# audit-repo-docs

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.

- command · `type=command` · Claude Code, Codex, GitHub Copilot, Gemini CLI · ★ 6529 repo stars
- Author: FlorianBruniaux
- License: CC-BY-SA-4.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/HEAD/.claude/commands/audit-repo-docs.md
- Updated: 2026-10-22
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/commands/audit-repo-docs

## What it 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.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/commands/audit-repo-docs.md` — Call it with /audit-repo-docs. For all projects use ~/.claude/commands/

### Codex

**Manually: put the files in place**
- File: `~/.codex/prompts/audit-repo-docs.md` — Call it with /prompts:audit-repo-docs. Codex marks this format deprecated in favour of skills

### GitHub Copilot

**Manually: put the files in place**
- File: `.github/prompts/audit-repo-docs.prompt.md`

### Gemini CLI

**Manually: put the files in place**
- File: `.gemini/commands/audit-repo-docs.toml` — Gemini stores commands as TOML: the prompt text goes into the prompt field

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/HEAD/.claude/commands/audit-repo-docs.md

## When to use it
- 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
- 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`

## Similar
- [repo-skillopt](https://affpapa.org/en/nevibecode/skills/repo-skillopt.md) — skill · 598 installs
- [index-repo](https://affpapa.org/en/nevibecode/commands/index-repo.md) — command · ★ 23950 repo stars
- [developer-docs-structure-audit](https://affpapa.org/en/nevibecode/skills/developer-docs-structure-audit.md) — skill · 13700 installs
- [repo-standardizer](https://affpapa.org/en/nevibecode/skills/repo-standardizer.md) — skill · 33 installs
- [docs-sync-audit](https://affpapa.org/en/nevibecode/skills/docs-sync-audit.md) — skill · 68 installs
- [auto-repo-setup](https://affpapa.org/en/nevibecode/skills/auto-repo-setup.md) — skill · 534 installs

From the same set: [florianbruniaux/claude-code-ultimate-guide](https://affpapa.org/en/nevibecode/by/florianbruniaux/claude-code-ultimate-guide.md) — 45 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
