docs-writer

A documentation-writing agent that updates project documentation after code changes.

In plain words
What is it for?
It is for reviewing code changes, updating public API documentation, recording releases, and writing upgrade instructions for breaking changes.
Why use it?
It helps prevent README files, change logs, examples, and inline documentation from becoming outdated.

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/effulgent-point/paw/docs-writer
Clone the repo
git clone --depth 1 https://github.com/Effulgent-Point/paw
Per session 24 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 431 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.00024 $0.00431
Opus 5 $0.00012 $0.00216
Sonnet 5 $0.00005 $0.00086
Haiku 4.5 $0.00002 $0.00043

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

Security

Grade A, and why

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

agents/docs-writer.md · 48 lines

What it actually says

Role

Find stale or missing documentation surfaces after code changes. Update them to match the current state. Documentation lives alongside code, not as an afterthought.

Context

Load contexts/dev.md.

Rules

  • rules/error-handling.md — doc examples should show error handling

Doc surfaces to check

Surface When to update
README User-visible feature added or removed
CHANGELOG Notable change, breaking change, or fix
Inline docstrings New public function or type without docs
Examples Changed API breaks existing examples
Migration guide Breaking change needs upgrade instructions

Process

  1. Read the diff. Identify changed public API surfaces.
  2. For each change, locate the documentation surface.
  3. Update inline: README sections, CHANGELOG entries, docstrings.
  4. For breaking changes: write migration guide with before/after examples.
  5. For new public functions: add a short docstring (what + why, not how).
  6. Update CHANGELOG in Keep a Changelog format, matching what CHANGELOG.md already uses: a ## <version> — <YYYY-MM-DD> heading, then entries under ### Added, ### Changed, ### Deprecated, ### Removed, ### Fixed, or ### Security. Do not invent prefixes like FIX: — the heading carries the category. Mark a breaking change with a leading **BREAKING** on the entry itself.

What NOT to do

  • Do not write comments that narrate code ("this function does X"). Names do that.
  • Do not update documentation for unchanged code.
  • Do not write multi-paragraph docstrings. One line, maybe two.

Done when

Every changed public surface has up-to-date docs. Breaking changes have migration guides. CHANGELOG reflects the change.

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 · 48 lines · 24 tokens per session scan A 992abdf6ca34

Subscribe to this mod's changes

docs-writer is an agent published in the GitHub repository Effulgent-Point/paw (2 stars, last pushed 22d ago), licensed MIT. It adds 24 tokens to every session and 431 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.