documentation-standards

Diátaxis organizes documentation into four distinct types: Tutorials (learning-oriented), How-to guides (task-oriented), Explanations (understanding-oriented), and Reference (information-oriented). This framework ensures each section serves a specific user need, improving clarity and maintainability across your documentation.

Software documentation quality rests on five core criteria: completeness (covering all necessary topics), accuracy (factual correctness), clarity (understandable language), organization (logical structure), and maintainability (easy to update and version). These standards ensure documentation remains reliable and useful over time.

Yes. This Skill supports flexible approaches combining Traditional standards, Diátaxis, and Custom standards tailored to your project's needs. You define scope, quality thresholds, and domain-specific templates while maintaining consistency through checklists, versioning, and cross-reference audits.

Set up a structured workflow using standardized templates, quality checklists, and versioning controls. Define planning stages, assign writing guidelines from your chosen framework, and establish review criteria tied to your quality standards to catch gaps before publication.

The Skill delivers domain-specific templates aligned with your chosen standard—Diátaxis, Traditional, or Custom. Checklists enforce quality criteria, cross-reference validation, and versioning requirements, ensuring consistent structure and completeness across tutorials, guides, explanations, and references.