grill-with-docs — 文档对照审查
- 触发方式:
/grill-with-docs或关键词「对照文档」「对照 CONTEXT.md」「grill with docs」 - 适用场景: 方案设计阶段对照现有文档验证、术语对齐、ADRs 更新
- 不适用场景: 没有项目文档的新项目、纯代码审查
功能概述
grill-with-docs 将你的计划方案与项目现有的领域模型(CONTEXT.md)和架构决策记录(ADRs)进行对照审查。它会:
- 检查方案中的术语是否与 CONTEXT.md 一致
- 验证方案是否符合已有的架构决策
- 在决策明确后,自动更新相关文档
触发条件
以下情况会自动触发 grill-with-docs:
- 提到「对照文档检查」「和已有决策对齐」
- 在设计阶段需要与项目规范保持一致
- 使用
/grill-with-docs命令
使用示例
示例 1:对照领域模型
/grill-with-docs 我们的新支付方案是否符合 CONTEXT.md 中的支付领域模型?Claude 会:
- 读取 CONTEXT.md 中的支付领域定义
- 对比方案中的术语是否一致
- 指出冲突或不一致的地方
示例 2:ADR 一致性检查
/grill-with-docs 检查这个缓存方案是否违反了我们已有的 ADR-003(禁止分布式缓存)示例 3:术语对齐
/grill-with-docs 统一我们的术语:方案里用的是「用户」,但 CONTEXT.md 里用的是「会员」示例 4:更新文档
/grill-with-docs 我们决定用 Redis Cluster,请更新 ADR-005 记录这个决策对照维度
| 维度 | 来源 | 检查内容 |
|---|---|---|
| 领域术语 | CONTEXT.md | 命名是否一致 |
| 架构约束 | ADRs | 是否违反已有决策 |
| 代码模式 | 代码库 | 是否符合现有模式 |
| 业务流程 | 领域模型 | 流程是否匹配 |
注意事项
- 如果 CONTEXT.md 和实际代码不一致,以代码为准并更新文档
- ADRs 是记录决策,不是不可改变的规则 — 可以推翻但要明确记录
- 审查结果中会有「可修复」和「需讨论」两个级别
- 文档变更会自动以 Edit 方式应用,审查后再提交
相关 Skills
- grill-me — 深度追问(不限定文档范围)
- improve-codebase-architecture — 基于领域语言改进架构
- init — 初始化 CONTEXT.md 和 ADRs