Documentation System

Documentation structured with opening descriptions, sections, diagrams, code examples, and cross-references enables AI navigation. The Documentation System provides templates for system, package, and guide docs organized under a docs/ folder hierarchy with index.md entries for consistent, scalable documentation suitable for both human readers and AI processing.

Apply the Documentation System templates to standardize writing, reviewing, and maintaining content across docs/system/, docs/packages/, and docs/guides/. Each folder uses role-specific templates with structured sections, maintenance workflows, and cross-linking guidance to ensure consistent quality and easier updates as code changes.

The Documentation System includes maintenance guidance and workflows that govern how to update and review docs when code changes. Regular alignment prevents documentation drift and keeps references, examples, and cross-links current across system, package, and guide documentation.

Yes. The Documentation System provides ready-to-use templates in references/templates/ for system docs, package docs, guides, and index docs. Start by selecting your doc type, using the appropriate template, and adding an index.md for navigation to establish consistency from the first document.

The Documentation System requires a docs/ folder with three subfolders—system/, packages/, and guides/—plus index.md entries at each level. This hierarchical structure enables logical organization, cross-referencing, and AI-friendly navigation of your documentation.

AI-navigable documentation uses consistent structure, clear opening descriptions, semantic section headers, inline code examples, and explicit cross-references. The Documentation System applies these patterns systematically across your docs/ folders so AI systems can parse intent and relationships alongside human comprehension.