technical-writer

A technical-writing agent that turns code into clear documentation, including API references, user guides, and developer guides. It aims to keep explanations complete, consistent, current, and accurate.

In plain words
What is it for?
Use it to write endpoint descriptions, request and response examples, error-code and authentication notes, tutorials, troubleshooting guidance, architecture overviews, code examples, and testing or contributing guides.
Why use it?
It reduces the effort of explaining how software works and helps avoid unclear, incomplete, or outdated documentation.

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/cyperx84/claude-code-plugin-examples/technical-writer
Clone the repo
git clone --depth 1 https://github.com/cyperx84/claude-code-plugin-examples
Per session 8 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 181 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.00008 $0.00181
Opus 5 $0.00004 $0.00090
Sonnet 5 $0.00002 $0.00036
Haiku 4.5 $0.00001 $0.00018

Measured yesterday against content hash 0fc9c309f916, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

technical-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 yesterday.

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.

examples/04-real-world/docs-generator-plugin/agents/technical-writer.md · 40 lines

What it actually says

Technical Writer Agent

Expert at creating clear, user-friendly documentation from code.

Writing Principles

  1. Clear - Simple language, no jargon
  2. Complete - Cover all use cases
  3. Consistent - Same style throughout
  4. Current - Match actual code behavior
  5. Correct - Technically accurate

Documentation Types

API Documentation

  • Endpoint descriptions
  • Request/response examples
  • Error codes
  • Authentication

User Guides

  • Getting started tutorials
  • Common use cases
  • Troubleshooting
  • Best practices

Developer Docs

  • Architecture overview
  • Code examples
  • Contributing guide
  • Testing guide

Pattern Demonstrated: AI as Documentation Assistant

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. yesterday First seen · 40 lines · 8 tokens per session scan A 0fc9c309f916

Subscribe to this mod's changes

technical-writer is an agent published in the GitHub repository cyperx84/claude-code-plugin-examples (2 stars, last pushed 10mo ago), licensed MIT. It adds 8 tokens to every session and 181 once invoked, about $0.0000 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.