# docs-writer

Субагент docs-writer для Claude Code и Cursor готовит API-документацию, руководства пользователя и архитектурные описания по кодовой базе.

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

## Что делает

Субагент сканирует кодовую базу через `Glob` и `Read`, после чего собирает структурированные технические тексты. Для быстрой подготовки структуры он умеет обращаться к вспомогательным скиллам: `api-documenter` извлекает комментарии к маршрутам в каркас OpenAPI 3.0, а `readme-updater` проверяет свежесть инструкций и параметров в файле `README.md`.

Поверх базовых схем агент вручную пишет руководства по интеграции, пошаговые сценарии и диаграммы Mermaid. В манифесте объявлен инструмент `Skill`, поэтому генерация первичных каркасов опирается на наличие этих вспомогательных скиллов в окружении.

## Установка

### 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/alirezarezvani/claude-code-tresor/tree/HEAD/agents/docs-writer.md

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

## Примеры запросов агенту
- Изучи маршруты в `src/api` и собери спецификацию OpenAPI вместе с примерами запросов
- Проверь актуальность `README.md` и обнови секцию с переменными окружения
- Напиши руководство по интеграции вебхуков с диаграммой Mermaid

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

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

Из того же набора: [alirezarezvani/claude-code-tresor](https://affpapa.org/nevibecode/by/alirezarezvani/claude-code-tresor.md) — 27 карточек

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

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