doc-create

A command that creates documentation by analyzing a codebase.

In plain words
What is it for?
Use it to generate a README, API reference, or templated document, with an optional Diátaxis category such as tutorial, how-to, reference, or explanation.
Why use it?
It reduces the manual work of starting project, API, or template-based documentation and helps choose an appropriate document structure.

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/zircote-plugins/documentation-review/doc-create
Clone the repo
git clone --depth 1 https://github.com/zircote-plugins/documentation-review
Per session 10 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,004 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.00010 $0.01004
Opus 5 $0.00005 $0.00502
Sonnet 5 $0.00002 $0.00201
Haiku 4.5 $0.00001 $0.00100

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

Security

Grade A, and why

doc-create 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/doc-create.md · 161 lines

How it starts

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

Generate new documentation based on codebase analysis.

Documentation Type

$IF($1, Generate: $1 documentation, Ask the user which type of documentation to create:

  • readme: Generate README.md from project analysis
  • api: Generate API documentation from code/specs
  • template: Create documentation from standard templates )

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

Before generating content, determine the Diátaxis quadrant:

  1. Check if the documentation type maps to a quadrant:

    • readme → typically mixed (overview), flag for later splitting
    • api → Reference quadrant
    • template → depends on template type
  2. Ask the user which quadrant the document serves:

    • Tutorial: learning-oriented, guided experience
    • How-to: task-oriented, solve a specific problem
    • Reference: information-oriented, technical descriptions
    • Explanation: understanding-oriented, context and background
  3. Apply the quadrant's structure template from the diataxis skill

  4. Set diataxis_type in frontmatter of the generated document

  5. Use the quadrant's tone and style guidelines during generation

Generation Workflows

README Generation (type: readme)

  1. Analyze Project Structure

    • Find package.json, pyproject.toml, go.mod, Cargo.toml
    • Identify primary language and framework
    • List main source directories
  2. Extract Project Information

    • Project name and description from manifest
    • Dependencies and their purposes
    • Available scripts/commands
    • Entry points and exports
  3. Generate Sections

    • Title and description
    • Features (from code analysis)
    • Installation (from package manager)
    • Quick start (from examples or main entry)
    • Configuration (from config files)
    • API overview (from exports)
    • Contributing (standard template)
    • License
  4. Write README.md Use Write tool to create the file.

API Documentation (type: api)

Read the full file on GitHub · 161 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 · 161 lines · 10 tokens per session scan A a689094e9431

Subscribe to this mod's changes

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