documentation

The Diataxis framework structures technical documentation into four distinct types: tutorials, how-to guides, references, and explanations. This classification addresses different user goals, reducing ambiguity and ensuring content serves its specific purpose.

You can organize technical documentation by classifying existing content into the Diataxis categories. Ask the AI to categorize your docs into tutorials, how-to guides, API references, and explanations, then generate an initial structured outline.

Structuring API references and user guides consistently requires a standardized workflow. This approach enforces a metadata-driven process with YAML frontmatter requirements and a three-part description structure, ensuring uniform validation and cross-linking across documents.

Yes, this content organization approach requires YAML frontmatter. It enforces a metadata-driven workflow where each document must include specific name and description fields within the YAML frontmatter to validate structural consistency.

To write consistent Quick Start instructions, apply the Diataxis framework to classify and refine content. This process guides you through crafting clear usage steps and validation criteria, ensuring your quick start instructions remain consistent and actionable.

Use Diataxis over standard technical writing methods when your documentation suffers from scattered information and inconsistent structure. It provides a standardized workflow for drafting and reviewing, which accelerates onboarding and clarifies content boundaries.