doc-gen — скилл для Claude Code: что делает и как установить
Генерирует документацию по кодовой базе, находит расхождения между кодом и текстами, а также запускает фоновые проверки по расписанию. Пригодится при частых изменениях в API.
npx skills add ruvnet/ruflo --skill doc-gen -a claude-codeЧто делает doc-gen
Скилл сравнивает текущий код с существующими файлами справки, чтобы вовремя выявлять неактуальные разделы. Он поддерживает выборочное обновление документации: можно сформировать описание только для API или сразу для всего проекта. Для запуска задач используются хуки воркеров MCP либо CLI-команда npx @claude-flow/cli@latest с параметром --context api или --context full.
Для непрерывного контроля документации предусмотрена интеграция с инструментом CronCreate. Это позволяет настроить периодический вызов воркера по таймеру, например каждые два часа. Выбранный подход к оформлению можно сохранить в память через вызов mcp__plugin_ruflo-core_ruflo__memory_store в пространстве имён patterns.
Без плагина ruflo-core или утилиты @claude-flow/cli диспетчер воркеров не выполнит команды. Инструменты MCP-окружения нужно подключить до вызова скилла.
Какие задачи решает
- выявить расхождения между кодом и устаревшей документацией
- сгенерировать справочные материалы для API через вызов воркера
- настроить фоновое обновление документов по cron-расписанию
- сохранить паттерны документирования в постоянную память проекта
Примеры запросов агенту
- Проверь расхождения между кодом и документацией с параметром --target src/api
- Сгенерируй полную документацию проекта через диспетчер воркеров
- Настрой регулярный запуск обновления документации каждые два часа
Как установить doc-gen
1Через Skills CLI (Vercel)
npx skills add ruvnet/ruflo --skill doc-gen -a claude-code2Вручную: положить файлы
~/.claude/skills/doc-gen/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/doc-gen/
1Через Skills CLI (Vercel)
npx skills add ruvnet/ruflo --skill doc-gen -a codex2Вручную: положить файлы
.agents/skills/doc-gen/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add ruvnet/ruflo --skill doc-gen -a cursor2Вручную: положить файлы
.cursor/skills/doc-gen/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install ruvnet/ruflo doc-gen2Вручную: положить файлы
.github/skills/doc-gen/SKILL.md1Через Skills CLI (Vercel)
npx skills add ruvnet/ruflo --skill doc-gen -a gemini-cli2Командой платформы
gemini skills install https://github.com/ruvnet/ruflo --path plugins/ruflo-docs/skills/doc-genВручную: положить файлы
.devin/skills/doc-gen/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add ruvnet/ruflo --skill doc-gen -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
Из того же набора104
Весь набор →Похожие
Вопросы о doc-gen
Как установить doc-gen в Claude Code?
Выполните команду npx skills add ruvnet/ruflo --skill doc-gen -a claude-code. Также файл скилла можно сохранить вручную по пути ~/.claude/skills/doc-gen/SKILL.md.
Что делает скилл doc-gen?
Он формирует проектную документацию и сверяет её с кодом для поиска расхождений. Скилл работает с отдельными модулями или проектом целиком и поддерживает запуск по расписанию.
Как настроить регулярное обновление документации?
Скилл использует инструмент CronCreate. Достаточно передать cron-расписание вида 0 */2 * * * и промпт для вызова воркера документирования.
Исходный текст
SKILL.md · MIT
---
name: doc-gen
description: Generate and maintain documentation with drift detection. Use when the user asks to write/update/refresh docs, detect doc drift against code, or schedule recurring documentation maintenance.
argument-hint: "[--target PATH]"
allowed-tools: Bash(npx *) mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch mcp__plugin_ruflo-core_ruflo__memory_store CronCreate Read Write
---
Generate docs via MCP worker dispatch:
`mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document" })`
For continuous doc maintenance via CronCreate:
`CronCreate({ schedule: "0 */2 * * *", prompt: "Run document worker" })`
Detect drift by comparing current code against existing docs and flagging inconsistencies.
Scoped generation:
- API docs: `npx @claude-flow/cli@latest hooks worker dispatch --trigger document --context api`
- Full project: `npx @claude-flow/cli@latest hooks worker dispatch --trigger document --context full`
Store the approach: `mcp__plugin_ruflo-core_ruflo__memory_store({ key: "doc-pattern", value: "APPROACH", namespace: "patterns" })`
© ruvnet · MIT · ruvnet/ruflo
