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.
npx agentmods add skills/zircote-plugins/documentation-review/documentation-standardsnpx skills add zircote-plugins/documentation-review --skill documentation-standardsgit 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/skills/zircote-plugins/documentation-review/documentation-standards)<a href="https://agentmods.dev/skills/zircote-plugins/documentation-review/documentation-standards"><img src="https://agentmods.dev/badge/skills/zircote-plugins/documentation-review/documentation-standards.svg" alt="Measured on agentmods" 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 | $0.00207 | $0.01999 |
| Opus 5 | $0.00103 | $0.01000 |
| Sonnet 5 | $0.00041 | $0.00400 |
| Haiku 4.5 | $0.00021 | $0.00200 |
Grade B, and why
documentation-standards scanned grade B with 1 finding 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 3d 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.
Strips warnings and disclaimersmediumAnti-refusal
Omitting safety caveats hides risk from the user and is a common jailbreak preamble.
2. Doc toolchain build must pass clean without warnings or errors 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.
Documentation Standards
Standards and patterns for creating, reviewing, and improving technical documentation. Good documentation reduces support burden, accelerates onboarding, and builds user trust — these standards exist to make that happen consistently.
Core Quality Principles
Documentation fails readers in predictable ways: unclear language forces re-reading, missing context creates dead ends, stale examples break trust, and inconsistent terminology confuses. These four principles address the root causes.
Clarity
- Write for the reader's level of expertise
- Define technical terms on first use
- Use active voice and direct language — "Configure the server" not "The server should be configured"
- Avoid jargon unless the audience expects it
Completeness
- Cover all essential topics for the document's purpose
- Include prerequisites and requirements upfront
- Provide working examples for technical concepts
- Document edge cases, limitations, and known issues
Accuracy
- Verify all technical details against current implementation
- Test code examples before including them — broken examples erode trust faster than missing docs
- Update documentation when code changes
- Remove or clearly mark deprecated content
Consistency
- Follow established style guides (project or industry standard)
- Use consistent terminology throughout — same concept, same name everywhere
- Maintain uniform formatting and structure
- Apply consistent code example styles
Document Structure
Standard Sections
README files:
- Title and brief description
- Features/highlights
- Installation/setup
- Quick start/usage
- Configuration options
- API reference (or link)
- Contributing guidelines
- License
Technical guides:
- Overview/introduction
- Prerequisites
- Step-by-step instructions
- Examples
- Troubleshooting
- Related resources
API documentation:
- Endpoint/function description
- Parameters (required/optional)
- Request/response formats
- Code examples
- Error responses
- Rate limits/constraints
What ships with it
6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.
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.
- 3d ago First seen · 267 lines · 207 tokens per session scan B 541896f21e2f
documentation-standards is a skill published in the GitHub repository zircote-plugins/documentation-review (5 stars, last pushed 2mo ago), licensed MIT. It adds 207 tokens to every session and 1,999 once invoked, about $0.0010 per session on Opus 5. A static security scan graded it B with 1 finding (strips warnings and disclaimers). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.
Other skills, from other repositories
documentation-writer
Write clear, scannable documentation using a research-first, phase-separated workflow. Covers READMEs, doc sites, API references, migration guides, and technical markdown. Uses web search for up-to-date facts and delegates broad repo reads to an explore subagent before drafting. Use when the user asks for…
walkthedoc
Run a command within a directory to check Markdown files for broken links and dead URLs.
technical-documentation
AI-powered technical documentation creation, maintenance, and auditing across README, ADR, API docs, runbooks, onboarding guides, changelogs, knowledge bases, and AI agent context files (AGENTS.md/CLAUDE.md). Primary keywords: technical documentation writing automation, ADR architecture decision record, API docs…
API Documentation Generator
AI-powered API documentation generation tool that auto-generates comprehensive API docs from source code, including OpenAPI/Swagger specs, Postman collections, and markdown documentation with examples and authentication details.
documentation-standards
Use when writing README files, API documentation, user guides, or technical documentation following industry standards from Google, Microsoft, and GitLab style guides.
decided-import
Reformat ONE existing document (a decision, requirement, design, roadmap, or prompt) into ONE valid RAC (requirements-as-code) artifact, with a mandatory human-review step before any file is written and decided validate as the deterministic close. Use when a user wants to add or import a single existing decision or…