Back to Skills

diataxis-documentation

verified

Write comprehensive, user-focused documentation following the Diataxis framework. Use this skill when creating or improving tutorials, how-to guides, reference documentation, or explanatory content. Helps identify the right documentation type and apply best practices for each.

View on GitHub

Marketplace

abatilo-plugins

abatilo/vimrc

Plugin

abatilo-core

Repository

abatilo/vimrc
1stars

plugins/abatilo-core/skills/diataxis-documentation/SKILL.md

Last Verified

January 21, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/abatilo/vimrc/blob/main/plugins/abatilo-core/skills/diataxis-documentation/SKILL.md -a claude-code --skill diataxis-documentation

Installation paths:

Claude
.claude/skills/diataxis-documentation/
Powered by add-skill CLI

Instructions

# Diataxis Documentation Skill

This skill helps you create high-quality, user-focused documentation following the Diataxis framework, which organizes documentation into four distinct types based on user needs.

## When to Use This Skill

Use this skill when:
- Creating new documentation of any kind
- Improving existing documentation
- Organizing documentation for a project or codebase
- Writing tutorials, how-to guides, reference material, or explanations
- Unsure which type of documentation is needed
- Documentation feels unclear or serves multiple purposes poorly

## The Diataxis Framework Overview

Diataxis organizes documentation along two dimensions:

**User Context:**
- **Study** (Skill Acquisition): User is learning
- **Work** (Skill Application): User is doing

**Content Nature:**
- **Action** (Practical Steps): How to do things
- **Cognition** (Theoretical Knowledge): Understanding concepts

This creates four distinct documentation types:

```
                Study          |          Work
           (Learning)          |         (Doing)
    ━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                |
    TUTORIALS                   |    HOW-TO GUIDES
    Learning-oriented           |    Goal-oriented
    Guided lessons              |    Practical directions
    "Learn by doing"            |    "Achieve a goal"
                                |
Action ━━━━━━━━━━━━━━━━━━━━━━━━┼━━━━━━━━━━━━━━━━━━━━━━━━━━ Action
                                |
    EXPLANATION                 |    REFERENCE
    Understanding-oriented      |    Information-oriented
    Background & context        |    Technical description
    "Why & how it works"        |    "Facts about machinery"
                                |
    ━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━
Cognition                       |                    Cognition
```

## How to Use This Skill

### 1. Identify the Documentation Type Needed

**Ask these two questions:**
1. **

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
6993 chars