What is the Diataxis framework?

Diataxis is a systematic approach to technical documentation that divides content into four distinct quadrants based on the user's needs: Tutorials (learning-oriented), How-to Guides (goal-oriented), Reference (information-oriented), and Explanation (understanding-oriented).

How do I know which document type to write?

The skill includes a diataxis-classifier agent that analyzes your project needs or user requests and automatically determines whether you should create a tutorial, guide, explanation, or reference document.

Is this skill compatible with existing codebases?

Absolutely. It integrates with your current file structure and can be triggered via natural language to audit or rewrite existing markdown files into the Diataxis format.

Can I use this for API documentation?

Yes, the diataxis-reference agent is specifically designed to handle authoritative, information-oriented API documentation with a clear, narrative-free structure.

How does this skill prevent confusing documentation?

It uses a specialized Documentation Auditor to detect 'quadrant mixing,' ensuring that task-oriented steps aren't buried inside conceptual explanations or reference tables, which is the leading cause of documentation friction.

Diataxis Documentation Skill for Claude Code

The Diataxis skill transforms how technical documentation is authored by applying the four-quadrant framework: tutorials for learning, how-to guides for tasks, reference docs for information, and explanations for understanding. It provides specialized AI agents for each content type, a classifier to route requests correctly, and an auditor to ensure your documentation remains free of 'quadrant mixing'—the most common cause of confusing documentation. Whether you are building API documentation, getting started guides, or complex architectural explanations, this skill ensures structural consistency and user-centric clarity.

主要功能

01Quadrant-Specific Writing: Specialized agents for tutorials, how-to guides, reference material, and conceptual explanations.

0216 GitHub stars

03Documentation Classification: Automatically determines the correct documentation type for any user request.

04Structure Auditing: Identifies and fixes 'quadrant mixing' to ensure documentation is clear and distinct.

05Self-Review Integration: Automatically applies Diataxis-specific quality checks during the writing process.

06Standardized Templates: Enforces structural consistency across all documentation types using built-in templates.

使用场景

01Auditing existing project READMEs and docs to separate 'how-to' steps from conceptual 'explanations'.

02Generating API reference documentation that is strictly informative and separated from tutorial content.

03Creating a comprehensive developer guide from scratch with distinct learning paths and reference materials.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add geekatron/jerry diataxis

For use in Claude.ai and ChatGPT

主要功能

01Quadrant-Specific Writing: Specialized agents for tutorials, how-to guides, reference material, and conceptual explanations.

0216 GitHub stars

03Documentation Classification: Automatically determines the correct documentation type for any user request.

04Structure Auditing: Identifies and fixes 'quadrant mixing' to ensure documentation is clear and distinct.

05Self-Review Integration: Automatically applies Diataxis-specific quality checks during the writing process.

06Standardized Templates: Enforces structural consistency across all documentation types using built-in templates.

使用场景

01Auditing existing project READMEs and docs to separate 'how-to' steps from conceptual 'explanations'.

02Generating API reference documentation that is strictly informative and separated from tutorial content.

03Creating a comprehensive developer guide from scratch with distinct learning paths and reference materials.

Diataxis Documentation Framework

Diataxis Documentation Framework

主要功能

使用场景

主要功能

使用场景