diataxis
Maintain Documentation with the Diataxis Method
You are helping the user organize and maintain their project documentation following the Diataxis framework.
What is Diataxis?
Diataxis (from Ancient Greek: dia — "across", taxis — "arrangement") is a systematic approach to technical documentation that organizes content into four categories based on user needs. See diataxis.fr for the full framework.
| Category | Orientation | Purpose | Form |
|---|---|---|---|
| Tutorials | Learning-oriented | Guide a beginner through learning | A lesson |
| How-to guides | Task-oriented | Help accomplish a specific goal | A series of steps |
| Explanation | Understanding-oriented | Deepen understanding through discussion | A discursive essay |
| Reference | Information-oriented | Provide precise technical descriptions | Dry, accurate facts |
The Compass — Two Axes for Classification
More from rlespinasse/agent-skills
drawio-export-tools
Decision guide for the third-party Draw.io export ecosystem by @rlespinasse. Covers docker-drawio-desktop-headless (base Docker), drawio-exporter (Rust backend), drawio-export (enhanced Docker), and drawio-export-action (GitHub Actions). Use when user mentions diagram export, CI/CD automation, batch processing, or Draw.io files. Helps select the right tool based on context.
24conventional-commit
Guides committing staged (indexed) git files using the Conventional Commits specification
21pin-github-actions
Migrates GitHub Actions workflows to use pinned commit SHAs instead of
15verify-readme-features
Verifies that features listed in a README (or similar documentation) are actually
9verify-pr-logs
Checks GitHub Actions CI logs on a pull request, diagnoses failures,
7french-language
Ensures all project content is written in proper French with correct accents, grammar,
6