← ClaudeAtlas

diataxis-auditlisted

Audit existing documentation against the Diátaxis framework's four quadrants. Use when reviewing documentation that feels unclear, when assessing documentation quality, or when preparing for a documentation reorganization.
jrjsmrtn/diataxis-skills · ★ 1 · Data & Documents · score 75
Install: claude install-skill jrjsmrtn/diataxis-skills
# Diátaxis Documentation Audit Audit existing documentation against the [Diátaxis](https://diataxis.fr/) framework to identify mixed quadrants, gaps, and quality issues. ## Diátaxis Compass ``` Practical Theoretical +----------------+------------------+ Study | TUTORIALS | EXPLANATION | | (learning) | (understanding) | +----------------+------------------+ Work | HOW-TO | REFERENCE | | (problem) | (information) | +----------------+------------------+ ``` **Key principle**: These quadrants must remain distinct. Blurring boundaries is the most common documentation problem. ## When to Use - Reviewing documentation that feels unclear or difficult to use - Assessing documentation quality before a release or handoff - Preparing for a documentation reorganization - Onboarding to an unfamiliar project and evaluating its docs ## Required Inputs 1. **Documentation path(s)**: Files or directories to audit 2. **Scope** (optional): Full audit or quick spot-check ## Workflow ### Phase 1: Inventory Read all documentation files in the target path. For each file, record: - File path - Apparent intent (what quadrant it seems to target) - Length and structure ### Phase 2: Classify For each document or section, classify using these questions: | Question | If Yes → | |----------|----------| | Is it a guided learning experience building to a result? | **Tutorial** | | Does it solve