audit-repo-docs — Claude Code command: documentation audit
The audit-repo-docs command checks repository documentation against 30 criteria and produces a scored report with prioritized fixes. It spots gaps in README files, docs structure, and automation.
CC-BY-SA-4.0 ★ 6,529 updated 2026-10-22
.claude/commands/audit-repo-docs.mdWhat audit-repo-docs does
The command scans root files, documentation folders, machine-readable resources, scripts, and examples. It then scores the repository across five areas: root files, documentation structure, machine-readable content, automation, and quality. The checks draw on patterns from the Claude Code guide.
A standard run produces a Markdown report with category scores and prioritized findings. With --generate, the command proposes creating missing files from templates, then asks for approval before making them. The scoring formula uses a maximum of 58 points and maps the result to a 0–100 scale, so compare reports using the final percentage rather than raw points.
What it helps with
- check whether the README has a quick start and table of contents
- find missing files in the repository root
- assess the layout of documentation folders
- rank documentation gaps by priority
- propose template-based files for approval
Example prompts for the agent
- Audit this repository's documentation and write a Markdown report:
/audit-repo-docs - Audit the docs and propose creating missing files:
/audit-repo-docs --generate
How to install audit-repo-docs
Manually: put the files in place
.claude/commands/audit-repo-docs.mdCall it with /audit-repo-docs. For all projects use ~/.claude/commands/
Manually: put the files in place
~/.codex/prompts/audit-repo-docs.mdCall it with /prompts:audit-repo-docs. Codex marks this format deprecated in favour of skills
Manually: put the files in place
.github/prompts/audit-repo-docs.prompt.mdManually: put the files in place
.gemini/commands/audit-repo-docs.tomlGemini stores commands as TOML: the prompt text goes into the prompt field
Questions about audit-repo-docs
How do I install audit-repo-docs in Claude Code?
Save the command as .claude/commands/audit-repo-docs.md.
What does audit-repo-docs do?
It checks repository documentation against 30 criteria and creates a scored report with prioritized recommendations. The review covers root files, documentation structure, automation, and quality.
What happens when I use --generate?
The command lists missing files and asks whether to create them. After approval, it creates the selected files from templates.