# gsd-doc-writer

Субагент gsd-doc-writer, который пишет и обновляет документацию проекта. Создаёт README, гайды, API-справки и другие файлы, следуя структуре проекта и исправляя ошибки по проверкам.

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

## Что делает

gsd-doc-writer получает задачу на создание, обновление или дополнение документа — с указанием типа (README, архитектура, development guide, API), режима работы и контекста проекта. Субагент читает исходный код через Read, Bash, Grep и Write, собирает факты и генерирует документацию, которая остаётся синхронна с кодом.

Работает в пяти режимах: создание doc с нуля (create), редактирование существующего (update), добавление только недостающих секций к hand-written файлам (supplement), исправление конкретных ошибок по результатам верификации (fix) и произвольная документация по описанию (custom). Каждый режим сохраняет баланс между автоматизацией и контролем — например, supplement никогда не трогает текст, который уже написан.

В Claude Code встраивается через слэш-команду `/gsd:docs-update` из других агентов, которые определяют, что документировать. Требует, чтобы проект был инициализирован через gsd-doc-init (создаёт конфиг проекта); работает с монорепо и single-package проектами.

## Установка

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

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

### Codex

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

### Cursor

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/davepoon/buildwithclaude/tree/HEAD/plugins/gsd/agents/gsd-doc-writer.md

## Когда брать
- Генерировать документацию, когда API или структура проекта меняется
- Дополнить hand-written README автоматически написанными секциями, не затирая авторский текст
- Создать README для каждого пакета в монорепо с разными описаниями
- Исправить ошибки в документации, которые нашла автоматическая проверка
- Писать custom документацию по описанию — гайды, архитектуру, development flow

## Примеры запросов агенту
- Создай README для этого проекта
- Обнови архитектурный документ, если код изменился
- Дополни существующий README секциями про установку и тестирование

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

Из того же набора: [davepoon/buildwithclaude](https://affpapa.org/nevibecode/by/davepoon/buildwithclaude.md) — 235 карточек

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

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