Skip to content
Back to skills

Diataxis Documentation

ASecurity

Apply the Diataxis framework: identify which of the four documentation kinds you're writing (tutorial/how-to/reference/explanation), keep them separate, and organize the whole docs set around the reader's journey rather than the system's structure.

  • 7 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added September 23, 2026
ai-agentsgodocumentation

Security analysis

A100/100

Scanned September 23, 2026

npx -y skills add mcorbett51090/RavenClaude --skill diataxis-documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Diataxis Documentation?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Diataxis Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/mcorbett51090-diataxis-documentation/badge)](https://www.skillsdirectory.com/skills/mcorbett51090-diataxis-documentation)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: diataxis-documentation
description: "Apply the Diataxis framework: identify which of the four documentation kinds you're writing (tutorial/how-to/reference/explanation), keep them separate, and organize the whole docs set around the reader's journey rather than the system's structure."
---

# Diataxis Documentation

## The four kinds (don't mix them)
| Kind | Serves | Oriented to |
|---|---|---|
| **Tutorial** | learning | the newcomer, hand-held |
| **How-to guide** | a task | the practitioner with a goal |
| **Reference** | information | the one who needs facts |
| **Explanation** | understanding | the one asking 'why' |

Most bad docs blur all four. Separating them is the biggest single improvement.

## Organize by the reader
Map audiences + journeys (newcomer / integrator / operator); structure around what they're doing, **not** your module tree.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…