bmad-template/README.md

# BMAD Method 成品模板

这是一个已经安装好的 BMAD Method 成品模板，用于解决团队成员在不同 IDE 或 Agent 环境中无法正常安装、重复安装成本高的问题。

使用者不需要重新执行安装流程。把本模板放到目标项目根目录后，只保留自己使用的 IDE 目录和 BMAD 共享目录即可。

## 适用场景

- 安装 BMAD Method 失败，但需要直接使用已安装好的 skills 和 workflows。
- 希望在新项目中快速放入一套统一的 BMAD 工作流。
- 团队希望用同一套 BMAD 角色、流程和输出目录约定。

## 快速使用

### 新项目

1. 克隆或下载本仓库到目标项目根目录。
2. 按自己的 IDE 或 Agent 环境保留一个 IDE 目录。
3. 删除不使用的其它 IDE 目录，减少项目体积。
4. 在 IDE 或 Agent 中使用 `bmad-help` 查看可用能力，或直接调用具体角色和技能。

### 既有项目

1. 将本模板中的 `_bmad`、`docs`、`_bmad-output` 复制到既有项目根目录。
2. 再复制自己 IDE 对应的一个目录，例如 `.claude` 或 `.trae`。
3. 不需要复制其它 IDE 目录。
4. 打开项目后，让对应 IDE 或 Agent 重新读取项目上下文。

## 目录选择

| 目录 | 适用环境 | 是否必须保留 |
| --- | --- | --- |
| `.agents` | Codex 等没有显示对应目录名的 IDE 或 Agent 环境 | 按需保留一个 |
| `.claude` | Claude Code | 按需保留一个 |
| `.codebuddy` | CodeBuddy | 按需保留一个 |
| `.trae` | Trae | 按需保留一个 |
| `_bmad` | BMAD 共享配置、模块、脚本和工作流元数据 | 必须保留 |
| `docs` | 项目知识库目录，供 BMAD 生成和读取项目文档 | 建议保留 |
| `_bmad-output` | BMAD 规划、实现、测试等输出产物目录 | 建议保留 |

保留规则：

- 必须保留 `_bmad`。
- 至少保留一个自己使用的 IDE 目录。
- `docs` 和 `_bmad-output` 建议保留；没有内容时也用于约定后续产物位置。
- 不使用的 IDE 目录可以删除，例如只使用 Trae 时，可以删除 `.agents`、`.claude`、`.codebuddy`。

## 常用入口

打开项目后，可以先让 IDE 或 Agent 执行：

```text
bmad-help
```

常见工作流包括：

- `bmad-create-prd`：创建产品需求文档。
- `bmad-create-architecture`：创建技术架构方案。
- `bmad-create-epics-and-stories`：拆分 epic 和 story。
- `bmad-sprint-planning`：生成 sprint 实施计划。
- `bmad-create-story`：创建具体 story。
- `bmad-dev-story`：按 story 执行开发。
- `bmad-code-review`：执行代码评审。
- `bmad-tea` 或 `bmad-testarch-*`：执行测试架构、测试设计、自动化测试等流程。

也可以直接按角色调用：

- Mary：业务分析。
- John：产品管理。
- Sally：UX 设计。
- Winston：系统架构。
- Amelia：开发实现。
- Paige：技术文档。
- Murat：测试架构。

## 输出位置

默认配置位于 `_bmad/config.toml` 和 `_bmad/config.user.toml`。

常用输出位置：

- 规划产物：`_bmad-output/planning-artifacts`
- 实现产物：`_bmad-output/implementation-artifacts`
- 测试产物：`_bmad-output/test-artifacts`
- 项目知识：`docs`

## 配置说明

`_bmad/config.toml` 和 `_bmad/config.user.toml` 是安装生成配置，后续重新安装时可能被覆盖。

如需长期覆盖配置，优先使用：

- 团队共享配置：`_bmad/custom/config.toml`
- 个人本地配置：`_bmad/custom/config.user.toml`
- 单个 skill 的团队覆盖：`_bmad/custom/<skill-name>.toml`
- 单个 skill 的个人覆盖：`_bmad/custom/<skill-name>.user.toml`

个人配置文件通常不应提交到团队仓库。

## 注意事项

- 本仓库是 BMAD Method 安装后的成品模板，不是安装器源码。
- 多个 IDE 目录内容相同，区别在于不同 IDE 或 Agent 识别的目录位置不同。
- 如果使用者只保留自己的 IDE 目录，BMAD 的共享能力仍依赖 `_bmad`。
- 如果移动项目目录后出现配置解析问题，先确认 `_bmad` 是否仍在项目根目录。
- 如果不知道当前环境该保留哪个目录，先保留 `.agents` 和自己的 IDE 目录，确认可用后再清理。