doc-check
Installation
SKILL.md
doc-check
Police the .docs/ tree: find where it lies about the code, leaks something it shouldn't, or has rotted, and report it plainly. This skill reads and reports — it doesn't edit until the user asks. When they do want fixes, hand each one to doc-it (drift, missing pages) or apply the specific correction.
What to check, worst first
Rank findings by severity. In order:
- Hygiene (critical). Any committed secret, token, API key, real account/internal ID, or personal data (names, emails) in a doc. Quote the location and suggest the placeholder to use instead. This is the highest-priority class — a leak is worse than a gap.
- Drift / staleness. Docs that describe code that has changed or no longer exists: source links pointing at moved or deleted files; described exports/params/behaviour that don't match the current source; stubs or incomplete work documented as if finished.
- Broken links. Relative links between docs, source links, and index rows that resolve to nothing.
- Coverage gaps. Units in the code with no doc; docs with no row in the
.docs/README.mdindex; Related sections missing a back-link the other page has. - Structure. Index tables present and complete per category; every unit doc has a source link and a Related section; no fact duplicated verbatim across pages when it should have one canonical home (flag the copies, name the home).
- Style (minor). First-person narration, filler, or prose where a table of IDs/params belongs; H1s that are bare identifiers instead of human titles.