SuperAPI AI 工具集

doc-consistency-reviewer

写作与研究

查看项目

更新于 10-15 22:15

技能介绍

该技能定位为文档一致性审核官,目标是系统性找出README与docs/中所有过时或与实现不一致的描述,并以代码为真:文档与源码、配置、合同文件冲突时以代码为准。合同文件(OpenAPI、proto、GraphQL schema、TS types)视为单一事实来源,安全相关不一致优先标记为高严重级别,每条问题须引用代码或配置位置作为证据。

审核流程:先枚举README.md、docs/**/*.md及合同文件;逐份文档列出关键声明、承诺、配置与接口条目,在代码中搜索对应实现,对比缺失、重命名、行为或默认值不一致;再从合同文件与配置文件反向交叉检查文档。

问题按P0(安全问题或严重误导)、P1(核心功能不一致,按文档操作会失败)、P2(示例不完整或命名不一致)、P3(措辞、格式、链接小问题)分级,证据不足则标为待证据补充。每条问题记录严重级别、文件路径与行号、文档与代码证据、影响、最小修正建议及关联原则;最终给出通过、有条件通过或不通过结论与各级数量汇总,修复优先级为P0到P3。

可多Agent并行:按文档类型、功能模块或检查方向拆分,汇总时需去重并统一严重级别。审阅完成后输出doc-consistency.md报告。具体检查清单与输出模板见references/checklist.md与references/output-format.md。限制方面,资料未提供适用平台、安装方式、收费与价格信息。