# SPARC 方法论 - 综合开发框架 ## 概述 SPARC（规范、伪代码、架构、细化、完成）是与该框架的多代理编排功能集成的系统开发方法。它为全面的软件开发提供了 17 种专门模式，从最初的研究到部署和监控。 **在 agent-studio 中：** 当下面的 `mcp__claude-flow__*` 或 `npx claude-flow` 示例不可用时，请使用任务工具生成代理（例如规划人员、开发人员、质量保证、架构师）并遵循 `.claude/workflows/` 和 router-decision.md 中的工作流程。 ## 目录一、核心理念 2. 发展阶段 3. 可用模式 4. 激活方法 5. 编排模式 6.TDD 工作流程 7. 最佳实践 8. 集成示例 9. 通用工作流程 ** ** ## 核心理念 SPARC 方法强调： * **系统方法**：从规范到完成的结构化阶段 * **测试驱动开发** ：在实施之前编写测试 * **并行执行**：并发代理协调，速度提高 2.8-4.4 倍 * **内存集成**：跨代理和会话持续共享知识 * **质量第一**：全面审查、测试和验证 * **模块化设计**：通过清晰的界面清晰地分离关注点 ### 关键原则 1. **规范先于代码**：明确定义需求和约束 2. **实施前设计**：规划架构和组件 3. **功能之前的测试**：编写失败的测试，然后使它们通过 4. **审查一切**：代码质量、安全性和性能检查 5. **持续记录**：始终维护当前的文档 ** ** ## 开发阶段 ### 第 1 阶段：规范 **目标**：定义要求、约束和成功标准 * 需求分析 * 用户故事映射 * 约束识别 * 成功指标定义 * 伪代码规划 **关键模式**：“研究员”、“分析器”、“内存管理器” ### 第 2 阶段：架构 **目标**：设计系统结构和组件接口 * 系统架构设计 * 组件接口定义 * 数据库架构规划 * API合约规范 * 基础设施规划 **关键模式** ：“建筑师”、“设计师”、“编排者” ### 第 3 阶段：细化（TDD 实施） **目标**：通过测试优先的方法实现功能 * 编写失败的测试 * 实施最小可行代码 * 使测试通过 * 重构质量 * 迭代直到完成 **关键模式**：`tdd`、`coder`、`tester` ### 第 4 阶段：审核 **目标**：确保代码质量、安全性和性能 * 代码质量评估 * 安全漏洞扫描 * 性能分析 * 最佳实践验证 * 文件审查 **关键模式**：`审查器`、`优化器`、`调试器` ### 第 5 阶段：完成 **目标**：集成、部署和监控 * 系统集成 * 部署自动化 * 监控设置 * 文档最终确定 * 知识捕获 **关键模式**：`工作流程管理器`、`文档管理器`、`内存管理器` ** ** ## 可用模式 ### 核心编排模式 #### `编曲家` 通过 TaskCreate/Task/Memory 协调进行多代理任务编排。 **能力**： * 任务分解为可管理的单元 * 代理协调和资源分配 * 进度跟踪和结果综合 * 自适应策略选择 * 跨代理通信 **用法**： mcp__claude-flow__sparc_mode { 模式：“协调器”， task_description: “协调功能开发”, 选项：{并行：true，监视器：true} } #### `群体协调员` 针对复杂的多代理工作流程的专门群体管理。 **能力**： * 拓扑优化（网状、分层、环型、星型） * 代理生命周期管理 * 根据工作负载动态扩展 * 容错和恢复 * 性能监控 #### `工作流程管理器` 流程自动化和工作流程编排。 **能力**： * 工作流程定义和执行 * 事件驱动的触发器 * 串行和并行管道 * 状态管理 * 错误处理和重试逻辑 #### `批处理执行器` 高吞吐量操作的并行任务执行。 **能力**： * 并发文件操作 * 批处理优化 * 资源池化 * 负载均衡 * 进度汇总 ** ** ### 开发模式 #### `编码器` 具有批处理文件操作的自主代码生成。 **能力**： * 功能实现 * 代码重构 * 错误修复和补丁 * API开发 * 算法实现 **质量标准**： * ES2022+标准 * TypeScript 类型安全 * 全面的错误处理 * 性能优化 * 安全最佳实践 **用法**： mcp__claude-flow__sparc_mode { 模式：“编码器”， task_description: "使用 JWT 实现用户身份验证", 选项：{ 测试驱动：正确，并行编辑：正确，打字稿：真实 } } #### `建筑师` 具有基于内存的协调的系统设计。 **能力**： * 微服务架构 * 事件驱动设计 * 领域驱动设计（DDD） * 六角形结构 * CQRS 和事件溯源 **内存集成**： * 存储架构决策 * 分享组件规格 * 保持设计的一致性 * 跟踪架构演变 **设计模式**： * 分层架构 * 微服务模式 * 事件驱动模式 * 领域建模 * 基础设施即代码 **用法**： mcp__claude-flow__sparc_mode { 模式：“建筑师”， task_description: “设计可扩展的电子商务平台”, 选项：{ 详细：真实，内存启用：真，模式：[“微服务”、“事件驱动”] } } #### `tdd` 具有全面测试的测试驱动开发。 **能力**： * 测试优先的开发 * 红-绿-重构循环 * 测试套件设计 * 覆盖率优化（目标：90%+） * 持续测试 **TDD 工作流程**： 1. 编写失败测试（红色） 2. 实施最少代码 3. 测试通过（绿色） 4. 重构质量（REFACTOR） 5. 重复循环 **测试策略**： * 单元测试（Jest、Mocha、Vitest） * 集成测试 * 端到端测试（Playwright、Cypress） * 性能测试 * 安全测试 **用法**： mcp__claude-flow__sparc_mode { 模式：“tdd”， task_description: "具有支付集成的购物车功能", 选项：{ 覆盖率目标：90， test_framework：“开玩笑”， e2e_framework：“剧作家” } } #### `审阅者` 使用批处理文件分析进行代码审查。 **能力**： * 代码质量评估 * 安全漏洞检测 * 性能分析 * 最佳实践验证 * 文件审查 **审查标准**： * 代码的正确性和逻辑性 * 设计模式遵循 * 全面的错误处理 * 测试覆盖率充足性 * 可维护性和可读性 * 安全漏洞 * 性能瓶颈 **批量分析**： * 并行文件审查 * 模式检测 * 依赖关系检查 * 一致性验证 * 自动报告 **用法**： mcp__claude-flow__sparc_mode { 模式：“审稿人”， task_description: "审查身份验证模块 PR #123", 选项：{ 安全检查：真，性能检查：真， test_coverage_check：true } } ** ** ### 分析与研究模式 #### `研究员` 并行 WebSearch/WebFetch 和内存协调的深入研究。 **能力**： * 综合信息收集 * 来源可信度评估 * 趋势分析与预测 * 竞争研究 * 技术评估 **研究方法**： * 并行网络搜索 * 学术论文分析 * 行业报告综合 * 专家意见收集 * 统计数据整理 **内存集成**： * 存储研究结果和引文 * 构建知识图谱 * 追踪信息来源 * 交叉参考见解 * 维护研究历史 **用法**： mcp__claude-flow__sparc_mode { 模式：“研究员”， task_description：“研究 2024 年微服务最佳实践”，选项：{ 深度：“全面”，来源：[“学术”、“行业”、“新闻”]、引用: 真实 } } #### `分析器` 通过模式识别进行代码和数据分析。 **能力**： * 静态代码分析 * 依赖分析 * 性能分析 * 安全扫描 * 数据模式识别 #### `优化器` 性能优化和瓶颈解决。 **能力**： * 算法优化 * 数据库查询调整 * 缓存策略设计 * 减少捆绑包尺寸 * 内存泄漏检测 ** ** ### 创意和支持模式 ####`设计师` 以可访问性为重点的 UI/UX 设计。 **能力**： * 界面设计 * 用户体验优化 * 辅助功能合规性 (WCAG 2.1) * 设计系统创建 * 响应式布局设计 #### `创新者` 创造性地解决问题和新颖的解决方案。 **能力**： * 头脑风暴和构思 *替代方法生成 * 技术评估 * 概念开发验证 * 创新可行性分析 #### `记录员` 综合文档生成。 **能力**： * API 文档（OpenAPI/Swagger） * 架构图 * 用户指南和教程 * 代码注释和JSDoc * 自述文件和变更日志维护 #### `调试器` 系统调试和问题解决。 **能力**： * 错误重现 * 根本原因分析 * 修复实施 * 预防回归 * 调试日志优化 #### `测试员` 超越 TDD 的全面测试。 **能力**： * 测试套件扩展 * 边缘情况识别 * 性能测试 * 负载测试 * 混沌工程 #### `内存管理器` 知识管理和上下文保存。 **能力**： * 跨会话内存持久化 * 知识图谱构建 * 上下文恢复 * 学习模式提取 * 决策跟踪 ** ** ## 激活方法 ### 方法1：MCP工具（Claude代码中首选） **最适合**：具有完整编排功能的集成 Claude Code 工作流程 // 基本模式执行 mcp__claude-flow__sparc_mode { 模式：“<模式名称>”， task_description: "<任务描述>", 选项：{ // 特定于模式的选项 } } // 为复杂任务初始化 swarm mcp__claude-flow__swarm_init { 拓扑: "hierarchical", // 或 "mesh", "ring", "star" 策略：“自动”，//或“平衡”，“专业”，“自适应” 最大代理数：8 } // 生成专门的代理 mcp__claude-flow__agent_spawn { 类型：“<代理类型>”，能力：[“<能力1>”，“<能力2>”] } // 监控执行情况 mcp__claude-flow__swarm_monitor { swarmId：“当前”，间隔：5000 } ### 方法 2：NPX CLI（后备） **最适合**：终端使用或 MCP 工具不可用时 # 执行特定模式 npx claude-flow sparc run <模式>“任务描述” # 使用 alpha 特征 npx claude-flow@alpha sparc run <模式>“任务描述” # 列出所有可用模式 npx claude-flow sparc 模式 # 获取特定模式的帮助 npx claude-flow sparc 帮助 <模式> # 使用选项运行 npx claude-flow sparc run <模式> "任务" --parallel --monitor # 执行TDD工作流程 npx claude-flow sparc tdd“功能描述” # 批量执行 npx claude-flow sparc 批处理<模式1，模式2，模式3>“任务” # 管道执行 npx claude-flow sparc 管道“任务描述” ### 方法三：本地安装 **最适合**：具有本地 claude-flow 安装的项目 # 如果claude-flow安装在本地 ./claude-flow sparc run <模式>“任务描述” ** ** ## 编排模式 ### 模式 1：层级协调 **最适合**：具有清晰授权层次结构的复杂项目 // 初始化分层群 mcp__claude-flow__swarm_init { 拓扑：“分层”，最大代理数：12 } // 生成协调器 mcp__claude-flow__agent_spawn { 类型：“协调员”，能力：[“规划”、“授权”、“监控”] } // 生成专门的工人 mcp__claude-flow__agent_spawn { 类型：“建筑师” } mcp__claude-flow__agent_spawn { 类型：“编码器” } mcp__claude-flow__agent_spawn { 类型：“测试仪” } mcp__claude-flow__agent_spawn { 类型：“审阅者” } ### 模式 2：网格协调 **最适合**：需要点对点通信的协作任务 mcp__claude-flow__swarm_init { 拓扑：“网格”，策略：“平衡”，最大代理数：6 } ### 模式 3：顺序管道 **最适合**：有序工作流程执行（规范→设计→代码→测试→审查） mcp__claude-flow__workflow_create { 名称：“开发管道”，步骤：[ { mode: "研究员", task: "收集需求" }, { 模式：“建筑师”，任务：“设计系统” }, { 模式：“编码器”，任务：“实现功能” }， { 模式：“tdd”，任务：“创建测试”}， { 模式：“审阅者”，任务：“审阅代码” } ], 触发器：[“on_step_complete”] } ### 模式 4：并行执行 **最适合**：可以同时运行的独立任务 mcp__claude-flow__task_orchestrate { 任务：“构建全栈应用程序”，策略：“并行”，依赖项：{ 后端：[]，前端：[]，数据库：[]，测试：[“后端”，“前端”] } } ### 模式 5：自适应策略 **最适合**：需求不断变化的动态工作负载 mcp__claude-flow__swarm_init { 拓扑：“分层”， Strategy: "adaptive", // 根据工作负载自动调整最大代理数：20 } ** ** ## TDD 工作流程 ### 完整的 TDD 工作流程 // 第 1 步：初始化 TDD 群 mcp__claude-flow__swarm_init { 拓扑：“分层”，最大代理数：8 } // 第 2 步：研究和规划 mcp__claude-flow__sparc_mode { 模式：“研究员”， task_description：“研究功能 X 的测试最佳实践” } // 第三步：架构设计 mcp__claude-flow__sparc_mode { 模式：“建筑师”， task_description：“为功能 X 设计可测试的架构” } // 步骤4：TDD实现 mcp__claude-flow__sparc_mode { 模式：“tdd”， task_description: “以 90% 的覆盖率实现功能 X”, 选项：{ 覆盖率目标：90， test_framework：“开玩笑”，并行测试：true } } // 步骤 5：代码审查 mcp__claude-flow__sparc_mode { 模式：“审稿人”， task_description: “审查功能 X 实现”, 选项：{ 测试覆盖率检查：真，安全检查：真 } } // 第 6 步：优化 mcp__claude-flow__sparc_mode { 模式：“优化器”， task_description: “优化功能 X 性能” } ### 红-绿-重构循环 // 红色：编写失败的测试 mcp__claude-flow__sparc_mode { 模式：“测试仪”， task_description: "为购物车添加项目创建失败测试", 选项：{expect_failure：true} } // 绿色：最小实现 mcp__claude-flow__sparc_mode { 模式：“编码器”， task_description: “实现最少的代码来通过测试”, 选项：{最小：true} } // REFACTOR：提高代码质量 mcp__claude-flow__sparc_mode { 模式：“编码器”， task_description: "重构购物车实现", 选项：{维护测试：true} } ** ** ## 最佳实践 ### 1\.内存整合 **始终使用内存进行跨代理协调**： // 存储架构决策 mcp__claude-flow__memory_usage { 动作：“存储”，命名空间：“架构”，键：“api-design-v1”，值：JSON.stringify(apiDesign), ttl: 86400000 // 24 小时 } // 在后续代理中检索 mcp__claude-flow__memory_usage { 动作：“检索”，命名空间：“架构”，键：“api-design-v1” } ### 2\.并行操作 **在单个消息中批量处理所有相关操作**： // ✅ 正确：所有操作一起进行 [单条消息]： mcp__claude-flow__agent_spawn { 类型：“研究员” } mcp__claude-flow__agent_spawn { 类型：“编码器” } mcp__claude-flow__agent_spawn { 类型：“测试仪” } TaskCreate { 任务: [8-10 任务] } // ❌ 错误：多条消息消息 1：mcp__claude-flow__agent_spawn { 类型：“研究员”} 消息 2：mcp__claude-flow__agent_spawn { 类型：“编码器”} 消息 3：TaskCreate { 任务：[...] } ### 3\.挂钩集成 **每个 SPARC 模式都应该使用钩子**： # 上班前 npx claude-flow@alpha 挂钩前置任务 --description“实施身份验证” # 工作期间 npx claude-flow@alpha 挂钩后期编辑--文件“auth.js” #下班后 npx claude-flow@alpha 挂钩后任务 --task-id "task-123" ### 4\.测试覆盖率 **保持至少 90% 的覆盖率**： * 所有功能的单元测试 * API 集成测试 * 关键流程的端到端测试 * 边缘情况覆盖 * 错误路径测试 ### 5\.文档 **构建时记录**： * API文档（OpenAPI） * 架构决策记录（ADR） * 复杂逻辑的代码注释 * 带有设置说明的自述文件 * 版本跟踪的变更日志 ### 6\.文件组织 **切勿保存到根文件夹**：项目/ ├── src/ # 源代码 ├──测试/#测试文件 ├── docs/ # 文档 ├── config/ # 配置 ├── 脚本/ # 实用脚本 └── Examples/ # 示例代码 ** ** ## 集成示例 ### 示例 1：全栈开发【单条消息-并行代理执行】： // 初始化集群 mcp__claude-flow__swarm_init { 拓扑：“分层”，最大代理数：10 } // 架构阶段 mcp__claude-flow__sparc_mode { 模式：“建筑师”， task_description: "设计带有身份验证的 REST API", 选项：{ Memory_enabled：true } } // 研究阶段 mcp__claude-flow__sparc_mode { 模式：“研究员”， task_description：“研究认证最佳实践” } // 实施阶段 mcp__claude-flow__sparc_mode { 模式：“编码器”， task_description: "使用 JWT 身份验证实现 Express API", 选项：{ test_driven：true } } // 测试阶段 mcp__claude-flow__sparc_mode { 模式：“tdd”， task_description: "全面的 API 测试", 选项：{coverage_target：90} } // 审核阶段 mcp__claude-flow__sparc_mode { 模式：“审稿人”， task_description: “安全和性能审查”, 选项：{ security_check：true } } // 批量创建任务任务创建{ 任务：[ {content: "Design API schema", status: "completed"}, {content: "研究 JWT 实现", status: "已完成"}, {content: "实施身份验证", status: "in_progress"}, {content: "编写 API 测试", status: "待处理"}, {content: "安全审核", status: "待处理"}, {content: "性能优化", status: "待处理"}, {content: "API 文档", status: "待处理"}, {内容：“部署设置”，状态：“待处理”} ] } ### 示例 2：研究驱动的创新 // 研究阶段 mcp__claude-flow__sparc_mode { 模式：“研究员”， task_description：“研究人工智能驱动的搜索实现”，选项：{ 深度：“全面”，来源：[“学术”、“行业”] } } // 创新阶段 mcp__claude-flow__sparc_mode { 模式：“创新者”， task_description: “提出新颖的搜索算法”, 选项：{ Memory_enabled：true } } // 架构阶段 mcp__claude-flow__sparc_mode { 模式：“建筑师”， task_description：“设计可扩展的搜索系统” } // 实施阶段 mcp__claude-flow__sparc_mode { 模式：“编码器”， task_description: "实现搜索算法", 选项：{ test_driven：true } } // 文档阶段 mcp__claude-flow__sparc_mode { 模式：“记录员”， task_description: “文档搜索系统架构和API” } ### 示例 3：遗留代码重构 // 分析阶段 mcp__claude-flow__sparc_mode { 模式：“分析器”， task_description：“分析遗留代码库依赖关系” } // 规划阶段 mcp__claude-flow__sparc_mode { 模式：“协调器”， task_description: “计划增量重构策略” } // 测试阶段（创建安全网） mcp__claude-flow__sparc_mode { 模式：“测试仪”， task_description：“为遗留代码创建全面的测试套件”，选项：{coverage_target：80} } // 重构阶段 mcp__claude-flow__sparc_mode { 模式：“编码器”， task_description: “用现代模式重构模块 X”, 选项：{维护测试：true} } // 审核阶段 mcp__claude-flow__sparc_mode { 模式：“审稿人”， task_description：“验证重构是否维护功能” } ** ** ## 常见工作流程 ### 工作流程 1：功能开发 # 第 1 步：研究和规划 npx claude-flow sparc 运行研究员“身份验证模式” # 第二步：架构设计 npx claude-flow sparc 运行架构师“设计验证系统” # 第 3 步：TDD 实施 npx claude-flow sparc tdd“用户身份验证功能” # 第 4 步：代码审查 npx claude-flow sparc 运行审阅者“审阅身份验证实施” # 步骤 5：文档 npx claude-flow sparc 运行文档管理器“文档身份验证 API” ### 工作流程 2：错误调查 # 第 1 步：分析问题 npx claude-flow sparc 运行分析器“调查 bug #456” # 第二步：系统调试 npx claude-flow sparc 运行调试器“修复服务 X 中的内存泄漏” # 第 3 步：创建测试 npx claude-flow sparc 运行测试器“bug #456 的回归测试” # 第 4 步：检查修复 npx claude-flow sparc 运行审阅者“验证错误修复” ### 工作流程 3：性能优化 # 第 1 步：分析性能 npx claude-flow sparc 运行分析器“配置 API 响应时间” # 第 2 步：识别瓶颈 npx claude-flow sparc 运行优化器“优化数据库查询” # 第 3 步：实施改进 npx claude-flow sparc run coder“实现缓存层” # 第 4 步：基准测试结果 npx claude-flow sparc 运行测试仪“性能基准” ### 工作流程 4：完整管道 # 执行完整的开发流程 npx claude-flow sparc 管道“电子商务结账功能” # 这会自动运行： # 1. 研究员 - 收集需求 # 2. 建筑师 - 设计系统 # 3. 编码器 - 实现功能 # 4. tdd - 创建全面的测试 # 5. reviewer - 代码质量审查 # 6. 优化器 - 性能调优 # 7. 文档管理器 - 文档 ** ** ## 高级功能 ### 神经模式训练 // 从成功的工作流程中训练模式 mcp__claude-flow__neural_train { pattern_type: "协调", 训练数据：“successful_tdd_workflow.json”，纪元：50 } ### 跨会话内存 // 保存会话状态 mcp__claude-flow__memory_persist { sessionId：“功能验证-v1” } // 在新会话中恢复 mcp__claude-flow__context_restore { snapshotId：“功能验证-v1” } ### GitHub 集成 // 分析存储库 mcp__claude-flow__github_repo_analyze { 回购：“所有者/回购”， Analysis_type：“代码质量” } // 管理拉取请求 mcp__claude-flow__github_pr_manage { 回购：“所有者/回购”，公关号码：123，行动：“审查” } ### 性能监控 // 实时集群监控 mcp__claude-flow__swarm_monitor { swarmId：“当前”，间隔：5000 } // 瓶颈分析 mcp__claude-flow__bottleneck_analyze { 组件：“api层”，指标：[“延迟”、“吞吐量”、“错误”] } // 令牌使用跟踪 mcp__claude-flow__token_usage { 操作：“功能开发”，时间范围：“24小时” } ** ** ## 性能优势 **经过验证的结果**： * **84.8%** SWE-Bench 解决率 * **通过优化减少了 32.3%** 代币 * **2.8-4.4x** 通过并行执行提高速度 * **27+** 用于模式学习的神经模型 * **90%+** 测试覆盖率标准 ** ** ## 支持和资源 * **文档**： * **问题**： * **NPM 包** : * **社区**：Discord 服务器（存储库中的链接） ** ** ## 快速参考 ### 最常用命令 # 列出模式 npx claude-flow sparc 模式 # 运行特定模式 npx claude-flow sparc run <模式>“任务” # TDD 工作流程 npx 克劳德流 sparc tdd“功能” # 完整管道 npx claude-flow sparc 管道“任务” # 批量执行 npx claude-flow sparc 批处理 <模式>“任务” ### 最常见的 MCP 调用 // 初始化集群 mcp__claude-flow__swarm_init { 拓扑：“分层” } // 执行模式 mcp__claude-flow__sparc_mode { 模式：“编码器”，task_description：“...” } // 监控进度 mcp__claude-flow__swarm_monitor { 间隔：5000 } // 存储在内存中 mcp__claude-flow__memory_usage { 操作：“存储”，键：“...”，值：“...” } ** ** ## 铁律 1. **永远不要**在完成规范阶段之前编写实现代码 2. **始终**在细化阶段的任何实现之前编写失败的测试 3. **切勿** 在未完成当前阶段的所有审核门之前进入下一个 SPARC 阶段 4. **始终**在生成代理之前将复杂的任务分解为具有显式依赖关系的子任务 5. **切勿** 在没有通过质量关卡的书面证据的情况下声称阶段已完成 ## 反模式反模式|为什么失败 |正确的做法 ---|---|--- 跳过规范阶段 |实施目标错误的要求|在任何代码之前定义需求、用户故事和约束测试前实施|无法验证正确性；回归漏掉了|在编写任何功能代码之前，先在 Refinement 中编写失败的测试时间压力下的跳相|错过了质量关口；下游阶段失败|在晋级之前完成所有审查关卡；门的存在是有充分理由的没有依赖关系映射的生成代理 |代理相互阻碍或重复工作|在生成代理之前映射任务依赖关系和并行组标记阶段在没有证据的情况下完成 |未完成的工作会传播到后续阶段 |每个阶段需要明确的门控证据（测试结果、审核签核） ## 内存协议（强制） **开始之前：**阅读 `.claude/context/memory/learnings.md` **完成后：** * 新模式 -> `.claude/context/memory/learnings.md` * 发现问题 -> `.claude/context/memory/issues.md` * 做出决定 -> `.claude/context/memory/decisions.md` > 假设中断：如果它不在内存中，则它没有发生。请记住：**SPARC = 系统、并行、敏捷、精致、完整**

Sparc方法论

包含技能