dev-playbooks-cn 1.7.3 → 2.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 (21) hide show
  1. package/README.md +33 -0
  2. package/package.json +1 -1
  3. package/skills/Skill/345/274/200/345/217/221/346/214/207/345/215/227.md +2 -2
  4. package/skills/_shared/references//346/211/271/345/207/206/351/205/215/347/275/256/350/257/264/346/230/216.md +285 -0
  5. package/skills/_shared/references//346/226/207/346/241/243/346/250/241/346/235/277-decision-log.md +137 -0
  6. package/skills/_shared/references//346/226/207/346/241/243/346/250/241/346/235/277-design.md +202 -0
  7. package/skills/_shared/references//346/226/207/346/241/243/346/250/241/346/235/277-project-profile.md +159 -0
  8. package/skills/_shared/references//346/226/207/346/241/243/346/250/241/346/235/277-proposal.md +226 -0
  9. package/skills/_shared/references//346/226/207/346/241/243/346/250/241/346/235/277-tasks.md +181 -0
  10. package/skills/_shared/references//346/226/207/346/241/243/346/250/241/346/235/277-verification.md +186 -0
  11. package/skills/devbooks-brownfield-bootstrap/references//344/273/243/347/240/201/345/257/274/350/210/252/347/255/226/347/225/245.md +1 -1
  12. package/skills/devbooks-coder/references//346/227/245/345/277/227/350/247/204/350/214/203.md +1 -1
  13. package/skills/devbooks-coder/references//347/274/226/347/240/201/351/243/216/346/240/274/347/273/206/345/210/231.md +1 -1
  14. package/skills/devbooks-coder/references//351/224/231/350/257/257/347/240/201/350/247/204/350/214/203.md +1 -1
  15. package/skills/devbooks-design-doc/references//351/232/220/347/247/201/345/220/210/350/247/204/346/243/200/346/237/245/346/270/205/345/215/225.md +1 -1
  16. package/skills/devbooks-proposal-author/references//346/217/220/346/241/210/346/222/260/345/206/231/346/217/220/347/244/272/350/257/215.md +46 -22
  17. package/skills/devbooks-reviewer/references/PR/346/250/241/346/235/277/344/270/216/346/214/207/345/215/227.md +1 -1
  18. package/skills/devbooks-reviewer/references//345/235/217/345/221/263/351/201/223/351/200/237/346/237/245/350/241/250.md +1 -3
  19. package/skills/devbooks-reviewer/references//350/265/204/346/272/220/347/256/241/347/220/206/345/256/241/346/237/245/346/270/205/345/215/225.md +1 -1
  20. package/skills/devbooks-spec-contract/references/API/350/256/276/350/256/241/346/214/207/345/215/227.md +1 -1
  21. package/skills/devbooks-test-owner/references//346/265/213/350/257/225/345/210/206/345/261/202/347/255/226/347/225/245.md +2 -2
@@ -0,0 +1,186 @@
1
+ # Verification 文档模板
2
+
3
+ > 本模板定义了 verification.md 的标准结构,确保验收清晰、可测试、可追溯。
4
+
5
+ ## 文件位置
6
+
7
+ ```
8
+ <change-root>/<change-id>/verification.md
9
+ ```
10
+
11
+ ## 标准结构
12
+
13
+ ```markdown
14
+ # <变更标题> - 验收文档
15
+
16
+ ## 🎯 结论先行(30秒阅读)
17
+
18
+ **本验收会导致**:
19
+ - ✅ 运行 [X] 个测试用例
20
+ - ✅ 验证准确率 >[X]%
21
+ - ✅ 验证性能 <[X] 秒
22
+
23
+ **本验收不会导致**:
24
+ - ❌ 不会修改代码
25
+ - ❌ 不会影响功能
26
+
27
+ **验收标准**:
28
+ - ✅ 所有测试通过
29
+ - ✅ 准确率 >[X]%
30
+ - ✅ 性能 <[X] 秒
31
+
32
+ ---
33
+
34
+ ## ✅ 验收批准(30秒)
35
+
36
+ **测试结果**:
37
+ - ✅ 单元测试:[X]/[Y] 通过
38
+ - ✅ 集成测试:[X]/[Y] 通过
39
+ - ✅ 性能测试:通过([X] 秒)
40
+
41
+ **如果你同意**:
42
+ - [ ] ✅ 验收通过,可以归档
43
+
44
+ **如果你不同意**:
45
+ - [ ] ❌ 验收不通过(请说明原因)
46
+
47
+ **默认选择**:✅ 验收通过(12小时后自动批准)
48
+
49
+ ---
50
+
51
+ ## ✅ 批准流程(1分钟)
52
+
53
+ **当前状态**:
54
+ - 📝 状态:待批准
55
+ - ⏰ 创建时间:[时间]
56
+ - ⏰ 超时时间:[时间](12小时后)
57
+
58
+ **如果你同意**:
59
+ - [ ] ✅ 批准验收,开始归档
60
+
61
+ **如果你不同意**:
62
+ - [ ] ❌ 拒绝验收,说明理由:[理由]
63
+
64
+ **默认选择**:✅ 批准验收(12小时后自动批准)
65
+
66
+ ---
67
+
68
+ ## 📋 详细验证(AI阅读)
69
+
70
+ ### 测试覆盖
71
+
72
+ #### 单元测试
73
+
74
+ | 测试用例 | 状态 | 说明 |
75
+ |----------|------|------|
76
+ | test_xxx_1 | ✅ 通过 | [说明] |
77
+ | test_xxx_2 | ✅ 通过 | [说明] |
78
+
79
+ **覆盖率**:[X]%
80
+
81
+ ---
82
+
83
+ #### 集成测试
84
+
85
+ | 测试用例 | 状态 | 说明 |
86
+ |----------|------|------|
87
+ | test_integration_1 | ✅ 通过 | [说明] |
88
+ | test_integration_2 | ✅ 通过 | [说明] |
89
+
90
+ ---
91
+
92
+ #### 性能测试
93
+
94
+ | 指标 | 目标 | 实际 | 状态 |
95
+ |------|------|------|------|
96
+ | 响应时间 | <[X]ms | [Y]ms | ✅ 通过 |
97
+ | 吞吐量 | >[X] QPS | [Y] QPS | ✅ 通过 |
98
+ | 内存占用 | <[X]MB | [Y]MB | ✅ 通过 |
99
+
100
+ ---
101
+
102
+ ### 验收标准追溯
103
+
104
+ #### AC-001: [验收标准标题]
105
+
106
+ **来源**:design.md AC-001
107
+
108
+ **验收条件**:
109
+ - [x] [条件1] - 测试用例:test_xxx_1
110
+ - [x] [条件2] - 测试用例:test_xxx_2
111
+
112
+ **验证结果**:✅ 通过
113
+
114
+ ---
115
+
116
+ #### AC-002: [验收标准标题]
117
+
118
+ **来源**:design.md AC-002
119
+
120
+ **验收条件**:
121
+ - [x] [条件1] - 测试用例:test_xxx_3
122
+ - [x] [条件2] - 测试用例:test_xxx_4
123
+
124
+ **验证结果**:✅ 通过
125
+
126
+ ---
127
+
128
+ ### 回归测试
129
+
130
+ #### 现有功能验证
131
+
132
+ | 功能 | 测试用例 | 状态 | 说明 |
133
+ |------|----------|------|------|
134
+ | [功能1] | test_regression_1 | ✅ 通过 | 未受影响 |
135
+ | [功能2] | test_regression_2 | ✅ 通过 | 未受影响 |
136
+
137
+ ---
138
+
139
+ ### 文档验证
140
+
141
+ #### 文档更新检查
142
+
143
+ - [x] README.md 已更新
144
+ - [x] 使用文档已更新
145
+ - [x] API 文档已更新
146
+ - [x] CHANGELOG.md 已更新
147
+
148
+ ---
149
+
150
+ ## 批准历史
151
+
152
+ | 时间 | 阶段 | 操作 | 操作者 | 理由 |
153
+ |------|------|------|--------|------|
154
+ | [时间] | Verification | 创建 | AI | - |
155
+ | [时间] | Verification | 批准 | 用户 | [理由] |
156
+ ```
157
+
158
+ ## 使用指南
159
+
160
+ ### 1. 结论先行的作用
161
+
162
+ - **30秒快速理解**:让用户立即知道验收的核心内容
163
+ - **测试结果**:明确说明测试结果
164
+ - **降低认知负担**:用大白话,不用专业术语
165
+
166
+ ### 2. 验收批准的作用
167
+
168
+ - **快速决策**:用户只需要确认"通过"或"不通过"
169
+ - **默认批准**:12小时后自动批准(比其他阶段更短)
170
+ - **保留控制权**:用户可以随时拒绝验收
171
+
172
+ ### 3. 验收标准追溯的作用
173
+
174
+ - **可追溯**:每个验收标准都应该与 Design 的 AC 对应
175
+ - **可验证**:每个验收条件都应该有对应的测试用例
176
+ - **完整性检查**:确保所有 AC 都被验证
177
+
178
+ ### 4. 回归测试的作用
179
+
180
+ - **防止破坏**:确保现有功能未受影响
181
+ - **质量保证**:确保变更不会引入新的问题
182
+
183
+ ### 5. 文档验证的作用
184
+
185
+ - **文档同步**:确保文档与代码同步
186
+ - **用户体验**:确保用户能够正确使用新功能
@@ -1,6 +1,6 @@
1
1
  # 代码导航策略(四步法)
2
2
 
3
- 借鉴 VS Code 的 `copilot-instructions.md`,本文档定义了在存量项目中快速定位代码的标准流程。
3
+ 本文档定义了在存量项目中快速定位代码的标准流程。
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  # 日志规范
2
2
 
3
- 借鉴 VS Code 的日志实践,本文档定义了应用程序日志的标准规范。
3
+ 本文档定义了应用程序日志的标准规范。
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  # 编码风格细则
2
2
 
3
- 借鉴 VS Code 的 `guidelines/CODING_GUIDELINES.md`,本文档定义了代码风格的具体规范。
3
+ 本文档定义了代码风格的具体规范。
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  # 错误码规范
2
2
 
3
- 借鉴 VS Code 错误处理模式,本文档定义了应用程序错误码的标准规范。
3
+ 本文档定义了应用程序错误码的标准规范。
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Telemetry 隐私合规检查项
2
2
 
3
- 借鉴 VS Code 的 `telemetry.instructions.md`,本文档定义了埋点/遥测数据的隐私合规要求。
3
+ 本文档定义了埋点/遥测数据的隐私合规要求。
4
4
 
5
5
  ---
6
6
 
@@ -4,13 +4,15 @@
4
4
 
5
5
  最高指示(优先级最高):
6
6
  - 在执行本提示词前,先阅读 `~/.claude/skills/_shared/references/AI行为规范.md` 并遵循其中所有协议。
7
+ - **必须**先阅读 `~/.claude/skills/_shared/references/文档模板-proposal.md` 了解新的文档结构。
7
8
 
8
9
  你是"提案负责人(Proposal Author)"。你的任务是在 proposal 阶段产出清晰、可审查、可落地的变更提案,确保范围最小且可验证。
9
10
 
10
11
  输入材料(由我提供):
11
12
  - 需求与目标(1–3 句)
12
13
  - 当前真理:`<truth-root>/`
13
- - 项目画像:`<truth-root>/_meta/project-profile.md`
14
+ - 项目画像:`<truth-root>/_meta/project-profile.md`(如存在)
15
+ - 决策日志:`<truth-root>/_meta/decision-log.md`(如存在)
14
16
  - 统一语言表(如存在):`<truth-root>/_meta/glossary.md`
15
17
  - 已有影响分析(如有)
16
18
 
@@ -51,26 +53,48 @@
51
53
  - 兼容性策略(是否保留向后兼容)
52
54
 
53
55
  输出格式(严格):
54
- 1) **Why**(问题与目标)
55
- 2) **What Changes**(范围、非目标、影响范围)
56
- 3) **Impact**(对外契约/数据/模块/测试/价值信号/价值流瓶颈假设)
57
- - **Transaction Scope**: `None | Single-DB | Cross-Service | Eventual`(必填,标明事务边界复杂度)
58
- 4) **Risks & Rollback**(风险与回滚)
59
- 5) **Validation**(候选验收锚点 + 证据落点)
60
- 6) **Debate Packet**(争议点/不确定点/需要辩论的问题)
61
- - 对于设计性决策,使用以下格式:
62
- ```
63
- #### DP-XX:<决策主题>(需用户决策)
64
-
65
- **选项**:
66
- - A:<选项描述> - 优点:xxx;缺点:xxx
67
- - B:<选项描述> - 优点:xxx;缺点:xxx
68
-
69
- **Author 建议**:<建议选项及理由>
70
- **等待用户选择**
71
- ```
72
- 7) **Decision Log(占位)**:
73
- - 决策状态:`Pending | Approved | Revise | Rejected`
74
- - 需要裁决的问题清单
56
+
57
+ **必须按照 `~/.claude/skills/_shared/references/文档模板-proposal.md` 的结构输出,包括:**
58
+
59
+ 1) **🎯 结论先行(30秒阅读)**
60
+ - 本提案会导致:[用大白话列出 3-5 个变化]
61
+ - 本提案不会导致:[用大白话列出 2-3 个不变的事情]
62
+ - 一句话总结:[用大白话说明这个变更是什么]
63
+
64
+ 2) **🤔 需求对齐(5分钟阅读)**
65
+ - 你是谁?(角色定位):提供 3-4 个角色选项,让用户选择
66
+ - 你要什么?(核心需求):列出基础需求和进阶需求
67
+ - 你可能没想到什么?(隐藏需求):通过问题引导用户思考
68
+ - 基于你的选择,推荐方案:根据不同角色推荐不同方案
69
+
70
+ 3) **✅ 批准流程(1分钟)**
71
+ - 快速批准(推荐):提供默认选项
72
+ - 默认选择:✅ 我同意推荐方案(24小时后自动批准)
73
+
74
+ 4) **📋 详细提案(AI阅读)**
75
+ - Why(为什么要改)
76
+ - What(要改什么)
77
+ - Impact(影响分析)
78
+ - **Transaction Scope**: `None | Single-DB | Cross-Service | Eventual`(必填)
79
+ - Alternatives(备选方案)
80
+ - Decision(决策)
81
+
82
+ 5) **批准历史**
83
+ - 记录所有批准操作
84
+
85
+ **关键原则**:
86
+ - "结论先行"和"需求对齐"部分必须用**大白话**,避免专业术语
87
+ - 假设用户是小白,不懂技术
88
+ - 用直观、简单的语言说明优劣势
89
+ - 提供多视角的推荐决策,帮助用户理清需求
90
+
91
+ **设计性决策处理**:
92
+ - 在"需求对齐"部分呈现选项
93
+ - 在"详细提案"的 Alternatives 部分详细说明
94
+ - 等待用户选择,不自行拍板
95
+
96
+ **决策日志更新**:
97
+ - 如果 `<truth-root>/_meta/decision-log.md` 存在,在做出重要决策后更新它
98
+ - 记录决策的背景、选项、理由和影响
75
99
 
76
100
  现在开始输出 `proposal.md` Markdown,不要输出额外解释。
@@ -1,6 +1,6 @@
1
1
  # Pull Request 模板与指南
2
2
 
3
- 借鉴 VS Code 的 `.github/pull_request_template.md`,本文档定义了 PR 提交的标准流程。
3
+ 本文档定义了 PR 提交的标准流程。
4
4
 
5
5
  ---
6
6
 
@@ -403,9 +403,7 @@ class PaymentService:
403
403
 
404
404
  ---
405
405
 
406
- ## 10. VS Code 风格代码卫生检查
407
-
408
- > 借鉴 VS Code ESLint 自定义规则,作为代码评审的自动化检查项
406
+ ## 10. 代码卫生检查
409
407
 
410
408
  ### 禁止提交的模式(阻塞级)
411
409
 
@@ -1,6 +1,6 @@
1
1
  # 资源管理审查清单
2
2
 
3
- 借鉴 VS Code 的 `code-no-potentially-unsafe-disposables` 和 `code-must-use-super-dispose` 规则。
3
+ 本文档定义了资源管理的审查要点。
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  # API 设计指南
2
2
 
3
- 借鉴 VS Code Extension API 设计原则,本文档定义了 API 设计的最佳实践。
3
+ 本文档定义了 API 设计的最佳实践。
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  # 测试分层策略
2
2
 
3
- 借鉴 VS Code 的测试组织模式,本文档定义了测试分层的最佳实践。
3
+ 本文档定义了测试分层的最佳实践。
4
4
 
5
5
  ---
6
6
 
@@ -234,7 +234,7 @@ if (process.env.NODE_ENV === 'development') {
234
234
 
235
235
  ---
236
236
 
237
- ## 6) 测试反脆弱策略(借鉴 VS Code Audit.md)
237
+ ## 6) 测试反脆弱策略
238
238
 
239
239
  ### 避免脆弱的选择器
240
240