← ClaudeAtlas

docs-applying-diataxis-frameworklisted

Diátaxis documentation framework for organizing content into four categories - tutorials (learning-oriented), how-to guides (problem-solving), reference (technical specifications), and explanation (conceptual understanding). Essential for creating and organizing documentation in docs/ directory.
wahidyankf/ose-primer · ★ 2 · Web & Frontend · score 75
Install: claude install-skill wahidyankf/ose-primer
# Applying Diátaxis Framework ## Purpose This Skill provides guidance for applying the **Diátaxis documentation framework** to organize and create documentation. Diátaxis categorizes documentation into four distinct types based on user needs and context. **When to use this Skill:** - Creating new documentation in docs/ - Organizing documentation structure - Deciding which documentation type to write - Reviewing documentation for proper categorization - Understanding documentation organization principles ## The Four Documentation Types ### Tutorials (Learning-Oriented) **Purpose**: Guide learners through a complete journey to achieve a specific learning outcome. **Characteristics**: - Learning-oriented (not task-oriented) - Hands-on, practical examples - Gradual progression from simple to complex - Safety and encouragement for beginners - Minimal assumptions about prior knowledge **Directory**: `docs/tutorials/` **Example**: "Data Tutorial - Beginner" teaching fundamentals step-by-step. ### How-To Guides (Problem-Solving) **Purpose**: Provide step-by-step instructions to solve specific problems or complete specific tasks. **Characteristics**: - Goal-oriented and task-focused - Assumes basic knowledge - Practical, actionable steps - Specific to one problem/task - Flexible order (can jump to relevant guide) **Directory**: `docs/how-to/` **Example**: "How to Add a New Nx App" - concrete steps for a specific task. ### Reference (Technical Specifications) **Purpo