关于 doc-gen
用于生成和维护项目文档的技能,可调度 worker 检查代码与文档之间的不一致,并支持按 API 或整个项目限定生成范围。
主要功能
- 01调度文档 worker
- 02生成 API 或全项目文档
- 03检测代码与文档偏差
- 04安排定期文档任务
适用场景
- 01代码变更后生成文档
- 02检查文档是否与当前代码一致
MCP 相关
通过 MCP worker-dispatch 工具触发文档生成,也可使用 MCP memory 工具保存处理方法。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ruvnet/ ruflo --skill doc-gen安装后在 Claude Code 中输入/doc-gen确认已加载。
详细介绍
通过 MCP worker dispatch 生成文档:
mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document" })
通过 CronCreate 持续维护文档:
CronCreate({ schedule: "0 */2 * * *", prompt: "Run document worker" })
通过将当前代码与现有文档进行比较来检测偏差,并标记不一致之处。
按范围生成:
- API 文档:
npx @claude-flow/cli@latest hooks worker dispatch --trigger document --scope api - 完整项目:
npx @claude-flow/cli@latest hooks worker dispatch --trigger document --scope full
存储此方法:mcp__plugin_ruflo-core_ruflo__memory_store({ key: "doc-pattern", value: "APPROACH", namespace: "patterns" })
评论
支持 Markdown