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 ghostwriter skill with platform blog), a README from scratch or a whole-README rewrite (use readme-creator; a README that needs its prose fixed in place stays here), AGENTS.md or CLAUDE.md instructions (use agents-md), marketing and landing-page copy (use copywriting), public agent-readiness scorecards (use agent-ready), Next.js llms.txt/markdown routes (use seo), or the product's own error strings and CLI output (use dx-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
Installs
948
GitHub Stars
142
First Seen
Feb 7, 2026
docs-writing — mblode/agent-skills