From eb72361720d81408947fccc53a6169de6f7bb365 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A2=81=E5=B1=B1=E6=B2=B3?= <392425595@qq.com> Date: Mon, 23 Mar 2026 00:06:58 +0800 Subject: [PATCH] docs(zh-cn): refine help and quick-fixes guides (#2095) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(zh-cn): refine help and quick-fixes guides improve zh-cn troubleshooting guidance so users can quickly choose the right support path and self-recover from common issues. align bmad-help and quick-dev usage wording with current invocation conventions and remove glossary-style appendices to keep the pages action-oriented. Feishu: N/A Made-with: Cursor * docs(zh-cn): fix tip admonition fence syntax 我把 get-answers-about-bmad 文档中的 `::::tip` 语法改为仓库统一使用的 `:::tip`。 此前四冒号写法与项目文档约定不一致，可能导致提示块渲染异常；现在与现有 Starlight 写法保持一致。 Feishu: Made-with: Cursor --------- Co-authored-by: leon --- docs/zh-cn/how-to/get-answers-about-bmad.md | 125 +++++++++----------- docs/zh-cn/how-to/quick-fixes.md | 40 +++---- 2 files changed, 72 insertions(+), 93 deletions(-) diff --git a/docs/zh-cn/how-to/get-answers-about-bmad.md b/docs/zh-cn/how-to/get-answers-about-bmad.md index ec327aef0..8d4ed0907 100644 --- a/docs/zh-cn/how-to/get-answers-about-bmad.md +++ b/docs/zh-cn/how-to/get-answers-about-bmad.md @@ -5,108 +5,109 @@ sidebar: order: 4 --- -## 从这里开始：BMad-Help +## 先从 BMad-Help 开始 -**获取关于 BMad 答案的最快方式是 `bmad-help`。** 这个智能指南可以回答超过 80% 的问题，并且直接在您的 IDE 中可用，方便您工作时使用。 +**获取 BMad 相关答案最快的方式是 `bmad-help` 技能。** 这个智能向导可以覆盖 80% 以上的常见问题，并且你在 IDE 里随时可用。 -BMad-Help 不仅仅是一个查询工具——它： -- **检查您的项目**以查看已完成的内容 -- **理解自然语言**——用简单的英语提问 -- **根据您安装的模块变化**——显示相关选项 -- **在工作流后自动运行**——告诉您接下来该做什么 -- **推荐第一个必需任务**——无需猜测从哪里开始 +BMad-Help 不只是查表工具，它还能： +- **检查你的项目状态**，判断哪些步骤已经完成 +- **理解自然语言问题**，直接按日常表达提问即可 +- **根据已安装模块给出选项**，只展示与你当前场景相关的内容 +- **在工作流结束后自动运行**，明确告诉你下一步做什么 +- **指出第一个必做任务**，避免猜流程起点 ### 如何使用 BMad-Help -只需使用斜杠命令运行它： +在 AI 会话里直接输入： ``` bmad-help ``` -或者结合自然语言查询： +:::tip +按平台不同，你也可以使用 `/bmad-help` 或 `$bmad-help`。但大多数情况下直接输入 `bmad-help` 就能工作。 +::: + +也可以结合自然语言问题一起调用： ``` -bmad-help 我有一个 SaaS 想法并且知道所有功能。我应该从哪里开始？ -bmad-help 我在 UX 设计方面有哪些选择？ -bmad-help 我在 PRD 工作流上卡住了 -bmad-help 向我展示到目前为止已完成的内容 +bmad-help 我有一个 SaaS 想法并且已经知道主要功能，我该从哪里开始？ +bmad-help 我在 UX 设计方面有哪些选项？ +bmad-help 我卡在 PRD 工作流了 +bmad-help 帮我看看目前完成了什么 ``` -BMad-Help 会回应： -- 针对您情况的建议 -- 第一个必需任务是什么 -- 流程的其余部分是什么样的 +BMad-Help 通常会返回： +- 针对你当前情况的建议路径 +- 第一个必做任务 +- 后续整体流程概览 ---- +## 何时使用这篇指南 -## 何时使用本指南 - -在以下情况下使用本节： -- 您想了解 BMad 的架构或内部机制 -- 您需要 BMad-Help 提供范围之外的答案 -- 您在安装前研究 BMad -- 您想直接探索源代码 +当你遇到以下情况时，可用本指南补充： +- 想理解 BMad 的架构设计或内部机制 +- 需要超出 BMad-Help 覆盖范围的答案 +- 在安装前做技术调研 +- 想直接基于源码进行追问 ## 步骤 -### 1. 选择您的来源 +### 1. 选择信息来源 -| 来源 | 最适合用于 | 示例 | -| -------------------- | ----------------------------------------- | ---------------------------- | -| **`_bmad` 文件夹** | BMad 如何工作——智能体、工作流、提示词 | "PM 智能体做什么？" | -| **完整的 GitHub 仓库** | 历史、安装程序、架构 | "v6 中有什么变化？" | -| **`llms-full.txt`** | 来自文档的快速概述 | "解释 BMad 的四个阶段" | +| 来源 | 适合回答的问题 | 示例 | +| --- | --- | --- | +| **`_bmad` 文件夹** | 智能体、工作流、提示词如何工作 | “PM 智能体具体做什么？” | +| **完整 GitHub 仓库** | 版本历史、安装器、整体架构 | “v6 主要改了什么？” | +| **`llms-full.txt`** | 文档层面的快速全景理解 | “解释 BMad 的四个阶段” | -`_bmad` 文件夹在您安装 BMad 时创建。如果您还没有它，请改为克隆仓库。 +安装 BMad 后会生成 `_bmad` 文件夹；如果你还没有安装，可先克隆仓库。 -### 2. 将您的 AI 指向来源 +### 2. 让 AI 读取来源 -**如果您的 AI 可以读取文件（Claude Code、Cursor 等）：** +**如果你的 AI 可以直接读文件（如 Claude Code、Cursor）：** -- **已安装 BMad：** 指向 `_bmad` 文件夹并直接提问 -- **想要更深入的上下文：** 克隆[完整仓库](https://github.com/bmad-code-org/BMAD-METHOD) +- **已安装 BMad：** 直接让它读取 `_bmad` 并提问 +- **想看更深上下文：** 克隆[完整仓库](https://github.com/bmad-code-org/BMAD-METHOD) -**如果您使用 ChatGPT 或 Claude.ai：** +**如果你使用 ChatGPT 或 Claude.ai：** -将 `llms-full.txt` 获取到您的会话中： +把 `llms-full.txt` 加入会话上下文： ```text https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt ``` -### 3. 提出您的问题 +### 3. 直接提问 :::note[示例] -**问：** "告诉我用 BMad 构建某物的最快方式" +**问：** “用 BMad 做一个需求到实现的最短路径是什么？” -**答：** 使用快速流程：运行 `bmad-quick-dev` — 它在单个工作流中澄清意图、规划、实现、审查和呈现结果，跳过完整的规划阶段。 +**答：** 使用 Quick Flow，运行 `bmad-quick-dev`。它会在一个工作流里完成意图澄清、计划、实现、审查与结果呈现，跳过完整规划阶段。 ::: -## 您将获得什么 +## 你将获得什么 -关于 BMad 的直接答案——智能体如何工作、工作流做什么、为什么事物以这种方式构建——无需等待其他人回应。 +你可以快速拿到直接、可执行的答案：智能体怎么工作、工作流做什么、为什么这样设计，而不需要等待外部回复。 ## 提示 -- **验证令人惊讶的答案**——LLM 偶尔会出错。检查源文件或在 Discord 上询问。 -- **具体化**——"PRD 工作流的第 3 步做什么？"比"PRD 如何工作？"更好 +- **对“意外答案”做二次核验**：LLM 偶尔会答偏，建议回看源码或到 Discord 确认 +- **问题越具体越好**：例如“PRD 工作流第 3 步在做什么？”比“PRD 怎么用？”更高效 -## 仍然卡住了？ +## 仍然卡住？ -尝试了 LLM 方法但仍需要帮助？您现在有一个更好的问题可以问。 +如果你已经试过 LLM 方案但还需要协助，现在你通常已经能提出一个更清晰的问题。 -| 频道 | 用于 | -| ------------------------- | ------------------------------------------- | -| `#bmad-method-help` | 快速问题（实时聊天） | -| `help-requests` 论坛 | 详细问题（可搜索、持久） | -| `#suggestions-feedback` | 想法和功能请求 | -| `#report-bugs-and-issues` | 错误报告 | +| 频道 | 适用场景 | +| --- | --- | +| `#bmad-method-help` | 快速问题（实时聊天） | +| `help-requests` forum | 复杂问题（可检索、可沉淀） | +| `#suggestions-feedback` | 建议与功能诉求 | +| `#report-bugs-and-issues` | Bug 报告 | -**Discord：** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) - -**GitHub Issues：** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)（用于明确的错误） +**Discord：** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) +**GitHub Issues：** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)（用于可复现问题） *你！* *卡住* @@ -132,13 +133,3 @@ https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt *今天？* *—Claude* - ---- -## 术语说明 - -- **agent**：智能体。在人工智能与编程文档中，指具备自主决策或执行能力的单元。 -- **LLM**：大语言模型。基于深度学习的自然语言处理模型，能够理解和生成人类语言。 -- **SaaS**：软件即服务。一种通过互联网提供软件应用的交付模式。 -- **UX**：用户体验。用户在使用产品或服务过程中建立的主观感受和评价。 -- **PRD**：产品需求文档。详细描述产品功能、特性和需求的正式文档。 -- **IDE**：集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。 diff --git a/docs/zh-cn/how-to/quick-fixes.md b/docs/zh-cn/how-to/quick-fixes.md index 4451627df..9c6c631e2 100644 --- a/docs/zh-cn/how-to/quick-fixes.md +++ b/docs/zh-cn/how-to/quick-fixes.md @@ -5,9 +5,9 @@ sidebar: order: 5 --- -使用 **Quick Dev** 进行 bug 修复、重构或小型针对性更改，这些操作不需要完整的 BMad Method。 +对于 bug 修复、重构或小范围改动，使用 **Quick Dev** 即可，不必走完整的 BMad Method。 -## 何时使用此方法 +## 何时使用本指南 - 原因明确且已知的 bug 修复 - 包含在少数文件中的小型重构（重命名、提取、重组） @@ -21,13 +21,13 @@ sidebar: ## 步骤 -### 1. 启动新的聊天 +### 1. 开启新会话 -在 AI IDE 中打开一个**新的聊天会话**。重用之前工作流的会话可能导致上下文冲突。 +在 AI IDE 中开启一个**全新的聊天会话**。复用之前工作流留下的会话，容易引发上下文冲突。 ### 2. 提供你的意图 -Quick Dev 接受自由形式的意图——可以在调用之前、同时或之后提供。示例： +Quick Dev 支持自由表达意图，你可以在调用前、调用时或调用后补充说明。示例： ```text run quick-dev — 修复允许空密码的登录验证 bug。 @@ -53,20 +53,20 @@ run quick-dev 重构 UserService 以使用 async/await 而不是回调。 ``` -纯文本、文件路径、GitHub issue URL、bug 跟踪器链接——任何 LLM 能解析为具体意图的内容都可以。 +纯文本、文件路径、GitHub issue 链接、缺陷跟踪地址都可以，只要 LLM 能解析成明确意图。 ### 3. 回答问题并批准 -Quick Dev 可能会提出澄清问题，或在实现之前呈现简短的规范供你批准。回答它的问题，并在你对计划满意时批准。 +Quick Dev 可能会先问澄清问题，或在实现前给出一份简短方案供你确认。回答问题后，在你认可方案时再批准继续。 ### 4. 审查和推送 -Quick Dev 实现更改、审查自己的工作、修复问题，并在本地提交。完成后，它会在编辑器中打开受影响的文件。 +Quick Dev 会实现改动、执行自检并修补问题，然后在本地提交。完成后，它会在编辑器中打开受影响文件。 -- 浏览 diff 以确认更改符合你的意图 -- 如果看起来有问题，告诉智能体需要修复什么——它可以在同一会话中迭代 +- 快速浏览 diff，确认改动符合你的意图 +- 如果有偏差，直接告诉智能体要改什么，它可以在同一会话里继续迭代 -满意后，推送提交。Quick Dev 会提供推送和创建 PR 的选项。 +确认无误后推送提交。Quick Dev 会提供推送和创建 PR 的选项。 :::caution[如果出现问题] 如果推送的更改导致意外问题，请使用 `git revert HEAD` 干净地撤销最后一次提交。然后启动新聊天并再次运行 Quick Dev 以尝试不同的方法。 @@ -80,9 +80,9 @@ Quick Dev 实现更改、审查自己的工作、修复问题，并在本地提 ## 延迟工作 -Quick Dev 保持每次运行聚焦于单一目标。如果你的请求包含多个独立目标，或者审查发现了与你的更改无关的已有问题，Quick Dev 会将它们延迟到一个文件中（实现产物目录中的 `deferred-work.md`），而不是试图一次解决所有问题。 +Quick Dev 每次只聚焦一个目标。如果你的请求包含多个独立目标，或审查过程中发现与你本次改动无关的存量问题，Quick Dev 会把它们记录到 `deferred-work.md`（位于实现产物目录），而不是一次性全都处理。 -运行后检查此文件——它是你的待办事项积压。每个延迟项目都可以稍后输入到新的 Quick Dev 运行中。 +每次运行后都建议看一下这个文件，它就是你的后续待办清单。你可以把其中任何一项在后续新的 Quick Dev 会话里单独处理。 ## 何时升级到正式规划 @@ -92,16 +92,4 @@ Quick Dev 保持每次运行聚焦于单一目标。如果你的请求包含多 - 你不确定范围，需要先进行需求发现 - 你需要为团队记录文档或架构决策 -参见 [Quick Dev](../explanation/quick-dev.md) 了解 Quick Dev 如何融入 BMad Method。 - ---- -## 术语说明 - -- **Quick Dev**：快速开发。BMad Method 中的快速工作流，用于小型更改的完整实现周期。 -- **refactoring**：重构。在不改变代码外部行为的情况下改进其内部结构的过程。 -- **breaking changes**：破坏性更改。可能导致现有代码或功能不再正常工作的更改。 -- **test suite**：测试套件。一组用于验证软件功能的测试用例集合。 -- **CI pipeline**：CI 流水线。持续集成流水线，用于自动化构建、测试和部署代码。 -- **diff**：差异。文件或代码更改前后的对比。 -- **commit**：提交。将更改保存到版本控制系统的操作。 -- **conventional commit**：约定式提交。遵循标准格式的提交消息。 +参见 [Quick Dev](../explanation/quick-dev.md) 了解 Quick Dev 在 BMad Method 中的位置与边界。