SuperAPI AI 工具集

review-doc-consistency

写作与研究

查看项目

更新于 10-15 21:38

技能介绍

用途:系统性找出 README、docs 目录中过时或与实现不符的描述,目标输出不少于 30 条问题项。

核心原则:代码为事实依据,文档与代码冲突时以源码、配置、契约文件为准;每个问题须引用代码或配置位置作为证据;OpenAPI、proto、schema、TS 类型视为唯一可信来源;安全相关不一致优先按高严重度处理。

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

严重级别:P0 安全问题或严重误导(如文档称沙箱已启用但代码未启用);P1 核心功能不一致,照文档操作会失败;P2 示例不完整或命名不一致,不直接阻断使用;P3 措辞、格式、链接等小问题;另设证据不足待查项。

输出格式:单条问题包含标题、严重级别、位置(文件路径与行号)、证据(文档引用与代码引用)、影响、最小修复建议、对应原则。结论部分给出通过、有条件通过或不通过,统计各级数量,修复优先级为 P0 到 P3。详细模板见 output-format.md。

加速方式:可按文档类型、功能模块或检查方向拆分给多个智能体并行执行,聚合时需去重并统一评级。执行完成后输出 doc-consistency.md 报告文件,同时输出 doc-consistency.json 结构化问题列表,便于聚合、去重与统计。限制与具体安装或调用方式在现有资料中暂未提供。