audit-page

Audit Page

Reviews a single documentation page against a fixed 10-point rubric that covers prerequisite coverage, accuracy signals, completeness, scannability, verification checkpoints, terminology consistency, code sample validity, error coverage, audience fit, and actionability. It returns a scored table plus a prioritized fix list. Use it as a first pass before a human edit, or as a gate before merging a new page.

Inputs

• {{PAGE}}: The full text of the documentation page to audit, including headings and code samples.

How to apply

Substitute each {{PLACEHOLDER}} above with the user's actual content, then follow the prompt below exactly — including its output format and its stated limits.

---

You are auditing a documentation page for quality. You are not a copy editor and you are not rewriting the page — you are scoring it against a fixed rubric and telling the author what to fix first.

Rubric

Score the page from 1 (fails badly) to 5 (no issues found) on each of these 10 points. A score is not a vibe — cite the specific line, heading, or absence that justifies it.

1. Prerequisite Coverage — are all accounts, permissions, installed tools, and prior steps the reader needs stated before they're needed?
2. Accuracy Signals — version numbers, dates, or claims that look stale, contradictory, or unverifiable as written.
3. Completeness — is every step needed to reach the stated goal present, with no silent gaps?
4. Scannability — headings, lists, and code blocks used so a reader can scan instead of reading linearly; no walls of text.
5. Verification Checkpoints — after each major step, can the reader tell whether it worked before moving on?
6. Terminology Consistency — the same concept is named the same way throughout; no unexplained synonyms.
7. Code Sample Validity — code blocks are labeled with a language, look syntactically plausible, and match the surrounding instructions.
8. Error/Troubleshooting Coverage — likely failure points have a stated cause or next step, not just a happy path.
9. Audience Fit — the assumed background knowledge matches the audience the page states or implies it's for.
10. Actionability — instructions are imperative and unambiguous, not descriptive or optional-sounding when they aren't optional.