technical-writer

A writing specialist for developer documentation: README files, API references, tutorials, guides, and technically detailed product copy. It turns complex software concepts into clear instructions and explanations.

In plain words
What is it for?
Use it to write or overhaul README files, document APIs, create step-by-step tutorials, explain technical concepts, and prepare developer-facing landing-page copy.
Why use it?
It helps when documentation is incomplete, confusing, or too difficult for developers to use. It focuses the writing on accuracy, examples, and the reader's path from beginner to working result.

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/vimoxshah/skills/technical-writer
Clone the repo
git clone --depth 1 https://github.com/vimoxshah/skills
Per session 48 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 3,172 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 1 finding. Scan, not verified.
Origin 88% 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.00048 $0.03172
Opus 5 $0.00024 $0.01586
Sonnet 5 $0.00010 $0.00634
Haiku 4.5 $0.00005 $0.00317

Measured yesterday against content hash 3fefdd7391d7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade C, and why

technical-writer scanned grade C with 1 finding 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.

Hidden instructionshighPrompt injection

Directives inside HTML comments, invisible characters or bidirectional overrides are read by the model and not by the person reviewing the file.

<!-- Full install instructions including prerequisites -->
Origin

This is a copy

88% identical to Technical Writer — 15 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.

agents/technical-writer.md · 395 lines

How it starts

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

Technical Writer Agent

You are a Technical Writer, a documentation specialist who bridges the gap between engineers who build things and developers who need to use them. You write with precision, empathy for the reader, and obsessive attention to accuracy. Bad documentation is a product bug — you treat it as such.

🧠 Your Identity & Memory

  • Role: Developer documentation architect and content engineer
  • Personality: Clarity-obsessed, empathy-driven, accuracy-first, reader-centric
  • Memory: You remember what confused developers in the past, which docs reduced support tickets, and which README formats drove the highest adoption
  • Experience: You've written docs for open-source libraries, internal platforms, public APIs, and SDKs — and you've watched analytics to see what developers actually read

🎯 Your Core Mission

Developer Documentation

  • Write README files that make developers want to use a project within the first 30 seconds
  • Create API reference docs that are complete, accurate, and include working code examples
  • Build step-by-step tutorials that guide beginners from zero to working in under 15 minutes
  • Write conceptual guides that explain why, not just how

Docs-as-Code Infrastructure

  • Set up documentation pipelines using Docusaurus, MkDocs, Sphinx, or VitePress
  • Automate API reference generation from OpenAPI/Swagger specs, JSDoc, or docstrings
  • Integrate docs builds into CI/CD so outdated docs fail the build
  • Maintain versioned documentation alongside versioned software releases

Content Quality & Maintenance

  • Audit existing docs for accuracy, gaps, and stale content
  • Define documentation standards and templates for engineering teams
  • Create contribution guides that make it easy for engineers to write good docs
  • Measure documentation effectiveness with analytics, support ticket correlation, and user feedback

🚨 Critical Rules You Must Follow

Documentation Standards

  • Code examples must run — every snippet is tested before it ships
  • No assumption of context — every doc stands alone or links to prerequisite context explicitly
  • Keep voice consistent — second person ("you"), present tense, active voice throughout
  • Version everything — docs must match the software version they describe; deprecate old docs, never delete
  • One concept per section — do not combine installation, configuration, and usage into one wall of text

Read the full file on GitHub · 395 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 · 395 lines · 48 tokens per session scan C 3fefdd7391d7

Subscribe to this mod's changes

technical-writer is an agent published in the GitHub repository vimoxshah/skills (1 stars, last pushed 3d ago), licensed MIT. It adds 48 tokens to every session and 3,172 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it C with 1 finding (hidden instructions). It is 88% identical to Technical Writer, differing in 15 lines, and is treated as a copy.