← ClaudeAtlas

docs-sync-auditlisted

Run a read-only documentation drift audit for a feature, PR, branch, release, API, configuration change, workflow, CLI, package, or repository area. Use when the user asks whether docs are stale, have missed a code change, are inconsistent with code, or need updates after code changes. Checks README files, setup guides, API docs, env docs, changelogs, examples, comments, generated docs, and user-facing instructions. This is not a general code review; use feature-audit for product bugs and readiness risks.
specialone0007/review-skills · ★ 1 · AI & Automation · score 75
Install: claude install-skill specialone0007/review-skills
# Docs Sync Audit Check whether documentation still matches the code, configuration, API behavior, commands, examples, and user workflows. Report stale or missing docs with concrete evidence and update direction. ## Core Rules - Stay read-only unless the user explicitly asks to update docs. Avoid creating docs during the audit phase. - Never quote an environment value, a credential or a connection string in the report, whatever file it came from. The script reads only the names to the left of `=`; hold your own greps into `.env*` files, compose files and CI secrets to the same rule - cite the file and the variable name, never the value. - Default to a full-repository docs audit when the user does not provide a specific scope. Inventory the repo's docs surfaces (README, docs directories, examples, CLI help, API contracts, config samples) and compare them against the code they describe. - Full-repo audits are breadth-first, then depth-limited, in the order under **Order Of Work**. Stop when the turn runs out and list the rest under **Surveyed But Not Deeply Inspected** with a pointer to run another pass on them. State the surface counts in the report header. Never present a shallow sweep as complete coverage. - Ground every finding in both sides of the mismatch: the code/config/source of truth and the stale or missing documentation. - Separate confirmed drift from inferred doc gaps. - Prefer user-impacting docs drift over cosmetic wording issues. Do not report style preferen