# doc-gen

Скилл doc-gen создаёт комментарии к функциям, README для каталогов и справку по API, подстраиваясь под стиль проекта. Полезен, когда документацию нужно сверить с кодом, а не пересказать сигнатуры.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 937 у репозитория
- Автор: SethGammon
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/SethGammon/Citadel/tree/HEAD/skills/doc-gen/SKILL.md
- Обновлён: 2026-10-29
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/sethgammon-doc-gen

## Что делает

Скилл работает в трёх режимах: добавляет JSDoc или docstrings к функциям, пишет README для каталога либо оформляет справку по HTTP-эндпоинтам и экспортам библиотеки. Режим выбирается по пути; его также можно задать через `--mode`, а `--dry-run` показывает план без записи файлов.

Перед генерацией скилл читает `AGENTS.md` и, если он есть, `CLAUDE.md`, затем изучает комментарии в целевой области. Простые геттеры и очевидные обёртки он пропускает. Документация должна сообщать больше, чем сигнатура: иначе комментарий удаляется. После записи скилл запускает проверку типов — некорректный JSDoc может вызвать ошибки TypeScript.

В режиме каталога создаётся или обновляется `README.md`; справка по API записывается в `docs/api/` или рядом с файлами маршрутов. Скилл также сообщает, какие файлы изменит, и описывает откат через `git checkout`.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add SethGammon/Citadel
```
В чате агента (не в терминале):
```text
/plugin install citadel@citadel-local
```
Команда ставит плагин citadel целиком, со всеми его скиллами

2. **Через Skills CLI (Vercel)**
```bash
npx skills add SethGammon/Citadel --skill doc-gen -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add SethGammon/Citadel --skill doc-gen -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add SethGammon/Citadel --skill doc-gen -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install SethGammon/Citadel skills/doc-gen
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add SethGammon/Citadel --skill doc-gen -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/SethGammon/Citadel --path skills/doc-gen
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

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

## Когда брать
- добавить JSDoc или docstrings к нетривиальным функциям
- создать README с экспортами и устройством модуля
- описать HTTP-эндпоинты и параметры запросов
- сверить комментарии с поведением кода и стилем проекта

## Примеры запросов агенту
- Добавь документацию к функциям в `src/utils.ts` командой `/doc-gen`.
- Создай README для каталога `src/auth` с описанием экспортов.
- Составь справку по API для `src/routes` через `/doc-gen --api`.

## Похожие
- [update-docs](https://affpapa.org/nevibecode/skills/update-docs.md) — скилл · 1400 установок
- [code-documentation](https://affpapa.org/nevibecode/skills/moizibnyousaf-code-documentation.md) — скилл · 571 установка
- [documentation-templates](https://affpapa.org/nevibecode/skills/documentation-templates.md) — скилл · 305 установок
- [quill](https://affpapa.org/nevibecode/skills/quill.md) — скилл · 107 установок
- [gsd-doc-writer](https://affpapa.org/nevibecode/agents/gsd-doc-writer.md) — субагент · ★ 3785 у репозитория
- [doc-forge](https://affpapa.org/nevibecode/plugins/doc-forge.md) — плагин · ★ 2858 у репозитория

## Другие версии с тем же именем
- [doc-gen · ruvnet](https://affpapa.org/nevibecode/skills/doc-gen.md) — 744 установки

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

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

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