6aspec 2.0.0-dev.3 → 2.0.0-dev.30
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/.6aspec/rules/biz/code.md +122 -28
- package/.6aspec/rules/biz/code_implementation_sop.md +77 -0
- package/.6aspec/rules/brown/brown_archive_sop.md +17 -11
- package/.6aspec/rules/brown/brown_constitution.md +11 -0
- package/.6aspec/rules/brown/brown_continue_sop.md +10 -3
- package/.6aspec/rules/brown/brown_design_sop.md +285 -71
- package/.6aspec/rules/brown/brown_explore_sop.md +314 -0
- package/.6aspec/rules/brown/brown_ff_sop.md +31 -18
- package/.6aspec/rules/brown/brown_impact_sop.md +101 -45
- package/.6aspec/rules/brown/brown_implement_sop.md +127 -43
- package/.6aspec/rules/brown/brown_list_sop.md +12 -12
- package/.6aspec/rules/brown/brown_new_sop.md +63 -38
- package/.6aspec/rules/brown/brown_proposal_sop.md +286 -76
- package/.6aspec/rules/brown/brown_quick_sop.md +5 -5
- package/.6aspec/rules/brown/brown_review_sop.md +4 -4
- package/.6aspec/rules/brown/brown_rollback_sop.md +29 -19
- package/.6aspec/rules/brown/brown_specs_sop.md +412 -120
- package/.6aspec/rules/brown/brown_status_sop.md +13 -3
- package/.6aspec/rules/brown/brown_tasks_sop.md +212 -83
- package/.6aspec/rules/brown/brown_understand_sop.md +111 -40
- package/.6aspec/rules/brown/brown_update_sop.md +287 -0
- package/.6aspec/rules/brown/brown_verify_sop.md +138 -58
- package/.6aspec/rules/green/{6A_archive_sop.md → green_archive_sop.md} +3 -3
- package/.6aspec/rules/green/{6A_clarify_sop.md → green_clarify_sop.md} +1 -1
- package/.6aspec/rules/green/{6A_code_implementation_sop.md → green_code_implementation_sop.md} +18 -3
- package/.6aspec/rules/green/{6A_continue_sop.md → green_continue_sop.md} +3 -3
- package/.6aspec/rules/green/{6A_new_sop.md → green_new_sop.md} +90 -11
- package/.6aspec/rules/green/green_status_schema.md +4 -4
- package/.6aspec/rules/green/{6A_status_sop.md → green_status_sop.md} +3 -3
- package/.6aspec/rules/green/{6A_tasks_sop.md → green_tasks_sop.md} +1 -1
- package/.claude/commands/6aspec/brown/explore.md +11 -0
- package/.claude/commands/6aspec/brown/update.md +11 -0
- package/.claude/commands/6aspec/code.md +10 -0
- package/.claude/commands/6aspec/green/archive.md +1 -1
- package/.claude/commands/6aspec/green/clarify.md +2 -2
- package/.claude/commands/6aspec/green/continue.md +1 -1
- package/.claude/commands/6aspec/green/design.md +2 -2
- package/.claude/commands/6aspec/green/{execute-task.md → implement.md} +1 -1
- package/.claude/commands/6aspec/green/import-model-table.md +1 -1
- package/.claude/commands/6aspec/green/init.md +2 -2
- package/.claude/commands/6aspec/green/model.md +2 -2
- package/.claude/commands/6aspec/green/new.md +2 -2
- package/.claude/commands/6aspec/green/rollback.md +1 -1
- package/.claude/commands/6aspec/green/status.md +1 -1
- package/.claude/commands/6aspec/green/tasks.md +2 -2
- package/.claude/commands/6aspec/green/visual-logic.md +2 -2
- package/.claude/commands/opsx/apply.md +152 -0
- package/.claude/commands/opsx/archive.md +157 -0
- package/.claude/commands/opsx/bulk-archive.md +242 -0
- package/.claude/commands/opsx/continue.md +114 -0
- package/.claude/commands/opsx/explore.md +174 -0
- package/.claude/commands/opsx/ff.md +94 -0
- package/.claude/commands/opsx/new.md +69 -0
- package/.claude/commands/opsx/onboard.md +525 -0
- package/.claude/commands/opsx/sync.md +134 -0
- package/.claude/commands/opsx/verify.md +164 -0
- package/.claude/settings.local.json +21 -1
- package/.cursor/commands/6aspec/brown/explore.md +11 -0
- package/.cursor/commands/6aspec/brown/update.md +9 -0
- package/.cursor/commands/6aspec/code.md +8 -0
- package/.cursor/commands/6aspec/green/archive.md +1 -1
- package/.cursor/commands/6aspec/green/clarify.md +2 -2
- package/.cursor/commands/6aspec/green/continue.md +1 -1
- package/.cursor/commands/6aspec/green/design.md +2 -2
- package/.cursor/commands/6aspec/green/{execute-task.md → implement.md} +1 -1
- package/.cursor/commands/6aspec/green/import-model-table.md +1 -1
- package/.cursor/commands/6aspec/green/init.md +2 -2
- package/.cursor/commands/6aspec/green/model.md +2 -2
- package/.cursor/commands/6aspec/green/new.md +2 -2
- package/.cursor/commands/6aspec/green/rollback.md +1 -1
- package/.cursor/commands/6aspec/green/status.md +1 -1
- package/.cursor/commands/6aspec/green/tasks.md +2 -2
- package/.cursor/commands/6aspec/green/visual-logic.md +2 -2
- package/.cursor/commands/opsx-apply.md +152 -0
- package/.cursor/commands/opsx-archive.md +157 -0
- package/.cursor/commands/opsx-bulk-archive.md +242 -0
- package/.cursor/commands/opsx-continue.md +114 -0
- package/.cursor/commands/opsx-explore.md +174 -0
- package/.cursor/commands/opsx-ff.md +94 -0
- package/.cursor/commands/opsx-new.md +69 -0
- package/.cursor/commands/opsx-onboard.md +525 -0
- package/.cursor/commands/opsx-sync.md +134 -0
- package/.cursor/commands/opsx-verify.md +164 -0
- package/README.md +1 -1
- package/bin/6aspec +17 -1
- package/lib/cli.js +1 -1
- package/package.json +1 -1
- /package/.6aspec/rules/green/{6A_constitution.md → green_constitution.md} +0 -0
- /package/.6aspec/rules/green/{6A_design_sop.md → green_design_sop.md} +0 -0
- /package/.6aspec/rules/green/{6A_import_model_table_sop.md → green_import_model_table_sop.md} +0 -0
- /package/.6aspec/rules/green/{6A_init_event_list_sop.md → green_init_event_list_sop.md} +0 -0
- /package/.6aspec/rules/green/{6A_init_map_sop.md → green_init_map_sop.md} +0 -0
- /package/.6aspec/rules/green/{6A_model_sop.md → green_model_sop.md} +0 -0
- /package/.6aspec/rules/green/{6A_rollback_sop.md → green_rollback_sop.md} +0 -0
- /package/.6aspec/rules/green/{6A_visual_logic_sop.md → green_visual_logic_sop.md} +0 -0
|
@@ -1,227 +1,519 @@
|
|
|
1
1
|
# 棕地需求 - Specs SOP
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
需求规格定义
|
|
4
4
|
|
|
5
5
|
**输入**:`/6aspec:brown:specs` 后可选需求名称。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
**适用流程**:轻量级、标准级、完整级
|
|
8
8
|
|
|
9
9
|
**步骤**
|
|
10
10
|
|
|
11
11
|
1. **选择需求并检查状态**
|
|
12
12
|
|
|
13
13
|
- 读取 `6aspecdoc/brown/<name>/status.json`
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
- 如果是 "lightweight",提示应该使用 `/6aspec:brown:proposal`
|
|
14
|
+
- 根据 `flowDepth` 检查前置阶段:
|
|
15
|
+
- **轻量级**:确认 `phases.proposal` 为 "done",如果未完成提示先运行 `/6aspec:brown:proposal`
|
|
16
|
+
- **标准级/完整级**:确认 `phases.impact` 为 "done",如果未完成提示先运行 `/6aspec:brown:impact`
|
|
18
17
|
|
|
19
18
|
2. **读取前置文档**
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
- `6aspecdoc/brown/<name>/artifacts/01-understanding.md`
|
|
20
|
+
根据 `flowDepth` 读取不同的前置文档:
|
|
23
21
|
|
|
24
|
-
|
|
22
|
+
**轻量级流程**:
|
|
23
|
+
- `6aspecdoc/brown/<name>/artifacts/proposal.md`
|
|
24
|
+
- `6aspecdoc/brown/<name>/explore-summary.md` - 探索摘要(如果存在)
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
**标准级/完整级流程**:
|
|
27
|
+
- `6aspecdoc/brown/<name>/artifacts/proposal.md`
|
|
28
|
+
- `6aspecdoc/brown/<name>/artifacts/understanding.md`
|
|
29
|
+
- `6aspecdoc/brown/<name>/artifacts/impact-analysis.md`
|
|
27
30
|
|
|
28
|
-
|
|
31
|
+
3. **读取问题答案(仅标准级/完整级)**
|
|
29
32
|
|
|
30
|
-
|
|
33
|
+
如果是标准级或完整级流程,从 understanding.md 中读取"待明确问题清单"及用户的答案:
|
|
31
34
|
|
|
32
|
-
|
|
35
|
+
- 检查问题清单中哪些问题已经有答案(标记为具体值而非"[待确认]")
|
|
36
|
+
- 如果有未回答的问题,提示用户这些问题需要明确,但不阻塞 specs 阶段
|
|
37
|
+
- 基于已有的答案和现状分析,开始定义需求规格
|
|
33
38
|
|
|
34
|
-
|
|
35
|
-
- FR-001: <功能描述>
|
|
36
|
-
- 输入:<输入内容>
|
|
37
|
-
- 输出:<输出内容>
|
|
38
|
-
- 业务规则:<业务规则>
|
|
39
|
-
- 验收标准:<验收标准>
|
|
39
|
+
注意:specs 阶段不再提出新问题,所有需求问题应该在 understand 阶段提出并收集。
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
|
|
41
|
+
4. **按需探索代码库(可选)**
|
|
42
|
+
|
|
43
|
+
**触发条件**:
|
|
44
|
+
- 需要了解现有字段定义、验证逻辑、Scenario实现方式
|
|
45
|
+
- 需要了解现有的非功能需求实现(如权限控制、性能优化)
|
|
46
|
+
- 用户明确要求探索(例如:"先了解一下现有实现")
|
|
47
|
+
- 信息不足,需要参考现有代码才能定义准确的需求规格
|
|
48
|
+
|
|
49
|
+
**探索方式**:
|
|
50
|
+
|
|
51
|
+
a. **简单搜索**(使用 Grep/Glob 工具):
|
|
52
|
+
|
|
53
|
+
- 搜索相关 Entity 类的字段定义:pattern = `private.*<字段名>`,type = `java`,glob = `*Entity.java`
|
|
54
|
+
- 搜索相关验证注解:pattern = `@NotNull|@NotEmpty|@Valid`,type = `java`,glob = `*Entity.java`
|
|
55
|
+
- 搜索现有的测试场景:pattern = `test.*<功能名>`,type = `java`,glob = `*Test.java`
|
|
56
|
+
|
|
57
|
+
b. **复杂探索**(使用Task工具调用Explore agent):
|
|
58
|
+
- 当需要深入理解现有架构模式时
|
|
59
|
+
- 当需要跨多个文件理解业务逻辑时
|
|
60
|
+
|
|
61
|
+
**探索结果处理**:
|
|
62
|
+
- 探索发现直接用于需求规格定义
|
|
63
|
+
- 不生成独立文档
|
|
64
|
+
- 在specs.md中可以标注"基于现有实现:<文件路径>"
|
|
65
|
+
|
|
66
|
+
**注意**:
|
|
67
|
+
- 探索是可选的,不是强制的
|
|
68
|
+
- 如果前置文档(proposal、understanding、impact)已经提供了足够信息,可以跳过探索
|
|
69
|
+
- 探索应该聚焦、快速,避免过度探索
|
|
70
|
+
|
|
71
|
+
5. **明确 Key Entities 和 Business Rules**
|
|
72
|
+
|
|
73
|
+
在定义功能需求之前,先从前置文档中识别业务对象和业务规则,作为后续需求定义的"词汇表"和"约束基础"。
|
|
74
|
+
|
|
75
|
+
**Key Entities(关键业务对象)**:
|
|
76
|
+
- 识别本次需求涉及的核心业务对象(不是数据库表,是业务概念)
|
|
77
|
+
- 明确每个实体的含义、关键属性口径、状态流转和与其他实体的关系
|
|
78
|
+
- 避免写数据库字段类型、类名等技术细节
|
|
79
|
+
|
|
80
|
+
**Business Rules(业务规则)**:
|
|
81
|
+
- 识别业务上必须成立的约束/推导规则(与实现无关)
|
|
82
|
+
- 按 Capability 分类组织,全局规则(跨 Capability)放在"通用规则"分类下
|
|
83
|
+
- 规则描述格式:条件 → 结果,或直接描述约束
|
|
84
|
+
|
|
85
|
+
**Business Rules 组织格式**:
|
|
86
|
+
```markdown
|
|
87
|
+
### 通用规则
|
|
88
|
+
- BR-001:<跨 Capability 的全局约束>
|
|
89
|
+
|
|
90
|
+
### Capability: <capability-name>
|
|
91
|
+
- BR-002:<该能力特有的约束>
|
|
92
|
+
- BR-003:<该能力特有的约束>
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
**注意**:
|
|
96
|
+
- 如果某个 Capability 没有特有规则,不需要单独列出
|
|
97
|
+
- 如果所有规则都是全局的,只写"通用规则"即可
|
|
98
|
+
- Business Rules 是业务约束,不是技术约束(技术约束放非功能需求)
|
|
99
|
+
|
|
100
|
+
6. **基于 Capabilities 定义功能需求**
|
|
101
|
+
|
|
102
|
+
从 proposal.md 中读取 Capabilities 列表,按 Capability 组织功能需求:
|
|
103
|
+
|
|
104
|
+
**功能需求格式**(按 Capability 组织):
|
|
105
|
+
```markdown
|
|
106
|
+
### Capability: <capability-name> [ADD/MODIFY/REMOVE]
|
|
107
|
+
|
|
108
|
+
<Capability 描述,说明这个能力是做什么的>
|
|
109
|
+
|
|
110
|
+
#### Requirement: <需求名称>
|
|
111
|
+
|
|
112
|
+
<需求描述,使用 SHALL/MUST 关键字表示强制性要求>
|
|
113
|
+
|
|
114
|
+
##### 验收标准
|
|
115
|
+
- AC1: <可观察、可验证的验收点>
|
|
116
|
+
- AC2: <可观察、可验证的验收点>
|
|
117
|
+
|
|
118
|
+
##### Scenario: <场景名称>
|
|
119
|
+
|
|
120
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
121
|
+
- **GIVEN** <前置条件(业务对象状态/权限/已有数据/开关等)>
|
|
122
|
+
- **WHEN** <触发动作>
|
|
123
|
+
- **THEN** <预期结果>
|
|
124
|
+
- **AND** <额外的预期结果>(可选)
|
|
125
|
+
|
|
126
|
+
##### Scenario: <另一个场景名称>
|
|
127
|
+
|
|
128
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
129
|
+
- **GIVEN** <前置条件>
|
|
130
|
+
- **WHEN** <触发动作>
|
|
131
|
+
- **THEN** <预期结果>
|
|
132
|
+
|
|
133
|
+
#### Requirement: <另一个需求名称>
|
|
134
|
+
|
|
135
|
+
<需求描述>
|
|
136
|
+
|
|
137
|
+
##### 验收标准
|
|
138
|
+
- AC1: <...>
|
|
139
|
+
|
|
140
|
+
##### Scenario: <场景名称>
|
|
141
|
+
|
|
142
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
143
|
+
- **GIVEN** <前置条件>
|
|
144
|
+
- **WHEN** <触发动作>
|
|
145
|
+
- **THEN** <预期结果>
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
**组织原则**:
|
|
149
|
+
- 每个 Capability 对应 proposal.md 中的一个能力
|
|
150
|
+
- 在 Capability 级别标识变更类型:[ADD](新增)、[MODIFY](修改)、[REMOVE](移除)
|
|
151
|
+
- 每个 Capability 下包含多个 Requirements
|
|
152
|
+
- 每个 Requirement 应该是独立的、可验证的
|
|
153
|
+
- 每个 Requirement SHOULD 显式列出验收标准(AC),用于快速评审覆盖面与边界
|
|
154
|
+
- 每个 Scenario MUST 包含:触发类型 + GIVEN/WHEN/THEN(AND 可选);触发类型只能从「用户操作|外部系统触发|事件订阅|定时任务」中选择
|
|
155
|
+
- 使用 SHALL/MUST 关键字表示强制性要求,SHOULD 表示推荐性要求
|
|
43
156
|
- 功能需求应该从用户视角描述(做什么,而不是怎么做)
|
|
44
157
|
- 避免技术实现细节(技术细节放在 design 阶段)
|
|
45
158
|
|
|
46
|
-
|
|
159
|
+
6. **定义非功能需求(可选)**
|
|
47
160
|
|
|
48
|
-
|
|
161
|
+
明确系统应该满足的质量标准。**注意:只写有明确要求的项,不要为了完整性而写空泛内容。**
|
|
49
162
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
-
|
|
163
|
+
**非功能需求格式**:
|
|
164
|
+
```markdown
|
|
165
|
+
### 性能需求
|
|
166
|
+
- 响应时间 SHALL < 200ms
|
|
167
|
+
- 并发量 SHALL 支持 1000+ QPS
|
|
54
168
|
|
|
55
|
-
|
|
169
|
+
### 安全需求
|
|
170
|
+
- 权限控制:只有管理员 SHALL 可以修改
|
|
171
|
+
- 数据加密:敏感数据 SHALL 加密存储
|
|
56
172
|
|
|
57
|
-
|
|
173
|
+
### 可用性需求
|
|
174
|
+
- 易用性:界面 SHOULD 符合团队 UI 规范
|
|
175
|
+
- 可维护性:代码 SHOULD 遵循现有架构模式
|
|
58
176
|
|
|
59
|
-
|
|
60
|
-
-
|
|
61
|
-
-
|
|
177
|
+
### 兼容性需求
|
|
178
|
+
- 浏览器:SHALL 支持 Chrome/Firefox/Safari 最新版本
|
|
179
|
+
- 数据库:SHALL 兼容现有数据库版本
|
|
180
|
+
```
|
|
62
181
|
|
|
63
|
-
|
|
64
|
-
-
|
|
65
|
-
-
|
|
66
|
-
-
|
|
182
|
+
**注意事项**:
|
|
183
|
+
- 使用 SHALL/MUST 表示强制性要求,SHOULD 表示推荐性要求
|
|
184
|
+
- 如果某个类别(如性能、安全)没有明确要求,可以省略该小节
|
|
185
|
+
- 避免写"遵循最佳实践"等空泛描述
|
|
67
186
|
|
|
68
|
-
7.
|
|
187
|
+
7. **定义范围边界(可选)**
|
|
69
188
|
|
|
70
|
-
|
|
189
|
+
明确做什么、不做什么,以及关键约束:
|
|
71
190
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
191
|
+
**范围边界格式**:
|
|
192
|
+
```markdown
|
|
193
|
+
## 1. 范围边界
|
|
194
|
+
|
|
195
|
+
**本次实现**:
|
|
196
|
+
- <明确包含的核心功能>
|
|
197
|
+
- <明确包含的核心功能>
|
|
198
|
+
|
|
199
|
+
**明确不包含**:
|
|
200
|
+
- <明确排除的功能或场景>
|
|
201
|
+
- <明确排除的功能或场景>
|
|
202
|
+
|
|
203
|
+
**关键约束**(可选):
|
|
204
|
+
- <技术约束:如必须使用某技术栈、兼容某版本>
|
|
205
|
+
- <业务约束:如必须满足某业务规则>
|
|
206
|
+
- <时间约束:如必须在某时间前完成>
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
**注意事项**:
|
|
210
|
+
- 范围边界用于明确需求边界,避免范围蔓延
|
|
211
|
+
- "本次实现"应该简洁列出核心功能点
|
|
212
|
+
- "明确不包含"用于排除容易混淆的功能
|
|
213
|
+
- "关键约束"只写有实际影响的约束,如果没有可以省略
|
|
214
|
+
- 如果范围已经很明确(如简单的 bug 修复),整个章节可以省略
|
|
75
215
|
|
|
76
216
|
8. **创建需求规格文档**
|
|
77
217
|
|
|
78
|
-
|
|
218
|
+
注意:Scenario 用于将关键验收路径以结构化方式表达(GIVEN/WHEN/THEN),但验收标准仍应显式列出,便于评审快速检查覆盖面与边界。
|
|
219
|
+
|
|
220
|
+
创建 `6aspecdoc/brown/<name>/artifacts/specs.md`:
|
|
79
221
|
```markdown
|
|
80
|
-
#
|
|
222
|
+
# 需求规格定义
|
|
81
223
|
|
|
82
224
|
> **需求**: <name>
|
|
83
|
-
>
|
|
225
|
+
> **基于提案**: proposal.md
|
|
226
|
+
> **流程**: <flowDepth>
|
|
227
|
+
> **阶段**: Specs
|
|
84
228
|
> **状态**: ✅ 已完成
|
|
85
229
|
> **完成时间**: <timestamp>
|
|
86
230
|
|
|
87
|
-
## 1.
|
|
231
|
+
## 1. 范围边界
|
|
232
|
+
|
|
233
|
+
**本次实现**:
|
|
234
|
+
- <明确包含的核心功能>
|
|
235
|
+
- <明确包含的核心功能>
|
|
236
|
+
|
|
237
|
+
**明确不包含**:
|
|
238
|
+
- <明确排除的功能或场景>
|
|
239
|
+
- <明确排除的功能或场景>
|
|
240
|
+
|
|
241
|
+
**关键约束**(可选):
|
|
242
|
+
- <技术约束:如必须使用某技术栈、兼容某版本>
|
|
243
|
+
- <业务约束:如必须满足某业务规则>
|
|
244
|
+
- <时间约束:如必须在某时间前完成>
|
|
245
|
+
|
|
246
|
+
## 2. Key Entities(关键业务对象)
|
|
247
|
+
|
|
248
|
+
> 轻量业务模型:描述业务对象的含义、关键属性口径、状态与关系;避免写数据库表/类/字段类型。
|
|
249
|
+
|
|
250
|
+
- **实体**:<实体名称>
|
|
251
|
+
- **定义**:<一句话定义>
|
|
252
|
+
- **关键属性**:<属性1口径>;<属性2口径>...
|
|
253
|
+
- **状态**(可选):<状态列表>
|
|
254
|
+
- **关系**(可选):<与其他实体的业务关系>
|
|
88
255
|
|
|
89
|
-
|
|
90
|
-
<为什么需要这个功能>
|
|
256
|
+
## 3. Business Rules(业务规则)
|
|
91
257
|
|
|
92
|
-
|
|
93
|
-
<谁用、什么时候用、怎么用>
|
|
258
|
+
> 业务上必须成立的约束/推导规则(与实现无关)。按 Capability 分类,跨 Capability 的全局规则放在"通用规则"下。
|
|
94
259
|
|
|
95
|
-
###
|
|
96
|
-
|
|
97
|
-
- <明确包含的功能>
|
|
260
|
+
### 通用规则
|
|
261
|
+
- BR-001:<跨 Capability 的全局约束>
|
|
98
262
|
|
|
99
|
-
|
|
100
|
-
-
|
|
263
|
+
### Capability: <capability-name>
|
|
264
|
+
- BR-002:<该能力特有的约束>
|
|
101
265
|
|
|
102
|
-
##
|
|
266
|
+
## 4. 功能需求
|
|
103
267
|
|
|
104
|
-
###
|
|
105
|
-
**描述**:<功能描述>
|
|
268
|
+
### Capability: <capability-name> [ADD]
|
|
106
269
|
|
|
107
|
-
|
|
108
|
-
- <输入内容>
|
|
270
|
+
<Capability 描述,说明这个能力是做什么的>
|
|
109
271
|
|
|
110
|
-
|
|
111
|
-
- <输出内容>
|
|
272
|
+
#### Requirement: <需求名称>
|
|
112
273
|
|
|
113
|
-
|
|
114
|
-
- <业务规则1>
|
|
115
|
-
- <业务规则2>
|
|
274
|
+
<需求描述,使用 SHALL/MUST 关键字表示强制性要求>
|
|
116
275
|
|
|
117
|
-
|
|
118
|
-
-
|
|
119
|
-
-
|
|
276
|
+
##### 验收标准
|
|
277
|
+
- AC1: <可观察、可验证的验收点>
|
|
278
|
+
- AC2: <可观察、可验证的验收点>
|
|
120
279
|
|
|
121
|
-
|
|
122
|
-
...
|
|
280
|
+
##### Scenario: <场景名称>
|
|
123
281
|
|
|
124
|
-
|
|
282
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
283
|
+
- **GIVEN** <前置条件(业务对象状态/权限/已有数据/开关等)>
|
|
284
|
+
- **WHEN** <触发动作>
|
|
285
|
+
- **THEN** <预期结果>
|
|
286
|
+
- **AND** <额外的预期结果>(可选)
|
|
125
287
|
|
|
126
|
-
|
|
127
|
-
- NFR-001: <性能要求>
|
|
288
|
+
##### Scenario: <另一个场景名称>
|
|
128
289
|
|
|
129
|
-
|
|
130
|
-
-
|
|
290
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
291
|
+
- **GIVEN** <前置条件>
|
|
292
|
+
- **WHEN** <触发动作>
|
|
293
|
+
- **THEN** <预期结果>
|
|
131
294
|
|
|
132
|
-
|
|
133
|
-
- NFR-003: <可用性要求>
|
|
295
|
+
#### Requirement: <另一个需求名称>
|
|
134
296
|
|
|
135
|
-
|
|
136
|
-
- NFR-004: <兼容性要求>
|
|
297
|
+
<需求描述>
|
|
137
298
|
|
|
138
|
-
|
|
299
|
+
##### 验收标准
|
|
300
|
+
- AC1: <...>
|
|
139
301
|
|
|
140
|
-
|
|
141
|
-
- <技术上的限制>
|
|
302
|
+
##### Scenario: <场景名称>
|
|
142
303
|
|
|
143
|
-
|
|
144
|
-
-
|
|
304
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
305
|
+
- **GIVEN** <前置条件>
|
|
306
|
+
- **WHEN** <触发动作>
|
|
307
|
+
- **THEN** <预期结果>
|
|
145
308
|
|
|
146
|
-
###
|
|
147
|
-
- <时间上的限制>
|
|
309
|
+
### Capability: <another-capability-name> [MODIFY]
|
|
148
310
|
|
|
149
|
-
|
|
311
|
+
<Capability 描述>
|
|
150
312
|
|
|
151
|
-
|
|
152
|
-
- AC-001: <功能验收标准>
|
|
153
|
-
- AC-002: <功能验收标准>
|
|
313
|
+
#### Requirement: <需求名称>
|
|
154
314
|
|
|
155
|
-
|
|
156
|
-
- AC-003: <非功能验收标准>
|
|
157
|
-
- AC-004: <非功能验收标准>
|
|
315
|
+
<需求描述>
|
|
158
316
|
|
|
159
|
-
|
|
160
|
-
-
|
|
317
|
+
##### 验收标准
|
|
318
|
+
- AC1: <...>
|
|
161
319
|
|
|
162
|
-
|
|
320
|
+
##### Scenario: <场景名称>
|
|
163
321
|
|
|
164
|
-
|
|
322
|
+
- **触发类型** 用户操作|外部系统触发|事件订阅|定时任务
|
|
323
|
+
- **GIVEN** <前置条件>
|
|
324
|
+
- **WHEN** <触发动作>
|
|
325
|
+
- **THEN** <预期结果>
|
|
165
326
|
|
|
166
|
-
##
|
|
327
|
+
## 5. 非功能需求
|
|
167
328
|
|
|
168
|
-
|
|
329
|
+
> **注意**:只写有明确要求的项,如果某个类别没有明确要求,可以省略该小节。
|
|
330
|
+
|
|
331
|
+
### 性能需求
|
|
332
|
+
- 响应时间 SHALL < <具体值>
|
|
333
|
+
- 并发量 SHALL 支持 <具体值>
|
|
334
|
+
|
|
335
|
+
### 安全需求
|
|
336
|
+
- 权限控制:<具体要求>
|
|
337
|
+
- 数据加密:<具体要求>
|
|
338
|
+
|
|
339
|
+
### 可用性需求
|
|
340
|
+
- 易用性:<具体要求>
|
|
341
|
+
- 可维护性:<具体要求>
|
|
342
|
+
|
|
343
|
+
### 兼容性需求
|
|
344
|
+
- 浏览器:SHALL 支持 <具体版本>
|
|
345
|
+
- 数据库:SHALL 兼容 <具体版本>
|
|
346
|
+
|
|
347
|
+
## 6. 下一步
|
|
348
|
+
|
|
349
|
+
运行 `/6aspec:brown:design` 进行技术方案设计
|
|
169
350
|
```
|
|
170
351
|
|
|
171
352
|
9. **更新状态**
|
|
172
353
|
|
|
173
354
|
更新 `6aspecdoc/brown/<name>/status.json`:
|
|
355
|
+
|
|
356
|
+
**轻量级流程**:
|
|
174
357
|
```json
|
|
175
358
|
{
|
|
176
|
-
"status": "
|
|
359
|
+
"status": "design_pending",
|
|
360
|
+
"flowDepth": "lightweight",
|
|
177
361
|
"phases": {
|
|
362
|
+
"proposal": "done",
|
|
363
|
+
"specs": "done",
|
|
364
|
+
"design": "pending",
|
|
365
|
+
"tasks": "blocked",
|
|
366
|
+
"implement": "blocked"
|
|
367
|
+
},
|
|
368
|
+
"artifacts": ["proposal.md", "specs.md"]
|
|
369
|
+
}
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
**标准级流程**:
|
|
373
|
+
```json
|
|
374
|
+
{
|
|
375
|
+
"status": "design_pending",
|
|
376
|
+
"flowDepth": "standard",
|
|
377
|
+
"phases": {
|
|
378
|
+
"proposal": "done",
|
|
379
|
+
"understand": "done",
|
|
380
|
+
"impact": "done",
|
|
381
|
+
"specs": "done",
|
|
382
|
+
"design": "pending",
|
|
383
|
+
"tasks": "blocked",
|
|
384
|
+
"implement": "blocked"
|
|
385
|
+
},
|
|
386
|
+
"artifacts": ["proposal.md", "understanding.md", "impact-analysis.md", "specs.md"]
|
|
387
|
+
}
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
**完整级流程**:
|
|
391
|
+
```json
|
|
392
|
+
{
|
|
393
|
+
"status": "design_pending",
|
|
394
|
+
"flowDepth": "complete",
|
|
395
|
+
"phases": {
|
|
396
|
+
"proposal": "done",
|
|
178
397
|
"understand": "done",
|
|
398
|
+
"impact": "done",
|
|
179
399
|
"specs": "done",
|
|
180
|
-
"
|
|
181
|
-
|
|
400
|
+
"design": "pending",
|
|
401
|
+
"tasks": "blocked",
|
|
402
|
+
"implement": "blocked",
|
|
403
|
+
"verify": "blocked",
|
|
404
|
+
"review": "blocked"
|
|
182
405
|
},
|
|
183
|
-
"artifacts": ["
|
|
406
|
+
"artifacts": ["proposal.md", "understanding.md", "impact-analysis.md", "specs.md"]
|
|
184
407
|
}
|
|
185
408
|
```
|
|
186
409
|
|
|
410
|
+
同时更新 `6aspecdoc/brown/<name>/requirement.md`:
|
|
411
|
+
- 更新"状态"字段为 `📋 Design 待开始`
|
|
412
|
+
- 更新"最后修改"时间戳为 `<timestamp>`
|
|
413
|
+
- 更新"当前阶段"为 `Specs - 需求规格定义(已完成)`
|
|
414
|
+
- 更新"下一步操作"为 `运行 /6aspec:brown:design 继续下一阶段`
|
|
415
|
+
- 在"进度概览"中标记 Specs 阶段为已完成 `[x]`
|
|
416
|
+
|
|
187
417
|
**输出**
|
|
188
418
|
|
|
419
|
+
根据 `flowDepth` 显示不同的输出信息:
|
|
420
|
+
|
|
421
|
+
**轻量级流程**:
|
|
422
|
+
```
|
|
423
|
+
## Specs 完成:<name>
|
|
424
|
+
|
|
425
|
+
**流程**: 轻量级
|
|
426
|
+
**进度**: 2/5 阶段完成
|
|
427
|
+
|
|
428
|
+
### 需求概要
|
|
429
|
+
- Capabilities:<数量> 个能力
|
|
430
|
+
- Requirements:<数量> 个需求
|
|
431
|
+
- Scenarios:<数量> 个测试场景
|
|
432
|
+
- 非功能需求:<数量> 项
|
|
433
|
+
|
|
434
|
+
### 核心 Capabilities
|
|
435
|
+
<列出 2-3 个核心 Capability 及其变更类型(ADD/MODIFY/REMOVE)>
|
|
436
|
+
|
|
437
|
+
### 文档位置
|
|
438
|
+
6aspecdoc/brown/<name>/artifacts/specs.md
|
|
439
|
+
|
|
440
|
+
### 下一步
|
|
441
|
+
- 直接回复补充或修正需求规格 → 我会更新本阶段文档(specs.md)
|
|
442
|
+
- 运行 `/6aspec:brown:design` → 进入技术方案设计阶段
|
|
443
|
+
- 运行 `/6aspec:brown:continue` → 自动进入下一阶段
|
|
444
|
+
```
|
|
445
|
+
|
|
446
|
+
**标准级流程**:
|
|
189
447
|
```
|
|
190
|
-
##
|
|
448
|
+
## Specs 完成:<name>
|
|
191
449
|
|
|
192
|
-
|
|
193
|
-
**进度**:
|
|
450
|
+
**流程**: 标准级
|
|
451
|
+
**进度**: 4/6 阶段完成
|
|
194
452
|
|
|
195
453
|
### 需求概要
|
|
196
|
-
-
|
|
197
|
-
-
|
|
198
|
-
-
|
|
454
|
+
- Capabilities:<数量> 个能力
|
|
455
|
+
- Requirements:<数量> 个需求
|
|
456
|
+
- Scenarios:<数量> 个测试场景
|
|
457
|
+
- 非功能需求:<数量> 项
|
|
458
|
+
|
|
459
|
+
### 核心 Capabilities
|
|
460
|
+
<列出 2-3 个核心 Capability 及其变更类型(ADD/MODIFY/REMOVE)>
|
|
461
|
+
|
|
462
|
+
### 文档位置
|
|
463
|
+
6aspecdoc/brown/<name>/artifacts/specs.md
|
|
464
|
+
|
|
465
|
+
### 下一步
|
|
466
|
+
- 直接回复补充或修正需求规格 → 我会更新本阶段文档(specs.md)
|
|
467
|
+
- 运行 `/6aspec:brown:design` → 进入技术方案设计阶段
|
|
468
|
+
- 运行 `/6aspec:brown:continue` → 自动进入下一阶段
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
**完整级流程**:
|
|
472
|
+
```
|
|
473
|
+
## Specs 完成:<name>
|
|
474
|
+
|
|
475
|
+
**流程**: 完整级
|
|
476
|
+
**进度**: 4/8 阶段完成
|
|
199
477
|
|
|
200
|
-
###
|
|
201
|
-
|
|
478
|
+
### 需求概要
|
|
479
|
+
- Capabilities:<数量> 个能力
|
|
480
|
+
- Requirements:<数量> 个需求
|
|
481
|
+
- Scenarios:<数量> 个测试场景
|
|
482
|
+
- 非功能需求:<数量> 项
|
|
202
483
|
|
|
203
|
-
###
|
|
204
|
-
<列出
|
|
484
|
+
### 核心 Capabilities
|
|
485
|
+
<列出 2-3 个核心 Capability 及其变更类型(ADD/MODIFY/REMOVE)>
|
|
205
486
|
|
|
206
487
|
### 文档位置
|
|
207
|
-
6aspecdoc/brown/<name>/artifacts/
|
|
488
|
+
6aspecdoc/brown/<name>/artifacts/specs.md
|
|
208
489
|
|
|
209
490
|
### 下一步
|
|
210
|
-
- 直接回复补充或修正需求规格 → 我会更新本阶段文档(
|
|
211
|
-
- 运行 `/6aspec:brown:
|
|
491
|
+
- 直接回复补充或修正需求规格 → 我会更新本阶段文档(specs.md)
|
|
492
|
+
- 运行 `/6aspec:brown:design` → 进入技术方案设计阶段
|
|
212
493
|
- 运行 `/6aspec:brown:continue` → 自动进入下一阶段
|
|
213
494
|
```
|
|
214
495
|
|
|
215
496
|
**用户补充信息时的处理**
|
|
216
497
|
|
|
217
|
-
|
|
218
|
-
1. 将用户的补充整合到 `
|
|
498
|
+
当用户补充需求细节、修正功能需求时(未使用阶段命令):
|
|
499
|
+
1. 将用户的补充整合到 `specs.md` 的对应章节(功能需求、非功能需求、验收标准等)
|
|
219
500
|
2. 展示变更摘要
|
|
220
501
|
3. 再次提示:可以继续补充,或通过命令进入下一阶段
|
|
221
502
|
4. **禁止**:不得自动进入下一阶段
|
|
222
503
|
|
|
223
504
|
**防护措施**
|
|
224
|
-
-
|
|
225
|
-
-
|
|
505
|
+
- 适用于所有流程(轻量级、标准级、完整级)
|
|
506
|
+
- 根据flowDepth检查不同的前置阶段:
|
|
507
|
+
- 轻量级:必须先完成proposal阶段
|
|
508
|
+
- 标准级/完整级:必须先完成impact阶段
|
|
509
|
+
- 功能需求必须按 Capability 组织,结构为:Capability > Requirement > Scenario
|
|
510
|
+
- 每个 Capability 必须标识变更类型:[ADD](新增)、[MODIFY](修改)、[REMOVE](移除)
|
|
511
|
+
- 每个 Capability 应该对应 proposal.md 中的一个能力
|
|
512
|
+
- 功能需求必须使用 Requirement + Scenario (WHEN/THEN) 格式
|
|
513
|
+
- 每个 Scenario 的触发类型只能从「用户操作|外部系统触发|事件订阅|定时任务」中选择
|
|
514
|
+
- 使用 SHALL/MUST 表示强制性要求,SHOULD 表示推荐性要求
|
|
515
|
+
- 每个 Scenario 必须可测试、可验证
|
|
226
516
|
- 功能需求必须从用户视角描述,避免技术实现细节
|
|
227
|
-
-
|
|
517
|
+
- 需求问题的答案应该体现在功能需求定义中,而不是单独列出
|
|
518
|
+
- 非功能需求和范围边界只写有明确要求的内容,避免空泛描述
|
|
519
|
+
- specs的详细程度保持一致,不区分流程深度
|