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

technical-writer · voltagent/awesome-codex-subagents — субагент для Codex: документация из кода

technical-writer — субагент Codex, который пишет release notes, миграционные гайды и онбординг по реальным изменениям кода. Запускается для технической документации, точной до деталей реализации и аудитории.

MIT ★ 6 505 обновлён 2026-10-05

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

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

technical-writer работает в Codex и помогает составить документацию, которая отражает то, что на самом деле произошло в коде. Не маркетинг-текст, а инструкции для разработчиков и операторов.

Субагент начинает с анализа: кто пострадает от изменения (разработчик, оператор, интегратор), что конкретно изменилось, какой контекст нужен. Потом структурирует гайды по задачам — как адаптировать, настроить, мигрировать, чинить. Каждая команда и путь проверяется против кода, явно названы ограничения и требования, добавлены примеры с реальными исходами.

Приоритеты: ясность, точность, можно сразу действовать. Про это проверяет — все ли ссылки на место, всё ли понятно без домыслов, какие пропасти в данных нужно заполнить хозяину проекта.

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

  • написать release notes, которые не расходятся с кодом
  • составить миграционный гайд с явными шагами и откатом
  • подготовить онбординг для новых разработчиков или операторов
  • объяснить breaking change так, чтобы никто не сломал production
  • задокументировать, где ловушки и что может пойти не так

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

  • Напиши release notes для версии 2.1: перечисли изменения в API и новые команды
  • Составь миграционный гайд с шагами переноса конфига из v1 в v2 и способом отката
  • Подготовь для оператора инструкцию: как настроить и запустить это, какие ошибки могут быть и как их читать

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

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

.codex/agents/technical-writer.toml

Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

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

Вопросы о technical-writer

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

Добавь файл technical-writer.toml в папку .codex/agents/. Для Claude Code и Cursor — соответственно technical-writer.md в .claude/agents/ и .cursor/agents/.

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

Пишет техническую документацию — release notes, гайды миграции, онбординг — на основе реальных изменений в коде. Проверяет команды и ссылки, явно называет требования и ограничения, указывает, кого затронут изменения.

Чем он отличается от обычного ИИ-помощника?

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

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

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

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

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

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

technical-writer VoltAgent Community Субагент technical-writer в Claude Code создаёт и поддерживает API-документацию, руководства и SDK-доки. Создаёт новые материалы и пересматривает существующие. CX Codex 4 345установок technical-writer SuperClaude-Org Субагент technical-writer пишет техническую документацию: API-референсы, гайды, спецификации и инструкции по установке с примерами кода и проверкой доступности. CX Codex ★ 23 950звёзд репо technical-writer josstei Субагент technical-writer пишет README, API-документацию, ADR и JSDoc, предварительно читая код, чтобы описывать реальное поведение, а не то, что задумывалось. CX Codex ★ 489звёзд репо technical-writer yahor-punko Субагент technical-writer операционной модели Mavericks для подготовки публичной документации. Пишет руководства, API-справочники и чейнджлоги, не трогая код проекта. CX Codex ★ 121звёзд репо technical-writing akillness technical-writing — скилл для Claude Code, который помогает писать техническую документацию для разработчиков и операторов. Выберите его для ADR, инструкций по эксплуатации или плана миграции. CX Codex +1 546установок 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установок 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установок

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

Весь набор →
agent-organizer Субагент agent-organizer разбивает крупную задачу на делегируемые ветки, задаёт границы работы и помогает согласовать результаты. CX Codex ★ 6 505звёзд репо agent-installer Субагент agent-installer для выбора, копирования и организации пользовательских агентов из репозитория в директории Codex. Помогает спланировать установку, выявить конфликты имён и проверить зависимости перед созданием. CX Codex ★ 6 505звёзд репо wordpress-master Субагент wordpress-master помогает отлаживать и дорабатывать темы, плагины и архитектуру WordPress с фокусом на минимальные безопасные правки. CX Codex ★ 6 505звёзд репо ux-researcher Субагент ux-researcher превращает отзывы и наблюдения о UI в список проблем, приоритеты и задачи для дизайна и разработки. Подходит для разбора конкретных пользовательских сценариев. CX Codex ★ 6 505звёзд репо scrum-master Субагент scrum-master помогает инженерным командам планировать итерации, выявлять задержки в процессах и устранять блокировки без раздувания лишних регламентов. CX Codex ★ 6 505звёзд репо sales-engineer Субагент sales-engineer для pre-sales: объясняет клиентам техсторону решения, разбирает трейдоффы и интеграционные предпосылки. Помогает закрыть пробелы между тем, что просит клиент, и тем, что действительно может система. CX Codex ★ 6 505звёзд репо resume-refiner Субагент resume-refiner для редактирования резюме, CV и LinkedIn-профиля. Проверяет опыт на конкретные результаты, выравнивает текст под целевую должность и готовит документ к ATS-фильтрам. CX Codex ★ 6 505звёзд репо project-manager Субагент project-manager выстраивает граф зависимостей, находит критический путь и оценивает риски срыва сроков между рабочими потоками. CX Codex ★ 6 505звёзд репо

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

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