Skip to main content

Documentation

/dev:doc writes, scores, fixes or checks docs. One command, four modes.

Step 1. Say what you want

The wording picks the mode. You don't name it.

Flow diagram: the request is sorted into generate, analyze, fix or validate, each passes through a quality gate, and all end in a report

SayModeWhat happens
"write a README for…"GENERATENew docs from a template
"score the docs in…"ANALYZEA quality score, plus the anti-patterns it found
"fix the API docs"FIXAnalyses first, shows you, then asks
"check the examples still work"VALIDATEExamples, links and claims, against the source

Step 2. For FIX, approve the changes

FIX doesn't touch a file until it has shown you what it found and you've agreed.

That order matters. A documentation "fix" applied without review is how a wrong claim gets rewritten into a confident wrong claim.

Step 3. Read the report

Every mode ends with one, and every mode passes through a quality gate first.

Which mode for what

Your situationSay
New project, no docs"write a README"
Docs exist, quality unknown"score the docs"
You know they're stale"fix the docs in docs/"
You suspect the examples rotted"check the examples in the README still work"

Start with ANALYZE if you're not sure. It changes nothing and tells you whether the rest is worth running.

Not what you wanted?

You wantGuide
To understand the code the docs describeUnderstanding code
A design document, not user docsDesigning before you build