ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

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 <noreply@anthropic.com>
This commit is contained in:
Alex Verkhovsky 2026-03-11 01:42:16 -06:00
parent 2b809e56a4
commit 5204846a5c
5 changed files with 26 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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. 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 - **Scale-Domain-Adaptive** — Automatically adjusts planning depth based on project complexity
- **Structured Workflows** — Grounded in agile best practices across analysis, planning, architecture, and implementation - **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) - **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/) [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 ## Modules

20
docs/how-to/get-answers-about-bmad.md
View File

@ -7,7 +7,7 @@ sidebar:
## Start Here: BMad-Help ## 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: BMad-Help is more than a lookup tool — it:
- **Inspects your project** to see what's already been completed - **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 ### 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 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 What are my options for UX design?
/bmad-help I'm stuck on the PRD workflow bmad-help I'm stuck on the PRD workflow
/bmad-help Show me what's been done so far bmad-help Show me what's been done so far
``` ```
BMad-Help responds with: BMad-Help responds with:

14
docs/tutorials/getting-started.md
View File

@ -22,7 +22,7 @@ Build software faster using AI-powered workflows with specialized agents that gu
:::tip[The Easiest Path] :::tip[The Easiest Path]
**Install** → `npx bmad-method install` **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 **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. 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] :::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 ## Understanding BMad
@ -105,14 +105,14 @@ The installer creates two folders:
Open your AI IDE in the project folder and run: 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?" 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] :::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] :::caution[Fresh Chats]
@ -249,7 +249,7 @@ Not strictly. Once you learn the flow, you can run workflows directly using the
## Getting Help ## Getting Help
:::tip[First Stop: BMad-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?" - "What should I do after installing?"
- "I'm stuck on workflow X" - "I'm stuck on workflow X"
- "What are my options for Y?" - "What are my options for Y?"
@ -264,10 +264,10 @@ BMad-Help inspects your project, detects what you've completed, and tells you ex
## Key Takeaways ## Key Takeaways
:::tip[Remember These] :::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 - **Always use fresh chats** — Start a new chat for each workflow
- **Track matters** — Quick Flow uses quick-spec; Method/Enterprise need PRD and architecture - **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 - **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.

8
src/core/tasks/bmad-help/workflow.md
View File

@ -15,24 +15,24 @@
### Command-Based Workflows ### Command-Based Workflows
When `command` field has a value: 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 ### Skill-Referenced Workflows
When `workflow-file` starts with `skill:`: When `workflow-file` starts with `skill:`:
- The value is a skill reference (e.g., `skill:bmad-quick-dev-new-preview`), NOT a file path - 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 - 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 ### Agent-Based Workflows
When `command` field is empty: 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 - 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 - Do NOT show a slash command — show the code value and agent load instruction instead
Example presentation for empty command: Example presentation for empty command:
``` ```
Explain Concept (EC) 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 Agent: Tech Writer
Description: Create clear technical explanations with examples... Description: Create clear technical explanations with examples...
``` ```

2
tools/cli/installers/lib/core/installer.js
View File

@ -1415,7 +1415,7 @@ class Installer {
` Join our Discord: ${color.dim('https://discord.gg/gk8jAdXWmj')}`, ` Join our Discord: ${color.dim('https://discord.gg/gk8jAdXWmj')}`,
` Star us on GitHub: ${color.dim('https://github.com/bmad-code-org/BMAD-METHOD/')}`, ` Star us on GitHub: ${color.dim('https://github.com/bmad-code-org/BMAD-METHOD/')}`,
` Subscribe on YouTube: ${color.dim('https://www.youtube.com/@BMadCode')}`, ` 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!'); await prompts.note(lines.join('\n'), 'BMAD is ready to use!');