doc-gen · sethgammon — скилл для Claude Code: генерация документации
Скилл doc-gen создаёт комментарии к функциям, README для каталогов и справку по API, подстраиваясь под стиль проекта. Полезен, когда документацию нужно сверить с кодом, а не пересказать сигнатуры.
MIT ★ 937 обновлён 2026-10-29
/plugin marketplace add SethGammon/Citadel
/plugin install citadel@citadel-localЧто делает doc-gen
Скилл работает в трёх режимах: добавляет JSDoc или docstrings к функциям, пишет README для каталога либо оформляет справку по HTTP-эндпоинтам и экспортам библиотеки. Режим выбирается по пути; его также можно задать через --mode, а --dry-run показывает план без записи файлов.
Перед генерацией скилл читает AGENTS.md и, если он есть, CLAUDE.md, затем изучает комментарии в целевой области. Простые геттеры и очевидные обёртки он пропускает. Документация должна сообщать больше, чем сигнатура: иначе комментарий удаляется. После записи скилл запускает проверку типов — некорректный JSDoc может вызвать ошибки TypeScript.
В режиме каталога создаётся или обновляется README.md; справка по API записывается в docs/api/ или рядом с файлами маршрутов. Скилл также сообщает, какие файлы изменит, и описывает откат через git checkout.
Какие задачи решает
- добавить JSDoc или docstrings к нетривиальным функциям
- создать README с экспортами и устройством модуля
- описать HTTP-эндпоинты и параметры запросов
- сверить комментарии с поведением кода и стилем проекта
Примеры запросов агенту
- Добавь документацию к функциям в
src/utils.tsкомандой/doc-gen. - Создай README для каталога
src/authс описанием экспортов. - Составь справку по API для
src/routesчерез/doc-gen --api.
Как установить doc-gen
1Через маркетплейс плагинов
/plugin marketplace add SethGammon/Citadel/plugin install citadel@citadel-localКоманда ставит плагин citadel целиком, со всеми его скиллами
2Через Skills CLI (Vercel)
npx skills add SethGammon/Citadel --skill doc-gen -a claude-code3Вручную: положить файлы
~/.claude/skills/doc-gen/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/doc-gen/
1Через Skills CLI (Vercel)
npx skills add SethGammon/Citadel --skill doc-gen -a codex2Вручную: положить файлы
.agents/skills/doc-gen/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add SethGammon/Citadel --skill doc-gen -a cursor2Вручную: положить файлы
.cursor/skills/doc-gen/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install SethGammon/Citadel skills/doc-gen2Вручную: положить файлы
.github/skills/doc-gen/SKILL.md1Через Skills CLI (Vercel)
npx skills add SethGammon/Citadel --skill doc-gen -a gemini-cli2Командой платформы
gemini skills install https://github.com/SethGammon/Citadel --path skills/doc-genВручную: положить файлы
.devin/skills/doc-gen/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о doc-gen
Как установить doc-gen в Claude Code?
В Claude Code выполните /plugin marketplace add SethGammon/Citadel? Нет: сначала добавьте маркетплейс командой /plugin marketplace add SethGammon/Citadel, затем установите скилл: /plugin install citadel@citadel-local.
Что делает doc-gen?
Скилл создаёт документацию для функций, каталогов и API. Он изучает существующий стиль и пропускает комментарии, которые лишь повторяют сигнатуру.
Как запустить генерацию без изменения файлов?
Передайте целевой путь с флагом --dry-run, например /doc-gen --dry-run src/utils.ts. Скилл покажет, что собирается документировать, не записывая изменения.
Исходный текст
SKILL.md · MIT
---
name: doc-gen
license: MIT
description: >-
Documentation generator with three modes: function-level (JSDoc/docstrings),
module-level (directory READMEs), and API reference (endpoints/exports).
Reads existing project doc style and matches it. Never generates docs that
just restate what the signature already says.
user-invocable: true
auto-trigger: false
trigger_keywords:
- document
- docs
- docstring
- jsdoc
- readme
- api docs
last-updated: 2026-03-20
---
# /doc-gen — Documentation Generator
## When to Use
- Add JSDoc/docstrings to functions in a file or set of files
- Write a README for a module or directory
- Document an HTTP API or exported library surface
Mode auto-detected from target:
- **File path** → function-level mode
- **Directory path** → module-level mode
- **Route file or API directory** → API reference mode
- **Explicit override**: `/doc-gen --mode function|module|api [target]`
## Commands
| Command | Behavior |
|---|---|
| `/doc-gen [file]` | Function-level docs for a file |
| `/doc-gen [directory]` | Module-level README for a directory |
| `/doc-gen --api [target]` | API reference for endpoints or exports |
| `/doc-gen --mode [mode] [target]` | Force a specific mode |
| `/doc-gen --dry-run [target]` | Show what would be documented without writing |
## Protocol
### Phase 1: DETECT STYLE
1. Read AGENTS.md (then CLAUDE.md if present) for doc conventions
2. Search for existing doc comments in the target area — note density, tone, tags used, and line length
3. Default when no existing docs: JSDoc (`@param`, `@returns`, `@throws`, `@example`) for TS/JS; Google-style for Python; idiomatic format for others
Apply detected style consistently across all generated docs.
### Phase 2: ANALYZE TARGET
#### Function-Level Mode
For each function:
1. Read the full body, not just the signature
2. Classify:
- **Trivial**: simple getters/setters, one-line wrappers with obvious names — SKIP
- **Non-trivial**: document purpose, parameter semantics (not types — TS has those), return guarantees, throws/errors, side effects, non-obvious edge cases, and `@example` when usage is non-obvious
3. Write using detected style
**Core rule:** every doc must add information beyond what the signature already says. If you cannot, skip it.
#### Module-Level Mode
1. Read all files in the directory (one level deep)
2. Identify: problem space, key exports, internal files, external dependencies, and what imports this module
3. README schema: `# {Module Name}` | one-paragraph description | `## Key Exports` table (name, description) | `## Architecture` (only if non-obvious internal structure) | `## Usage` (real import paths) | `## Dependencies` (non-obvious only)
4. If a README already exists, update rather than replace — preserve sections not covered by your analysis
#### API Reference Mode
For HTTP endpoints: method + path, description, path/query/body params (with types), response shape and status codes, errors, auth level, and a curl/fetch example for non-trivial endpoints.
For exported libraries: name and kind (function/class/constant/type), description, parameters/properties with semantics, return type with guarantees, import and usage example.
Structure as a single reference document with a table of contents.
### Phase 3: WRITE
1. Apply detected style consistently
2. Function-level: insert doc comments above each function
3. Module-level: write or update README.md in the target directory
4. API reference: write to `docs/api/` or adjacent to route files
5. Run typecheck after writing (malformed JSDoc can cause TS errors)
### Phase 4: VERIFY
Re-read every doc comment. For each: "Does this add information beyond the signature?" If not, delete it. Check accuracy: parameter names, return types, side effects, and that examples would actually compile/run.
## Contextual Gates
**Disclosure:** "Generating documentation for [target]. Source files will be modified."
**Reversibility:** amber — adds JSDoc/docstrings to source files; undo with `git checkout` on modified files.
**Trust gates:**
- Any: additive doc generation on undocumented functions.
- Familiar (5+ sessions): rewriting existing docstrings that may discard prior content.
## Quality Gates
- Every doc comment adds information beyond the signature; if not, delete it
- Docs match actual code behavior — wrong docs are worse than no docs
- Style matches the project's existing convention throughout
- No `@param name - The name` filler; omit parameters when their name is self-explanatory
- Typecheck passes after insertion
- At least some functions skipped as trivial — if every function was documented, you over-documented
## Exit Protocol
```
=== Doc-Gen Report ===
Mode: {function-level | module-level | api-reference}
Target: {path}
Style: {detected style}
Documented: {N functions ({M} skipped as trivial) | README.md ({N} exports) | {N} endpoints}
Skipped: {item}: {reason}
```
```
---HANDOFF---
- Generated {mode} docs for {target}
- Matched existing {style} convention
- {what was skipped and why}
- Reversibility: amber — undo with `git checkout` on modified source files
---
```
© SethGammon · MIT · SethGammon/Citadel
Похожие скиллы
Все скиллы по теме «Тексты и документация» →Сначала — doc-gen от других авторов.