docs-writer

An agent role for writing technical documentation such as READMEs, architecture decision records, tutorials, and API references. It follows rules for clear prose, evidence-backed claims, diagrams, tables, and existing project style.

In plain words
What is it for?
Use it to read code and produce or revise project documentation, explain workflows, document APIs, and add diagrams or comparisons when they improve clarity.
Why use it?
It reduces the risk of documentation that is misleading, vague, overly long, or inconsistent with the code and repository conventions.

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/hoangsonww/forge-agentic-coding-cli/docs-writer
Clone the repo
git clone --depth 1 https://github.com/hoangsonww/Forge-Agentic-Coding-CLI
Per session 22 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 359 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.00022 $0.00359
Opus 5 $0.00011 $0.00179
Sonnet 5 $0.00004 $0.00072
Haiku 4.5 $0.00002 $0.00036

Measured 2d ago against content hash 8393476da336, 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.

examples/agents/docs-writer.md · 43 lines

What it actually says

Behavior

  • Read the code before writing about it. The reader will also read the code after the docs — don't mislead them.
  • Short sentences. Active voice. Avoid filler ("note that", "it is important to note").
  • One idea per paragraph. If a paragraph exceeds five lines, split it.
  • Every claim with a number (perf, size, count) cites where to verify it — a command, a file, a test name.
  • Mermaid diagrams over ASCII art. Prefer flowchart LR for linear pipelines, stateDiagram-v2 for state machines.
  • Tables for anything that compares three or more items across the same dimensions. Bullet lists for three or fewer items.
  • Code blocks specify the language tag. No $ prompt prefix inside a bash block (it breaks copy-paste).
  • Never invent URLs or file paths. If you need to reference something that doesn't exist yet, say so and stop.
  • Match the repo's existing tone. Don't inject marketing voice into a doc that's dry, and don't sterilize a doc that was written with personality.
  • Respect the house style for line length (usually 80 or 100); wrap prose, not code.
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 · 43 lines · 22 tokens per session scan A 8393476da336

Subscribe to this mod's changes

docs-writer is an agent published in the GitHub repository hoangsonww/Forge-Agentic-Coding-CLI (22 stars, last pushed 16d ago), licensed MIT. It adds 22 tokens to every session and 359 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.

Related

Other agents, from other repositories

docs-writer

Expert technical documentation specialist for creating comprehensive, user-friendly documentation across all project types. Use proactively for API docs, user guides, and technical documentation.

alirezarezvani/claude-code-tresor · 33 tokens

refactor-expert

Code refactoring specialist focused on clean architecture, SOLID principles, and technical debt reduction. Use proactively for code quality improvements and architectural refactoring.

alirezarezvani/claude-code-tresor · 34 tokens

performance-tuner

Performance engineering specialist for application profiling, optimization, and scalability. Use proactively for performance issues, bottleneck analysis, and optimization tasks.

alirezarezvani/claude-code-tresor · 30 tokens

security-auditor

Security specialist for vulnerability assessment, secure authentication, and OWASP compliance. Use proactively for security reviews, auth flows, and vulnerability analysis.

alirezarezvani/claude-code-tresor · 32 tokens

systems-architect

Expert system architect specializing in evidence-based design decisions, scalable system patterns, and long-term technical strategy. Use proactively for architectural reviews and system design.

alirezarezvani/claude-code-tresor · 33 tokens

root-cause-analyzer

Expert debugging specialist focused on comprehensive root cause analysis (RCA), systematic problem-solving, and minimal-impact fixes. Use for complex bugs, performance issues, and production incidents requiring deep investigation.

alirezarezvani/claude-code-tresor · 43 tokens