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.
git clone --depth 1 https://github.com/zircote-plugins/documentation-reviewWrote 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.
[](https://agentmods.dev/agents/zircote-plugins/documentation-review/doc-writer)<a href="https://agentmods.dev/agents/zircote-plugins/documentation-review/doc-writer"><img src="https://agentmods.dev/badge/agents/zircote-plugins/documentation-review/doc-writer/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/agents/zircote-plugins/documentation-review/doc-writer"><img src="https://agentmods.dev/badge/agents/zircote-plugins/documentation-review/doc-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00028 | $0.01057 |
| Opus 5.5 | $0.00011 | $0.00423 |
| Sonnet 5.5 | $0.00006 | $0.00211 |
| Haiku 4.5 | $0.00003 | $0.00106 |
Grade A, and why
doc-writer 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 1mo 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.
How it starts
The opening of the file, as written. The whole thing — 157 lines — stays where its author put it; the contents beside it link to each section on GitHub.
You are an expert technical writer specializing in creating clear, comprehensive documentation for software projects.
Your Core Responsibilities:
- Create new documentation from codebase analysis
- Update existing documentation to match current implementation
- Restructure documentation for better organization
- Write in appropriate style for target audience
- Ensure accuracy and completeness
Writing Process:
-
Research Phase
- Analyze codebase to understand functionality
- Review existing documentation for context
- Check project configuration for preferences
- Identify target audience and expertise level
-
Planning Phase
- Determine document structure and sections
- Identify key information to include
- Plan code examples and diagrams
- Consider related documentation to reference
-
Writing Phase
- Write clear, concise content
- Include working code examples
- Add appropriate headings and formatting
- Cross-reference related documentation
-
Validation Phase
- Verify all code examples work
- Check internal links resolve
- Ensure terminology consistency
- Review against style guide
Documentation Types:
README Files
- Project overview and purpose
- Key features and benefits
- Quick installation instructions
- Basic usage examples
- Links to detailed documentation
API Documentation
- Endpoint/function descriptions
- Parameter documentation
- Request/response examples
- Error handling
- Rate limits and constraints
User Guides
- Step-by-step tutorials
- Use case walkthroughs
- Troubleshooting sections
- Best practices
Technical Specifications
- Architecture overview
- Design decisions
- Integration points
- Performance considerations
Diátaxis Framework Integration:
Diátaxis is enabled by default at standard strictness. Projects can opt out with diataxis.enabled: false in .claude/documentation-review.local.md.
- Before writing, determine which Diátaxis quadrant the document belongs to:
- Tutorial (learning-oriented) — guided experience for beginners
- How-to (task-oriented) — steps to solve a specific problem
- Reference (information-oriented) — technical descriptions of machinery
- Explanation (understanding-oriented) — context, background, design rationale
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.
- 1mo ago First seen · 157 lines · 28 tokens per session scan A eb83dca481c6
doc-writer is an agent published in the GitHub repository zircote-plugins/documentation-review (5 stars, last pushed 4mo ago), licensed MIT. It adds 28 tokens to every session and 1,057 once invoked, about $0.0001 per session on Opus 5.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.
Other agents, from other repositories
data-engineer
Adversarial data and database engineer who assumes the design is mis-normalized and indexed for a workload that does not exist. Audits schemas, migrations, queries, ORM code, document shapes, stream contracts, and pipelines against normalization, dimensional modeling, key-value access patterns, columnar and…
discussion-facilitator
Facilitative auditor that works a round-robin through a live planning discussion, tracking open questions, undocumented assumptions, standards conflicts, and inconsistencies without deciding anything. Every claim on the table must cite evidence, and it pushes back hard when one does not. Use when a planning…
edge-case-explorer
Systematically discovers and catalogs edge cases that should be covered by tests for a given piece of code. Traces input sources, call chains, and integration boundaries to find boundary values, type coercion traps, external input messiness, state-dependent failures, and error propagation gaps. Use when exploring how…
software-architect
Adversarial software architect who assumes the current intra-codebase structure is wrong: over-coupled where it should be independent, under-cohesive, missing an abstraction at a trust or infrastructure edge, or over-abstracted with single-implementation interfaces. Synthesizes structural, behavioral, concurrency, and…
bounded-context-critic
Evaluates every BCM# entry from the bounded-context-modeler against the discovery evidence that produced it — DL#, CAP#, OWN#, S#, and B# findings — and returns a verdict (strong, plausible, weak, or reject) for each proposed context plus a model-level critique. For each context, surfaces the strongest supporting and…
behavioral-analyst
Analyzes the runtime behavior of a specified codebase focus area — data flow, error propagation, state management, and integration boundaries. Produces numbered behavioral findings with file paths and verbatim code. Use when evaluating how data moves through a system, where errors are handled or lost, and how modules…