diataxis-documentation

Classify project documentation into Diataxis types and guide iterative improvements.

2|2|Updated Dec 30, 2025

Search Tags:#documentation #reference #iteration #explanation #tutorials #diataxis

Ready to run

npx skills add https://github.com/NavarrePratt/claude-settings --skill diataxis-documentation-navarrepratt

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: diataxis-documentation
Source: https://github.com/NavarrePratt/claude-settings/tree/main/skills/diataxis-documentation
Command: npx skills add https://github.com/NavarrePratt/claude-settings --skill diataxis-documentation-navarrepratt

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps teams produce clear, user-focused documentation by systematically classifying content into the four Diataxis types and guiding iterative improvements, preventing blur between tutorials, how-tos, references, and explanations.

Core Features & Use Cases

Type separation guidance for Tutorials, How-to Guides, Reference, and Explanations
Iterative improvement framework (Choose → Assess → Decide → Do) to refine content in small steps
Cross-referencing recommendations to connect related types without merging their purposes
Real-world use: reorganize an existing project wiki or README into purposeful Diataxis sections for better usability

Quick Start

Begin by selecting an existing document, identify the user need, assign a Diataxis type, and outline a minimal improvement.

Frequently Asked Questions about diataxis-documentation

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

FAQPage Schema

How do I organize project documentation to separate tutorials, how-to guides, references, and explanations?▼

To separate documentation types, classify each document by user need: tutorials for learning, how-to guides for tasks, references for information, and explanations for understanding. This prevents content blur and aligns docs with specific user goals.

What is the Diataxis framework for structuring software documentation?▼

The Diataxis framework structures documentation into tutorials, how-to guides, references, and explanations. It aligns content with user needs by enforcing clear separation of these four types and guiding iterative content improvements.

How do I restructure an existing project wiki into purposeful documentation sections?▼

Restructure a project wiki by selecting an existing document, identifying the user need, and assigning it a Diataxis type. Apply an iterative workflow to assess, decide, and execute small content refinements for better usability.

How do I connect related documentation types without merging their purposes?▼

Connect related documentation types by using cross-referencing recommendations to link tutorials, how-tos, references, and explanations. This maintains strict separation of each document's purpose while ensuring seamless content navigation.

Can I apply an iterative improvement workflow to refine technical documentation?▼

Yes, you can refine technical documentation using an iterative framework of Choose, Assess, Decide, and Do. This workflow guides small, incremental content improvements rather than large, disruptive rewrites.

When should I not use a single documentation format for all project content?▼

Avoid a single documentation format when users have distinct needs like learning, task execution, or reference lookup. Merging these purposes creates content blur, making it harder for users to find what they need.