documenting-with-diataxis

What problem does it solve?

Documentation often mixes different types (tutorials, how-tos, references, explanations) leading to unclear outcomes. This skill ensures topics are classified according to the Diataxis framework to guide appropriate writing and preserve clarity.

Core Features & Use Cases

• Type identification: classify a topic into one of the four Diataxis types based on user need.
• Writing templates: provide structure guidance and tone for Tutorial, How-to, Reference, and Explanation.
• Documentation audit: assess existing content for alignment with Diataxis and suggest reorganization.
• Use case: when documenting a new API, determine whether to create a Reference for lookup, a Tutorial for onboarding, a How-to for common tasks, or an Explanation for rationale.

Quick Start

Draft your topic as one of the four Diataxis types by analyzing user needs and selecting the appropriate document type.