SuperAPI AI 工具集

resolve

写作与研究

查看项目

更新于 10-19 19:24

技能介绍

resolve 是 doc-sentinel 技能集中的漂移处理技能,用于清理 .doc-sentinel-drift.json 中累积的文档漂移警告:逐条核实文档是否确实与代码脱节,确有漂移则修正受影响文档,属误报则驳回。\n\n用途\n承接文档同步环节产生的漂移警告队列。当源文件变更后,doc-sentinel 会记录可能受影响的文档;resolve 负责把这些积压警告处理完,使文档重新与代码一致。\n\n主要流程\n1. 加载漂移队列:读取 .doc-sentinel-drift.json,若文件缺失或为空则报告“没有待解决的漂移警告”并退出。\n2. 去重与分组:按文档文件对警告分组,同一文档受多处源变更影响时合并处理,并在处理前展示分组摘要与总数。\n3. 逐组甄别:先读取文档与变更后的源文件,再判定漂移类型——路径迁移(更新文档中的路径引用)、API 变更(更新接口文档)、配置变更(更新环境变量、端口、配置项引用)、结构变更(更新代码地图/架构章节)、行为变更(更新涉及具体行为的描述)、误报(驳回)。\n4. 修复或驳回:真实漂移先读取文档中引用该代码的片段与源码新状态,再按周围内容一致的写作风格和详细程度更新;意图不明时添加 <!-- TODO: verify --> 注释而非猜测。误报记录为已驳回并从队列移除。\n5. 提交修复:仅暂存被修改的文档文件,使用 docs: 前缀提交,避免提交后钩子再次触发。\n6. 清空队列:删除 .doc-sentinel-drift.json(该文件为会话级)。\n7. 输出报告:列出已修复项、已驳回的误报项与剩余项;无法自动解决、需要人工判断意图的警告单列在“Needs Review”下并附具体问题。\n\n使用方式\n以技能形式在具备相应源码仓库中使用,依赖 .doc-sentinel-drift.json 队列文件与 git 提交环境。具体安装命令与调用参数暂未提供。\n\n规则约束\n修改前必须同时阅读文档与源码;保持原有写作风格;不得整段删除文档章节,只做更新;使用 docs: 前缀避免钩子循环;若单次提交对同一文档产生超过 5 条漂移警告,考虑整体重写而非逐点修复,复杂情况可派发 drift-resolver 代理;处理完毕后即使有驳回项也要删除队列文件;若同时安装了 doc-sync 或 inkwell,不重复其工作,本技能只负责引用与准确性修复,不负责内容生成。\n\n适用场景\n适用于维护随代码演进的项目文档(如架构说明、API 文档、README),需要批量核实并修正文档与代码偏差的场合。\n\n限制\n仅处理队列中已有警告;不生成新内容;意图不明确处需人工复核;收费、价格、平台支持等信息暂未提供。