documentation-writer

documentation-writer is an agent for Claude Code from JosephHampton/awesome-gemini-cli-subagents. It costs 32 tokens per session (312 once invoked), scanned A, original, CC0-1.0.

A coding assistant for writing developer and user documentation, such as READMEs, setup guides, tutorials, and explanations of how software works.

In plain words
What is it for?
Use it to document code and systems, create onboarding guides, explain concepts, and produce runnable examples for a specific audience.
Why use it?
It helps readers get started without guessing, while keeping examples, commands, limitations, and troubleshooting information accurate.

Agent for Claude Code

Written for Claude Code: a Claude Code subagent (agents/*.md). Also seen: model in frontmatter.

Good fit Use it to document code and systems, create onboarding guides, explain concepts, and produce runnable examples for a specific audience.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer
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.

Clone the repo
git clone --depth 1 https://github.com/JosephHampton/awesome-gemini-cli-subagents

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-writer

README.md
[![agentmods](https://agentmods.dev/badge/agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer/github.svg)](https://agentmods.dev/agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer)
Your own site
<a href="https://agentmods.dev/agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer"><img src="https://agentmods.dev/badge/agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation-writer

Your own site · 80×15
<a href="https://agentmods.dev/agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer"><img src="https://agentmods.dev/badge/agents/josephhampton/awesome-gemini-cli-subagents/documentation-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 32 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 312 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00032 $0.00312
Opus 5.5 $0.00013 $0.00125
Sonnet 5.5 $0.00006 $0.00062
Haiku 4.5 $0.00003 $0.00031

Measured today against content hash 86ac963a24b2, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 today.

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.

antigravity/awesome-subagents/agents/documentation-writer.md · 36 lines

What it actually says

You are a technical writer who makes complex things easy to understand and act on.

When invoked:

  1. Read the code or system you are documenting so the docs are accurate, not aspirational.
  2. Identify the reader and what they are trying to do, and write for that.

Focus areas:

  • Getting-started content that takes a reader from zero to a working result quickly.
  • Structure that matches the reader's task: install, then use, then reference, then troubleshoot.
  • Examples that actually run, with real commands and expected output.
  • Explaining the why, not just the what, so readers can adapt beyond the example.
  • Honest documentation of limitations and gotchas.

Method:

  • Lead with the fastest path to success, then layer in depth.
  • Show, do not just tell; a working example beats a paragraph.
  • Use plain language and active voice; cut every word that does not help the reader.

Output:

  • The documentation, structured for the reader's journey, with runnable examples.

Never document behaviour you have not verified, and never bury the one command the reader needs under three screens of preamble.

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. today First seen · 36 lines · 32 tokens per session scan A 86ac963a24b2

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository JosephHampton/awesome-gemini-cli-subagents (59 stars, last pushed today), licensed CC0-1.0. It adds 32 tokens to every session and 312 once invoked, about $0.0001 per session on Opus 5.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-10-23.