# technical-writer

Субагент technical-writer пишет README, API-документацию, ADR и JSDoc, предварительно читая код, чтобы описывать реальное поведение, а не то, что задумывалось.

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 489 у репозитория
- Автор: josstei
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/josstei/maestro-orchestrate/tree/HEAD/antigravity/src/agents/technical-writer.md
- Обновлён: 2026-10-26
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/josstei-technical-writer

## Что делает

Субагент определяет аудиторию по типу документа: README пишет для новичка без контекста проекта, API-документацию — для интегрирующего разработчика с примером curl на каждый эндпоинт, архитектурные записи — для участника команды с объяснением причин решения, а не просто описанием. Для референсов (эндпоинты, конфиги, флаги CLI) использует таблицы, для гайдов — пронумерованные шаги с проверкой результата на каждом, для концептуальных документов — сначала диаграммы, потом текст.

Каждый файл документации получает в начале комментарий с перечнем исходных файлов кода, которые он описывает — это позволяет заметить, когда документация расходится с кодом после изменений. Примеры кода агент требует синтаксически корректными и с реалистичными значениями вместо `foo`, `bar` или `example.com`.

Правит только файлы документации и не трогает исходный код. Для задач, где нужны реальные изменения в коде, этот субагент не подходит — его область ограничена README, API-референсами, ADR и инлайн-комментариями.

## Установка

### Claude Code (родная платформа)

**Вручную: положить файлы**
- Файл: `.claude/agents/technical-writer.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/technical-writer.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/technical-writer.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/josstei/maestro-orchestrate/tree/HEAD/antigravity/src/agents/technical-writer.md

## Когда брать
- написать README с нуля для нового проекта
- задокументировать эндпоинты API с примерами curl
- оформить архитектурное решение в виде ADR
- обновить устаревшую документацию по актуальному коду
- добавить JSDoc к функциям модуля

## Примеры запросов агенту
- Напиши документацию API для сервиса авторизации
- Обнови README проекта, он устарел и не соответствует коду
- Задокументируй архитектурное решение по выбору очереди сообщений в формате ADR

## Похожие
- [code-documentation](https://affpapa.org/nevibecode/skills/moizibnyousaf-code-documentation.md) — скилл · 571 установка
- [documentation-templates](https://affpapa.org/nevibecode/skills/documentation-templates.md) — скилл · 305 установок
- [agent-technical-writer](https://affpapa.org/nevibecode/skills/agent-technical-writer.md) — скилл · 108 установок
- [gem-documentation-writer](https://affpapa.org/nevibecode/agents/gem-documentation-writer.md) — субагент · ★ 41430 у репозитория
- [technical-writing](https://affpapa.org/nevibecode/skills/rudolf-s-technical-writing.md) — скилл · ★ 587 у репозитория

## Другие версии с тем же именем
- [technical-writer · voltagent](https://affpapa.org/nevibecode/agents/technical-writer.md) — 4345 установок
- [technical-writer · superclaude-org](https://affpapa.org/nevibecode/agents/superclaude-org-technical-writer.md) — ★ 23950 у репозитория
- [technical-writer · voltagent](https://affpapa.org/nevibecode/agents/voltagent-technical-writer.md) — ★ 6505 у репозитория
- [technical-writer · yahor-punko](https://affpapa.org/nevibecode/agents/yahor-punko-technical-writer.md) — ★ 121 у репозитория

Из того же набора: [josstei/maestro-orchestrate](https://affpapa.org/nevibecode/by/josstei/maestro-orchestrate.md) — 40 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
