mirror of
https://github.com/cexll/myclaude.git
synced 2026-02-05 02:30:26 +08:00
Fix #13: Clean up redundant README files
- Remove README-zh.md (replaced by README_CN.md) - Remove BMAD-README.md (integrated into docs/BMAD-WORKFLOW.md) - Remove BMAD-PILOT-USER-GUIDE.md (content merged into docs/) Solution A (Modular Structure) is now complete with: - Concise bilingual READMEs (115 lines, -60% reduction) - Modular documentation in docs/ directory - Clear plugin table structure - 30-second comprehension time Generated by swe-agent
This commit is contained in:
swe-agent[bot]
@@ -1,163 +0,0 @@
|
|||||||
# BMAD Pilot 使用指南
|
|
||||||
|
|
||||||
本指南介绍如何使用 BMAD Pilot 工作流，编排一组协作 AI 角色（PO/Architect/SM/Dev/QA）在仓库上下文中完成：01 产品需求文档、02 系统设计规范、03 冲刺计划，并自动进入开发与测试，整个过程包含多次用户确认门与质量评分。
|
|
||||||
|
|
||||||
参考阅读：BMAD-README.md（BMAD 方法概览）、BMAD-INTEGRATION-GUIDE.md（进阶集成）。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 命令总览
|
|
||||||
|
|
||||||
- 命令：`/bmad-pilot <PROJECT_DESCRIPTION> [OPTIONS]`
|
|
||||||
- 作用：在仓库上下文中，按阶段编排 `bmad-po → bmad-architect → bmad-sm → bmad-dev → bmad-qa`。
|
|
||||||
- Orchestrator：由工作流统一编排（使用 bmad-orchestrator 进行仓库扫描）。
|
|
||||||
|
|
||||||
### Options
|
|
||||||
- `--skip-tests`：跳过 QA 阶段
|
|
||||||
- `--direct-dev`：跳过 SM 冲刺计划，架构后直接进入开发
|
|
||||||
- `--skip-scan`：跳过初始仓库扫描（不推荐）
|
|
||||||
|
|
||||||
### 输出目录
|
|
||||||
- 所有产出归档在：`./.claude/specs/{feature_name}/`
|
|
||||||
- `00-repo-scan.md` — 仓库扫描摘要（自动生成）
|
|
||||||
- `01-product-requirements.md` — 产品需求文档（确认后保存）
|
|
||||||
- `02-system-architecture.md` — 系统设计规范（确认后保存）
|
|
||||||
- `03-sprint-plan.md` — 冲刺计划（确认后保存；`--direct-dev` 时跳过）
|
|
||||||
|
|
||||||
`{feature_name}` 由 `<PROJECT_DESCRIPTION>` 生成（kebab-case：小写，空格/标点转 `-`，连续合并，首尾去除）。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 快速开始
|
|
||||||
|
|
||||||
1) 执行 Pilot：
|
|
||||||
```
|
|
||||||
/bmad-pilot 为现有项目新增看板模块，支持多用户权限与移动端适配
|
|
||||||
```
|
|
||||||
2) 与 PO 交互澄清，直至 PRD ≥ 90 分 → 确认保存。
|
|
||||||
3) 与 Architect 讨论技术决策，直至架构 ≥ 90 分 → 确认保存。
|
|
||||||
4) 审阅并确认 SM 的冲刺计划（或使用 `--direct-dev` 跳过该阶段）。
|
|
||||||
5) Dev 基于文档实现；QA 基于文档与实现测试（除非 `--skip-tests`）。
|
|
||||||
6) 查看产出目录：`./.claude/specs/{feature_name}/`。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 工作流阶段
|
|
||||||
|
|
||||||
- Phase 0：仓库扫描（自动，除非 `--skip-scan`）
|
|
||||||
- Agent：`bmad-orchestrator`
|
|
||||||
- 结果：扫描摘要返回并写入 `00-repo-scan.md`
|
|
||||||
- 内容：项目类型、技术栈、代码组织、惯例、集成点、约束与注意事项
|
|
||||||
|
|
||||||
- Phase 1：产品需求（交互）
|
|
||||||
- Agent：`bmad-po`
|
|
||||||
- 循环：澄清问题 → 更新 PRD → 评分（目标 ≥ 90）
|
|
||||||
- 确认门：PRD ≥ 90 分后，需要用户明确确认再继续
|
|
||||||
- 保存：`01-product-requirements.md`
|
|
||||||
|
|
||||||
- Phase 2：系统架构（交互）
|
|
||||||
- Agent：`bmad-architect`
|
|
||||||
- 循环：技术选型与设计澄清 → 更新架构 → 评分（目标 ≥ 90）
|
|
||||||
- 确认门：架构 ≥ 90 分后，需要用户明确确认再继续
|
|
||||||
- 保存：`02-system-architecture.md`
|
|
||||||
|
|
||||||
- Phase 3：冲刺计划（交互，除非 `--direct-dev`）
|
|
||||||
- Agent：`bmad-sm`
|
|
||||||
- 循环：计划要点与问题澄清 → 更新计划 → 确认保存
|
|
||||||
- 保存：`03-sprint-plan.md`
|
|
||||||
|
|
||||||
- Phase 4：开发实现（自动）
|
|
||||||
- Agent：`bmad-dev`
|
|
||||||
- 输入：PRD、架构、冲刺计划、`00-repo-scan.md`
|
|
||||||
|
|
||||||
- Phase 5：质量保障（自动，除非 `--skip-tests`）
|
|
||||||
- Agent：`bmad-qa`
|
|
||||||
- 输入：PRD、架构、冲刺计划、实现、`00-repo-scan.md`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 交互与质量门
|
|
||||||
|
|
||||||
- 质控阈值：PRD 与架构质量评分需达到 ≥ 90 分。
|
|
||||||
- 强制确认门：每个关键阶段完成后，Orchestrator 会停下等待你的“继续/确认”。
|
|
||||||
- 迭代澄清：PO/Architect/SM 会提出 2-5 个精准问题，Orchestrator 转述并汇总你的回答以供下一轮完善。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 仓库上下文
|
|
||||||
|
|
||||||
- 首次扫描：由工作流触发的 orchestrator 扫描（`bmad-orchestrator`）自动分析当前仓库（`--skip-scan` 可跳过）。
|
|
||||||
- 缓存路径：`./.claude/specs/{feature_name}/00-repo-scan.md`（供所有后续 Agent 引用）。
|
|
||||||
- 作用：提供技术栈识别、约定、测试模式、集成点，避免上下文丢失并保持一致性。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 角色职责
|
|
||||||
|
|
||||||
- `bmad-po`：需求澄清与 PRD 产出，评分与问题驱动迭代。
|
|
||||||
- `bmad-architect`：技术架构与关键决策，评分与问题驱动迭代。
|
|
||||||
- `bmad-sm`：冲刺计划、任务拆分、依赖/风险/节奏规划。
|
|
||||||
- `bmad-dev`：按文档实现、测试、日志/安全/性能与同构风格。
|
|
||||||
- `bmad-qa`：基于需求与实现的全维度测试（单测/集成/E2E/性能/安全）。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 示例
|
|
||||||
|
|
||||||
- 基础运行：
|
|
||||||
```
|
|
||||||
/bmad-pilot 在线商城结算流程升级，支持优惠券与发票
|
|
||||||
```
|
|
||||||
|
|
||||||
- 跳过测试：
|
|
||||||
```
|
|
||||||
/bmad-pilot H5 活动页生成器 --skip-tests
|
|
||||||
```
|
|
||||||
|
|
||||||
- 直接从架构进入开发（跳过 SM）：
|
|
||||||
```
|
|
||||||
/bmad-pilot 小程序客服模块重构 --direct-dev
|
|
||||||
```
|
|
||||||
|
|
||||||
- 跳过扫描（不推荐）：
|
|
||||||
```
|
|
||||||
/bmad-pilot 部署流水线可视化 --skip-scan
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 目录结构
|
|
||||||
|
|
||||||
```
|
|
||||||
.claude/
|
|
||||||
specs/
|
|
||||||
{feature_name}/
|
|
||||||
00-repo-scan.md
|
|
||||||
01-product-requirements.md
|
|
||||||
02-system-architecture.md
|
|
||||||
03-sprint-plan.md
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips & 常见问题
|
|
||||||
|
|
||||||
- 分数上不去：优先补齐评分分项的缺口（业务指标、关键流程、性能/安全约束等）。
|
|
||||||
- 上下文不一致：检查并引用 `00-repo-scan.md` 的关键约定与模式，保证 PRD/架构/计划一致。
|
|
||||||
- 依赖/网络受限：Dev/QA 的实际执行受环境影响；请在项目内准备依赖与测试环境，或先提交伪实现/测试策略。
|
|
||||||
- 文档路径：确保在项目根目录执行，Pilot 会将文件写入 `./.claude/specs/{feature_name}/`。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 最佳实践
|
|
||||||
|
|
||||||
- 小步快跑：每轮补充最关键信息，快速达成 ≥ 90 分文档。
|
|
||||||
- 统一术语：在 PRD 固定术语词表；架构与代码沿用同名。
|
|
||||||
- 用例先行：PRD 的验收标准应转化为 QA 的关键测试用例。
|
|
||||||
- 复用模式：尽量沿用扫描识别的现有代码/测试模式，减少偏差。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 版本记录
|
|
||||||
|
|
||||||
- 2025-08-11：新增仓库扫描摘要缓存 `00-repo-scan.md`，统一路径与跨阶段引用；明确确认门与目录预创建说明。
|
|
||||||
339
BMAD-README.md
339
BMAD-README.md
@@ -1,339 +0,0 @@
|
|||||||
# BMAD方法论 Claude Code 使用指南
|
|
||||||
|
|
||||||
[](https://github.com/bmadcode/BMAD-METHOD)
|
|
||||||
[](https://claude.ai/code)
|
|
||||||
|
|
||||||
> 从产品理念到代码实现的完整AI驱动敏捷开发工作流
|
|
||||||
|
|
||||||
## 🎯 什么是BMAD方法论？
|
|
||||||
|
|
||||||
BMAD (Business, Market, Architecture, Development) 是一个AI驱动的敏捷开发方法论，通过专业化代理团队实现从商业需求到技术实现的完整工作流程。
|
|
||||||
|
|
||||||
### 核心理念
|
|
||||||
- **智能体规划**: 专门代理协作创建详细、一致的PRD和架构文档
|
|
||||||
- **上下文工程开发**: 将详细计划转换为超详细的开发故事
|
|
||||||
- **角色专业化**: 每个代理专注特定领域，避免角色切换导致的质量下降
|
|
||||||
|
|
||||||
## 🏗️ BMAD代理体系
|
|
||||||
|
|
||||||
### 代理角色说明
|
|
||||||
- **PO (Product Owner)** - 产品负责人Sarah：需求分析、用户故事、验收标准
|
|
||||||
- **Analyst** - 业务分析师Mary：市场研究、竞争分析、商业案例
|
|
||||||
- **Architect** - 系统架构师Winston：技术架构、系统设计、技术选择
|
|
||||||
- **SM (Scrum Master)** - 敏捷教练：任务分解、冲刺规划、流程协调
|
|
||||||
- **Dev (Developer)** - 开发工程师：代码实现、技术文档
|
|
||||||
- **QA (Quality Assurance)** - 质量保证：测试策略、质量验证
|
|
||||||
- **UX Expert** - 用户体验专家：交互设计、可用性测试
|
|
||||||
|
|
||||||
## 🚀 快速开始
|
|
||||||
|
|
||||||
### 安装配置
|
|
||||||
BMAD方法论已集成到您的Claude Code系统中，无需额外安装。
|
|
||||||
|
|
||||||
### 基本使用方法
|
|
||||||
|
|
||||||
#### 1. 完整BMAD工作流
|
|
||||||
```bash
|
|
||||||
# 一键执行完整开发流程
|
|
||||||
/bmad-pilot "实现企业级用户管理系统，支持RBAC权限控制和LDAP集成"
|
|
||||||
|
|
||||||
# 执行流程：PO → Architect → SM → Dev → QA
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 2. 常用选项
|
|
||||||
```bash
|
|
||||||
# 跳过测试（PO → Architect → SM → Dev）
|
|
||||||
/bmad-pilot "实现支付网关API" --skip-tests
|
|
||||||
|
|
||||||
# 直接从架构进入开发（跳过 SM 规划）
|
|
||||||
/bmad-pilot "设计微服务电商平台" --direct-dev
|
|
||||||
|
|
||||||
# 跳过仓库扫描（不推荐）
|
|
||||||
/bmad-pilot "用户界面优化" --skip-scan
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 3. 直接开发与部分流程
|
|
||||||
```bash
|
|
||||||
# 技术焦点（架构后直接进入开发与测试）
|
|
||||||
/bmad-pilot "API网关实现" --direct-dev
|
|
||||||
|
|
||||||
# 完整设计流程（需求→架构→规划→开发→测试）
|
|
||||||
/bmad-pilot "系统重构规划"
|
|
||||||
|
|
||||||
# 仅业务相关分析 → 请使用下方“独立代理使用”中的 /bmad-po 与 /bmad-analyst
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 4. 独立代理使用
|
|
||||||
```bash
|
|
||||||
# 产品需求分析
|
|
||||||
/bmad-po "企业CRM系统功能需求定义"
|
|
||||||
|
|
||||||
# 市场调研分析
|
|
||||||
/bmad-analyst "SaaS市场竞争格局和机会分析"
|
|
||||||
|
|
||||||
# 系统架构设计
|
|
||||||
/bmad-architect "高并发分布式系统架构设计"
|
|
||||||
|
|
||||||
# 主协调器（可转换为任意代理）
|
|
||||||
/bmad-orchestrator "协调多代理完成复杂项目"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📋 详细命令说明
|
|
||||||
|
|
||||||
### `/bmad-pilot` - 完整工作流执行
|
|
||||||
**用法**: `/bmad-pilot <项目描述> [选项]`
|
|
||||||
|
|
||||||
**选项**:
|
|
||||||
- `--skip-tests`: 跳过 QA 阶段
|
|
||||||
- `--direct-dev`: 跳过 SM 冲刺计划，架构后直接进入开发
|
|
||||||
- `--skip-scan`: 跳过初始仓库扫描（不推荐）
|
|
||||||
|
|
||||||
**示例**:
|
|
||||||
```bash
|
|
||||||
/bmad-pilot "构建在线教育平台，支持直播、录播、作业系统"
|
|
||||||
/bmad-pilot "API网关设计" --direct-dev
|
|
||||||
/bmad-pilot "支付模块" --skip-tests
|
|
||||||
```
|
|
||||||
|
|
||||||
### `/bmad-po` - 产品负责人
|
|
||||||
**角色**: Sarah - 技术产品负责人 & 流程管家
|
|
||||||
**专长**: 需求分析、用户故事、验收标准、冲刺规划
|
|
||||||
|
|
||||||
**用法**: `/bmad-po <需求描述>`
|
|
||||||
|
|
||||||
**工作流程**:
|
|
||||||
1. 需求分解和功能点识别
|
|
||||||
2. 用户故事创建（As a... I want... So that...）
|
|
||||||
3. 验收标准定义和优先级排序
|
|
||||||
4. 利益相关者验证和签署
|
|
||||||
|
|
||||||
**示例**:
|
|
||||||
```bash
|
|
||||||
/bmad-po "设计企业级权限管理系统，支持多租户和细粒度权限控制"
|
|
||||||
/bmad-po "移动端电商APP功能需求分析"
|
|
||||||
```
|
|
||||||
|
|
||||||
### `/bmad-analyst` - 业务分析师
|
|
||||||
**角色**: Mary - 洞察分析师 & 战略合作伙伴
|
|
||||||
**专长**: 市场研究、竞争分析、商业案例开发、利益相关者分析
|
|
||||||
|
|
||||||
**用法**: `/bmad-analyst <分析主题>`
|
|
||||||
|
|
||||||
**工作流程**:
|
|
||||||
1. 市场格局和竞争对手分析
|
|
||||||
2. 商业案例开发和ROI分析
|
|
||||||
3. 利益相关者分析和需求收集
|
|
||||||
4. 项目简报和战略建议
|
|
||||||
|
|
||||||
**示例**:
|
|
||||||
```bash
|
|
||||||
/bmad-analyst "企业级认证市场分析，JWT vs OAuth2.0 vs SAML"
|
|
||||||
/bmad-analyst "云原生架构迁移的商业价值和风险评估"
|
|
||||||
```
|
|
||||||
|
|
||||||
### `/bmad-architect` - 系统架构师
|
|
||||||
**角色**: Winston - 全栈系统架构师 & 技术领导者
|
|
||||||
**专长**: 系统设计、技术选择、API设计、基础架构规划
|
|
||||||
|
|
||||||
**用法**: `/bmad-architect <系统设计需求>`
|
|
||||||
|
|
||||||
**工作流程**:
|
|
||||||
1. 系统需求和约束分析
|
|
||||||
2. 技术栈和架构模式选择
|
|
||||||
3. 组件设计和系统架构图
|
|
||||||
4. 实施策略和开发指导
|
|
||||||
|
|
||||||
**示例**:
|
|
||||||
```bash
|
|
||||||
/bmad-architect "微服务架构设计，支持事件驱动和最终一致性"
|
|
||||||
/bmad-architect "高可用API网关架构，支持限流、熔断、监控"
|
|
||||||
```
|
|
||||||
|
|
||||||
### `/bmad-orchestrator` - 主协调器
|
|
||||||
**角色**: BMAD主协调器
|
|
||||||
**专长**: 工作流协调、代理转换、多代理任务管理
|
|
||||||
|
|
||||||
**用法**: `/bmad-orchestrator [命令] [参数]`
|
|
||||||
|
|
||||||
**功能**:
|
|
||||||
- 动态转换为任意专门代理
|
|
||||||
- 协调复杂多代理工作流
|
|
||||||
- 管理代理间的上下文传递
|
|
||||||
- 提供工作流指导和建议
|
|
||||||
|
|
||||||
## 🔄 与现有系统集成
|
|
||||||
|
|
||||||
### 现有系统 vs BMAD方法论
|
|
||||||
|
|
||||||
| 特性 | Requirements-Pilot | BMAD方法论 |
|
|
||||||
|------|-------------------|-----------|
|
|
||||||
| **执行时间** | 30分钟 | 1-2小时 |
|
|
||||||
| **适用场景** | 快速功能开发 | 企业级项目 |
|
|
||||||
| **覆盖范围** | 技术实现 | 商业+技术全流程 |
|
|
||||||
| **质量门控** | 90%技术质量 | 多维度质量验证 |
|
|
||||||
| **代理数量** | 4个技术代理 | 7个全角色代理 |
|
|
||||||
|
|
||||||
### 使用场景建议
|
|
||||||
|
|
||||||
#### 🚅 快速开发（推荐现有系统）
|
|
||||||
```bash
|
|
||||||
# 简单功能快速实现
|
|
||||||
/requirements-pilot "添加用户登录功能"
|
|
||||||
/requirements-pilot "实现数据导出API"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 🏢 企业级项目（推荐BMAD）
|
|
||||||
```bash
|
|
||||||
# 复杂系统完整流程
|
|
||||||
/bmad-pilot "构建企业级ERP系统，集成财务、人事、项目管理模块"
|
|
||||||
/bmad-pilot "设计多租户SaaS平台，支持自定义配置和第三方集成"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 🔄 混合模式（规划+实现）
|
|
||||||
```bash
|
|
||||||
# 先用BMAD做规划（在 PRD/架构确认门停留）
|
|
||||||
/bmad-pilot "电商平台架构设计"
|
|
||||||
|
|
||||||
# 再用现有系统快速实现
|
|
||||||
/requirements-pilot "基于架构规格实现用户服务模块"
|
|
||||||
/requirements-pilot "基于架构规格实现订单服务模块"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🎯 典型工作流示例
|
|
||||||
|
|
||||||
### 示例1: 企业级认证系统
|
|
||||||
```bash
|
|
||||||
# 完整BMAD流程
|
|
||||||
/bmad-pilot "企业级JWT认证系统，支持RBAC权限控制、LDAP集成、审计日志、高可用部署"
|
|
||||||
|
|
||||||
# 预期输出：
|
|
||||||
# 1. PO: 详细用户故事和验收标准
|
|
||||||
# 2. Architect: 完整系统架构和技术选择
|
|
||||||
# 3. SM: 开发任务分解和冲刺计划
|
|
||||||
# 4. Dev: 生产就绪代码实现
|
|
||||||
# 5. QA: 测试策略与用例并执行（可选）
|
|
||||||
```
|
|
||||||
|
|
||||||
### 示例2: API网关开发
|
|
||||||
```bash
|
|
||||||
# 技术焦点流程（跳过SM，架构后直接进入开发）
|
|
||||||
/bmad-pilot "高性能API网关，支持限流、熔断、监控、服务发现" --direct-dev
|
|
||||||
|
|
||||||
# 执行流程：
|
|
||||||
# 1. Architect: 系统架构设计
|
|
||||||
# 2. Dev: 代码实现
|
|
||||||
# 3. QA: 性能测试和质量验证
|
|
||||||
```
|
|
||||||
|
|
||||||
### 示例3: 产品市场分析
|
|
||||||
```bash
|
|
||||||
# 业务分析流程（使用独立代理）
|
|
||||||
/bmad-po "云原生数据库市场机会分析的产品需求假设与范围界定"
|
|
||||||
/bmad-analyst "云原生数据库市场机会分析"
|
|
||||||
|
|
||||||
# 执行流程：
|
|
||||||
# 1. PO: 产品需求定义
|
|
||||||
# 2. Analyst: 市场研究和竞争分析
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📊 质量保证体系
|
|
||||||
|
|
||||||
### BMAD质量标准
|
|
||||||
- **需求完整性**: 90+ 分需求清晰度评分
|
|
||||||
- **商业对齐**: 明确的价值主张和市场定位
|
|
||||||
- **架构完善**: 全面的系统设计和技术选择
|
|
||||||
- **实现就绪**: 可执行的开发规格和质量标准
|
|
||||||
|
|
||||||
### 集成现有质量门控
|
|
||||||
- 保持90%技术质量阈值
|
|
||||||
- 增加商业价值验证维度
|
|
||||||
- 多代理交叉验证机制
|
|
||||||
- 自动化质量反馈循环
|
|
||||||
|
|
||||||
## 🔧 高级用法和最佳实践
|
|
||||||
|
|
||||||
### 1. 渐进式复杂度管理
|
|
||||||
```bash
|
|
||||||
# MVP阶段
|
|
||||||
/bmad-workflow "用户管理系统MVP版本" --phase=development
|
|
||||||
|
|
||||||
# 功能增强阶段
|
|
||||||
/bmad-analyst "用户反馈分析和功能增强建议"
|
|
||||||
/requirements-pilot "基于反馈实现增强功能"
|
|
||||||
|
|
||||||
# 企业级增强
|
|
||||||
/bmad-workflow "企业级安全增强和合规支持" --agents=architect,dev,qa
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. 跨项目知识管理
|
|
||||||
```bash
|
|
||||||
# 项目文档化
|
|
||||||
/bmad-orchestrator "将当前项目架构文档化，便于后续项目参考"
|
|
||||||
|
|
||||||
# 最佳实践提取
|
|
||||||
/bmad-architect "基于项目经验总结微服务架构最佳实践"
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. 团队协作优化
|
|
||||||
```bash
|
|
||||||
# 团队能力评估
|
|
||||||
/bmad-analyst "评估团队技术栈和能力匹配度"
|
|
||||||
|
|
||||||
# 开发计划调整
|
|
||||||
/bmad-po "根据团队能力调整功能优先级和实现计划"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🚦 故障排除
|
|
||||||
|
|
||||||
### 常见问题
|
|
||||||
|
|
||||||
**Q: BMAD工作流执行时间较长，如何优化？**
|
|
||||||
A:
|
|
||||||
- 简单功能使用 `/requirements-pilot`
|
|
||||||
- 复杂项目使用分阶段执行 `--phase=planning`
|
|
||||||
- 使用自定义代理序列减少不必要的步骤
|
|
||||||
|
|
||||||
**Q: 如何在BMAD和现有系统间选择？**
|
|
||||||
A:
|
|
||||||
- 项目复杂度 < 中等：使用 `/requirements-pilot`
|
|
||||||
- 项目复杂度 ≥ 高：使用 `/bmad-workflow`
|
|
||||||
- 需要商业分析：必须使用BMAD
|
|
||||||
- 纯技术实现：可选择任一系统
|
|
||||||
|
|
||||||
**Q: 代理输出质量不符合预期怎么办？**
|
|
||||||
A:
|
|
||||||
- 提供更详细的项目描述
|
|
||||||
- 使用分阶段执行，逐步细化
|
|
||||||
- 结合独立代理使用进行专项优化
|
|
||||||
|
|
||||||
## 🎉 开始你的BMAD之旅
|
|
||||||
|
|
||||||
### 第一次使用
|
|
||||||
```bash
|
|
||||||
# 体验完整BMAD工作流
|
|
||||||
/bmad-workflow "构建一个简单的博客系统，支持文章发布、评论、用户管理"
|
|
||||||
```
|
|
||||||
|
|
||||||
### 学习不同代理角色
|
|
||||||
```bash
|
|
||||||
# 产品思维
|
|
||||||
/bmad-po "分析博客系统的用户需求和使用场景"
|
|
||||||
|
|
||||||
# 商业思维
|
|
||||||
/bmad-analyst "个人博客vs企业CMS市场定位分析"
|
|
||||||
|
|
||||||
# 技术思维
|
|
||||||
/bmad-architect "可扩展博客系统架构设计"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📚 进阶学习资源
|
|
||||||
|
|
||||||
- [BMAD-METHOD原理](https://github.com/bmadcode/BMAD-METHOD)
|
|
||||||
- [Claude Code文档](https://docs.anthropic.com/en/docs/claude-code)
|
|
||||||
- [敏捷开发最佳实践](https://agilemanifesto.org/)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**BMAD方法论 + Claude Code = 从理念到代码的完整AI开发工作流** 🚀
|
|
||||||
|
|
||||||
开始使用BMAD方法论，体验专业化AI代理团队带来的开发效率和质量提升！
|
|
||||||
288
README-zh.md
288
README-zh.md
@@ -1,288 +0,0 @@
|
|||||||
# Claude Code 多智能体工作流系统
|
|
||||||
|
|
||||||
[](https://opensource.org/licenses/MIT)
|
|
||||||
[](https://claude.ai/code)
|
|
||||||
[](https://github.com/)
|
|
||||||
[](https://docs.claude.com/en/docs/claude-code/plugins)
|
|
||||||
|
|
||||||
> 企业级敏捷开发工作流自动化与多智能体编排
|
|
||||||
|
|
||||||
[English](README.md)
|
|
||||||
|
|
||||||
## 🚀 BMAD 方法论：敏捷开发自动化
|
|
||||||
|
|
||||||
**BMAD (Business-Minded Agile Development)** 将您的开发流程转换为全自动化的敏捷工作流，配备角色化 AI 智能体和质量门控。
|
|
||||||
|
|
||||||
### 一条命令，完整工作流
|
|
||||||
|
|
||||||
```bash
|
|
||||||
/bmad-pilot "构建电商结账系统，集成支付功能"
|
|
||||||
# 自动化：产品 → 架构 → 冲刺 → 开发 → 审查 → 测试
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🎯 BMAD 工作流架构
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
graph LR
|
|
||||||
PO[产品负责人] -->|PRD 90+| Architect[架构师]
|
|
||||||
Architect -->|设计 90+| SM[Scrum Master]
|
|
||||||
SM -->|冲刺计划| Dev[开发者]
|
|
||||||
Dev -->|代码| Review[审查]
|
|
||||||
Review -->|Pass/Fail| QA[测试]
|
|
||||||
QA -->|测试| Done[完成]
|
|
||||||
```
|
|
||||||
|
|
||||||
### 核心特性
|
|
||||||
|
|
||||||
- **🤖 6个专业智能体**：PO、Architect、SM、Dev、Review、QA
|
|
||||||
- **📊 质量门控**：90% 阈值自动优化
|
|
||||||
- **✅ 确认节点**：关键阶段用户确认
|
|
||||||
- **📁 持久化产物**：所有文档保存至 `./.claude/specs/`
|
|
||||||
- **🔄 迭代优化**：自动改进直至质量达标
|
|
||||||
|
|
||||||
## 📋 BMAD 智能体与角色
|
|
||||||
|
|
||||||
| 智能体 | 角色 | 质量门控 | 输出 |
|
|
||||||
|--------|------|----------|------|
|
|
||||||
| **bmad-po** (Sarah) | 产品需求收集 | 90/100 PRD 评分 | `01-product-requirements.md` |
|
|
||||||
| **bmad-architect** (Winston) | 技术设计与架构 | 90/100 设计评分 | `02-system-architecture.md` |
|
|
||||||
| **bmad-sm** (Mike) | 冲刺计划与任务分解 | 用户确认 | `03-sprint-plan.md` |
|
|
||||||
| **bmad-dev** (Alex) | 功能实现 | 代码完成 | 实现文件 |
|
|
||||||
| **bmad-review** | 独立代码审查 | Pass/Risk/Fail | `04-dev-reviewed.md` |
|
|
||||||
| **bmad-qa** (Emma) | 测试与质量保证 | 测试执行 | `05-qa-report.md` |
|
|
||||||
|
|
||||||
## 🚀 快速开始
|
|
||||||
|
|
||||||
### 安装方法
|
|
||||||
|
|
||||||
#### 方法1：插件系统（推荐）🎯
|
|
||||||
|
|
||||||
```bash
|
|
||||||
/plugin github.com/cexll/myclaude
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 方法2：传统安装
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 克隆仓库
|
|
||||||
git clone https://github.com/your-repo/claude-code-workflows.git
|
|
||||||
cd claude-code-workflows
|
|
||||||
|
|
||||||
# 使用 make 安装所有配置
|
|
||||||
make install
|
|
||||||
|
|
||||||
# 或部署特定工作流
|
|
||||||
make deploy-bmad # 仅部署 BMAD 工作流
|
|
||||||
make deploy-requirements # 仅部署 Requirements 工作流
|
|
||||||
make deploy-all # 部署所有命令和智能体
|
|
||||||
```
|
|
||||||
|
|
||||||
### 基本 BMAD 工作流
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 完整敏捷工作流（所有阶段）
|
|
||||||
/bmad-pilot "用户认证系统，支持 OAuth2 和多因素认证"
|
|
||||||
|
|
||||||
# 快速原型（跳过测试）
|
|
||||||
/bmad-pilot "管理后台" --skip-tests
|
|
||||||
|
|
||||||
# 直接开发（跳过冲刺计划）
|
|
||||||
/bmad-pilot "修复登录问题" --direct-dev
|
|
||||||
|
|
||||||
# 跳过仓库扫描（使用现有上下文）
|
|
||||||
/bmad-pilot "添加功能" --skip-scan
|
|
||||||
```
|
|
||||||
|
|
||||||
### 工作流产物
|
|
||||||
|
|
||||||
每次 BMAD 运行创建结构化文档：
|
|
||||||
|
|
||||||
```
|
|
||||||
.claude/specs/user-authentication/
|
|
||||||
├── 00-repository-context.md # 仓库分析
|
|
||||||
├── 01-product-requirements.md # PRD 及业务目标
|
|
||||||
├── 02-system-architecture.md # 技术设计
|
|
||||||
├── 03-sprint-plan.md # 冲刺任务
|
|
||||||
├── 04-dev-reviewed.md # 代码审查报告（v3.1 新增）
|
|
||||||
└── 05-qa-report.md # 测试结果
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🎨 BMAD 输出样式
|
|
||||||
|
|
||||||
BMAD 工作流使用专门的输出样式：
|
|
||||||
- 创建阶段隔离的上下文
|
|
||||||
- 管理智能体交接
|
|
||||||
- 跟踪质量评分
|
|
||||||
- 处理确认门控
|
|
||||||
- 支持 Codex CLI 集成
|
|
||||||
|
|
||||||
## ⚡ v3.2 插件系统
|
|
||||||
|
|
||||||
### 🔌 原生插件支持（新增）
|
|
||||||
本项目现已包含原生 Claude Code 插件支持，提供4个即装即用的插件包：
|
|
||||||
|
|
||||||
#### 可用插件
|
|
||||||
|
|
||||||
| 插件 | 描述 | 命令 | 智能体 |
|
|
||||||
|------|------|------|--------|
|
|
||||||
| **bmad-agile-workflow** | 完整 BMAD 方法论及角色化智能体 | `/bmad-pilot` | bmad-po, bmad-architect, bmad-sm, bmad-dev, bmad-qa |
|
|
||||||
| **requirements-driven-development** | 精简需求工作流 | `/requirements-pilot` | requirements-generate, requirements-code, requirements-review |
|
|
||||||
| **development-essentials** | 核心开发命令 | `/code`, `/debug`, `/test`, `/optimize` | code, bugfix, debug, develop |
|
|
||||||
| **advanced-ai-agents** | GPT-5 深度分析集成 | - | gpt5 |
|
|
||||||
|
|
||||||
#### 使用插件
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 列出所有可用插件
|
|
||||||
/plugin list
|
|
||||||
|
|
||||||
# 获取插件详细信息
|
|
||||||
/plugin info bmad-agile-workflow
|
|
||||||
|
|
||||||
# 安装插件以激活其命令和智能体
|
|
||||||
/plugin install requirements-driven-development
|
|
||||||
|
|
||||||
# 移除已安装的插件
|
|
||||||
/plugin remove development-essentials
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 插件配置
|
|
||||||
插件定义在 `.claude-plugin/marketplace.json`，遵循 Claude Code 插件规范。每个插件包含：
|
|
||||||
- 命令（斜杠命令）
|
|
||||||
- 智能体（专业 AI 智能体）
|
|
||||||
- 元数据（版本、作者、关键词）
|
|
||||||
- 类别分类
|
|
||||||
|
|
||||||
## ⚡ v3.1 特性
|
|
||||||
|
|
||||||
### 独立代码审查智能体
|
|
||||||
- **bmad-review**：Dev 和 QA 之间的自动审查
|
|
||||||
- **双版本支持**：
|
|
||||||
- 标准版：Claude Code 原生审查
|
|
||||||
- 增强版：通过 Codex CLI 调用 GPT-5
|
|
||||||
- **三级状态**：Pass / Pass with Risk / Fail
|
|
||||||
|
|
||||||
### 增强工作流
|
|
||||||
- Dev → Review → QA 质量链
|
|
||||||
- 自动更新冲刺计划
|
|
||||||
- 针对性 QA 测试建议
|
|
||||||
|
|
||||||
## 📊 质量评分系统
|
|
||||||
|
|
||||||
### PRD 质量（100分）
|
|
||||||
- 业务价值：30
|
|
||||||
- 功能需求：25
|
|
||||||
- 用户体验：20
|
|
||||||
- 技术约束：15
|
|
||||||
- 范围与优先级：10
|
|
||||||
|
|
||||||
### 架构质量（100分）
|
|
||||||
- 设计质量：30
|
|
||||||
- 技术选型：25
|
|
||||||
- 可扩展性：20
|
|
||||||
- 安全性：15
|
|
||||||
- 可行性：10
|
|
||||||
|
|
||||||
### 审查状态
|
|
||||||
- **Pass**：无问题，进入 QA
|
|
||||||
- **Pass with Risk**：非关键问题
|
|
||||||
- **Fail**：必须返回 Dev
|
|
||||||
|
|
||||||
## 🔧 高级用法
|
|
||||||
|
|
||||||
### 仓库上下文
|
|
||||||
BMAD 自动扫描仓库了解：
|
|
||||||
- 技术栈
|
|
||||||
- 项目结构
|
|
||||||
- 现有模式
|
|
||||||
- 依赖关系
|
|
||||||
- 编码规范
|
|
||||||
|
|
||||||
### 交互式优化
|
|
||||||
每个阶段支持迭代改进：
|
|
||||||
```
|
|
||||||
PO: "这是 PRD（评分：75/100）"
|
|
||||||
用户: "添加移动端支持和离线模式"
|
|
||||||
PO: "更新的 PRD（评分：92/100）✅"
|
|
||||||
```
|
|
||||||
|
|
||||||
### 确认门控
|
|
||||||
关键阶段需要明确确认：
|
|
||||||
```
|
|
||||||
架构师: "技术设计完成（评分：93/100）"
|
|
||||||
系统: "准备继续？(yes/no)"
|
|
||||||
用户: yes
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🏭 Requirements-Driven 工作流
|
|
||||||
|
|
||||||
适用于简单项目的轻量级替代方案：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
/requirements-pilot "实现 JWT 认证"
|
|
||||||
# 自动化：需求 → 代码 → 审查 → 测试
|
|
||||||
```
|
|
||||||
|
|
||||||
### 特性
|
|
||||||
- 90% 质量门控
|
|
||||||
- 自动优化循环
|
|
||||||
- 实现导向规格
|
|
||||||
- 实用主义优先
|
|
||||||
|
|
||||||
## 🛠️ 其他命令
|
|
||||||
|
|
||||||
### 开发命令
|
|
||||||
- `/ask` - 技术咨询
|
|
||||||
- `/code` - 直接实现
|
|
||||||
- `/debug` - 系统化调试
|
|
||||||
- `/test` - 测试策略
|
|
||||||
- `/review` - 代码验证
|
|
||||||
- `/optimize` - 性能优化
|
|
||||||
- `/bugfix` - 错误解决
|
|
||||||
- `/refactor` - 代码改进
|
|
||||||
- `/docs` - 文档生成
|
|
||||||
- `/think` - 高级分析
|
|
||||||
|
|
||||||
### 手动工作流示例
|
|
||||||
```bash
|
|
||||||
/ask "实时消息的设计模式"
|
|
||||||
/code "实现 WebSocket 服务器"
|
|
||||||
/test "创建集成测试"
|
|
||||||
/review "验证安全性"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📄 许可证
|
|
||||||
|
|
||||||
MIT 许可证 - 查看 [LICENSE](LICENSE) 文件
|
|
||||||
|
|
||||||
## 🙋 支持
|
|
||||||
|
|
||||||
- **文档**：查看 `/commands/` 和 `/agents/` 目录
|
|
||||||
- **插件指南**：查看 [PLUGIN_README.md](PLUGIN_README.md) 了解插件系统详情
|
|
||||||
- **问题**：GitHub issues 用于报告 bug 和功能请求
|
|
||||||
- **Makefile 帮助**：运行 `make help` 查看所有部署选项
|
|
||||||
- **Claude Code 文档**：[插件系统](https://docs.claude.com/en/docs/claude-code/plugins)
|
|
||||||
|
|
||||||
### 可用的 Make 命令
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make install # 安装所有配置到 Claude Code
|
|
||||||
make deploy-bmad # 仅部署 BMAD 工作流
|
|
||||||
make deploy-requirements # 仅部署 Requirements 工作流
|
|
||||||
make deploy-commands # 部署所有斜杠命令
|
|
||||||
make deploy-agents # 部署所有智能体配置
|
|
||||||
make test-bmad # 测试 BMAD 工作流示例
|
|
||||||
make test-requirements # 测试 Requirements 工作流示例
|
|
||||||
make clean # 清理生成的文件
|
|
||||||
make help # 显示所有可用命令
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**使用 BMAD 转型您的开发** - 一条命令，完整敏捷工作流，质量保证。
|
|
||||||
|
|
||||||
*通过 `/plugin install bmad-agile-workflow` 安装或使用传统安装方法。*
|
|
||||||
|
|
||||||
*让专业的 AI 智能体处理专业工作。*
|
|
||||||
Reference in New Issue
Block a user