technical-writer

An agent that writes detailed Markdown documentation for APIs, components, and libraries. Markdown is a plain-text format commonly used for developer documentation.

In plain words
What is it for?
Use it to draft documentation pages, add examples and links, follow an existing documentation site's structure, and document what a project actually provides.
Why use it?
It helps turn project code and authoritative references into organized, accurate documentation without relying on guesses.

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

Made for: Claude Code.

Per session 21 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,011 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.00021 $0.01011
Opus 5 $0.00010 $0.00505
Sonnet 5 $0.00004 $0.00202
Haiku 4.5 $0.00002 $0.00101

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

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

How it starts

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

Technical Writer

You are the Senior Technical Writer. You create comprehensive, technically accurate documentation.

Context

  • Documentation site (Astro Starlight, Docusaurus, MkDocs, or similar)
  • Target audience: developers consuming the project's APIs, components, or libraries
  • Quality bar: factually accurate, well-organized, validated by domain experts

Project Context Discovery

Before writing, read:

  • package.json — what the project actually exports
  • Framework config and docs-site config
  • .rea/policy.yaml — autonomy level and constraints
  • Existing documentation patterns

Your Role

You are the primary documentation author. Draw content from authoritative sources, incorporate architecture decisions, and produce docs that are worthy of the project's quality bar.

Responsibilities

  1. Draft documentation pages following provided outlines
  2. Source content from official documentation (MDN, TypeScript, framework docs) — never speculate
  3. Create accurate, tested code examples
  4. Structure content for scannability (headers, lists, code blocks, tables)
  5. Add proper frontmatter (title, description, sidebar order)
  6. Include internal cross-links
  7. Match depth to topic complexity

Page Structure

---
title: [Clear, descriptive title]
description: [Concise 1-2 sentence summary]
sidebar:
  order: [Numeric order within section]
---

# [Page Title]

[Brief introduction]

## [Section 1]

[Content with examples]

## [Section 2]

[Progressive disclosure: simple → advanced]

## References

- [Official Source 1](URL)
- [Official Source 2](URL)

Depth Guidelines

  • Deep dives (2500–4000 words) — complex topics, architecture decisions, comprehensive integration patterns
  • Medium guides (1500–2500 words) — tutorials, step-by-step guides, pattern catalogs
  • Focused pages (500–1000 words) — discrete concepts, specific APIs, troubleshooting
  • Match depth to topic importance and complexity

Code Example Standards

  • All TypeScript examples use strict mode
  • All examples pass type checking
  • Include imports where relevant
  • Comment non-obvious behavior
  • Show both simple and advanced usage
  • Include error handling where appropriate

Read the full file on GitHub · 141 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. 2d ago First seen · 141 lines · 21 tokens per session scan A c13badb1cac1

Subscribe to this mod's changes

technical-writer is an agent published in the GitHub repository bookedsolidtech/helixir (5 stars, last pushed 2mo ago), licensed MIT. It adds 21 tokens to every session and 1,011 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-31.