@zeyue0329/xiaoma-cli 1.0.22 → 1.0.24

package//345/205/250/351/234/200/346/261/202/350/207/252/345/212/250/345/214/226/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

@@ -0,0 +1,613 @@
+# 全需求自动化开发流程使用指南 🌟
+
+## 概述
+
+XIAOMA-CLI™ 全需求自动化开发流程是一个革命性的项目级自动化解决方案，能够将完整的产品需求文档（PRD）自动转换为可交付的软件产品，实现从需求分析到项目交付的端到端自动化。
+
+### 核心特性
+
+- 🎯 **全需求覆盖**: 自动识别并处理PRD中的所有功能需求
+- ⚡ **智能并行处理**: 多条开发流水线并行执行，最大化开发效率
+- 🔒 **严格质量控制**: 项目级质量门控确保交付质量
+- 🤖 **完全自动化**: 从故事创建到项目交付的零人工干预
+- 📊 **实时监控**: 全程进度跟踪和智能问题处理
+
+## 架构概览
+
+### 双层编排架构
+
+```
+全需求编排器 (full-requirement-orchestrator)
+├── 项目级编排和协调
+├── 批量故事管理
+├── 并行开发调度
+└── 项目交付控制
+    │
+    ├── 故事编排器 (automation-orchestrator) - Pipeline 1
+    │   ├── SM智能体 → PO智能体 → Dev智能体 → QA智能体
+    │   └── 基础设施故事组
+    │
+    ├── 故事编排器 (automation-orchestrator) - Pipeline 2
+    │   ├── SM智能体 → PO智能体 → Dev智能体 → QA智能体
+    │   └── 核心业务故事组
+    │
+    ├── 故事编排器 (automation-orchestrator) - Pipeline 3
+    │   ├── SM智能体 → PO智能体 → Dev智能体 → QA智能体
+    │   └── 特性功能故事组
+    │
+    └── 故事编排器 (automation-orchestrator) - Pipeline 4
+        ├── SM智能体 → PO智能体 → Dev智能体 → QA智能体
+        └── 支撑功能故事组
+```
+
+### 工作流程概览
+
+1. **需求分析阶段** (5-15分钟)
+   - PRD深度分析和功能点识别
+   - 批量用户故事生成
+   - 依赖关系建立和优先级排序
+   - 并行开发计划制定
+
+2. **并行开发阶段** (主要时间消耗)
+   - 多条流水线同时启动
+   - 基础设施 → 核心业务 → 特性功能 → 支撑功能
+   - 实时进度监控和协调
+   - 自动冲突检测和解决
+
+3. **项目集成阶段** (15-30分钟)
+   - 跨模块集成测试
+   - 端到端业务流程验证
+   - 性能和安全性验证
+
+4. **项目交付阶段** (5-10分钟)
+   - 交付物打包和文档生成
+   - 部署准备和交接文档
+   - 最终质量验证
+
+## 快速开始
+
+### 前置条件
+
+1. **完整的PRD文档** (`prd.md`)
+   - 包含详细的功能需求描述
+   - 明确的用户场景和业务流程
+   - 清晰的验收标准
+
+2. **数据库设计文档** (`database_design.md`) [可选]
+   - 如已有数据库设计，将被集成到故事生成中
+   - 如无，系统将自动生成数据库设计
+
+3. **XIAOMA-CLI环境配置**
+   - 确保已配置 `team-fullstack-with-database` 团队
+   - 验证所有智能体可用
+
+### 基本使用流程
+
+#### 步骤1: 切换到全需求编排器
+
+```bash
+# 切换到全需求自动化编排器
+*agent full-requirement-orchestrator
+```
+
+#### 步骤2: 启动全需求自动化
+
+```bash
+# 启动完整需求自动化开发流程
+*start-full-requirement-automation
+```
+
+就这么简单！系统将自动执行以下流程：
+
+1. ✅ 分析PRD文档，识别所有功能点
+2. ✅ 批量生成增强版用户故事(包含数据库和API设计)
+3. ✅ 建立故事依赖关系和优先级
+4. ✅ 创建并行开发计划
+5. ✅ 启动4条并行开发流水线
+6. ✅ 每条流水线执行完整的SM→PO→Dev→QA循环
+7. ✅ 跨流水线协调和冲突解决
+8. ✅ 项目级集成测试和验证
+9. ✅ 生成最终交付物和文档
+
+### 监控和控制
+
+#### 实时监控项目进度
+
+```bash
+# 查看项目整体进度
+*monitor-project-progress
+
+# 查看各流水线状态
+*check-pipeline-status
+
+# 查看依赖关系满足情况
+*manage-story-dependencies
+```
+
+#### 问题处理
+
+```bash
+# 处理跨故事冲突
+*handle-cross-story-conflicts
+
+# 重新平衡流水线负载
+*rebalance-pipeline-load
+
+# 生成项目状态报告
+*generate-progress-report
+```
+
+## 高级功能
+
+### 自定义配置
+
+#### 指定自定义PRD文档
+
+```bash
+*start-full-requirement-automation --prd custom_requirements.md
+```
+
+#### 调整并行配置
+
+```bash
+# 使用6条并行流水线，每条最多10个故事
+*start-full-requirement-automation --pipelines 6 --max-stories 10
+```
+
+#### 包含架构约束
+
+```bash
+*start-full-requirement-automation --include-architecture-constraints
+```
+
+### 分步执行模式
+
+如果需要更精细的控制，可以分步执行：
+
+```bash
+# 步骤1: 生成所有用户故事
+*generate-all-stories
+
+# 步骤2: 编排并行开发流水线
+*orchestrate-parallel-development
+
+# 步骤3: 监控并行开发进度
+*monitor-project-progress
+
+# 步骤4: 执行项目集成测试
+*execute-project-integration
+
+# 步骤5: 生成最终交付物
+*generate-project-deliverables
+```
+
+## 并行开发流水线详解
+
+### Pipeline 1: 基础设施流水线
+
+**聚焦领域**: 基础设施和核心依赖
+**典型故事**:
+
+- 用户注册和登录系统
+- 权限管理和角色控制
+- 基础数据模型设计
+- 认证和授权机制
+
+**特点**:
+
+- 最高优先级执行
+- 为其他流水线提供基础依赖
+- 包含关键的安全和认证功能
+
+### Pipeline 2: 核心业务流水线
+
+**聚焦领域**: 核心业务功能
+**典型故事**:
+
+- 主要业务数据管理
+- 核心业务流程实现
+- 关键业务规则执行
+- 主要用户操作功能
+
+**特点**:
+
+- 依赖基础设施完成
+- 实现核心价值功能
+- 业务逻辑最复杂
+
+### Pipeline 3: 特性功能流水线
+
+**聚焦领域**: 扩展特性功能
+**典型故事**:
+
+- 高级搜索和筛选
+- 数据导入导出功能
+- 报表和统计功能
+- 用户体验优化
+
+**特点**:
+
+- 基于核心业务构建
+- 提升用户体验
+- 相对独立可并行
+
+### Pipeline 4: 支撑功能流水线
+
+**聚焦领域**: 系统支撑功能
+**典型故事**:
+
+- 系统配置管理
+- 日志监控功能
+- 数据备份恢复
+- 系统维护工具
+
+**特点**:
+
+- 优先级相对较低
+- 支撑系统运维
+- 可最后实现
+
+## 质量控制体系
+
+### 三层质量门控
+
+#### 1. 故事级质量门控
+
+- ✅ 故事格式完整性验证
+- ✅ 验收标准可测试性检查
+- ✅ 数据库映射一致性验证
+- ✅ API规范完整性检查
+- ✅ 单元测试覆盖率≥80%
+
+#### 2. 流水线级质量门控
+
+- ✅ 流水线内故事集成测试
+- ✅ API契约一致性验证
+- ✅ 数据库结构一致性检查
+- ✅ 跨故事业务逻辑验证
+
+#### 3. 项目级质量门控
+
+- ✅ 跨模块集成测试通过率≥98%
+- ✅ 端到端业务流程验证100%
+- ✅ 性能基准达标
+- ✅ 安全漏洞零容忍(高危)
+- ✅ 部署就绪度评分≥9/10
+
+### 自动化质量保证
+
+#### 持续监控
+
+- 实时代码质量监控
+- 测试覆盖率趋势分析
+- 性能指标持续跟踪
+- 安全漏洞自动扫描
+
+#### 智能预警
+
+- 质量指标下降预警
+- 进度偏差风险提示
+- 依赖阻塞自动识别
+- 资源争用智能调度
+
+## 输出产物
+
+### 开发过程产物
+
+1. **项目故事积压清单** (`project_story_backlog.md`)
+   - 完整的用户故事清单
+   - 优先级和依赖关系
+   - 开发路线图
+
+2. **故事依赖关系图** (`story_dependency_graph.yaml`)
+   - 可视化依赖关系
+   - 关键路径识别
+   - 并行执行计划
+
+3. **并行开发计划** (`parallel_development_plan.yaml`)
+   - 流水线配置和分工
+   - 同步点定义
+   - 资源分配计划
+
+4. **个体用户故事文件** (`stories/`)
+   - 每个故事的详细规范
+   - 数据库实体映射
+   - API接口定义
+   - 验收测试标准
+
+### 最终交付产物
+
+1. **部署包** (`deployment_package/`)
+   - 完整应用程序代码
+   - 数据库部署脚本
+   - 配置文件模板
+   - 依赖关系清单
+
+2. **API文档** (`api_documentation/`)
+   - RESTful API完整文档
+   - 接口契约规范
+   - 示例请求响应
+   - 错误码定义
+
+3. **数据库文档** (`database_documentation/`)
+   - 完整数据库设计文档
+   - ER图和数据字典
+   - 索引和约束说明
+   - 性能优化建议
+
+4. **用户文档** (`user_documentation/`)
+   - 用户使用手册
+   - 功能操作指南
+   - 常见问题解答
+   - 联系支持信息
+
+5. **维护文档** (`maintenance_documentation/`)
+   - 系统架构文档
+   - 部署运维指南
+   - 监控告警配置
+   - 故障排查手册
+
+6. **项目总结报告** (`project_summary_report.md`)
+   - 项目完成情况统计
+   - 质量指标分析
+   - 性能基准测试结果
+   - 风险和改进建议
+
+## 最佳实践
+
+### PRD文档准备
+
+1. **结构化组织**
+   - 使用标准的PRD模板
+   - 清晰的章节分层
+   - 详细的功能描述
+
+2. **完整的功能描述**
+   - 每个功能点都有明确描述
+   - 包含用户场景和用例
+   - 定义清晰的验收标准
+
+3. **业务流程清晰**
+   - 描述完整的业务工作流
+   - 明确异常处理流程
+   - 定义状态转换规则
+
+### 项目执行优化
+
+1. **并行度配置**
+   - 根据项目规模调整并行流水线数量
+   - 平衡资源利用和管理复杂度
+   - 考虑依赖关系的影响
+
+2. **监控频率设置**
+   - 大型项目增加监控频率
+   - 关键阶段加强实时跟踪
+   - 重要同步点设置检查点
+
+3. **质量标准调整**
+   - 根据项目需求调整质量阈值
+   - 关键业务功能提高质量要求
+   - 支撑功能适度宽松标准
+
+### 问题预防措施
+
+1. **依赖关系管理**
+   - 提前识别关键依赖
+   - 优先处理瓶颈故事
+   - 建立依赖变更管理机制
+
+2. **冲突预防**
+   - 明确API接口规范
+   - 统一数据库命名规范
+   - 建立代码review机制
+
+3. **风险缓解**
+   - 关键路径备用方案
+   - 质量问题应急处理
+   - 进度偏差调整策略
+
+## 故障排查指南
+
+### 常见问题及解决方案
+
+#### 问题1: PRD分析失败
+
+**症状**: 无法生成用户故事
+**可能原因**: PRD格式不规范或内容不完整
+**解决方案**:
+
+```bash
+# 检查PRD文档结构
+*validate-prd-structure
+
+# 补充缺失信息后重新分析
+*regenerate-story-analysis
+```
+
+#### 问题2: 并行流水线阻塞
+
+**症状**: 某条流水线长时间无进展
+**可能原因**: 依赖未满足或资源争用
+**解决方案**:
+
+```bash
+# 检查依赖满足情况
+*analyze-dependency-blocking
+
+# 重新平衡负载
+*rebalance-pipeline-load
+```
+
+#### 问题3: 集成测试失败
+
+**症状**: 跨模块集成测试不通过
+**可能原因**: API契约不一致或数据格式冲突
+**解决方案**:
+
+```bash
+# 分析集成问题
+*analyze-integration-failures
+
+# 修复冲突并重测
+*resolve-integration-conflicts
+*retry-integration-tests
+```
+
+#### 问题4: 质量门控失败
+
+**症状**: 某个质量检查点未通过
+**可能原因**: 代码质量、测试覆盖率或性能不达标
+**解决方案**:
+
+```bash
+# 详细分析质量问题
+*analyze-quality-failures
+
+# 针对性改进
+*improve-code-quality
+*increase-test-coverage
+*optimize-performance
+```
+
+### 应急恢复程序
+
+#### 流程中断恢复
+
+```bash
+# 从最近检查点恢复
+*resume-from-checkpoint
+
+# 重建项目状态
+*rebuild-project-state
+
+# 继续执行剩余任务
+*continue-automation
+```
+
+#### 数据一致性修复
+
+```bash
+# 检查数据一致性
+*validate-data-consistency
+
+# 修复不一致数据
+*repair-data-inconsistencies
+
+# 验证修复结果
+*verify-data-integrity
+```
+
+## 性能优化建议
+
+### 大型项目优化
+
+1. **流水线配置优化**
+   - 增加并行流水线数量(6-8条)
+   - 减少每条流水线的故事数量
+   - 优化依赖关系减少等待
+
+2. **资源分配优化**
+   - 为复杂故事分配更多资源
+   - 动态调整资源分配策略
+   - 监控资源利用率
+
+3. **缓存和复用**
+   - 缓存PRD分析结果
+   - 复用通用组件设计
+   - 优化重复性任务
+
+### 小型项目优化
+
+1. **简化配置**
+   - 减少并行流水线数量(2-3条)
+   - 适当放宽质量门控标准
+   - 减少监控频率
+
+2. **快速迭代**
+   - 缩短同步点间隔
+   - 加速反馈循环
+   - 简化交付流程
+
+## 高级定制
+
+### 自定义质量标准
+
+创建自定义质量配置文件 `custom_quality_standards.yaml`:
+
+```yaml
+quality_standards:
+  story_level:
+    unit_test_coverage: ≥90% # 提高测试覆盖率要求
+    code_quality_score: ≥9.0/10 # 提高代码质量要求
+
+  project_level:
+    integration_test_pass_rate: ≥99% # 提高集成测试通过率
+    security_vulnerability_count: 0 # 零漏洞容忍
+```
+
+使用自定义标准:
+
+```bash
+*start-full-requirement-automation --quality-config custom_quality_standards.yaml
+```
+
+### 自定义并行策略
+
+创建自定义并行配置 `custom_parallel_config.yaml`:
+
+```yaml
+parallel_configuration:
+  pipeline_count: 6
+  max_stories_per_pipeline: 8
+  load_balancing_strategy: 'complexity_based'
+  synchronization_strategy: 'milestone_based'
+```
+
+使用自定义配置:
+
+```bash
+*start-full-requirement-automation --parallel-config custom_parallel_config.yaml
+```
+
+### 集成外部工具
+
+#### 集成CI/CD流水线
+
+```yaml
+# cicd_integration.yaml
+integration:
+  build_trigger: 'on_story_completion'
+  deployment_trigger: 'on_integration_success'
+  notification_channels: ['slack', 'email']
+```
+
+#### 集成项目管理工具
+
+```yaml
+# project_management_integration.yaml
+integration:
+  jira_sync: enabled
+  story_mapping: 'automatic'
+  progress_reporting: 'real_time'
+```
+
+## 总结
+
+XIAOMA-CLI™ 全需求自动化开发流程为软件开发带来了革命性的变化，实现了从需求到交付的完全自动化。通过智能并行处理、严格质量控制和实时监控，显著提升了开发效率和交付质量。
+
+### 关键优势
+
+1. **效率提升**: 并行处理提升开发效率75%以上
+2. **质量保证**: 严格的三层质量门控确保交付质量
+3. **风险降低**: 自动化流程减少人为错误和遗漏
+4. **可观测性**: 实时监控和智能预警确保项目可控
+5. **标准化**: 统一的开发流程和质量标准
+
+### 适用场景
+
+- ✅ 中大型软件项目的端到端开发
+- ✅ 需要快速原型验证的创新项目
+- ✅ 多团队协作的复杂系统开发
+- ✅ 对质量和交付时间要求严格的商业项目
+
+通过本指南，您已经掌握了XIAOMA-CLI™ 全需求自动化开发流程的完整使用方法。立即开始您的自动化开发之旅吧！