About good-docs-audit
A documentation-review skill that checks writing against the `good-docs-writing` rules and reports specific deviations. It defaults to findings only, with edits made only when explicitly requested.
Key features
- 01Uses the writing rules as its rubric
- 02Cites file and line for each finding
- 03Quotes offending text and proposes rewrites
- 04Defaults to report-only reviews
Use cases
- 01Auditing documentation for style deviations
- 02Preparing actionable findings without editing files
- 03Rewriting documentation when explicitly requested
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/good-docs-auditin Claude Code to confirm it loaded.
Bundled filesreferences/audit-process.md
Details
From the project READMEGood docs audit
Review target documentation against the good-docs-writing rules and report where the writing drifts from that voice. Default behavior is report only: produce findings, do not edit. Only modify files if the user explicitly says to fix, rewrite, or apply.
Read references/audit-process.md for the procedure, the prioritized violation checklist, the report format, and the reporting rules.
Non-negotiables:
- Read
good-docs-writing(and itsreferences/style-guide.md) first. Those rules are the rubric; this skill is the process. - Cite
file:linefor every finding and quote the exact offending text. - Give a real rewrite in the target voice, not "consider revising."
- Don't invent violations. A short report is a good outcome.