Skip to content

Commit 76fb7e0

Browse files
lrliangleonalexeyv
authored
docs(zh-cn): refine established project guides (#2096)
* docs(zh-cn): refine established project guides clarify the boundary between new-project and established-project usage so zh-cn readers can choose the right workflow path. align project context terminology and command references with current conventions while keeping guidance concise and executable. Feishu: https://www.feishu.cn/ Made-with: Cursor * docs(zh-cn): fix project-context syntax and wording 我将 project-context 文档中的提示块语法统一回项目规范的 `:::...:::` 形式,避免与文档风格约定不一致。 我同时把“在不同用户故事(story)间决策不一致”调整为“之间决策不一致”,提升中文表达的自然度与可读性。 Feishu: <https://www.feishu.cn/> Made-with: Cursor --------- Co-authored-by: leon <leon.liang@hairobotics.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
1 parent ad2eb0e commit 76fb7e0

2 files changed

Lines changed: 82 additions & 118 deletions

File tree

docs/zh-cn/how-to/established-projects.md

Lines changed: 32 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar:
55
order: 6
66
---
77

8-
在现有项目和遗留代码库上工作时,有效使用 BMad Method。
8+
当你在现有项目或遗留代码库上工作时,本指南帮助你更稳妥地使用 BMad Method。
99

10-
本指南涵盖了使用 BMad Method 接入现有项目的核心工作流程
10+
如果你是从零开始的新项目,建议先看[快速入门](../tutorials/getting-started.md);本文主要面向既有项目接入场景
1111

1212
:::note[前置条件]
1313
- 已安装 BMad Method(`npx bmad-method install`
@@ -23,26 +23,27 @@ sidebar:
2323
- `_bmad-output/planning-artifacts/`
2424
- `_bmad-output/implementation-artifacts/`
2525

26-
## 步骤 2:创建项目上下文
26+
## 步骤 2:创建项目上下文(project context)
2727

2828
:::tip[推荐用于既有项目]
29-
生成 `project-context.md` 以捕获你现有代码库的模式和约定。这确保 AI 智能体在实施变更时遵循你既定的实践
29+
生成 `project-context.md`,梳理现有代码库的模式与约定,确保 AI 智能体在实施变更时遵循你既有的工程实践
3030
:::
3131

32-
运行生成项目上下文工作流程
32+
运行生成项目上下文工作流
3333

3434
```bash
35-
/bmad-bmm-generate-project-context
35+
bmad-generate-project-context
3636
```
3737

3838
这将扫描你的代码库以识别:
3939
- 技术栈和版本
4040
- 代码组织模式
4141
- 命名约定
4242
- 测试方法
43-
- 框架特定模式
43+
- 框架相关模式
4444

45-
你可以查看和完善生成的文件,或者如果你更喜欢,可以在 `_bmad-output/project-context.md` 手动创建它。
45+
你可以先审阅并完善生成内容;如果更希望手动维护,也可以直接在
46+
`_bmad-output/project-context.md` 创建并编辑。
4647

4748
[了解更多关于项目上下文](../explanation/project-context.md)
4849

@@ -55,80 +56,63 @@ sidebar:
5556
- 架构
5657
- 任何其他相关的项目信息
5758

58-
对于复杂项目,考虑使用 `document-project` 工作流程。它提供运行时变体,将扫描你的整个项目并记录其实际当前状态
59+
对于复杂项目,可考虑使用 `bmad-document-project` 工作流。它会扫描整个项目并记录当前真实状态
5960

60-
## 步骤 3:获取帮助
61+
## 步骤 4:获取帮助
6162

62-
### BMad-Help:你的起点
63+
### BMad-Help:默认起点
6364

64-
**随时运行 `bmad-help`,当你不确定下一步该做什么时** 这个智能指南
65+
**当你不确定下一步做什么时,随时运行 `bmad-help`** 这个智能指南会
6566

66-
- 检查你的项目以查看已经完成了什么
67-
- 根据你安装的模块显示选项
67+
- 检查项目当前状态,识别哪些工作已经完成
68+
- 根据你安装的模块给出可行选项
6869
- 理解自然语言查询
6970

7071
```
7172
bmad-help 我有一个现有的 Rails 应用,我应该从哪里开始?
72-
bmad-help quick-flow 和完整方法有什么区别?
73-
bmad-help 显示我有哪些可用的工作流程
73+
bmad-help Quick Flow 和完整方法有什么区别?
74+
bmad-help 显示我当前有哪些可用工作流
7475
```
7576

76-
BMad-Help 还会在**每个工作流程结束时自动运行**提供关于下一步该做什么的清晰指导
77+
BMad-Help 还会在**每个工作流结束时自动运行**明确告诉你下一步该做什么
7778

7879
### 选择你的方法
7980

8081
根据变更范围,你有两个主要选项:
8182

82-
| 范围 | 推荐方法 |
83-
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
84-
| **小型更新或添加** | 运行 `bmad-quick-dev` 在单个工作流中澄清意图、规划、实现和审查。完整的四阶段 BMad Method 可能有些过度|
85-
| **重大变更或添加** | BMad Method 开始,根据需要应用或多或少的严谨性。 |
83+
| 范围 | 推荐方法 |
84+
| --- | --- |
85+
| **小型更新或新增** | 运行 `bmad-quick-dev`,在单个工作流中完成意图澄清、规划、实现与审查。完整四阶段 BMad Method 往往过重|
86+
| **重大变更或新增** | 从完整 BMad Method 开始,再按项目风险和协作需求调整流程严谨度。 |
8687

8788
### 在创建 PRD 期间
8889

8990
在创建简报或直接进入 PRD 时,确保智能体:
9091

9192
- 查找并分析你现有的项目文档
92-
- 阅读关于你当前系统的适当上下文
93+
- 读取与你当前系统匹配的项目上下文(project context)
9394

94-
你可以明确地指导智能体,但目标是确保新功能与你的现有系统良好集成
95+
你可以显式补充指令,但核心目标是让新功能与现有 architecture 和代码约束自然融合
9596

9697
### UX 考量
9798

98-
UX 工作是可选的。决定不取决于你的项目是否有 UX,而取决于:
99+
UX 工作是可选项。是否需要进入 UX 流程,不取决于“项目里有没有 UX”,而取决于:
99100

100-
- 你是否将处理 UX 变更
101-
- 是否需要重要的新 UX 设计或模式
101+
- 你是否真的在做 UX 层面的变更
102+
- 是否需要新增重要的 UX 设计或交互模式
102103

103-
如果你的变更只是对你满意的现有屏幕进行简单更新,则不需要完整的 UX 流程。
104+
如果本次只是对现有页面做小幅调整,通常不需要完整 UX 流程。
104105

105-
### 架构考量
106+
### 架构考量(architecture)
106107

107108
在进行架构工作时,确保架构师:
108109

109-
- 使用适当的已记录文件
110-
- 扫描现有代码库
110+
- 使用正确且最新的文档输入
111+
- 扫描并理解现有代码库
111112

112-
在此处要密切注意,以防止重新发明轮子或做出与你现有架构不一致的决定
113+
这一点非常关键:可避免“重复造轮子”,也能减少与现有架构冲突的设计决策
113114

114115
## 更多信息
115116

116117
- **[快速修复](./quick-fixes.md)** - 错误修复和临时变更
117118
- **[既有项目 FAQ](../explanation/established-projects-faq.md)** - 关于在既有项目上工作的常见问题
118-
119-
---
120-
## 术语说明
121-
122-
- **BMad Method**:BMad 方法。一种结构化的软件开发方法论,用于指导从分析到实施的完整流程。
123-
- **PRD**:产品需求文档(Product Requirements Document)。描述产品功能、需求和目标的文档。
124-
- **epic**:史诗。大型功能或用户故事的集合,通常需要较长时间完成。
125-
- **story**:用户故事。描述用户需求的简短陈述,通常遵循"作为...我想要...以便于..."的格式。
126-
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
127-
- **IDE**:集成开发环境(Integrated Development Environment)。提供代码编辑、调试、构建等功能的软件工具。
128-
- **UX**:用户体验(User Experience)。用户在使用产品或服务过程中的整体感受和交互体验。
129-
- **tech-spec**:技术规范(Technical Specification)。描述技术实现细节、架构设计和开发标准的文档。
130-
- **quick-flow**:快速流程。BMad Method 中的一种简化工作流程,适用于小型变更或快速迭代。
131-
- **legacy codebase**:遗留代码库。指历史遗留的、可能缺乏文档或使用过时技术的代码集合。
132-
- **project context**:项目上下文。描述项目技术栈、约定、模式等背景信息的文档。
133-
- **artifact**:产物。在开发过程中生成的文档、代码或其他输出物。
134-
- **runtime variant**:运行时变体。在程序运行时可选择或切换的不同实现方式或配置。

docs/zh-cn/how-to/project-context.md

Lines changed: 50 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,30 @@ sidebar:
55
order: 8
66
---
77

8-
使用 `project-context.md` 文件确保 AI 智能体在所有工作流程中遵循项目的技术偏好和实现规则。
8+
使用 `project-context.md`,确保 AI 智能体在各类工作流中遵循项目的技术偏好与实现规则。
9+
为了保证这份上下文始终可见,你也可以在工具上下文或 always-rules 文件(如 `AGENTS.md`
10+
中加入这句:
11+
`Important project context and conventions are located in [path to project context]/project-context.md`
912

1013
:::note[前置条件]
1114
- 已安装 BMad Method
12-
- 了解项目的技术栈和约定
15+
- 了解项目的技术栈与团队约定
1316
:::
1417

1518
## 何时使用
1619

17-
- 在开始架构设计之前有明确的技术偏好
18-
- 已完成架构设计并希望为实施捕获决策
19-
- 正在处理具有既定模式的现有代码库
20-
- 注意到智能体在不同用户故事中做出不一致的决策
20+
- 在开始架构(architecture)前,你已有明确的技术偏好
21+
- 已完成架构设计,希望把关键决策沉淀到实施阶段
22+
- 正在处理具有既定模式的既有代码库
23+
- 发现智能体在不同用户故事(story)之间决策不一致
2124

22-
## 步骤 1:选择方法
25+
## 步骤 1:选择路径
2326

24-
**手动创建**当您确切知道要记录哪些规则时最佳
27+
**手动创建**适合你已经明确知道要沉淀哪些规则
2528

26-
**架构后生成**最适合捕获解决方案制定过程中所做的决策
29+
**架构后生成**适合把 solutioning 阶段形成的架构决策沉淀下来
2730

28-
**为现有项目生成**最适合在现有代码库中发现模式
31+
**为既有项目生成**适合从现有代码库中自动发现团队约定与模式
2932

3033
## 步骤 2:创建文件
3134

@@ -38,17 +41,17 @@ mkdir -p _bmad-output
3841
touch _bmad-output/project-context.md
3942
```
4043

41-
添加技术栈和实现规则
44+
然后补充技术栈与实现规则
4245

4346
```markdown
4447
---
45-
project_name: 'MyProject'
46-
user_name: 'YourName'
48+
project_name: '我的项目'
49+
user_name: '你的名字'
4750
date: '2026-02-15'
4851
sections_completed: ['technology_stack', 'critical_rules']
4952
---
5053

51-
# AI 智能体的项目上下文
54+
# AI 智能体项目上下文
5255

5356
## 技术栈与版本
5457

@@ -60,93 +63,70 @@ sections_completed: ['technology_stack', 'critical_rules']
6063
## 关键实现规则
6164

6265
**TypeScript:**
63-
- 启用严格模式,不使用 `any` 类型
64-
- 公共 API 使用 `interface`,联合类型使用 `type`
66+
- 开启严格模式,禁止使用 `any` 类型
67+
- 对外 API 使用 `interface`,联合类型使用 `type`
6568

6669
**代码组织:**
67-
- 组件位于 `/src/components/` 并附带同位置测试
68-
- API 调用使用 `apiClient` 单例 — 绝不直接使用 fetch
70+
- 组件放在 `/src/components/`,并与测试文件同目录(co-located)
71+
- API 调用统一使用 `apiClient` 单例,不要直接使用 `fetch`
6972

7073
**测试:**
71-
- 单元测试专注于业务逻辑
72-
- 集成测试使用 MSW 进行 API 模拟
74+
- 单元测试聚焦业务逻辑
75+
- 集成测试使用 MSW 模拟 API
7376
```
7477

7578
### 选项 B:架构后生成
7679

77-
在新的聊天中运行工作流程
80+
在新的会话中运行
7881

7982
```bash
80-
/bmad-bmm-generate-project-context
83+
bmad-generate-project-context
8184
```
8285

83-
工作流程扫描架构文档和项目文件,生成捕获所做决策的上下文文件
86+
该工作流会扫描架构文档和项目文件,生成能够反映已做决策的上下文文件
8487

85-
### 选项 C:为现有项目生成
88+
### 选项 C:为既有项目生成
8689

87-
对于现有项目,运行:
90+
对于既有项目,运行:
8891

8992
```bash
90-
/bmad-bmm-generate-project-context
93+
bmad-generate-project-context
9194
```
9295

93-
工作流程分析代码库以识别约定,然后生成上下文文件供您审查和完善
96+
该工作流会分析代码库中的约定,然后生成可供你审阅和完善的上下文文件
9497

9598
## 步骤 3:验证内容
9699

97-
审查生成的文件并确保它捕获了
100+
审查生成文件,并确认它覆盖了
98101

99102
- 正确的技术版本
100-
- 实际约定(而非通用最佳实践
101-
- 防止常见错误的规则
102-
- 框架特定的模式
103+
- 你的真实约定(不是通用最佳实践
104+
- 能预防常见错误的规则
105+
- 框架相关模式
103106

104-
手动编辑以添加任何缺失内容或删除不准确之处
107+
如果有缺漏或误判,直接手动补充和修正
105108

106-
## 您将获得
109+
## 你将获得
107110

108-
一个 `project-context.md` 文件,
111+
一个 `project-context.md` 文件,它可以
109112

110-
- 确保所有智能体遵循相同的约定
111-
- 防止在不同用户故事中做出不一致的决策
112-
- 为实施捕获架构决策
113-
- 作为项目模式和规则的参考
113+
- 确保所有智能体遵循相同约定
114+
- 避免在不同用户故事(story)中出现不一致决策
115+
- 为实施阶段保留架构决策
116+
- 作为项目模式与规则的长期参考
114117

115118
## 提示
116119

117-
:::tip[关注非显而易见的内容]
118-
记录智能体可能遗漏的模式,例如"在每个公共类、函数和变量上使用 JSDoc 风格注释",而不是像"使用有意义的变量名"这样的通用实践,因为 LLM 目前已经知道这些。
119-
:::
120-
121-
:::tip[保持精简]
122-
此文件由每个实施工作流程加载。长文件会浪费上下文。不要包含仅适用于狭窄范围或特定用户故事或功能的内容。
123-
:::
124-
125-
:::tip[根据需要更新]
126-
当模式发生变化时手动编辑,或在重大架构更改后重新生成。
127-
:::
128-
129-
:::tip[适用于所有项目类型]
130-
对于快速流程和完整的 BMad Method 项目同样有用。
120+
:::tip[最佳实践]
121+
- **聚焦“不明显但重要”的规则**:优先记录智能体容易漏掉的项目约束,而不是
122+
“变量要有意义”这类通用建议。
123+
- **保持精简**:此文件会被多数实现工作流加载,过长会浪费上下文窗口。避免写入
124+
只适用于单一 story 的细节。
125+
- **按需更新**:当团队约定变化时手动更新,或在架构发生较大变化后重新生成。
126+
- **适用于 Quick Flow 与完整 BMad Method**:两种模式都可共享同一份项目上下文。
131127
:::
132128

133129
## 后续步骤
134130

135-
- [**项目上下文说明**](../explanation/project-context.md) — 了解其工作原理
136-
- [**工作流程图**](../reference/workflow-map.md) — 查看哪些工作流程加载项目上下文
137-
138-
---
139-
## 术语说明
140-
141-
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
142-
- **workflow**:工作流程。指完成特定任务的一系列步骤或过程。
143-
- **codebase**:代码库。指项目的所有源代码和资源的集合。
144-
- **implementation**:实施。指将设计或架构转化为实际代码的过程。
145-
- **architecture**:架构。指系统的整体结构和设计。
146-
- **stack**:技术栈。指项目使用的技术组合,如编程语言、框架、工具等。
147-
- **convention**:约定。指团队或项目中遵循的编码规范和最佳实践。
148-
- **singleton**:单例。一种设计模式,确保类只有一个实例。
149-
- **co-located**:同位置。指相关文件(如测试文件)与主文件放在同一目录中。
150-
- **mocking**:模拟。在测试中用模拟对象替代真实对象的行为。
151-
- **context**:上下文。指程序运行时的环境信息或背景信息。
152-
- **LLM**:大语言模型。Large Language Model 的缩写,指大型语言模型。
131+
- [**项目上下文说明**](../explanation/project-context.md) - 了解其工作原理
132+
- [**工作流程图**](../reference/workflow-map.md) - 查看哪些工作流会加载项目上下文

0 commit comments

Comments
 (0)