documentation-writer

The Diátaxis framework structures software documentation into four distinct quadrants: tutorials, how-to guides, reference, and explanations. It ensures audience-centric language by separating learning goals from practical work steps and technical descriptions.

To write technical documentation using Diátaxis, provide a topic and audience. The workflow asks clarifying questions, enforces a four-quadrant content structure, and generates a complete draft with YAML frontmatter containing name and description metadata.

Yes, the Diátaxis documentation method applies across tutorials, how-to guides, reference, and explanations for any technical topic. It adapts to the specific subject matter while maintaining a consistent, audience-centric structure throughout the generated content.

The best way to structure markdown documentation is applying the Diátaxis framework. This approach divides content into four quadrants—tutorials, how-to guides, reference, and explanations—ensuring high-quality, consistent documentation that serves different user needs effectively.

Documentation requires YAML frontmatter with name and description to support discovery and indexing. This frontmatter-driven metadata keeps the content machine-friendly while ensuring the structured software documentation remains organized and easily retrievable across documentation workflows.

A four-quadrant Diátaxis documentation structure may not suit projects needing unstructured narratives or single-page quick references. It is designed for comprehensive software documentation requiring strict separation between tutorials, how-to guides, reference, and explanations for distinct audiences.