SuperAPI AI 工具集

design-doc-reviewer

写作与研究

查看项目

更新于 10-15 21:37

技能介绍

用途:独立判断设计是否构成可靠、经济的实现契约。评审保持只读,只保存评审产物,不修改设计或改变其状态。

主要能力:完整阅读目标文档与 ../design-doc/references/design-contract.md,不加载写作者提示词,以共享契约为评审边界。阅读仓库说明及相关愿景或架构文档,独立检查高风险代码、测试、schema、配置与调用点,区分已验证的仓库事实、提议的设计决策与未解决假设。

使用方式:解析 design-to-issues/scripts/story_contract.py 并运行:python3 <story-contract-script> <design-doc> --repo-root <repository-root> --mode author。机械校验失败即阻断;脚本只判断语法与结构,不判断语义质量。

评审模式:初始评审检查设计是否在授权范围内解决产品问题,架构、归属、状态/数据契约、集成行为与失败路径是否一致,安全、隐私、权限、迁移、兼容、发布、回滚、性能与运维是否足够安全,风险行为能否验证,每个规范故事是否描述单一连贯结果、包含共享需求、依赖有效、提供二元标准与真实验证,以及细节是否投机、重复或过度。后续评审验证先前阻断项、变更部分及其影响的故事与依赖面、机械校验与关键回归;若变更涉及横切架构、安全边界、数据契约、迁移、兼容、发布或故事排序,则扩大为完整评审。

发现:每个阻断项包含证据(确切设计位置加已验证仓库证据或具体内部矛盾)、影响(实现或交付如何失败)、必需不变量(修订必须满足的条件)。非阻断建议须有价值且简洁,可保留或豁免,不阻止 Ready 结论。

输出:使用下一个未使用的版本化路径 docs/design/reviews/<design-slug>/review-<NN>.md,保留每次评审产物而非覆盖。报告含标题、设计路径、评审日期、模式、结论、机械校验、阻断项数、非阻断建议数,以及阻断发现、非阻断建议、先前发现与交接部分。Ready 表示作者模式机械校验通过、无阻断发现、无未解决决策阻碍范围内故事。一次性评审者报告结论,但从不将设计提升为 Revised。

限制:只读,不修改设计或状态;机械校验不评估语义质量;资料未提供具体安装命令、收费、价格、平台或效果信息。