SuperAPI AI 工具集

docs-update

写作与研究

查看项目

更新于 10-16 00:29

技能介绍

用途:把已有文档刷新到与当前代码库一致,覆盖架构、快速上手、数据模型、部署、安全、贡献指南等文档。

主要能力:支持按参数限定范围——无参数或 all 更新 docs/ 下所有文档;传文档名(如 architecture)只更新映射到的那一个文件;category:<名称>(core、data、infrastructure、development)更新该类别下所有文档。内置防幻觉规则:每句话都要能追溯到本次运行读取或检索到的文件,数量用 find/grep 统计而非估算,删除已不存在的功能描述,写完复读 diff 去掉无证据内容。

使用方式:先解析范围并做存在性检查,目标文档不存在时立即停止整次运行,并提示改用 docs-init 创建;多文档运行时用 TodoWrite 逐条跟踪。随后检查新鲜度,将文档最后一次提交与之后源码变更对比;git 历史不可用时回退到 references/change-detection.md 的命令并说明。再逐一对照代码验证文档中的组件名、数量、路径、技术栈等声明,多文档时每个文档起一个子代理并行验证,无子代理工具则串行执行。写入时保留人工新增内容和不符合模板结构的内容,只改有事实支撑的部分;模板与 docs-init 共享,需先运行 grep -oE '{{[A-Z_]+}}' <template-file> 确认该模板实际使用的占位符,组件或实体有变化的图需重画,无法验证的声明删除,不确定某段是自定义还是自动生成时先询问再决定是否覆盖。最后报告已更新、已是最新、未找到/未验证的文档及具体数字。

适用场景:重构、架构调整、数据模型或基础设施变更之后,以及新成员入职、发布之前反复运行。

限制:永远不会创建不存在的文档;不报告“已创建”文档;git 历史缺失时无法从 git 判断新鲜度;无法验证的安全等声明会保留并标记人工复核;子代理、模板获取等依赖具体环境,未提供时按回退方式处理。