writing-documentation-with-diataxis

Creates and reviews technical documentation using the Diataxis framework's four document types.

Updated Mar 26, 2026
One-click install
npx skills add https://github.com/TranVanTienDat/Milkyway --skill writing-documentation-with-diataxis-tranvantiendat
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-documentation-with-diataxis
Source: https://github.com/TranVanTienDat/Milkyway/tree/main/.agents/skills/writing-documentation-with-diataxis
Command: npx skills add https://github.com/TranVanTienDat/Milkyway --skill writing-documentation-with-diataxis-tranvantiendat

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Technical documentation often mixes tutorials, how-to guides, reference material, and explanations into confusing pages that fail to serve any reader well. This Skill applies the Diataxis framework to classify content by user need, enforce clean boundaries between document types, and iteratively improve existing documentation. ## Core Features & Use Cases - Document Type Classification: Uses the Diataxis compass (Action vs Cognition, Acquisition vs Application) to determine whether content should be a Tutorial, How-to Guide, Reference, or Explanation. - Authoring Guidance: Provides type-specific principles, structure templates, and language patterns for writing each of the four documentation types. - Documentation Review: Runs an iterative audit workflow that challenges each section, identifies boundary violations (e.g., explanations inside tutorials), and applies targeted improvements. - Use Case: When asked to write a getting-started guide for a new API, the Skill identifies it as a Tutorial, structures it as a single reliable learning path with verifiable results, and links out conceptual background to a separate Explanation page. ## Quick Start Ask the assistant to review your documentation page using the Diataxis framework and identify which document type each section should be.

Frequently Asked Questions about writing-documentation-with-diataxis

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure technical documentation with the Diataxis framework?▼

Diataxis divides documentation into four types based on user needs: Tutorials for learning by doing, How-to Guides for accomplishing tasks, Reference for looking up facts, and Explanation for understanding concepts. Classify each piece of content using the Action/Cognition and Acquisition/Application axes, then keep the types separate and link between them.

What is the difference between a tutorial and a how-to guide?▼

A tutorial serves learners studying a skill and must provide one reliable path with guaranteed results, where the author takes responsibility for success. A how-to guide serves competent practitioners solving real problems, assumes prior knowledge, and may include conditional branches for real-world complexity.

How do I decide which Diataxis document type to write?▼

Ask two questions: does the content serve action or cognition, and does it serve skill acquisition or application. Action plus acquisition means Tutorial, action plus application means How-to Guide, cognition plus application means Reference, and cognition plus acquisition means Explanation.

Can Diataxis improve existing documentation that mixes content types?▼

Yes, through an iterative review process: pick one section, challenge it against the four user needs, identify boundary violations like explanations inside tutorials, extract misplaced content into the correct type, and link between documents. Improve one section at a time rather than restructuring everything at once.

What are the limitations of the Diataxis framework?▼

Diataxis does not guarantee factual accuracy, completeness, or consistency, which require domain expertise and ongoing maintenance. It addresses deep quality like flow and user fit, and it complements rather than replaces technical writing, UX design, and visual design disciplines.