@zeyue0329/xiaoma-cli 1.0.24 → 1.0.26

package/xiaoma-core/agents/requirements-coverage-auditor.yaml

@@ -0,0 +1,373 @@
+# Requirements Coverage Auditor Agent
+# 需求覆盖度审计代理
+
+meta:
+  name: "Requirements Coverage Auditor"
+  version: "1.0"
+  description: "专门用于检查需求覆盖度和用户故事实施完整性的审计代理"
+  created_date: "2025-09-10"
+  specialization: "requirements_validation_and_audit"
+
+# ========== 代理能力定义 ==========
+agent_capabilities:
+  core_functions:
+    - "PRD文档分析和需求提取"
+    - "用户故事完整性验证"
+    - "需求到故事的映射分析"
+    - "实施状态真实性验证"
+    - "覆盖度差距识别"
+    - "综合审计报告生成"
+
+  analysis_depth:
+    - "语义级需求理解"
+    - "结构化文档解析"
+    - "跨文档关联分析"
+    - "实施证据验证"
+    - "质量标准符合度检查"
+
+# ========== 审计执行引擎 ==========
+audit_execution_engine:
+  # 阶段1：文档发现和解析
+  phase_1_document_discovery:
+    name: "文档发现和解析阶段"
+    actions:
+      - action: "scan_prd_documents"
+        description: "扫描并解析PRD文档"
+        targets:
+          - "云链API平台需求文档.md"
+          - "docs/prd/史诗-*.md"
+        parsing_rules:
+          - extract_epic_definitions
+          - identify_user_story_requirements
+          - parse_acceptance_criteria
+          - extract_functional_requirements
+
+      - action: "scan_implemented_stories"
+        description: "扫描已实施的用户故事"
+        targets:
+          - "docs/stories/epic*-story*.md"
+        parsing_rules:
+          - extract_story_metadata
+          - analyze_implementation_status
+          - verify_content_completeness
+          - check_required_sections
+
+      - action: "load_summary_documents"
+        description: "加载汇总文档"
+        targets:
+          - "docs/stories/COMPLETED_STORIES_SUMMARY.md"
+        parsing_rules:
+          - extract_completion_statistics
+          - verify_summary_accuracy
+
+  # 阶段2：需求映射分析
+  phase_2_requirement_mapping:
+    name: "需求映射分析阶段"
+    actions:
+      - action: "build_requirements_hierarchy"
+        description: "构建需求层次结构"
+        algorithms:
+          - epic_to_story_mapping
+          - story_to_requirement_tracing
+          - dependency_relationship_analysis
+
+      - action: "create_coverage_matrix"
+        description: "创建覆盖度矩阵"
+        matrix_dimensions:
+          - epic_level_requirements
+          - user_story_level_requirements
+          - implementation_status
+          - completion_evidence
+
+      - action: "identify_mapping_gaps"
+        description: "识别映射差距"
+        gap_types:
+          - unmapped_requirements
+          - orphaned_stories
+          - inconsistent_implementations
+          - missing_dependencies
+
+  # 阶段3：实施完整性验证
+  phase_3_implementation_verification:
+    name: "实施完整性验证阶段"
+    validation_layers:
+      - layer: "structural_completeness"
+        name: "结构完整性验证"
+        checks:
+          - required_sections_presence
+          - section_hierarchy_correctness
+          - content_format_compliance
+          - template_adherence_verification
+        scoring_weight: 25
+
+      - layer: "content_completeness"
+        name: "内容完整性验证"
+        checks:
+          - user_story_format_validation
+          - acceptance_criteria_adequacy
+          - database_design_completeness
+          - api_specification_completeness
+          - task_breakdown_completeness
+        scoring_weight: 35
+
+      - layer: "implementation_evidence"
+        name: "实施证据验证"
+        checks:
+          - developer_records_presence
+          - qa_results_authenticity
+          - file_lists_accuracy
+          - implementation_details_verification
+        scoring_weight: 25
+
+      - layer: "quality_standards"
+        name: "质量标准符合度"
+        checks:
+          - technical_accuracy_assessment
+          - documentation_clarity
+          - consistency_verification
+          - business_value_alignment
+        scoring_weight: 15
+
+  # 阶段4：差距分析和建议
+  phase_4_gap_analysis_recommendations:
+    name: "差距分析和改进建议阶段"
+    analysis_methods:
+      - method: "coverage_gap_analysis"
+        description: "覆盖度差距分析"
+        techniques:
+          - requirement_coverage_calculation
+          - priority_weighted_coverage
+          - critical_path_analysis
+          - risk_impact_assessment
+
+      - method: "quality_gap_analysis"
+        description: "质量差距分析"
+        techniques:
+          - completeness_gap_identification
+          - consistency_deviation_analysis
+          - implementation_quality_assessment
+          - documentation_standard_compliance
+
+      - method: "improvement_prioritization"
+        description: "改进优先级分析"
+        criteria:
+          - business_value_impact
+          - implementation_complexity
+          - resource_requirement
+          - timeline_constraints
+
+# ========== 分析算法配置 ==========
+analysis_algorithms:
+  # 需求提取算法
+  requirement_extraction:
+    - algorithm: "semantic_parsing"
+      description: "语义解析需求文本"
+      techniques:
+        - keyword_identification
+        - context_analysis
+        - dependency_extraction
+        - priority_inference
+
+    - algorithm: "structure_analysis"
+      description: "分析文档结构"
+      techniques:
+        - section_hierarchy_parsing
+        - content_classification
+        - relationship_mapping
+        - metadata_extraction
+
+  # 映射分析算法
+  mapping_analysis:
+    - algorithm: "similarity_matching"
+      description: "基于相似度的需求故事匹配"
+      techniques:
+        - text_similarity_calculation
+        - semantic_similarity_assessment
+        - structural_similarity_evaluation
+
+    - algorithm: "dependency_tracing"
+      description: "依赖关系追踪"
+      techniques:
+        - forward_tracing
+        - backward_tracing
+        - cross_reference_validation
+
+  # 完整性验证算法
+  completeness_verification:
+    - algorithm: "template_compliance_check"
+      description: "模板合规性检查"
+      validation_rules:
+        - required_sections_check
+        - format_consistency_validation
+        - content_quality_assessment
+
+    - algorithm: "evidence_verification"
+      description: "实施证据验证"
+      verification_methods:
+        - content_authenticity_check
+        - implementation_consistency_validation
+        - quality_metric_verification
+
+# ========== 报告生成配置 ==========
+report_generation:
+  # 报告模板
+  report_templates:
+    executive_summary_template: |
+      # 需求覆盖度审计报告 - 执行摘要
+
+      ## 🎯 审计概览
+      - **审计日期**: {{audit_date}}
+      - **审计范围**: {{audit_scope}}
+      - **总体评级**: {{overall_rating}}
+
+      ## 📊 关键指标
+      - **需求总数**: {{total_requirements}}
+      - **已实施用户故事**: {{implemented_stories}}
+      - **覆盖度**: {{coverage_percentage}}%
+      - **完整性评分**: {{completeness_score}}/100
+
+      ## 🔍 关键发现
+      {{key_findings}}
+
+      ## ⚡ 优先改进建议
+      {{priority_recommendations}}
+
+    detailed_analysis_template: |
+      # 需求覆盖度详细分析
+
+      ## 📋 需求覆盖度矩阵
+      {{coverage_matrix_table}}
+
+      ## ✅ 用户故事完整性分析
+      {{story_completeness_analysis}}
+
+      ## 🔗 需求到故事映射
+      {{requirement_story_mapping}}
+
+      ## ⚠️ 识别的问题和差距
+      {{identified_gaps_and_issues}}
+
+      ## 📈 质量趋势分析
+      {{quality_trend_analysis}}
+
+    action_plan_template: |
+      # 实施改进行动计划
+
+      ## 🚨 立即行动项（高优先级）
+      {{immediate_actions}}
+
+      ## 📅 短期改进计划（2-4周）
+      {{short_term_plan}}
+
+      ## 🎯 长期完善建议（1-3个月）
+      {{long_term_recommendations}}
+
+      ## 💼 资源需求评估
+      {{resource_requirements}}
+
+      ## 📊 成功度量标准
+      {{success_metrics}}
+
+  # 数据可视化
+  visualization_options:
+    - type: "coverage_heatmap"
+      description: "需求覆盖度热力图"
+      axes: ["epic", "story", "completion_status"]
+
+    - type: "completeness_radar_chart"
+      description: "用户故事完整性雷达图"
+      dimensions: ["structure", "content", "implementation", "quality"]
+
+    - type: "gap_analysis_matrix"
+      description: "差距分析矩阵"
+      dimensions: ["priority", "complexity", "impact"]
+
+# ========== 质量阈值配置 ==========
+quality_thresholds:
+  coverage_thresholds:
+    excellent: 95 # 优秀覆盖度
+    good: 85 # 良好覆盖度
+    acceptable: 75 # 可接受覆盖度
+    poor: 60 # 较差覆盖度
+
+  completeness_thresholds:
+    structure_completeness: 90 # 结构完整性阈值
+    content_quality: 85 # 内容质量阈值
+    implementation_evidence: 80 # 实施证据阈值
+    overall_completeness: 85 # 整体完整性阈值
+
+  quality_gates:
+    critical_requirements_coverage: 100 # 关键需求100%覆盖
+    high_priority_completeness: 90 # 高优先级故事90%完整
+    documentation_standards: 85 # 文档标准85%符合
+
+# ========== 输出配置 ==========
+output_configuration:
+  primary_outputs:
+    - name: "comprehensive_audit_report"
+      location: "audit-reports/"
+      filename: "requirements_coverage_audit_{{timestamp}}.md"
+      includes: ["executive_summary", "detailed_analysis", "action_plan"]
+
+    - name: "coverage_matrix_data"
+      location: "audit-data/"
+      filename: "coverage_matrix_{{timestamp}}.json"
+      format: "structured_json"
+
+    - name: "gap_analysis_report"
+      location: "audit-reports/"
+      filename: "implementation_gaps_{{timestamp}}.md"
+      focus: "actionable_improvements"
+
+  supplementary_outputs:
+    - name: "story_completeness_scores"
+      location: "audit-data/"
+      filename: "completeness_scores_{{timestamp}}.json"
+
+    - name: "requirements_inventory"
+      location: "audit-data/"
+      filename: "requirements_inventory_{{timestamp}}.json"
+
+    - name: "improvement_roadmap"
+      location: "audit-reports/"
+      filename: "improvement_roadmap_{{timestamp}}.md"
+
+# ========== 执行模式 ==========
+execution_modes:
+  comprehensive_audit:
+    description: "全面审计模式"
+    scope: "all_requirements_and_stories"
+    depth: "deep_analysis"
+    duration: "20-30 minutes"
+
+  focused_audit:
+    description: "专注审计模式"
+    scope: "specific_epic_or_story_set"
+    depth: "targeted_analysis"
+    duration: "10-15 minutes"
+
+  quick_validation:
+    description: "快速验证模式"
+    scope: "completion_status_verification"
+    depth: "surface_level_check"
+    duration: "5-8 minutes"
+
+# ========== 成功标准 ==========
+success_criteria:
+  audit_accuracy:
+    - "100%文档发现和解析"
+    - "准确的需求故事映射"
+    - "可靠的完整性评估"
+    - "真实的实施状态验证"
+
+  report_usefulness:
+    - "清晰的执行摘要"
+    - "具体的改进建议"
+    - "可行的行动计划"
+    - "准确的优先级排序"
+
+  actionable_insights:
+    - "识别具体覆盖度差距"
+    - "提供实施改进路径"
+    - "估算资源需求"
+    - "制定时间计划"

package/xiaoma-core/docs/ENHANCED_WORKFLOW_USAGE_GUIDE.md

@@ -0,0 +1,306 @@
+# Enhanced Workflow Usage Guide
+
+# 增强工作流使用指南
+
+## 🎯 系统概述
+
+基于之前项目实施经验，我们构建了一个全自动化、多层质量保证的工作流系统，确保零容错和最高质量标准。
+
+### 核心优势
+
+- **全流程自动化**: 99%的任务无需人工干预
+- **多层质量保证**: 7层质量验证，确保无质量缺陷
+- **智能纠错**: 自动检测和修正问题
+- **零容错标准**: 关键质量门100%通过率
+- **实时监控**: 全程可视化进度跟踪
+
+## 🏗️ 系统架构
+
+### 四大核心组件
+
+1. **增强工作流编排器** (`enhanced-workflow-orchestrator.yaml`)
+   - 任务规划和依赖管理
+   - 并行处理优化
+   - 回滚和恢复机制
+
+2. **智能模板适配器** (`intelligent-template-adapter.yaml`)
+   - 自动模板理解和验证
+   - 智能内容生成
+   - 多维质量验证
+
+3. **自动化质量验证器** (`automated-quality-validator.yaml`)
+   - 7层质量验证系统
+   - 实时错误检测和纠正
+   - 质量指标监控
+
+4. **主执行引擎** (`master-execution-engine.yaml`)
+   - 统一编排和控制
+   - 质量门控管理
+   - 综合报告生成
+
+## 🚀 使用方法
+
+### 方法1: 直接调用增强工作流
+
+```markdown
+\*start-enhanced-workflow
+```
+
+系统将自动执行以下流程：
+
+1. 项目分析和模板理解验证
+2. 智能任务规划和优化
+3. 批量文档处理（7层质量验证）
+4. 跨文档集成验证
+5. 最终交付准备
+
+### 方法2: 指定特定配置
+
+```markdown
+\*start-enhanced-workflow --mode=MAXIMUM_QUALITY --batch-size=3 --parallel=true
+```
+
+### 方法3: 针对特定文档类型
+
+```markdown
+\*start-template-enhancement --template=enhanced-story-with-database-tmpl.yaml --target=docs/stories/
+```
+
+## 📋 执行阶段详解
+
+### 阶段1: 初始化和准备 (5-10分钟)
+
+- ✅ 系统健康检查
+- ✅ 项目上下文加载
+- ✅ 模板智能系统激活
+- ✅ 质量验证系统准备
+
+**质量门控**: 2个关键检查点
+
+### 阶段2: 智能任务规划 (10-15分钟)
+
+- ✅ 任务范围分析
+- ✅ 执行策略优化
+- ✅ 质量保证规划
+
+**质量门控**: 3个策略验证点
+
+### 阶段3: 自动化内容生成 (20-40分钟/批次)
+
+**7层质量验证系统**:
+
+1. **语法格式验证** (100%必须通过)
+   - Markdown语法检查
+   - 模板结构验证
+   - 内容格式标准化
+
+2. **内容完整性验证** (90%通过标准)
+   - 用户故事完整性
+   - 数据库设计完整性
+   - API规范完整性
+   - 实施指导完整性
+
+3. **内容质量验证** (87%通过标准)
+   - 技术准确性验证
+   - 清晰度和可读性
+   - 专业质量标准
+
+4. **一致性验证** (96%通过标准)
+   - 术语一致性
+   - 结构一致性
+   - 交叉引用完整性
+
+5. **实施可行性验证** (83%通过标准)
+   - 数据库设计可行性
+   - API设计可行性
+   - 实施任务可行性
+
+6. **业务价值验证** (82%通过标准)
+   - 需求可追踪性
+   - 用户体验影响
+
+7. **最终集成验证** (90%通过标准)
+   - 端到端文档验证
+   - 质量指标达成
+   - 交付准备确认
+
+### 阶段4: 跨文档集成验证 (15-25分钟)
+
+- ✅ 全局一致性验证
+- ✅ 综合质量评估
+- ✅ 集成测试和验证
+
+**质量门控**: 3个集成验证点
+
+### 阶段5: 最终交付准备 (10-15分钟)
+
+- ✅ 综合报告生成
+- ✅ 交付包最终确认
+- ✅ 成功确认和交接
+
+**质量门控**: 2个交付验证点
+
+## 🎯 质量保证机制
+
+### 零容错策略
+
+- **关键错误**: 立即停止并纠正
+- **质量缺陷**: 自动改进循环（最多3轮）
+- **一致性问题**: 批量纠正和对齐
+- **可行性问题**: 专家系统优化
+
+### 自动纠错系统
+
+1. **立即纠正**: 语法、格式、结构问题
+2. **迭代改进**: 内容质量和完整性问题
+3. **综合优化**: 集成和业务对齐问题
+
+### 质量指标
+
+- **整体质量分数**: ≥90
+- **关键层面分数**: ≥95
+- **一致性分数**: ≥95
+- **可行性分数**: ≥85
+- **业务价值分数**: ≥80
+
+## 📊 实时监控和报告
+
+### 实时监控仪表板
+
+- 阶段进度跟踪
+- 质量分数实时更新
+- 错误检测和纠正日志
+- 性能指标分析
+
+### 报告类型
+
+1. **执行摘要报告**: 高层质量概览
+2. **详细技术报告**: 逐层分析结果
+3. **质量认证报告**: 合规性证明
+4. **持续改进报告**: 优化建议
+
+## ⚙️ 配置选项
+
+### 执行模式
+
+- **最高质量模式**: 质量优先，详尽验证
+- **平衡效率模式**: 质量和效率并重
+- **快速交付模式**: 效率优先，保证基本质量
+
+### 自定义配置
+
+```yaml
+execution_config:
+  mode: 'MAXIMUM_QUALITY'
+  batch_size: 3
+  parallel_processing: true
+  quality_thresholds:
+    overall_minimum: 90
+    critical_minimum: 95
+  max_correction_attempts: 3
+  comprehensive_reporting: true
+```
+
+## 🔧 故障排除
+
+### 常见问题及解决方案
+
+**问题1**: 模板理解验证失败
+
+- **解决**: 系统自动重新读取并分析模板文件
+- **预防**: 确保模板文件路径正确且可访问
+
+**问题2**: 质量验证层失败
+
+- **解决**: 自动触发纠错循环，最多3次尝试
+- **升级**: 如果自动纠错失败，将标记需要人工审核
+
+**问题3**: 跨文档一致性问题
+
+- **解决**: 批量一致性纠正和术语对齐
+- **预防**: 维护术语词典和命名约定
+
+### 回滚机制
+
+- **检查点回滚**: 回滚到最近成功状态
+- **部分恢复**: 仅恢复失败组件
+- **完整重启**: 系统性失败时的完整重启
+
+## 📈 性能优化
+
+### 并行处理
+
+- 批次大小: 3个文档
+- 并行验证: 7层质量验证可部分并行
+- 资源优化: 智能资源分配
+
+### 缓存策略
+
+- 模板理解结果缓存
+- 质量验证规则缓存
+- 术语词典缓存
+
+## 🎉 成功标准
+
+### 技术成功标准
+
+- ✅ 整体质量分数 ≥90
+- ✅ 关键错误数量 = 0
+- ✅ 模板合规率 = 100%
+- ✅ 内容完整性 ≥90
+- ✅ 一致性分数 ≥95
+
+### 业务成功标准
+
+- ✅ 实施准备度 = 开发就绪
+- ✅ 文档可用性 = 用户友好
+- ✅ 维护可行性 = 易于维护
+- ✅ 利益相关者满意度 = 高
+
+## 📚 最佳实践
+
+### 项目准备
+
+1. 确保所有模板文件完整且可访问
+2. 验证项目目录结构正确
+3. 确认写入权限充足
+
+### 执行期间
+
+1. 监控实时进度仪表板
+2. 注意质量门控状态
+3. 及时处理任何警报或通知
+
+### 交付后
+
+1. 审查综合质量报告
+2. 实施持续改进建议
+3. 保存质量认证文档
+
+## 🔮 持续改进
+
+### 学习机制
+
+- 从每次执行中学习和优化
+- 质量趋势分析
+- 最佳实践提取
+
+### 进化能力
+
+- 质量标准逐步提升
+- 验证算法持续优化
+- 纠错策略不断改进
+
+---
+
+## 🚀 立即开始使用
+
+只需输入以下命令即可开始使用增强工作流：
+
+```markdown
+\*start-enhanced-workflow
+```
+
+系统将自动执行所有阶段，确保最高质量标准的交付成果。
+
+**享受全自动化、零缺陷的文档处理体验！** ✨