@zeyue0329/xiaoma-cli 1.0.7 → 1.0.8

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.
@@ -0,0 +1,977 @@
1
+ # XiaoMa-Web 多智能体 0-1 项目开发完整指南
2
+
3
+ 基于 XiaoMa-Web 通用 AI 代理框架的详细开发流程,从零开始创建项目到完整交付的每一步操作指南。
4
+
5
+ ## 🚀 前置准备
6
+
7
+ ### 环境初始化
8
+ ```bash
9
+ # 1. 创建新项目目录
10
+ mkdir my-project && cd my-project
11
+
12
+ # 2. 初始化 npm 项目
13
+ npm init -y
14
+
15
+ # 3. 安装 XiaoMa-Web 框架
16
+ npx xiaoma-web install
17
+ # 或者使用 npm 命令
18
+ npm run install:xiaoma
19
+
20
+ # 4. 验证安装成功
21
+ npm run list:agents
22
+ # 预期输出:显示所有可用的智能体列表
23
+
24
+ # 5. 创建必要的目录结构
25
+ mkdir -p docs/prd docs/architecture docs/stories
26
+ ```
27
+
28
+ **成功标准**:
29
+ - ✅ 项目根目录下生成 `.xiaoma/` 配置目录
30
+ - ✅ `npm run list:agents` 命令能正常显示智能体列表
31
+ - ✅ docs 目录结构创建完成
32
+
33
+ ## 🎯 总体架构
34
+
35
+ **双阶段开发模式**:
36
+ - **规划阶段**(Web UI):需求分析、产品设计、技术架构
37
+ - **开发阶段**(IDE):敏捷开发、代码实现、测试验收
38
+
39
+ **核心智能体及其职责**:
40
+ - `analyst`:业务分析师,负责需求调研和项目概要
41
+ - `pm`:产品经理,负责 PRD 文档创建和维护
42
+ - `ux-expert`:UX 专家,负责前端设计规范和 AI 提示词
43
+ - `architect`:系统架构师,负责技术架构设计
44
+ - `po`:产品负责人,负责文档验证和分片管理
45
+ - `sm`:敏捷教练,负责故事创建和管理
46
+ - `dev`:开发工程师,负责代码实现
47
+ - `qa`:质量保证工程师,负责代码审查和质量控制
48
+
49
+ ## 📋 阶段一:项目规划(Web UI 环境)
50
+
51
+ ### 1.1 业务分析阶段
52
+ **智能体**:`analyst`
53
+ **输出文档**:`project-brief.md`
54
+
55
+ **操作步骤**:
56
+ ```bash
57
+ # 在 Web UI 中
58
+ @analyst
59
+ ```
60
+
61
+ **具体任务**:
62
+ - 可选:头脑风暴会议(`brainstorming_session`)
63
+ - 可选:市场调研(`market_research_prompt`)
64
+ - 创建项目概要文档
65
+ - **保存输出**:将 `project-brief.md` 复制到项目的 `docs/` 文件夹
66
+
67
+ ### 1.2 产品需求文档创建
68
+ **智能体**:`pm`
69
+ **输入依赖**:`project-brief.md`
70
+ **输出文档**:`prd.md`
71
+
72
+ **操作步骤**:
73
+ ```bash
74
+ # 确保 project-brief.md 已保存到 docs/
75
+ @pm
76
+ ```
77
+
78
+ **具体任务**:
79
+ - 基于项目概要使用 `prd-tmpl` 模板创建 PRD
80
+ - **保存输出**:将最终的 `prd.md` 复制到项目的 `docs/` 文件夹
81
+
82
+ ### 1.3 用户体验设计
83
+ **智能体**:`ux-expert`
84
+ **输入依赖**:`prd.md`
85
+ **输出文档**:`front-end-spec.md`
86
+
87
+ **操作步骤**:
88
+ ```bash
89
+ # 确保 prd.md 已保存到 docs/
90
+ @ux-expert
91
+ ```
92
+
93
+ **具体任务**:
94
+ - 可选:用户研究(`user_research_prompt`)
95
+ - 使用 `front-end-spec-tmpl` 创建 UI/UX 规范
96
+ - **保存输出**:将 `front-end-spec.md` 复制到项目的 `docs/` 文件夹
97
+
98
+ ### 1.4 AI 前端代码生成(可选但推荐)
99
+ **智能体**:`ux-expert`
100
+ **输入依赖**:`front-end-spec.md`
101
+ **输出**:v0 提示词
102
+
103
+ **操作步骤**:
104
+ ```bash
105
+ # 在完成前端规范后
106
+ @ux-expert
107
+ # 使用 generate-ai-frontend-prompt 任务
108
+ ```
109
+
110
+ **具体任务**:
111
+ - 生成适用于 v0、Lovable 等工具的 AI 前端提示词
112
+ - 用户在外部工具中生成 UI 并下载项目结构
113
+ - 为后续架构设计提供具体的项目结构参考
114
+
115
+ ### 1.5 系统架构设计
116
+ **智能体**:`architect`
117
+ **输入依赖**:`prd.md` + `front-end-spec.md`
118
+ **输出文档**:`fullstack-architecture.md`
119
+
120
+ **操作步骤**:
121
+ ```bash
122
+ # 确保 PRD 和前端规范都已保存
123
+ @architect
124
+ ```
125
+
126
+ **具体任务**:
127
+ - 可选:技术调研(`technical_research_prompt`)
128
+ - 可选:审查生成的 UI 结构(如果使用了 v0/Lovable)
129
+ - 使用 `fullstack-architecture-tmpl` 创建综合架构
130
+ - 可能建议对 PRD 故事的修改或新增
131
+ - **保存输出**:将 `fullstack-architecture.md` 复制到项目的 `docs/` 文件夹
132
+
133
+ ### 步骤 1.6:PRD 更新(条件触发)
134
+
135
+ **使用智能体**:`pm`
136
+ **执行环境**:Web UI (ChatGPT/Gemini)
137
+ **触发条件**:架构师在步骤 1.5 中建议 PRD 变更
138
+ **输入文件**:`docs/fullstack-architecture.md` + 架构师的修改建议
139
+ **输出文件**:`docs/prd.md`(更新版)
140
+
141
+ #### 详细操作步骤:
142
+
143
+ 1. **判断是否需要执行**
144
+ ```
145
+ # 检查架构师的反馈
146
+ 如果架构文档包含以下内容,则需要更新 PRD:
147
+ - "建议修改用户故事..."
148
+ - "需要新增技术故事..."
149
+ - "某些功能在技术上不可行..."
150
+ ```
151
+
152
+ 2. **重新加载 PM 智能体**
153
+ ```
154
+ # 新会话或继续之前的会话
155
+ @pm
156
+
157
+ # 提供架构师的反馈
158
+ 架构师提出了以下修改建议:
159
+ [粘贴架构师的具体建议]
160
+ ```
161
+
162
+ 3. **执行 PRD 更新命令**
163
+ ```
164
+ # 命令序列
165
+ 1. 请根据架构师的反馈更新相关的用户故事
166
+ 2. 如需要,请添加新的技术故事
167
+ 3. 请重新评估故事的优先级
168
+ 4. 请生成更新后的完整 PRD 文档
169
+ ```
170
+
171
+ 4. **验证更新内容**
172
+ - [ ] 所有架构师的建议都已处理
173
+ - [ ] 新增的技术故事有清晰的验收标准
174
+ - [ ] 优先级调整合理
175
+ - [ ] 文档版本号已更新
176
+
177
+ 5. **保存更新的 PRD**
178
+ ```bash
179
+ # 备份原始 PRD
180
+ mv docs/prd.md docs/prd-v1.md
181
+
182
+ # 保存新版本
183
+ echo "[更新后的 PRD]" > docs/prd.md
184
+
185
+ # 记录变更日志
186
+ echo "PRD 更新:根据架构反馈调整" >> docs/changelog.md
187
+ ```
188
+
189
+ **成功标准**:
190
+ - ✅ 架构师的所有建议都已整合
191
+ - ✅ PRD 与架构文档完全对齐
192
+ - ✅ 没有技术不可行的故事
193
+
194
+ **进入下一步的条件**:
195
+ - PRD 更新完成
196
+ - 与架构文档无冲突
197
+
198
+ ### 步骤 1.7:文档验证与批准
199
+
200
+ **使用智能体**:`po`(产品负责人)
201
+ **执行环境**:Web UI (ChatGPT/Gemini)
202
+ **输入文件**:所有规划阶段文档
203
+ **输出**:验证报告 + 批准状态
204
+
205
+ #### 详细操作步骤:
206
+
207
+ 1. **准备所有文档**
208
+ ```
209
+ # 在 Web UI 中提供所有文档
210
+ 以下是所有规划文档:
211
+
212
+ 1. Project Brief:
213
+ [粘贴 project-brief.md]
214
+
215
+ 2. PRD:
216
+ [粘贴 prd.md]
217
+
218
+ 3. Frontend Spec:
219
+ [粘贴 front-end-spec.md]
220
+
221
+ 4. Architecture:
222
+ [粘贴 fullstack-architecture.md]
223
+ ```
224
+
225
+ 2. **加载 PO 智能体**
226
+ ```
227
+ @po
228
+ ```
229
+
230
+ 3. **执行验证命令**
231
+ ```
232
+ # 主命令
233
+ 请使用 po-master-checklist 对所有文档进行全面验证
234
+
235
+ # 具体检查项
236
+ 请验证:
237
+ 1. PRD 与 Project Brief 的一致性
238
+ 2. Frontend Spec 是否覆盖所有 PRD 功能
239
+ 3. Architecture 是否支持所有业务需求
240
+ 4. 文档之间是否有冲突或遗漏
241
+ ```
242
+
243
+ 4. **PO 验证清单**
244
+ ```
245
+ 验证项目:
246
+ □ 业务目标对齐
247
+ □ 用户故事完整性
248
+ □ 技术可行性确认
249
+ □ 优先级合理性
250
+ □ 依赖关系清晰
251
+ □ 风险已识别
252
+ □ 时间线可实现
253
+ ```
254
+
255
+ 5. **处理验证结果**
256
+ ```bash
257
+ # 如果发现问题
258
+ # 场景 A:需要修改 PRD
259
+ 返回步骤 1.2,使用 @pm 修改
260
+
261
+ # 场景 B:需要调整架构
262
+ 返回步骤 1.5,使用 @architect 调整
263
+
264
+ # 场景 C:所有文档通过验证
265
+ echo "✅ 所有文档验证通过" >> docs/validation-report.md
266
+ echo "批准进入开发阶段" >> docs/validation-report.md
267
+ ```
268
+
269
+ 6. **最终确认**
270
+ ```bash
271
+ # 确认所有文档都在正确位置
272
+ ls -la docs/
273
+ # 应该看到:
274
+ # - project-brief.md
275
+ # - prd.md
276
+ # - front-end-spec.md
277
+ # - fullstack-architecture.md
278
+ # - validation-report.md
279
+ ```
280
+
281
+ **成功标准**:
282
+ - ✅ 所有文档相互一致
283
+ - ✅ 没有功能遗漏或冲突
284
+ - ✅ PO 正式批准进入开发
285
+ - ✅ 所有文档已保存到 docs/ 目录
286
+
287
+ **进入下一步的条件**:
288
+ - PO 验证通过
289
+ - 所有文档就绪
290
+ - 准备切换到 IDE 环境
291
+
292
+ ### 步骤 1.8:环境切换准备
293
+
294
+ **从 Web UI 切换到 IDE**
295
+
296
+ #### 切换前检查清单:
297
+
298
+ 1. **文档完整性检查**
299
+ ```bash
300
+ # 在项目根目录执行
301
+ find docs -name "*.md" -type f | sort
302
+
303
+ # 期望输出:
304
+ # docs/project-brief.md
305
+ # docs/prd.md
306
+ # docs/front-end-spec.md
307
+ # docs/fullstack-architecture.md
308
+ # docs/validation-report.md
309
+ ```
310
+
311
+ 2. **项目结构设置**
312
+ ```bash
313
+ # 根据架构决策设置项目结构
314
+
315
+ # 选项 A:单仓库结构
316
+ mkdir -p apps/web apps/api
317
+ mv [前端代码] apps/web/
318
+
319
+ # 选项 B:多仓库结构
320
+ # frontend repo: my-project-frontend/
321
+ # backend repo: my-project-backend/
322
+ # docs repo: my-project-docs/
323
+ ```
324
+
325
+ 3. **IDE 环境准备**
326
+ ```bash
327
+ # 安装 VS Code 或其他 IDE
328
+ # 安装必要的扩展
329
+ # - XiaoMa 扩展(如果有)
330
+ # - 语言相关扩展
331
+
332
+ # 在 IDE 中打开项目
333
+ code .
334
+ ```
335
+
336
+ 4. **验证 XiaoMa 在 IDE 中可用**
337
+ ```bash
338
+ # 在 IDE 终端中
339
+ npm run list:agents
340
+
341
+ # 确认可以看到开发阶段的智能体:
342
+ # - po (产品负责人)
343
+ # - sm (敏捷教练)
344
+ # - dev (开发者)
345
+ # - qa (质量保证)
346
+ ```
347
+
348
+ **成功标准**:
349
+ - ✅ 所有规划文档已保存
350
+ - ✅ 项目结构已按架构设置
351
+ - ✅ IDE 环境配置完成
352
+ - ✅ 可以在 IDE 中访问智能体
353
+
354
+ **进入开发阶段的标志**:
355
+ - Web UI 阶段正式结束
356
+ - 切换到 IDE 进行代码开发
357
+
358
+ ## 📝 阶段二:开发准备(IDE 环境)
359
+
360
+ ### 步骤 2.1:文档分片
361
+
362
+ **使用智能体**:`po`(产品负责人)
363
+ **执行环境**:IDE (VS Code/Cursor/WebStorm)
364
+ **输入文件**:`docs/prd.md` 和 `docs/fullstack-architecture.md`
365
+ **输出**:分片文档目录
366
+
367
+ #### 详细操作步骤:
368
+
369
+ 1. **创建分片目录结构**
370
+ ```bash
371
+ # 在项目根目录执行
372
+ mkdir -p docs/prd/epics
373
+ mkdir -p docs/architecture/components
374
+ mkdir -p docs/stories
375
+
376
+ # 验证目录创建
377
+ tree docs -d
378
+ ```
379
+
380
+ 2. **在 IDE 中加载 PO 智能体**
381
+ ```
382
+ # 在 IDE 的 AI 对话中
383
+ @po
384
+ ```
385
+
386
+ 3. **执行文档分片命令**
387
+ ```
388
+ # 命令 1:分片 PRD
389
+ 请执行 shard-doc 任务,分片 docs/prd.md
390
+ 将每个 Epic 保存到 docs/prd/epics/ 目录
391
+
392
+ # 命令 2:分片架构文档
393
+ 请分片 docs/fullstack-architecture.md
394
+ 将模块保存到 docs/architecture/components/ 目录
395
+ ```
396
+
397
+ 4. **分片结果验证**
398
+ ```bash
399
+ # 检查分片后的文件
400
+ ls -la docs/prd/epics/
401
+ # 预期输出:
402
+ # epic-01-user-authentication.md
403
+ # epic-02-dashboard.md
404
+ # epic-03-data-management.md
405
+ # ...
406
+
407
+ ls -la docs/architecture/components/
408
+ # 预期输出:
409
+ # api-design.md
410
+ # database-schema.md
411
+ # frontend-components.md
412
+ # ...
413
+ ```
414
+
415
+ 5. **创建分片索引文件**
416
+ ```bash
417
+ # 创建索引便于跟踪
418
+ echo "# 文档分片索引" > docs/shard-index.md
419
+ echo "## PRD Epics" >> docs/shard-index.md
420
+ ls docs/prd/epics/ >> docs/shard-index.md
421
+ echo "## Architecture Components" >> docs/shard-index.md
422
+ ls docs/architecture/components/ >> docs/shard-index.md
423
+ ```
424
+
425
+ **分片规则**:
426
+ - 每个分片文件不超过 500 行
427
+ - 按逻辑单元分片(一个 Epic = 一个文件)
428
+ - 保留引用关系和依赖信息
429
+ - 每个分片文件包含完整上下文
430
+
431
+ **成功标准**:
432
+ - ✅ PRD 被分解为 3-8 个 Epic 文件
433
+ - ✅ 架构文档被分解为模块化组件
434
+ - ✅ 每个分片文件可独立理解
435
+ - ✅ 分片索引文件创建完成
436
+
437
+ **进入下一步的条件**:
438
+ - 文档分片完成
439
+ - 准备开始敏捷开发循环
440
+
441
+ ## 🔄 阶段三:敏捷开发循环(IDE 环境)
442
+
443
+ ### 3.1 故事创建
444
+ **智能体**:`sm`(敏捷教练)
445
+ **输入依赖**:分片文档
446
+ **输出文档**:`story.md`
447
+
448
+ **操作步骤**:
449
+ ```bash
450
+ # 在新的聊天窗口中
451
+ @sm → *create
452
+ ```
453
+
454
+ **具体任务**:
455
+ - 基于分片的史诗文档创建下一个故事
456
+ - 故事初始状态为 "Draft"(草稿)
457
+ - 为每个史诗重复此过程
458
+
459
+ ### 3.2 故事审查(可选)
460
+ **智能体**:`analyst` 或 `pm`
461
+ **输入依赖**:`story.md`
462
+ **操作**:审查并批准草稿故事
463
+
464
+ **操作步骤**:
465
+ ```bash
466
+ # 如果需要故事审查
467
+ @analyst 或 @pm
468
+ # 注意:story-review 任务即将推出
469
+ ```
470
+
471
+ **具体任务**:
472
+ - 审查故事的完整性和对齐度
473
+ - 将故事状态从 "Draft" 更新为 "Approved"
474
+
475
+ ### 3.3 故事实现
476
+ **智能体**:`dev`(开发工程师)
477
+ **输入依赖**:已批准的 `story.md`
478
+ **输出**:实现文件
479
+
480
+ **操作步骤**:
481
+ ```bash
482
+ # 在新的聊天窗口中
483
+ @dev
484
+ ```
485
+
486
+ **具体任务**:
487
+ - 实现已批准的故事
488
+ - 更新文件列表记录所有变更
489
+ - 完成后将故事标记为 "Review"
490
+
491
+ ### 3.4 代码审查(可选但推荐)
492
+ **智能体**:`qa`(质量保证工程师)
493
+ **输入依赖**:实现文件
494
+ **操作**:审查实现质量
495
+
496
+ **操作步骤**:
497
+ ```bash
498
+ # 在新的聊天窗口中
499
+ @qa → review-story
500
+ ```
501
+
502
+ **具体任务**:
503
+ - 高级开发审查,具备重构能力
504
+ - 直接修复小问题
505
+ - 为剩余问题留下检查清单
506
+ - 更新故事状态(Review → Done 或保持 Review)
507
+
508
+ ### 3.5 解决 QA 反馈(条件触发)
509
+ **智能体**:`dev`
510
+ **触发条件**:QA 留下了未检查的项目
511
+
512
+ **操作步骤**:
513
+ ```bash
514
+ # 如果 QA 留下未完成项目
515
+ # 在新的聊天窗口中
516
+ @dev
517
+ # 解决剩余问题
518
+ # 返回 QA 进行最终批准
519
+ ```
520
+
521
+ ### 步骤 3.7:开发循环重复
522
+
523
+ **循环流程**:
524
+ ```
525
+ SM 创建故事 → Dev 实现 → QA 审查 → [修复] → 完成
526
+ ↓ ↑
527
+ ←←←←←←←← 下一个故事 ←←←←←←←←←
528
+ ```
529
+
530
+ #### 循环管理:
531
+
532
+ 1. **故事进度跟踪**
533
+ ```bash
534
+ # 创建进度跟踪文件
535
+ cat > docs/sprint-progress.md << EOF
536
+ # Sprint 进度
537
+
538
+ ## Epic-01: 用户认证
539
+ - [x] Story-001: 登录功能
540
+ - [ ] Story-002: 注册功能
541
+ - [ ] Story-003: 密码重置
542
+
543
+ ## Epic-02: 仪表板
544
+ - [ ] Story-004: 数据展示
545
+ - [ ] Story-005: 图表组件
546
+ EOF
547
+ ```
548
+
549
+ 2. **切换到下一个故事**
550
+ ```bash
551
+ # 返回步骤 3.1
552
+ # SM 创建 Story-002
553
+ @sm
554
+ 请基于 Epic-01 创建下一个故事 (Story-002)
555
+ ```
556
+
557
+ 3. **Epic 完成标准**
558
+ ```
559
+ 当一个 Epic 的所有故事完成:
560
+ - 所有故事状态 = Done
561
+ - 所有验收标准通过
562
+ - 集成测试通过
563
+ → 进入下一个 Epic
564
+ ```
565
+
566
+ **继续条件**:
567
+ - 直到所有 Epic 完成
568
+ - 直到 PRD 中所有故事实现
569
+
570
+ ## 🎉 阶段四:项目完成
571
+
572
+ ### 步骤 4.1:史诗回顾(可选但推荐)
573
+
574
+ **使用智能体**:`po`
575
+ **执行环境**:IDE
576
+ **触发条件**:每个 Epic 完成后
577
+ **输出文件**:`docs/retrospectives/epic-XX-retrospective.md`
578
+
579
+ #### 详细操作步骤:
580
+
581
+ 1. **创建回顾目录**
582
+ ```bash
583
+ mkdir -p docs/retrospectives
584
+ ```
585
+
586
+ 2. **进行史诗回顾**
587
+ ```
588
+ @po
589
+
590
+ Epic-01 已完成,请进行回顾:
591
+ - 验证所有故事是否满足原始需求
592
+ - 记录开发过程中的经验教训
593
+ - 识别可以改进的流程
594
+ - 评估质量和性能
595
+ ```
596
+
597
+ 3. **生成回顾报告**
598
+ ```bash
599
+ # PO 生成回顾后保存
600
+ echo "[回顾内容]" > docs/retrospectives/epic-01-retrospective.md
601
+ ```
602
+
603
+ ### 步骤 4.2:最终项目验证
604
+
605
+ #### 完整性检查清单:
606
+
607
+ 1. **功能完整性验证**
608
+ ```bash
609
+ # 检查所有故事状态
610
+ find docs/stories -name "*.md" -exec grep -l "Done" {} \;
611
+
612
+ # 运行完整测试套件
613
+ npm run test:all
614
+ npm run test:e2e
615
+ ```
616
+
617
+ 2. **文档完整性检查**
618
+ ```bash
619
+ # 验证所有必要文档存在
620
+ ls -la docs/
621
+ # 应包含:
622
+ # - 所有规划文档
623
+ # - 分片文档
624
+ # - 故事文档
625
+ # - 回顾文档
626
+ ```
627
+
628
+ 3. **代码质量最终检查**
629
+ ```bash
630
+ # 代码质量检查
631
+ npm run lint
632
+ npm run typecheck
633
+ npm run build
634
+
635
+ # 安全扫描
636
+ npm audit
637
+ ```
638
+
639
+ ### 步骤 4.3:项目交付准备
640
+
641
+ 1. **生成项目报告**
642
+ ```bash
643
+ cat > docs/PROJECT-SUMMARY.md << EOF
644
+ # 项目完成总结
645
+
646
+ ## 项目概述
647
+ - 项目名称:[项目名]
648
+ - 完成日期:$(date)
649
+ - 总 Epic 数:[数量]
650
+ - 总 Story 数:[数量]
651
+
652
+ ## 交付物清单
653
+ - [ ] 前端应用
654
+ - [ ] 后端 API
655
+ - [ ] 数据库 Schema
656
+ - [ ] 部署脚本
657
+ - [ ] 测试套件
658
+ - [ ] 文档
659
+
660
+ ## 技术栈
661
+ - 前端:[技术栈]
662
+ - 后端:[技术栈]
663
+ - 数据库:[数据库]
664
+ - 部署:[部署方案]
665
+ EOF
666
+ ```
667
+
668
+ 2. **创建部署指南**
669
+ ```bash
670
+ cat > DEPLOYMENT.md << EOF
671
+ # 部署指南
672
+
673
+ ## 环境要求
674
+ - Node.js >= [版本]
675
+ - [其他要求]
676
+
677
+ ## 部署步骤
678
+ 1. 克隆仓库
679
+ 2. 安装依赖
680
+ 3. 配置环境变量
681
+ 4. 运行部署脚本
682
+ EOF
683
+ ```
684
+
685
+ **项目完成标准**:
686
+ - ✅ 所有 PRD 故事实现完成
687
+ - ✅ 所有测试通过
688
+ - ✅ 代码质量检查通过
689
+ - ✅ 部署文档齐全
690
+ - ✅ 项目可以成功部署运行
691
+
692
+ ## 🛠️ 核心命令快速参考
693
+
694
+ ### 环境设置命令
695
+ ```bash
696
+ # 项目初始化
697
+ mkdir my-project && cd my-project
698
+ npm init -y
699
+ npx xiaoma-web install
700
+
701
+ # 验证安装
702
+ npm run list:agents
703
+ npm run validate
704
+
705
+ # 目录结构创建
706
+ mkdir -p docs/prd docs/architecture docs/stories
707
+ ```
708
+
709
+ ### 阶段一:规划阶段(Web UI)
710
+ ```bash
711
+ # 按顺序执行每个智能体
712
+ @analyst # 1. 创建 project-brief.md
713
+ @pm # 2. 创建 prd.md (基于 project-brief)
714
+ @ux-expert # 3. 创建 front-end-spec.md + AI 提示词
715
+ @architect # 4. 创建 fullstack-architecture.md
716
+ @pm # 5. 更新 PRD (如果架构师建议)
717
+ @po # 6. 验证所有文档一致性
718
+ ```
719
+
720
+ ### 阶段二:文档分片(IDE)
721
+ ```bash
722
+ # IDE 环境中
723
+ @po # 分片 docs/prd.md 和 docs/fullstack-architecture.md
724
+ # 结果:docs/prd/epics/ 和 docs/architecture/components/
725
+ ```
726
+
727
+ ### 阶段三:开发循环(IDE)
728
+ ```bash
729
+ # 每个故事的完整流程
730
+ @sm # 1. 创建故事 (基于 Epic)
731
+ @analyst 或 @pm # 2. 故事审查 (可选)
732
+ @dev # 3. 实现故事
733
+ @qa # 4. 代码审查
734
+ @dev # 5. 修复反馈 (如需要)
735
+ @qa # 6. 最终确认
736
+
737
+ # 重复直到所有故事完成
738
+ ```
739
+
740
+ ### 阶段四:项目完成
741
+ ```bash
742
+ # 项目验证
743
+ npm run test:all
744
+ npm run lint
745
+ npm run build
746
+
747
+ # 生成交付文档
748
+ @po # 史诗回顾
749
+ # 手动创建 PROJECT-SUMMARY.md 和 DEPLOYMENT.md
750
+ ```
751
+
752
+ ## ❓ 常见问题和故障排除
753
+
754
+ ### 环境问题
755
+
756
+ **Q: `npm run install:xiaoma` 失败**
757
+ ```bash
758
+ # 解决方案
759
+ # 1. 确保 Node.js 版本 >= 16
760
+ node --version
761
+
762
+ # 2. 清理 npm 缓存
763
+ npm cache clean --force
764
+
765
+ # 3. 尝试替代安装方法
766
+ npx xiaoma-web install
767
+ ```
768
+
769
+ **Q: `npm run list:agents` 显示空列表**
770
+ ```bash
771
+ # 解决方案
772
+ # 1. 检查是否在正确目录
773
+ ls -la | grep xiaoma
774
+
775
+ # 2. 重新安装
776
+ rm -rf .xiaoma
777
+ npx xiaoma-web install
778
+
779
+ # 3. 验证安装
780
+ npm run validate
781
+ ```
782
+
783
+ ### 智能体使用问题
784
+
785
+ **Q: 智能体不响应或响应错误**
786
+ ```bash
787
+ # 排查步骤
788
+ # 1. 确认智能体名称正确
789
+ npm run list:agents
790
+
791
+ # 2. 检查上下文是否提供充分
792
+ # - Web UI: 确保粘贴了所有依赖文档
793
+ # - IDE: 确保文件在项目目录中
794
+
795
+ # 3. 重新开始对话
796
+ # Web UI: 刷新页面
797
+ # IDE: 重启 AI 对话
798
+ ```
799
+
800
+ **Q: 文档生成不完整**
801
+ ```bash
802
+ # 解决方法
803
+ # 1. 分步骤要求生成
804
+ # 2. 提供更具体的指令
805
+ # 3. 检查模板是否正确加载
806
+
807
+ # 示例:
808
+ @pm
809
+ 请使用 prd-tmpl 模板,为以下项目概要创建完整的 PRD:
810
+ [提供项目概要内容]
811
+ 请确保包含:用户故事、验收标准、优先级
812
+ ```
813
+
814
+ ### 工作流程问题
815
+
816
+ **Q: 文档分片失败**
817
+ ```bash
818
+ # 解决方案
819
+ # 1. 检查源文档格式
820
+ head -50 docs/prd.md
821
+
822
+ # 2. 手动创建目录结构
823
+ mkdir -p docs/prd/epics docs/architecture/components
824
+
825
+ # 3. 逐个Epic手动分片
826
+ @po
827
+ 请将以下 Epic 保存为独立文件:
828
+ [粘贴单个 Epic 内容]
829
+ ```
830
+
831
+ **Q: 故事创建没有遵循模板**
832
+ ```bash
833
+ # 解决方法
834
+ # 提供明确的模板格式
835
+ @sm
836
+ 请按以下模板创建故事:
837
+
838
+ # Story-XXX: [标题]
839
+ ## 状态
840
+ - [x] Draft / [ ] Approved / [ ] In Progress / [ ] Review / [ ] Done
841
+
842
+ ## 故事描述
843
+ As a [角色]
844
+ I want [功能]
845
+ So that [价值]
846
+
847
+ ## 验收标准
848
+ - [ ] AC1: 具体的可测试标准
849
+ - [ ] AC2: 具体的可测试标准
850
+
851
+ ## 技术任务
852
+ - [ ] Task 1: 具体实现任务
853
+ - [ ] Task 2: 具体实现任务
854
+ ```
855
+
856
+ **Q: 代码质量检查失败**
857
+ ```bash
858
+ # 常见问题及解决方案
859
+
860
+ # Lint 错误
861
+ npm run lint -- --fix
862
+
863
+ # 类型错误
864
+ npm run typecheck
865
+ # 根据错误提示修复类型问题
866
+
867
+ # 测试失败
868
+ npm test -- --verbose
869
+ # 检查失败的测试用例
870
+
871
+ # 构建失败
872
+ npm run build 2>&1 | tee build.log
873
+ # 查看详细错误日志
874
+ ```
875
+
876
+ ### 性能优化
877
+
878
+ **Q: 智能体响应慢**
879
+ - 减少上下文长度
880
+ - 分步骤执行复杂任务
881
+ - 使用更具体的指令
882
+ - 避免同时处理多个大文档
883
+
884
+ **Q: 文档过多导致混乱**
885
+ ```bash
886
+ # 组织建议
887
+ # 1. 使用清晰的目录结构
888
+ tree docs
889
+
890
+ # 2. 创建索引文件
891
+ echo "# 文档索引" > docs/README.md
892
+ echo "## 规划文档" >> docs/README.md
893
+ ls docs/*.md >> docs/README.md
894
+
895
+ # 3. 定期清理过时文档
896
+ find docs -name "*.md" -mtime +30
897
+ ```
898
+
899
+ ## 📊 流程决策指导
900
+
901
+ ### 何时使用完整流程
902
+ - ✅ **生产就绪应用**:需要部署到生产环境
903
+ - ✅ **多人协作**:团队成员 > 1
904
+ - ✅ **复杂需求**:功能模块 > 5
905
+ - ✅ **长期维护**:预期使用 > 1年
906
+ - ✅ **企业级应用**:面向客户或内部重要系统
907
+
908
+ ### 简化流程选项
909
+ - 🔹 **快速原型**:跳过 UX Expert,直接 PM → Architect
910
+ - 🔹 **个人项目**:跳过 QA,Dev 自测
911
+ - 🔹 **简单功能**:合并故事,减少分片
912
+
913
+ ### 文档传递最佳实践
914
+ - 📋 每个阶段完成后,立即保存到 `docs/` 目录
915
+ - 🔄 确保后续智能体可访问前置文档
916
+ - 📱 Web UI ↔ IDE 环境切换时验证文档完整性
917
+ - 📝 使用版本控制跟踪文档变更
918
+
919
+ ## 🔗 相关资源
920
+
921
+ ### 框架文件结构
922
+ - **项目配置**:`xiaoma-core/core-config.yaml`
923
+ - **工作流定义**:`xiaoma-core/workflows/greenfield-fullstack.yaml`
924
+ - **智能体定义**:`xiaoma-core/agents/`
925
+ - **模板库**:`xiaoma-core/templates/`
926
+ - **任务库**:`xiaoma-core/tasks/`
927
+ - **检查清单**:`xiaoma-core/checklists/`
928
+
929
+ ### 有用的命令
930
+ ```bash
931
+ # 查看框架版本
932
+ npm run version
933
+
934
+ # 验证所有配置
935
+ npm run validate
936
+
937
+ # 平铺代码库(AI 分析用)
938
+ npm run flatten
939
+
940
+ # 升级框架版本
941
+ npx xiaoma-web upgrade
942
+ ```
943
+
944
+ ### 进阶使用
945
+ - 📚 **扩展包**:`expansion-packs/` - 领域特定扩展
946
+ - 🎯 **自定义智能体**:修改 `agents/` 目录下的配置
947
+ - 🔧 **自定义模板**:在 `templates/` 目录添加模板
948
+ - 📋 **自定义任务**:在 `tasks/` 目录添加任务
949
+
950
+ ---
951
+
952
+ ## 📝 总结
953
+
954
+ 这套 **XiaoMa-Web 多智能体 0-1 项目开发完整指南** 提供了从零开始创建项目到完整交付的每一步详细操作指南。
955
+
956
+ **核心特点**:
957
+ - 🎯 **明确的角色分工**:每个智能体都有专门职责
958
+ - 📋 **结构化流程**:每个步骤都有具体的命令和验证标准
959
+ - 🔄 **双阶段开发**:Web UI 规划 + IDE 开发
960
+ - ✅ **质量保证**:内置代码审查和测试流程
961
+ - 📊 **进度跟踪**:文档化的故事状态管理
962
+
963
+ **适用场景**:
964
+ - 新项目从 0 到 1 的完整开发
965
+ - 需要规范化流程的团队协作
966
+ - 复杂应用的结构化开发
967
+ - 长期维护项目的质量保证
968
+
969
+ 通过遵循这个指南,你可以确保项目从需求分析到最终交付的每个环节都有专门的智能体负责,实现高效、高质量的项目开发。
970
+
971
+ **下一步**:
972
+ 1. 根据你的项目需求选择合适的流程
973
+ 2. 准备必要的开发环境
974
+ 3. 开始执行 **步骤 0:前置准备**
975
+ 4. 遇到问题时参考 **常见问题和故障排除** 部分
976
+
977
+ 祝你项目开发顺利!🚀