SuperAPI AI 工具集

doc-gen

写作与研究

查看项目

更新于 10-15 15:56

技能介绍

doc-gen 是一个文档生成与维护技能,来源于 ruvnet/ruflo 项目,主要用于在代码演进过程中保持文档同步,并通过漂移检测发现文档与代码之间的不一致。

用途方面,该技能适用于以下情形:用户要求编写、更新或刷新文档;需要检测文档相对代码的漂移;或需要安排持续的文档维护任务。

主要能力包括两项:一是文档生成与维护,通过 MCP worker 调度触发;二是漂移检测,即把当前代码与已有文档进行比对,标记出不一致之处。

使用方式提供了多种入口:

  • 通过 MCP worker 调度生成文档: 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" })

适用场景涵盖:希望自动产出或刷新项目文档的开发者;需要在代码变更后检查文档是否过时的团队;以及希望通过定时任务持续维护文档的持续集成或维护流程。

限制方面:资料中未说明该技能的收费、价格、平台支持范围、生成效果保证或具体支持的文档格式,这些信息暂未提供。使用时需具备相应的 MCP 环境或 @claude-flow/cli 命令行工具,具体依赖与前置条件资料中亦未说明。