SuperAPI AI 工具集

octocode-documentaion-writer

办公与效率

查看项目

更新于 10-15 18:37

技能介绍

用途:面向代码仓库自动生成较完整的文档,通过多阶段流水线把分析、提问、研究、编排、写作与质检串联起来。资料称其为生产就绪的六阶段管线,强调研究优先验证与无冲突的文件归属。

主要能力与流程:阶段1为发现与分析,由4个并行代理分别处理语言与清单、组件、依赖、流程与API,汇总为 analysis.json;阶段2由单个 Opus 代理基于分析生成问题,输出 questions.json;阶段3为研究代理,按问题量动态并行(少于10个问题1个代理,否则按问题数/15向上取整),产出带证据的 research.json;阶段4由单个 Opus 编排,按目标文件分组并把文件独占权分配给写作者,输出 work-assignments.json;阶段5由1至8个 Sonnet 写作者并行撰写,输出 documentation/*.md(称16份核心文档、5份必需及补充文件);阶段6为单代理 QA 校验,使用 LSP 验证,输出 qa-results.json 与 QA-SUMMARY.md,评分0-100,分档为 excellent(≥90)、good(≥75)、fair(≥60)、needs-improvement(<60)。

使用方式:以 /octocode-documentaion-writer PATH 形式调用并传入仓库路径。运行前有预检:路径必须存在且为目录,含 node_modules/dist/build 会报错退出,源码文件少于3个或超过20万行会警告并询问是否继续。上下文写入 ${REPOSITORY_PATH}/.context,文档写入 ${REPOSITORY_PATH}/documentation;若存在 state.json 且未完成,会提示是否从检查点恢复。并行阶段要求在同一消息中发起全部 Task 调用,禁止顺序调用。

适用场景:需要为较大代码库批量生成多份结构化文档并附带质量报告的场合。

限制:文档未提供具体的收费、价格、平台支持范围、安装命令与使用时长的信息,这些事实暂未提供。