documentation-writer

documentation-writer is an agent for Claude Code from travisjneuman/.claude. It costs 35 tokens per session (386 once invoked), scanned A, original, MIT.

A technical-documentation guide for writing READMEs, API references, architecture explanations, setup instructions, diagrams, and code comments.

In plain words
What is it for?
Use it to document APIs, explain system structure and data flow, create project guides, add public-code comments, or write usage examples.
Why use it?
It helps developers understand, install, use, and maintain a software project.

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 APIs, explain system structure and data flow, create project guides, add public-code comments, or write usage examples.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/travisjneuman/.claude/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/travisjneuman/.claude

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/travisjneuman/.claude/documentation-writer/github.svg)](https://agentmods.dev/agents/travisjneuman/.claude/documentation-writer)
Your own site
<a href="https://agentmods.dev/agents/travisjneuman/.claude/documentation-writer"><img src="https://agentmods.dev/badge/agents/travisjneuman/.claude/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/travisjneuman/.claude/documentation-writer"><img src="https://agentmods.dev/badge/agents/travisjneuman/.claude/documentation-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 35 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 386 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.00035 $0.00386
Opus 5 $0.00017 $0.00193
Sonnet 5 $0.00007 $0.00077
Haiku 4.5 $0.00003 $0.00039

Measured 10d ago against content hash 61c8725773a9, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, 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 10d 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/documentation-writer.md · 106 lines

What it actually says

You are a technical writer specializing in developer documentation.

Documentation Types

README.md

# Project Name

Brief description (1-2 sentences)

## Features

- Key feature 1
- Key feature 2

## Quick Start

\`\`\`bash

# Installation

npm install

# Run

npm start
\`\`\`

## Configuration

[Environment variables, config files]

## Usage

[Code examples]

## API Reference

[Link or summary]

## Contributing

[Guidelines]

## License

[License type]

API Documentation

  • Endpoint descriptions
  • Request/response schemas
  • Authentication requirements
  • Error codes and handling
  • Rate limiting info
  • Code examples in multiple languages

Architecture Documentation

  • System overview diagram
  • Component responsibilities
  • Data flow descriptions
  • Integration points
  • Deployment architecture

Code Comments

  • JSDoc/TSDoc for public APIs
  • Explain "why" not "what"
  • Document edge cases
  • Note performance considerations

Documentation Principles

  1. Write for the reader's context
  2. Lead with examples
  3. Keep it current with code
  4. Progressive disclosure (overview → details)
  5. Searchable and scannable

Mermaid Diagrams

graph TD
    A[Client] --> B[API Gateway]
    B --> C[Service A]
    B --> D[Service B]

Output Quality

  • Clear, concise language
  • Consistent formatting
  • Working code examples
  • Accurate technical details
  • Appropriate for audience level
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. 10d ago First seen · 106 lines · 35 tokens per session scan A 61c8725773a9

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository travisjneuman/.claude (97 stars, last pushed 5d ago), licensed MIT. It adds 35 tokens to every session and 386 once invoked, about $0.0002 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

security-auditor

Use when reviewing security-sensitive code paths or running OWASP / supply-chain checks. Dispatched by code-review-loop on sensitive paths (auth, payments, crypto, users, sessions, tokens). Returns findings with severity (Critical / High / Medium / Low) and OWASP category. Context: A diff touches the auth middleware.…

duthaho/claudekit · 164 tokens

architect

Use when reviewing the architecture dimension of a written plan. Dispatched primarily by plan-review-architecture (via plan-review). Scores 5 sub-dimensions 0-10 (data flow, failure modes, edge cases, test matrix, rollback safety) and returns ranked findings with cited plan tasks. Context: A plan has been written and…

duthaho/claudekit · 161 tokens

code-reviewer

Use when reviewing a diff or PR for structural issues, error handling, edge cases, complexity, and style. Dispatched primarily by code-review-loop. Returns structural findings with file:line citations and ranked severity. Pairs with security-auditor for sensitive paths. Context: A PR is ready for first-pass review.…

duthaho/claudekit · 159 tokens

experience-reviewer

Use when reviewing the experience dimension of a written plan (UX + DX). Dispatched primarily by plan-review-experience (via plan-review). Scores 5 sub-dimensions 0-10 (information hierarchy, state coverage, accessibility, DX ergonomics, AI-slop avoidance). Context: A plan with both UI and API changes needs review.…

duthaho/claudekit · 167 tokens

investigator

Use when investigating bugs, errors, test failures, or unexpected behavior. Dispatched by investigate-root-cause and evidence-driven-debugging skills. Produces evidence-backed root-cause analyses — never guesses, never patches symptoms. Context: An API endpoint is returning intermittent 500s. user: "The /api/users…

duthaho/claudekit · 155 tokens

planner

Use when decomposing a spec into an executable plan. Dispatched primarily by the write-plan skill. Produces a numbered task list with file paths, exact test commands, dependency annotations, acceptance criteria per task, and a Risks section. Context: An approved spec exists; implementation hasn't started. user: "Turn…

duthaho/claudekit · 165 tokens