Skip to content

Commit ad2eb0e

Browse files
lrliangleon
andauthored
docs(zh-cn): refine install and non-interactive guides (#2094)
* docs(zh-cn): refine install and non-interactive guides 我统一中文安装文档中的术语和参数说明,补齐预发布安装与 skills 启用提示, 并保持交互式与非交互式安装路径和英文源文一致,减少安装场景下的理解偏差。 Feishu: https://www.feishu.cn/ Made-with: Cursor * docs(zh-cn): align install guide review wording 我在安装指南中补充目录结构示例说明,明确工具相关目录会随所选平台变化,避免读者误以为 .claude/.cursor 一定同时存在。 我同时统一非交互式安装文档里残留的“标志”表述为“参数”,让术语在全文保持一致并降低理解成本。 Feishu: <https://www.feishu.cn/> Made-with: Cursor --------- Co-authored-by: leon <leon.liang@hairobotics.com>
1 parent 7e97b7e commit ad2eb0e

2 files changed

Lines changed: 46 additions & 40 deletions

File tree

docs/zh-cn/how-to/install-bmad.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar:
55
order: 1
66
---
77

8-
使用 `npx bmad-method install` 命令在项目中设置 BMad,并选择你需要的模块和 AI 工具。
8+
使用 `npx bmad-method install` 在项目中安装 BMad,并按需选择模块和 AI 工具。
99

10-
如果你想使用非交互式安装程序并在命令行中提供所有安装选项,请参阅[本指南](./non-interactive-installation.md)
10+
如果你需要在命令行里一次性传入全部安装参数(例如 CI/CD 场景),请阅读[非交互式安装指南](./non-interactive-installation.md)
1111

1212
## 何时使用
1313

@@ -29,7 +29,16 @@ sidebar:
2929
npx bmad-method install
3030
```
3131

32-
:::tip[最新版本]
32+
:::tip[想要最新预发布版本?]
33+
使用 `next` 发布标签:
34+
```bash
35+
npx bmad-method@next install
36+
```
37+
38+
这会更早拿到新改动,但相比默认安装通道,出现变动的概率也更高。
39+
:::
40+
41+
:::tip[前沿版本]
3342
要从主分支安装最新版本(可能不稳定):
3443
```bash
3544
npx github:bmad-code-org/BMAD-METHOD install
@@ -51,7 +60,11 @@ npx github:bmad-code-org/BMAD-METHOD install
5160
- Cursor
5261
- 其他
5362

54-
每个工具都有自己的命令集成方式。安装程序会创建微小的提示文件来激活工作流和智能体——它只是将它们放在工具期望找到的位置。
63+
每种工具都有自己的 skills 集成方式。安装程序会生成用于激活工作流和智能体的轻量提示文件,并放到该工具约定的位置。
64+
65+
:::note[启用 Skills]
66+
某些平台需要你在设置中手动启用 skills 才会显示。如果你已经安装 BMad 但看不到 skills,请检查平台设置,或直接询问你的 AI 助手如何启用 skills。
67+
:::
5568

5669
### 4. 选择模块
5770

@@ -63,16 +76,25 @@ npx github:bmad-code-org/BMAD-METHOD install
6376

6477
## 你将获得
6578

79+
以下目录结构仅作示例。工具相关目录会随你选择的平台变化(例如可能是
80+
`.claude/skills``.cursor/skills``.kiro/skills`),并不一定会同时出现。
81+
6682
```text
6783
your-project/
6884
├── _bmad/
6985
│ ├── bmm/ # 你选择的模块
70-
│ │ └── config.yaml # 模块设置(如果你需要更改它们
71-
│ ├── core/ # 必需的核心模块
86+
│ │ └── config.yaml # 模块设置(后续如需可修改
87+
│ ├── core/ # 必需核心模块
7288
│ └── ...
73-
├── _bmad-output/ # 生成的工件
74-
├── .claude/ # Claude Code 命令(如果使用 Claude Code)
75-
└── .kiro/ # Kiro 引导文件(如果使用 Kiro)
89+
├── _bmad-output/ # 生成产物
90+
├── .claude/ # Claude Code skills(如使用 Claude Code)
91+
│ └── skills/
92+
│ ├── bmad-help/
93+
│ ├── bmad-persona/
94+
│ └── ...
95+
└── .cursor/ # Cursor skills(如使用 Cursor)
96+
└── skills/
97+
└── ...
7698
```
7799

78100
## 验证安装
@@ -96,10 +118,3 @@ bmad-help 对于 SaaS 项目我有哪些选项?
96118

97119
**安装程序工作正常但后续出现问题**——你的 AI 需要 BMad 上下文才能提供帮助。请参阅[如何获取关于 BMad 的答案](./get-answers-about-bmad.md)了解如何将你的 AI 指向正确的来源。
98120

99-
---
100-
## 术语说明
101-
102-
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
103-
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
104-
- **module**:模块。指软件系统中可独立开发、测试和维护的功能单元。
105-
- **artifact**:工件。指在软件开发过程中生成的任何输出,如文档、代码、配置文件等。

docs/zh-cn/how-to/non-interactive-installation.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: "非交互式安装"
3-
description: 使用命令行标志安装 BMad,适用于 CI/CD 流水线和自动化部署
3+
description: 使用命令行参数安装 BMad,适用于 CI/CD 流水线和自动化部署
44
sidebar:
55
order: 2
66
---
77

8-
使用命令行标志以非交互方式安装 BMad。这适用于
8+
使用命令行参数(flags)以非交互方式安装 BMad。适用于以下场景
99

1010
## 使用场景
1111

@@ -18,11 +18,11 @@ sidebar:
1818
需要 [Node.js](https://nodejs.org) v20+ 和 `npx`(随 npm 附带)。
1919
:::
2020

21-
## 可用标志
21+
## 可用参数(Flags)
2222

2323
### 安装选项
2424

25-
| 标志 | 描述 | 示例 |
25+
| 参数 | 描述 | 示例 |
2626
|------|-------------|---------|
2727
| `--directory <path>` | 安装目录 | `--directory ~/projects/myapp` |
2828
| `--modules <modules>` | 逗号分隔的模块 ID | `--modules bmm,bmb` |
@@ -32,7 +32,7 @@ sidebar:
3232

3333
### 核心配置
3434

35-
| 标志 | 描述 | 默认值 |
35+
| 参数 | 描述 | 默认值 |
3636
|------|-------------|---------|
3737
| `--user-name <name>` | 智能体使用的名称 | 系统用户名 |
3838
| `--communication-language <lang>` | 智能体通信语言 | 英语 |
@@ -41,14 +41,14 @@ sidebar:
4141

4242
### 其他选项
4343

44-
| 标志 | 描述 |
44+
| 参数 | 描述 |
4545
|------|-------------|
4646
| `-y, --yes` | 接受所有默认值并跳过提示 |
4747
| `-d, --debug` | 启用清单生成的调试输出 |
4848

4949
## 模块 ID
5050

51-
`--modules` 标志可用的模块 ID:
51+
`--modules` 参数可用的模块 ID:
5252

5353
- `bmm` — BMad Method Master
5454
- `bmb` — BMad Builder
@@ -57,7 +57,7 @@ sidebar:
5757

5858
## 工具/IDE ID
5959

60-
`--tools` 标志可用的工具 ID:
60+
`--tools` 参数可用的工具 ID:
6161

6262
**推荐:** `claude-code``cursor`
6363

@@ -67,8 +67,8 @@ sidebar:
6767

6868
| 模式 | 描述 | 示例 |
6969
|------|-------------|---------|
70-
| 完全非交互式 | 提供所有标志以跳过所有提示 | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` |
71-
| 半交互式 | 提供部分标志;BMad 提示其余部分 | `npx bmad-method install --directory . --modules bmm` |
70+
| 完全非交互式 | 提供所有参数以跳过所有提示 | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` |
71+
| 半交互式 | 提供部分参数;BMad 提示其余部分 | `npx bmad-method install --directory . --modules bmm` |
7272
| 仅使用默认值 | 使用 `-y` 接受所有默认值 | `npx bmad-method install --yes` |
7373
| 不包含工具 | 跳过工具/IDE 配置 | `npx bmad-method install --modules bmm --tools none` |
7474

@@ -124,9 +124,9 @@ npx bmad-method install \
124124
- 为所选模块和工具配置的智能体和工作流
125125
- 用于生成产物的 `_bmad-output/` 文件夹
126126

127-
## 验证和错误处理
127+
## 参数校验与错误处理
128128

129-
BMad 会验证所有提供的标志
129+
BMad 会验证你提供的所有参数
130130

131131
- **目录** — 必须是具有写入权限的有效路径
132132
- **模块** — 对无效的模块 ID 发出警告(但不会失败)
@@ -141,14 +141,14 @@ BMad 会验证所有提供的标志:
141141

142142
:::tip[最佳实践]
143143
-`--directory` 使用绝对路径以避免歧义
144-
- 在 CI/CD 流水线中使用前先在本地测试标志
144+
- 在 CI/CD 流水线中使用前先在本地测试参数
145145
- 结合 `-y` 实现真正的无人值守安装
146146
- 如果在安装过程中遇到问题,使用 `--debug`
147147
:::
148148

149149
## 故障排除
150150

151-
### 安装失败,提示"Invalid directory"
151+
### 安装失败,提示 `Invalid directory`
152152

153153
- 目录路径必须存在(或其父目录必须存在)
154154
- 您需要写入权限
@@ -167,15 +167,6 @@ BMad 会验证所有提供的标志:
167167
-`module.yaml` 中有 `code` 字段
168168

169169
:::note[仍然卡住了?]
170-
使用 `--debug` 运行以获取详细输出,尝试交互模式以隔离问题,或在 <https://github.com/bmad-code-org/BMAD-METHOD/issues> 报告
170+
使用 `--debug` 获取详细输出,尝试交互模式定位问题,或在 <https://github.com/bmad-code-org/BMAD-METHOD/issues> 提交反馈
171171
:::
172172

173-
---
174-
## 术语说明
175-
176-
- **CI/CD**:持续集成/持续部署。一种自动化软件开发流程的实践,用于频繁集成代码更改并自动部署到生产环境。
177-
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
178-
- **module**:模块。软件系统中可独立开发、测试和维护的功能单元。
179-
- **IDE**:集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。
180-
- **npx**:Node Package eXecute。npm 包执行器,用于直接执行 npm 包而无需全局安装。
181-
- **workflow**:工作流。一系列有序的任务或步骤,用于完成特定的业务流程或开发流程。

0 commit comments

Comments
 (0)