dev-playbooks-cn 3.0.0 → 4.0.0

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 (115) hide show
  1. package/CHANGELOG.md +123 -26
  2. package/README.md +111 -163
  3. package/bin/devbooks +5 -0
  4. package/bin/{devbooks.js → devbooks.mjs} +46 -80
  5. package/docs/Skill/350/257/246/350/247/243.md +714 -0
  6. package/docs/ai-native-workflow.md +69 -0
  7. package/docs/gate-validation-cases.md +208 -0
  8. package/docs/workflow-diagram.svg +203 -0
  9. package/docs//344/275/277/347/224/250/346/214/207/345/215/227.md +616 -0
  10. package/package.json +3 -2
  11. package/scripts/config-discovery.sh +209 -24
  12. package/scripts/english-sync.sh +230 -0
  13. package/scripts/generate-protocol-v1.1-coverage-report.sh +34 -0
  14. package/scripts/intent-routing.sh +379 -0
  15. package/scripts/legacy/migrate-from-legacy.sh +77 -0
  16. package/scripts/legacy/migrate-from-openspec.sh +11 -0
  17. package/scripts/legacy/migrate-from-speckit.sh +11 -0
  18. package/scripts/platform-sync.sh +625 -0
  19. package/skills/Skills/344/275/277/347/224/250/350/257/264/346/230/216.md +83 -20
  20. package/skills/_shared/references//345/201/217/347/246/273/346/243/200/346/265/213/344/270/216/350/267/257/347/224/261/345/215/217/350/256/256.md +9 -7
  21. package/skills/_shared/references//345/256/214/345/244/207/346/200/247/346/200/235/347/273/264/346/241/206/346/236/266.md +84 -64
  22. package/skills/_shared//345/267/245/344/275/234/346/265/201/344/270/213/344/270/200/346/255/245.md +2 -1
  23. package/skills/devbooks-archiver/references//345/275/222/346/241/243/346/265/201/347/250/213/344/270/216/350/247/204/345/210/231.md +19 -6
  24. package/skills/devbooks-brownfield-bootstrap/SKILL.md +12 -0
  25. package/skills/devbooks-coder/references//345/256/214/346/210/220/347/212/266/346/200/201/344/270/216/350/267/257/347/224/261.md +3 -3
  26. package/skills/devbooks-delivery-workflow/SKILL.md +12 -8
  27. package/skills/devbooks-delivery-workflow/references//347/274/226/346/216/222/347/246/201/344/273/244/344/270/216/351/230/266/346/256/265/350/241/250.md +79 -61
  28. package/skills/devbooks-delivery-workflow/references//347/274/226/346/216/222/351/200/273/350/276/221/344/274/252/344/273/243/347/240/201.md +26 -98
  29. package/skills/devbooks-delivery-workflow/scripts/archive-decider.sh +1878 -0
  30. package/skills/devbooks-delivery-workflow/scripts/capability-registry-check.sh +321 -0
  31. package/skills/devbooks-delivery-workflow/scripts/change-check.sh +1475 -47
  32. package/skills/devbooks-delivery-workflow/scripts/change-metadata-check.sh +499 -0
  33. package/skills/devbooks-delivery-workflow/scripts/change-scaffold.sh +220 -11
  34. package/skills/devbooks-delivery-workflow/scripts/check-anti-weakening.sh +692 -0
  35. package/skills/devbooks-delivery-workflow/scripts/check-completion-contract.sh +526 -0
  36. package/skills/devbooks-delivery-workflow/scripts/check-evidence-freshness.sh +397 -0
  37. package/skills/devbooks-delivery-workflow/scripts/check-state-consistency.sh +370 -0
  38. package/skills/devbooks-delivery-workflow/scripts/check-upstream-claims.sh +278 -0
  39. package/skills/devbooks-delivery-workflow/scripts/docs-consistency-check.sh +399 -0
  40. package/skills/devbooks-delivery-workflow/scripts/epic-alignment-check.sh +359 -0
  41. package/skills/devbooks-delivery-workflow/scripts/extension-pack-integrity-check.sh +435 -0
  42. package/skills/devbooks-delivery-workflow/scripts/handoff-check.sh +150 -1
  43. package/skills/devbooks-delivery-workflow/scripts/icgc-compile.sh +345 -0
  44. package/skills/devbooks-delivery-workflow/scripts/knife-correctness-check.sh +661 -0
  45. package/skills/devbooks-delivery-workflow/scripts/knife-plan-check.sh +419 -0
  46. package/skills/devbooks-delivery-workflow/scripts/lib/upstream-claims.sh +715 -0
  47. package/skills/devbooks-delivery-workflow/scripts/protocol-coverage-report.sh +571 -0
  48. package/skills/devbooks-delivery-workflow/scripts/reference-integrity-check.sh +524 -0
  49. package/skills/devbooks-delivery-workflow/scripts/required-gates-check.sh +282 -0
  50. package/skills/devbooks-delivery-workflow/scripts/required-gates-derive.sh +437 -0
  51. package/skills/devbooks-delivery-workflow/scripts/requirements-ledger-derive.sh +278 -0
  52. package/skills/devbooks-delivery-workflow/scripts/risk-evidence-check.sh +393 -0
  53. package/skills/devbooks-delivery-workflow/scripts/runbook-derive.sh +479 -0
  54. package/skills/devbooks-delivery-workflow/scripts/ssot-scaffold.sh +198 -0
  55. package/skills/devbooks-delivery-workflow/scripts/state-audit-check.sh +378 -0
  56. package/skills/devbooks-delivery-workflow/scripts/verification-anchors-check.sh +328 -0
  57. package/skills/devbooks-delivery-workflow/scripts/verify-all.sh +42 -0
  58. package/skills/devbooks-delivery-workflow/scripts/verify-npm-package.sh +77 -0
  59. package/skills/devbooks-delivery-workflow/scripts/verify-openspec-free.sh +78 -0
  60. package/skills/devbooks-delivery-workflow/scripts/verify-slash-commands.sh +52 -0
  61. package/skills/devbooks-delivery-workflow/scripts/void-protocol-check.sh +283 -0
  62. package/skills/devbooks-delivery-workflow/templates//344/272/244/346/216/245/346/226/207/346/241/243.md +18 -2
  63. package/skills/devbooks-docs-consistency/SKILL.md +9 -0
  64. package/skills/devbooks-knife/SKILL.md +73 -0
  65. package/skills/devbooks-spec-contract/references//351/232/220/345/274/217/345/217/230/346/233/264/346/243/200/346/265/213/346/217/220/347/244/272/350/257/215.md +3 -3
  66. package/skills/devbooks-ssot-maintainer/SKILL.md +83 -0
  67. package/skills/devbooks-ssot-maintainer/scripts/lib/ssot-delta.sh +121 -0
  68. package/skills/devbooks-ssot-maintainer/scripts/ssot-delta-report.sh +129 -0
  69. package/skills/devbooks-ssot-maintainer/scripts/ssot-index-sync.sh +520 -0
  70. package/skills/devbooks-test-owner/SKILL.md +1 -1
  71. package/skills/devbooks-void/SKILL.md +40 -0
  72. package/templates/.devbooks/config.yaml +37 -0
  73. package/templates/.github/copilot-instructions.md +14 -0
  74. package/templates/AGENTS.md +52 -0
  75. package/templates/CLAUDE.md +28 -0
  76. package/templates/GEMINI.md +28 -0
  77. package/templates/claude-agents/devbooks-archiver.md +1 -1
  78. package/templates/claude-agents/devbooks-explorer.md +1 -1
  79. package/templates/claude-commands/devbooks/apply.md +2 -2
  80. package/templates/claude-commands/devbooks/archive.md +3 -3
  81. package/templates/claude-commands/devbooks/debate.md +2 -2
  82. package/templates/claude-commands/devbooks/delivery.md +15 -5
  83. package/templates/claude-commands/devbooks/gardener.md +7 -7
  84. package/templates/claude-commands/devbooks/index.md +3 -4
  85. package/templates/claude-commands/devbooks/knife.md +20 -0
  86. package/templates/cursor-rules/devbooks.mdc +11 -0
  87. package/templates/dev-playbooks/README.md +34 -56
  88. package/templates/dev-playbooks/changes/RUNBOOK.md +82 -22
  89. package/templates/dev-playbooks/changes/brief.md +3 -3
  90. package/templates/dev-playbooks/changes/completion.contract.yaml +84 -0
  91. package/templates/dev-playbooks/changes/compliance.md +2 -2
  92. package/templates/dev-playbooks/changes/inputs/index.md +21 -6
  93. package/templates/dev-playbooks/changes/proposal.md +67 -30
  94. package/templates/dev-playbooks/changes/prototype/README.md +4 -4
  95. package/templates/dev-playbooks/changes/rollback-plan.md +4 -4
  96. package/templates/dev-playbooks/changes/state.audit.yaml +7 -0
  97. package/templates/dev-playbooks/changes/validation.md +4 -4
  98. package/templates/dev-playbooks/changes/verification.md +4 -4
  99. package/templates/dev-playbooks/docs/DevBooks/351/205/215/347/275/256/346/214/207/345/215/227.md +4 -3
  100. package/templates/dev-playbooks/requirements/requirements.index.yaml +9 -0
  101. package/templates/dev-playbooks/specs/bootstrap/README.md +13 -13
  102. package/templates/dev-playbooks/specs/knife/knife-plan.md +4 -4
  103. package/templates/dev-playbooks/specs/knife/knife-plan.yaml +33 -0
  104. package/scripts/benchmark-scan.sh +0 -67
  105. package/scripts/detect-fancy-words.sh +0 -7
  106. package/scripts/detect-mcp.sh +0 -86
  107. package/scripts/migrate-from-openspec.sh +0 -481
  108. package/scripts/migrate-from-speckit.sh +0 -735
  109. package/scripts/sync_mcp_from_claude_to_codex.py +0 -343
  110. package/skills/Skill/345/274/200/345/217/221/346/214/207/345/215/227.md +0 -248
  111. package/skills/devbooks-router/SKILL.md +0 -40
  112. package/skills/devbooks-router/references//350/267/257/347/224/261/350/247/204/345/210/231/344/270/216/346/250/241/346/235/277.md +0 -329
  113. package/templates/claude-commands/devbooks/quick.md +0 -23
  114. package/templates/claude-commands/devbooks/router.md +0 -24
  115. package/templates/claude-commands/devbooks/start.md +0 -21
package/CHANGELOG.md CHANGED
@@ -1,32 +1,130 @@
1
- # Changelog
1
+ # 变更日志
2
2
 
3
- All notable changes to this project will be documented in this file.
3
+ 本项目的所有重要变更都会记录在本文件中。
4
4
 
5
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5
+ 格式参考 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),并遵循 [语义化版本](https://semver.org/spec/v2.0.0.html)。
6
+
7
+ ## [4.0.0] - 2026-02-03
8
+
9
+ ### 新增
10
+
11
+ - **完成合同(Completion Contract)**:把用户意图编译为机读合同,锁定“义务→检查→证据”链条,防止交付标准被静默弱化
12
+ - **7 道闸门(G0-G6)**:从输入就绪到归档裁决,全链路可裁判检查点,任何一道失败都会阻断
13
+ - **上游 SSOT 支持**:自动索引项目已有的需求文档,提取可裁判约束;缺失时自动创建最小 SSOT 包
14
+ - **Knife 切片协议**:大需求强制切片,每片有复杂度预算,超预算必须再切
15
+ - **Void 研究协议**:高熵问题先研究再决策,产出可追溯的决策记录(ADR)
16
+ - **证据新鲜度校验**:证据文件必须比被覆盖的交付物更新,防止用旧证据糊弄
17
+ - **弱连接义务**:文档、配置、发布说明等“代码外契约”也被编译为可裁判义务
18
+
19
+ ### 修复
20
+
21
+ - **忽略规则补齐**:补齐 `.ci-index/`(本地索引数据库目录)到忽略清单,避免误提交/误发布
22
+ - **文档示例一致性**:安装后命令示例对齐为 `dev-playbooks-cn`
23
+
24
+ ## [3.1.0] - 2026-01-31
25
+
26
+ > ⚠️ 重要:`3.0.0` 存在“错误发布/叙事漂移”风险(版本/变更记录与能力集不一致)。本版本用于收敛并提供可复验的发布与同步证据。建议跳过 `3.0.0`,直接使用 `3.1.0`。
27
+
28
+ ### 新增
29
+
30
+ - **发布边界证据锚点**:
31
+ - 将 `npm pack --dry-run` 作为发布边界的客观证据(packlist),用于复验“包内包含/不包含”的最终口径
32
+ - 补齐 CLI 入口一致性自检锚点(bin 映射与入口可执行性)
33
+
34
+ ### 变更
35
+
36
+ - **版本收敛**:
37
+ - CN/EN 用户侧版本统一推进到 `3.1.0`,并对齐 Release notes 叙事(语言不同但要点一致)
38
+
39
+ ### 修复
40
+
41
+ - **发布与同步闭环可裁判性**:
42
+ - 将“发布包范围”和“跨仓同步边界”从口头约定收敛为脚本可复验证据(packlist + parity 报告)
43
+
44
+ ---
45
+
46
+ ## [3.0.3] - 2026-01-29
47
+
48
+ ### 新增
49
+
50
+ - **协议 v1.1 覆盖与强制校验**:
51
+ - 新增 v1.1 coverage mapping,并强制产出覆盖报告(映射 + 证据驱动;要求 `uncovered=0`)
52
+ - **闸门报告与风险证据约定**:
53
+ - 新增 Gate Report 证据约定与风险证据落点(`evidence/gates/`、`evidence/risks/`)
54
+ - **依赖审计输出格式化**:
55
+ - 新增格式化的依赖审计输出(最小字段 + 原始 audit JSON)
56
+
57
+ ### 变更
58
+
59
+ - **强化 `change-check.sh`**:
60
+ - 加固元数据合同、状态机、change-type 矩阵,以及 Knife/Bootstrap 的闸门校验
61
+ - **对齐文档与模板**:
62
+ - 对齐 Gate Report、覆盖报告与依赖审计的约定(docs + templates)
63
+
64
+ ---
65
+
66
+ ## [3.0.2] - 2026-01-28
67
+
68
+ ### 新增
69
+
70
+ - **协议层 CN↔EN 同步工具**:
71
+ - 新增针对 `dev-playbooks/**` 的协议层同步脚本(带可审计报告与回滚锚点):`scripts/english-sync-protocol.sh`
72
+ - **v1.1 覆盖报告生成器**:
73
+ - 新增用于 strict/archive 闸门的 v1.1 覆盖报告生成脚本:`scripts/generate-protocol-v1.1-coverage-report.sh`
74
+
75
+ ### 变更
76
+
77
+ - **加固 strict/archive 闸门**:
78
+ - strict/archive 需要协议同步报告、parity 报告与 v1.1 覆盖报告(`skills/devbooks-delivery-workflow/scripts/change-check.sh`)
79
+ - **高风险审批加固**:
80
+ - strict 模式下 `risk_level=high` 需要有人类审批记录(闸门强制)
81
+
82
+ ---
83
+
84
+ ## [3.0.1] - 2026-01-27
85
+
86
+ ### 新增
87
+
88
+ - **新增 `/devbooks:delivery`(基于 `devbooks-delivery-workflow`)**:
89
+ - 统一入口:产物化变更包骨架(RUNBOOK/inputs index + evidence + completion contract)并路由 `request_kind`
90
+ - **新增验证入口**:
91
+ - 新增 legacy 清理、slash commands、npm 打包与总结校验等验证入口
92
+ - **新增工具脚本**:
93
+ - `tools/devbooks-embedding.sh`、`tools/devbooks-complexity.sh`、`tools/devbooks-entropy-viz.sh`
94
+
95
+ ### 变更
96
+
97
+ - **完善 strict 闸门**:
98
+ - 完成 `change-check.sh` strict 校验:G0–G6 报告、风险/追溯/handoff 阻断,以及 registry 一致性检查
99
+ - **加固 `scripts/english-sync.sh`**:
100
+ - 增加发布规格报告与加强 `dev-playbooks/**` deny 边界
101
+ - **统一 CLI 入口脚本**:
102
+ - `bin/devbooks.mjs`
103
+
104
+ ---
7
105
 
8
106
  ## [3.0.0] - 2026-01-26
9
107
 
10
- ### Added
108
+ ### 新增
11
109
 
12
110
  - **AI 原生工作流与协议升级**:
13
- - 补齐 Start/Router 入口与阶段路由规范
111
+ - 补齐 Delivery 入口与 request_kind 路由规范
14
112
  - 新增变更包模板与协议合同(RUNBOOK、验证/合规/回滚、Knife Plan、合同 schema)
15
113
  - 完整化质量闸门与证据结构(G0–G6、风险与审计要求)
16
114
  - 新增依赖审计脚本与发布校验入口
17
115
  - 更新架构/文件系统视图与工作流示意图模板
18
116
 
19
- ### Changed
117
+ ### 变更
20
118
 
21
119
  - **CLI 入口补齐**:
22
- - 新增 `start` 与 `router` 命令,用于入口指引(不执行 AI)
120
+ - 新增 `delivery` 命令,用于入口指引(不执行 AI)
23
121
  - 帮助信息指向模板与工作流文档入口
24
122
 
25
123
  ---
26
124
 
27
125
  ## [2.6.0] - 2026-01-25
28
126
 
29
- ### Added
127
+ ### 新增
30
128
 
31
129
  - **MCP 增强功能**:
32
130
  - 新增 MCP 检测脚本 `scripts/detect-mcp.sh`
@@ -38,13 +136,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
38
136
  - 新增 `skills/devbooks-archiver/references/归档流程与规则.md`
39
137
  - 新增 `skills/devbooks-convergence-audit/references/` 目录
40
138
  - 新增 `skills/devbooks-delivery-workflow/references/编排禁令与阶段表.md`
41
- - 新增 `skills/devbooks-router/references/` 目录
42
139
 
43
140
  - **规格文档完善**:
44
141
  - 新增 `dev-playbooks/specs/README.md` 规格索引
45
142
  - 完善 MCP、共享方法论、样式清理等规格文档
46
143
 
47
- ### Changed
144
+ ### 变更
48
145
 
49
146
  - **文档结构优化**:
50
147
  - 更新所有 skill 的 SKILL.md 文档
@@ -58,13 +155,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
58
155
 
59
156
  ## [2.5.4] - 2026-01-23
60
157
 
61
- ### Fixed
158
+ ### 修复
62
159
 
63
160
  - **修正 ignore 规则**:
64
161
  - 移除 `.ckb/` - 这是外部工具 CKB 的缓存,不属于 DevBooks
65
162
  - 将 `dev-playbooks/changes/*/evidence/` 改为 `dev-playbooks/` - 整个工作目录都应该被 ignore
66
163
 
67
- ### Changed
164
+ ### 变更
68
165
 
69
166
  - **更准确的 ignore 范围**:
70
167
  - `dev-playbooks/` - DevBooks 工作目录(包含所有运行时产生的内容)
@@ -76,7 +173,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
76
173
 
77
174
  ## [2.5.3] - 2026-01-23
78
175
 
79
- ### Added
176
+ ### 新增
80
177
 
81
178
  - **智能 ignore 功能增强**:
82
179
  - 自动识别并 ignore DevBooks 工作流产生的临时文件
@@ -86,7 +183,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
86
183
  - 新增 `.ckb/` - CKB 代码知识库缓存
87
184
  - 自动识别项目级 skills 目录(`.factory/`, `.cursor/` 等)
88
185
 
89
- ### Changed
186
+ ### 变更
90
187
 
91
188
  - **更智能的 ignore 规则生成**:
92
189
  - 根据选择的 AI 工具自动添加对应的目录
@@ -97,7 +194,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
97
194
 
98
195
  ## [2.5.2] - 2026-01-23
99
196
 
100
- ### Fixed
197
+ ### 修复
101
198
 
102
199
  - **init 命令支持 Factory 和 Cursor**:
103
200
  - 将 Factory 添加为完整 Skills 支持的工具
@@ -114,7 +211,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
114
211
 
115
212
  ## [2.5.1] - 2026-01-23
116
213
 
117
- ### Fixed
214
+ ### 修复
118
215
 
119
216
  - 修复 `dev-playbooks-cn update` 命令的 changelog 显示功能
120
217
  - 添加完整的 2.5.0 版本变更记录
@@ -124,7 +221,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
124
221
 
125
222
  ## [2.5.0] - 2026-01-23
126
223
 
127
- ### Added
224
+ ### 新增
128
225
 
129
226
  - **Factory 原生 Skills 支持**:添加 `.factory/skills/` 目录,支持 Factory Droid
130
227
  - 使用符号链接指向现有 `skills/` 目录,保持单一数据源
@@ -136,7 +233,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
136
233
  - 所有 18 个 DevBooks skills 可在 Cursor 中原生使用
137
234
  - 符合 Cursor Agent Skills 标准
138
235
 
139
- ### Changed
236
+ ### 变更
140
237
 
141
238
  - **README 优化**:
142
239
  - 移除"30秒电梯演讲"章节,简化文档结构
@@ -159,7 +256,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
159
256
 
160
257
  ## [2.3.0] - 2026-01-23
161
258
 
162
- ### Added
259
+ ### 新增
163
260
 
164
261
  - 新增 `devbooks-docs-consistency`:文档一致性检查技能(原 `devbooks-docs-sync` 的改名与增强)
165
262
  - 支持自定义规则引擎(持续规则 + 一次性任务)
@@ -174,7 +271,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
174
271
  - `scripts/benchmark-scan.sh`:扫描性能基准测试
175
272
  - `scripts/detect-fancy-words.sh`:浮夸词语检测
176
273
 
177
- ### Changed
274
+ ### 变更
178
275
 
179
276
  - `devbooks-docs-sync` 改名为 `devbooks-docs-consistency`,旧名称作为别名保留(6 个月弃用期)
180
277
  - 更新所有 skills 的 AI 行为规范,添加专家角色声明协议
@@ -225,7 +322,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
225
322
 
226
323
  ## [2.1.0] - 2025-01-19
227
324
 
228
- ### Added
325
+ ### 新增
229
326
 
230
327
  - **Version Changelog Display**: When running `dev-playbooks-cn update`, the CLI now displays a formatted changelog summary showing all changes between the current version and the latest version
231
328
  - ✅ Automatic fetch from GitHub: Retrieves CHANGELOG.md from the repository
@@ -242,7 +339,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
242
339
 
243
340
  ## [2.0.0] - 2026-01-19
244
341
 
245
- ### Added
342
+ ### 新增
246
343
 
247
344
  #### 🎯 Human-Friendly Document Templates
248
345
 
@@ -286,7 +383,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
286
383
 
287
384
  - Updated README.md with v2.0.0 features section (both Chinese and English versions)
288
385
 
289
- ### Changed
386
+ ### 变更
290
387
 
291
388
  - **proposal-author skill**: Updated to use new document templates
292
389
  - Now generates documents with "Bottom Line Up Front" section
@@ -382,14 +479,14 @@ New projects will automatically use the new document templates. No migration nee
382
479
 
383
480
  ## [1.7.4] - 2026-01-18
384
481
 
385
- ### Changed
482
+ ### 变更
386
483
  - Various bug fixes and improvements
387
484
 
388
485
  ---
389
486
 
390
487
  ## [1.7.0] - 2026-01-15
391
488
 
392
- ### Added
489
+ ### 新增
393
490
  - Initial release with 18 skills
394
491
  - Support for Claude Code, Codex CLI, and other AI tools
395
492
  - Quality gates and role isolation
package/README.md CHANGED
@@ -1,224 +1,172 @@
1
1
  # DevBooks
2
2
 
3
- **AI 编程的质量闸门:让 AI 助手从"不可预测"变成"可验证"**
4
-
5
3
  [![npm](https://img.shields.io/npm/v/dev-playbooks-cn)](https://www.npmjs.com/package/dev-playbooks-cn)
6
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
7
5
 
8
- ![DevBooks 工作流](docs/workflow-diagram.svg)
9
-
10
- ---
11
-
12
- ## 最佳实践:一键跑完整闭环
6
+ ## v4.0 新特性
13
7
 
14
- 不知道怎么用?直接运行:
15
-
16
- ```bash
17
- /devbooks-delivery-workflow
18
- ```
19
-
20
- 这个 skill 会自动编排完整的开发闭环:Proposal → Design → Spec → Plan → Test → Implement → Review → Archive
21
-
22
- 不确定入口时,也可以先运行:
23
-
24
- ```bash
25
- /devbooks:start
26
- ```
27
-
28
- **适用场景**:新功能开发、重大重构、不熟悉 DevBooks 工作流
29
-
30
- ---
31
-
32
- ## 定位与文本规范
33
-
34
- DevBooks 本体是非 MCP 工具,但提供 MCP 可选集成点,便于按需接入外部能力,同时保留少量自检脚本作为护栏。
35
- DevBooks 是一套围绕协议、工作流、文本规范的协作体系,强调可追溯与可验证。
36
-
37
- 约束:核心流程必须保持可追溯与可审计。
38
- 取舍:更重视一致性检查,接受部分自动化效率降低。
39
- 影响:文档可扫描性提高,协作成本下降。
8
+ - **完成合同(Completion Contract)**:把用户意图编译为机读合同,锁定"义务→检查→证据"链条,防止 AI 偷偷降低交付标准
9
+ - **7 道闸门(G0-G6)**:从输入就绪到归档裁决,全链路可裁判检查点,任何一道失败都会阻断
10
+ - **上游 SSOT 支持**:自动索引项目已有的需求文档,提取可裁判约束;没有需求文档时自动创建最小 SSOT 包
11
+ - **Knife 切片协议**:大需求强制切片,每片有复杂度预算,超预算必须再切
12
+ - **Void 研究协议**:高熵问题先研究再决策,产出可追溯的决策记录(ADR)
13
+ - **证据新鲜度校验**:证据文件必须比被覆盖的交付物更新,防止用旧证据糊弄
14
+ - **弱连接义务**:文档、配置、发布说明等"代码外契约"也被编译为可裁判义务
40
15
 
41
16
  ---
42
17
 
43
- ## 我们解决的核心问题
44
-
45
- ### 问题 1:逻辑幻觉与事实捏造
18
+ ## 你用 AI 写代码时,是不是经常遇到这些问题?
46
19
 
47
- **痛点**:AI 在缺乏知识时倾向于自信地编造代码或库,而非承认无知。
20
+ **"说改好了,结果没改好"**
21
+ AI 说"已修复",你问它确定吗,它说"确定"。上线后炸了。回头看,它写的测试恰好能通过它自己的 Bug。
48
22
 
49
- **DevBooks 方案**:
50
- - 规格驱动开发:所有代码必须追溯到 AC-xxx(验收标准)
51
- - Contract Tests:验证对外契约,防止 API 幻觉
23
+ **"改着改着就忘了之前说的"**
24
+ 对话开头你说"不要改 X 模块",三十轮对话后它把 X 模块改了。你提醒它,它道歉,然后下一轮又改了。
52
25
 
53
- ### 问题 2:非收敛性调试
26
+ **"需求大了就乱套"**
27
+ 小功能还行,稍微复杂一点就开始胡说八道。改了 A 忘了 B,修了 B 又破坏了 C。
54
28
 
55
- **痛点**:修复一个 Bug 引入两个新 Bug,陷入"打地鼠"循环。
29
+ **"不知道它到底做没做完"**
30
+ 它说"完成了",但你不敢信。你让它再检查一遍,它说"检查过了,没问题"。你还是不敢信。
56
31
 
57
- **DevBooks 方案**:
58
- - 角色隔离:Test Owner 先跑出 Red 基线,Coder 不能修改测试
59
- - 收敛性审计:`devbooks-convergence-audit` 评估变更包是否有效推进
32
+ **"每次都要从头教"**
33
+ 上次对话里建立的约定,这次对话全忘了。项目的术语、边界、约束,每次都要重新解释。
60
34
 
61
- ### 问题 3:局部最优与全局短视
35
+ **"改完不知道改了什么"**
36
+ 它改了一堆文件,你问它改了什么,它给你一个摘要。但这个摘要对不对?你不知道。
62
37
 
63
- **痛点**:AI 倾向于生成"能跑通"的独立代码块,缺乏对整体架构的考量。
64
-
65
- **DevBooks 方案**:
66
- - 设计先行:Design Doc 定义 What/Constraints,不写 How
67
- - 架构约束:Fitness Rules 验证架构规则
68
- - 影响分析:变更前评估跨模块影响
38
+ ---
69
39
 
70
- ### 问题 4:验证疲劳
40
+ ## 这些不是 AI 不够聪明,是结构性问题
71
41
 
72
- **痛点**:AI 生成速度极快,人类审查代码的警觉性随时间呈指数下降。
42
+ 提示词写得再好也没用。这是 LLM 的工作方式决定的:
73
43
 
74
- **DevBooks 方案**:
75
- - 自动化质量闸门:Green 证据检查、任务完成率、角色边界检查
76
- - 强制评审:Reviewer 只审查可维护性,业务正确性由测试保证
44
+ | 问题 | 根本原因 |
45
+ |-----|---------|
46
+ | 说改好了没改好 | 自己写测试验证自己的代码,当然能过 |
47
+ | 改着改着就忘了 | 上下文窗口有限,早期信息被挤出去 |
48
+ | 需求大了就乱 | 复杂度超过单次对话能处理的极限 |
49
+ | 不知道做没做完 | 没有客观证据,只有它的口头声明 |
50
+ | 每次从头教 | 对话是临时的,知识没有持久化 |
51
+ | 不知道改了什么 | 没有可审计的变更记录 |
77
52
 
78
53
  ---
79
54
 
80
- ## 快速开始
81
-
82
- ### 安装
55
+ ## DevBooks:用工程约束解决这些问题
83
56
 
84
57
  ```bash
85
- # 全局安装
86
58
  npm install -g dev-playbooks-cn
87
-
88
- # 在项目中初始化
89
59
  dev-playbooks-cn init
60
+ dev-playbooks-cn delivery
90
61
  ```
91
62
 
92
- ### 更新
63
+ | 问题 | DevBooks 怎么解决 |
64
+ |-----|------------------|
65
+ | 自己验证自己 | **角色隔离**:写测试的 Agent 和写代码的 Agent 必须分开,互相看不到对方的思路 |
66
+ | 上下文遗忘 | **真理落盘**:术语、边界、约束写在文件里,不依赖对话记忆 |
67
+ | 需求太大 | **切片预算**:大需求必须切成小块,每块有复杂度上限,超了就再切 |
68
+ | 口头完成 | **证据定义完成**:测试日志、构建输出必须真的存在于磁盘上 |
69
+ | 每次从头教 | **SSOT(单一真理源)**:项目知识持久化在 specs/,跨对话、跨变更稳定 |
70
+ | 不知道改了什么 | **变更包**:每次变更有完整记录——提案、设计、任务、证据 |
93
71
 
94
- ```bash
95
- dev-playbooks-cn update
96
- ```
72
+ ---
97
73
 
98
- ### 支持的 AI 工具
74
+ ## 它是怎么工作的
99
75
 
100
- | 工具 | 支持级别 |
101
- |------|----------|
102
- | Claude Code | 完整 Skills(`.claude/skills/`)|
103
- | Codex CLI | 完整 Skills(`.codex/skills/`)|
104
- | Qoder | 完整 Skills |
105
- | OpenCode | 完整 Skills |
106
- | Every Code | 完整 Skills |
107
- | Factory | 原生 Skills(`.factory/skills/`)|
108
- | Cursor | 原生 Skills(`.cursor/skills/`)|
109
- | Windsurf | Rules 系统 |
110
- | Gemini CLI | Rules 系统 |
76
+ 你只需要记住一个命令:
111
77
 
112
- ---
78
+ ```bash
79
+ dev-playbooks-cn delivery
80
+ ```
113
81
 
114
- ## 文档
82
+ 系统会问你几个问题,然后生成一份 `RUNBOOK.md`——这是你这次任务的操作手册。照着做就行。
115
83
 
116
- - [使用指南](docs/使用指南.md) - 完整工作流程和最佳实践
117
- - [Skill 详解](docs/Skill详解.md) - 18 个 Skills 的特色和功能
84
+ ```
85
+ 你的需求
86
+
87
+ Delivery(判断类型、生成 RUNBOOK)
88
+
89
+ ┌─────────────────────────────────┐
90
+ │ 小改动 → 直接执行 │
91
+ │ 大需求 → 先切片再执行 │
92
+ │ 不确定 → 先研究再决策 │
93
+ └─────────────────────────────────┘
94
+
95
+ 闸门检查(7 道关卡,任何一道失败都会阻断)
96
+
97
+ 证据归档(测试日志、构建输出、审批记录)
98
+ ```
118
99
 
119
100
  ---
120
101
 
121
- ## 核心理念
102
+ ## 核心机制
122
103
 
123
- ### 1. 角色隔离(Role Isolation)
104
+ **真理源(SSOT)**
124
105
 
125
- Test Owner 与 Coder **必须在独立对话**中工作。这不是建议,是硬性约束。
106
+ ```
107
+ 你的需求文档(如果有)
108
+ ↓ 提取约束
109
+ specs/(术语、边界、决策)← 跨变更稳定的"项目记忆"
110
+
111
+ changes/<id>/(本次变更的提案、设计、任务、证据)
112
+ ↓ 归档
113
+ specs/(更新真理)
114
+ ```
126
115
 
127
- **隔离执行基线:**
128
- - 同一对话不同时编写测试与实现
129
- - 测试用于验证规格
116
+ 如果你没有需求文档,DevBooks 会帮你创建一个最小的。这反而是好事——逼你把模糊的想法写清楚。
130
117
 
131
- ### 2. 规格驱动(Spec-Driven)
118
+ **完成合同**
132
119
 
133
- 所有代码必须追溯到 AC-xxx(验收标准)。
120
+ 把"我要什么"编译成机器可检查的清单:
121
+ - 5 条义务
122
+ - 每条有对应的检查项
123
+ - 每条有对应的证据文件
134
124
 
135
- ```
136
- 需求 → Proposal → Design (AC-001, AC-002) → Spec → Tasks → Tests → Code
137
- ```
125
+ 不是"大概做完了",而是"这 5 条都有证据"。
138
126
 
139
- ### 3. 证据优先(Evidence-First)
127
+ **7 道闸门(G0-G6)**
140
128
 
141
- 完成由证据定义,而非 AI 声明。
129
+ | 闸门 | 检查什么 |
130
+ |-----|---------|
131
+ | G0 | 输入就绪了吗?需求清楚吗? |
132
+ | G1 | 该有的文件都有吗? |
133
+ | G2 | 任务都完成了吗? |
134
+ | G3 | 切片正确吗?(大需求) |
135
+ | G4 | 文档同步了吗? |
136
+ | G5 | 风险覆盖了吗?(高风险变更) |
137
+ | G6 | 证据完整吗?可以归档吗? |
142
138
 
143
- 必需的证据:
144
- - 测试通过(Green 证据)
145
- - 构建成功
146
- - 静态检查通过
147
- - 任务完成率 100%
139
+ 任何一道失败,流程阻断。不是警告,是阻断。
148
140
 
149
141
  ---
150
142
 
151
- ## 工作流程
143
+ ## 目录结构
152
144
 
153
145
  ```
154
- 1. Proposal(提案)- 分析需求,评估影响
155
-
156
- 2. Design(设计)- 定义 What/Constraints + AC-xxx
157
-
158
- 3. Spec(规格)- 定义对外行为契约
159
-
160
- 4. Plan(计划)- 制定实现计划和任务拆解
161
-
162
- 5. Test(测试)- 编写验收测试(独立对话)
163
-
164
- 6. Implement(实现)- 实现功能(独立对话)
165
-
166
- 7. Review(评审)- 代码评审
167
-
168
- 8. Archive(归档)- 归档变更包
146
+ project/
147
+ ├── .devbooks/config.yaml # 配置
148
+ └── dev-playbooks/
149
+ ├── constitution.md # 硬约束(不可绕过的规则)
150
+ ├── specs/ # 真理源(跨变更稳定)
151
+ └── changes/ # 变更包(每次变更一个目录)
152
+ └── <change-id>/
153
+ ├── proposal.md # 为什么做、做什么
154
+ ├── design.md # 怎么做、验收标准
155
+ ├── tasks.md # 拆成可执行的步骤
156
+ ├── verification.md # 怎么证明做对了
157
+ └── evidence/ # 测试日志、构建输出
169
158
  ```
170
159
 
171
160
  ---
172
161
 
173
- ## 18 个 Skills
174
-
175
- | Skill | 阶段 | 作用 |
176
- |-------|------|------|
177
- | devbooks-router | 入口 | 工作流引导 |
178
- | devbooks-proposal-author | Proposal | 撰写提案 |
179
- | devbooks-proposal-challenger | Proposal | 质疑提案 |
180
- | devbooks-proposal-judge | Proposal | 裁决提案 |
181
- | devbooks-design-doc | Design | 编写设计文档 |
182
- | devbooks-spec-contract | Spec | 定义规格契约 |
183
- | devbooks-implementation-plan | Plan | 制定实现计划 |
184
- | devbooks-test-owner | Test | 编写验收测试 |
185
- | devbooks-test-reviewer | Review | 测试评审 |
186
- | devbooks-coder | Implement | 实现功能 |
187
- | devbooks-reviewer | Review | 代码评审 |
188
- | devbooks-archiver | Archive | 归档变更包 |
189
- | devbooks-docs-consistency | Quality | 文档一致性检查 |
190
- | devbooks-impact-analysis | Quality | 影响分析 |
191
- | devbooks-convergence-audit | Quality | 收敛性审计 |
192
- | devbooks-entropy-monitor | Quality | 熵度量监控 |
193
- | devbooks-brownfield-bootstrap | Init | 存量项目初始化 |
194
- | devbooks-delivery-workflow | Full | 完整闭环编排 |
195
-
196
- 详见 [Skill 详解](docs/Skill详解.md)
197
-
198
- ---
199
-
200
- ## 传统 AI 编程对照
201
-
202
- ### 对比传统 AI 编程
203
-
204
- | 传统 AI 编程 | DevBooks |
205
- |-------------|----------|
206
- | AI 自评"已完成" | 测试通过 + 构建成功 |
207
- | 同一对话写测试又写代码 | 角色隔离,独立对话 |
208
- | 无验证闸门 | 多重质量闸门 |
209
- | 边修边破 | 稳定推进 |
210
- | 只支持 0→1 项目 | 支持存量项目 |
211
-
212
- ### 适用场景
162
+ ## 下一步
213
163
 
214
- - 新功能开发
215
- - 重大重构
216
- - Bug 修复
217
- - 存量项目接入
218
- - 需要高质量保证的项目
164
+ - [快速开始](docs/使用指南.md)
165
+ - [设计原理](dev-playbooks/docs/AI软件工程开发框架设计.md)
166
+ - [Skill 详解](docs/Skill详解.md)
219
167
 
220
168
  ---
221
169
 
222
170
  ## 许可证
223
171
 
224
- MIT License - 详见 [LICENSE](LICENSE)
172
+ MIT
package/bin/devbooks ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+
4
+ script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
5
+ exec node "${script_dir}/devbooks.mjs" "$@"