К основному содержанию
субагент CX Codex

technical-writer · superclaude-org — субагент для Claude Code

Субагент technical-writer пишет техническую документацию: API-референсы, гайды, спецификации и инструкции по установке с примерами кода и проверкой доступности.

MIT ★ 23 950 обновлён 2026-09-27

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/agents/technical-writer.md
Открыть на GitHub

Что делает technical-writer

Субагент анализирует аудиторию (уровень навыков, цели), выстраивает структуру контента и пишет пошаговые инструкции с рабочими примерами. Создаёт API-документацию с интеграционными сценариями, руководства пользователя с нужной глубиной, спецификации систем и troubleshooting-гайды.

Включает проверку доступности по WCAG, совместимость со скринридерами и инклюзивный язык. Триггеры запуска: запросы на документирование API, создание туториалов, улучшение структуры технического контента.

Не пишет production-код за пределами примеров для документации, не принимает архитектурные решения и не создаёт маркетинговые тексты.

Какие задачи решает

  • написать API-документацию с примерами интеграции
  • собрать пошаговый гайд по установке с проверкой окружения
  • реструктурировать техническую документацию для разных аудиторий
  • проверить документацию на доступность и совместимость со скринридерами
  • создать troubleshooting-гайд с типовыми проблемами и решениями

Примеры запросов агенту

  • Напиши API-документацию для эндпоинта /users с примерами запросов на curl и JavaScript
  • Создай инструкцию по установке PostgreSQL для начинающих с проверкой каждого шага
  • Перепиши этот раздел README так, чтобы он подходил для разработчиков без опыта работы с Kubernetes

Как установить technical-writer

Вручную: положить файлы

.claude/agents/technical-writer.md

Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст

Вопросы о technical-writer

Как установить technical-writer в Claude Code?

Положи файл субагента в .claude/agents/technical-writer.md в корне проекта.

Что делает субагент technical-writer?

Пишет техническую документацию: API-референсы, пользовательские гайды, спецификации систем, troubleshooting-инструкции и установочные процедуры с примерами кода и проверкой доступности.

Может ли technical-writer написать production-код?

Нет. Субагент пишет только примеры кода для документации, не реализует фичи приложений и не принимает архитектурные решения.

Исходный текст

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

Похожие субагенты

Все субагенты по теме «Тексты и документация» →

Сначала — technical-writer от других авторов.

technical-writer VoltAgent Community Субагент technical-writer в Claude Code создаёт и поддерживает API-документацию, руководства и SDK-доки. Создаёт новые материалы и пересматривает существующие. CX Codex 4 345установок technical-writer VoltAgent technical-writer — субагент Codex, который пишет release notes, миграционные гайды и онбординг по реальным изменениям кода. Запускается для технической документации, точной до деталей реализации и аудитории. CX Codex ★ 6 505звёзд репо technical-writer josstei Субагент technical-writer пишет README, API-документацию, ADR и JSDoc, предварительно читая код, чтобы описывать реальное поведение, а не то, что задумывалось. CX Codex ★ 489звёзд репо technical-writer yahor-punko Субагент technical-writer операционной модели Mavericks для подготовки публичной документации. Пишет руководства, API-справочники и чейнджлоги, не трогая код проекта. CX Codex ★ 121звёзд репо agent-technical-writer Tony363 Скилл agent-technical-writer для Claude Code пишет API-документацию, гайды и технические материалы. Подключается к задачам технического писателя и подготовке технических рекомендаций. CX Codex +1 108установок technical-article-writer samber Скилл technical-article-writer помогает писать технические статьи, туториалы и разборы багов для разработчиков. Скилл проводит интервью по теме и предлагает десять вариантов заголовков. CX Codex +1 5 600установок technical-writing riekelt Скилл technical-writing для Claude Code задаёт правила структуры, проверки фактов и стиля технических документов. Помогает писать README, спецификации, отчёты и планы. CX Codex +1 27 800установок reviewing-technical-prose riekelt Скилл reviewing-technical-prose для вычитки чужих технических текстов: находит запрещённые конструкции, слабые утверждения и структурные дефекты, а перед сдачей документа прогоняет чек-лист. CX Codex +1 26 900установок technical-content-evaluator официальный github Субагент technical-content-evaluator для GitHub Copilot вычитывает технические курсы и документацию: проверяет код, логику изложения и упражнения. Перед публикацией оценивает, учат ли материалы или только ведут по ссылкам. CX Codex +1 209установок technical-documentation wondelai Скилл technical-documentation для Claude Code, Codex, Cursor, GitHub Copilot и Gemini CLI, который проверяет, пишет и переписывает документацию по руководству Google Developer Documentation Style Guide. CX Codex +1 1 900установок

Из того же набора56

Весь набор →
performance-engineer Субагент performance-engineer находит узкие места в коде и ускоряет веб-приложения на основе реальных замеров. Пригодится при просадках Core Web Vitals, долгих ответах API или перерасходе памяти. CX Codex ★ 23 950звёзд репо index-repo Команда index-repo анализирует структуру репозитория и создаёт PROJECT_INDEX.md и PROJECT_INDEX.json. Индекс помогает агенту изучать проект без чтения всех файлов при каждом запуске. CX Codex +1 ★ 23 950звёзд репо agent Слэш-команда /sc:agent управляет ходом сессии: проверяет статус проекта при старте, планирует исследование и координирует вспомогательные скиллы для уверенной реализации. CX Codex +1 ★ 23 950звёзд репо quality-engineer Субагент quality-engineer проектирует тест-планы и находит граничные случаи и сценарии отказа, которые не видны по основному сценарию работы. CX Codex ★ 23 950звёзд репо refactoring-expert Субагент refactoring-expert снижает цикломатическую сложность кода и устраняет технический долг через принципы SOLID. Пригодится при безопасном рефакторинге без изменения поведения системы. CX Codex ★ 23 950звёзд репо requirements-analyst Субагент requirements-analyst помогает превратить расплывчатую идею в требования, PRD и критерии приёмки. Подключайте его до начала реализации, чтобы согласовать объём проекта и ожидания участников. CX Codex ★ 23 950звёзд репо learning-guide Субагент learning-guide для Claude Code пошагово объясняет код и программные концепции на рабочих примерах и упражнениях. Помогает разобраться в теме, а не получить готовый ответ. CX Codex ★ 23 950звёзд репо root-cause-analyst Субагент root-cause-analyst для Claude Code систематически расследует сбои и системные ошибки, собирая логи и проверяя гипотезы. Помогает найти первопричины сложных багов вместо борьбы с симптомами. CX Codex ★ 23 950звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой