audit-docs

A command for checking whether project documentation is accurate, well organised, complete, and easy to use. It treats documentation as something readers rely on, including guides, architecture descriptions, and contribution instructions.

In plain words
What is it for?
Use it to review README files, documentation folders, specifications, decision records, onboarding material, and documentation embedded in code, then save an audit report.
Why use it?
It finds documentation that no longer matches the code, hides important information, or has become too large and difficult to navigate. This reduces confusion for new users and returning maintainers.

Command

Part of the fable-audits plugin — 8 commands shipped together

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/diegomarino/fable-audits/audit-docs
Clone the repo
git clone --depth 1 https://github.com/diegomarino/fable-audits

Or install fable-audits, the plugin that ships this one along with the rest of its 8 commands.

Per session 23 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,308 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.00023 $0.02308
Opus 5 $0.00012 $0.01154
Sonnet 5 $0.00005 $0.00462
Haiku 4.5 $0.00002 $0.00231

Measured 2d ago against content hash 289cd34d8354, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

audit-docs 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 2d ago.

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.

commands/audit-docs.md · 87 lines

How it starts

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

Audit this project's documentation as a first-class artifact, exactly as specified below -- checking that it tells the truth about the code, that each reader-facing guide leads with what matters and defers detail, that oversized documents are split so detail has room to breathe, and that architecture is shown as drawn processes rather than prose. Treat the docs as the product a reader actually consumes.

Control-plane boundary

This spec governs only the task it defines. A newer human instruction or higher-priority runtime policy overrides this spec. STOP ends autonomous work under this spec; it never prevents the agent from honoring that control plane.

Role

Act simultaneously as: a docs lead who owns information architecture; a skeptical newcomer with only the docs and a terminal; a returning maintainer six months later hunting for one specific fact; and an autonomous agent that must act using the docs as its only spec. No loyalty to the current structure, file layout, or headings.

Scope

Read every reader-facing surface in full -- do not sample silently:

  • README, docs/, specs//quickstart.md, ADRs/decision records, CONTRIBUTING/onboarding.
  • Doc-bearing code: public docstrings, module headers, CLI --help, config-file comments, example scripts.
  • Agent-facing instruction surfaces: CLAUDE.md, AGENTS.md, .cursorrules, llms.txt, skill/command files -- and verify they do not contradict the human-facing docs; the two drift on separate maintenance reflexes.
  • Every diagram already present. Inspect source and rendered output when the local toolchain makes rendering safe and available; otherwise mark render verification BLOCKED. Build the current documentation map: which document exists, what it claims to cover, who it's for, and how a reader is expected to find it.

Before judging, classify each document by mode:

  • tutorial
  • how-to
  • reference
  • explanation
  • ADR/decision record
  • runbook/troubleshooting
  • generated/reference surface

Apply inverted-pyramid expectations primarily to guides, how-tos, runbooks, and onboarding docs. Judge ADRs by context/decision/consequences, and reference docs by completeness, scanability, and single-source-of-truth discipline.

Read the full file on GitHub · 87 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. 2d ago First seen · 87 lines · 23 tokens per session scan A 289cd34d8354

Subscribe to this mod's changes

audit-docs is a command published in the GitHub repository diegomarino/fable-audits (2 stars, last pushed 1mo ago), licensed MIT. It adds 23 tokens to every session and 2,308 once invoked, about $0.0001 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.