← 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, missing, 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 77
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. - 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. Inventory the repo, rank surfaces by risk, deep-inspect as many high-risk surfaces as the turn allows, 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 preferences unless they make instructions misleading, incomplete, or hard to follow. - Treat generated docs carefully: identify the generator, source file, and expected generation command before recommending direct edits. - If generated docs appear stale but were not regenerated, say so explicitly and report the residual