docs-writing
Installation
SKILL.md
Documentation Writing
- IS: writing and auditing technical documentation quality (Diataxis doc types, voice, structure, clarity, runnable code, formatting, navigation, content hygiene, agent-readable docs) for docs sites, API references, documentation-site tutorials, how-to docs, and existing READMEs.
- IS NOT: editorial blog tutorials or articles (use the external
ghostwriterskill with platformblog), a README from scratch or a whole-README rewrite (usereadme-creator; a README that needs its prose fixed in place stays here), AGENTS.md or CLAUDE.md instructions (useagents-md), marketing and landing-page copy (usecopywriting), public agent-readiness scorecards (useagent-ready), Next.jsllms.txt/markdown routes (useseo), or the product's own error strings and CLI output (usedx-audit; this skill covers the docs that describe them).
Mode dispatch
- Reviewing docs? → Audit workflow.
- Writing or rewriting a page? → Writing workflow.
- "Improve" or "fix" docs? → Audit first, then apply fixes yourself.
Classify before anything else
Doc type gates which rules apply, so classify every file first. Use the Diataxis compass: does the page serve action (doing) or cognition (understanding), and is the reader acquiring a skill or applying one?
| Acquisition (learning) | Application (working) | |
|---|---|---|
| Action | Tutorial | How-to guide |
| Cognition | Explanation | Reference |