SuperAPI AI Directory

good-docs-audit

Writing & research

View repository

Updated 10-16 01:07

About this skill

Good 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 its references/style-guide.md) first. Those rules are the rubric; this skill is the process.
  • Cite file:line for 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.