@namewta/speculo 0.2.2 → 0.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -15
- package/dist/src/index.js +72 -8
- package/dist/src/index.js.map +1 -1
- package/dist/src/migrate.js +8 -8
- package/dist/src/migrate.js.map +1 -1
- package/dist/src/workflows.js +2 -2
- package/dist/src/workflows.js.map +1 -1
- package/package.json +1 -1
- package/template/.speculo/README.md +3 -3
- package/template/AGENTS.md +4 -0
- package/template/CLAUDE.md +3 -0
- package/template/canonical/README.md +114 -0
- package/template/canonical/canonical-domain-modeling.md +289 -0
- package/template/canonical/canonical-skill-example.md +608 -0
- package/template/canonical/canonical-teach.md +296 -0
- package/template/commands/archive-and-consolidate.md +49 -0
- package/template/commands/docs-sync.md +2 -2
- package/template/commands/retro.md +9 -7
- package/template/commands/status.md +2 -2
- package/template/skills/archive-and-consolidate/SKILL.md +179 -0
- package/template/skills/archive-and-consolidate/assets/archive-plan-template.md +34 -0
- package/template/skills/archive-and-consolidate/assets/cleanup-candidate-template.md +69 -0
- package/template/skills/archive-and-consolidate/assets/consolidation-plan-template.md +67 -0
- package/template/skills/archive-and-consolidate/references/archive-rules.md +48 -0
- package/template/skills/archive-and-consolidate/references/cleanup-rules.md +73 -0
- package/template/skills/archive-and-consolidate/references/consolidation-rules.md +70 -0
- package/template/skills/archive-and-consolidate/references/knowledge-graduation.md +50 -0
- package/template/skills/docs-sync/SKILL.md +1 -1
- package/template/skills/docs-sync/references/readme-contract.md +2 -0
- package/template/skills/docs-sync/references/readme-writing-guide.md +294 -0
- package/template/skills/docs-sync/references/workflow-scope-contract.md +3 -3
- package/template/skills/speculo-retro/SKILL.md +1 -1
- package/template/skills/speculo-retro/references/issue-drafting-sop.md +1 -1
- package/template/skills/worktree-isolation/references/merge-and-cleanup.md +2 -2
- package/template/vendor/README.md +3 -3
- package/template/vendor/khazix-skills/neat-freak/SKILL.md +210 -0
- package/template/vendor/khazix-skills/neat-freak/references/agent-paths.md +72 -0
- package/template/vendor/khazix-skills/neat-freak/references/governance.md +88 -0
- package/template/vendor/khazix-skills/neat-freak/references/sync-matrix.md +77 -0
- package/template/vendor/khazix-skills/neat-freak/references/verification.md +92 -0
- package/template/vendor/khazix-skills/neat-freak/scripts/audit-inventory.sh +106 -0
- package/template/workflows/person/INDEX.md +12 -0
- package/template/workflows/person/M-mao-zedong-cognitive-os/M-mao-zedong-cognitive-os.md +73 -74
- package/template/workflows/specdev/D-diagnose-bugs/D-diagnose-bugs.md +85 -0
- package/template/workflows/specdev/D-diagnose-bugs/cleanup-postmortem.md +37 -0
- package/template/workflows/specdev/D-diagnose-bugs/feedback-loop-techniques.md +84 -0
- package/template/workflows/specdev/D-diagnose-bugs/hypothesis-format.md +46 -0
- package/template/workflows/specdev/D-diagnose-bugs/instrumentation-rules.md +51 -0
- package/template/workflows/specdev/G-grill-with-docs/G-grill-with-docs.md +54 -0
- package/template/workflows/specdev/G-grill-with-docs/adr-format.md +77 -0
- package/template/workflows/specdev/G-grill-with-docs/context-format.md +63 -0
- package/template/workflows/specdev/G-grill-with-docs/domain-modeling-rules.md +93 -0
- package/template/workflows/specdev/G-grill-with-docs/grilling-protocol.md +54 -0
- package/template/workflows/specdev/G-grill-with-docs/log-format.md +99 -0
- package/template/workflows/specdev/I-implement/I-implement.md +85 -0
- package/template/workflows/specdev/I-implement/code-review-process.md +83 -0
- package/template/workflows/specdev/I-implement/codebase-design-glossary.md +109 -0
- package/template/workflows/specdev/I-implement/deepening.md +37 -0
- package/template/workflows/specdev/I-implement/design-it-twice.md +44 -0
- package/template/workflows/specdev/I-implement/tdd-examples.md +139 -0
- package/template/workflows/specdev/I-implement/tdd-rules.md +31 -0
- package/template/workflows/specdev/I-init-setup/I-init-setup.md +132 -0
- package/template/workflows/specdev/I-init-setup/domain-layout.md +90 -0
- package/template/workflows/specdev/I-init-setup/status-labels.md +54 -0
- package/template/workflows/specdev/I-init-setup/tracking-convention.md +58 -0
- package/template/workflows/specdev/INDEX.md +81 -0
- package/template/workflows/specdev/S-spec/S-spec.md +91 -0
- package/template/workflows/specdev/T-tickets/T-tickets.md +241 -0
- package/template/workflows/specdev/W-wayfinder/W-wayfinder.md +209 -0
- package/template/workflows/specdev/_state/adr/.gitkeep +0 -0
- package/template/workflows/specdev/_state/archive/.gitkeep +0 -0
- package/template/workflows/specdev/_state/changes/.gitkeep +0 -0
- package/template/workflows/specdev/_state/context/.gitkeep +0 -0
- package/template/workflows/{matt-pocock → specdev}/_state/status.json +1 -1
- package/template/commands/finalize.md +0 -37
- package/template/commands/knowledge-prune.md +0 -20
- package/template/skills/change-lifecycle/SKILL.md +0 -25
- package/template/skills/change-lifecycle/assets/completion-summary-template.md +0 -25
- package/template/skills/change-lifecycle/assets/completion-verification-template.md +0 -29
- package/template/skills/change-lifecycle/references/completion-gate.md +0 -19
- package/template/skills/change-lifecycle/references/finalize-archive.md +0 -32
- package/template/skills/knowledge-prune/SKILL.md +0 -29
- package/template/skills/knowledge-prune/references/audit-rules.md +0 -24
- package/template/skills/runtime-context/SKILL.md +0 -54
- package/template/skills/runtime-context/references/path-resolution.md +0 -41
- package/template/workflows/matt-pocock/PERSISTENCE.md +0 -80
- package/template/workflows/matt-pocock/WORKFLOW.md +0 -103
- package/template/workflows/matt-pocock/_state/archive/.gitkeep +0 -1
- package/template/workflows/matt-pocock/_state/changes/.gitkeep +0 -1
- package/template/workflows/matt-pocock/atomic-skills/ask-matt.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/claude-handoff.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/code-review.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/codebase-design.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/diagnosing-bugs.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/domain-modeling.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/grill-me.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/grill-with-docs.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/grilling.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/handoff.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/implement.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/improve-codebase-architecture.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/loop-me.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/prototype.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/research.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/resolving-merge-conflicts.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/setup-matt-pocock-skills.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/tdd.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/teach.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/to-spec.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/to-tickets.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/triage.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/wayfinder.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/wizard.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/writing-beats.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/writing-fragments.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/writing-great-skills.md +0 -21
- package/template/workflows/matt-pocock/atomic-skills/writing-shape.md +0 -20
- package/template/workflows/matt-pocock/routes/architecture.md +0 -24
- package/template/workflows/matt-pocock/routes/diagnose.md +0 -22
- package/template/workflows/matt-pocock/routes/experimental.md +0 -18
- package/template/workflows/matt-pocock/routes/idea-to-delivery.md +0 -63
- package/template/workflows/matt-pocock/routes/merge-conflicts.md +0 -19
- package/template/workflows/matt-pocock/routes/productivity.md +0 -25
- package/template/workflows/matt-pocock/routes/research-prototype.md +0 -20
- package/template/workflows/matt-pocock/routes/review.md +0 -19
- package/template/workflows/matt-pocock/routes/setup.md +0 -42
- package/template/workflows/matt-pocock/routes/triage.md +0 -25
- package/template/workflows/matt-pocock/routes/wayfinder.md +0 -27
- package/template/workflows/person/PERSISTENCE.md +0 -56
- package/template/workflows/person/WORKFLOW.md +0 -50
- package/template/workflows/person/_state/.config/LESSONS.md +0 -3
- package/template/workflows/person/_state/.config/RULES.md +0 -3
- package/template/workflows/person/_state/.config/context/.gitkeep +0 -1
- package/template/workflows/person/_templates/mao-consultation-output-template.md +0 -55
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# 清理与事后分析
|
|
2
|
+
|
|
3
|
+
诊断完成、修复已由 I-implement 执行后,必须完成以下清理和复盘。
|
|
4
|
+
|
|
5
|
+
## 清理检查清单
|
|
6
|
+
|
|
7
|
+
逐项确认:
|
|
8
|
+
|
|
9
|
+
- [ ] 原始复现不再复现——重新运行阶段 2 的反馈回路,确认变绿
|
|
10
|
+
- [ ] 回归测试通过——I-implement 已为修复编写并通过回归测试
|
|
11
|
+
- [ ] 所有 `[DEBUG-xxxx]` 插桩已移除——`grep -r "\[DEBUG-"` 项目根目录,确认无残留
|
|
12
|
+
- [ ] 一次性原型已删除——移除所有为诊断创建的临时脚本、测试夹具、mock 数据
|
|
13
|
+
- [ ] 被证实的假设已记录到 `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>`,以便下一个调试者学习
|
|
14
|
+
|
|
15
|
+
## 记录根因
|
|
16
|
+
|
|
17
|
+
在 `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>` 中追加条目:
|
|
18
|
+
|
|
19
|
+
```markdown
|
|
20
|
+
## [YYYY-MM-DD] 诊断:<bug 简述>
|
|
21
|
+
|
|
22
|
+
- **根因**:<被证实的假设,包含技术细节>
|
|
23
|
+
- **验证方式**:<哪个探测确认了根因>
|
|
24
|
+
- **修复提交**:<I-implement 的提交 hash 或描述>
|
|
25
|
+
- **预防建议**:<什么本可以预防此 bug>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 事后分析
|
|
29
|
+
|
|
30
|
+
问:什么本可以预防这个 bug?从以下维度审视:
|
|
31
|
+
|
|
32
|
+
- **测试缝合点**——是否缺少合适的测试接缝?如果有好的缝合点,此 bug 是否会被更早发现?
|
|
33
|
+
- **接口设计**——接口是否暴露了容易误用的契约?深度是否足够防止调用者犯错?
|
|
34
|
+
- **数据边界**——是否缺少输入校验、类型约束或边界条件处理?
|
|
35
|
+
- **耦合**——是否因模块间的隐藏耦合导致变更的连锁反应?
|
|
36
|
+
|
|
37
|
+
如果答案涉及架构变更(没有好的测试缝合点、纠缠的调用者、隐藏的耦合),将具体情况记录到 LOG.md 的预防建议中。在修复之后提出建议——此时比诊断开始时拥有更多信息。
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# 反馈回路构建技术
|
|
2
|
+
|
|
3
|
+
反馈回路是诊断的核心——一个紧凑的通过/失败信号,锚定 bug 的症状。以下技术按大致优先级排列,从最理想到最后手段。
|
|
4
|
+
|
|
5
|
+
## 构建方式
|
|
6
|
+
|
|
7
|
+
按顺序尝试,直到获得一个可工作的回路:
|
|
8
|
+
|
|
9
|
+
### 1. 失败测试
|
|
10
|
+
|
|
11
|
+
在能触及 bug 的任意缝合点编写——单元测试、集成测试、端到端测试。优先选择现有的测试缝合点。观察项目中已有的测试了解如何注入测试。
|
|
12
|
+
|
|
13
|
+
### 2. Curl / HTTP 脚本
|
|
14
|
+
|
|
15
|
+
针对正在运行的开发服务器。固定请求参数,对响应状态码和关键字段进行断言。
|
|
16
|
+
|
|
17
|
+
### 3. CLI 调用
|
|
18
|
+
|
|
19
|
+
带固定输入调用 CLI,将 stdout 与已知良好快照进行 diff。适合命令行工具和数据管道。
|
|
20
|
+
|
|
21
|
+
### 4. 无头浏览器脚本
|
|
22
|
+
|
|
23
|
+
Playwright 或 Puppeteer 驱动 UI,对 DOM 状态、控制台输出、网络请求进行断言。适合前端 bug。
|
|
24
|
+
|
|
25
|
+
### 5. 回放捕获的追踪数据
|
|
26
|
+
|
|
27
|
+
将真实网络请求、负载、事件日志保存到磁盘,在隔离环境中通过代码路径回放。适合需要真实数据的场景。
|
|
28
|
+
|
|
29
|
+
### 6. 一次性测试夹具
|
|
30
|
+
|
|
31
|
+
启动系统的最小子集——一个服务、模拟依赖——用单个函数调用驱动 bug 代码路径。适合微服务或多组件交互的 bug。
|
|
32
|
+
|
|
33
|
+
### 7. 属性 / 模糊测试循环
|
|
34
|
+
|
|
35
|
+
如果 bug 表现为"有时输出错误",运行 1000 次随机输入寻找故障模式。适合数据相关或边界条件 bug。
|
|
36
|
+
|
|
37
|
+
### 8. 二分查找夹具
|
|
38
|
+
|
|
39
|
+
如果 bug 出现在两个已知状态之间(commit、数据集、版本),自动化"在状态 X 启动、检查、重复"以便 `git bisect run`。
|
|
40
|
+
|
|
41
|
+
### 9. 差分循环
|
|
42
|
+
|
|
43
|
+
通过旧版本 vs 新版本(或两种配置)运行相同输入,对输出进行 diff。适合回归 bug。
|
|
44
|
+
|
|
45
|
+
### 10. HITL bash 脚本
|
|
46
|
+
|
|
47
|
+
最后手段。如果必须由人工点击,使用 `<Path>{roots.vendor}/matt-pocock/engineering/diagnosing-bugs/scripts/hitl-loop.template.sh</Path>` 驱动人工操作,使循环仍然结构化。捕获的输出反馈给 agent。
|
|
48
|
+
|
|
49
|
+
复制模板,编辑步骤,运行脚本。脚本中的 `step` 函数显示指令并等待按 Enter,`capture` 函数显示问题并读取响应。结束时以 `KEY=VALUE` 格式打印捕获的值供 agent 解析。
|
|
50
|
+
|
|
51
|
+
## 收紧回路
|
|
52
|
+
|
|
53
|
+
将回路视为产品。一旦有了一个回路,收紧它:
|
|
54
|
+
|
|
55
|
+
- **更快**——缓存设置、跳过无关初始化、缩小测试范围
|
|
56
|
+
- **更清晰**——针对具体症状断言,而非"没崩溃"
|
|
57
|
+
- **更确定**——固定时间、种子随机数、隔离文件系统、冻结网络
|
|
58
|
+
|
|
59
|
+
一个 30 秒的抖动回路比没有回路好不了多少;一个 2 秒的确定性回路是调试的超能力。
|
|
60
|
+
|
|
61
|
+
## 非确定性 bug
|
|
62
|
+
|
|
63
|
+
目标不是干净的复现,而是更高的复现率。循环触发 100 次,并行化,增加压力,缩小时间窗口,注入 sleep。50% 抖动的 bug 是可调试的;1% 则不行——持续提高复现率直到可调试。
|
|
64
|
+
|
|
65
|
+
## 当确实无法构建回路时
|
|
66
|
+
|
|
67
|
+
停下来,明确说明。列出已尝试的方法。向用户请求:
|
|
68
|
+
|
|
69
|
+
1. 访问能复现的任何环境
|
|
70
|
+
2. 一个捕获的产物——HAR 文件、日志转储、核心转储、带时间戳的屏幕录制
|
|
71
|
+
3. 添加临时生产环境插桩的许可
|
|
72
|
+
|
|
73
|
+
在没有回路的情况下进入假设阶段是本规程要防止的核心失败模式。没有变红能力的命令,就没有后续阶段。
|
|
74
|
+
|
|
75
|
+
## 最小化协议
|
|
76
|
+
|
|
77
|
+
复现后,将场景缩小到仍能变红的最小场景。逐个削减以下元素,每次削减后重新运行回路:
|
|
78
|
+
|
|
79
|
+
1. 输入数据——减少字段、缩小数据集、简化参数
|
|
80
|
+
2. 调用者——移除中间层、直接调用核心逻辑
|
|
81
|
+
3. 配置——使用默认值、移除环境变量
|
|
82
|
+
4. 步骤——跳过前置操作、合并中间步骤
|
|
83
|
+
|
|
84
|
+
每个剩余元素必须有负载作用——移除其中任何一个都会使回路变绿。最小复现场景缩小了假设空间,并成为最终的回归测试基础。
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# 假设格式与诊断计划
|
|
2
|
+
|
|
3
|
+
在插桩之前生成多个排名假设。单一假设会锚定在第一个看似合理的想法上。每个假设必须是可证伪的——陈述其预测。
|
|
4
|
+
|
|
5
|
+
## 假设格式
|
|
6
|
+
|
|
7
|
+
每个假设使用以下模板:
|
|
8
|
+
|
|
9
|
+
> 如果 `<根因>` 是原因,那么 `<改变 X>` 会使 bug 消失 / `<改变 Z>` 会使它更糟。
|
|
10
|
+
|
|
11
|
+
无法陈述预测的假设只是感觉——精炼或丢弃它。
|
|
12
|
+
|
|
13
|
+
示例:
|
|
14
|
+
|
|
15
|
+
> 如果缓存键在用户 ID 包含特殊字符时生成错误,那么将用户 ID 替换为纯字母数字字符串会使 bug 消失,而保持原 ID 并在缓存查询前打印键值会显示格式错误的键。
|
|
16
|
+
|
|
17
|
+
## 排名规则
|
|
18
|
+
|
|
19
|
+
生成 3-5 个假设,按以下优先级排名:
|
|
20
|
+
|
|
21
|
+
1. **最近变更**——最近修改的代码区域优先。新代码是 bug 最常见的来源。
|
|
22
|
+
2. **数据边界**——涉及空值、特殊字符、极限值、类型转换的假设优先于一般逻辑错误。
|
|
23
|
+
3. **时序与并发**——涉及竞态条件、异步顺序、超时的假设在单线程同步假设之后。
|
|
24
|
+
4. **外部依赖**——涉及第三方库、API 响应变更、环境差异的假设排在最后。
|
|
25
|
+
|
|
26
|
+
## 诊断计划呈现
|
|
27
|
+
|
|
28
|
+
将排名假设列表作为诊断计划呈现给用户。使用以下格式:
|
|
29
|
+
|
|
30
|
+
```markdown
|
|
31
|
+
## 诊断计划
|
|
32
|
+
|
|
33
|
+
基于当前症状和代码库理解,以下是 3-5 个按优先级排名的可证伪假设:
|
|
34
|
+
|
|
35
|
+
1. **[假设名称]** —— 如果 `<根因>` 是原因,那么 `<预测>`。
|
|
36
|
+
2. **[假设名称]** —— 如果 `<根因>` 是原因,那么 `<预测>`。
|
|
37
|
+
...
|
|
38
|
+
|
|
39
|
+
请确认计划或调整优先级。你是否已经排除了其中任何一个?
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
用户通常拥有能立即重排名的领域知识——低成本检查点,大幅节省时间。向用户展示后等待确认。
|
|
43
|
+
|
|
44
|
+
## AFK 默认行为
|
|
45
|
+
|
|
46
|
+
如果用户 AFK(无响应),按排名继续——从排名最高的假设开始插桩验证。在每个假设被排除后,更新排名并继续下一个,无需等待确认。
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# 插桩验证规则
|
|
2
|
+
|
|
3
|
+
每个探测必须映射到诊断计划中的一个具体预测。每次只改变一个变量。
|
|
4
|
+
|
|
5
|
+
## 探测映射
|
|
6
|
+
|
|
7
|
+
在添加任何插桩之前,明确陈述:
|
|
8
|
+
|
|
9
|
+
- 此探测验证诊断计划中的哪个假设、哪个预测
|
|
10
|
+
- 期望看到什么结果(如果假设正确)
|
|
11
|
+
- 期望看到什么结果(如果假设错误)
|
|
12
|
+
|
|
13
|
+
每次探测后记录实际结果,与预测对照。如果预测不匹配,该假设被排除,移至下一个。
|
|
14
|
+
|
|
15
|
+
## 工具偏好
|
|
16
|
+
|
|
17
|
+
按优先级选择插桩方式:
|
|
18
|
+
|
|
19
|
+
### 1. 调试器 / REPL 检查
|
|
20
|
+
|
|
21
|
+
如果环境支持,优先使用。一个断点胜过十行日志。在关键路径上设置条件断点,检查变量状态和调用栈。
|
|
22
|
+
|
|
23
|
+
### 2. 针对性日志
|
|
24
|
+
|
|
25
|
+
在能区分假设的边界处添加日志——模块接口、数据转换点、分支条件。日志内容应包含:
|
|
26
|
+
|
|
27
|
+
- 所在假设的简短标识
|
|
28
|
+
- 关键变量的值
|
|
29
|
+
- 与预测相关的状态信息
|
|
30
|
+
|
|
31
|
+
### 3. 每条日志必须有明确的验证目标
|
|
32
|
+
|
|
33
|
+
全量日志淹没信号。每条日志单独对应一个假设预测,通过唯一前缀追溯到诊断计划中的具体条目。
|
|
34
|
+
|
|
35
|
+
## 调试日志标记
|
|
36
|
+
|
|
37
|
+
所有调试日志使用唯一前缀标记,格式为 `[DEBUG-xxxx]`,其中 `xxxx` 为 4 位随机字母数字(如 `[DEBUG-a4f2]`)。在日志消息中包含:
|
|
38
|
+
|
|
39
|
+
```javascript
|
|
40
|
+
console.log(`[DEBUG-a4f2] 缓存键: ${cacheKey}, 用户ID: ${userId}`)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
最终的清理只需一次 `grep`——未标记的日志保留,已标记的日志删除。
|
|
44
|
+
|
|
45
|
+
## 性能分支
|
|
46
|
+
|
|
47
|
+
对于性能回归,日志通常是错误工具。替代方案:
|
|
48
|
+
|
|
49
|
+
1. 建立基线测量——计时夹具、`performance.now()`、分析器、查询计划
|
|
50
|
+
2. 二分查找——定位引入回归的变更点
|
|
51
|
+
3. 先测量,后修复——在没有测量基线的情况下,任何优化都是猜测
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: specdev/grill-with-docs
|
|
3
|
+
type: workflow-entry
|
|
4
|
+
workflow: specdev
|
|
5
|
+
name: 设计访谈(带文档)
|
|
6
|
+
description: 无情访谈打磨设计,同时持续产出 ADR.md、LOG.md 和 CONTEXT.md 三个领域文档。在设计讨论中捕获术语定义、记录架构决策、保存完整设计轨迹。
|
|
7
|
+
keywords: [设计, 访谈, 领域建模, ADR, 决策记录, 词汇表, 设计轨迹]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 设计访谈(带文档)
|
|
11
|
+
|
|
12
|
+
组合 work——grilling 访谈技术 + domain-modeling 领域建模规程,在无情盘问中打磨设计,同时持续写入 ADR.md、LOG.md 和 CONTEXT.md 三个领域文档。访谈负责深度提问与共识达成,领域建模负责在决策结晶的瞬间捕获术语、记录轨迹、筛选架构决策。
|
|
13
|
+
|
|
14
|
+
产物统一写入 `<Path>{roots.state}/specdev/changes/{change}/</Path>`,其中 `{change}` 为 `<YYYY-MM-DD>-<topic>` 格式。
|
|
15
|
+
|
|
16
|
+
## 流程
|
|
17
|
+
|
|
18
|
+
### 1. 启动变更
|
|
19
|
+
|
|
20
|
+
创建 `<Path>{roots.state}/specdev/changes/{change}/</Path>` 目录(`{change}` 为 `<YYYY-MM-DD>-<topic>` 格式),初始化三个空文件模板:
|
|
21
|
+
|
|
22
|
+
- `<Path>{roots.state}/specdev/changes/{change}/ADR.md</Path>` — 架构决策记录,仅含 `# 架构决策记录` 标题
|
|
23
|
+
- `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>` — 设计决策日志,含 `# 设计决策日志` 标题及维护规则说明
|
|
24
|
+
- `<Path>{roots.state}/specdev/changes/{change}/CONTEXT.md</Path>` — 领域词汇表,含 `# {主题} 领域词汇表` 标题及一两句描述
|
|
25
|
+
|
|
26
|
+
**完成标准**:变更目录 `<YYYY-MM-DD>-<topic>` 已创建,初始 ADR.md/LOG.md/CONTEXT.md 已就位。
|
|
27
|
+
|
|
28
|
+
### 2. 访谈
|
|
29
|
+
|
|
30
|
+
委托给 `<Path>{roots.workflows}/specdev/G-grill-with-docs/grilling-protocol.md</Path>`。一次一问,沿设计树逐分支推进,在用户确认共识之前不执行方案。访谈过程中随时更新 `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>`,记录每个确认、延后、替代的结论。
|
|
31
|
+
|
|
32
|
+
**完成标准**:访谈完成——一次一问,决策树已遍历,共识已达成。LOG.md 已同步所有访谈结论。
|
|
33
|
+
|
|
34
|
+
### 3. 捕获文档
|
|
35
|
+
|
|
36
|
+
委托给 `<Path>{roots.workflows}/specdev/G-grill-with-docs/domain-modeling-rules.md</Path>`。对照词汇表挑战术语、精炼模糊语言、讨论具体场景、与代码交叉引用。
|
|
37
|
+
|
|
38
|
+
- `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>` 同步所有结论
|
|
39
|
+
- `<Path>{roots.state}/specdev/changes/{change}/CONTEXT.md</Path>` 精炼术语定义
|
|
40
|
+
- `<Path>{roots.state}/specdev/changes/{change}/ADR.md</Path>` 仅追加满足三条件的架构决策(参见 `<Path>{roots.workflows}/specdev/G-grill-with-docs/adr-format.md</Path>`)
|
|
41
|
+
|
|
42
|
+
**完成标准**:LOG.md 已同步所有结论;CONTEXT.md 已精炼术语;ADR.md 已追加满足三条件的架构决策。
|
|
43
|
+
|
|
44
|
+
## 子文件引用
|
|
45
|
+
|
|
46
|
+
本入口及以下子文件按需加载:
|
|
47
|
+
|
|
48
|
+
| 文件 | 触发条件 |
|
|
49
|
+
|------|----------|
|
|
50
|
+
| `<Path>{roots.workflows}/specdev/G-grill-with-docs/grilling-protocol.md</Path>` | 进入步骤 2「访谈」时加载——包含完整访谈协议,一次一问、推荐答案、决策树遍历、LOG.md 同步规则 |
|
|
51
|
+
| `<Path>{roots.workflows}/specdev/G-grill-with-docs/domain-modeling-rules.md</Path>` | 进入步骤 3「捕获文档」时加载——包含三文件分工、对照词汇表挑战、精炼与交叉引用规程、同步规则 |
|
|
52
|
+
| `<Path>{roots.workflows}/specdev/G-grill-with-docs/adr-format.md</Path>` | 需要创建或修改 ADR 条目时加载——单一 ADR.md 文件格式、编号规则、三条件检查、可选元素 |
|
|
53
|
+
| `<Path>{roots.workflows}/specdev/G-grill-with-docs/context-format.md</Path>` | 需要增删改术语时加载——CONTEXT.md 结构、定义规则、增删改操作说明 |
|
|
54
|
+
| `<Path>{roots.workflows}/specdev/G-grill-with-docs/log-format.md</Path>` | 需要记录设计结论时加载——LOG.md 格式、状态标记、编号规则、追加与修订规程 |
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# ADR.md 格式
|
|
2
|
+
|
|
3
|
+
所有架构决策记录存放在变更目录的单一 `<Path>{roots.state}/specdev/changes/{change}/ADR.md</Path>` 文件中。不使用 `docs/adr/` 目录下的编号文件,所有决策在一个文件内按二级标题分段。
|
|
4
|
+
|
|
5
|
+
## 模板
|
|
6
|
+
|
|
7
|
+
```md
|
|
8
|
+
# 架构决策记录
|
|
9
|
+
|
|
10
|
+
## 0001: {决策的简短标题}
|
|
11
|
+
|
|
12
|
+
{1-3 句话:背景是什么,我们做了什么决策,以及为什么。}
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 0002: {另一决策标题}
|
|
17
|
+
|
|
18
|
+
{1-3 句话描述。}
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
每个决策是一个 `##` 二级标题,编号从 `0001` 开始顺序递增。决策之间用 `---` 分隔。
|
|
24
|
+
|
|
25
|
+
就这样。一个 ADR 条目可以就是一个段落。其价值在于记录*已经*做出了决策以及*为什么*——而不是填满各个部分。
|
|
26
|
+
|
|
27
|
+
## 追加新决策
|
|
28
|
+
|
|
29
|
+
1. 读取 `<Path>{roots.state}/specdev/changes/{change}/ADR.md</Path>`,找到最高现有编号
|
|
30
|
+
2. 编号加 1
|
|
31
|
+
3. 在文件末尾追加 `---` 分隔线和新条目
|
|
32
|
+
|
|
33
|
+
## 可选附加元素
|
|
34
|
+
|
|
35
|
+
仅当它们真正增加价值时才包含这些。大多数 ADR 不需要它们:
|
|
36
|
+
|
|
37
|
+
- **日期**——在标题行的 `{标题}` 后面加 `(YYYY-MM-DD)`
|
|
38
|
+
- **Status**——`**Status**: proposed | accepted | deprecated | superseded by ADR-NNNN`。当决策被重新审视时,直接修改状态标记
|
|
39
|
+
- **Considered Options**——仅当被拒绝的替代方案值得记住时
|
|
40
|
+
- **Consequences**——仅当需要指出非显而易见的下游影响时
|
|
41
|
+
|
|
42
|
+
### 带可选元素的示例
|
|
43
|
+
|
|
44
|
+
```md
|
|
45
|
+
## 0003: 写模型采用事件溯源(2025-03-15)
|
|
46
|
+
|
|
47
|
+
**Status**: accepted
|
|
48
|
+
|
|
49
|
+
Order 聚合需要完整的变更历史用于审计和补偿。我们选择事件溯源——
|
|
50
|
+
所有状态变更作为不可变事件存储,当前状态从中投影。
|
|
51
|
+
|
|
52
|
+
**Considered Options**:
|
|
53
|
+
- 事件溯源(已选)——天然审计日志,支持时间旅行调试
|
|
54
|
+
- CRUD + 审计表——更简单,但审计日志与业务逻辑解耦,容易不同步
|
|
55
|
+
- 仅 CRUD——无审计历史,不满足合规要求
|
|
56
|
+
|
|
57
|
+
**Consequences**:
|
|
58
|
+
- 写路径复杂度增加;读路径需要投影
|
|
59
|
+
- 事件 schema 演进需要显式版本策略
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## 修改已有决策
|
|
63
|
+
|
|
64
|
+
- **澄清或补充后果**——直接编辑条目正文
|
|
65
|
+
- **改变状态**——修改 `**Status**` 字段(如 accepted → deprecated)
|
|
66
|
+
- **废弃**——将状态改为 `deprecated`,如被新决策替代则加上 `superseded by ADR-NNNN`
|
|
67
|
+
- **不要删除**——即使决策被废弃,保留条目作为历史上下文
|
|
68
|
+
|
|
69
|
+
## 三条件检查
|
|
70
|
+
|
|
71
|
+
在创建 ADR 之前,确认以下三个条件同时为真:
|
|
72
|
+
|
|
73
|
+
1. **难以逆转**——以后改变主意的成本是实质性的。容易逆转的决策跳过——你反正会逆转的。
|
|
74
|
+
2. **没有上下文的话令人惊讶**——未来的读者会看着代码想"他们到底为什么这样做?"。不令人惊讶的决策没人会追问,不需要记录。
|
|
75
|
+
3. **真实权衡的结果**——确实存在替代方案,你基于特定原因选择了一个。没有真正的替代方案就没有可记录的,除了"我们做了显而易见的事"。
|
|
76
|
+
|
|
77
|
+
如果决策不满足全部三个条件,只记入 LOG.md,不追加 ADR。
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# CONTEXT.md 格式
|
|
2
|
+
|
|
3
|
+
领域词汇表存放在变更目录的 `<Path>{roots.state}/specdev/changes/{change}/CONTEXT.md</Path>` 中。它只包含精炼的规范术语定义,不包含实现细节、设计决策或草稿内容。
|
|
4
|
+
|
|
5
|
+
## 模板
|
|
6
|
+
|
|
7
|
+
```md
|
|
8
|
+
# {项目名称} 领域词汇表
|
|
9
|
+
|
|
10
|
+
{对该上下文是什么以及为什么存在的一两句话描述。}
|
|
11
|
+
|
|
12
|
+
## {术语分组}
|
|
13
|
+
|
|
14
|
+
**Order**:
|
|
15
|
+
{对该术语的一两句话描述}
|
|
16
|
+
_Avoid_: Purchase, transaction
|
|
17
|
+
|
|
18
|
+
**Invoice**:
|
|
19
|
+
发货后发送给客户的付款请求。
|
|
20
|
+
_Avoid_: Bill, payment request
|
|
21
|
+
|
|
22
|
+
**Customer**:
|
|
23
|
+
下订单的个人或组织。
|
|
24
|
+
_Avoid_: Client, buyer, account
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 规则
|
|
28
|
+
|
|
29
|
+
- **要有主见。** 当同一概念存在多个词时,选择最好的那个,并将其他的列在 `_Avoid_` 下。不要犹豫——明确选定一个规范术语。
|
|
30
|
+
- **定义保持精炼。** 最多一两句话。定义它是什么,而不是它做什么。术语的定义描述概念的本质,而非其行为或实现。
|
|
31
|
+
- **仅包含特定于该项目上下文的术语。** 通用的编程概念(超时、错误类型、工具模式)即使项目广泛使用也不属于这里。添加术语前自问:这是该上下文独有的概念,还是一个通用编程概念?只有前者才属于这里。
|
|
32
|
+
- **当自然形成聚类时,用子标题分组术语。** 如果所有术语属于一个单一的凝聚领域,扁平列表也可以。当术语数量超过 10 个时,几乎总能找到自然分组。
|
|
33
|
+
- **随时增删改。** 模型演进时,直接修改文件:添加新术语、删除废弃术语、修正定义、术语更名。不要堆积——保持词汇表精炼且反映当前模型。
|
|
34
|
+
|
|
35
|
+
## 增删改操作
|
|
36
|
+
|
|
37
|
+
### 新增术语
|
|
38
|
+
|
|
39
|
+
在合适的子标题下追加条目。如果现有子标题都不匹配,新建一个子标题。格式:
|
|
40
|
+
|
|
41
|
+
```md
|
|
42
|
+
**{术语名}**:
|
|
43
|
+
{定义}
|
|
44
|
+
_Avoid_: {避免使用的同义词,用逗号分隔}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 修改术语
|
|
48
|
+
|
|
49
|
+
直接更新定义文本和 `_Avoid_` 列表。如果术语的含义已经变化,更新定义以反映当前理解。在 `_Avoid_` 中添加新出现的同义词,移除不再使用的同义词。
|
|
50
|
+
|
|
51
|
+
### 删除术语
|
|
52
|
+
|
|
53
|
+
移除整个条目(术语名、定义、`_Avoid_` 行)。如果术语已不再使用或已被其他术语替代,直接删除,不要保留废弃标记。词汇表只反映当前模型。
|
|
54
|
+
|
|
55
|
+
### 术语更名
|
|
56
|
+
|
|
57
|
+
删除旧条目,新增新条目。在 `_Avoid_` 中保留旧名称作为新术语的避免项——这样未来的读者能理解新旧术语的对应关系。例如,将 "Client" 更名为 "Customer":
|
|
58
|
+
|
|
59
|
+
```md
|
|
60
|
+
**Customer**:
|
|
61
|
+
下订单的个人或组织。
|
|
62
|
+
_Avoid_: Client, buyer, account
|
|
63
|
+
```
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# 领域建模规程
|
|
2
|
+
|
|
3
|
+
在设计过程中积极构建和精炼项目的领域模型。这是*主动*规程——挑战术语、发明边界场景、并在决策结晶的那一刻立即写入词汇表和决策。仅仅*阅读*文档获取词汇不是本规程——本规程用于当你正在*改变*模型,而不仅仅是消费它时。
|
|
4
|
+
|
|
5
|
+
## 三文件分工
|
|
6
|
+
|
|
7
|
+
三个文件各司其职,三者关系为:LOG.md 是最完整的记录 → CONTEXT.md 从中提取术语定义 → ADR.md 从中筛选同时满足三个条件的架构决策。
|
|
8
|
+
|
|
9
|
+
| 文件 | 职责 | 维护方式 |
|
|
10
|
+
|------|------|----------|
|
|
11
|
+
| `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>` | 完整设计轨迹——所有确认、延后、被替代的结论 | 持续增删改,条目可被后续决定修订 |
|
|
12
|
+
| `<Path>{roots.state}/specdev/changes/{change}/CONTEXT.md</Path>` | 精炼的规范词汇表——只保留当前有效的术语 | 增删改,保持精炼 |
|
|
13
|
+
| `<Path>{roots.state}/specdev/changes/{change}/ADR.md</Path>` | 难以逆转、令人意外、存在真实权衡的架构决策 | 只追加不删除,可标记废弃 |
|
|
14
|
+
|
|
15
|
+
## 对照词汇表挑战
|
|
16
|
+
|
|
17
|
+
当用户使用的术语与 `CONTEXT.md` 中的现有语言冲突时,立即指出。"你的词汇表将 'cancellation' 定义为 X,但你似乎指的是 Y——到底是哪个?"如果用户确认应修改词汇表,更新 `CONTEXT.md` 中的定义并追加日志。
|
|
18
|
+
|
|
19
|
+
## 精炼模糊语言
|
|
20
|
+
|
|
21
|
+
当用户使用含糊或重载的术语时,提出一个精确的规范术语。"你在说 'account'——你指的是 Customer 还是 User?它们是不同的东西。"在 `CONTEXT.md` 中为新术语添加条目,将模糊的同义词列入 `_Avoid_`。
|
|
22
|
+
|
|
23
|
+
## 讨论具体场景
|
|
24
|
+
|
|
25
|
+
当讨论领域关系时,用具体场景进行压力测试。发明探索边界情况的场景,迫使用户精确界定概念之间的边界。"你说订单可以部分取消——未取消的商品怎么办?它们还能发货吗?"
|
|
26
|
+
|
|
27
|
+
## 与代码交叉引用
|
|
28
|
+
|
|
29
|
+
当用户陈述某事如何工作时,检查代码是否一致。如果发现矛盾,指出来:"你的代码取消的是整个 Order,但你刚才说部分取消是可能的——哪个是正确的?"在日志中记录这种矛盾的发现和解决过程。
|
|
30
|
+
|
|
31
|
+
## 及时更新 LOG.md
|
|
32
|
+
|
|
33
|
+
当设计问答中形成任何结论时,当场更新 `LOG.md`。它是完整的设计轨迹——记录"当时讨论了什么、最终固定了什么行为以及对应哪个 ADR"。不要批量处理——发生时立即捕获。具体格式参见 `<Path>{roots.workflows}/specdev/G-grill-with-docs/log-format.md</Path>`。
|
|
34
|
+
|
|
35
|
+
### 日志条目格式
|
|
36
|
+
|
|
37
|
+
每条日志使用 `## LOG-XXXX: {标题}` 二级标题,编号从 `0001` 开始顺序递增。每个条目包含:
|
|
38
|
+
|
|
39
|
+
- **Status** — `accepted`(已确认)、`deferred`(暂不决定)、`superseded`(被后续决定替代)
|
|
40
|
+
- **Superseded by** — 如状态为 `superseded`,标注替代它的日志编号
|
|
41
|
+
- **Related** — 如该结论对应某个 ADR,标注 `Related: ADR-XXXX`
|
|
42
|
+
- **正文** — 背景、讨论的问题、做出的决定及原因,可以记录具体场景和交互细节
|
|
43
|
+
|
|
44
|
+
### 维护规则
|
|
45
|
+
|
|
46
|
+
- 每次完成设计问答,同步更新 `LOG.md`、`CONTEXT.md` 与 `ADR.md`。
|
|
47
|
+
- 后续确认改变既有结论时,直接修订原日志条目,并记录替代关系,不保留互相矛盾的"现行规则"。
|
|
48
|
+
- 日志可以记录具体交互和边界场景;词汇表保持精炼;ADR 只记录难以逆转、令人意外且存在真实权衡的决定。
|
|
49
|
+
- 每个日志条目应关联对应的 ADR(如有):`Related: ADR-XXXX`。
|
|
50
|
+
- 状态为 `deferred` 的条目保留,以便后续恢复讨论时知道从什么问题开始。
|
|
51
|
+
|
|
52
|
+
## 及时更新 CONTEXT.md
|
|
53
|
+
|
|
54
|
+
当术语确定时,当场更新 `CONTEXT.md`。不要批量处理——发生时立即捕获。具体格式参见 `<Path>{roots.workflows}/specdev/G-grill-with-docs/context-format.md</Path>`。
|
|
55
|
+
|
|
56
|
+
`CONTEXT.md` 应该完全不包含实现细节。不要将 `CONTEXT.md` 当作规范、草稿纸或实现决策的仓库。它只是词汇表,别无其他。
|
|
57
|
+
|
|
58
|
+
- **新增术语**:在合适的子标题下追加条目。
|
|
59
|
+
- **修改术语**:直接更新定义文本和 `_Avoid_` 列表。
|
|
60
|
+
- **删除术语**:移除整个条目。
|
|
61
|
+
- **术语更名**:删除旧条目,新增新条目。
|
|
62
|
+
|
|
63
|
+
## 谨慎更新 ADR.md
|
|
64
|
+
|
|
65
|
+
仅在以下三个条件全部满足时才向 `ADR.md` 追加一条决策记录:
|
|
66
|
+
|
|
67
|
+
1. **难以逆转**——以后改变主意的成本是有意义的
|
|
68
|
+
2. **没有上下文会令人惊讶**——未来的读者会疑惑"他们为什么这样做?"
|
|
69
|
+
3. **真实权衡的结果**——存在真正的替代方案,你出于特定原因选择了一个
|
|
70
|
+
|
|
71
|
+
如果缺少任何一个条件,跳过 ADR。具体格式参见 `<Path>{roots.workflows}/specdev/G-grill-with-docs/adr-format.md</Path>`。
|
|
72
|
+
|
|
73
|
+
`ADR.md` 中每个决策是一个 `## NNNN: {标题}` 二级标题,编号顺序递增,条目之间用 `---` 分隔。可以修改已有条目、标记废弃——但不要删除。
|
|
74
|
+
|
|
75
|
+
## 什么算 ADR
|
|
76
|
+
|
|
77
|
+
- **架构形态。** "我们使用 monorepo。" "写模型采用事件溯源,读模型投影到 Postgres。"
|
|
78
|
+
- **上下文间的集成模式。** "Ordering 和 Billing 通过领域事件通信,而非同步 HTTP。"
|
|
79
|
+
- **带来锁定效应的技术选择。** 数据库、消息总线、认证提供商、部署目标。不是每个库——只是那些需要花一个季度才能替换的。
|
|
80
|
+
- **边界和范围决策。** "客户数据由 Customer 上下文拥有;其他上下文仅通过 ID 引用它。"明确的"不做"和"要做"同样有价值。
|
|
81
|
+
- **有意偏离显而易见路径的决策。** "我们使用手动 SQL 而不是 ORM,因为 X。"任何合理读者会假设相反的情况。
|
|
82
|
+
- **代码中不可见的约束。** "由于合规要求,我们不能使用 AWS。" "由于合作伙伴 API 合同,响应时间必须低于 200ms。"
|
|
83
|
+
- **拒绝的原因不明显的被拒绝替代方案。** 如果你考虑了 GraphQL 而因微妙原因选择了 REST,记录下来——否则 6 个月后有人会再次建议 GraphQL。
|
|
84
|
+
|
|
85
|
+
## 三文件同步规则
|
|
86
|
+
|
|
87
|
+
访谈中每完成一轮设计问答,按以下顺序同步三个文件:
|
|
88
|
+
|
|
89
|
+
1. **LOG.md** 先更新——立即追加日志条目,记录本次讨论的结论
|
|
90
|
+
2. **CONTEXT.md** 随后更新——从日志中提取新术语或修正的术语定义
|
|
91
|
+
3. **ADR.md** 最后更新——检查是否需要满足三条件追加 ADC(架构决策记录)
|
|
92
|
+
|
|
93
|
+
如果 CONTEXT 或 ADR 的更新来自日志条目,在日志中补充 `Related: ADR-XXXX` 的关联标注。
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# 访谈协议
|
|
2
|
+
|
|
3
|
+
请对我进行无情的面试,深入探讨该方案的每一个方面,直到我们达成共识。沿设计树的每个分支逐步推进,逐个解决决策之间的依赖关系。每个问题都给出你的推荐答案。
|
|
4
|
+
|
|
5
|
+
## 核心规则
|
|
6
|
+
|
|
7
|
+
### 一次只问一个问题
|
|
8
|
+
|
|
9
|
+
等待我对每个问题给出反馈后再继续。一次问多个问题会让人困惑,也会让讨论失去焦点。每个问题的回答会自然引出下一个分支的追问,不要跳跃。
|
|
10
|
+
|
|
11
|
+
### 每个问题给出推荐答案
|
|
12
|
+
|
|
13
|
+
不要只抛出问题。基于你的分析,给出你认为最好的答案,并解释为什么。然后让我确认、反驳或修正。推荐答案让讨论有锚点——我可以直接同意、微调、或推翻重来,而不是从白纸开始。
|
|
14
|
+
|
|
15
|
+
### 事实自己查,决策问用户
|
|
16
|
+
|
|
17
|
+
如果某个*事实*可以通过探索代码库找到,请自行查找,不要来问我。包括:现有实现方式、类型定义、数据流、命名约定、文件结构。但*决策*由我来做——将每个决策提交给我并等待我的回答。事实和决策的边界:事实是关于"现在是什么",决策是关于"应该是什么"。
|
|
18
|
+
|
|
19
|
+
### 沿设计树逐分支推进
|
|
20
|
+
|
|
21
|
+
不要跳跃。如果一个决策依赖另一个决策,先解决被依赖的那个。识别出依赖关系并告诉我:"我们需要先决定 X,因为 Y 的选择取决于 X 的结论。"设计树的典型分支顺序:
|
|
22
|
+
|
|
23
|
+
1. **核心概念** — 领域的实体、值对象、聚合根是什么?
|
|
24
|
+
2. **边界与关系** — 概念之间的边界在哪里?它们如何关联?
|
|
25
|
+
3. **行为与规则** — 每个概念能做什么?有什么约束?
|
|
26
|
+
4. **实现映射** — 概念如何映射到代码结构、数据模型、接口?
|
|
27
|
+
5. **边界场景** — 极端情况和异常如何处理?
|
|
28
|
+
|
|
29
|
+
### 共识之前不执行
|
|
30
|
+
|
|
31
|
+
在我确认我们已达成共识之前,不要执行该方案。即使讨论看起来已经穷尽,也要明确询问:"我们是否已就该设计达成共识?"只有在得到肯定回答后才进入下一阶段。
|
|
32
|
+
|
|
33
|
+
## 访谈中维护 LOG.md
|
|
34
|
+
|
|
35
|
+
在访谈过程中,每当一个结论被确认、延后或被替代时,当场更新 `<Path>{roots.state}/specdev/changes/{change}/LOG.md</Path>`。不要等访谈结束再批量写入——发生时立即捕获。具体格式参见 `<Path>{roots.workflows}/specdev/G-grill-with-docs/log-format.md</Path>`。
|
|
36
|
+
|
|
37
|
+
写入 LOG.md 的时机:
|
|
38
|
+
|
|
39
|
+
- **结论被确认** — 用户明确同意某个设计决定时,立即追加一条 `accepted` 日志
|
|
40
|
+
- **决定被延后** — 用户说"先不定"或"后面再讨论"时,追加一条 `deferred` 日志,记录为什么暂不决定以及从什么角度恢复讨论
|
|
41
|
+
- **结论被替代** — 后续讨论推翻了之前的决定时,将原条目状态改为 `superseded`,标注 `Superseded by: LOG-XXXX`,再新建替代条目
|
|
42
|
+
|
|
43
|
+
## 访谈节奏
|
|
44
|
+
|
|
45
|
+
- **开场**:先理解用户想打磨的方案是什么。问清楚范围和目标,然后开始沿设计树推进。
|
|
46
|
+
- **推进**:每个回答后,识别下一个最关键的未解决问题。优先解决会阻塞其他决策的问题。
|
|
47
|
+
- **收束**:当设计树的主要分支都已遍历、且用户确认共识时,访谈结束。不要无限追问无关细节。
|
|
48
|
+
|
|
49
|
+
## 好的访谈问题范例
|
|
50
|
+
|
|
51
|
+
- "你把 X 称为 'account'——你指的是 Customer 还是 User?它们在代码中是不同的概念。我建议用 Customer,因为它更精确地描述了购买关系。"
|
|
52
|
+
- "你提到订单可以部分取消。未取消的商品怎么办——它们还能发货吗?我建议将它们标记为可发货状态,因为取消是针对商品行而非整个订单。"
|
|
53
|
+
- "你打算用事件溯源还是 CRUD?考虑到审计需求,我推荐事件溯源——虽然写路径更复杂,但天然支持完整审计日志。"
|
|
54
|
+
- "Ordering 和 Billing 之间你选择了同步 HTTP 调用。这意味着 Billing 挂了订单也创建不了。你确定要这种耦合?我建议用异步领域事件——订单创建后发出事件,Billing 异步消费。"
|