From e74dd8040d74f0d44073bd88f1449d3ca76ed5e1 Mon Sep 17 00:00:00 2001 From: Loic Duong <34233006+loicduong@users.noreply.github.com> Date: Sat, 30 May 2026 10:34:00 +0700 Subject: [PATCH] docs: refresh skill metadata references (#2439) * docs: refresh skill metadata references * docs: link BMad customization guide --- docs/explanation/party-mode.md | 2 +- docs/reference/agents.md | 17 ++++++++--------- docs/reference/commands.md | 11 ++++++----- docs/reference/core-tools.md | 24 ++++++++++++++++++++++++ 4 files changed, 39 insertions(+), 15 deletions(-) diff --git a/docs/explanation/party-mode.md b/docs/explanation/party-mode.md index e2b8bc007..b44afac24 100644 --- a/docs/explanation/party-mode.md +++ b/docs/explanation/party-mode.md @@ -9,7 +9,7 @@ Get all your AI agents in one conversation. ## What is Party Mode? -Run `bmad-party-mode` and you've got your whole AI team in one room - PM, Architect, Dev, UX Designer, whoever you need. BMad Master orchestrates, picking relevant agents per message. Agents respond in character, agree, disagree, and build on each other's ideas. +Run `bmad-party-mode` and you've got your whole AI team in one room - PM, Architect, Dev, UX Designer, whoever you need. Party Mode orchestrates the discussion, picking relevant installed agents per message. Agents respond in character, agree, disagree, and build on each other's ideas. The conversation continues as long as you want. Ask follow-ups, push back on answers, redirect the discussion - it's a real back-and-forth with your agents until you're done. diff --git a/docs/reference/agents.md b/docs/reference/agents.md index bdc7d0871..3771918e8 100644 --- a/docs/reference/agents.md +++ b/docs/reference/agents.md @@ -11,18 +11,18 @@ This page lists the default BMM (Agile suite) agents that install with BMad Meth ## Notes -- Each agent is available as a skill, generated by the installer. The skill ID (e.g., `bmad-dev`) is used to invoke the agent. -- Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu. +- Each agent is available as a skill, generated by the installer. The skill ID (e.g., `bmad-agent-dev`) is used to invoke the agent. +- Triggers are the short menu codes (e.g., `PRD`) and fuzzy matches shown in each agent menu. - QA test generation is handled by the `bmad-qa-generate-e2e-tests` workflow skill, available through the Developer agent. The full Test Architect (TEA) lives in its own module. | Agent | Skill ID | Triggers | Primary workflows | | --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- | -| Analyst (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorm, Market Research, Domain Research, Technical Research, Create Brief, PRFAQ Challenge, Document Project | -| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course | -| Architect (Winston) | `bmad-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness | +| Analyst (Mary) | `bmad-agent-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorm, Market Research, Domain Research, Technical Research, Create Brief, PRFAQ Challenge, Document Project | +| Product Manager (John) | `bmad-agent-pm` | `PRD`, `CE`, `IR`, `CC` | Create/Update/Validate PRD, Create Epics and Stories, Implementation Readiness, Correct Course | +| Architect (Winston) | `bmad-agent-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness | | Developer (Amelia) | `bmad-agent-dev` | `DS`, `QD`, `QA`, `CR`, `SP`, `CS`, `ER`, `IN` | Dev Story, Quick Dev, QA Test Generation, Code Review, Sprint Planning, Create Story, Epic Retrospective, [Forensic Investigation](../explanation/forensic-investigation.md) | -| UX Designer (Sally) | `bmad-ux-designer` | `CU` | Create UX Design | -| Technical Writer (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept | +| UX Designer (Sally) | `bmad-agent-ux-designer` | `CU` | Create UX Design | +| Technical Writer (Paige) | `bmad-agent-tech-writer` | `DP`, `WD`, `MG`, `VD`, `EC` | Document Project, Write Document, Mermaid Generate, Validate Doc, Explain Concept | ## Trigger Types @@ -32,7 +32,7 @@ Agent menu triggers use two different invocation types. Knowing which type a tri Most triggers load a structured workflow file. Type the trigger code and the agent starts the workflow, prompting you for input at each step. -Examples: `CP` (Create PRD), `DS` (Dev Story), `CA` (Create Architecture), `QD` (Quick Dev) +Examples: `PRD` (Create, update, or validate PRD), `DS` (Dev Story), `CA` (Create Architecture), `QD` (Quick Dev) ### Conversational triggers (arguments required) @@ -41,7 +41,6 @@ Some triggers start a free-form conversation instead of a structured workflow. T | Agent | Trigger | What to provide | | --- | --- | --- | | Technical Writer (Paige) | `WD` | Description of the document to write | -| Technical Writer (Paige) | `US` | Preferences or conventions to add to standards | | Technical Writer (Paige) | `MG` | Diagram description and type (sequence, flowchart, etc.) | | Technical Writer (Paige) | `VD` | Document to validate and focus areas | | Technical Writer (Paige) | `EC` | Concept name to explain | diff --git a/docs/reference/commands.md b/docs/reference/commands.md index 2934a0ec7..dc11760b5 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -42,8 +42,8 @@ The installer writes skill files into an IDE-specific directory inside your proj | IDE / CLI | Skills directory | | --- | --- | | Claude Code | `.claude/skills/` | -| Cursor | `.cursor/skills/` | -| Windsurf | `.windsurf/skills/` | +| Cursor | `.agents/skills/` | +| Windsurf | `.agents/skills/` | | Other IDEs | See the installer output for the target path | Each skill is a directory containing a `SKILL.md` file. For example, a Claude Code installation looks like: @@ -80,8 +80,8 @@ Agent skills load a specialized AI persona with a defined role, communication st | Example skill | Agent | Role | | --- | --- | --- | | `bmad-agent-dev` | Amelia (Developer) | Implements stories with strict adherence to specs | -| `bmad-pm` | John (Product Manager) | Creates and validates PRDs | -| `bmad-architect` | Winston (Architect) | Designs system architecture | +| `bmad-agent-pm` | John (Product Manager) | Creates and validates PRDs | +| `bmad-agent-architect` | Winston (Architect) | Designs system architecture | See [Agents](./agents.md) for the full list of default agents and their triggers. @@ -94,6 +94,7 @@ Workflow skills run a structured, multi-step process without loading an agent pe | `bmad-product-brief` | Create or update a product brief — guided discovery when your concept is clear | | `bmad-prfaq` | [Working Backwards PRFAQ](../explanation/analysis-phase.md#prfaq-working-backwards) challenge to stress-test your product concept | | `bmad-prd` | Create, update, or validate a Product Requirements Document | +| `bmad-ux` | Design user experience | | `bmad-create-architecture` | Design system architecture | | `bmad-create-epics-and-stories` | Create epics and stories | | `bmad-dev-story` | Implement a story | @@ -120,7 +121,7 @@ bmad-help What are my options for UX design? **Other Core Tasks and Tools** -The core module includes 11 built-in tools — reviews, compression, brainstorming, document management, and more. See [Core Tools](./core-tools.md) for the complete reference. +The core module includes 12 built-in tools — specs, reviews, brainstorming, customization, document management, and more. See [Core Tools](./core-tools.md) for the complete reference. ## Naming Convention diff --git a/docs/reference/core-tools.md b/docs/reference/core-tools.md index c8f7b3c77..d2625d190 100644 --- a/docs/reference/core-tools.md +++ b/docs/reference/core-tools.md @@ -26,6 +26,7 @@ Run any core tool by typing its skill name (e.g., `bmad-help`) in your IDE. No a | [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Task | Structural editing — cuts, merges, and reorganization | | [`bmad-shard-doc`](#bmad-shard-doc) | Task | Split large markdown files into organized sections | | [`bmad-index-docs`](#bmad-index-docs) | Task | Generate or update an index of all docs in a folder | +| [`bmad-customize`](#bmad-customize) | Task | Create and verify BMad customization overrides | ## bmad-help @@ -295,3 +296,26 @@ Run both `bmad-review-adversarial-general` and `bmad-review-edge-case-hunter` to **Input:** Target folder path **Output:** `index.md` with organized file listings, relative links, and brief descriptions + +## bmad-customize + +**Create and verify customization overrides.** — Helps you change how an installed BMad agent or workflow behaves without hand-authoring TOML. + +**Use it when:** + +- You want to change an agent or workflow behavior +- You need to add persistent facts, activation hooks, or custom menu items +- You want the right override scope selected and verified automatically + +**How it works:** + +1. Scans installed BMad skills for customizable surfaces +2. Selects the right scope for your requested change +3. Writes override files under `_bmad/custom/` +4. Verifies the merged configuration + +**Input:** Natural language description of the customization you want + +**Output:** TOML override files under `_bmad/custom/` + +For a detailed guide on customizing BMad, see [How to Customize BMad](../how-to/customize-bmad.md). \ No newline at end of file