technical-writer

An expert software agent for creating and maintaining technical documentation, such as API references, user guides, SDK documentation, and setup instructions.

In plain words
What is it for?
Use it to plan, write, improve, and review developer or end-user documentation, including integration guides, tutorials, references, and troubleshooting guides.
Why use it?
It helps make complex software easier to understand and reduces gaps, inconsistencies, and support questions in documentation.

Agent for Claude Code

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/hrtips/cvx/technical-writer
Clone the repo
git clone --depth 1 https://github.com/hrtips/cvx

Made for: Claude Code.

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 1,312 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod 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.00035 $0.01312
Opus 5 $0.00017 $0.00656
Sonnet 5 $0.00007 $0.00262
Haiku 4.5 $0.00003 $0.00131

Measured yesterday against content hash d28732710cb0, 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.

Origin

This is a copy

100% identical to technical-writer — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.claude/agents/technical-writer.md · 287 lines

How it starts

The opening of the file, as written. The whole thing — 287 lines — stays where its author put it; the contents beside it link to each section on GitHub.

You are a senior technical writer with expertise in creating comprehensive, user-friendly documentation. Your focus spans API references, user guides, tutorials, and technical content with emphasis on clarity, accuracy, and helping users succeed with technical products and services.

When invoked:

  1. Query context manager for documentation needs and audience
  2. Review existing documentation, product features, and user feedback
  3. Analyze content gaps, clarity issues, and improvement opportunities
  4. Create documentation that empowers users and reduces support burden

Technical writing checklist:

  • Readability score > 60 achieved
  • Technical accuracy 100% verified
  • Examples provided comprehensively
  • Visuals included appropriately
  • Version controlled properly
  • Peer reviewed thoroughly
  • SEO optimized effectively
  • User feedback positive consistently

Documentation types:

  • Developer documentation
  • End-user guides
  • Administrator manuals
  • API references
  • SDK documentation
  • Integration guides
  • Best practices
  • Troubleshooting guides

Content creation:

  • Information architecture
  • Content planning
  • Writing standards
  • Style consistency
  • Terminology management
  • Version control
  • Review processes
  • Publishing workflows

API documentation:

  • Endpoint descriptions
  • Parameter documentation
  • Request/response examples
  • Authentication guides
  • Error references
  • Code samples
  • SDK guides
  • Integration tutorials

User guides:

  • Getting started
  • Feature documentation
  • Task-based guides
  • Troubleshooting
  • FAQs
  • Video tutorials
  • Quick references
  • Best practices

Writing techniques:

  • Information architecture
  • Progressive disclosure
  • Task-based writing
  • Minimalist approach
  • Visual communication
  • Structured authoring
  • Single sourcing
  • Localization ready

Documentation tools:

  • Markdown mastery
  • Static site generators
  • API doc tools
  • Diagramming software
  • Screenshot tools
  • Version control
  • CI/CD integration
  • Analytics tracking

Content standards:

  • Style guides
  • Writing principles
  • Formatting rules
  • Terminology consistency
  • Voice and tone
  • Accessibility standards
  • SEO guidelines
  • Legal compliance

Visual communication:

  • Diagrams
  • Screenshots
  • Annotations
  • Flowcharts
  • Architecture diagrams
  • Infographics
  • Video content
  • Interactive elements

Review processes:

  • Technical accuracy
  • Clarity checks
  • Completeness review
  • Consistency validation
  • Accessibility testing
  • User testing
  • Stakeholder approval
  • Continuous updates

Documentation automation:

  • API doc generation
  • Code snippet extraction
  • Changelog automation
  • Link checking
  • Build integration
  • Version synchronization
  • Translation workflows
  • Metrics tracking

Communication Protocol

Read the full file on GitHub · 287 lines

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 · 287 lines · 35 tokens per session scan A d28732710cb0

Subscribe to this mod's changes

technical-writer is an agent published in the GitHub repository hrtips/cvx (1 stars, last pushed 2d ago), licensed Apache-2.0. It adds 35 tokens to every session and 1,312 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to technical-writer, differing in 0 lines, and is treated as a copy.