doc-review

doc-review is a command for coding agents from zircote-plugins/documentation-review. It costs 12 tokens per session (720 once invoked), scanned A, original, MIT.

A command for checking project documentation for accuracy, completeness, clarity, and formatting. It can review selected files or the project's usual documentation paths.

In plain words
What is it for?
Use it to inspect README and Markdown files, verify examples and API references, find missing or placeholder content, assess readability, and check code blocks, lists, tables, and headings.
Why use it?
Documentation may contain examples that no longer run, missing setup steps, broken links, unclear terms, or inconsistent formatting. This review identifies those problems against the current code and configured rules.

Command

Part of the documentation-review plugin — 4 skills, 6 commands, 2 agents 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/zircote-plugins/documentation-review/doc-review
Clone the repo
git clone --depth 1 https://github.com/zircote-plugins/documentation-review

Or install documentation-review, the plugin that ships this one along with the rest of its 4 skills, 6 commands, 2 agents.

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 doc-review

README.md
[![agentmods](https://agentmods.dev/badge/commands/zircote-plugins/documentation-review/doc-review.svg)](https://agentmods.dev/commands/zircote-plugins/documentation-review/doc-review)
Your own site
<a href="https://agentmods.dev/commands/zircote-plugins/documentation-review/doc-review"><img src="https://agentmods.dev/badge/commands/zircote-plugins/documentation-review/doc-review.svg" alt="Measured on agentmods" height="20"></a>
Per session 12 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 720 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.00012 $0.00720
Opus 5 $0.00006 $0.00360
Sonnet 5 $0.00002 $0.00144
Haiku 4.5 $0.00001 $0.00072

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

Security

Grade A, and why

doc-review 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 4d 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/doc-review.md · 124 lines

How it starts

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

Review documentation for quality issues.

Target Scope

$IF($1, Focus on: @$1, Scan all documentation in configured paths )

Configuration Check

Use Glob tool to check if .claude/documentation-review.local.md exists.

If configuration exists, read it with Read tool for custom settings. Otherwise, use default paths: docs/, README.md, *.md

Review Process

  1. Inventory Documentation

    • Use Glob to find all markdown files in scope
    • List files with their last modified dates
  2. Content Analysis For each document, evaluate:

    Accuracy

    • Verify code examples compile/run
    • Check that API references match implementation
    • Validate version numbers are current
    • Confirm links are not broken

    Completeness

    • Ensure all sections have content
    • Check for missing prerequisites
    • Verify examples cover common use cases
    • Look for TODO or placeholder text

    Clarity

    • Assess heading structure (proper hierarchy)
    • Check for undefined technical terms
    • Evaluate sentence complexity
    • Look for ambiguous instructions

    Formatting

    • Verify code blocks have language tags
    • Check list formatting consistency
    • Validate table structure
    • Assess whitespace usage

    Diátaxis Alignment (enabled by default; disable with diataxis.enabled: false)

    • Classify each document into its Diátaxis quadrant (tutorial, how-to, reference, explanation)
    • Check for diataxis_type frontmatter — flag if missing (when require_frontmatter: true)
    • Score mode purity — flag sections where content drifts into another quadrant
    • Evaluate cross-references between quadrants
    • Apply strictness level from config: advisory (suggestions), standard (flagged issues), strict (errors)
    • Use the diataxis skill for classification compass and quality criteria
  3. Generate Report

    Organize findings by severity:

    Critical Issues

    • Incorrect technical information
    • Broken code examples
    • Missing critical sections

Read the full file on GitHub · 124 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. 4d ago First seen · 124 lines · 12 tokens per session scan A f24210ba54b8

Subscribe to this mod's changes

doc-review is a command published in the GitHub repository zircote-plugins/documentation-review (5 stars, last pushed 2mo ago), licensed MIT. It adds 12 tokens to every session and 720 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.