documentation-writer

The Diátaxis framework structures technical documentation into Tutorials, How-to Guides, Reference, and Explanation. This Skill guides you through a metadata-driven workflow to generate content aligned with these four distinct quadrants.

The best way to write software documentation is using a structured workflow that enforces YAML frontmatter for metadata. This process clarifies your topic, proposes a structured outline, and then generates content ensuring name and description accuracy.

Yes, you can generate both tutorials and reference docs. The workflow supports all four Diátaxis quadrants, allowing product teams to produce comprehensive documentation for developers, testers, and operators across various software domains.

Yes, the workflow supports Markdown formatting for technical writing. It integrates a metadata-driven process using YAML frontmatter to ensure clarity, accuracy, user-centricity, and consistency across all generated Markdown documentation outputs.

Use Diátaxis-aligned documentation when you need to serve novice to advanced readers with distinct learning goals. It separates learning, application, information, and understanding, ensuring user-centricity and consistency across complex software domains.