@zeyue0329/xiaoma-cli 1.0.36 → 1.0.38

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 (89) hide show
  1. package/.idea/workspace.xml +27 -26
  2. package/JAVA-BACKEND-COMMANDS-REFERENCE.md +62 -52
  3. package/JAVA-BACKEND-ITERATION-GUIDE.md +125 -18
  4. package/README.md +1 -1
  5. package/common/utils/bmad-doc-template.md +5 -5
  6. package/dist/agents/analyst.txt +35 -5
  7. package/dist/agents/architect.txt +217 -31
  8. package/dist/agents/automation-orchestrator.txt +4 -4
  9. package/dist/agents/dev.txt +3 -3
  10. package/dist/agents/full-requirement-orchestrator.txt +11 -11
  11. package/dist/agents/qa.txt +102 -102
  12. package/dist/agents/sm.txt +6 -6
  13. package/dist/agents/ux-expert.txt +6 -1
  14. package/dist/agents/workflow-executor.txt +879 -0
  15. package/dist/agents/xiaoma-master.txt +258 -37
  16. package/dist/teams/team-all.txt +1223 -445
  17. package/dist/teams/team-fullstack-with-database.txt +384 -446
  18. package/dist/teams/team-fullstack.txt +258 -37
  19. package/dist/teams/team-ide-minimal.txt +111 -111
  20. package/dist/teams/team-no-ui.txt +252 -36
  21. package/docs/architecture-sharding-modification.md +623 -0
  22. package/docs/automated-requirements-analysis-outputs.md +896 -0
  23. package/package.json +1 -1
  24. package/tools/builders/web-builder.js +292 -142
  25. package/tools/bump-all-versions.js +50 -32
  26. package/tools/cli.js +52 -47
  27. package/tools/flattener/aggregate.js +30 -12
  28. package/tools/flattener/binary.js +46 -43
  29. package/tools/flattener/discovery.js +23 -15
  30. package/tools/flattener/files.js +6 -6
  31. package/tools/flattener/ignoreRules.js +122 -121
  32. package/tools/flattener/main.js +249 -144
  33. package/tools/flattener/projectRoot.js +74 -69
  34. package/tools/flattener/prompts.js +12 -10
  35. package/tools/flattener/stats.helpers.js +90 -61
  36. package/tools/flattener/stats.js +1 -1
  37. package/tools/flattener/test-matrix.js +225 -170
  38. package/tools/flattener/xml.js +31 -23
  39. package/tools/installer/bin/xiaoma.js +199 -153
  40. package/tools/installer/lib/config-loader.js +76 -47
  41. package/tools/installer/lib/file-manager.js +101 -44
  42. package/tools/installer/lib/ide-base-setup.js +49 -39
  43. package/tools/installer/lib/ide-setup.js +694 -380
  44. package/tools/installer/lib/installer.js +802 -469
  45. package/tools/installer/lib/memory-profiler.js +22 -12
  46. package/tools/installer/lib/module-manager.js +16 -14
  47. package/tools/installer/lib/resource-locator.js +61 -35
  48. package/tools/lib/dependency-resolver.js +34 -23
  49. package/tools/lib/yaml-utils.js +7 -2
  50. package/tools/preview-release-notes.js +33 -25
  51. package/tools/shared/bannerArt.js +3 -3
  52. package/tools/sync-installer-version.js +16 -7
  53. package/tools/upgraders/v3-to-v4-upgrader.js +244 -163
  54. package/tools/version-bump.js +24 -18
  55. package/tools/xiaoma-npx-wrapper.js +15 -10
  56. package/tools/yaml-format.js +60 -36
  57. package/xiaoma-core/agent-teams/team-fullstack-with-database.yaml +0 -1
  58. package/xiaoma-core/agents/automated-fix-validator.yaml +2 -1
  59. package/xiaoma-core/agents/automated-quality-validator.yaml +10 -5
  60. package/xiaoma-core/agents/automation-orchestrator.md +4 -4
  61. package/xiaoma-core/agents/dev.md +4 -4
  62. package/xiaoma-core/agents/enhanced-workflow-orchestrator.yaml +2 -1
  63. package/xiaoma-core/agents/full-requirement-orchestrator.md +11 -11
  64. package/xiaoma-core/agents/global-requirements-auditor.yaml +11 -3
  65. package/xiaoma-core/agents/intelligent-template-adapter.yaml +19 -5
  66. package/xiaoma-core/agents/master-execution-engine.yaml +19 -5
  67. package/xiaoma-core/agents/workflow-executor.md +126 -18
  68. package/xiaoma-core/agents/xiaoma-master.md +1 -1
  69. package/xiaoma-core/data/test-levels-framework.md +12 -12
  70. package/xiaoma-core/tasks/analyze-existing-database.md +1 -1
  71. package/xiaoma-core/tasks/apply-qa-fixes.md +3 -3
  72. package/xiaoma-core/tasks/batch-story-generation.md +22 -22
  73. package/xiaoma-core/tasks/create-enhanced-story-with-database.md +6 -6
  74. package/xiaoma-core/tasks/nfr-assess.md +6 -6
  75. package/xiaoma-core/tasks/project-integration-testing.md +42 -42
  76. package/xiaoma-core/tasks/qa-gate.md +23 -23
  77. package/xiaoma-core/tasks/review-story.md +18 -18
  78. package/xiaoma-core/tasks/risk-profile.md +25 -25
  79. package/xiaoma-core/tasks/serial-development-orchestration.md +51 -51
  80. package/xiaoma-core/tasks/test-design.md +9 -9
  81. package/xiaoma-core/tasks/trace-requirements.md +21 -21
  82. package/xiaoma-core/templates/competitor-analysis-tmpl.yaml +35 -5
  83. package/xiaoma-core/templates/front-end-architecture-tmpl.yaml +77 -11
  84. package/xiaoma-core/templates/front-end-spec-tmpl.yaml +6 -1
  85. package/xiaoma-core/templates/fullstack-architecture-tmpl.yaml +140 -20
  86. package/xiaoma-core/templates/global-qa-monitoring-tmpl.yaml +2 -1
  87. package/xiaoma-core/templates/requirements-coverage-audit.yaml +2 -1
  88. package/xiaoma-core/workflows/automated-requirements-analysis.yaml +4 -4
  89. package/dist/agents/database-architect.txt +0 -322
@@ -0,0 +1,896 @@
1
+ # automated-requirements-analysis.yaml 工作流输出文档清单
2
+
3
+ ## 工作流概述
4
+
5
+ **工作流ID**: `automated-requirements-analysis`
6
+ **用途**: 从 req.txt 需求文档到 PRD 生成和 Epic 拆分的全自动化流程
7
+ **适用场景**: 现有 Java 后端项目的迭代需求开发(Brownfield 项目)
8
+ **总耗时**: 约 1.5-2.5 小时
9
+
10
+ ## 📄 生成的文档清单
11
+
12
+ ### 1. 需求分析阶段(Analyst 智能体)
13
+
14
+ #### 1.1 需求分析报告
15
+
16
+ - **文件路径**: `docs/requirements/requirements-analysis.md`
17
+ - **生成智能体**: Analyst
18
+ - **生成时机**: 第1步 - 需求分析和澄清阶段
19
+ - **文档内容**:
20
+
21
+ ```markdown
22
+ ## 1. 需求概览
23
+
24
+ - 项目背景和目标
25
+ - 业务价值主张
26
+ - 核心功能摘要
27
+
28
+ ## 2. 需求分类清单
29
+
30
+ - 功能需求(按模块分类)
31
+ - 非功能需求
32
+ - 数据需求
33
+ - 接口需求
34
+ - 约束条件
35
+
36
+ ## 3. 用户和场景
37
+
38
+ - 目标用户角色定义
39
+ - 典型使用场景
40
+ - 用户旅程地图
41
+
42
+ ## 4. 需求澄清记录
43
+
44
+ - 原始需求中的不明确点
45
+ - 澄清后的明确需求
46
+ - 补充的需求细节
47
+
48
+ ## 5. 需求优先级
49
+
50
+ - 高优先级需求(Must Have)
51
+ - 中优先级需求(Should Have)
52
+ - 低优先级需求(Could Have)
53
+ - 未来考虑(Won't Have This Time)
54
+
55
+ ## 6. 依赖关系分析
56
+
57
+ - 功能依赖关系图
58
+ - 技术依赖识别
59
+ - 数据依赖识别
60
+
61
+ ## 7. 风险和约束
62
+
63
+ - 识别的业务风险
64
+ - 识别的技术约束
65
+ - 资源和时间约束
66
+ - 风险缓解建议
67
+
68
+ ## 8. 实施建议
69
+
70
+ - 建议的开发阶段划分
71
+ - MVP(最小可行产品)范围
72
+ - 迭代计划建议
73
+ ```
74
+
75
+ #### 1.2 项目简报(可选)
76
+
77
+ - **文件路径**: `docs/brief.md`
78
+ - **生成智能体**: Analyst
79
+ - **生成时机**: 第1步(可选)
80
+ - **文档内容**: 简洁的项目概览、目标、关键里程碑
81
+
82
+ ---
83
+
84
+ ### 2. 架构分析阶段(Architect 智能体)
85
+
86
+ #### 2.1 现有架构分析报告 ⭐
87
+
88
+ - **文件路径**: `docs/architecture/current-architecture-analysis.md`
89
+ - **生成智能体**: Architect
90
+ - **生成时机**: 第2步 - 分析现有架构
91
+ - **文档内容**:
92
+
93
+ ```markdown
94
+ ## 1. 项目概览
95
+
96
+ - 项目名称
97
+ - 技术栈版本清单
98
+ - 项目规模统计(类数量、接口数量等)
99
+
100
+ ## 2. 技术架构
101
+
102
+ - 框架和依赖清单
103
+ - Spring Boot 版本
104
+ - 持久化框架(MyBatis/MyBatis-Plus/JPA)
105
+ - 数据库类型和版本
106
+ - 其他关键依赖(Redis/Kafka等)
107
+ - 分层架构说明
108
+ - 关键技术组件
109
+
110
+ ## 3. 数据库架构
111
+
112
+ - 数据库类型和版本(MySQL/PostgreSQL)
113
+ - 现有数据表清单
114
+ - 表名
115
+ - 用途说明
116
+ - 主要字段
117
+ - ER 关系说明
118
+ - 数据库设计模式
119
+
120
+ ## 4. API 架构
121
+
122
+ - API 模块清单
123
+ - RESTful 端点统计
124
+ - API 版本策略
125
+ - 请求/响应规范
126
+
127
+ ## 5. 代码组织
128
+
129
+ - 包结构说明
130
+ - 分层职责定义(Controller-Service-Mapper/Repository)
131
+ - 公共组件和工具类
132
+
133
+ ## 6. 架构特点和注意事项
134
+
135
+ - 遵循的设计原则
136
+ - 编码规范要点
137
+ - 技术约束
138
+ - 已知技术债务
139
+
140
+ ## 7. 迭代开发建议
141
+
142
+ - 新增功能的集成点
143
+ - 需要遵循的规范
144
+ - 兼容性注意事项
145
+ ```
146
+
147
+ ---
148
+
149
+ ### 3. PRD 创建阶段(PM 智能体)
150
+
151
+ #### 3.1 Brownfield 迭代 PRD 文档 ⭐⭐
152
+
153
+ - **文件路径**: `docs/prd/brownfield-iteration-prd.md`
154
+ - **生成智能体**: PM
155
+ - **生成时机**: 第3步 - 创建 Brownfield PRD
156
+ - **输入来源**:
157
+ - `docs/req.txt` - PM 提供的原始需求
158
+ - `docs/architecture/current-architecture-analysis.md` - 现有架构上下文
159
+ - **文档内容**:
160
+
161
+ ```markdown
162
+ # PRD 元数据
163
+
164
+ - 标题、版本、作者、创建日期、状态
165
+
166
+ ## 1. 需求概述
167
+
168
+ - 迭代背景和目标
169
+ - 目标用户群体
170
+ - 业务价值说明
171
+
172
+ ## 2. 目标用户和使用场景
173
+
174
+ - 用户角色定义
175
+ - 典型使用场景描述
176
+ - 用户旅程地图
177
+
178
+ ## 3. 功能需求详细描述
179
+
180
+ - 功能模块清单
181
+ - 每个功能的详细描述
182
+ - 业务规则和约束
183
+ - 数据流和处理逻辑
184
+
185
+ ## 4. 非功能需求
186
+
187
+ - 性能要求(响应时间、并发量)
188
+ - 安全要求(认证、授权、数据保护)
189
+ - 兼容性要求(浏览器、移动端、API版本)
190
+ - 可用性和可维护性要求
191
+
192
+ ## 5. 技术约束(基于现有架构)
193
+
194
+ - 必须使用的技术栈
195
+ - 必须遵循的架构模式
196
+ - 不能修改的现有组件
197
+ - 技术兼容性约束
198
+
199
+ ## 6. 数据需求(数据库变更)
200
+
201
+ - 新增数据表清单
202
+ - 修改现有表的变更说明
203
+ - 数据迁移策略
204
+ - 数据关联关系
205
+
206
+ ## 7. API 需求(新增/修改的接口)
207
+
208
+ - RESTful API 端点清单
209
+ - 请求/响应数据结构
210
+ - API 版本策略
211
+ - 与现有 API 的集成点
212
+
213
+ ## 8. 验收标准
214
+
215
+ - 功能验收标准(可测试、可验证)
216
+ - 性能验收标准
217
+ - 质量验收标准
218
+
219
+ ## 9. 实施计划(史诗拆分建议)
220
+
221
+ - 建议的史诗划分
222
+ - 优先级排序
223
+ - 依赖关系说明
224
+ - 预估工作量
225
+ ```
226
+
227
+ ---
228
+
229
+ ### 4. Epic 拆分阶段(PM 智能体)
230
+
231
+ #### 4.1 史诗文档集合 ⭐
232
+
233
+ - **文件路径**: `docs/epics/史诗-{epic_name}.md`(多个文件)
234
+ - **生成智能体**: PM
235
+ - **生成时机**: 第3步 - Epic 拆分循环
236
+ - **生成数量**: 根据 PRD 建议,通常 3-8 个史诗
237
+ - **每个史诗文档内容**:
238
+
239
+ ```markdown
240
+ # 史诗元数据
241
+
242
+ - epic_id: Epic-01, Epic-02, ...
243
+ - epic_name: 史诗名称
244
+ - status: Planned
245
+ - priority: 高/中/低
246
+ - created_date: 创建日期
247
+
248
+ ## 1. 史诗概述
249
+
250
+ - 史诗目标
251
+ - 业务价值
252
+ - 成功标准
253
+
254
+ ## 2. 用户故事清单(初步识别)
255
+
256
+ - 故事清单(5-15个故事)
257
+ - 故事优先级
258
+ - 故事依赖关系
259
+
260
+ ## 3. 技术设计概要(针对此史诗)
261
+
262
+ - 技术组件
263
+ - 架构设计
264
+ - 技术方案
265
+
266
+ ## 4. 数据库变更(针对此史诗)
267
+
268
+ - 新增表
269
+ - 修改表
270
+ - 数据迁移
271
+
272
+ ## 5. API 接口清单(针对此史诗)
273
+
274
+ - API 端点清单
275
+ - 接口概要
276
+
277
+ ## 6. 验收标准(史诗级别)
278
+
279
+ - 史诗验收标准
280
+ - 质量标准
281
+
282
+ ## 7. 估算工作量
283
+
284
+ - 故事数量
285
+ - 工作量预估
286
+ - 风险和不确定性
287
+
288
+ ## 8. 风险和注意事项
289
+
290
+ - 技术风险
291
+ - 业务风险
292
+ - 依赖风险
293
+ - 缓解措施
294
+ ```
295
+
296
+ ---
297
+
298
+ ### 5. 架构设计阶段(Architect 智能体)
299
+
300
+ #### 5.1 迭代后端架构增量设计文档 ⭐⭐⭐(核心架构文档)
301
+
302
+ - **文件路径**: `docs/architecture/iteration-backend-design.md`
303
+ - **生成智能体**: Architect
304
+ - **生成时机**: 第4步 - 后端架构增量设计
305
+ - **输入来源**:
306
+ - `docs/prd/brownfield-iteration-prd.md`
307
+ - `docs/epics/史诗-*.md`
308
+ - `docs/architecture/current-architecture-analysis.md`
309
+ - **文档内容**(最详细的架构设计):
310
+
311
+ ````markdown
312
+ # 架构设计元数据
313
+
314
+ - 标题: 迭代后端架构增量设计
315
+ - 版本号
316
+ - 架构师: Architect Agent
317
+ - 创建日期
318
+ - 基于: current_architecture_analysis, prd_document, epic_documents
319
+
320
+ ## 1. 设计概述
321
+
322
+ - 设计概述
323
+ - 设计原则
324
+ - 技术选型
325
+
326
+ ## 2. 新增数据模型设计 ⭐
327
+
328
+ ### 2.1 新增 Entity 实体类(Java Entity)
329
+
330
+ - 类名、包名
331
+ - 字段定义(类型、注解)
332
+ - 关联关系(@OneToMany, @ManyToOne, @ManyToMany)
333
+ - JPA/Hibernate 注解配置
334
+
335
+ ### 2.2 数据表结构设计(DDL)
336
+
337
+ - 完整的 CREATE TABLE 语句
338
+ - 主键、外键、索引定义
339
+ - 字段类型、长度、默认值、注释
340
+ - 约束条件(唯一、非空等)
341
+
342
+ ### 2.3 与现有实体的关联关系
343
+
344
+ - 外键关系
345
+ - 关联表设计(多对多)
346
+ - 级联操作策略
347
+
348
+ ### 2.4 数据迁移策略
349
+
350
+ - 新表创建脚本
351
+ - 现有表修改脚本(ALTER TABLE)
352
+ - 数据初始化脚本
353
+ - 回滚方案
354
+
355
+ ## 3. API 设计 ⭐
356
+
357
+ ### 3.1 新增 RESTful API 端点列表
358
+
359
+ - HTTP 方法(GET/POST/PUT/DELETE)
360
+ - URL 路径设计
361
+ - 路径参数和查询参数
362
+ - 请求 Body 结构
363
+ - 响应数据结构
364
+ - HTTP 状态码
365
+
366
+ ### 3.2 请求/响应 DTO 设计
367
+
368
+ - DTO 类名和包名
369
+ - 字段定义和验证注解
370
+ - DTO 与 Entity 的映射关系
371
+
372
+ ### 3.3 API 版本策略
373
+
374
+ - 版本号规则
375
+ - 向后兼容性保证
376
+ - 废弃策略
377
+
378
+ ### 3.4 与现有 API 的集成点
379
+
380
+ - 复用现有 API
381
+ - 扩展现有 API
382
+ - API 组合调用
383
+
384
+ ## 4. 服务层设计 ⭐
385
+
386
+ ### 4.1 新增 Service 接口和实现
387
+
388
+ - Service 接口定义
389
+ - 方法签名和 JavaDoc
390
+ - 业务逻辑流程
391
+ - Service 实现类结构
392
+
393
+ ### 4.2 业务逻辑流程图
394
+
395
+ - 关键业务流程的流程图
396
+ - 决策点和分支逻辑
397
+ - 异常处理流程
398
+
399
+ ### 4.3 事务边界设计
400
+
401
+ - 事务传播策略
402
+ - 事务隔离级别
403
+ - 事务回滚规则
404
+
405
+ ### 4.4 与现有服务的交互
406
+
407
+ - 依赖的现有 Service
408
+ - 服务间调用关系
409
+ - 数据流转
410
+
411
+ ## 5. 技术决策
412
+
413
+ ### 5.1 新技术/组件的引入
414
+
415
+ - 新增依赖说明
416
+ - 版本选择理由
417
+ - 与现有技术栈的兼容性
418
+
419
+ ### 5.2 性能优化策略
420
+
421
+ - 数据库查询优化(索引、分页)
422
+ - 缓存策略(Redis/本地缓存)
423
+ - 异步处理(线程池、消息队列)
424
+
425
+ ### 5.3 安全性考虑
426
+
427
+ - 认证和授权策略
428
+ - 数据加密
429
+ - SQL 注入防护
430
+ - XSS 防护
431
+
432
+ ### 5.4 缓存策略
433
+
434
+ - 缓存位置(本地/分布式)
435
+ - 缓存粒度
436
+ - 缓存更新策略
437
+ - 缓存失效策略
438
+
439
+ ## 6. 数据库变更脚本(详细)
440
+
441
+ ### 6.1 新增表的 DDL
442
+
443
+ ```sql
444
+ CREATE TABLE xxx (
445
+ id BIGINT AUTO_INCREMENT PRIMARY KEY,
446
+ field1 VARCHAR(255) NOT NULL COMMENT '字段1',
447
+ field2 INT DEFAULT 0 COMMENT '字段2',
448
+ created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
449
+ updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
450
+ INDEX idx_field1 (field1)
451
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='表说明';
452
+ ```
453
+ ````
454
+
455
+ ### 6.2 现有表的 ALTER 脚本
456
+
457
+ ```sql
458
+ ALTER TABLE existing_table ADD COLUMN new_field VARCHAR(100);
459
+ ALTER TABLE existing_table ADD INDEX idx_new_field (new_field);
460
+ ```
461
+
462
+ ### 6.3 索引优化
463
+ - 新增索引
464
+ - 修改索引
465
+ - 复合索引设计
466
+
467
+ ### 6.4 数据迁移脚本
468
+ - 数据初始化
469
+ - 数据转换
470
+ - 数据清理
471
+
472
+ ## 7. 技术风险和注意事项
473
+
474
+ ### 7.1 兼容性风险
475
+ - API 兼容性
476
+ - 数据库向后兼容
477
+ - 依赖版本冲突
478
+
479
+ ### 7.2 性能影响
480
+ - 新增查询的性能评估
481
+ - 数据量增长预测
482
+ - 性能瓶颈识别
483
+
484
+ ### 7.3 技术债务
485
+ - 已知的设计妥协
486
+ - 需要重构的遗留代码
487
+ - 后续优化计划
488
+
489
+ ## 8. 实施指导
490
+
491
+ ### 8.1 开发顺序建议
492
+ - 模块开发顺序
493
+ - 依赖关系处理
494
+ - 集成测试策略
495
+
496
+ ### 8.2 测试策略
497
+ - 单元测试覆盖率目标
498
+ - 集成测试场景
499
+ - 性能测试基准
500
+
501
+ ### 8.3 部署注意事项
502
+ - 数据库迁移步骤
503
+ - 配置变更
504
+ - 灰度发布建议
505
+
506
+ ```
507
+
508
+ ```
509
+
510
+ #### 5.2 数据库迁移脚本 ⭐⭐⭐(可直接执行)
511
+
512
+ - **文件路径**: `docs/architecture/db-migration-scripts.sql`
513
+ - **生成智能体**: Architect
514
+ - **生成时机**: 第4步 - 与架构设计文档同时生成
515
+ - **文件内容**:
516
+
517
+ ```sql
518
+ -- =============================================
519
+ -- 数据库迁移脚本
520
+ -- 项目: {项目名称}
521
+ -- 版本: {版本号}
522
+ -- 创建日期: {日期}
523
+ -- 说明: 迭代需求的数据库变更脚本
524
+ -- =============================================
525
+
526
+ -- 1. 新增表
527
+ CREATE TABLE new_table_1 (
528
+ id BIGINT AUTO_INCREMENT PRIMARY KEY,
529
+ field1 VARCHAR(255) NOT NULL COMMENT '字段1',
530
+ field2 INT DEFAULT 0 COMMENT '字段2',
531
+ created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
532
+ updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
533
+ INDEX idx_field1 (field1)
534
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='新表1';
535
+
536
+ CREATE TABLE new_table_2 (
537
+ ...
538
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='新表2';
539
+
540
+ -- 2. 修改现有表
541
+ ALTER TABLE existing_table_1
542
+ ADD COLUMN new_field1 VARCHAR(100) COMMENT '新增字段1',
543
+ ADD COLUMN new_field2 INT DEFAULT 0 COMMENT '新增字段2';
544
+
545
+ ALTER TABLE existing_table_2
546
+ ADD INDEX idx_new_field (new_field);
547
+
548
+ -- 3. 数据迁移
549
+ INSERT INTO new_table_1 (field1, field2)
550
+ SELECT old_field1, old_field2
551
+ FROM existing_table
552
+ WHERE condition;
553
+
554
+ -- 4. 回滚脚本(注释形式保存)
555
+ -- 如需回滚,执行以下脚本:
556
+ -- DROP TABLE IF EXISTS new_table_1;
557
+ -- DROP TABLE IF EXISTS new_table_2;
558
+ -- ALTER TABLE existing_table_1 DROP COLUMN new_field1;
559
+ -- ALTER TABLE existing_table_1 DROP COLUMN new_field2;
560
+ ```
561
+
562
+ ---
563
+
564
+ ### 6. 完成报告
565
+
566
+ #### 6.1 需求分析完成报告
567
+
568
+ - **文件路径**: `docs/requirements-analysis-completion-report.md`
569
+ - **生成智能体**: 系统自动生成
570
+ - **生成时机**: 工作流完成时
571
+ - **文档内容**:
572
+
573
+ ```markdown
574
+ # 需求分析自动化工作流完成报告
575
+
576
+ ## 1. 工作流执行概况
577
+
578
+ - 总耗时: {duration}
579
+ - 成功完成的步骤: 6/6
580
+
581
+ ## 2. 生成的文档清单
582
+
583
+ - 需求分析报告: docs/requirements/requirements-analysis.md
584
+ - 架构分析报告: docs/architecture/current-architecture-analysis.md
585
+ - PRD 文档: docs/prd/brownfield-iteration-prd.md
586
+ - Epic 文档: docs/epics/史诗-\*.md ({count} 个)
587
+ - 架构设计文档: docs/architecture/iteration-backend-design.md
588
+ - 数据库脚本: docs/architecture/db-migration-scripts.sql
589
+
590
+ ## 3. 下一步建议
591
+
592
+ - 下一阶段: 用户故事创建和细化
593
+ - 建议使用: automated-story-development.yaml 工作流
594
+ - 前置条件已满足:
595
+ - Epic 文档已创建
596
+ - 数据库设计已完成
597
+ - 架构设计已完成
598
+
599
+ ## 4. 关键指标
600
+
601
+ - 识别的 Epic 数量: {epic_count}
602
+ - 识别的数据表数量: {table_count}
603
+ - 识别的 API 端点数量: {api_count}
604
+ - 预估的用户故事数量: {story_count}
605
+ ```
606
+
607
+ ---
608
+
609
+ ## 📊 文档依赖关系图
610
+
611
+ ```mermaid
612
+ graph TD
613
+ A[docs/req.txt<br/>PM提供的需求] --> B[docs/requirements/<br/>requirements-analysis.md<br/>需求分析报告]
614
+
615
+ B --> C[docs/architecture/<br/>current-architecture-analysis.md<br/>现有架构分析]
616
+
617
+ B --> D[docs/prd/<br/>brownfield-iteration-prd.md<br/>Brownfield PRD]
618
+ C --> D
619
+
620
+ D --> E[docs/epics/<br/>史诗-*.md<br/>史诗文档集合]
621
+
622
+ D --> F[docs/architecture/<br/>iteration-backend-design.md<br/>迭代架构设计]
623
+ E --> F
624
+ C --> F
625
+
626
+ F --> G[docs/architecture/<br/>db-migration-scripts.sql<br/>数据库迁移脚本]
627
+
628
+ B --> H[docs/requirements-analysis-<br/>completion-report.md<br/>完成报告]
629
+ C --> H
630
+ D --> H
631
+ E --> H
632
+ F --> H
633
+ G --> H
634
+
635
+ style A fill:#FFE4B5
636
+ style B fill:#E6E6FA
637
+ style C fill:#FFE4B5
638
+ style D fill:#ADD8E6
639
+ style E fill:#98FB98
640
+ style F fill:#FFB6C1
641
+ style G fill:#FFA07A
642
+ style H fill:#90EE90
643
+ ```
644
+
645
+ ---
646
+
647
+ ## 🎯 核心架构文档重点说明
648
+
649
+ ### ⭐⭐⭐ 最重要的架构文档
650
+
651
+ #### 1. `iteration-backend-design.md` - 迭代后端架构增量设计
652
+
653
+ **为什么最重要**:
654
+
655
+ - **直接可执行**: 包含完整的实现细节
656
+ - **技术蓝图**: Entity 类、数据表 DDL、API 端点、Service 设计
657
+ - **实施指导**: 开发顺序、测试策略、部署注意事项
658
+ - **开发依据**: 开发人员直接按此文档编码
659
+
660
+ **包含的关键信息**:
661
+
662
+ - ✅ Java Entity 类设计(完整字段和注解)
663
+ - ✅ 数据表 CREATE TABLE 语句
664
+ - ✅ RESTful API 端点列表(URL、方法、参数、响应)
665
+ - ✅ DTO 类设计
666
+ - ✅ Service 接口和实现
667
+ - ✅ 业务逻辑流程图
668
+ - ✅ 事务边界设计
669
+ - ✅ 性能优化策略
670
+ - ✅ 安全设计
671
+ - ✅ 缓存策略
672
+
673
+ #### 2. `db-migration-scripts.sql` - 数据库迁移脚本
674
+
675
+ **为什么重要**:
676
+
677
+ - **可直接执行**: 复制粘贴即可在数据库中运行
678
+ - **完整的 DDL**: 所有 CREATE TABLE 和 ALTER TABLE 语句
679
+ - **数据迁移**: 数据初始化和转换脚本
680
+ - **回滚方案**: 包含回滚脚本(注释形式)
681
+
682
+ **包含的关键信息**:
683
+
684
+ - ✅ 所有新增表的完整 CREATE TABLE 语句
685
+ - ✅ 现有表的 ALTER TABLE 语句
686
+ - ✅ 索引创建语句
687
+ - ✅ 数据迁移 INSERT/UPDATE 语句
688
+ - ✅ 回滚脚本
689
+
690
+ ### ⭐⭐ 重要的上下文文档
691
+
692
+ #### 3. `current-architecture-analysis.md` - 现有架构分析
693
+
694
+ **作用**:
695
+
696
+ - 提供技术约束和规范
697
+ - 确保新设计与现有架构一致
698
+ - 识别现有数据表和 API
699
+ - 定义编码规范
700
+
701
+ #### 4. `brownfield-iteration-prd.md` - Brownfield PRD
702
+
703
+ **作用**:
704
+
705
+ - 定义所有功能需求
706
+ - 定义非功能需求
707
+ - 定义验收标准
708
+ - 建议史诗拆分
709
+
710
+ #### 5. `史诗-*.md` - 史诗文档集合
711
+
712
+ **作用**:
713
+
714
+ - 功能模块划分
715
+ - 初步识别用户故事
716
+ - 史诗级别的技术概要
717
+ - 工作量估算
718
+
719
+ ### ⭐ 分析和规划文档
720
+
721
+ #### 6. `requirements-analysis.md` - 需求分析报告
722
+
723
+ **作用**:
724
+
725
+ - 需求澄清和分类
726
+ - 用户角色和场景
727
+ - 依赖关系和优先级
728
+ - 风险识别
729
+
730
+ ---
731
+
732
+ ## 🔄 文档生成流程时序图
733
+
734
+ ```mermaid
735
+ sequenceDiagram
736
+ participant U as 用户
737
+ participant A as Analyst
738
+ participant Arc as Architect
739
+ participant PM as PM
740
+
741
+ U->>A: 提供 req.txt
742
+ A->>A: 分析需求
743
+ A-->>U: requirements-analysis.md
744
+
745
+ U->>Arc: 分析现有项目
746
+ Arc->>Arc: 扫描代码库
747
+ Arc-->>U: current-architecture-analysis.md
748
+
749
+ U->>PM: 创建 PRD
750
+ PM->>PM: 结合需求和架构
751
+ PM-->>U: brownfield-iteration-prd.md
752
+
753
+ U->>PM: 拆分史诗
754
+ loop 每个史诗
755
+ PM->>PM: 创建史诗文档
756
+ PM-->>U: 史诗-{name}.md
757
+ end
758
+
759
+ U->>Arc: 设计架构
760
+ Arc->>Arc: 增量设计
761
+ Arc-->>U: iteration-backend-design.md
762
+ Arc-->>U: db-migration-scripts.sql
763
+
764
+ Arc->>U: 🎉 完成报告
765
+ ```
766
+
767
+ ---
768
+
769
+ ## 📋 质量保证
770
+
771
+ ### 每个文档的质量检查
772
+
773
+ 1. **requirements-analysis.md**:
774
+ - ✅ 需求完整性 100%
775
+ - ✅ 清晰度 ≥9/10
776
+ - ✅ 优先级覆盖 100%
777
+ - ✅ 依赖映射 ≥90%
778
+
779
+ 2. **current-architecture-analysis.md**:
780
+ - ✅ 技术栈识别完整
781
+ - ✅ 现有数据表已列出
782
+ - ✅ 现有 API 已记录
783
+ - ✅ 编码规范已说明
784
+
785
+ 3. **brownfield-iteration-prd.md**:
786
+ - ✅ 需求覆盖率 100%
787
+ - ✅ 清晰度 ≥9/10
788
+ - ✅ 技术对齐度 100%
789
+ - ✅ 可测试性 ≥9/10
790
+
791
+ 4. **史诗-\*.md**:
792
+ - ✅ 史诗规模适中(2-4周)
793
+ - ✅ 故事数量合理(5-15个)
794
+ - ✅ 技术设计一致
795
+ - ✅ 数据库变更相对独立
796
+
797
+ 5. **iteration-backend-design.md**:
798
+ - ✅ 一致性 ≥9/10
799
+ - ✅ 完整性 100%
800
+ - ✅ 质量评分 ≥9/10
801
+ - ✅ 可行性 ≥8/10
802
+
803
+ 6. **db-migration-scripts.sql**:
804
+ - ✅ SQL 语法正确
805
+ - ✅ 所有表和字段已定义
806
+ - ✅ 索引设计合理
807
+ - ✅ 包含回滚方案
808
+
809
+ ---
810
+
811
+ ## 🚀 后续使用指南
812
+
813
+ ### 1. 架构设计文档的使用
814
+
815
+ **开发阶段**:
816
+
817
+ ```
818
+ iteration-backend-design.md
819
+
820
+ 【第2节】创建 Entity 类
821
+
822
+ 【第6节】执行数据库迁移脚本
823
+
824
+ 【第4节】创建 Service 接口和实现
825
+
826
+ 【第3节】创建 Controller 和 DTO
827
+
828
+ 【第8节】按实施指导进行测试和部署
829
+ ```
830
+
831
+ **数据库变更**:
832
+
833
+ ```bash
834
+ # 1. 审查 SQL 脚本
835
+ cat docs/architecture/db-migration-scripts.sql
836
+
837
+ # 2. 在测试环境执行
838
+ mysql -u user -p database < docs/architecture/db-migration-scripts.sql
839
+
840
+ # 3. 验证表结构
841
+ SHOW CREATE TABLE new_table_name;
842
+
843
+ # 4. 如需回滚,使用脚本中的回滚部分
844
+ ```
845
+
846
+ ### 2. 文档间的引用关系
847
+
848
+ - **开发时**: 主要看 `iteration-backend-design.md`
849
+ - **需要业务背景**: 查看 `brownfield-iteration-prd.md`
850
+ - **需要技术规范**: 查看 `current-architecture-analysis.md`
851
+ - **需要功能拆分**: 查看 `史诗-*.md`
852
+
853
+ ### 3. 与下游工作流的衔接
854
+
855
+ 生成的文档直接作为 `automated-story-development.yaml` 工作流的输入:
856
+
857
+ - ✅ Epic 文档已创建 → 用于生成用户故事
858
+ - ✅ 数据库设计已完成 → 指导数据层开发
859
+ - ✅ 架构设计已完成 → 指导服务层和 API 层开发
860
+
861
+ ---
862
+
863
+ ## 📈 总结
864
+
865
+ ### 文档数量统计
866
+
867
+ | 类别 | 文档数量 | 核心程度 |
868
+ | ------------ | ---------- | ---------- |
869
+ | 需求分析 | 1-2个 | ⭐ |
870
+ | 架构分析 | 1个 | ⭐⭐ |
871
+ | PRD | 1个 | ⭐⭐ |
872
+ | 史诗 | 3-8个 | ⭐⭐ |
873
+ | **架构设计** | **2个** | **⭐⭐⭐** |
874
+ | 完成报告 | 1个 | ⭐ |
875
+ | **总计** | **9-15个** | - |
876
+
877
+ ### 最关键的架构文档
878
+
879
+ 🏆 **Top 2 架构文档**(开发必读):
880
+
881
+ 1. **`iteration-backend-design.md`**
882
+ - 完整的技术实现方案
883
+ - Entity、DDL、API、Service 全覆盖
884
+ - 直接指导开发编码
885
+
886
+ 2. **`db-migration-scripts.sql`**
887
+ - 可直接执行的 SQL 脚本
888
+ - 数据库变更的唯一来源
889
+ - 包含回滚方案
890
+
891
+ ### 工作流价值
892
+
893
+ **自动化程度**: 90%
894
+ **人工介入点**: 需求审查、质量检查、最终批准
895
+ **时间节省**: 传统方式需 1-2 天,自动化仅需 1.5-2.5 小时
896
+ **质量保证**: 内置 18 项质量检查,确保文档一致性和完整性