SuperAPI AI 工具集

doc-freshness-review

通用与其它

查看项目

更新于 10-16 04:30

技能介绍

用途:审查仓库文档是否仍与当前代码、生成资源和发布入口一致,适用于对 doc/ 下已发布文档做陈旧或错误表述审计,检查 README.md、README.zh-CN.md、mcp/README.md、mcp/README.zh-CN.md 是否偏离当前行为,验证链接的脚本、文件、命令和工作流是否仍存在且匹配,以及在提交修正 PR 前做周期性文档健康检查。不适用于仅做营销文案润色、依赖 CloudBase 控制面文档的 API 契约审查、功能规划或架构设计,以及从零重写大型文档。

主要能力:按阶段执行审计。第一阶段先读 references/review-scope.md,将审计面分为 doc/ 下已发布文档与 README 系列两类,并记录这些文档声称描述的代码、脚本、生成文件或工作流。第二阶段做基于证据的比对,核实被引用的文件、脚本、命令和工作流名称是否仍存在,将每处不一致标记为过时表述、缺失或失效引用、过时命令、已发布文档与 README 之间的漂移、文档与实际实现之间的漂移。第三阶段给出严重程度与行动,优先提供带确切文件路径的具体发现和最小改写方向;机械且低风险的修复可准备聚焦 PR;产品行为不明确时写报告和 issue 而非猜测;若漂移源于 CloudBase API 契约问题,先转交 api-contract-review。第四阶段跟进,报告分开发布文档、README 面、失效或缺失引用三部分,每个连贯漂移批次一个聚焦 PR,已确认的开放 PR 修复转交 pr-review-fix。

使用方式:按路由表读取对应资源,审查范围读 references/review-scope.md,API 契约漂移读 api-contract-review,开放 PR 修复读 pr-review-fix。自检要求分别审查已发布文档与 README 面,为每处失效引用指出确切路径,与当前代码、脚本和生成输出比对而非凭记忆,修复建议应为小而可审的文档批次,产品行为不明时止步于报告或 issue。

限制:资料未提供具体安装命令、收费或平台信息;不适用于营销文案、API 契约审查、功能规划及大规模重写。