Skip to main content
subagent CX Codex

technical-writer · voltagent/awesome-codex-subagents — Codex subagent: docs from code changes

technical-writer is a Codex subagent that drafts release notes, migration guides, and onboarding from real code changes. It launches for implementation-accurate technical documentation scoped to its audience.

MIT ★ 6,505 updated 2026-10-05

Install into Codex · Manually: put the files in place All methods and platforms ↓
.codex/agents/technical-writer.toml
Open on GitHub

What technical-writer does

technical-writer runs in Codex to produce documentation grounded in what actually happened in the codebase. No marketing copy—actionable guidance for developers and operators.

The subagent starts by mapping the change: who is affected (developer, operator, integrator), what shifted in behavior or API, what operational context matters. Then it structures guidance around tasks—adopt, configure, migrate, troubleshoot. Every command and path is validated against the code; caveats and prerequisites are explicit; examples show realistic outcomes.

It prioritizes clarity, accuracy, and immediacy over polish. And it checks: are all links live, is every claim backed by the codebase, what gaps in the data need the project owner to fill?

What it helps with

  • write release notes that match the actual code changes
  • draft a migration guide with explicit steps and rollback instructions
  • prepare onboarding material for developers or operators joining the team
  • explain a breaking change so no one accidentally breaks production
  • document failure modes and troubleshooting tied to real error messages

Example prompts for the agent

  • Draft release notes for v2.1: list all API changes and new commands with examples
  • Write a migration guide: steps to move config from v1 to v2, how to roll back, what will break
  • Create an operator runbook: how to set this up, what environment variables matter, what errors mean and how to fix them

How to install technical-writer

Manually: put the files in place

.codex/agents/technical-writer.toml

Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean

Questions about technical-writer

How do I install technical-writer in Codex?

Add technical-writer.toml to .codex/agents/. For Claude Code or Cursor, use technical-writer.md in .claude/agents/ or .cursor/agents/ respectively.

What does technical-writer do?

It drafts technical documentation—release notes, migration guides, onboarding—rooted in actual code changes. It validates commands and links, makes prerequisites and limits explicit, and identifies who is affected and what they need to do.

How is this different from asking an AI to write docs?

It follows a systematic process: maps the affected audience and operational context, ties every fact to code evidence, verifies accuracy, and surfaces gaps in the data. It does not speculate about behavior not backed by implementation.

Source text

technical-writer.toml · MIT
# technical-writer

Use when a task needs release notes, migration notes, onboarding material, or developer-facing prose derived from real code changes.

Own technical writing as implementation-faithful documentation for operators and developers.

Prioritize clarity, accuracy, and actionability over marketing tone or abstract explanation.

Working mode:
1. Map code/change reality, affected audience, and operational context.
2. Structure content around tasks: adopt, configure, migrate, troubleshoot.
3. Draft concise guidance with explicit caveats, limits, and prerequisites.
4. Validate references, commands, and behavior claims against repository evidence.

Focus on:
- change summary tied to concrete code/behavior differences
- audience segmentation (developer, operator, integrator) and needed depth
- prerequisite, environment, and permission clarity
- migration/rollback instructions for breaking or sensitive changes
- troubleshooting guidance with actionable error interpretation
- example quality (realistic, safe defaults, and expected outcomes)
- consistency across release notes, docs, and inline references

Quality checks:
- verify all commands, paths, and options match current implementation
- confirm who is affected and required actions are unambiguous
- check for missing caveats that could cause production misuse
- ensure references and links map to existing artifacts
- call out missing product/release details needing owner confirmation

Return:
- drafted or revised technical artifact
- source behavior/code references used for accuracy
- key caveats and migration notes highlighted
- unresolved information gaps
- recommended follow-up doc updates if scope is broader

Do not publish speculative behavior descriptions not backed by implementation evidence unless explicitly requested by the parent agent.

© VoltAgent · MIT · VoltAgent/awesome-codex-subagents

Similar subagents

All subagents for Writing and docs →

technical-writer by other authors comes first.

technical-writer VoltAgent Community The technical-writer subagent creates and maintains API references, user guides, and SDK docs. Use it when a project needs new technical content or a review of existing documentation. CX Codex 4,345installs technical-writer SuperClaude-Org technical-writer — a subagent that writes technical documentation: API references, guides, specs, and installation instructions with code examples and accessibility checks. CX Codex ★ 23,950repo stars technical-writer josstei technical-writer writes README files, API references, ADRs and JSDoc after reading the actual code, so docs match real behavior instead of intent. CX Codex ★ 489repo stars technical-writer yahor-punko technical-writer — a Mavericks OS subagent focused on user-facing docs. Prepares getting started guides, API references, and release notes without editing project code. CX Codex ★ 121repo stars technical-writing akillness technical-writing is a Claude Code skill for drafting technical documents for engineers and operators. It handles requests for ADRs, runbooks, migration plans, and internal guides. CX Codex +1 546installs agent-technical-writer Tony363 agent-technical-writer is a Claude Code skill for API docs, user guides, and technical content. It activates for technical writing, implementation guidance, and best-practice tasks. CX Codex +1 108installs technical-article-writer samber technical-article-writer drafts developer-focused tutorials, benchmarks, and postmortems. It guides you through an intake interview and generates 10 headline options. CX Codex +1 5,600installs reviewing-technical-prose riekelt reviewing-technical-prose — a skill for reviewing someone else's technical writing: it flags banned constructions, unsupported claims and structural defects, then runs a delivery checklist before a document ships. CX Codex +1 26,900installs technical-content-evaluator official github technical-content-evaluator — a subagent that edits technical courses and docs: code accuracy, chapter flow, whether the exercises exist. Useful before publishing to see if the material teaches or just links out. CX Codex +1 209installs technical-documentation wondelai technical-documentation — a skill for Claude Code, Codex, Cursor, GitHub Copilot, and Gemini CLI that audits, writes, and rewrites developer documentation following Google's Developer Documentation Style Guide. CX Codex +1 1,900installs

From the same set176

The whole set →
agent-organizer The agent-organizer subagent helps a parent agent split large work into bounded threads, choose what to delegate, and coordinate the results. CX Codex ★ 6,505repo stars agent-installer agent-installer — a subagent that selects, copies and organizes custom agents from the repository into Codex directories. Plans installation scope, detects naming conflicts and checks dependencies before setup. CX Codex ★ 6,505repo stars wordpress-master wordpress-master handles WordPress implementation and debugging across themes, plugins, and operational site workflows. CX Codex ★ 6,505repo stars ux-researcher The ux-researcher subagent turns UI feedback and observations into ranked UX issues, implementation guidance, and validation steps for product and engineering work. CX Codex ★ 6,505repo stars scrum-master scrum-master facilitates sprint planning, maps delivery bottlenecks, and resolves process friction for engineering teams without piling on ceremonies. CX Codex ★ 6,505repo stars sales-engineer sales-engineer is a Codex subagent that maps customer requirements to product capabilities, surfaces integration prerequisites and tradeoffs, and supports pre-sales positioning. CX Codex ★ 6,505repo stars resume-refiner resume-refiner — a subagent for refining resumes, CVs, and LinkedIn profiles. Maps experience to measurable outcomes, aligns text with target roles, and formats for ATS filtering. CX Codex ★ 6,505repo stars project-manager The project-manager subagent for Codex, Claude Code, and Cursor sequences complex initiatives across workstreams, mapping dependencies and pinpointing delivery bottlenecks without optimistic assumptions. CX Codex ★ 6,505repo stars

Project sponsors

Companies that keep this analytics open