documentation-writer

The Diátaxis framework structures software documentation into four distinct types: tutorials, how-to guides, references, and explanations. This approach separates learning-oriented content from practical task execution, ensuring readers find the right information based on their specific intent.

Generating documentation outlines works best by first defining the document type, target audience, and specific scope. This workflow-assisted approach prompts authors for these foundational details before drafting, ensuring the finalized outline aligns precisely with the intended documentation structure.

Yes, frontmatter templates support reusable documentation across multiple projects. These templates enforce a consistent schema requiring a name and description, while also providing standardized section templates to accelerate content generation and maintain uniform metadata across various software products.

Diátaxis documentation supports optional assets, scripts, and references for extensible docs. While the Markdown body is mandated for activation and frontmatter enforces the core schema, these optional components allow authors to attach supplementary technical material directly to the documentation.

Use a how-to guide when a reader needs to accomplish a specific practical task and already possesses basic knowledge. Tutorials are reserved for learning-oriented scenarios where the audience needs guided steps to understand concepts, whereas how-tos focus strictly on practical problem-solving.