SuperAPI AI 工具集

octocode-documentation-writer

写作与研究

查看项目

更新于 10-15 17:25

技能介绍

用途:当用户要求生成文档、为项目写文档、创建或更新文档时使用。该技能用 6 阶段流水线为代码仓库生成文档,强调研究先行验证与文件独占以避免冲突。

主要能力:阶段1以 4 个并行代理做发现与分析,合并为 analysis.json;阶段2由单个高能力推理代理生成 questions.json;阶段3由并行研究代理基于问题做代码取证,产出 research.json;阶段4由单个高能力推理代理按文件目标分组问题并分配独占权,产出 work-assignments.json;阶段5由 1-8 个并行写作代理生成 documentation/*.md(含 16 篇核心文档,其中 5 篇必需);阶段6由单个校验代理用 LSP 校验质量,产出 qa-results.json 与 QA-SUMMARY.md。

使用方式:入口为 /octocode-documentation-writer PATH。运行前做预检:路径必须存在且为目录;源码文件少于 3 个会警告;不得指向 node_modules、dist、build 等构建目录;超过 200k LOC 会警告。会话工件位于 .octocode/documentation/{session-name}/,文档写入 documentation。若 state.json 存在且未处于完成或失败,会默认从检查点恢复;仅在显式要求时才重新开始。模型标签 Opus、Sonnet、Haiku 仅为角色提示,需映射到宿主可用模型;Task 指宿主的并行子代理机制,无真正并行时按顺序执行并保留文件独占,且需告知用户处于顺序回退模式。可选安装 Octocode MCP 以增强研究,配置含 npx octocode-mcp 与 ENABLE_LOCAL=true。

适用场景:为项目生成或更新结构化文档,尤其希望以代码证据驱动、避免多写作者文件冲突的场景。

限制:并行度受宿主能力约束,不支持并发时退化为顺序执行;预检对路径、构建目录、仓库规模有硬性要求;模型标签并非硬性要求;部分细节如具体文档清单字段与各代理实现需参考其引用文件,资料未完全展开。