301 lines
15 KiB
Markdown
301 lines
15 KiB
Markdown
---
|
||
title: "快速入门"
|
||
description: 安装 BMad 并构建你的第一个项目
|
||
---
|
||
|
||
使用 AI 驱动的工作流更快地构建软件，通过专门的智能体引导你完成规划、架构设计和实现。
|
||
|
||
## 你将学到
|
||
|
||
- 为新项目安装并初始化 BMad Method
|
||
- 使用 **BMad-Help** —— 你的智能向导，它知道下一步该做什么
|
||
- 根据项目规模选择合适的规划路径
|
||
- 从需求到可用代码，逐步推进各个阶段
|
||
- 有效使用智能体和工作流
|
||
|
||
:::note[前置条件]
|
||
- **Node.js 20+** — 安装程序必需
|
||
- **Git** — 推荐用于版本控制
|
||
- **AI 驱动的 IDE** — Claude Code、Cursor 或类似工具
|
||
- **一个项目想法** — 即使是简单的想法也可以用于学习
|
||
:::
|
||
|
||
:::tip[最简单的路径]
|
||
**安装** → `npx bmad-method install`
|
||
**询问** → `bmad-help 我应该先做什么？`
|
||
**构建** → 让 BMad-Help 逐个工作流地引导你
|
||
:::
|
||
|
||
## 认识 BMad-Help：你的智能向导
|
||
|
||
**BMad-Help 是开始使用 BMad 的最快方式。** 你不需要记住工作流或阶段 —— 只需询问，BMad-Help 就会：
|
||
|
||
- **检查你的项目**，看看已经完成了什么
|
||
- **根据你安装的模块显示你的选项**
|
||
- **推荐下一步** —— 包括第一个必需任务
|
||
- **回答问题**，比如"我有一个 SaaS 想法，应该从哪里开始？"
|
||
|
||
### 如何使用 BMad-Help
|
||
|
||
只需在 AI IDE 中使用斜杠命令运行它：
|
||
|
||
```
|
||
bmad-help
|
||
```
|
||
|
||
或者结合问题以获得上下文感知的指导：
|
||
|
||
```
|
||
bmad-help 我有一个 SaaS 产品的想法，我已经知道我想要的所有功能。我应该从哪里开始？
|
||
```
|
||
|
||
BMad-Help 将回应：
|
||
- 针对你的情况推荐什么
|
||
- 第一个必需任务是什么
|
||
- 其余流程是什么样的
|
||
|
||
### 它也驱动工作流
|
||
|
||
BMad-Help 不仅回答问题 —— **它会在每个工作流结束时自动运行**，告诉你确切地下一步该做什么。无需猜测，无需搜索文档 —— 只需对下一个必需工作流的清晰指导。
|
||
|
||
:::tip[从这里开始]
|
||
安装 BMad 后，立即运行 `bmad-help`。它将检测你安装了哪些模块，并引导你找到项目的正确起点。
|
||
:::
|
||
|
||
## 了解 BMad
|
||
|
||
BMad 通过带有专门 AI 智能体的引导工作流帮助你构建软件。该过程遵循四个阶段：
|
||
|
||
| 阶段 | 名称 | 发生什么 |
|
||
| ---- | -------------- | -------------------------------------------------- |
|
||
| 1 | 分析 | 头脑风暴、研究、产品简报 *（可选）* |
|
||
| 2 | 规划 | 创建需求（PRD 或技术规范） |
|
||
| 3 | 解决方案设计 | 设计架构 *（仅限 BMad Method/Enterprise only）* |
|
||
| 4 | 实现 | 逐个史诗、逐个故事地构建 |
|
||
|
||
**[打开工作流地图](../reference/workflow-map.md)** 以探索阶段、工作流和上下文管理。
|
||
|
||
根据项目的复杂性，BMad 提供三种规划路径：
|
||
|
||
| 路径 | 最适合 | 创建的文档 |
|
||
| --------------- | ---------------------------------------------------- | --------------------------------------- |
|
||
| **Quick Flow** | 错误修复、简单功能、范围清晰（1-15 个故事） | 仅技术规范 |
|
||
| **BMad Method** | 产品、平台、复杂功能（10-50+ 个故事） | PRD + 架构 + UX |
|
||
| **Enterprise** | 合规、多租户系统（30+ 个故事） | PRD + 架构 + 安全 + DevOps |
|
||
|
||
:::note
|
||
故事数量是指导，而非定义。根据规划需求选择你的路径，而不是故事数学。
|
||
:::
|
||
|
||
## 安装
|
||
|
||
在项目目录中打开终端并运行：
|
||
|
||
```bash
|
||
npx bmad-method install
|
||
```
|
||
|
||
当提示选择模块时，选择 **BMad Method**。
|
||
|
||
安装程序会创建两个文件夹：
|
||
- `_bmad/` — 智能体、工作流、任务和配置
|
||
- `_bmad-output/` — 目前为空，但这是你的工件将被保存的地方
|
||
|
||
:::tip[你的下一步]
|
||
在项目文件夹中打开你的 AI IDE 并运行：
|
||
|
||
```
|
||
bmad-help
|
||
```
|
||
|
||
BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么。你也可以问它诸如"我的选项是什么？"或"我有一个 SaaS 想法，我应该从哪里开始？"之类的问题。
|
||
:::
|
||
|
||
:::note[如何加载智能体和运行工作流]
|
||
每个工作流都有一个你在 IDE 中运行的**斜杠命令**（例如 `bmad-bmm-create-prd`）。运行工作流命令会自动加载相应的智能体 —— 你不需要单独加载智能体。你也可以直接加载智能体进行一般对话（例如，加载 PM 智能体使用 `bmad-agent-bmm-pm`）。
|
||
:::
|
||
|
||
:::caution[新对话]
|
||
始终为每个工作流开始一个新的对话。这可以防止上下文限制导致问题。
|
||
:::
|
||
|
||
## 步骤 1：创建你的计划
|
||
|
||
完成阶段 1-3。**为每个工作流使用新对话。**
|
||
|
||
:::tip[项目上下文（可选）]
|
||
在开始之前，考虑创建 `project-context.md` 来记录你的技术偏好和实现规则。这确保所有 AI 智能体在整个项目中遵循你的约定。
|
||
|
||
在 `_bmad-output/project-context.md` 手动创建它，或在架构之后使用 `bmad-bmm-generate-project-context` 生成它。[了解更多](../explanation/project-context.md)。
|
||
:::
|
||
|
||
### 阶段 1：分析（可选）
|
||
|
||
此阶段中的所有工作流都是可选的：
|
||
- **头脑风暴**（`bmad-brainstorming`） — 引导式构思
|
||
- **研究**（`bmad-bmm-research`） — 市场和技术研究
|
||
- **创建产品简报**（`bmad-bmm-create-product-brief`） — 推荐的基础文档
|
||
|
||
### 阶段 2：规划（必需）
|
||
|
||
**对于 BMad Method 和 Enterprise 路径：**
|
||
1. 在新对话中加载 **PM 智能体**（`bmad-agent-bmm-pm`）
|
||
2. 运行 `prd` 工作流（`bmad-bmm-create-prd`）
|
||
3. 输出：`PRD.md`
|
||
|
||
**对于 Quick Flow 路径：**
|
||
- 使用 `quick-spec` 工作流（`bmad-bmm-quick-spec`）代替 PRD，然后跳转到实现
|
||
|
||
:::note[UX 设计（可选）]
|
||
如果你的项目有用户界面，在创建 PRD 后加载 **UX-Designer 智能体**（`bmad-agent-bmm-ux-designer`）并运行 UX 设计工作流（`bmad-bmm-create-ux-design`）。
|
||
:::
|
||
|
||
### 阶段 3：解决方案设计（BMad Method/Enterprise）
|
||
|
||
**创建架构**
|
||
1. 在新对话中加载 **Architect 智能体**（`bmad-agent-bmm-architect`）
|
||
2. 运行 `create-architecture`（`bmad-bmm-create-architecture`）
|
||
3. 输出：包含技术决策的架构文档
|
||
|
||
**创建史诗和故事**
|
||
|
||
:::tip[V6 改进]
|
||
史诗和故事现在在架构*之后*创建。这会产生更高质量的故事，因为架构决策（数据库、API 模式、技术栈）直接影响工作应该如何分解。
|
||
:::
|
||
|
||
1. 在新对话中加载 **PM 智能体**（`bmad-agent-bmm-pm`）
|
||
2. 运行 `create-epics-and-stories`（`bmad-bmm-create-epics-and-stories`）
|
||
3. 工作流使用 PRD 和架构来创建技术信息丰富的故事
|
||
|
||
**实现就绪检查** *（强烈推荐）*
|
||
1. 在新对话中加载 **Architect 智能体**（`bmad-agent-bmm-architect`）
|
||
2. 运行 `check-implementation-readiness`（`bmad-bmm-check-implementation-readiness`）
|
||
3. 验证所有规划文档之间的一致性
|
||
|
||
## 步骤 2：构建你的项目
|
||
|
||
规划完成后，进入实现阶段。**每个工作流应该在新对话中运行。**
|
||
|
||
### 初始化冲刺规划
|
||
|
||
加载 **SM 智能体**（`bmad-agent-bmm-sm`）并运行 `sprint-planning`（`bmad-bmm-sprint-planning`）。这将创建 `sprint-status.yaml` 来跟踪所有史诗和故事。
|
||
|
||
### 构建周期
|
||
|
||
对于每个故事，使用新对话重复此周期：
|
||
|
||
| 步骤 | 智能体 | 工作流 | 命令 | 目的 |
|
||
| ---- | ------ | ------------ | ----------------------- | ------------------------------- |
|
||
| 1 | SM | `create-story` | `bmad-bmm-create-story` | 从史诗创建故事文件 |
|
||
| 2 | DEV | `dev-story` | `bmad-bmm-dev-story` | 实现故事 |
|
||
| 3 | DEV | `code-review` | `bmad-bmm-code-review` | 质量验证 *（推荐）* |
|
||
|
||
完成史诗中的所有故事后，加载 **SM 智能体**（`bmad-agent-bmm-sm`）并运行 `retrospective`（`bmad-bmm-retrospective`）。
|
||
|
||
## 你已完成的工作
|
||
|
||
你已经学习了使用 BMad 构建的基础：
|
||
|
||
- 安装了 BMad 并为你的 IDE 进行了配置
|
||
- 使用你选择的规划路径初始化了项目
|
||
- 创建了规划文档（PRD、架构、史诗和故事）
|
||
- 了解了实现的构建周期
|
||
|
||
你的项目现在拥有：
|
||
|
||
```text
|
||
your-project/
|
||
├── _bmad/ # BMad 配置
|
||
├── _bmad-output/
|
||
│ ├── planning-artifacts/
|
||
│ │ ├── PRD.md # 你的需求文档
|
||
│ │ ├── architecture.md # 技术决策
|
||
│ │ └── epics/ # 史诗和故事文件
|
||
│ ├── implementation-artifacts/
|
||
│ │ └── sprint-status.yaml # 冲刺跟踪
|
||
│ └── project-context.md # 实现规则（可选）
|
||
└── ...
|
||
```
|
||
|
||
## 快速参考
|
||
|
||
| 工作流 | 命令 | 智能体 | 目的 |
|
||
| ----------------------------------- | --------------------------------------- | -------- | -------------------------------------------- |
|
||
| **`help`** ⭐ | `bmad-help` | 任意 | **你的智能向导 —— 随时询问任何问题！** |
|
||
| `prd` | `bmad-bmm-create-prd` | PM | 创建产品需求文档 |
|
||
| `create-architecture` | `bmad-bmm-create-architecture` | Architect | 创建架构文档 |
|
||
| `generate-project-context` | `bmad-bmm-generate-project-context` | Analyst | 创建项目上下文文件 |
|
||
| `create-epics-and-stories` | `bmad-bmm-create-epics-and-stories` | PM | 将 PRD 分解为史诗 |
|
||
| `check-implementation-readiness` | `bmad-bmm-check-implementation-readiness` | Architect | 验证规划一致性 |
|
||
| `sprint-planning` | `bmad-bmm-sprint-planning` | SM | 初始化冲刺跟踪 |
|
||
| `create-story` | `bmad-bmm-create-story` | SM | 创建故事文件 |
|
||
| `dev-story` | `bmad-bmm-dev-story` | DEV | 实现故事 |
|
||
| `code-review` | `bmad-bmm-code-review` | DEV | 审查已实现的代码 |
|
||
|
||
## 常见问题
|
||
|
||
**我总是需要架构吗？**
|
||
仅对于 BMad Method 和 Enterprise 路径。Quick Flow 从技术规范跳转到实现。
|
||
|
||
**我可以稍后更改我的计划吗？**
|
||
可以。SM 智能体有一个 `correct-course` 工作流（`bmad-bmm-correct-course`）用于处理范围变更。
|
||
|
||
**如果我想先进行头脑风暴怎么办？**
|
||
在开始 PRD 之前，加载 Analyst 智能体（`bmad-agent-bmm-analyst`）并运行 `brainstorming`（`bmad-brainstorming`）。
|
||
|
||
**我需要遵循严格的顺序吗？**
|
||
不一定。一旦你了解了流程，你可以使用上面的快速参考直接运行工作流。
|
||
|
||
## 获取帮助
|
||
|
||
:::tip[第一站：BMad-Help]
|
||
**随时运行 `bmad-help`** —— 这是摆脱困境的最快方式。问它任何问题：
|
||
- "安装后我应该做什么？"
|
||
- "我在工作流 X 上卡住了"
|
||
- "我在 Y 方面有什么选项？"
|
||
- "向我展示到目前为止已完成的工作"
|
||
|
||
BMad-Help 检查你的项目，检测你已完成的内容，并确切地告诉你下一步该做什么。
|
||
:::
|
||
|
||
- **在工作流期间** — 智能体通过问题和解释引导你
|
||
- **社区** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
|
||
|
||
## 关键要点
|
||
|
||
:::tip[记住这些]
|
||
- **从 `bmad-help` 开始** — 你的智能向导，了解你的项目和选项
|
||
- **始终使用新对话** — 为每个工作流开始新对话
|
||
- **路径很重要** — Quick Flow 使用 quick-spec；Method/Enterprise 需要 PRD 和架构
|
||
- **BMad-Help 自动运行** — 每个工作流结束时都会提供下一步的指导
|
||
:::
|
||
|
||
准备好开始了吗？安装 BMad，运行 `bmad-help`，让你的智能向导为你引路。
|
||
|
||
---
|
||
## 术语说明
|
||
|
||
- **agent**：智能体。在人工智能与编程文档中，指具备自主决策或执行能力的单元。
|
||
- **epic**：史诗。软件开发中用于组织和管理大型功能或用户需求的高级工作项。
|
||
- **story**：故事。敏捷开发中的用户故事，描述用户需求的小型工作项。
|
||
- **PRD**：产品需求文档（Product Requirements Document）。详细描述产品功能、需求和目标的文档。
|
||
- **workflow**：工作流。一系列有序的任务或步骤，用于完成特定目标。
|
||
- **sprint**：冲刺。敏捷开发中的固定时间周期，用于完成预定的工作。
|
||
- **IDE**：集成开发环境（Integrated Development Environment）。提供代码编辑、调试等功能的软件工具。
|
||
- **artifact**：工件。软件开发过程中产生的文档、代码或其他可交付成果。
|
||
- **retrospective**：回顾。敏捷开发中的会议，用于反思和改进团队工作流程。
|
||
- **tech-spec**：技术规范（Technical Specification）。描述系统技术实现细节的文档。
|
||
- **UX**：用户体验（User Experience）。用户在使用产品过程中的整体感受和交互体验。
|
||
- **PM**：产品经理（Product Manager）。负责产品规划、需求管理和团队协调的角色。
|
||
- **SM**：Scrum Master。敏捷开发中的角色，负责促进 Scrum 流程和团队协作。
|
||
- **DEV**：开发者（Developer）。负责编写代码和实现功能的角色。
|
||
- **Architect**：架构师。负责系统架构设计和技术决策的角色。
|
||
- **Analyst**：分析师。负责需求分析、市场研究等工作的角色。
|
||
- **npx**：Node Package eXecute。Node.js 包执行器，用于运行 npm 包而无需安装。
|
||
- **Node.js**：基于 Chrome V8 引擎的 JavaScript 运行时环境。
|
||
- **Git**：分布式版本控制系统。
|
||
- **SaaS**：软件即服务（Software as a Service）。通过互联网提供软件服务的模式。
|
||
- **DevOps**：开发运维（Development and Operations）。强调开发和运维协作的实践和方法。
|
||
- **multi-tenant**：多租户。一种软件架构，允许单个实例为多个客户（租户）提供服务。
|
||
- **compliance**：合规性。遵守法律、法规和行业标准的要求。
|