# doc-generate

Команда анализирует кодовую базу и создаёт документацию для API, архитектуры, кода и пользователей. Она также задаёт автоматизацию её проверки и публикации.

- команда · `type=command` · Claude Code, Codex, Cursor · ★ 41729
- Автор: Seth Hobson
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/wshobson/agents/tree/HEAD/plugins/code-documentation/commands/doc-generate.md
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/commands/doc-generate

## Что делает

\`doc-generate` предлагает описать, что нужно подготовить, а затем изучает код и формирует подходящие материалы: спецификацию OpenAPI, диаграммы Mermaid или PlantUML, README, руководства и справку по конфигурации. Можно запросить и настройку CI/CD для генерации, проверки и публикации документации.

Внутри команды есть инструкции и примеры извлечения сведений из Python-кода, схем Pydantic и шаблона OpenAPI. Это ориентиры для агента, а не гарантия, что каждый проект использует такие технологии. Результат зависит от структуры и содержимого репозитория: если в коде не описаны детали поведения API, проверьте их перед публикацией документации.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add wshobson/agents
```
В чате агента (не в терминале):
```text
/plugin install code-documentation@claude-code-workflows
```

2. **Вручную: положить файлы**
- Файл: `.claude/commands/doc-generate.md` — Вызов — /doc-generate. Для всех проектов — ~/.claude/commands/

### Codex

**Вручную: положить файлы**
- Файл: `~/.codex/prompts/doc-generate.md` — Вызов — /prompts:doc-generate. В Codex этот формат помечен устаревшим, замена — скиллы

### GitHub Copilot

**Вручную: положить файлы**
- Файл: `.github/prompts/doc-generate.prompt.md`

### Gemini CLI

**Вручную: положить файлы**
- Файл: `.gemini/commands/doc-generate.toml` — Gemini хранит команды в TOML: текст запроса — в поле prompt

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

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

## Примеры запросов агенту
- Создай спецификацию OpenAPI для API в этом проекте.
- Подготовь диаграмму архитектуры и опиши связи компонентов.
- Настрой CI/CD для проверки и публикации документации.

## Похожие
- [create-architecture-documentation](https://affpapa.org/nevibecode/commands/create-architecture-documentation.md) — команда · 6136 установок
- [update-docs](https://affpapa.org/nevibecode/commands/update-docs.md) — команда · 3861 установка
- [revise-claude-md](https://affpapa.org/nevibecode/commands/revise-claude-md.md) — команда · ★ 44635
- [create-prd](https://affpapa.org/nevibecode/commands/create-prd.md) — команда · 2431 установка
- [add-changelog](https://affpapa.org/nevibecode/commands/add-changelog.md) — команда · 2025 установок
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки

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

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

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