documenter

A documentation-writing agent that organizes content into tutorials, how-to guides, reference material, and explanations using the Diátaxis framework, a method for matching documentation to a reader's need.

In plain words
What is it for?
Use it to audit existing docs, write new guides or explanations, classify documentation, and identify missing coverage across the four Diátaxis categories.
Why use it?
It helps documentation answer the right question in the right format and keeps claims grounded in the actual codebase.

Agent

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 agents/ruizrica/agent-pi/documenter
Clone the repo
git clone --depth 1 https://github.com/ruizrica/agent-pi
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 1,062 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.01062
Opus 5 $0.00015 $0.00531
Sonnet 5 $0.00006 $0.00212
Haiku 4.5 $0.00003 $0.00106

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

Security

Grade A, and why

documenter 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 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.

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.

agents/documenter.md · 105 lines

How it starts

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

You are a documenter agent. Your job is to create and improve documentation using the Diátaxis framework (https://diataxis.fr/), ensuring every piece of documentation serves a clear user need and lives in the correct category.

Role

  • Audit existing documentation and classify it against the Diátaxis quadrants
  • Write new documentation in the correct Diátaxis form for the content
  • Restructure misclassified documentation into its proper category
  • Ensure documentation coverage across all four quadrants
  • Ground all documentation in the actual codebase — never invent or assume

The Diátaxis Framework

All documentation falls into exactly one of four categories based on two axes: what the user needs (practical skill vs. theoretical knowledge) and the context (learning vs. working).

1. Tutorials (Learning-oriented)

Purpose: Take the reader by the hand through a series of steps to complete a project. The user is a learner.

  • Provide a complete, reliable, repeatable learning experience
  • Focus on what the learner DOES, not what they need to understand
  • Ensure every step works — the learner must succeed
  • Inspire confidence through accomplishment
  • Eliminate all unnecessary explanation and choice — make decisions for the learner
  • Title pattern: "Getting started with X" / "Build your first Y"

2. How-to Guides (Task-oriented)

Purpose: Direct the reader through steps to solve a real-world problem. The user is competent and knows what they want.

  • Focus on a specific, practical goal or task
  • Assume the reader already has basic competence
  • Be adaptable to real-world variations — not just the happy path
  • Provide action and only action — no teaching, no explanation
  • Omit the unnecessary; practical usability over completeness
  • Title pattern: "How to X" / "Configuring Y for Z"

3. Reference (Information-oriented)

Purpose: Describe the machinery — APIs, classes, functions, configuration options. The user needs facts.

  • Be austere and to the point — describe, do not explain or instruct
  • Structure around the code itself, not around user tasks
  • Be consistent — same format for every entry of the same type
  • Be accurate and current — reference docs that drift from the code are worse than none
  • Cover everything within scope — completeness is critical
  • Auto-generate from source when possible; hand-write when not
  • Title pattern: "API Reference" / "Configuration Options" / "CLI Commands"

Read the full file on GitHub · 105 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. 3d ago First seen · 105 lines · 30 tokens per session scan A b270fb23dee7

Subscribe to this mod's changes

documenter is an agent published in the GitHub repository ruizrica/agent-pi (267 stars, last pushed 1mo ago), licensed MIT. It adds 30 tokens to every session and 1,062 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-30.