Merge branch 'main' into fix/checkbox-tracking

This commit is contained in:
Alex Verkhovsky 2026-03-22 16:45:48 -06:00 committed by GitHub
commit 82fc1dfbfc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 150 additions and 180 deletions

View File

@ -135,7 +135,7 @@ Créez-le manuellement dans `_bmad-output/project-context.md` ou générez-le ap
Tous les workflows de cette phase sont optionnels : Tous les workflows de cette phase sont optionnels :
- **brainstorming** (`bmad-brainstorming`) — Idéation guidée - **brainstorming** (`bmad-brainstorming`) — Idéation guidée
- **research** (`bmad-research`) — Recherche marché et technique - **research** (`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research`) — Recherche marché, domaine et technique
- **create-product-brief** (`bmad-create-product-brief`) — Document de base recommandé - **create-product-brief** (`bmad-create-product-brief`) — Document de base recommandé
### Phase 2 : Planification (Requis) ### Phase 2 : Planification (Requis)
@ -239,7 +239,7 @@ Uniquement pour les voies méthode BMad et Enterprise. Quick Dev passe directeme
Oui. Utilisez `bmad-correct-course` pour gérer les changements de périmètre. Oui. Utilisez `bmad-correct-course` pour gérer les changements de périmètre.
**Et si je veux d'abord faire du brainstorming ?** **Et si je veux d'abord faire du brainstorming ?**
Invoquez l'agent Analyst (`bmad-analyst`) et exécutez `bmad-brainstorming` (`bmad-brainstorming`) avant de commencer votre PRD. Invoquez l'agent Analyst (`bmad-agent-analyst`) et exécutez `bmad-brainstorming` (`bmad-brainstorming`) avant de commencer votre PRD.
**Dois-je suivre un ordre strict ?** **Dois-je suivre un ordre strict ?**
Pas strictement. Une fois que vous maîtrisez le flux, vous pouvez exécuter les workflows directement en utilisant la référence rapide ci-dessus. Pas strictement. Une fois que vous maîtrisez le flux, vous pouvez exécuter les workflows directement en utilisant la référence rapide ci-dessus.

View File

@ -114,7 +114,7 @@ BMad-Help will detect what you've completed and recommend exactly what to do nex
::: :::
:::note[How to Load Agents and Run Workflows] :::note[How to Load Agents and Run Workflows]
Each workflow has a **skill** you invoke by name in your IDE (e.g., `bmad-create-prd`). Your AI tool will recognize the `bmad-*` name and run it — you don't need to load agents separately. You can also invoke an agent skill directly for general conversation (e.g., `bmad-pm` for the PM agent). Each workflow has a **skill** you invoke by name in your IDE (e.g., `bmad-create-prd`). Your AI tool will recognize the `bmad-*` name and run it — you don't need to load agents separately. You can also invoke an agent skill directly for general conversation (e.g., `bmad-agent-pm` for the PM agent).
::: :::
:::caution[Fresh Chats] :::caution[Fresh Chats]
@ -135,13 +135,13 @@ Create it manually at `_bmad-output/project-context.md` or generate it after arc
All workflows in this phase are optional: All workflows in this phase are optional:
- **brainstorming** (`bmad-brainstorming`) — Guided ideation - **brainstorming** (`bmad-brainstorming`) — Guided ideation
- **research** (`bmad-research`) — Market and technical research - **research** (`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research`) — Market, domain, and technical research
- **create-product-brief** (`bmad-create-product-brief`) — Recommended foundation document - **create-product-brief** (`bmad-create-product-brief`) — Recommended foundation document
### Phase 2: Planning (Required) ### Phase 2: Planning (Required)
**For BMad Method and Enterprise tracks:** **For BMad Method and Enterprise tracks:**
1. Invoke the **PM agent** (`bmad-pm`) in a new chat 1. Invoke the **PM agent** (`bmad-agent-pm`) in a new chat
2. Run the `bmad-create-prd` workflow (`bmad-create-prd`) 2. Run the `bmad-create-prd` workflow (`bmad-create-prd`)
3. Output: `PRD.md` 3. Output: `PRD.md`
@ -149,13 +149,13 @@ All workflows in this phase are optional:
- Run `bmad-quick-dev` — it handles planning and implementation in a single workflow, skip to implementation - Run `bmad-quick-dev` — it handles planning and implementation in a single workflow, skip to implementation
:::note[UX Design (Optional)] :::note[UX Design (Optional)]
If your project has a user interface, invoke the **UX-Designer agent** (`bmad-ux-designer`) and run the UX design workflow (`bmad-create-ux-design`) after creating your PRD. If your project has a user interface, invoke the **UX-Designer agent** (`bmad-agent-ux-designer`) and run the UX design workflow (`bmad-create-ux-design`) after creating your PRD.
::: :::
### Phase 3: Solutioning (BMad Method/Enterprise) ### Phase 3: Solutioning (BMad Method/Enterprise)
**Create Architecture** **Create Architecture**
1. Invoke the **Architect agent** (`bmad-architect`) in a new chat 1. Invoke the **Architect agent** (`bmad-agent-architect`) in a new chat
2. Run `bmad-create-architecture` (`bmad-create-architecture`) 2. Run `bmad-create-architecture` (`bmad-create-architecture`)
3. Output: Architecture document with technical decisions 3. Output: Architecture document with technical decisions
@ -165,12 +165,12 @@ If your project has a user interface, invoke the **UX-Designer agent** (`bmad-ux
Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down. Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down.
::: :::
1. Invoke the **PM agent** (`bmad-pm`) in a new chat 1. Invoke the **PM agent** (`bmad-agent-pm`) in a new chat
2. Run `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`) 2. Run `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`)
3. The workflow uses both PRD and Architecture to create technically-informed stories 3. The workflow uses both PRD and Architecture to create technically-informed stories
**Implementation Readiness Check** *(Highly Recommended)* **Implementation Readiness Check** *(Highly Recommended)*
1. Invoke the **Architect agent** (`bmad-architect`) in a new chat 1. Invoke the **Architect agent** (`bmad-agent-architect`) in a new chat
2. Run `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`) 2. Run `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`)
3. Validates cohesion across all planning documents 3. Validates cohesion across all planning documents
@ -180,7 +180,7 @@ Once planning is complete, move to implementation. **Each workflow should run in
### Initialize Sprint Planning ### Initialize Sprint Planning
Invoke the **SM agent** (`bmad-sm`) and run `bmad-sprint-planning` (`bmad-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories. Invoke the **SM agent** (`bmad-agent-sm`) and run `bmad-sprint-planning` (`bmad-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
### The Build Cycle ### The Build Cycle
@ -192,7 +192,7 @@ For each story, repeat this cycle with fresh chats:
| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implement the story | | 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implement the story |
| 3 | DEV | `bmad-code-review` | `bmad-code-review` | Quality validation *(recommended)* | | 3 | DEV | `bmad-code-review` | `bmad-code-review` | Quality validation *(recommended)* |
After completing all stories in an epic, invoke the **SM agent** (`bmad-sm`) and run `bmad-retrospective` (`bmad-retrospective`). After completing all stories in an epic, invoke the **SM agent** (`bmad-agent-sm`) and run `bmad-retrospective` (`bmad-retrospective`).
## What You've Accomplished ## What You've Accomplished
@ -243,7 +243,7 @@ Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to i
Yes. The SM agent has a `bmad-correct-course` workflow (`bmad-correct-course`) for handling scope changes. Yes. The SM agent has a `bmad-correct-course` workflow (`bmad-correct-course`) for handling scope changes.
**What if I want to brainstorm first?** **What if I want to brainstorm first?**
Invoke the Analyst agent (`bmad-analyst`) and run `bmad-brainstorming` (`bmad-brainstorming`) before starting your PRD. Invoke the Analyst agent (`bmad-agent-analyst`) and run `bmad-brainstorming` (`bmad-brainstorming`) before starting your PRD.
**Do I need to follow a strict order?** **Do I need to follow a strict order?**
Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above. Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above.

View File

@ -5,9 +5,9 @@ sidebar:
order: 6 order: 6
--- ---
在现有项目和遗留代码库上工作时,有效使用 BMad Method。 当你在现有项目或遗留代码库上工作时,本指南帮助你更稳妥地使用 BMad Method。
本指南涵盖了使用 BMad Method 接入现有项目的核心工作流程 如果你是从零开始的新项目,建议先看[快速入门](../tutorials/getting-started.md);本文主要面向既有项目接入场景
:::note[前置条件] :::note[前置条件]
- 已安装 BMad Method`npx bmad-method install` - 已安装 BMad Method`npx bmad-method install`
@ -23,16 +23,16 @@ sidebar:
- `_bmad-output/planning-artifacts/` - `_bmad-output/planning-artifacts/`
- `_bmad-output/implementation-artifacts/` - `_bmad-output/implementation-artifacts/`
## 步骤 2创建项目上下文 ## 步骤 2创建项目上下文project context
:::tip[推荐用于既有项目] :::tip[推荐用于既有项目]
生成 `project-context.md` 以捕获你现有代码库的模式和约定。这确保 AI 智能体在实施变更时遵循你既定的实践。 生成 `project-context.md`,梳理现有代码库的模式与约定,确保 AI 智能体在实施变更时遵循你既有的工程实践。
::: :::
运行生成项目上下文工作流 运行生成项目上下文工作流:
```bash ```bash
/bmad-bmm-generate-project-context bmad-generate-project-context
``` ```
这将扫描你的代码库以识别: 这将扫描你的代码库以识别:
@ -40,9 +40,10 @@ sidebar:
- 代码组织模式 - 代码组织模式
- 命名约定 - 命名约定
- 测试方法 - 测试方法
- 框架特定模式 - 框架相关模式
你可以查看和完善生成的文件,或者如果你更喜欢,可以在 `_bmad-output/project-context.md` 手动创建它。 你可以先审阅并完善生成内容;如果更希望手动维护,也可以直接在
`_bmad-output/project-context.md` 创建并编辑。
[了解更多关于项目上下文](../explanation/project-context.md) [了解更多关于项目上下文](../explanation/project-context.md)
@ -55,80 +56,63 @@ sidebar:
- 架构 - 架构
- 任何其他相关的项目信息 - 任何其他相关的项目信息
对于复杂项目,考虑使用 `document-project` 工作流程。它提供运行时变体,将扫描你的整个项目并记录其实际当前状态。 对于复杂项目,可考虑使用 `bmad-document-project` 工作流。它会扫描整个项目并记录当前真实状态。
## 步骤 3:获取帮助 ## 步骤 4:获取帮助
### BMad-Help你的起点 ### BMad-Help默认起点
**随时运行 `bmad-help`,当你不确定下一步该做什么时。** 这个智能指南: **当你不确定下一步做什么时,随时运行 `bmad-help`。** 这个智能指南
- 检查你的项目以查看已经完成了什么 - 检查项目当前状态,识别哪些工作已经完成
- 根据你安装的模块显示选项 - 根据你安装的模块给出可行选项
- 理解自然语言查询 - 理解自然语言查询
``` ```
bmad-help 我有一个现有的 Rails 应用,我应该从哪里开始? bmad-help 我有一个现有的 Rails 应用,我应该从哪里开始?
bmad-help quick-flow 和完整方法有什么区别? bmad-help Quick Flow 和完整方法有什么区别?
bmad-help 显示我有哪些可用工作流 bmad-help 显示我当前有哪些可用工作流
``` ```
BMad-Help 还会在**每个工作流程结束时自动运行**,提供关于下一步该做什么的清晰指导 BMad-Help 还会在**每个工作流结束时自动运行**,明确告诉你下一步该做什么
### 选择你的方法 ### 选择你的方法
根据变更范围,你有两个主要选项: 根据变更范围,你有两个主要选项:
| 范围 | 推荐方法 | | 范围 | 推荐方法 |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------- | | --- | --- |
| **小型更新或添加** | 运行 `bmad-quick-dev` 在单个工作流中澄清意图、规划、实现和审查。完整的四阶段 BMad Method 可能有些过度。 | | **小型更新或新增** | 运行 `bmad-quick-dev`,在单个工作流中完成意图澄清、规划、实现与审查。完整四阶段 BMad Method 往往过重。 |
| **重大变更或添加** | 从 BMad Method 开始,根据需要应用或多或少的严谨性。 | | **重大变更或新增** | 从完整 BMad Method 开始,再按项目风险和协作需求调整流程严谨度。 |
### 在创建 PRD 期间 ### 在创建 PRD 期间
在创建简报或直接进入 PRD 时,确保智能体: 在创建简报或直接进入 PRD 时,确保智能体:
- 查找并分析你现有的项目文档 - 查找并分析你现有的项目文档
- 阅读关于你当前系统的适当上下文 - 读取与你当前系统匹配的项目上下文project context
你可以明确地指导智能体,但目标是确保新功能与你的现有系统良好集成 你可以显式补充指令,但核心目标是让新功能与现有 architecture 和代码约束自然融合
### UX 考量 ### UX 考量
UX 工作是可选的。决定不取决于你的项目是否有 UX,而取决于: UX 工作是可选项。是否需要进入 UX 流程,不取决于“项目里有没有 UX”,而取决于:
- 你是否将处理 UX 变更 - 你是否真的在做 UX 层面的变更
- 是否需要重要的 UX 设计或模式 - 是否需要新增重要的 UX 设计或交互模式
如果你的变更只是对你满意的现有屏幕进行简单更新,则不需要完整的 UX 流程。 如果本次只是对现有页面做小幅调整,通常不需要完整 UX 流程。
### 架构考量 ### 架构考量architecture
在进行架构工作时,确保架构师: 在进行架构工作时,确保架构师:
- 使用适当的已记录文件 - 使用正确且最新的文档输入
- 扫描现有代码库 - 扫描并理解现有代码库
在此处要密切注意,以防止重新发明轮子或做出与你现有架构不一致的决定 这一点非常关键:可避免“重复造轮子”,也能减少与现有架构冲突的设计决策
## 更多信息 ## 更多信息
- **[快速修复](./quick-fixes.md)** - 错误修复和临时变更 - **[快速修复](./quick-fixes.md)** - 错误修复和临时变更
- **[既有项目 FAQ](../explanation/established-projects-faq.md)** - 关于在既有项目上工作的常见问题 - **[既有项目 FAQ](../explanation/established-projects-faq.md)** - 关于在既有项目上工作的常见问题
---
## 术语说明
- **BMad Method**BMad 方法。一种结构化的软件开发方法论,用于指导从分析到实施的完整流程。
- **PRD**产品需求文档Product Requirements Document。描述产品功能、需求和目标的文档。
- **epic**:史诗。大型功能或用户故事的集合,通常需要较长时间完成。
- **story**:用户故事。描述用户需求的简短陈述,通常遵循"作为...我想要...以便于..."的格式。
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
- **IDE**集成开发环境Integrated Development Environment。提供代码编辑、调试、构建等功能的软件工具。
- **UX**用户体验User Experience。用户在使用产品或服务过程中的整体感受和交互体验。
- **tech-spec**技术规范Technical Specification。描述技术实现细节、架构设计和开发标准的文档。
- **quick-flow**快速流程。BMad Method 中的一种简化工作流程,适用于小型变更或快速迭代。
- **legacy codebase**:遗留代码库。指历史遗留的、可能缺乏文档或使用过时技术的代码集合。
- **project context**:项目上下文。描述项目技术栈、约定、模式等背景信息的文档。
- **artifact**:产物。在开发过程中生成的文档、代码或其他输出物。
- **runtime variant**:运行时变体。在程序运行时可选择或切换的不同实现方式或配置。

View File

@ -5,9 +5,9 @@ sidebar:
order: 1 order: 1
--- ---
使用 `npx bmad-method install` 命令在项目中设置 BMad并选择你需要的模块和 AI 工具。 使用 `npx bmad-method install` 在项目中安装 BMad并按需选择模块和 AI 工具。
如果你想使用非交互式安装程序并在命令行中提供所有安装选项,请参阅[本指南](./non-interactive-installation.md)。 如果你需要在命令行里一次性传入全部安装参数(例如 CI/CD 场景),请阅读[非交互式安装指南](./non-interactive-installation.md)。
## 何时使用 ## 何时使用
@ -29,7 +29,16 @@ sidebar:
npx bmad-method install npx bmad-method install
``` ```
:::tip[最新版本] :::tip[想要最新预发布版本?]
使用 `next` 发布标签:
```bash
npx bmad-method@next install
```
这会更早拿到新改动,但相比默认安装通道,出现变动的概率也更高。
:::
:::tip[前沿版本]
要从主分支安装最新版本(可能不稳定): 要从主分支安装最新版本(可能不稳定):
```bash ```bash
npx github:bmad-code-org/BMAD-METHOD install npx github:bmad-code-org/BMAD-METHOD install
@ -51,7 +60,11 @@ npx github:bmad-code-org/BMAD-METHOD install
- Cursor - Cursor
- 其他 - 其他
每个工具都有自己的命令集成方式。安装程序会创建微小的提示文件来激活工作流和智能体——它只是将它们放在工具期望找到的位置。 每种工具都有自己的 skills 集成方式。安装程序会生成用于激活工作流和智能体的轻量提示文件,并放到该工具约定的位置。
:::note[启用 Skills]
某些平台需要你在设置中手动启用 skills 才会显示。如果你已经安装 BMad 但看不到 skills请检查平台设置或直接询问你的 AI 助手如何启用 skills。
:::
### 4. 选择模块 ### 4. 选择模块
@ -63,16 +76,25 @@ npx github:bmad-code-org/BMAD-METHOD install
## 你将获得 ## 你将获得
以下目录结构仅作示例。工具相关目录会随你选择的平台变化(例如可能是
`.claude/skills`、`.cursor/skills` 或 `.kiro/skills`),并不一定会同时出现。
```text ```text
your-project/ your-project/
├── _bmad/ ├── _bmad/
│ ├── bmm/ # 你选择的模块 │ ├── bmm/ # 你选择的模块
│ │ └── config.yaml # 模块设置(如果你需要更改它们 │ │ └── config.yaml # 模块设置(后续如需可修改
│ ├── core/ # 必需核心模块 │ ├── core/ # 必需核心模块
│ └── ... │ └── ...
├── _bmad-output/ # 生成的工件 ├── _bmad-output/ # 生成产物
├── .claude/ # Claude Code 命令(如果使用 Claude Code ├── .claude/ # Claude Code skills如使用 Claude Code
└── .kiro/ # Kiro 引导文件(如果使用 Kiro │ └── skills/
│ ├── bmad-help/
│ ├── bmad-persona/
│ └── ...
└── .cursor/ # Cursor skills如使用 Cursor
└── skills/
└── ...
``` ```
## 验证安装 ## 验证安装
@ -96,10 +118,3 @@ bmad-help 对于 SaaS 项目我有哪些选项?
**安装程序工作正常但后续出现问题**——你的 AI 需要 BMad 上下文才能提供帮助。请参阅[如何获取关于 BMad 的答案](./get-answers-about-bmad.md)了解如何将你的 AI 指向正确的来源。 **安装程序工作正常但后续出现问题**——你的 AI 需要 BMad 上下文才能提供帮助。请参阅[如何获取关于 BMad 的答案](./get-answers-about-bmad.md)了解如何将你的 AI 指向正确的来源。
---
## 术语说明
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
- **module**:模块。指软件系统中可独立开发、测试和维护的功能单元。
- **artifact**:工件。指在软件开发过程中生成的任何输出,如文档、代码、配置文件等。

View File

@ -1,11 +1,11 @@
--- ---
title: "非交互式安装" title: "非交互式安装"
description: 使用命令行标志安装 BMad适用于 CI/CD 流水线和自动化部署 description: 使用命令行参数安装 BMad适用于 CI/CD 流水线和自动化部署
sidebar: sidebar:
order: 2 order: 2
--- ---
使用命令行标志以非交互方式安装 BMad。这适用于 使用命令行参数flags以非交互方式安装 BMad。适用于以下场景
## 使用场景 ## 使用场景
@ -18,11 +18,11 @@ sidebar:
需要 [Node.js](https://nodejs.org) v20+ 和 `npx`(随 npm 附带)。 需要 [Node.js](https://nodejs.org) v20+ 和 `npx`(随 npm 附带)。
::: :::
## 可用标志 ## 可用参数Flags
### 安装选项 ### 安装选项
| 标志 | 描述 | 示例 | | 参数 | 描述 | 示例 |
|------|-------------|---------| |------|-------------|---------|
| `--directory <path>` | 安装目录 | `--directory ~/projects/myapp` | | `--directory <path>` | 安装目录 | `--directory ~/projects/myapp` |
| `--modules <modules>` | 逗号分隔的模块 ID | `--modules bmm,bmb` | | `--modules <modules>` | 逗号分隔的模块 ID | `--modules bmm,bmb` |
@ -32,7 +32,7 @@ sidebar:
### 核心配置 ### 核心配置
| 标志 | 描述 | 默认值 | | 参数 | 描述 | 默认值 |
|------|-------------|---------| |------|-------------|---------|
| `--user-name <name>` | 智能体使用的名称 | 系统用户名 | | `--user-name <name>` | 智能体使用的名称 | 系统用户名 |
| `--communication-language <lang>` | 智能体通信语言 | 英语 | | `--communication-language <lang>` | 智能体通信语言 | 英语 |
@ -41,14 +41,14 @@ sidebar:
### 其他选项 ### 其他选项
| 标志 | 描述 | | 参数 | 描述 |
|------|-------------| |------|-------------|
| `-y, --yes` | 接受所有默认值并跳过提示 | | `-y, --yes` | 接受所有默认值并跳过提示 |
| `-d, --debug` | 启用清单生成的调试输出 | | `-d, --debug` | 启用清单生成的调试输出 |
## 模块 ID ## 模块 ID
`--modules` 标志可用的模块 ID `--modules` 参数可用的模块 ID
- `bmm` — BMad Method Master - `bmm` — BMad Method Master
- `bmb` — BMad Builder - `bmb` — BMad Builder
@ -57,7 +57,7 @@ sidebar:
## 工具/IDE ID ## 工具/IDE ID
`--tools` 标志可用的工具 ID `--tools` 参数可用的工具 ID
**推荐:** `claude-code`、`cursor` **推荐:** `claude-code`、`cursor`
@ -67,8 +67,8 @@ sidebar:
| 模式 | 描述 | 示例 | | 模式 | 描述 | 示例 |
|------|-------------|---------| |------|-------------|---------|
| 完全非交互式 | 提供所有标志以跳过所有提示 | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` | | 完全非交互式 | 提供所有参数以跳过所有提示 | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` |
| 半交互式 | 提供部分标志BMad 提示其余部分 | `npx bmad-method install --directory . --modules bmm` | | 半交互式 | 提供部分参数BMad 提示其余部分 | `npx bmad-method install --directory . --modules bmm` |
| 仅使用默认值 | 使用 `-y` 接受所有默认值 | `npx bmad-method install --yes` | | 仅使用默认值 | 使用 `-y` 接受所有默认值 | `npx bmad-method install --yes` |
| 不包含工具 | 跳过工具/IDE 配置 | `npx bmad-method install --modules bmm --tools none` | | 不包含工具 | 跳过工具/IDE 配置 | `npx bmad-method install --modules bmm --tools none` |
@ -124,9 +124,9 @@ npx bmad-method install \
- 为所选模块和工具配置的智能体和工作流 - 为所选模块和工具配置的智能体和工作流
- 用于生成产物的 `_bmad-output/` 文件夹 - 用于生成产物的 `_bmad-output/` 文件夹
## 验证和错误处理 ## 参数校验与错误处理
BMad 会验证所有提供的标志 BMad 会验证你提供的所有参数
- **目录** — 必须是具有写入权限的有效路径 - **目录** — 必须是具有写入权限的有效路径
- **模块** — 对无效的模块 ID 发出警告(但不会失败) - **模块** — 对无效的模块 ID 发出警告(但不会失败)
@ -141,14 +141,14 @@ BMad 会验证所有提供的标志:
:::tip[最佳实践] :::tip[最佳实践]
- 为 `--directory` 使用绝对路径以避免歧义 - 为 `--directory` 使用绝对路径以避免歧义
- 在 CI/CD 流水线中使用前先在本地测试标志 - 在 CI/CD 流水线中使用前先在本地测试参数
- 结合 `-y` 实现真正的无人值守安装 - 结合 `-y` 实现真正的无人值守安装
- 如果在安装过程中遇到问题,使用 `--debug` - 如果在安装过程中遇到问题,使用 `--debug`
::: :::
## 故障排除 ## 故障排除
### 安装失败,提示"Invalid directory" ### 安装失败,提示 `Invalid directory`
- 目录路径必须存在(或其父目录必须存在) - 目录路径必须存在(或其父目录必须存在)
- 您需要写入权限 - 您需要写入权限
@ -167,15 +167,6 @@ BMad 会验证所有提供的标志:
- 在 `module.yaml` 中有 `code` 字段 - 在 `module.yaml` 中有 `code` 字段
:::note[仍然卡住了?] :::note[仍然卡住了?]
使用 `--debug` 运行以获取详细输出,尝试交互模式以隔离问题,或在 <https://github.com/bmad-code-org/BMAD-METHOD/issues> 报告 使用 `--debug` 获取详细输出,尝试交互模式定位问题,或在 <https://github.com/bmad-code-org/BMAD-METHOD/issues> 提交反馈
::: :::
---
## 术语说明
- **CI/CD**:持续集成/持续部署。一种自动化软件开发流程的实践,用于频繁集成代码更改并自动部署到生产环境。
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
- **module**:模块。软件系统中可独立开发、测试和维护的功能单元。
- **IDE**:集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。
- **npx**Node Package eXecute。npm 包执行器,用于直接执行 npm 包而无需全局安装。
- **workflow**:工作流。一系列有序的任务或步骤,用于完成特定的业务流程或开发流程。

View File

@ -5,27 +5,30 @@ sidebar:
order: 8 order: 8
--- ---
使用 `project-context.md` 文件确保 AI 智能体在所有工作流程中遵循项目的技术偏好和实现规则。 使用 `project-context.md`,确保 AI 智能体在各类工作流中遵循项目的技术偏好与实现规则。
为了保证这份上下文始终可见,你也可以在工具上下文或 always-rules 文件(如 `AGENTS.md`
中加入这句:
`Important project context and conventions are located in [path to project context]/project-context.md`
:::note[前置条件] :::note[前置条件]
- 已安装 BMad Method - 已安装 BMad Method
- 了解项目的技术栈约定 - 了解项目的技术栈与团队约定
::: :::
## 何时使用 ## 何时使用
- 在开始架构设计之前有明确的技术偏好 - 在开始架构architecture你已有明确的技术偏好
- 已完成架构设计并希望为实施捕获决策 - 已完成架构设计,希望把关键决策沉淀到实施阶段
- 正在处理具有既定模式的有代码库 - 正在处理具有既定模式的有代码库
- 注意到智能体在不同用户故事中做出不一致的决策 - 发现智能体在不同用户故事story之间决策不一致
## 步骤 1选择方法 ## 步骤 1选择路径
**手动创建** — 当您确切知道要记录哪些规则时最佳 **手动创建** — 适合你已经明确知道要沉淀哪些规则
**架构后生成** — 最适合捕获解决方案制定过程中所做的决策 **架构后生成** — 适合把 solutioning 阶段形成的架构决策沉淀下来
**为现有项目生成** — 最适合在现有代码库中发现模式 **为既有项目生成** — 适合从现有代码库中自动发现团队约定与模式
## 步骤 2创建文件 ## 步骤 2创建文件
@ -38,17 +41,17 @@ mkdir -p _bmad-output
touch _bmad-output/project-context.md touch _bmad-output/project-context.md
``` ```
添加技术栈和实现规则: 然后补充技术栈与实现规则:
```markdown ```markdown
--- ---
project_name: 'MyProject' project_name: '我的项目'
user_name: 'YourName' user_name: '你的名字'
date: '2026-02-15' date: '2026-02-15'
sections_completed: ['technology_stack', 'critical_rules'] sections_completed: ['technology_stack', 'critical_rules']
--- ---
# AI 智能体项目上下文 # AI 智能体项目上下文
## 技术栈与版本 ## 技术栈与版本
@ -60,93 +63,70 @@ sections_completed: ['technology_stack', 'critical_rules']
## 关键实现规则 ## 关键实现规则
**TypeScript** **TypeScript**
- 启用严格模式,不使用 `any` 类型 - 开启严格模式,禁止使用 `any` 类型
- 公共 API 使用 `interface`,联合类型使用 `type` - 对外 API 使用 `interface`,联合类型使用 `type`
**代码组织:** **代码组织:**
- 组件位于 `/src/components/` 并附带同位置测试 - 组件放在 `/src/components/`并与测试文件同目录co-located
- API 调用使用 `apiClient` 单例 — 绝不直接使用 fetch - API 调用统一使用 `apiClient` 单例,不要直接使用 `fetch`
**测试:** **测试:**
- 单元测试专注于业务逻辑 - 单元测试聚焦业务逻辑
- 集成测试使用 MSW 进行 API 模拟 - 集成测试使用 MSW 模拟 API
``` ```
### 选项 B架构后生成 ### 选项 B架构后生成
在新的聊天中运行工作流程 在新的会话中运行
```bash ```bash
/bmad-bmm-generate-project-context bmad-generate-project-context
``` ```
工作流程扫描架构文档和项目文件,生成捕获所做决策的上下文文件。 该工作流会扫描架构文档和项目文件,生成能够反映已做决策的上下文文件。
### 选项 C有项目生成 ### 选项 C有项目生成
对于有项目,运行: 对于有项目,运行:
```bash ```bash
/bmad-bmm-generate-project-context bmad-generate-project-context
``` ```
工作流程分析代码库以识别约定,然后生成上下文文件供您审查和完善 该工作流会分析代码库中的约定,然后生成可供你审阅和完善的上下文文件
## 步骤 3验证内容 ## 步骤 3验证内容
审查生成的文件并确保它捕获了: 审查生成文件,并确认它覆盖了:
- 正确的技术版本 - 正确的技术版本
- 实际约定(而非通用最佳实践) - 你的真实约定(不是通用最佳实践)
- 防常见错误的规则 - 能预防常见错误的规则
- 框架特定的模式 - 框架相关模式
手动编辑以添加任何缺失内容或删除不准确之处 如果有缺漏或误判,直接手动补充和修正
## 将获得 ## 将获得
一个 `project-context.md` 文件,它: 一个 `project-context.md` 文件,它可以
- 确保所有智能体遵循相同约定 - 确保所有智能体遵循相同约定
- 防止在不同用户故事中做出不一致的决策 - 避免在不同用户故事story中出现不一致决策
- 为实施捕获架构决策 - 为实施阶段保留架构决策
- 作为项目模式和规则的参考 - 作为项目模式与规则的长期参考
## 提示 ## 提示
:::tip[关注非显而易见的内容] :::tip[最佳实践]
记录智能体可能遗漏的模式,例如"在每个公共类、函数和变量上使用 JSDoc 风格注释",而不是像"使用有意义的变量名"这样的通用实践,因为 LLM 目前已经知道这些。 - **聚焦“不明显但重要”的规则**:优先记录智能体容易漏掉的项目约束,而不是
::: “变量要有意义”这类通用建议。
- **保持精简**:此文件会被多数实现工作流加载,过长会浪费上下文窗口。避免写入
:::tip[保持精简] 只适用于单一 story 的细节。
此文件由每个实施工作流程加载。长文件会浪费上下文。不要包含仅适用于狭窄范围或特定用户故事或功能的内容。 - **按需更新**:当团队约定变化时手动更新,或在架构发生较大变化后重新生成。
::: - **适用于 Quick Flow 与完整 BMad Method**:两种模式都可共享同一份项目上下文。
:::tip[根据需要更新]
当模式发生变化时手动编辑,或在重大架构更改后重新生成。
:::
:::tip[适用于所有项目类型]
对于快速流程和完整的 BMad Method 项目同样有用。
::: :::
## 后续步骤 ## 后续步骤
- [**项目上下文说明**](../explanation/project-context.md) — 了解其工作原理 - [**项目上下文说明**](../explanation/project-context.md) - 了解其工作原理
- [**工作流程图**](../reference/workflow-map.md) — 查看哪些工作流程加载项目上下文 - [**工作流程图**](../reference/workflow-map.md) - 查看哪些工作流会加载项目上下文
---
## 术语说明
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
- **workflow**:工作流程。指完成特定任务的一系列步骤或过程。
- **codebase**:代码库。指项目的所有源代码和资源的集合。
- **implementation**:实施。指将设计或架构转化为实际代码的过程。
- **architecture**:架构。指系统的整体结构和设计。
- **stack**:技术栈。指项目使用的技术组合,如编程语言、框架、工具等。
- **convention**:约定。指团队或项目中遵循的编码规范和最佳实践。
- **singleton**:单例。一种设计模式,确保类只有一个实例。
- **co-located**:同位置。指相关文件(如测试文件)与主文件放在同一目录中。
- **mocking**:模拟。在测试中用模拟对象替代真实对象的行为。
- **context**:上下文。指程序运行时的环境信息或背景信息。
- **LLM**大语言模型。Large Language Model 的缩写,指大型语言模型。

View File

@ -114,7 +114,7 @@ BMad-Help 将检测你已完成的内容,并准确推荐下一步该做什么
::: :::
:::note[如何加载智能体和运行工作流] :::note[如何加载智能体和运行工作流]
每个工作流都可以通过技能名直接调用(例如 `bmad-create-prd`)。你的 AI IDE 会识别 `bmad-*` 技能并执行,无需额外单独加载智能体。你也可以直接调用智能体技能进行通用对话(例如 PM 智能体用 `bmad-pm`)。 每个工作流都可以通过技能名直接调用(例如 `bmad-create-prd`)。你的 AI IDE 会识别 `bmad-*` 技能并执行,无需额外单独加载智能体。你也可以直接调用智能体技能进行通用对话(例如 PM 智能体用 `bmad-agent-pm`)。
::: :::
:::caution[新对话] :::caution[新对话]
@ -136,12 +136,12 @@ BMad-Help 将检测你已完成的内容,并准确推荐下一步该做什么
此阶段中的所有工作流都是可选的: 此阶段中的所有工作流都是可选的:
- **头脑风暴**`bmad-brainstorming` — 引导式构思 - **头脑风暴**`bmad-brainstorming` — 引导式构思
- **研究**`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research` — 市场、领域和技术研究 - **研究**`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research` — 市场、领域和技术研究
- **创建产品简报**`bmad-product-brief` — 推荐的基础文档 - **创建产品简报**`bmad-create-product-brief` — 推荐的基础文档
### 阶段 2规划必需 ### 阶段 2规划必需
**对于 BMad Method 和 Enterprise 路径:** **对于 BMad Method 和 Enterprise 路径:**
1. 在新对话中调用 **PM 智能体**`bmad-pm` 1. 在新对话中调用 **PM 智能体**`bmad-agent-pm`
2. 运行 `bmad-create-prd` 工作流(`bmad-create-prd` 2. 运行 `bmad-create-prd` 工作流(`bmad-create-prd`
3. 输出:`PRD.md` 3. 输出:`PRD.md`
@ -149,13 +149,13 @@ BMad-Help 将检测你已完成的内容,并准确推荐下一步该做什么
- 运行 `bmad-quick-dev` —— 它会在一个工作流里同时处理规划与实现,可直接进入实现阶段 - 运行 `bmad-quick-dev` —— 它会在一个工作流里同时处理规划与实现,可直接进入实现阶段
:::note[UX 设计(可选)] :::note[UX 设计(可选)]
如果你的项目有用户界面,在创建 PRD 后调用 **UX-Designer 智能体**`bmad-ux-designer`),然后运行 UX 设计工作流(`bmad-create-ux-design`)。 如果你的项目有用户界面,在创建 PRD 后调用 **UX-Designer 智能体**`bmad-agent-ux-designer`),然后运行 UX 设计工作流(`bmad-create-ux-design`)。
::: :::
### 阶段 3解决方案设计BMad Method/Enterprise ### 阶段 3解决方案设计BMad Method/Enterprise
**创建架构** **创建架构**
1. 在新对话中调用 **Architect 智能体**`bmad-architect` 1. 在新对话中调用 **Architect 智能体**`bmad-agent-architect`
2. 运行 `bmad-create-architecture``bmad-create-architecture` 2. 运行 `bmad-create-architecture``bmad-create-architecture`
3. 输出:包含技术决策的架构文档 3. 输出:包含技术决策的架构文档
@ -165,12 +165,12 @@ BMad-Help 将检测你已完成的内容,并准确推荐下一步该做什么
史诗和故事现在在架构*之后*创建。这会产生更高质量的故事因为架构决策数据库、API 模式、技术栈)直接影响工作应该如何分解。 史诗和故事现在在架构*之后*创建。这会产生更高质量的故事因为架构决策数据库、API 模式、技术栈)直接影响工作应该如何分解。
::: :::
1. 在新对话中调用 **PM 智能体**`bmad-pm` 1. 在新对话中调用 **PM 智能体**`bmad-agent-pm`
2. 运行 `bmad-create-epics-and-stories``bmad-create-epics-and-stories` 2. 运行 `bmad-create-epics-and-stories``bmad-create-epics-and-stories`
3. 工作流使用 PRD 和架构来创建技术信息丰富的故事 3. 工作流使用 PRD 和架构来创建技术信息丰富的故事
**实现就绪检查** *(强烈推荐)* **实现就绪检查** *(强烈推荐)*
1. 在新对话中调用 **Architect 智能体**`bmad-architect` 1. 在新对话中调用 **Architect 智能体**`bmad-agent-architect`
2. 运行 `bmad-check-implementation-readiness``bmad-check-implementation-readiness` 2. 运行 `bmad-check-implementation-readiness``bmad-check-implementation-readiness`
3. 验证所有规划文档之间的一致性 3. 验证所有规划文档之间的一致性
@ -180,7 +180,7 @@ BMad-Help 将检测你已完成的内容,并准确推荐下一步该做什么
### 初始化冲刺规划 ### 初始化冲刺规划
调用 **SM 智能体**`bmad-sm`)并运行 `bmad-sprint-planning``bmad-sprint-planning`)。这会创建 `sprint-status.yaml` 来跟踪所有史诗和故事。 调用 **SM 智能体**`bmad-agent-sm`)并运行 `bmad-sprint-planning``bmad-sprint-planning`)。这会创建 `sprint-status.yaml` 来跟踪所有史诗和故事。
### 构建周期 ### 构建周期
@ -192,7 +192,7 @@ BMad-Help 将检测你已完成的内容,并准确推荐下一步该做什么
| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | 实现故事 | | 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | 实现故事 |
| 3 | DEV | `bmad-code-review` | `bmad-code-review` | 质量验证 *(推荐)* | | 3 | DEV | `bmad-code-review` | `bmad-code-review` | 质量验证 *(推荐)* |
完成史诗中的所有故事后,调用 **SM 智能体**`bmad-sm`)并运行 `bmad-retrospective``bmad-retrospective`)。 完成史诗中的所有故事后,调用 **SM 智能体**`bmad-agent-sm`)并运行 `bmad-retrospective``bmad-retrospective`)。
## 你已完成的工作 ## 你已完成的工作
@ -243,7 +243,7 @@ your-project/
可以。SM 智能体提供 `bmad-correct-course` 工作流(`bmad-correct-course`)来处理范围变化。 可以。SM 智能体提供 `bmad-correct-course` 工作流(`bmad-correct-course`)来处理范围变化。
**如果我想先进行头脑风暴怎么办?** **如果我想先进行头脑风暴怎么办?**
在开始 PRD 之前,调用 Analyst 智能体(`bmad-analyst`)并运行 `bmad-brainstorming``bmad-brainstorming`)。 在开始 PRD 之前,调用 Analyst 智能体(`bmad-agent-analyst`)并运行 `bmad-brainstorming``bmad-brainstorming`)。
**我需要遵循严格的顺序吗?** **我需要遵循严格的顺序吗?**
不一定。一旦你了解了流程,你可以使用上面的快速参考直接运行工作流。 不一定。一旦你了解了流程,你可以使用上面的快速参考直接运行工作流。