Software Development
Diataxis
Use whenever writing, editing, restructuring, or reviewing technical documentation — READMEs, API docs, guides, tutorials, reference, onboarding, or developer docs of any kind — to apply the Diátaxis framework, which splits content into four modes (tutorials, how-to guides, reference, explanation) that each serve a distinct user need. Trigger even when the user just says "write docs", "document this", "improve the README", or "our docs are confusing" without naming Diátaxis or documentation types. Use it to decide WHAT KIND of doc to write (via the compass), to diagnose docs that feel bloated, mix instruction with reference, or leave users unable to get started or find facts, and to improve docs in small safe iterations. Especially when you are unsure whether something belongs in a tutorial vs how-to vs reference vs explanation, or when one page is trying to do all four at once.
- Publisher / source
- pproenca/dot-skills (found on skills.sh)
- Upstream record
- pproenca/dot-skills
- Version
- Version 3
- Published
- Publication review
- Approved for publication
- Content fingerprint
e867a75ada7381820788c58e1cd3156f170012bc41c77b4ffaacc18b946d97da