dev-playbooks-cn 1.0.7 → 1.0.10

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.
Files changed (32) hide show
  1. package/bin/devbooks.js +14 -72
  2. package/package.json +1 -1
  3. package/templates/dev-playbooks/README.md +69 -109
  4. package/templates/dev-playbooks/docs/DevBooks/351/205/215/347/275/256/346/214/207/345/215/227.md +204 -0
  5. package/templates/dev-playbooks/docs/workflow-diagram.svg +203 -0
  6. package/templates/claude-commands/devbooks/apply.md +0 -38
  7. package/templates/claude-commands/devbooks/archive.md +0 -33
  8. package/templates/claude-commands/devbooks/backport.md +0 -19
  9. package/templates/claude-commands/devbooks/bootstrap.md +0 -19
  10. package/templates/claude-commands/devbooks/c4.md +0 -19
  11. package/templates/claude-commands/devbooks/challenger.md +0 -19
  12. package/templates/claude-commands/devbooks/code.md +0 -19
  13. package/templates/claude-commands/devbooks/debate.md +0 -19
  14. package/templates/claude-commands/devbooks/delivery.md +0 -19
  15. package/templates/claude-commands/devbooks/design.md +0 -19
  16. package/templates/claude-commands/devbooks/entropy.md +0 -19
  17. package/templates/claude-commands/devbooks/federation.md +0 -19
  18. package/templates/claude-commands/devbooks/gardener.md +0 -19
  19. package/templates/claude-commands/devbooks/impact.md +0 -19
  20. package/templates/claude-commands/devbooks/index.md +0 -19
  21. package/templates/claude-commands/devbooks/judge.md +0 -19
  22. package/templates/claude-commands/devbooks/plan.md +0 -19
  23. package/templates/claude-commands/devbooks/proposal.md +0 -19
  24. package/templates/claude-commands/devbooks/quick.md +0 -42
  25. package/templates/claude-commands/devbooks/review.md +0 -19
  26. package/templates/claude-commands/devbooks/router.md +0 -19
  27. package/templates/claude-commands/devbooks/spec.md +0 -19
  28. package/templates/claude-commands/devbooks/test-review.md +0 -19
  29. package/templates/claude-commands/devbooks/test.md +0 -19
  30. package/templates/dev-playbooks/docs/DevBooks/345/256/211/350/243/205/346/217/220/347/244/272/350/257/215.md +0 -42
  31. package/templates/dev-playbooks/docs/DevBooks/351/233/206/346/210/220/346/250/241/346/235/277/357/274/210/345/215/217/350/256/256/346/227/240/345/205/263/357/274/211.md +0 -120
  32. package/templates/dev-playbooks/docs/Slash /345/221/275/344/273/244/344/275/277/347/224/250/346/214/207/345/215/227.md" +0 -485
@@ -1,485 +0,0 @@
1
- # DevBooks Slash 命令使用指南
2
-
3
- 本指南按变更闭环的阶段顺序,说明每个 Slash 命令的使用时机。
4
-
5
- > **MCP 自动检测**:每个 Skill 执行时自动检测 MCP 可用性(2s 超时),无需手动选择"基础"或"增强"模式。
6
-
7
- ---
8
-
9
- ## 阶段概览
10
-
11
- | 阶段 | 核心命令 | 说明 |
12
- |------|----------|------|
13
- | **Proposal** | proposal → impact → challenger/judge → design → spec → c4 → plan | 禁止写代码 |
14
- | **Apply** | test → code → backport(如需) | 强制角色隔离 |
15
- | **Review** | review → test-review | 审查代码与测试 |
16
- | **Archive** | backport → spec → c4 → gardener | 合并到真理源 |
17
- | **独立** | router / bootstrap / entropy / federation / index | 不属于单次变更 |
18
-
19
- ---
20
-
21
- ## Proposal(提案阶段)
22
-
23
- > **核心原则**:禁止写实现代码,只产出设计文档
24
-
25
- ### 1. `/devbooks:proposal` - 创建变更提案(必做)
26
-
27
- **使用时机**:每次变更的起点
28
-
29
- ```
30
- /devbooks:proposal <你的需求>
31
- ```
32
-
33
- **产物**:`<change-root>/<change-id>/proposal.md`
34
-
35
- **包含内容**:
36
- - Why(为什么要改)
37
- - What(改什么)
38
- - Impact(影响范围)
39
- - Debate Packet(风险/替代方案/约束)
40
-
41
- ---
42
-
43
- ### 2. `/devbooks:impact` - 影响分析(跨模块/影响不清晰时必做)
44
-
45
- **使用时机**:
46
- - 变更涉及多个模块
47
- - 不确定受影响范围
48
- - 可能破坏兼容性
49
-
50
- ```
51
- /devbooks:impact <change-id>
52
- ```
53
-
54
- **产物**:更新 `proposal.md` 的 Impact 部分
55
-
56
- **MCP 增强**:
57
- - CKB 可用:使用 `analyzeImpact`、`getCallGraph`、`findReferences`
58
- - CKB 不可用:降级为 Grep + Glob 文本搜索
59
-
60
- ---
61
-
62
- ### 3. `/devbooks:challenger` - 提案质疑(有争议/风险高时)
63
-
64
- **使用时机**:
65
- - 风险高、争议大
66
- - 需要强约束审查
67
- - 建议在新对话中执行(角色隔离)
68
-
69
- ```
70
- /devbooks:challenger <change-id>
71
- ```
72
-
73
- **产物**:质疑报告(结论必须为 `Approve | Revise | Reject`)
74
-
75
- ---
76
-
77
- ### 4. `/devbooks:judge` - 提案裁决(做了 Challenger 就必须)
78
-
79
- **使用时机**:
80
- - 有 Challenger 报告,需要最终裁决
81
- - 建议在新对话中执行(角色隔离)
82
-
83
- ```
84
- /devbooks:judge <change-id>
85
- ```
86
-
87
- **产物**:更新 `proposal.md` 的 Decision Log(`Approved | Revise | Rejected`,禁止 Pending)
88
-
89
- ---
90
-
91
- ### 5. `/devbooks:debate` - 三角对辩流程(风险高/争议大时)
92
-
93
- **使用时机**:
94
- - 替代单独调用 challenger + judge
95
- - 自动编排 Author → Challenger → Judge 流程
96
-
97
- ```
98
- /devbooks:debate <change-id>
99
- ```
100
-
101
- **产物**:
102
- - 质疑报告
103
- - 裁决结果
104
- - 更新后的 `proposal.md`
105
-
106
- ---
107
-
108
- ### 6. `/devbooks:design` - 设计文档(非小改动建议做)
109
-
110
- **使用时机**:
111
- - 非 bug fix 或单行修改
112
- - 需要明确约束、验收口径
113
-
114
- ```
115
- /devbooks:design <change-id>
116
- ```
117
-
118
- **产物**:`<change-root>/<change-id>/design.md`
119
-
120
- **包含内容**:
121
- - What(具体设计)
122
- - Constraints(约束与边界)
123
- - AC-xxx(验收标准)
124
- - **禁止**写实现步骤
125
-
126
- ---
127
-
128
- ### 7. `/devbooks:spec` - 规格与契约(对外行为/契约变化时)
129
-
130
- **使用时机**:
131
- - 对外 API 变更
132
- - 数据契约/Schema 变更
133
- - 需要兼容策略
134
-
135
- ```
136
- /devbooks:spec <change-id>
137
- ```
138
-
139
- **产物**:
140
- - `<change-root>/<change-id>/specs/<capability>/spec.md`(Requirements/Scenarios)
141
- - 更新 `design.md` 的 Contract 章节
142
-
143
- ---
144
-
145
- ### 8. `/devbooks:c4` - C4 架构地图(边界/依赖变化时)
146
-
147
- **使用时机**:
148
- - 模块边界变化
149
- - 依赖方向变化
150
- - 新增/移除组件
151
-
152
- ```
153
- /devbooks:c4 <change-id>
154
- ```
155
-
156
- **Proposal 阶段行为**:
157
- - **不修改**当前真理 `<truth-root>/architecture/c4.md`
158
- - 输出 C4 Delta 到 `design.md`
159
-
160
- ---
161
-
162
- ### 9. `/devbooks:plan` - 实现计划(必做)
163
-
164
- **使用时机**:
165
- - 在 design.md 完成后
166
- - Proposal 阶段的最后一步
167
-
168
- ```
169
- /devbooks:plan <change-id>
170
- ```
171
-
172
- **产物**:`<change-root>/<change-id>/tasks.md`
173
-
174
- **包含内容**:
175
- - 主线计划(Main Path)
176
- - 临时计划(Temp Path,如有)
177
- - 断点区(Breakpoint Zone)
178
- - 每个任务的验收锚点
179
-
180
- ---
181
-
182
- ## Apply(实现阶段)
183
-
184
- > **核心原则**:Test Owner 与 Coder 必须独立对话/独立实例
185
-
186
- ### 1. `/devbooks:test` - Test Owner(必做,必须新对话)
187
-
188
- **使用时机**:
189
- - Apply 阶段的第一步
190
- - 必须先于 Coder 执行
191
-
192
- ```
193
- /devbooks:test <change-id>
194
- ```
195
-
196
- **角色约束**:
197
- - 只读:`proposal.md`、`design.md`、`specs/**`
198
- - 禁止参考:`tasks.md`
199
-
200
- **产物**:
201
- - `<change-root>/<change-id>/verification.md`(追溯矩阵)
202
- - `tests/**`
203
- - `evidence/` 下的失败证据
204
-
205
- **要求**:必须先跑出 **Red** 基线
206
-
207
- ---
208
-
209
- ### 2. `/devbooks:code` - Coder(必做,必须新对话)
210
-
211
- **使用时机**:
212
- - Test Owner 完成后
213
- - 必须在独立对话中执行
214
-
215
- ```
216
- /devbooks:code <change-id>
217
- ```
218
-
219
- **角色约束**:
220
- - 严格按 `tasks.md` 实现
221
- - **禁止**修改 `tests/**`
222
- - 如需改测试,交还 Test Owner
223
-
224
- **完成判据**:tests/静态检查/build 全绿
225
-
226
- **MCP 增强**:
227
- - CKB 可用:输出热点检查报告
228
- - 热点 Top 5:先重构再修改
229
-
230
- ---
231
-
232
- ### 3. `/devbooks:backport` - 设计回写(发现设计缺口/冲突时)
233
-
234
- **使用时机**:
235
- - 实现中发现设计遗漏
236
- - 需要上升到设计层的决策
237
-
238
- ```
239
- /devbooks:backport <change-id>
240
- ```
241
-
242
- **产物**:更新 `design.md`
243
-
244
- **后续动作**:
245
- - 重跑 Planner(更新 tasks.md)
246
- - Test Owner 重新确认/补测试
247
-
248
- ---
249
-
250
- ## Review(评审阶段)
251
-
252
- ### 1. `/devbooks:review` - 代码评审(必做)
253
-
254
- **使用时机**:
255
- - Apply 阶段完成后
256
- - PR 合并前
257
-
258
- ```
259
- /devbooks:review <change-id>
260
- ```
261
-
262
- **审查内容**:
263
- - 可读性
264
- - 依赖方向
265
- - 一致性
266
- - 复杂度
267
- - 坏味道
268
-
269
- **不讨论**:业务正确性
270
-
271
- **MCP 增强**:
272
- - CKB 可用:热点优先审查(Top 5 深度审查)
273
-
274
- ---
275
-
276
- ### 2. `/devbooks:test-review` - 测试评审(可选)
277
-
278
- **使用时机**:
279
- - 测试质量需特别关注
280
- - 覆盖率/边界条件需审查
281
-
282
- ```
283
- /devbooks:test-review <change-id>
284
- ```
285
-
286
- **审查内容**:
287
- - 测试覆盖率
288
- - 边界条件
289
- - 与 `verification.md` 的一致性
290
-
291
- ---
292
-
293
- ## Archive(归档阶段)
294
-
295
- ### 1. `/devbooks:backport` - 补齐遗漏决策
296
-
297
- **使用时机**:归档前发现未记录的设计决策
298
-
299
- ---
300
-
301
- ### 2. `/devbooks:spec` - 落到真理源
302
-
303
- **使用时机**:归档前需要把规格/契约更新到 `<truth-root>`
304
-
305
- ---
306
-
307
- ### 3. `/devbooks:c4` - 落到真理源
308
-
309
- **使用时机**:归档前更新/校验 `<truth-root>/architecture/c4.md`
310
-
311
- **Archive 阶段行为**:更新当前真理(而非只写 Delta)
312
-
313
- ---
314
-
315
- ### 4. `/devbooks:gardener` - 规格园丁(有 spec deltas 时)
316
-
317
- **使用时机**:
318
- - 本次变更产生了 spec deltas
319
- - 需要合并到真理源
320
-
321
- ```
322
- /devbooks:gardener <change-id>
323
- ```
324
-
325
- **操作**:
326
- - 去重/合并/归类/删除过时
327
- - 只修改 `<truth-root>/**`
328
- - 不修改 change 包内容
329
-
330
- ---
331
-
332
- ## 独立命令(不属于单次变更阶段)
333
-
334
- ### `/devbooks:router` - 路由建议(不确定下一步时)
335
-
336
- **使用时机**:
337
- - 不确定当前属于哪个阶段
338
- - 需要 AI 给出最短闭环建议
339
-
340
- ```
341
- /devbooks:router <你的需求>
342
- ```
343
-
344
- ---
345
-
346
- ### `/devbooks:bootstrap` - 存量项目初始化
347
-
348
- **使用时机**:
349
- - `<truth-root>` 为空
350
- - 老项目首次接入 DevBooks
351
-
352
- ```
353
- /devbooks:bootstrap
354
- ```
355
-
356
- **产物**:
357
- - 项目画像
358
- - 术语表(可选)
359
- - 基线规格
360
- - 最小验证锚点
361
-
362
- ---
363
-
364
- ### `/devbooks:entropy` - 熵度量(定期体检)
365
-
366
- **使用时机**:
367
- - 定期代码健康检查
368
- - 重构前获取量化数据
369
-
370
- ```
371
- /devbooks:entropy
372
- ```
373
-
374
- **产物**:熵度量报告(结构熵/变更熵/测试熵/依赖熵)
375
-
376
- ---
377
-
378
- ### `/devbooks:federation` - 跨仓库联邦分析
379
-
380
- **使用时机**:
381
- - 变更涉及对外 API/契约
382
- - 多仓库项目需要分析下游影响
383
-
384
- ```
385
- /devbooks:federation
386
- ```
387
-
388
- **前置条件**:项目根目录存在 `.devbooks/federation.yaml`
389
-
390
- ---
391
-
392
- ### `/devbooks:index` - 索引引导
393
-
394
- **使用时机**:
395
- - `mcp__ckb__getStatus` 显示 SCIP 后端不可用
396
- - 需要激活图基代码理解能力
397
-
398
- ```
399
- /devbooks:index
400
- ```
401
-
402
- **产物**:SCIP 索引文件
403
-
404
- ---
405
-
406
- ## 典型流程示例
407
-
408
- ### 小型变更(bug fix)
409
-
410
- ```
411
- 1. /devbooks:proposal <bug 描述>
412
- 2. /devbooks:plan <change-id>
413
- 3. /devbooks:test <change-id> # 新对话
414
- 4. /devbooks:code <change-id> # 新对话
415
- 5. /devbooks:review <change-id>
416
- 6. /devbooks:gardener <change-id>
417
- ```
418
-
419
- ### 中型变更(新功能)
420
-
421
- ```
422
- 1. /devbooks:proposal <功能需求>
423
- 2. /devbooks:impact <change-id> # 跨模块时
424
- 3. /devbooks:design <change-id>
425
- 4. /devbooks:spec <change-id> # 有契约变化时
426
- 5. /devbooks:plan <change-id>
427
- 6. /devbooks:test <change-id> # 新对话
428
- 7. /devbooks:code <change-id> # 新对话
429
- 8. /devbooks:review <change-id>
430
- 9. /devbooks:gardener <change-id>
431
- ```
432
-
433
- ### 大型/高风险变更
434
-
435
- ```
436
- 1. /devbooks:proposal <需求>
437
- 2. /devbooks:impact <change-id>
438
- 3. /devbooks:debate <change-id> # 三角对辩
439
- 4. /devbooks:design <change-id>
440
- 5. /devbooks:spec <change-id>
441
- 6. /devbooks:c4 <change-id> # 架构变化时
442
- 7. /devbooks:plan <change-id>
443
- 8. /devbooks:test <change-id> # 新对话
444
- 9. /devbooks:code <change-id> # 新对话
445
- 10. /devbooks:review <change-id>
446
- 11. /devbooks:gardener <change-id>
447
- ```
448
-
449
- ---
450
-
451
- ## 命令总览(24 个)
452
-
453
- ### 核心命令(21 个)
454
-
455
- | 阶段 | 命令 | 对应 Skill |
456
- |------|------|-----------|
457
- | Proposal | `/devbooks:proposal` | `devbooks-proposal-author` |
458
- | | `/devbooks:impact` | `devbooks-impact-analysis` |
459
- | | `/devbooks:challenger` | `devbooks-proposal-challenger` |
460
- | | `/devbooks:judge` | `devbooks-proposal-judge` |
461
- | | `/devbooks:debate` | `devbooks-proposal-debate-workflow` |
462
- | | `/devbooks:design` | `devbooks-design-doc` |
463
- | | `/devbooks:spec` | `devbooks-spec-contract` |
464
- | | `/devbooks:c4` | `devbooks-c4-map` |
465
- | | `/devbooks:plan` | `devbooks-implementation-plan` |
466
- | Apply | `/devbooks:test` | `devbooks-test-owner` |
467
- | | `/devbooks:code` | `devbooks-coder` |
468
- | | `/devbooks:backport` | `devbooks-design-backport` |
469
- | Review | `/devbooks:review` | `devbooks-code-review` |
470
- | | `/devbooks:test-review` | `devbooks-test-reviewer` |
471
- | Archive | `/devbooks:gardener` | `devbooks-spec-gardener` |
472
- | | `/devbooks:delivery` | `devbooks-delivery-workflow` |
473
- | 独立 | `/devbooks:router` | `devbooks-router` |
474
- | | `/devbooks:bootstrap` | `devbooks-brownfield-bootstrap` |
475
- | | `/devbooks:entropy` | `devbooks-entropy-monitor` |
476
- | | `/devbooks:federation` | `devbooks-federation` |
477
- | | `/devbooks:index` | `devbooks-index-bootstrap` |
478
-
479
- ### 向后兼容命令(3 个)
480
-
481
- | 命令 | 等价于 |
482
- |------|--------|
483
- | `/devbooks:coder` | `/devbooks:code` |
484
- | `/devbooks:tester` | `/devbooks:test` |
485
- | `/devbooks:reviewer` | `/devbooks:review` |