Documentation Types

• How-to guides & tutorials

• Release notes

• Developer guides

• REST API documentation

• Ops & Migration Guides

• Knowledge base articles

• Troubleshooting & FAQs

• YouTube video tutorials

• Blog posts

Content Writing

• Product documentation

• Design documentation

• Editorial reviews

• Content strategy

• Quality assurance

Tools

• Markdown,

• Visual Studio Code

• Hugo

• MadCap Flare

• Git

• Confluence

• JIRA

• MS Office

• Swagger

• Jupyter Notebook

• Video & Image editing:

  • Figma

  • Snagit

  • Camtasia

• Project management

  • Agile

  • Kanban

• Project documentation

  • WordPress

  • Sphinx