mcpField
D
design-doc-reviewer

design-doc-reviewer

github.com/eho测试与质量148 次安装9 周前更新
代码仓库

关于 design-doc-reviewer

Design Doc Reviewer 是只读审查技能,用于判断设计文档能否作为可靠且精简的实现契约。它依据仓库证据核查设计并运行机械验证,将审查结果保存为版本化文档,不修改设计或其状态。

主要功能

  1. 01通读设计文档和共享契约
  2. 02依据仓库证据核实陈述
  3. 03评估风险与实现边界
  4. 04运行故事契约的机械验证
  5. 05区分阻塞问题与建议
  6. 06保存版本化审查文档

适用场景

  1. 01在实现前审查设计
  2. 02核对设计陈述是否符合现有代码
  3. 03根据此前的阻塞问题检查修订
  4. 04记录审查结果但不更改设计状态

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/eho/agent-skills --skill design-doc-reviewer

安装后在 Claude Code 中输入/design-doc-reviewer确认已加载。

详细介绍

设计文档评审员

独立判断设计是否构成合理、经济的实现契约。保持只读:保存评审产物,但不要修改设计或更改其状态。

阅读目标文档全文以及 ../design-doc/references/design-contract.md。 不要加载编写者提示词;共享契约就是评审边界。

以事实为依据开展评审

阅读仓库说明以及相关的愿景或架构文档。 独立检查支撑重要主张的最高风险代码、测试、架构、配置和调用点。 在评审中区分:

  • 已核实的当前仓库事实;
  • 提议的设计决策;
  • 尚未解决的假设。

根据风险成比例地探索,而不是重现编写者的全部发现过程。看似精确的路径或签名,在核实之前都不构成证据。

解析 design-to-issues/scripts/story_contract.py 并运行:

python3 <story-contract-script> <design-doc> \
  --repo-root <repository-root> --mode author

机械验证失败属于阻塞问题。该脚本检查语法和结构,不评判语义质量。

评审模式

初始评审

阅读完整设计并检查所有重要的实现边界。思考:

  • 该设计是否在获准范围内解决了所述产品问题?
  • 架构、所有权、状态/数据契约、集成行为和故障路径是否与仓库现状及彼此一致?
  • 在相关情况下,安全、隐私、权限、迁移、兼容性、发布、回滚、性能和运维是否足够安全,可供实现?
  • 是否可以验证高风险行为,而不依赖循环、不可用或事后证据?
  • 每个规范故事是否描述一个连贯的结果,包含影响该故事的全部共享要求,使用有效依赖项,并提供二元标准和切实可行的验证方式?
  • 是否有任何细节纯属推测、重复或与功能不成比例?若现有机制能满足不变量,应优先简化或沿用现有机制。

仅当某项问题可能导致不兼容或不安全的实现、行为错误、数据/安全/迁移/兼容性故障、不可能达成的标准,或阻碍范围内故事所需的决策未解决时,才将其视为阻塞问题。缺少润色或可能的增强属于非阻塞问题。

后续评审

收到先前评审时,核实:

  1. 每项先前的阻塞发现;
  2. 已更改的部分,以及这些更改影响的每个故事或依赖关系;
  3. 机械验证;
  4. 修订引入的关键回归问题。

如果更改影响跨领域架构、安全边界、数据契约、迁移、兼容性、发布或故事顺序,且影响程度使聚焦评审不再安全,则扩大到完整评审。

发现

每项阻塞发现都包含:

  • **证据:**设计中的确切位置,以及已核实的仓库证据或具体的内部矛盾;
  • **影响:**实现或交付可能如何失败;
  • **必需不变量:**修订必须满足的条件。

如果有多种方案都能满足不变量,不要指定新的子系统。只有在能实质性说明问题时,才提供示例。

非阻塞建议应有价值且简洁。它们可以保留或豁免,且绝不会妨碍给出 Ready 结论。不要要求补充优点、泛泛的章节评论、数字评分或任意数量的问题。

输出

使用下一个未使用的版本化路径: docs/design/reviews/<design-slug>/review-<NN>.md。如果仓库规范要求使用其他持久路径,请保留每一轮审查记录,不要覆盖之前的产物。

# Design Review: [title]

- Design: `docs/design/<file>.md`
- Reviewed: YYYY-MM-DD
- Mode: Initial | Follow-up
- Verdict: Ready | Not ready
- Mechanical validation: Pass | Fail
- Blocking findings: N
- Non-blocking suggestions: N

## Blocking Findings

### B1: [short title]
- Evidence:
- Impact:
- Required invariant:

## Non-Blocking Suggestions
- N1: [concise optional improvement]

## Prior Findings
- B1: Resolved | Unresolved | Regressed — [evidence]

## Handoff
- User decisions required:
- Affected story IDs:
- Recommended next action:

省略空的审查发现部分,或注明 None。Ready 表示作者模式下的机械验证已通过、没有遗留阻塞性发现,且没有未解决的决策会阻碍范围内的故事。一次性审查者会报告此结论,但绝不会将设计提升为 Revised。

评论

支持 Markdown