# documentation-generator

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

- команда · `type=command` · Claude Code, Codex, GitHub Copilot, Gemini CLI · ★ 2003 у репозитория
- Автор: Community
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/composio-community/awesome-claude-plugins/tree/HEAD/documentation-generator/commands/documentation-generator.md
- Обновлён: 2026-07-26
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/commands/documentation-generator

## Что делает

Команда просит Claude Code подготовить документацию к функциям и методам: объяснить параметры и возвращаемые значения, добавить примеры использования, разобрать крайние случаи и обработку ошибок. В отдельном разделе описываются API-эндпоинты, HTTP-методы, схемы запросов и ответов, аутентификация, лимиты и коды ошибок.

Для проекта команда формирует инструкции по установке и настройке, описание параметров конфигурации, раздел по устранению проблем и правила для контрибьюторов. Результат оформляется в Markdown и включает практические примеры. Для короткой заметки такой охват избыточен.

Вызовите слэш-команду в Claude Code и укажите код, API или проект, который нужно описать. Формат результата зависит от материала, который вы передадите агенту.

## Установка

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

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

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

### Codex

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

### GitHub Copilot

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

### Gemini CLI

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/composio-community/awesome-claude-plugins/tree/HEAD/documentation-generator/commands/documentation-generator.md

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

## Примеры запросов агенту
- \`/documentation-generator` Опиши функции в `src/auth.py`, добавь параметры, возвращаемые значения и примеры вызова.
- \`/documentation-generator` Подготовь документацию для API: HTTP-методы, схемы запросов и ответов, аутентификация и коды ошибок.
- \`/documentation-generator` Составь README для проекта с установкой, настройкой, устранением проблем и правилами для контрибьюторов.

## Похожие
- [generate-api-documentation](https://affpapa.org/nevibecode/commands/generate-api-documentation.md) — команда · 1849 установок
- [documentation-engineer](https://affpapa.org/nevibecode/agents/documentation-engineer.md) — субагент · 735 установок
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10800 установок
- [code-documentation](https://affpapa.org/nevibecode/skills/aj-geddes-code-documentation.md) — скилл · 502 установки
- [documentation-templates](https://affpapa.org/nevibecode/skills/documentation-templates.md) — скилл · 305 установок
- [code-documentation-analyzer](https://affpapa.org/nevibecode/skills/code-documentation-analyzer.md) — скилл · 1 установка

Из того же набора: [composio-community/awesome-claude-plugins](https://affpapa.org/nevibecode/by/composio-community/awesome-claude-plugins.md) — 68 карточек

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