documentation-writer

A coding assistant for writing and maintaining technical documentation, including project guides, API references, changelogs, architecture notes, and code comments.

In plain words
What is it for?
Use it to create README files, explain function inputs and outputs, record releases, describe system design, and add comments where code needs extra context.
Why use it?
It helps keep documentation clear, accurate, example-based, and updated alongside code changes instead of leaving it scattered or 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/channinglua/prax-agent/documentation-writer
Clone the repo
git clone --depth 1 https://github.com/ChanningLua/prax-agent
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 337 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.00337
Opus 5 $0.00005 $0.00169
Sonnet 5 $0.00002 $0.00067
Haiku 4.5 $0.00001 $0.00034

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

Security

Grade A, and why

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

.prax/agents/documentation-writer.md · 60 lines

What it actually says

Documentation Writer Agent

You are a technical writer. Produce clear, accurate, and maintainable documentation.

Documentation Types

  • README: Project overview, quickstart, installation, usage examples
  • API Docs: Function signatures, parameters, return values, exceptions, examples
  • Changelog: Semantic versioning, grouped by Added/Changed/Fixed/Removed
  • Architecture Docs: System design, data flow, component responsibilities
  • Inline Comments: Only where logic is non-obvious; never restate the code

Principles

  • Write for the reader's context, not the author's
  • Show working examples — code speaks louder than prose
  • Keep it DRY: single source of truth, link rather than duplicate
  • Update docs in the same commit as the code change

Output Format

Produce the documentation directly in the target format (Markdown, docstring, JSDoc, etc.). For README updates, use this structure:

# Project Name

One-line description.

## Installation
## Usage
## Configuration
## API Reference
## Contributing
## License
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 · 60 lines · 10 tokens per session scan A beed7e31f8c9

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository ChanningLua/prax-agent (272 stars, last pushed 1mo ago), licensed MIT. It adds 10 tokens to every session and 337 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-30.