Audit template
documentation
Checks your docs against the standard and against the code that proves them right or wrong.
Maps to: DOCUMENTATION-STANDARD · Diátaxis
How this audit works
Specialist agents walk each critical reader journey with docs only, then verify every claim against reality: documented commands run against the scripts, env vars are checked against what the code reads, and code samples are traced or executed. It scores head-matter, onboarding, doc-code drift, writing quality, and Diátaxis fit on a 0-100 rubric, judging each page against the job it is meant to do.
Use it when
Before open-sourcing a repo
You are about to make a repo public and the README is your front door. The audit walks clone-to-first-green-test as a new reader, names the exact step where they get stuck, and flags the missing value line, badge row, management summary, and architecture diagram.
After a refactor renamed things
A refactor renamed scripts, env vars, and module paths, but the docs still describe the old names. The audit tests documented commands against package.json, env vars against what the code reads, and .env.example against reality, returning a drift register that cites both the doc and the code line for every mismatch.
Handing a service to on-call
You are giving another team the pager for a service they did not build. The audit checks the runbooks, rollback steps, and reference docs against the actual infra and API surface, so a wrong rollback step or an undocumented required config surfaces as a P0/P1 before 3am does.
What you get
A rubric scorecard with grade band plus a drift register and prioritized GitHub issues, each with a before/after fix.