Docs Use Cases

Documentation Best Practices
- For Building / Maintaining / Hosting Docs
  - Of User / Admin / Dev Docs 📖 TRADE STUDY
    - From Git Repositories
      - Using GitBook
      - Using RETYPE
      - Using mdBook
      - Using docusaurus
      - Using MkDocs
      - Using daux
      - Using docsify
      - Using ReadTheDocs
    - On Third-Party Managed Hosts
      - Using ReadTheDocs
      - Using Confluence
      - Using GitBook
  - Of APIs
    - Using GitBook
    - Using Redoc
    - Using Swagger
    - Using readme
    - Using Slate
  - Of Diagrams
    - Using LucidChart
    - Using Mermaid
    - Using C4-builder
  - Of Code
    - Using DocFX
- For Embedded Docs
  - From Mailing Lists / Discussions / Threads
    - Using GitHub Discussions
    - Using Google Groups
    - Using Mailman
  - From Automated Sources
    - From Logs
    - From Reports
    - From Alerts
- For Writing Docs
  - For Open Source Project Files
    - For READMEs
      - Using a Software Project Template 🏁 STARTER KIT
    - For CODE_OF_CONDUCT
      - Using Contributor Covenant 🏁 STARTER KIT
    - For Contributor Guides
      - Using Contributing Guide Template 🏁 STARTER KIT
  - For Requirements
    - Using NASA Systems Engineering Handbook
  - For Architecture / Design
    - Using C4 model
  - For Inferface Control
    - Using NASA Systems Engineering Handbook
  - For Test Planning
  - For Releases
    - For Release Plans
    - For Release Descriptions
  - For Guides
    - For User / Operator Guides
    - For Admin Guides
    - For Developer Guides
- For Publicizing Docs
  - From Blogging Platforms
    - Using Publii
  - From Website Platforms