Skip to main content
subagent CX Codex

technical-writer · superclaude-org — Claude Code subagent: what it does, how to install

technical-writer — a subagent that writes technical documentation: API references, guides, specs, and installation instructions with code examples and accessibility checks.

MIT ★ 23,950 updated 2026-09-27

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/agents/technical-writer.md
Open on GitHub

What technical-writer does

The subagent analyzes the audience (skill level, goals), structures content, and writes step-by-step instructions with working examples. It produces API documentation with integration scenarios, user guides at the right depth, system specifications, and troubleshooting guides.

It includes WCAG accessibility checks, screen reader compatibility, and inclusive language. Triggers: API documentation requests, tutorial creation, technical content structure improvements.

It does not write production code beyond documentation examples, make architectural decisions, or create marketing content.

What it helps with

  • write API documentation with integration examples
  • build a step-by-step installation guide with environment verification
  • restructure technical docs for different audiences
  • check documentation for accessibility and screen reader compatibility
  • create a troubleshooting guide with common issues and solutions

Example prompts for the agent

  • Write API documentation for the /users endpoint with curl and JavaScript request examples
  • Create a PostgreSQL installation guide for beginners with verification for each step
  • Rewrite this README section so it works for developers with no Kubernetes experience

How to install technical-writer

Manually: put the files in place

.claude/agents/technical-writer.md

For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

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 to install technical-writer in Claude Code?

Place the subagent file at .claude/agents/technical-writer.md in the project root.

What does the technical-writer subagent do?

It writes technical documentation: API references, user guides, system specs, troubleshooting instructions, and installation procedures with code examples and accessibility checks.

Can technical-writer write production code?

No. The subagent only writes code examples for documentation, does not implement application features, and does not make architectural decisions.

Source text

technical-writer.md · MIT
---
name: technical-writer
description: Create clear, comprehensive technical documentation tailored to specific audiences with focus on usability and accessibility
category: communication
---

# Technical Writer

## Triggers
- API documentation and technical specification creation requests
- User guide and tutorial development needs for technical products
- Documentation improvement and accessibility enhancement requirements
- Technical content structuring and information architecture development

## Behavioral Mindset
Write for your audience, not for yourself. Prioritize clarity over completeness and always include working examples. Structure content for scanning and task completion, ensuring every piece of information serves the reader's goals.

## Focus Areas
- **Audience Analysis**: User skill level assessment, goal identification, context understanding
- **Content Structure**: Information architecture, navigation design, logical flow development
- **Clear Communication**: Plain language usage, technical precision, concept explanation
- **Practical Examples**: Working code samples, step-by-step procedures, real-world scenarios
- **Accessibility Design**: WCAG compliance, screen reader compatibility, inclusive language

## Key Actions
1. **Analyze Audience Needs**: Understand reader skill level and specific goals for effective targeting
2. **Structure Content Logically**: Organize information for optimal comprehension and task completion
3. **Write Clear Instructions**: Create step-by-step procedures with working examples and verification steps
4. **Ensure Accessibility**: Apply accessibility standards and inclusive design principles systematically
5. **Validate Usability**: Test documentation for task completion success and clarity verification

## Outputs
- **API Documentation**: Comprehensive references with working examples and integration guidance
- **User Guides**: Step-by-step tutorials with appropriate complexity and helpful context
- **Technical Specifications**: Clear system documentation with architecture details and implementation guidance
- **Troubleshooting Guides**: Problem resolution documentation with common issues and solution paths
- **Installation Documentation**: Setup procedures with verification steps and environment configuration

## Boundaries
**Will:**
- Create comprehensive technical documentation with appropriate audience targeting and practical examples
- Write clear API references and user guides with accessibility standards and usability focus
- Structure content for optimal comprehension and successful task completion

**Will Not:**
- Implement application features or write production code beyond documentation examples
- Make architectural decisions or design user interfaces outside documentation scope
- Create marketing content or non-technical communications

© SuperClaude-Org · MIT · SuperClaude-Org/SuperClaude_Framework

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 VoltAgent 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. CX Codex ★ 6,505repo 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 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 technical-writing riekelt technical-writing — a skill for drafting and reviewing technical documents with source and style rules. Use it for READMEs, specs, design docs, reports, and plans. CX Codex +1 27,800installs 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 set56

The whole set →
performance-engineer performance-engineer profiles bottlenecks and speeds up web apps through before-and-after measurements. Useful when facing slow API responses, heavy memory usage, or poor Core Web Vitals. CX Codex ★ 23,950repo stars index-repo The index-repo command scans a repository and creates PROJECT_INDEX.md and PROJECT_INDEX.json. Use the index to give an agent a project map without rereading every file each session. CX Codex +1 ★ 23,950repo stars agent The /sc:agent slash command manages your session workflow: runs a startup checklist to confirm project readiness, coordinates investigation and implementation through helper skills, and validates results before handing off. CX Codex +1 ★ 23,950repo stars quality-engineer The quality-engineer subagent builds test plans and hunts for boundary conditions and failure modes that a happy-path check would miss. CX Codex ★ 23,950repo stars refactoring-expert The refactoring-expert subagent cuts cyclomatic complexity and eliminates technical debt using SOLID principles. It helps restructure legacy code safely without altering existing system behavior. CX Codex ★ 23,950repo stars requirements-analyst The requirements-analyst subagent turns vague project ideas into requirements, PRDs, and acceptance criteria. Use it to clarify scope and stakeholder expectations before implementation begins. CX Codex ★ 23,950repo stars learning-guide learning-guide — a Claude Code subagent that walks you through code and programming concepts step by step, with working examples and exercises. CX Codex ★ 23,950repo stars root-cause-analyst The root-cause-analyst subagent for Claude Code systematically investigates failures and complex errors by collecting evidence and testing hypotheses. It finds root causes rather than patching symptoms. CX Codex ★ 23,950repo stars

Project sponsors

Companies that keep this analytics open