From 2a12c6b2f093f15c8269e4d14e08764c383f7066 Mon Sep 17 00:00:00 2001 From: Alex Verkhovsky Date: Wed, 11 Mar 2026 02:35:16 -0600 Subject: [PATCH] docs: drop slash-command prefix from skill references (#1892) * docs: drop slash-command syntax from skill references (editorial) Skill names like bmad-help are now shown without a / prefix since invocation syntax varies across platforms. First-encounter locations (README, getting-started, get-answers, installer message, bmad-help display rules) get editorial framing so new users understand these are skill names to invoke by name. Co-Authored-By: Claude Opus 4.6 * docs: mechanical removal of slash prefix from all remaining skill references Co-Authored-By: Claude Opus 4.6 --------- Co-authored-by: Claude Opus 4.6 --- CHANGELOG.md | 4 +- README.md | 4 +- README_CN.md | 4 +- docs/how-to/get-answers-about-bmad.md | 20 +++--- docs/tutorials/getting-started.md | 76 ++++++++++---------- docs/zh-cn/how-to/established-projects.md | 2 +- docs/zh-cn/how-to/get-answers-about-bmad.md | 2 +- docs/zh-cn/how-to/install-bmad.md | 2 +- docs/zh-cn/index.md | 2 +- docs/zh-cn/reference/commands.md | 40 +++++------ docs/zh-cn/reference/workflow-map.md | 4 +- docs/zh-cn/tutorials/getting-started.md | 80 ++++++++++----------- src/core/tasks/bmad-help/workflow.md | 8 +-- tools/cli/installers/lib/core/installer.js | 2 +- tools/docs/fix-refs.md | 2 +- 15 files changed, 128 insertions(+), 124 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 03e191434..034222306 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,7 +47,7 @@ * Add CodeBuddy platform support with installer configuration (#1483) * Add LLM audit prompt for file reference conventions - new audit tool using parallel subagents (#1720) * Migrate Codex installer from `.codex/prompts` to `.agents/skills` format to align with Codex CLI changes (#1729) -* Convert review-pr and audit-file-refs tools to proper bmad-os skills with slash commands `/bmad-os-review-pr` and `/bmad-os-audit-file-refs` (#1732) +* Convert review-pr and audit-file-refs tools to proper bmad-os skills with slash commands `bmad-os-review-pr` and `bmad-os-audit-file-refs` (#1732) ### 🐛 Bug Fixes @@ -365,7 +365,7 @@ V6 Stable Release! The End of Beta! - TEA documentation restructured using Diátaxis framework (25 docs) - Style guide optimized for LLM readers (367 lines, down from 767) - Glossary rewritten using table format (123 lines, down from 373) -- README overhaul with numbered command flows and prominent `/bmad-help` callout +- README overhaul with numbered command flows and prominent `bmad-help` callout - New workflow map diagram with interactive HTML - New editorial review tasks for document quality - E2E testing methodology for Game Dev Studio diff --git a/README.md b/README.md index 28d12221f..d76519c97 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflows act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI. -- **AI Intelligent Help** — Ask `/bmad-help` anytime for guidance on what's next +- **AI Intelligent Help** — Invoke the `bmad-help` skill anytime for guidance on what's next - **Scale-Domain-Adaptive** — Automatically adjusts planning depth based on project complexity - **Structured Workflows** — Grounded in agile best practices across analysis, planning, architecture, and implementation - **Specialized Agents** — 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more) @@ -52,7 +52,7 @@ npx bmad-method install --directory /path/to/project --modules bmm --tools claud [See all installation options](https://docs.bmad-method.org/how-to/non-interactive-installation/) -> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask questions like `/bmad-help I just finished the architecture, what do I do next?` +> **Not sure what to do?** Ask `bmad-help` — it tells you exactly what's next and what's optional. You can also ask questions like `bmad-help I just finished the architecture, what do I do next?` ## Modules diff --git a/README_CN.md b/README_CN.md index 85b42cb2f..922644e5e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -13,7 +13,7 @@ 传统 AI 工具替你思考，产生平庸的结果。BMad 智能体和辅助工作流充当专家协作者，引导你通过结构化流程，与 AI 的合作发挥最佳思维，产出最有效优秀的结果。 -- **AI 智能帮助** — 随时使用 `/bmad-help` 获取下一步指导 +- **AI 智能帮助** — 随时使用 `bmad-help` 获取下一步指导 - **规模-领域自适应** — 根据项目复杂度自动调整规划深度 - **结构化工作流** — 基于分析、规划、架构和实施的敏捷最佳实践 - **专业智能体** — 12+ 领域专家（PM、架构师、开发者、UX、Scrum Master 等） @@ -52,7 +52,7 @@ npx bmad-method install --directory /path/to/project --modules bmm --tools claud [查看所有安装选项](http://docs.bmad-method.org/how-to/non-interactive-installation/) -> **不确定该做什么？** 运行 `/bmad-help` — 它会准确告诉你下一步做什么以及什么是可选的。你也可以问诸如 `/bmad-help 我刚刚完成了架构设计，接下来该做什么？` 之类的问题。 +> **不确定该做什么？** 运行 `bmad-help` — 它会准确告诉你下一步做什么以及什么是可选的。你也可以问诸如 `bmad-help 我刚刚完成了架构设计，接下来该做什么？` 之类的问题。 ## 模块 diff --git a/docs/how-to/get-answers-about-bmad.md b/docs/how-to/get-answers-about-bmad.md index 87cd057ee..c42e69cc8 100644 --- a/docs/how-to/get-answers-about-bmad.md +++ b/docs/how-to/get-answers-about-bmad.md @@ -7,7 +7,7 @@ sidebar: ## Start Here: BMad-Help -**The fastest way to get answers about BMad is `/bmad-help`.** This intelligent guide will answer upwards of 80% of all questions and is available to you directly in your IDE as you work. +**The fastest way to get answers about BMad is the `bmad-help` skill.** This intelligent guide will answer upwards of 80% of all questions and is available to you directly in your IDE as you work. BMad-Help is more than a lookup tool — it: - **Inspects your project** to see what's already been completed @@ -18,19 +18,23 @@ BMad-Help is more than a lookup tool — it: ### How to Use BMad-Help -Run it with just the skill name: +Call it by name in your AI session: ``` -/bmad-help +bmad-help ``` -Or combine it with a natural language query: +:::tip +You can also use `/bmad-help` or `$bmad-help` depending on your platform, but just `bmad-help` should work everywhere. +::: + +Combine it with a natural language query: ``` -/bmad-help I have a SaaS idea and know all the features. Where do I start? -/bmad-help What are my options for UX design? -/bmad-help I'm stuck on the PRD workflow -/bmad-help Show me what's been done so far +bmad-help I have a SaaS idea and know all the features. Where do I start? +bmad-help What are my options for UX design? +bmad-help I'm stuck on the PRD workflow +bmad-help Show me what's been done so far ``` BMad-Help responds with: diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index 2c7817111..43b5ba2e9 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -22,7 +22,7 @@ Build software faster using AI-powered workflows with specialized agents that gu :::tip[The Easiest Path] **Install** → `npx bmad-method install` -**Ask** → `/bmad-help what should I do first?` +**Ask** → `bmad-help what should I do first?` **Build** → Let BMad-Help guide you workflow by workflow ::: @@ -59,7 +59,7 @@ BMad-Help will respond with: BMad-Help doesn't just answer questions — **it automatically runs at the end of every workflow** to tell you exactly what to do next. No guessing, no searching docs — just clear guidance on the next required workflow. :::tip[Start Here] -After installing BMad, run `/bmad-help` immediately. It will detect what modules you have installed and guide you to the right starting point for your project. +After installing BMad, invoke the `bmad-help` skill immediately. It will detect what modules you have installed and guide you to the right starting point for your project. ::: ## Understanding BMad @@ -107,14 +107,14 @@ The installer creates two folders: Open your AI IDE in the project folder and run: ``` -/bmad-help +bmad-help ``` BMad-Help will detect what you've completed and recommend exactly what to do next. You can also ask it questions like "What are my options?" or "I have a SaaS idea, where should I start?" ::: :::note[How to Load Agents and Run Workflows] -Each workflow has a **skill** you invoke in your IDE (e.g., `/bmad-create-prd`). Running a workflow skill automatically loads the appropriate agent — you don't need to load agents separately. You can also invoke an agent 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-pm` for the PM agent). ::: :::caution[Fresh Chats] @@ -128,35 +128,35 @@ Work through phases 1-3. **Use fresh chats for each workflow.** :::tip[Project Context (Optional)] Before starting, consider creating `project-context.md` to document your technical preferences and implementation rules. This ensures all AI agents follow your conventions throughout the project. -Create it manually at `_bmad-output/project-context.md` or generate it after architecture using `/bmad-generate-project-context`. [Learn more](../explanation/project-context.md). +Create it manually at `_bmad-output/project-context.md` or generate it after architecture using `bmad-generate-project-context`. [Learn more](../explanation/project-context.md). ::: ### Phase 1: Analysis (Optional) All workflows in this phase are optional: -- **brainstorming** (`/bmad-brainstorming`) — Guided ideation -- **research** (`/bmad-research`) — Market and technical research -- **create-product-brief** (`/bmad-create-product-brief`) — Recommended foundation document +- **brainstorming** (`bmad-brainstorming`) — Guided ideation +- **research** (`bmad-research`) — Market and technical research +- **create-product-brief** (`bmad-create-product-brief`) — Recommended foundation document ### Phase 2: Planning (Required) **For BMad Method and Enterprise tracks:** -1. Invoke the **PM agent** (`/bmad-pm`) in a new chat -2. Run the `bmad-create-prd` workflow (`/bmad-create-prd`) +1. Invoke the **PM agent** (`bmad-pm`) in a new chat +2. Run the `bmad-create-prd` workflow (`bmad-create-prd`) 3. Output: `PRD.md` **For Quick Flow track:** -- Use the `bmad-quick-spec` workflow (`/bmad-quick-spec`) instead of PRD, then skip to implementation +- Use the `bmad-quick-spec` workflow (`bmad-quick-spec`) instead of PRD, then skip to implementation :::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-ux-designer`) and run the UX design workflow (`bmad-create-ux-design`) after creating your PRD. ::: ### Phase 3: Solutioning (BMad Method/Enterprise) **Create Architecture** -1. Invoke the **Architect agent** (`/bmad-architect`) in a new chat -2. Run `bmad-create-architecture` (`/bmad-create-architecture`) +1. Invoke the **Architect agent** (`bmad-architect`) in a new chat +2. Run `bmad-create-architecture` (`bmad-create-architecture`) 3. Output: Architecture document with technical decisions **Create Epics and Stories** @@ -165,13 +165,13 @@ If your project has a user interface, invoke the **UX-Designer agent** (`/bmad-u 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 -2. Run `bmad-create-epics-and-stories` (`/bmad-create-epics-and-stories`) +1. Invoke the **PM agent** (`bmad-pm`) in a new chat +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 **Implementation Readiness Check** *(Highly Recommended)* -1. Invoke the **Architect agent** (`/bmad-architect`) in a new chat -2. Run `bmad-check-implementation-readiness` (`/bmad-check-implementation-readiness`) +1. Invoke the **Architect agent** (`bmad-architect`) in a new chat +2. Run `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`) 3. Validates cohesion across all planning documents ## Step 2: Build Your Project @@ -180,7 +180,7 @@ Once planning is complete, move to implementation. **Each workflow should run in ### 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-sm`) and run `bmad-sprint-planning` (`bmad-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories. ### The Build Cycle @@ -188,11 +188,11 @@ For each story, repeat this cycle with fresh chats: | Step | Agent | Workflow | Command | Purpose | | ---- | ----- | -------------- | -------------------------- | ---------------------------------- | -| 1 | SM | `bmad-create-story` | `/bmad-create-story` | Create story file from epic | -| 2 | DEV | `bmad-dev-story` | `/bmad-dev-story` | Implement the story | -| 3 | DEV | `bmad-code-review` | `/bmad-code-review` | Quality validation *(recommended)* | +| 1 | SM | `bmad-create-story` | `bmad-create-story` | Create story file from epic | +| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implement the story | +| 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-sm`) and run `bmad-retrospective` (`bmad-retrospective`). ## What You've Accomplished @@ -223,16 +223,16 @@ your-project/ | Workflow | Command | Agent | Purpose | | ------------------------------------- | ------------------------------------------ | --------- | ----------------------------------------------- | -| **`bmad-help`** ⭐ | `/bmad-help` | Any | **Your intelligent guide — ask anything!** | -| `bmad-create-prd` | `/bmad-create-prd` | PM | Create Product Requirements Document | -| `bmad-create-architecture` | `/bmad-create-architecture` | Architect | Create architecture document | -| `bmad-generate-project-context` | `/bmad-generate-project-context` | Analyst | Create project context file | -| `bmad-create-epics-and-stories` | `/bmad-create-epics-and-stories` | PM | Break down PRD into epics | -| `bmad-check-implementation-readiness` | `/bmad-check-implementation-readiness` | Architect | Validate planning cohesion | -| `bmad-sprint-planning` | `/bmad-sprint-planning` | SM | Initialize sprint tracking | -| `bmad-create-story` | `/bmad-create-story` | SM | Create a story file | -| `bmad-dev-story` | `/bmad-dev-story` | DEV | Implement a story | -| `bmad-code-review` | `/bmad-code-review` | DEV | Review implemented code | +| **`bmad-help`** ⭐ | `bmad-help` | Any | **Your intelligent guide — ask anything!** | +| `bmad-create-prd` | `bmad-create-prd` | PM | Create Product Requirements Document | +| `bmad-create-architecture` | `bmad-create-architecture` | Architect | Create architecture document | +| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | Create project context file | +| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | Break down PRD into epics | +| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Architect | Validate planning cohesion | +| `bmad-sprint-planning` | `bmad-sprint-planning` | SM | Initialize sprint tracking | +| `bmad-create-story` | `bmad-create-story` | SM | Create a story file | +| `bmad-dev-story` | `bmad-dev-story` | DEV | Implement a story | +| `bmad-code-review` | `bmad-code-review` | DEV | Review implemented code | ## Common Questions @@ -240,10 +240,10 @@ your-project/ Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation. **Can I change my plan later?** -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?** -Invoke the Analyst agent (`/bmad-analyst`) and run `bmad-brainstorming` (`/bmad-brainstorming`) before starting your PRD. +Invoke the Analyst agent (`bmad-analyst`) and run `bmad-brainstorming` (`bmad-brainstorming`) before starting your PRD. **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. @@ -251,7 +251,7 @@ Not strictly. Once you learn the flow, you can run workflows directly using the ## Getting Help :::tip[First Stop: BMad-Help] -**Run `/bmad-help` anytime** — it's the fastest way to get unstuck. Ask it anything: +**Invoke `bmad-help` anytime** — it's the fastest way to get unstuck. Ask it anything: - "What should I do after installing?" - "I'm stuck on workflow X" - "What are my options for Y?" @@ -266,10 +266,10 @@ BMad-Help inspects your project, detects what you've completed, and tells you ex ## Key Takeaways :::tip[Remember These] -- **Start with `/bmad-help`** — Your intelligent guide that knows your project and options +- **Start with `bmad-help`** — Your intelligent guide that knows your project and options - **Always use fresh chats** — Start a new chat for each workflow - **Track matters** — Quick Flow uses quick-spec; Method/Enterprise need PRD and architecture - **BMad-Help runs automatically** — Every workflow ends with guidance on what's next ::: -Ready to start? Install BMad, run `/bmad-help`, and let your intelligent guide lead the way. +Ready to start? Install BMad, invoke `bmad-help`, and let your intelligent guide lead the way. diff --git a/docs/zh-cn/how-to/established-projects.md b/docs/zh-cn/how-to/established-projects.md index ec7b9d787..b157f6a68 100644 --- a/docs/zh-cn/how-to/established-projects.md +++ b/docs/zh-cn/how-to/established-projects.md @@ -61,7 +61,7 @@ sidebar: ### BMad-Help：你的起点 -**随时运行 `/bmad-help`，当你不确定下一步该做什么时。** 这个智能指南： +**随时运行 `bmad-help`，当你不确定下一步该做什么时。** 这个智能指南： - 检查你的项目以查看已经完成了什么 - 根据你安装的模块显示选项 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 d40dbbcab..43d23fd95 100644 --- a/docs/zh-cn/how-to/get-answers-about-bmad.md +++ b/docs/zh-cn/how-to/get-answers-about-bmad.md @@ -7,7 +7,7 @@ sidebar: ## 从这里开始：BMad-Help -**获取关于 BMad 答案的最快方式是 `/bmad-help`。** 这个智能指南可以回答超过 80% 的问题，并且直接在您的 IDE 中可用，方便您工作时使用。 +**获取关于 BMad 答案的最快方式是 `bmad-help`。** 这个智能指南可以回答超过 80% 的问题，并且直接在您的 IDE 中可用，方便您工作时使用。 BMad-Help 不仅仅是一个查询工具——它： - **检查您的项目**以查看已完成的内容 diff --git a/docs/zh-cn/how-to/install-bmad.md b/docs/zh-cn/how-to/install-bmad.md index f0e2d436c..d74479b45 100644 --- a/docs/zh-cn/how-to/install-bmad.md +++ b/docs/zh-cn/how-to/install-bmad.md @@ -77,7 +77,7 @@ your-project/ ## 验证安装 -运行 `/bmad-help` 来验证一切正常并查看下一步操作。 +运行 `bmad-help` 来验证一切正常并查看下一步操作。 **BMad-Help 是你的智能向导**，它会： - 确认你的安装正常工作 diff --git a/docs/zh-cn/index.md b/docs/zh-cn/index.md index 6e643c34b..11c43eeb5 100644 --- a/docs/zh-cn/index.md +++ b/docs/zh-cn/index.md @@ -19,7 +19,7 @@ BMad 方法（**B**reakthrough **M**ethod of **A**gile AI **D**riven Development - **[工作流地图](./reference/workflow-map.md)** — BMM 阶段、工作流和上下文管理的可视化概览 :::tip[只想直接上手？] -安装 BMad 并运行 `/bmad-help` — 它会根据您的项目和已安装的模块引导您完成所有操作。 +安装 BMad 并运行 `bmad-help` — 它会根据您的项目和已安装的模块引导您完成所有操作。 ::: ## 如何使用本文档 diff --git a/docs/zh-cn/reference/commands.md b/docs/zh-cn/reference/commands.md index 40629e673..773998cfd 100644 --- a/docs/zh-cn/reference/commands.md +++ b/docs/zh-cn/reference/commands.md @@ -13,7 +13,7 @@ BMad 提供两种开始工作的方式，它们服务于不同的目的。 | 机制 | 调用方式 | 发生什么 | | --- | --- | --- | -| **斜杠命令** | 在 IDE 中输入 `/bmad-...` | 直接加载智能体、运行工作流或执行任务 | +| **斜杠命令** | 在 IDE 中输入 `bmad-...` | 直接加载智能体、运行工作流或执行任务 | | **智能体菜单触发器** | 先加载智能体，然后输入简短代码（例如 `DS`） | 智能体解释代码并启动匹配的工作流，同时保持角色设定 | 智能体菜单触发器需要活动的智能体会话。当您知道要使用哪个工作流时，使用斜杠命令。当您已经与智能体一起工作并希望在不离开对话的情况下切换任务时，使用触发器。 @@ -58,13 +58,13 @@ BMad 提供两种开始工作的方式，它们服务于不同的目的。 └── ... ``` -文件名决定了 IDE 中的斜杠命令名称。例如，文件 `bmad-agent-bmm-dev.md` 注册命令 `/bmad-agent-bmm-dev`。 +文件名决定了 IDE 中的技能名称。例如，文件 `bmad-agent-bmm-dev.md` 注册技能 `bmad-agent-bmm-dev`。 ## 如何发现您的命令 在 IDE 中输入 `/bmad` 并使用自动完成功能浏览可用命令。 -运行 `/bmad-help` 获取关于下一步的上下文感知指导。 +运行 `bmad-help` 获取关于下一步的上下文感知指导。 :::tip[快速发现] 项目中生成的命令文件夹是权威列表。在文件资源管理器中打开它们以查看每个命令及其描述。 @@ -78,10 +78,10 @@ BMad 提供两种开始工作的方式，它们服务于不同的目的。 | 示例命令 | 智能体 | 角色 | | --- | --- | --- | -| `/bmad-agent-bmm-dev` | Amelia（开发者） | 严格按照规范实现故事 | -| `/bmad-agent-bmm-pm` | John（产品经理） | 创建和验证 PRD | -| `/bmad-agent-bmm-architect` | Winston（架构师） | 设计系统架构 | -| `/bmad-agent-bmm-sm` | Bob（Scrum Master） | 管理冲刺和故事 | +| `bmad-agent-bmm-dev` | Amelia（开发者） | 严格按照规范实现故事 | +| `bmad-agent-bmm-pm` | John（产品经理） | 创建和验证 PRD | +| `bmad-agent-bmm-architect` | Winston（架构师） | 设计系统架构 | +| `bmad-agent-bmm-sm` | Bob（Scrum Master） | 管理冲刺和故事 | 参见[智能体](./agents.md)获取默认智能体及其触发器的完整列表。 @@ -91,11 +91,11 @@ BMad 提供两种开始工作的方式，它们服务于不同的目的。 | 示例命令 | 目的 | | --- | --- | -| `/bmad-bmm-create-prd` | 创建产品需求文档 | -| `/bmad-bmm-create-architecture` | 设计系统架构 | -| `/bmad-bmm-dev-story` | 实现故事 | -| `/bmad-bmm-code-review` | 运行代码审查 | -| `/bmad-bmm-quick-spec` | 定义临时更改（快速流程） | +| `bmad-bmm-create-prd` | 创建产品需求文档 | +| `bmad-bmm-create-architecture` | 设计系统架构 | +| `bmad-bmm-dev-story` | 实现故事 | +| `bmad-bmm-code-review` | 运行代码审查 | +| `bmad-bmm-quick-spec` | 定义临时更改（快速流程） | 参见[工作流地图](./workflow-map.md)获取按阶段组织的完整工作流参考。 @@ -105,7 +105,7 @@ BMad 提供两种开始工作的方式，它们服务于不同的目的。 #### BMad-Help：您的智能向导 -**`/bmad-help`** 是您发现下一步操作的主要界面。它不仅仅是一个查找工具——它是一个智能助手，可以： +**`bmad-help`** 是您发现下一步操作的主要界面。它不仅仅是一个查找工具——它是一个智能助手，可以： - **检查您的项目**以查看已经完成的工作 - **理解自然语言查询**——用简单的英语提问 @@ -116,19 +116,19 @@ BMad 提供两种开始工作的方式，它们服务于不同的目的。 **示例：** ``` -/bmad-help -/bmad-help 我有一个 SaaS 想法并且知道所有功能。我应该从哪里开始？ -/bmad-help 我在 UX 设计方面有哪些选择？ -/bmad-help 我在 PRD 工作流上卡住了 +bmad-help +bmad-help 我有一个 SaaS 想法并且知道所有功能。我应该从哪里开始？ +bmad-help 我在 UX 设计方面有哪些选择？ +bmad-help 我在 PRD 工作流上卡住了 ``` #### 其他任务和工具 | 示例命令 | 目的 | | --- | --- | -| `/bmad-shard-doc` | 将大型 Markdown 文件拆分为较小的部分 | -| `/bmad-index-docs` | 索引项目文档 | -| `/bmad-editorial-review-prose` | 审查文档散文质量 | +| `bmad-shard-doc` | 将大型 Markdown 文件拆分为较小的部分 | +| `bmad-index-docs` | 索引项目文档 | +| `bmad-editorial-review-prose` | 审查文档散文质量 | ## 命名约定 diff --git a/docs/zh-cn/reference/workflow-map.md b/docs/zh-cn/reference/workflow-map.md index 23ae70b5b..51a8e2219 100644 --- a/docs/zh-cn/reference/workflow-map.md +++ b/docs/zh-cn/reference/workflow-map.md @@ -9,7 +9,7 @@ BMad Method（BMM）是 BMad 生态系统中的一个模块，旨在遵循上下 其基本原理和概念来自敏捷方法论，这些方法论在整个行业中被广泛用作思维框架，并取得了巨大成功。 -如果您在任何时候不确定该做什么，`/bmad-help` 命令将帮助您保持正轨或了解下一步该做什么。您也可以随时参考此文档以获取参考信息——但如果您已经安装了 BMad Method，`/bmad-help` 是完全交互式的，速度要快得多。此外，如果您正在使用扩展了 BMad Method 或添加了其他互补非扩展模块的不同模块——`/bmad-help` 会不断演进以了解所有可用内容，从而为您提供最佳即时建议。 +如果您在任何时候不确定该做什么，`bmad-help` 命令将帮助您保持正轨或了解下一步该做什么。您也可以随时参考此文档以获取参考信息——但如果您已经安装了 BMad Method，`bmad-help` 是完全交互式的，速度要快得多。此外，如果您正在使用扩展了 BMad Method 或添加了其他互补非扩展模块的不同模块——`bmad-help` 会不断演进以了解所有可用内容，从而为您提供最佳即时建议。 最后的重要说明：以下每个工作流程都可以通过斜杠命令直接使用您选择的工具运行，或者先加载智能体，然后使用智能体菜单中的条目来运行。 @@ -84,7 +84,7 @@ BMad Method（BMM）是 BMad 生态系统中的一个模块，旨在遵循上下 **如何创建它：** - **手动** — 使用您的技术栈和实施规则创建 `_bmad-output/project-context.md` -- **生成它** — 运行 `/bmad-bmm-generate-project-context` 以从您的架构或代码库自动生成 +- **生成它** — 运行 `bmad-bmm-generate-project-context` 以从您的架构或代码库自动生成 [**了解更多关于 project-context.md**](../explanation/project-context.md) diff --git a/docs/zh-cn/tutorials/getting-started.md b/docs/zh-cn/tutorials/getting-started.md index 31a765b33..3bffb4407 100644 --- a/docs/zh-cn/tutorials/getting-started.md +++ b/docs/zh-cn/tutorials/getting-started.md @@ -22,7 +22,7 @@ description: 安装 BMad 并构建你的第一个项目 :::tip[最简单的路径] **安装** → `npx bmad-method install` -**询问** → `/bmad-help 我应该先做什么？` +**询问** → `bmad-help 我应该先做什么？` **构建** → 让 BMad-Help 逐个工作流地引导你 ::: @@ -40,13 +40,13 @@ description: 安装 BMad 并构建你的第一个项目 只需在 AI IDE 中使用斜杠命令运行它： ``` -/bmad-help +bmad-help ``` 或者结合问题以获得上下文感知的指导： ``` -/bmad-help 我有一个 SaaS 产品的想法，我已经知道我想要的所有功能。我应该从哪里开始？ +bmad-help 我有一个 SaaS 产品的想法，我已经知道我想要的所有功能。我应该从哪里开始？ ``` BMad-Help 将回应： @@ -59,7 +59,7 @@ BMad-Help 将回应： BMad-Help 不仅回答问题 —— **它会在每个工作流结束时自动运行**，告诉你确切地下一步该做什么。无需猜测，无需搜索文档 —— 只需对下一个必需工作流的清晰指导。 :::tip[从这里开始] -安装 BMad 后，立即运行 `/bmad-help`。它将检测你安装了哪些模块，并引导你找到项目的正确起点。 +安装 BMad 后，立即运行 `bmad-help`。它将检测你安装了哪些模块，并引导你找到项目的正确起点。 ::: ## 了解 BMad @@ -105,14 +105,14 @@ npx bmad-method install 在项目文件夹中打开你的 AI IDE 并运行： ``` -/bmad-help +bmad-help ``` BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么。你也可以问它诸如"我的选项是什么？"或"我有一个 SaaS 想法，我应该从哪里开始？"之类的问题。 ::: :::note[如何加载智能体和运行工作流] -每个工作流都有一个你在 IDE 中运行的**斜杠命令**（例如 `/bmad-bmm-create-prd`）。运行工作流命令会自动加载相应的智能体 —— 你不需要单独加载智能体。你也可以直接加载智能体进行一般对话（例如，加载 PM 智能体使用 `/bmad-agent-bmm-pm`）。 +每个工作流都有一个你在 IDE 中运行的**斜杠命令**（例如 `bmad-bmm-create-prd`）。运行工作流命令会自动加载相应的智能体 —— 你不需要单独加载智能体。你也可以直接加载智能体进行一般对话（例如，加载 PM 智能体使用 `bmad-agent-bmm-pm`）。 ::: :::caution[新对话] @@ -126,35 +126,35 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 :::tip[项目上下文（可选）] 在开始之前，考虑创建 `project-context.md` 来记录你的技术偏好和实现规则。这确保所有 AI 智能体在整个项目中遵循你的约定。 -在 `_bmad-output/project-context.md` 手动创建它，或在架构之后使用 `/bmad-bmm-generate-project-context` 生成它。[了解更多](../explanation/project-context.md)。 +在 `_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`） — 推荐的基础文档 +- **头脑风暴**（`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`） +1. 在新对话中加载 **PM 智能体**（`bmad-agent-bmm-pm`） +2. 运行 `prd` 工作流（`bmad-bmm-create-prd`） 3. 输出：`PRD.md` **对于 Quick Flow 路径：** -- 使用 `quick-spec` 工作流（`/bmad-bmm-quick-spec`）代替 PRD，然后跳转到实现 +- 使用 `quick-spec` 工作流（`bmad-bmm-quick-spec`）代替 PRD，然后跳转到实现 :::note[UX 设计（可选）] -如果你的项目有用户界面，在创建 PRD 后加载 **UX-Designer 智能体**（`/bmad-agent-bmm-ux-designer`）并运行 UX 设计工作流（`/bmad-bmm-create-ux-design`）。 +如果你的项目有用户界面，在创建 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`） +1. 在新对话中加载 **Architect 智能体**（`bmad-agent-bmm-architect`） +2. 运行 `create-architecture`（`bmad-bmm-create-architecture`） 3. 输出：包含技术决策的架构文档 **创建史诗和故事** @@ -163,13 +163,13 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 史诗和故事现在在架构*之后*创建。这会产生更高质量的故事，因为架构决策（数据库、API 模式、技术栈）直接影响工作应该如何分解。 ::: -1. 在新对话中加载 **PM 智能体**（`/bmad-agent-bmm-pm`） -2. 运行 `create-epics-and-stories`（`/bmad-bmm-create-epics-and-stories`） +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`） +1. 在新对话中加载 **Architect 智能体**（`bmad-agent-bmm-architect`） +2. 运行 `check-implementation-readiness`（`bmad-bmm-check-implementation-readiness`） 3. 验证所有规划文档之间的一致性 ## 步骤 2：构建你的项目 @@ -178,7 +178,7 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 ### 初始化冲刺规划 -加载 **SM 智能体**（`/bmad-agent-bmm-sm`）并运行 `sprint-planning`（`/bmad-bmm-sprint-planning`）。这将创建 `sprint-status.yaml` 来跟踪所有史诗和故事。 +加载 **SM 智能体**（`bmad-agent-bmm-sm`）并运行 `sprint-planning`（`bmad-bmm-sprint-planning`）。这将创建 `sprint-status.yaml` 来跟踪所有史诗和故事。 ### 构建周期 @@ -186,11 +186,11 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 | 步骤 | 智能体 | 工作流 | 命令 | 目的 | | ---- | ------ | ------------ | ----------------------- | ------------------------------- | -| 1 | SM | `create-story` | `/bmad-bmm-create-story` | 从史诗创建故事文件 | -| 2 | DEV | `dev-story` | `/bmad-bmm-dev-story` | 实现故事 | -| 3 | DEV | `code-review` | `/bmad-bmm-code-review` | 质量验证 *（推荐）* | +| 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`）。 +完成史诗中的所有故事后，加载 **SM 智能体**（`bmad-agent-bmm-sm`）并运行 `retrospective`（`bmad-bmm-retrospective`）。 ## 你已完成的工作 @@ -221,16 +221,16 @@ your-project/ | 工作流 | 命令 | 智能体 | 目的 | | ----------------------------------- | --------------------------------------- | -------- | -------------------------------------------- | -| **`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 | 审查已实现的代码 | +| **`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 | 审查已实现的代码 | ## 常见问题 @@ -238,10 +238,10 @@ your-project/ 仅对于 BMad Method 和 Enterprise 路径。Quick Flow 从技术规范跳转到实现。 **我可以稍后更改我的计划吗？** -可以。SM 智能体有一个 `correct-course` 工作流（`/bmad-bmm-correct-course`）用于处理范围变更。 +可以。SM 智能体有一个 `correct-course` 工作流（`bmad-bmm-correct-course`）用于处理范围变更。 **如果我想先进行头脑风暴怎么办？** -在开始 PRD 之前，加载 Analyst 智能体（`/bmad-agent-bmm-analyst`）并运行 `brainstorming`（`/bmad-brainstorming`）。 +在开始 PRD 之前，加载 Analyst 智能体（`bmad-agent-bmm-analyst`）并运行 `brainstorming`（`bmad-brainstorming`）。 **我需要遵循严格的顺序吗？** 不一定。一旦你了解了流程，你可以使用上面的快速参考直接运行工作流。 @@ -249,7 +249,7 @@ your-project/ ## 获取帮助 :::tip[第一站：BMad-Help] -**随时运行 `/bmad-help`** —— 这是摆脱困境的最快方式。问它任何问题： +**随时运行 `bmad-help`** —— 这是摆脱困境的最快方式。问它任何问题： - "安装后我应该做什么？" - "我在工作流 X 上卡住了" - "我在 Y 方面有什么选项？" @@ -264,13 +264,13 @@ BMad-Help 检查你的项目，检测你已完成的内容，并确切地告诉 ## 关键要点 :::tip[记住这些] -- **从 `/bmad-help` 开始** — 你的智能向导，了解你的项目和选项 +- **从 `bmad-help` 开始** — 你的智能向导，了解你的项目和选项 - **始终使用新对话** — 为每个工作流开始新对话 - **路径很重要** — Quick Flow 使用 quick-spec；Method/Enterprise 需要 PRD 和架构 - **BMad-Help 自动运行** — 每个工作流结束时都会提供下一步的指导 ::: -准备好开始了吗？安装 BMad，运行 `/bmad-help`，让你的智能向导为你引路。 +准备好开始了吗？安装 BMad，运行 `bmad-help`，让你的智能向导为你引路。 --- ## 术语说明 diff --git a/src/core/tasks/bmad-help/workflow.md b/src/core/tasks/bmad-help/workflow.md index 537f42322..7cea8b7ff 100644 --- a/src/core/tasks/bmad-help/workflow.md +++ b/src/core/tasks/bmad-help/workflow.md @@ -15,24 +15,24 @@ ### Command-Based Workflows When `command` field has a value: -- Show the command prefixed with `/` (e.g., `/bmad-bmm-create-prd`) +- Show the command as a skill name in backticks (e.g., `bmad-bmm-create-prd`) ### Skill-Referenced Workflows When `workflow-file` starts with `skill:`: - The value is a skill reference (e.g., `skill:bmad-quick-dev-new-preview`), NOT a file path - Do NOT attempt to resolve or load it as a file path -- Display using the `command` column value prefixed with `/` (same as command-based workflows) +- Display using the `command` column value as a skill name in backticks (same as command-based workflows) ### Agent-Based Workflows When `command` field is empty: -- User loads agent first via `/agent-command` +- User loads agent first by invoking the agent skill (e.g., `bmad-pm`) - Then invokes by referencing the `code` field or describing the `name` field - Do NOT show a slash command — show the code value and agent load instruction instead Example presentation for empty command: ``` Explain Concept (EC) -Load: /tech-writer, then ask to "EC about [topic]" +Load: tech-writer agent skill, then ask to "EC about [topic]" Agent: Tech Writer Description: Create clear technical explanations with examples... ``` diff --git a/tools/cli/installers/lib/core/installer.js b/tools/cli/installers/lib/core/installer.js index 1d9868b60..c9ea83182 100644 --- a/tools/cli/installers/lib/core/installer.js +++ b/tools/cli/installers/lib/core/installer.js @@ -1415,7 +1415,7 @@ class Installer { ` Join our Discord: ${color.dim('https://discord.gg/gk8jAdXWmj')}`, ` Star us on GitHub: ${color.dim('https://github.com/bmad-code-org/BMAD-METHOD/')}`, ` Subscribe on YouTube: ${color.dim('https://www.youtube.com/@BMadCode')}`, - ` Run ${color.cyan('/bmad-help')} with your IDE Agent and ask it how to get started`, + ` Invoke the ${color.cyan('bmad-help')} skill in your IDE Agent to get started`, ); await prompts.note(lines.join('\n'), 'BMAD is ready to use!'); diff --git a/tools/docs/fix-refs.md b/tools/docs/fix-refs.md index df9835b43..fe7ef679f 100644 --- a/tools/docs/fix-refs.md +++ b/tools/docs/fix-refs.md @@ -50,7 +50,7 @@ Use backticks with plain workflow name: - **Other docs**: "Run `prd`" — they already know, so "workflow" is noise **Platform hint**: Only in newbie docs, and only on the **first** workflow mention: -- First mention: Run the `help` workflow (`/bmad-help` on most platforms) +- First mention: Run the `help` workflow (`bmad-help` on most platforms) - Subsequent mentions: Run `prd` — no hint, no "workflow" needed after they've seen the pattern In experienced docs, the hint is always noise — just use the workflow name.