SuperAPI AI 工具集

synchronize-documentation

写作与研究

查看项目

更新于 10-16 06:18

技能介绍

用途:在观察到代码、配置或 API 变更后,同步既有文档,同时保留每份文档的用途与权威性。

主要能力:先确定精确的实现差异及其对外部/用户/维护者可见的后果;按与被变更契约、名称、路径、配置、API 和工作流的语义关联发现相关文档,不做无理由的全量扫描;编辑前判断每份候选文档的用途、受众、权威性和事实来源关系,将其重要陈述与当前实现/契约比对,对不受影响的文档明确跳过。

使用方式:只更新最窄的权威位置;删除过时陈述而非内联保留历史(除非文档本身就是历史性质);当多份文档重复同一含义时,向权威来源合并,必要时保留导航指针;示例若是有用的可执行/用户指引应予保留,更新或测试而非一律禁止代码示例;编辑后重读文档,校验链接/引用及仓库要求的检查,并报告已变更和已检查但未变更的部分。

限制:文档同步过程中不得修改源码行为;不得假定实现优先于规范性规范,遇到权威冲突应上报而非改写规范去迁就代码。具体安装命令、收费、价格与平台信息暂未提供。