SuperAPI AI 工具集

review-docs

写作与研究

查看项目

更新于 10-15 21:12

技能介绍

用途:review-docs 是一个只读的文档审计技能,用于对照代码变更检查文档与代码注释是否准确,找出过时文档、错误示例和缺失文档,通常在提交 PR 前使用。

主要能力:确定审查范围(用户指定文件/目录,或默认对比 origin/main、origin/master 的 git diff);读取完整文件而非仅看 diff;定位 AGENTS.md、README.md、docs/、SPEC.md、CHANGELOG.md、CONTRIBUTING.md、plugin.json、SKILL.md 等文档;审计 JSDoc/docstring、行为注释、TODO/FIXME、类型注解和注释中的示例代码;交叉核对 API 签名、配置项、命令、安装步骤、示例、文件路径和版本号;识别未记录的新功能、仍记录已删除功能的过时文档、会报错的示例和版本不匹配。

使用方式:由用户指定文件或目录,否则默认对比 origin/main 或 origin/master,命令为 git diff origin/main...HEAD --name-only && git diff --name-only;范围不明确或无变更时需先向用户确认。输出为文档审计报告,包含范围、分支、状态、已分析代码变更、按严重程度分组的问题、缺失文档、代码注释问题、统计和推荐操作。

适用场景:代码变更后的文档同步检查、PR 前审查、API 文档与示例核对、代码注释准确性检查。

限制:严格只读,不修改任何文件;仅报告高置信度问题,且需通过可操作性筛选;严重程度最高为 Medium;默认 diff 模式下只报告由本次代码变更引起的文档问题,既有问题不在范围内;代码缺陷、可维护性、类型安全、测试覆盖和 AGENTS.md 合规性由其他技能处理;无文档时报告为严重缺口;无代码变更影响文档时报告文档已是最新。

其他事实(如收费、价格、平台支持)暂未提供。