docs-audit

A project-audit step for planning documentation. It examines a project’s language, framework, existing documentation, interfaces, and documentation gaps before writing begins.

In plain words
What is it for?
Use it to analyze a project, choose how existing documentation should be handled, and prepare structured input for later documentation work.
Why use it?
It prevents documentation work from being based on guesses about the project or its missing information.

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/axiomantic/spellbook/docs-audit
Clone the repo
git clone --depth 1 https://github.com/axiomantic/spellbook
Per session 30 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,365 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.00030 $0.02365
Opus 5 $0.00015 $0.01182
Sonnet 5 $0.00006 $0.00473
Haiku 4.5 $0.00003 $0.00236

Measured 2d ago against content hash d4b544a2d540, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 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/docs-audit.md · 267 lines

How it starts

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

MISSION

Analyze the target project to build a complete picture of its language, framework, existing documentation, API surface, and documentation gaps. Produce a structured DocsAuditResult that subsequent phases consume. Every field must be populated or explicitly defaulted with user interview fallback.

Invariant Principles

  1. Detect, don't assume: Scan package manifests and source files. Never guess language from directory names alone.
  2. Every field populated: A DocsAuditResult with null or empty fields causes downstream failures. If detection fails, interview the user via AskUserQuestion.
  3. User chooses existing docs mode: Present all three options (audit+improve, start fresh, additive only). Never default silently.
  4. Graceful degradation: Missing manifest means interview the user, not a hard failure. Unsupported language means warn and default to MkDocs, not abort.

Execution Steps

Step 0: Create State Directory

PROJECT_ROOT=$(git rev-parse --show-toplevel 2>/dev/null || pwd)
# Follows the spellbook project-encoded path convention (see managing-artifacts skill):
# strip leading slash, replace remaining slashes with dashes.
PROJECT_ENCODED=$(echo "$PROJECT_ROOT" | sed 's|^/||' | tr '/' '-')
mkdir -p ~/.local/spellbook/docs/$PROJECT_ENCODED/doc-state/

Read the full file on GitHub · 267 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 · 267 lines · 30 tokens per session scan A d4b544a2d540

Subscribe to this mod's changes

docs-audit is a command published in the GitHub repository axiomantic/spellbook (10 stars, last pushed 7d ago), licensed MIT. It adds 30 tokens to every session and 2,365 once invoked, about $0.0002 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.