Skip to content

Content Architecture

Design the documentation around how teams actually browse and update pages.

Principles

  • Group by user intent.
  • Keep folder depth shallow.
  • Prefer stable section names.
  • Put templates in a separate folder.
  • Use indexes as entry points for each section.
  • Overview
  • Setup
  • Usage
  • Reference
  • Troubleshooting
  • Changelog

Markdown-first documentation for teams that update docs often.