Docs Sync Audit
Checks whether docs still match the code, config, commands and links, and reports drift with evidence.
- Repository
- github/awesome-copilot
- Stars
- 40,703
- Licence
- MIT
- Files
- 2 files
What it does
This skill makes an AI agent act as a read-only documentation auditor. When asked whether docs are stale, missing or inconsistent with the code, the agent compares what the README, setup guides, API docs, env docs, changelogs and examples claim against what the code actually does, then reports each mismatch with evidence from both sides and a suggested direction for the fix. It first runs a bundled Python script that mechanically checks documented npm scripts and make targets, relative Markdown links, and environment variable names, then the agent applies judgement to wording and completeness.
Great for
- Maintainers preparing a release who want to know which docs are out of date
- Developers who changed a feature, endpoint or config and need to find the docs that now mislead readers
- Teams with large repos who want a prioritised list of doc risks rather than a full manual review
Skip it if
- General code review or bug hunting, because the skill explicitly compares docs against code rather than judging code quality
- Repos that rely heavily on dynamic imports or generated code, since the script uses name matching and can miss or misreport some references; the agent must confirm findings manually
- Anyone expecting the skill to fix docs automatically, since it is designed to stay read-only unless explicitly asked to update docs
Try asking
- “Audit the docs for this PR and tell me what needs updating before release.”
- “Check whether the README setup instructions still work with the current code.”
- “Find environment variables that are documented but never read, or read but never documented.”
- “Does our API documentation match the current route handlers?”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 2 original files, the MIT licence and an attribution note.
docs-sync-audit.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip docs-sync-audit.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip docs-sync-audit.zip -d .claude/skills/Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.
- 3
Ask for the task
No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.
Get better results
- Give a specific scope such as a feature, PR or API area; without one the skill runs a full-repo audit, which is depth-limited and reports what it could not inspect.
- Ask the agent to run the script with --format json if you want to review or filter the raw results yourself.
- Treat the script's output as leads: use --check-paths only when you want backticked paths checked too, and confirm any flagged unreachable module before acting on it.
What's inside
- scripts/docs_drift.py
- SKILL.md
Redistributed unmodified from github/awesome-copilot under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.