documentation-writer

The Diátaxis framework divides software documentation into four quadrants: tutorials, how-to guides, references, and explanations. This approach structures content by user needs, ensuring technical writing remains clear, user-centric, and aligned with specific learning goals.

To write technical documentation using Diátaxis, you separate content into tutorials, how-tos, references, and explanations. This skill guides you through a workflow that proposes a structure and generates content with guardrails for clarity and accuracy.

Yes, this skill applies to documentation projects for software products, APIs, and development libraries. It satisfies requirements for YAML frontmatter and generates a structured description body to ensure consistent API lifecycle documentation.

The best way to structure software documentation for clarity is aligning it with the Diátaxis framework. This method categorizes content into tutorials, how-tos, references, and explanations, emphasizing accuracy and user-centric guidance throughout the writing workflow.

Yes, this documentation workflow requires YAML frontmatter containing the name and description of the document. It also enforces a structured description body to maintain consistency across tutorials and references for software products.