SuperAPI AI 工具集

design-review

写作与研究

查看项目

更新于 10-15 20:07

技能介绍

用途:design-review 在设计文档即将获批前,进行一次对抗式预审批审查,提前暴露那些通常在后期甚至生产环境才出现的问题。审查对象为 spec、设计文档、RFC、ADR 或实施计划,不审查代码或 diff。

主要能力:按九类缺口清单逐项排查——启动与归属、命名是否诚实、规模与限制、隐藏假设、与已发布代码是否一致、幂等/失败/重跑、安全面、必要性与更简单替代方案、完整性与清晰度。若文档是实施或项目计划,还额外检查任务粒度、依赖顺序/DAG、对配套 spec 的覆盖、退出标准可测性。它会针对现有行为、路径或接口的断言去核实真实代码,并引用 file:line 证据;无法确认的疑点会明确标注为 unverified,不当作事实。最终产出发现报告与结论。

发现格式:每条包含严重级别(blocker / important / minor)、类别、在文档中的位置、缺口说明、具体建议修复、证据(path:line 或 unverified)。结论以一行给出 ready-for-approval 或 has-blockers。

使用方式:先提供待审查文档路径,可选提供代码库指针与输出偏好(默认内联,亦可写出 review.md)。先完整阅读文档,再按清单排查,对涉码断言读取或 grep 相应模块确认,最后汇总并给出结论。可选在大文档或高风险文档时派发一个无先前上下文的子代理独立审查,再合并去重。该 skill 不含脚本,依赖 Read / Grep / Glob 及可选的子代理派发。

适用场景:文档作者在提交审批前想要一次批判性检查;自动化工作流需要一致的预审批审查步骤。

限制:仅审查文档,绝不编辑文档,也绝不批准或拒绝;决定权归人,修复归作者。不要用于代码/diff。doc-library 的 technical-design、architecture-doc、data-model、api-spec 四类制品有各自专用审查 skill,不在本 skill 范围内;独立临时的 ADR/RFC 仍归本 skill。全新项目无代码可核实时,一致性类别标为 N/A,缺少代码本身不构成 blocker。核实范围仅限文档引用的模块,不扫描整棵仓库树。