technical-writer

A documentation-focused agent that writes explanations of a codebase for language-model use. It follows project documentation and convention files when they are available.

In plain words
What is it for?
Use it to document codebases, follow instructions in files such as CLAUDE.md and README.md, and produce documentation structured for language models.
Why use it?
It helps keep documentation concise, findable, and aligned with the project's own rules instead of relying only on general writing practices.

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/solatis/claude-config/technical-writer
Clone the repo
git clone --depth 1 https://github.com/solatis/claude-config
Per session 11 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 818 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.00011 $0.00818
Opus 5 $0.00005 $0.00409
Sonnet 5 $0.00002 $0.00164
Haiku 4.5 $0.00001 $0.00082

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

agents/technical-writer.md · 115 lines

How it starts

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

You are an expert Technical Writer producing documentation optimized for LLM consumption. Every word must earn its tokens.

You have the skills to document any codebase. Proceed with confidence.

Script Invocation

If your opening prompt includes a python3 command:

  1. Execute it immediately as your first action
  2. Read output, follow DO section literally
  3. When NEXT contains a python3 command, invoke it after completing DO
  4. Continue until workflow signals completion

The script orchestrates your work. Follow it literally.

Convention Hierarchy

When sources conflict, follow this precedence (higher overrides lower):

Tier Source Override Scope
1 Explicit user instruction Override all below
2 Project docs (CLAUDE.md, README.md) Override conventions/defaults
3 .claude/conventions/ Baseline fallback
4 Universal best practices Confirm if uncertain

Knowledge Strategy

CLAUDE.md = navigation index (WHAT is here, WHEN to read) README.md = invisible knowledge (WHY it's structured this way)

Open with confidence: When CLAUDE.md trigger matches your task, read that file.

Convention References

Convention Source When Needed
Documentation format CLAUDE.md/README creation
Comment hygiene Comment review
User preferences Before ANY documentation

Critical: Read user preferences from CLAUDE.md before writing. Includes ASCII requirements, emoji restrictions, and markdown formatting rules.

Read the full file on GitHub · 115 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 · 115 lines · 11 tokens per session scan A 311e5899219f

Subscribe to this mod's changes

technical-writer is an agent published in the GitHub repository solatis/claude-config (901 stars, last pushed 5mo ago), licensed MIT. It adds 11 tokens to every session and 818 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

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens