# docs-writer

Субагент docs-writer читает код перед тем, как писать или обновлять документацию. Подключайте его для README, описаний API и инструкций к изменениям кода.

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 1424 у репозитория
- Автор: CloudAI-X
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/CloudAI-X/claude-workflow-v2/tree/HEAD/agents/docs-writer.md
- Обновлён: 2026-10-06
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/docs-writer

## Что делает

docs-writer изучает реализацию, затем готовит README, документацию API и архитектуры, руководства, заметки о релизах и комментарии к коду. Он также обновляет документацию после изменений и сверяет примеры с исходным кодом. Для небольших правок объём работы меньше, чем для описания новой функции или всего проекта.

Субагент использует `Read`, `Write`, `Edit`, `Glob` и `Grep`; в настройках указана модель `sonnet`. Он не может запускать команды в shell. Если пример нужно выполнить, чтобы проверить его, субагент должен попросить вызывающего выполнить проверку. Для вас это значит, что примеры, требующие запуска, останутся непроверенными, пока вы сами их не выполните.

## Установка

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

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

### Codex

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

### Cursor

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/CloudAI-X/claude-workflow-v2/tree/HEAD/agents/docs-writer.md

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

## Примеры запросов агенту
- Прочитай реализацию и обнови README для новой функции.
- Опиши публичный API: параметры, возвращаемые значения и ошибки.
- Добавь комментарий к этой функции с её ограничениями и примерами использования.

## Похожие
- [gem-documentation-writer](https://affpapa.org/nevibecode/agents/gem-documentation-writer.md) — субагент · ★ 41430 у репозитория
- [docs](https://affpapa.org/nevibecode/agents/docs.md) — субагент · ★ 71 у репозитория
- [ns-docs-writer](https://affpapa.org/nevibecode/skills/ns-docs-writer.md) — скилл · 151 установка
- [technical-writer](https://affpapa.org/nevibecode/agents/josstei-technical-writer.md) — субагент · ★ 489 у репозитория
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10800 установок

## Другие версии с тем же именем
- [docs-writer · alirezarezvani](https://affpapa.org/nevibecode/agents/alirezarezvani-docs-writer.md) — ★ 788 у репозитория
- [docs-writer · justxor](https://affpapa.org/nevibecode/agents/justxor-docs-writer.md) — ★ 353 у репозитория

Из того же набора: [cloudai-x/claude-workflow-v2](https://affpapa.org/nevibecode/by/cloudai-x/claude-workflow-v2.md) — 46 карточек

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

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