# doc-generator

Скилл читает исходники и собирает документацию по эндпоинтам: OpenAPI-спеки, примеры вызовов, коды ошибок. Пригодится, когда API обросло роутами, а README отстал.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · ★ 45153
- Автор: luongnv89
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/luongnv89/claude-howto/tree/HEAD/03-skills/doc-generator/SKILL.md
- Обновлён: 2026-10-20
- HTML: https://affpapa.org/nevibecode/skills/doc-generator

## Что делает

Скилл `doc-generator` разбирает код и выдаёт документацию по каждому эндпоинту. Внутри — шаблон с описанием, таблицей параметров, примерами ответов на успех и на ошибку, а также готовыми вызовами на cURL, JavaScript и Python. Отдельно он берётся за OpenAPI/Swagger-спеки, примеры использования SDK, гайды по интеграции, справочник кодов ошибок и раздел про аутентификацию.

Установка идёт через `npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code`, файл скилла ложится в `~/.claude/skills/doc-generator/SKILL.md`. Тот же репозиторий поддерживает Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode — команды отличаются только флагом платформы. Для GitHub Copilot ставится через `gh skill install`.

Скилл генерирует текст по вашему коду, поэтому качество описаний зависит от того, насколько аккуратно размечены роуты и схемы. Если в проекте нет типов или валидации запросов, таблицы параметров придётся вычитывать руками — это повод проверить, что скилл вообще смог вытащить из исходников.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/doc-generator/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/doc-generator/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add luongnv89/claude-howto --skill doc-generator -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add luongnv89/claude-howto --skill doc-generator -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install luongnv89/claude-howto doc-generator
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/doc-generator/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add luongnv89/claude-howto --skill doc-generator -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/luongnv89/claude-howto --path 03-skills/doc-generator
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/doc-generator/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add luongnv89/claude-howto --skill doc-generator -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/luongnv89/claude-howto/tree/HEAD/03-skills/doc-generator/SKILL.md

## Когда брать
- собрать OpenAPI-спеку по существующим роутам
- описать параметры и ответы для каждого эндпоинта
- добавить примеры вызовов на cURL, JavaScript и Python
- составить справочник кодов ошибок API
- написать гайд по аутентификации для внешних разработчиков

## Примеры запросов агенту
- сгенерируй документацию по эндпоинтам из папки `src/routes`
- собери OpenAPI-спеку для нашего API и добавь примеры ответов
- обнови справочник кодов ошибок по текущему коду

## Похожие
- [documentation-engineer](https://affpapa.org/nevibecode/agents/documentation-engineer.md) — субагент · 735 установок
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [api-documenter](https://affpapa.org/nevibecode/skills/api-documenter.md) — скилл · 717 установок
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/secondsky-api-reference-documentation.md) — скилл · 454 установки
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 413 установок
- [scalar](https://affpapa.org/nevibecode/skills/scalar.md) — скилл · 2800 установок

## Другие версии с тем же именем
- [doc-generator · luongnv89](https://affpapa.org/nevibecode/skills/luongnv89-doc-generator.md) — ★ 45153

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

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

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