SuperAPI AI 工具集

generate-docs

通用与其它

查看项目

更新于 10-15 21:56

技能介绍

用途:把一次工作单元产生的知识整理成贡献者可阅读的开发者文档,随交付增量更新,避免公开仓库文档过期。适合在完成一个工作单元后、上下文尚新时使用,也可按需针对特定区域生成,例如 generate-docs src/domain/events/。另有 --review 选项,用于把最新评审报告导出为文档页面。它不用于编写 SPEC/规划文档、会话日志或代码评审。

主要能力与流程:先通过 Step 0 检测清单解析 docs adapter,并给出适配器名称或 NOT CONFIGURED;仅配置适配器后读取适配器槽位,再执行范围、增量、映射/评审、验证与报告步骤。生成或更新的页面需写入磁盘并带 provenance frontmatter。增量选择是唯一的页面选取依据,禁止整站再生成。允许读取 diff、代码和文档,允许在适配器指南位置写/更新页面,允许仅更新适配器声明的手动侧边栏配置,允许运行声明的文档构建/验证命令。

输出要求:结束时打印固定报告块,包含 adapter、scope、页面表格(Page/Action/Source-unit/Subject paths)、Map、Review export、Verify、Pages、Decision(PASS/FAIL/NOT-CONFIGURED),最后输出 → Next: 块。FAIL 仅当验证失败或已写页面需要回滚。

限制:禁止整项目文档再生成、编辑源码/测试/其他配置、搭建文档站点、在适配器内容位置之外写入、写无 provenance frontmatter 的页面、提交或推送。NOT CONFIGURED 时停止写入,不得猜测适配器、输出路径或固定契约。文档语言优先级为显式用户指令 > 项目声明的文档语言 > 英语,对话语言不决定。

其他信息:官方文本未提供;价格、平台、具体构建命令和适配器清单等细节暂未提供。