@zeyue0329/xiaoma-cli 1.0.20 → 1.0.22
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/XIAOMA-CLI/345/267/245/344/275/234/346/265/201/344/270/216/346/231/272/350/203/275/344/275/223/347/274/226/346/216/222/350/257/246/347/273/206/346/226/207/346/241/243.md +18 -18
- package/XIAOMA-CLI/346/231/272/350/203/275/344/275/223/344/270/216/345/221/275/344/273/244/345/256/214/346/225/264/346/226/207/346/241/243.md +5 -5
- package/dist/agents/analyst.txt +1 -1
- package/dist/agents/architect.txt +5 -5
- package/dist/agents/automation-orchestrator.txt +396 -0
- package/dist/agents/database-architect.txt +1 -1
- package/dist/agents/pm.txt +7 -7
- package/dist/agents/po.txt +1 -1
- package/dist/agents/sm.txt +1395 -0
- package/dist/agents/xiaoma-master.txt +11 -11
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +1 -1
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +1 -1
- package/dist/teams/team-all.txt +1766 -15
- package/dist/teams/team-fullstack-with-database.txt +2116 -22
- package/dist/teams/team-fullstack.txt +14 -14
- package/dist/teams/team-ide-minimal.txt +1396 -1
- package/dist/teams/team-no-ui.txt +14 -14
- package/package.json +1 -1
- package/tools/installer/package.json +1 -1
- package/xiaoma-core/agent-teams/team-fullstack-with-database.yaml +3 -1
- package/xiaoma-core/agents/analyst.md +1 -1
- package/xiaoma-core/agents/automation-orchestrator.md +353 -0
- package/xiaoma-core/agents/database-architect.md +1 -1
- package/xiaoma-core/agents/pm.md +1 -1
- package/xiaoma-core/agents/po.md +1 -1
- package/xiaoma-core/agents/sm.md +4 -0
- package/xiaoma-core/checklists/dev-completion-checklist.md +324 -0
- package/xiaoma-core/checklists/po-story-validation-checklist.md +219 -0
- package/xiaoma-core/checklists/qa-approval-checklist.md +393 -0
- package/xiaoma-core/tasks/automated-story-cycle.md +370 -0
- package/xiaoma-core/tasks/create-database-design.md +2 -2
- package/xiaoma-core/tasks/create-enhanced-story-with-database.md +250 -0
- package/xiaoma-core/templates/api-design-tmpl.yaml +704 -0
- package/xiaoma-core/templates/brownfield-architecture-tmpl.yaml +5 -5
- package/xiaoma-core/templates/brownfield-prd-tmpl.yaml +6 -6
- package/xiaoma-core/templates/enhanced-story-with-database-tmpl.yaml +428 -0
- package/xiaoma-core/workflows/automated-story-development.yaml +331 -0
- package/xiaoma-core/workflows/enhanced-fullstack-with-database.yaml +13 -6
- package//346/225/260/346/215/256/345/272/223/350/256/276/350/256/241/345/242/236/345/274/272/345/212/237/350/203/275/344/275/277/347/224/250/346/214/207/345/215/227.md +1 -1
- package//350/207/252/345/212/250/345/214/226/347/224/250/346/210/267/346/225/205/344/272/213/345/274/200/345/217/221/346/265/201/347/250/213/344/275/277/347/224/250/346/214/207/345/215/227.md +377 -0
|
@@ -0,0 +1,377 @@
|
|
|
1
|
+
# XIAOMA-CLI™ 自动化用户故事开发流程使用指南
|
|
2
|
+
|
|
3
|
+
## 概述
|
|
4
|
+
|
|
5
|
+
本文档详细介绍如何使用XIAOMA-CLI™框架的自动化用户故事开发流程,实现从用户故事创建到QA验收的完全自动化开发循环。
|
|
6
|
+
|
|
7
|
+
## 🚀 新增功能特性
|
|
8
|
+
|
|
9
|
+
### 1. 自动化流程编排器 (automation-orchestrator)
|
|
10
|
+
|
|
11
|
+
- **角色**: 自动化开发流程编排器和质量控制中心
|
|
12
|
+
- **图标**: 🤖
|
|
13
|
+
- **专长**: 流程自动化、质量门控、状态管理、智能体协调
|
|
14
|
+
|
|
15
|
+
### 2. 完整的自动化开发循环
|
|
16
|
+
|
|
17
|
+
- **故事创建**: SM智能体使用增强模板创建详细用户故事
|
|
18
|
+
- **故事验证**: PO智能体严格验证业务需求和技术可行性
|
|
19
|
+
- **代码开发**: Dev智能体实现功能并进行全面自测
|
|
20
|
+
- **QA测试**: QA智能体进行全面的测试验证
|
|
21
|
+
- **状态管理**: 自动化的状态转换和质量门控
|
|
22
|
+
|
|
23
|
+
### 3. 严格的质量控制
|
|
24
|
+
|
|
25
|
+
- **每个阶段都有明确的通过标准**
|
|
26
|
+
- **自动化的质量检查和验证**
|
|
27
|
+
- **问题自动识别和修复机制**
|
|
28
|
+
- **完整的进度跟踪和报告**
|
|
29
|
+
|
|
30
|
+
## 🎯 自动化流程详细说明
|
|
31
|
+
|
|
32
|
+
### 流程概览
|
|
33
|
+
|
|
34
|
+
```mermaid
|
|
35
|
+
graph TD
|
|
36
|
+
A[开始自动化开发] --> B[SM: 创建增强用户故事]
|
|
37
|
+
B --> C{故事质量验证}
|
|
38
|
+
C -->|失败| B
|
|
39
|
+
C -->|通过| D[PO: 验证故事草稿]
|
|
40
|
+
D --> E{业务需求验证}
|
|
41
|
+
E -->|失败| F[修复故事]
|
|
42
|
+
F --> D
|
|
43
|
+
E -->|通过| G[状态: Draft → Approved]
|
|
44
|
+
G --> H[Dev: 开发用户故事]
|
|
45
|
+
H --> I[实现数据库层]
|
|
46
|
+
I --> J[实现业务逻辑]
|
|
47
|
+
J --> K[实现API接口]
|
|
48
|
+
K --> L[编写测试代码]
|
|
49
|
+
L --> M[Dev: 运行自测]
|
|
50
|
+
M --> N{自测结果}
|
|
51
|
+
N -->|失败| O[修复代码]
|
|
52
|
+
O --> M
|
|
53
|
+
N -->|通过| P[状态: Approved → Review]
|
|
54
|
+
P --> Q[QA: 测试验证]
|
|
55
|
+
Q --> R{QA测试结果}
|
|
56
|
+
R -->|失败| S[报告问题给Dev]
|
|
57
|
+
S --> T[状态: Review → InProgress]
|
|
58
|
+
T --> H
|
|
59
|
+
R -->|通过| U[状态: Review → Done]
|
|
60
|
+
U --> V{还有待开发故事?}
|
|
61
|
+
V -->|是| B
|
|
62
|
+
V -->|否| W[🎉 完成所有开发]
|
|
63
|
+
|
|
64
|
+
style B fill:#FFE4B5
|
|
65
|
+
style D fill:#ADD8E6
|
|
66
|
+
style H fill:#98FB98
|
|
67
|
+
style Q fill:#DDA0DD
|
|
68
|
+
style W fill:#90EE90
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 用户故事状态定义
|
|
72
|
+
|
|
73
|
+
| 状态 | 含义 | 负责方 | 转换条件 |
|
|
74
|
+
| ---------- | -------------------- | -------- | ---------------------------- |
|
|
75
|
+
| Draft | 故事已创建,等待验证 | SM | 故事格式和内容验证通过 |
|
|
76
|
+
| Approved | 故事已验证,可以开发 | PO | 业务需求和技术可行性验证通过 |
|
|
77
|
+
| InProgress | 正在开发中 | Dev | 开发工作进行中 |
|
|
78
|
+
| Review | 开发完成,等待测试 | Dev → QA | 开发自测全部通过 |
|
|
79
|
+
| Done | 所有工作完成 | QA | QA测试验证全部通过 |
|
|
80
|
+
|
|
81
|
+
## 🛠️ 使用方法
|
|
82
|
+
|
|
83
|
+
### 方法1: 启动完全自动化流程
|
|
84
|
+
|
|
85
|
+
**适用场景**: 需要批量开发多个用户故事,希望完全自动化
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
# 1. 切换到自动化编排器
|
|
89
|
+
*agent automation-orchestrator
|
|
90
|
+
|
|
91
|
+
# 2. 启动自动化开发流程
|
|
92
|
+
*start-auto-development
|
|
93
|
+
|
|
94
|
+
# 流程将自动执行:
|
|
95
|
+
# SM创建故事 → PO验证 → Dev开发 → QA测试 → 循环直到完成
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 方法2: 手动执行单个开发循环
|
|
99
|
+
|
|
100
|
+
**适用场景**: 希望对每个故事进行精确控制
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# 1. 切换到自动化编排器
|
|
104
|
+
*agent automation-orchestrator
|
|
105
|
+
|
|
106
|
+
# 2. 手动执行单个故事循环
|
|
107
|
+
*execute-story-cycle
|
|
108
|
+
|
|
109
|
+
# 每个循环包含完整的 SM → PO → Dev → QA 流程
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 方法3: 分步骤手动控制 (原有方式)
|
|
113
|
+
|
|
114
|
+
**适用场景**: 希望完全手动控制每个步骤
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
# 阶段1: 创建用户故事
|
|
118
|
+
*agent sm
|
|
119
|
+
*draft-enhanced
|
|
120
|
+
|
|
121
|
+
# 阶段2: 验证故事
|
|
122
|
+
*agent po
|
|
123
|
+
*validate-story-draft {story_file}
|
|
124
|
+
|
|
125
|
+
# 阶段3: 开发实现
|
|
126
|
+
*agent dev
|
|
127
|
+
*develop-story
|
|
128
|
+
*run-tests
|
|
129
|
+
|
|
130
|
+
# 阶段4: QA测试
|
|
131
|
+
*agent qa
|
|
132
|
+
*review {story_file}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## 📋 质量门控标准
|
|
136
|
+
|
|
137
|
+
### 故事创建质量门控
|
|
138
|
+
|
|
139
|
+
**必须满足的条件**:
|
|
140
|
+
|
|
141
|
+
- ✅ 故事格式符合增强模板要求
|
|
142
|
+
- ✅ 数据库实体映射完整准确
|
|
143
|
+
- ✅ API接口规范详细完整
|
|
144
|
+
- ✅ 请求响应示例具体明确
|
|
145
|
+
- ✅ 验收标准清晰可测试
|
|
146
|
+
- ✅ 任务分解合理可执行
|
|
147
|
+
|
|
148
|
+
### 故事验证质量门控
|
|
149
|
+
|
|
150
|
+
**必须满足的条件**:
|
|
151
|
+
|
|
152
|
+
- ✅ 与PRD业务需求完全对齐
|
|
153
|
+
- ✅ 技术实现方案可行
|
|
154
|
+
- ✅ 验收标准可验证
|
|
155
|
+
- ✅ 故事规模适当(一个迭代内完成)
|
|
156
|
+
- ✅ 依赖关系明确
|
|
157
|
+
|
|
158
|
+
### 开发完成质量门控
|
|
159
|
+
|
|
160
|
+
**必须满足的条件**:
|
|
161
|
+
|
|
162
|
+
- ✅ 所有功能需求已实现
|
|
163
|
+
- ✅ 单元测试覆盖率 ≥ 80%
|
|
164
|
+
- ✅ 集成测试全部通过
|
|
165
|
+
- ✅ API接口功能正常
|
|
166
|
+
- ✅ 数据库操作正确
|
|
167
|
+
- ✅ 代码质量达标
|
|
168
|
+
|
|
169
|
+
### QA验收质量门控
|
|
170
|
+
|
|
171
|
+
**必须满足的条件**:
|
|
172
|
+
|
|
173
|
+
- ✅ 所有验收标准满足
|
|
174
|
+
- ✅ 功能测试全部通过
|
|
175
|
+
- ✅ API契约测试通过
|
|
176
|
+
- ✅ 数据完整性验证通过
|
|
177
|
+
- ✅ 性能要求满足
|
|
178
|
+
- ✅ 安全测试通过
|
|
179
|
+
|
|
180
|
+
## 🔧 智能体命令详解
|
|
181
|
+
|
|
182
|
+
### automation-orchestrator 智能体
|
|
183
|
+
|
|
184
|
+
| 命令 | 功能 | 使用场景 |
|
|
185
|
+
| --------------------------------------- | ---------------------- | ---------------- |
|
|
186
|
+
| `*start-auto-development` | 启动完全自动化开发流程 | 批量开发多个故事 |
|
|
187
|
+
| `*execute-story-cycle` | 执行单个故事开发循环 | 单个故事精确控制 |
|
|
188
|
+
| `*validate-quality-gate <stage>` | 验证特定阶段质量门控 | 质量检查 |
|
|
189
|
+
| `*manage-story-status <story> <action>` | 管理故事状态转换 | 状态管理 |
|
|
190
|
+
| `*generate-progress-report` | 生成开发进度报告 | 进度跟踪 |
|
|
191
|
+
| `*check-completion-status` | 检查整体完成状态 | 项目完成度评估 |
|
|
192
|
+
|
|
193
|
+
### sm 智能体 (增强版)
|
|
194
|
+
|
|
195
|
+
| 命令 | 功能 | 说明 |
|
|
196
|
+
| ----------------- | ------------------ | ----------------------------- |
|
|
197
|
+
| `*draft-enhanced` | 创建增强版用户故事 | 包含数据库和API设计的详细故事 |
|
|
198
|
+
| `*draft` | 创建标准用户故事 | 原有的标准故事模板 |
|
|
199
|
+
|
|
200
|
+
### po 智能体 (增强版)
|
|
201
|
+
|
|
202
|
+
| 命令 | 功能 | 说明 |
|
|
203
|
+
| ------------------------------- | ------------ | ---------------------------- |
|
|
204
|
+
| `*validate-story-draft {story}` | 验证故事草稿 | 使用增强验证清单进行全面检查 |
|
|
205
|
+
|
|
206
|
+
### dev 智能体 (增强版)
|
|
207
|
+
|
|
208
|
+
| 命令 | 功能 | 说明 |
|
|
209
|
+
| ---------------- | ------------ | --------------------------- |
|
|
210
|
+
| `*develop-story` | 开发用户故事 | 实现完整的数据库+业务+API层 |
|
|
211
|
+
| `*run-tests` | 运行自测 | 全面的单元测试和集成测试 |
|
|
212
|
+
|
|
213
|
+
### qa 智能体 (增强版)
|
|
214
|
+
|
|
215
|
+
| 命令 | 功能 | 说明 |
|
|
216
|
+
| ----------------- | ---------- | ---------------------------- |
|
|
217
|
+
| `*review {story}` | QA测试验收 | 使用增强验收清单进行全面测试 |
|
|
218
|
+
|
|
219
|
+
## 📊 进度跟踪和报告
|
|
220
|
+
|
|
221
|
+
### 实时进度监控
|
|
222
|
+
|
|
223
|
+
系统自动跟踪以下指标:
|
|
224
|
+
|
|
225
|
+
- **故事状态分布**: Draft, Approved, InProgress, Review, Done
|
|
226
|
+
- **开发效率**: 每个故事的开发周期时间
|
|
227
|
+
- **质量指标**: 缺陷率、返工率、测试通过率
|
|
228
|
+
- **团队协作**: 智能体间协作效率
|
|
229
|
+
|
|
230
|
+
### 自动生成报告
|
|
231
|
+
|
|
232
|
+
- **每日进度报告**: `docs/reports/daily-progress-{date}.md`
|
|
233
|
+
- **质量指标报告**: `docs/reports/quality-metrics.md`
|
|
234
|
+
- **完成度报告**: `docs/reports/completion-summary.md`
|
|
235
|
+
|
|
236
|
+
## 🚨 错误处理和恢复
|
|
237
|
+
|
|
238
|
+
### 自动重试机制
|
|
239
|
+
|
|
240
|
+
- **故事创建失败**: 最多重试3次
|
|
241
|
+
- **验证失败**: 返回修复后重新验证
|
|
242
|
+
- **开发失败**: 最多尝试5次修复
|
|
243
|
+
- **QA失败**: 返回开发阶段修复
|
|
244
|
+
|
|
245
|
+
### 升级机制
|
|
246
|
+
|
|
247
|
+
- **连续失败**: 超过重试次数后升级到项目经理
|
|
248
|
+
- **重大问题**: 架构设计问题升级到架构师
|
|
249
|
+
- **阻塞问题**: 外部依赖问题升级到产品经理
|
|
250
|
+
|
|
251
|
+
### 人工介入点
|
|
252
|
+
|
|
253
|
+
- **质量门控失败**: 人工review和决策
|
|
254
|
+
- **技术难题**: 人工技术支持
|
|
255
|
+
- **业务变更**: 人工需求澄清
|
|
256
|
+
|
|
257
|
+
## 📝 最佳实践建议
|
|
258
|
+
|
|
259
|
+
### 前置准备
|
|
260
|
+
|
|
261
|
+
1. **确保数据库设计完成**: `docs/database/database-design.md`
|
|
262
|
+
2. **生成基础代码框架**: 实体类、Mapper接口等
|
|
263
|
+
3. **准备测试环境**: 数据库、中间件、配置等
|
|
264
|
+
4. **Epic分解完成**: 用户故事列表清晰
|
|
265
|
+
|
|
266
|
+
### 流程优化
|
|
267
|
+
|
|
268
|
+
1. **批量处理**: 对于类似功能的故事可以批量处理
|
|
269
|
+
2. **并行开发**: 无依赖的故事可以并行开发
|
|
270
|
+
3. **预检查**: 在开始前验证所有前置条件
|
|
271
|
+
4. **快速反馈**: 问题发现后立即修复
|
|
272
|
+
|
|
273
|
+
### 质量保证
|
|
274
|
+
|
|
275
|
+
1. **严格门控**: 不满足质量标准的坚决不通过
|
|
276
|
+
2. **完整测试**: 确保测试覆盖所有场景
|
|
277
|
+
3. **文档同步**: 代码实现与文档保持一致
|
|
278
|
+
4. **持续改进**: 基于反馈不断优化流程
|
|
279
|
+
|
|
280
|
+
## 🔍 故障排除
|
|
281
|
+
|
|
282
|
+
### 常见问题
|
|
283
|
+
|
|
284
|
+
**问题1: 故事创建质量不达标**
|
|
285
|
+
|
|
286
|
+
- **现象**: 反复创建失败
|
|
287
|
+
- **解决**: 检查Epic质量,确保需求描述清晰
|
|
288
|
+
- **预防**: 提升Epic分解质量
|
|
289
|
+
|
|
290
|
+
**问题2: PO验证反复失败**
|
|
291
|
+
|
|
292
|
+
- **现象**: 业务需求不匹配
|
|
293
|
+
- **解决**: 澄清PRD需求,调整故事内容
|
|
294
|
+
- **预防**: 加强PRD质量控制
|
|
295
|
+
|
|
296
|
+
**问题3: 开发自测不通过**
|
|
297
|
+
|
|
298
|
+
- **现象**: 测试覆盖率不足或测试失败
|
|
299
|
+
- **解决**: 补充测试用例,修复代码问题
|
|
300
|
+
- **预防**: 提升开发代码质量
|
|
301
|
+
|
|
302
|
+
**问题4: QA测试反复失败**
|
|
303
|
+
|
|
304
|
+
- **现象**: 功能不满足验收标准
|
|
305
|
+
- **解决**: 详细分析验收标准,修复功能缺陷
|
|
306
|
+
- **预防**: 加强开发阶段的需求理解
|
|
307
|
+
|
|
308
|
+
### 性能优化
|
|
309
|
+
|
|
310
|
+
**数据库操作优化**:
|
|
311
|
+
|
|
312
|
+
- 使用批量操作
|
|
313
|
+
- 优化查询语句
|
|
314
|
+
- 合理使用索引
|
|
315
|
+
- 避免N+1查询
|
|
316
|
+
|
|
317
|
+
**API性能优化**:
|
|
318
|
+
|
|
319
|
+
- 合理的响应时间控制
|
|
320
|
+
- 适当的缓存策略
|
|
321
|
+
- 数据传输优化
|
|
322
|
+
- 并发处理优化
|
|
323
|
+
|
|
324
|
+
## 📖 使用示例
|
|
325
|
+
|
|
326
|
+
### 示例1: 用户注册功能自动化开发
|
|
327
|
+
|
|
328
|
+
```bash
|
|
329
|
+
# 1. 启动自动化流程
|
|
330
|
+
*agent automation-orchestrator
|
|
331
|
+
*start-auto-development
|
|
332
|
+
|
|
333
|
+
# 系统自动执行:
|
|
334
|
+
# ✅ SM创建"用户注册"故事 (包含users表设计和API规范)
|
|
335
|
+
# ✅ PO验证业务需求和技术可行性
|
|
336
|
+
# ✅ Dev实现Entity、Service、Controller层代码
|
|
337
|
+
# ✅ Dev运行单元测试和集成测试
|
|
338
|
+
# ✅ QA执行功能测试、API测试、安全测试
|
|
339
|
+
# ✅ 故事状态变更为Done
|
|
340
|
+
|
|
341
|
+
# 2. 自动进入下一个故事开发循环
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### 示例2: 产品管理功能批量开发
|
|
345
|
+
|
|
346
|
+
```bash
|
|
347
|
+
# 1. 批量开发产品相关的多个故事
|
|
348
|
+
*agent automation-orchestrator
|
|
349
|
+
*start-auto-development
|
|
350
|
+
|
|
351
|
+
# 系统将依次自动开发:
|
|
352
|
+
# - 产品创建功能 (products表设计 + CRUD API)
|
|
353
|
+
# - 产品分类功能 (categories表设计 + 关联API)
|
|
354
|
+
# - 产品搜索功能 (搜索API + 性能优化)
|
|
355
|
+
# - 产品评价功能 (reviews表设计 + 评价API)
|
|
356
|
+
|
|
357
|
+
# 每个故事都经过完整的质量门控验证
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
## 🎉 总结
|
|
361
|
+
|
|
362
|
+
通过XIAOMA-CLI™的自动化用户故事开发流程,你可以:
|
|
363
|
+
|
|
364
|
+
1. **显著提升开发效率**: 自动化的流程减少了人工协调时间
|
|
365
|
+
2. **保证开发质量**: 严格的质量门控确保每个环节都达标
|
|
366
|
+
3. **降低沟通成本**: 标准化的流程减少了团队间的沟通成本
|
|
367
|
+
4. **提高交付可靠性**: 完整的测试验证确保交付质量
|
|
368
|
+
|
|
369
|
+
现在你可以专注于业务逻辑的实现,而将流程管理和质量控制交给自动化系统!
|
|
370
|
+
|
|
371
|
+
---
|
|
372
|
+
|
|
373
|
+
**版本信息**:
|
|
374
|
+
|
|
375
|
+
- 版本:2.0.0
|
|
376
|
+
- 更新日期:2024年
|
|
377
|
+
- 作者:Automation Enhancement Team
|