Tired of outdated docs, broken links, and features nobody documented? Stop guessing — audit it.
If your repo looks something like this, this skill is for you:
my-project/
├── src/ # application code
├── docs/ # user-facing documentation (Markdown, MDX, RST…)
├── api/
└── ...
Your code and your docs live side by side, but nothing ensures they stay in sync. This skill cross-references both to surface gaps, stale references, and inconsistencies automatically.
A Claude Code skill that generates a customized /doc-audit skill tailored to your codebase. It scans your repo, asks a few questions, then produces a complete documentation audit pipeline that detects broken links, stale references, missing coverage, and more.
Focus: end-user/functional documentation only — not developer docs.
Run /doc-audit-setup and the skill walks through 6 steps:
-
Detect documentation location — Scans for doc directories, framework configs (Mintlify, Docusaurus, MkDocs, Sphinx, Hugo, etc.), file formats (
.md,.mdx,.rst,.adoc), nav configs, and i18n structure. Asks you to confirm. -
Discover feature types — Scans source code for user-facing features: API endpoints, CLI commands, SDK exports, configuration options, webhooks/events, UI pages, monorepo packages, and any project-specific feature areas. Asks you to confirm.
-
Detect exclusions — Identifies internal directories (test infra, build tooling, dev utilities) that should be skipped during the audit. Asks you to confirm.
-
Clarifying questions — Asks for the product name, redirect config location, and any custom code patterns your docs reference.
-
Generate the skill — Fills in templates with your project's specifics and writes 5 files to
.claude/skills/doc-audit/:File Role SKILL.mdMain 6-phase audit workflow references/section-audit-instructions.mdDetection rules for doc issues references/section-audit-agent-prompt.mdPrompt template for audit agents references/reviewer-agent-prompt.mdPrompt template for review agents references/opportunities-agent-prompt.mdPrompt template for coverage gap detection -
Print summary — Shows what was configured and how to run it.
/doc-audit-setup # one-time setup — generates the skill for your project
/doc-audit # run the audit
Re-run /doc-audit-setup after major structural changes to regenerate the skill.
Run /doc-audit on a weekly schedule so documentation issues never pile up. Copy weekly-doc-review.yml into your repo at .github/workflows/weekly-doc-review.yml.
Prerequisites:
- Add your
ANTHROPIC_API_KEYas a repository secret - Run
/doc-audit-setupat least once so the skill exists in your repo - See claude-code-action for more options