docs-audit

docs-audit is a command for Claude Code from fatihkan/badi. It costs 0 tokens per session (417 once invoked), scanned A, original, MIT.

A technical documentation audit that reviews guides, API references, comments, configuration explanations, and other project documents. It checks whether they are complete, current, accurate, and linked correctly.

In plain words
What is it for?
Use it to inventory documentation, compare it with code changes, check installation instructions and examples, find coverage gaps, and assess consistency.
Why use it?
It finds documentation that no longer matches the code, contains broken links or examples, or leaves important APIs and setup steps unexplained.

Command for Claude Code

Written for Claude Code: installed under .claude/.

Part of the badi plugin — 81 skills, 86 commands, 30 agents, 7 hooks shipped together

Good fit Use it to inventory documentation, compare it with code changes, check installation…

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/fatihkan/badi/docs-audit
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/fatihkan/badi

Made for: Claude Code.

Or install badi, the plugin that ships this one along with the rest of its 81 skills, 86 commands, 30 agents, 7 hooks.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-audit

README.md
[![agentmods](https://agentmods.dev/badge/commands/fatihkan/badi/docs-audit.svg)](https://agentmods.dev/commands/fatihkan/badi/docs-audit)
Your own site
<a href="https://agentmods.dev/commands/fatihkan/badi/docs-audit"><img src="https://agentmods.dev/badge/commands/fatihkan/badi/docs-audit.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 417 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00000 $0.00417
Opus 5 $0.00000 $0.00209
Sonnet 5 $0.00000 $0.00083
Haiku 4.5 $0.00000 $0.00042

Measured today against content hash b236d90127e5, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

docs-audit scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured today.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/docs-audit.md · 66 lines

What it actually says

Documentation audit command. Evaluates completeness, freshness, and quality of technical documentation.

Required Tools

  • Read (documentation files)
  • Grep (reference scan)
  • Glob (file discovery)
  • Bash (git log, file dates)

Procedure (5 Steps)

Step 1: Documentation Inventory

Scan all documentation files:

  • README.md files (root + subdirectories)
  • API documentation
  • Architecture documentation (including ADRs)
  • User guides
  • Developer guides
  • Install/getting-started instructions
  • CHANGELOG, CONTRIBUTING, SECURITY
  • In-code comments (JSDoc, docstrings, etc.)

Step 2: Completeness Check

For each document, verify:

  • Is it current? (last change date vs. related code changes)
  • Do referenced files/functions still exist?
  • Do the install steps still work?
  • Are the code examples current?
  • Any broken links?
  • Any missing sections?

Step 3: Coverage Gap Analysis

Detect undocumented areas:

  • Public APIs without documentation
  • Important directories without a README
  • Configuration files without explanations
  • Undocumented environment variables
  • Missing error-code descriptions

Step 4: Quality Assessment

  • Consistent format and tone?
  • The right level for the target audience?
  • Do the code examples run?
  • Are visuals/diagrams current?

Step 5: Report and Action Plan

Prioritize the findings:

  • CRITICAL: Wrong/misleading information
  • HIGH: Entirely missing documentation
  • MEDIUM: Outdated content
  • LOW: Improvable format/style

Output Format

=== BADI DOCUMENTATION AUDIT ===
Files Scanned: [count]
Coverage Score: [percent]%

CRITICAL: [count] findings
HIGH: [count] findings
MEDIUM: [count] findings
LOW: [count] findings

Most Urgent: [top 3 actions]
===================================
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. today First seen · 66 lines · 0 tokens per session scan A b236d90127e5

Subscribe to this mod's changes

docs-audit is a command published in the GitHub repository fatihkan/badi (7 stars, last pushed yesterday), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 417 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-06.