SuperAPI AI 工具集

review-doc-consistency

编程与开发

查看项目

更新于 10-15 22:13

技能介绍

用途:系统性识别 README 与 docs/ 中“过时”或“与实现不一致”的描述,输出不少于 30 条问题项。核心原则:代码为准,文档与代码冲突时以源码、配置、契约文件为准;结论需有证据,每条问题须引用代码或配置位置;契约优先,OpenAPI、proto、schema、TS 类型视为唯一事实来源;安全相关不一致优先定为高严重度。

审查流程:先枚举文档,扫描 README.md、docs/**/*.md 及 OpenAPI、proto、GraphQL schema、TS 类型等契约文件;再逐文档审查,列出关键声明、承诺、配置与接口项,在代码中查找对应实现,比较缺失、重命名、行为不符、默认值不符等差异,并按模板记录;最后交叉核对,从契约文件和配置文件反向检查文档。详细清单见 checklist.md。

严重度:P0 安全问题或严重误导;P1 核心功能不一致,照文档操作会失败;P2 示例不完整或命名不一致,不直接阻塞使用;P3 措辞、格式、链接等小问题;另有“待证据”表示可疑但证据不足。

输出格式:单条问题包含标题、严重度、位置(文件路径与行号)、证据(文档引用与代码引用)、影响、建议、相关原则。审查结论包含判定(通过、有条件通过、不通过)、汇总(各严重度数量)与修复优先级(P0 到 P3)。

可多智能体并行:按文档类型、按模块或按检查方向拆分,聚合时需去重并统一严重度。执行完成后输出 doc-consistency.md 报告文件,并输出 doc-consistency.json 结构化问题列表,便于聚合、去重与统计。限制:资料未提供具体安装命令、运行环境、收费与平台信息。