audit

A documentation checker that reviews a project's README files, docs, API descriptions, and code comments against configured standards.

In plain words
What is it for?
Use it to run a quick checklist or create a detailed report covering setup instructions, main features, API endpoints, and documentation coverage.
Why use it?
It helps find missing, incomplete, or poorly structured documentation without checking every file manually.

Command

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.

agentmods
npx agentmods add commands/hculap/better-code/audit
Clone the repo
git clone --depth 1 https://github.com/hculap/better-code
Per session 5 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,184 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00005 $0.01184
Opus 5 $0.00003 $0.00592
Sonnet 5 $0.00001 $0.00237
Haiku 4.5 $0.00001 $0.00118

Measured yesterday against content hash fbe741f0af65, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

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 yesterday.

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.

plugins/doc-master/commands/audit.md · 217 lines

How it starts

The opening of the file, as written. The whole thing — 217 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Audit

Analyze existing documentation for quality, completeness, and adherence to configured standards.

Arguments

  • path (optional): Directory to audit (default: ./docs or project root)
  • --detailed: Generate comprehensive report with scores and recommendations
  • --checklist: Quick pass/fail checklist (default mode)

Process

Step 1: Load Configuration

Read .claude/doc-master.local.md to determine active documentation standard:

  • Diátaxis: Audit against four-quadrant criteria
  • Traditional: Audit against hierarchical structure
  • Custom: Audit against custom rules

If no configuration exists, suggest running /doc-master:setup first, but proceed with Diátaxis as default.

Step 2: Discover Documentation

Search for documentation files:

- README.md, README files
- docs/ directory
- *.md files in common locations
- API documentation (openapi.yaml, swagger.json)
- Inline documentation (JSDoc, docstrings)

Step 3: Analyze Documentation

Checklist Mode (default)

Quick pass/fail assessment:

Completeness

  • README exists and has content
  • Installation/setup documented
  • Main features have documentation
  • API endpoints documented (if applicable)
  • Configuration options listed

Accuracy

  • Code examples appear current
  • Version information present
  • No obviously outdated content
  • Links are valid (spot check)

Clarity

  • Headings are descriptive
  • Code examples present
  • Consistent formatting

Organization

  • Logical structure
  • Navigation/TOC present
  • Related content linked
Detailed Mode

Comprehensive analysis with scoring:

1. Coverage Analysis (0-10)

  • Map documented vs undocumented code
  • Check for missing API documentation
  • Identify undocumented features
  • List documentation gaps

2. Quality Score (0-10)

  • Writing quality assessment
  • Code example validation
  • Formatting consistency
  • Terminology consistency

3. Freshness Assessment (0-10)

  • Last modification dates
  • Version alignment
  • Outdated content detection
  • Stale examples identification

Read the full file on GitHub · 217 lines

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. yesterday First seen · 217 lines · 5 tokens per session scan A fbe741f0af65

Subscribe to this mod's changes

audit is a command published in the GitHub repository hculap/better-code (2 stars, last pushed 7mo ago), licensed MIT. It adds 5 tokens to every session and 1,184 once invoked, about $0.0000 per session on Opus 5. 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-08-31.