bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/.claude/settings.local.json +11 -1
  2. package/README.md +109 -161
  3. package/docs/BMad-Method-V6-Quick-Start.md +341 -0
  4. package/docs/index.md +229 -0
  5. package/docs/v4-to-v6-upgrade.md +9 -7
  6. package/package.json +1 -1
  7. package/src/modules/bmb/README.md +135 -73
  8. package/src/modules/bmb/workflows/create-agent/README.md +126 -243
  9. package/src/modules/bmb/workflows/create-agent/instructions.md +25 -12
  10. package/src/modules/bmb/workflows/create-module/README.md +163 -154
  11. package/src/modules/bmb/workflows/create-workflow/instructions.md +16 -8
  12. package/src/modules/bmm/README.md +86 -83
  13. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +45 -26
  14. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/README.md +100 -16
  15. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +42 -23
  16. package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +42 -28
  17. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +38 -27
  18. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +24 -34
  19. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +23 -34
  20. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +30 -14
  21. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +23 -34
  22. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +42 -24
  23. package/src/modules/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md +35 -22
  24. package/src/modules/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +73 -22
  25. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +45 -63
  26. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +46 -62
  27. package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +46 -53
  28. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +78 -47
  29. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +99 -82
  30. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +2 -0
  31. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +3 -0
  32. package/src/modules/bmm/workflows/README.md +149 -511
  33. package/src/modules/bmm/workflows/workflow-status/README.md +38 -19
  34. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +117 -24
  35. package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +2 -2
  36. package/src/modules/bmm/workflows/workflow-status/instructions.md +173 -111
  37. package/src/modules/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +49 -0
  38. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +31 -0
  39. package/src/modules/bmm/workflows/workflow-status/workflow.yaml +3 -3
  40. package/src/modules/cis/README.md +153 -0
  41. package/src/modules/cis/workflows/README.md +102 -30
  42. package/src/modules/cis/workflows/storytelling/instructions.md +10 -2
  43. package/tools/cli/installers/lib/core/manifest-generator.js +4 -1
  44. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.md +0 -30
  45. package/src/modules/cis/readme.md +0 -86
  46. /package/src/modules/bmm/sub-modules/claude-code/{readme.md → README.md} +0 -0
  47. /package/src/modules/bmm/workflows/3-solutioning/architecture/{readme.md → README.md} +0 -0
@@ -0,0 +1,341 @@
1
+ # BMad Method V6 Quick Start Guide
2
+
3
+ Get started with BMad Method v6 for your new greenfield project. This guide walks you through building software from scratch using AI-powered workflows.
4
+
5
+ ## TL;DR - The Quick Path
6
+
7
+ 1. **Install**: `npx bmad-method@alpha install`
8
+ 2. **Initialize**: Load Analyst agent → Run "workflow-init"
9
+ 3. **Plan**: Load PM agent → Run "prd" (or "tech-spec" for small projects)
10
+ 4. **Architect**: Load Architect agent → Run "create-architecture" (10+ stories only)
11
+ 5. **Build**: Load SM agent → Run workflows for each story → Load DEV agent → Implement
12
+ 6. **Always use fresh chats** for each workflow to avoid hallucinations
13
+
14
+ ---
15
+
16
+ ## What is BMad Method?
17
+
18
+ BMad Method (BMM) helps you build software through guided workflows with specialized AI agents. The process follows four phases:
19
+
20
+ 1. **Phase 1: Analysis** (Optional) - Brainstorming, Research, Product Brief
21
+ 2. **Phase 2: Planning** (Required) - Create your requirements (tech-spec or PRD)
22
+ 3. **Phase 3: Architecture** (Conditional) - Design the architecture for complex projects (10+ stories)
23
+ 4. **Phase 4: Implementation** (Required) - Build your software Epic by Epic, Story by Story
24
+
25
+ ## Installation
26
+
27
+ ```bash
28
+ # Install v6 Alpha to your project
29
+ npx bmad-method@alpha install
30
+ ```
31
+
32
+ The interactive installer will guide you through setup and create a `bmad/` folder with all agents and workflows.
33
+
34
+ ---
35
+
36
+ ## Getting Started
37
+
38
+ ### Step 1: Initialize Your Workflow
39
+
40
+ 1. **Load the Analyst agent** in your IDE - See your IDE-specific instructions in [docs/ide-info](../docs/ide-info/) for how to activate agents:
41
+ - [Claude Code](../docs/ide-info/claude-code.md)
42
+ - [VS Code/Cursor/Windsurf](../docs/ide-info/) - Check your IDE folder
43
+ - Other IDEs also supported
44
+ 2. **Wait for the agent's menu** to appear
45
+ 3. **Tell the agent**: "Run workflow-init" or type "\*workflow-init" or select the menu item number
46
+
47
+ #### What happens during workflow-init?
48
+
49
+ Workflows are interactive processes in V6 that replaced tasks and templates from prior versions. There are many types of workflows, and you can even create your own with the BMad Builder module. For the BMad Method, you'll be interacting with expert-designed workflows crafted to work with you to get the best out of both you and the LLM.
50
+
51
+ During workflow-init, you'll describe:
52
+
53
+ - Your project and its goals
54
+ - Whether there's an existing codebase or this is a new project
55
+ - The general size and complexity (you can adjust this later)
56
+
57
+ #### Project Scale Levels
58
+
59
+ Based on your description, the workflow will suggest a level and let you choose from:
60
+
61
+ **Greenfield Project Levels:**
62
+
63
+ - **Level 0** - Single atomic change (1 story) - bug fixes, typos, minor updates, single file changes
64
+ - **Level 1** - Small feature (1-10 stories) - simple additions, isolated features, one module
65
+ - **Level 2** - Medium feature set (5-15 stories) - dashboards, multiple related features, several modules
66
+ - **Level 3** - Complex integration (12-40 stories) - platform features, major integrations, architectural changes
67
+ - **Level 4** - Enterprise expansion (40+ stories) - multi-tenant, ecosystem changes, system-wide initiatives
68
+
69
+ #### What gets created?
70
+
71
+ Once you confirm your level, the `bmm-workflow-status.md` file will be created in your project's docs folder (assuming default install location). This file tracks your progress through all phases.
72
+
73
+ **Important notes:**
74
+
75
+ - Every level has different paths through the phases
76
+ - Story counts can still change based on overall complexity as you work
77
+ - For this guide, we'll assume a Level 2 project
78
+ - This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for Level 2+ complexity)
79
+
80
+ ### Step 2: Work Through Phases 1-3
81
+
82
+ After workflow-init completes, you'll work through the planning phases. **Important: Use fresh chats for each workflow to avoid context limitations.**
83
+
84
+ #### Checking Your Status
85
+
86
+ If you're unsure what to do next:
87
+
88
+ 1. Load any agent in a new chat
89
+ 2. Ask for "workflow-status"
90
+ 3. The agent will tell you the next recommended or required workflow
91
+
92
+ **Example response:**
93
+
94
+ ```
95
+ Phase 1 (Analysis) is entirely optional. All workflows are optional or recommended:
96
+ - brainstorm-project - optional
97
+ - research - optional
98
+ - product-brief - RECOMMENDED (but not required)
99
+
100
+ The next TRULY REQUIRED step is:
101
+ - PRD (Product Requirements Document) in Phase 2 - Planning
102
+ - Agent: pm
103
+ - Command: /bmad:bmm:workflows:prd
104
+ ```
105
+
106
+ #### How to Run Workflows in Phases 1-3
107
+
108
+ When an agent tells you to run a workflow (like `/bmad:bmm:workflows:prd`):
109
+
110
+ 1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](../docs/ide-info/) for your IDE's specific instructions
111
+ 2. **Wait for the menu** to appear
112
+ 3. **Tell the agent** to run it using any of these formats:
113
+ - Type the shorthand: `*prd`
114
+ - Say it naturally: "Let's create a new PRD"
115
+ - Select the menu number for "create-prd"
116
+
117
+ The agents in V6 are very good with fuzzy menu matching!
118
+
119
+ #### Quick Reference: Agent → Document Mapping
120
+
121
+ For v4 users or those who prefer to skip workflow-status guidance:
122
+
123
+ - **Analyst** → Brainstorming, Product Brief
124
+ - **PM** → PRD (10+ stories) OR tech-spec (1-10 stories)
125
+ - **UX-Designer** → UX Design Document (if UI-heavy)
126
+ - **Architect** → Architecture (10+ stories)
127
+
128
+ #### Phase 2: Planning - Creating the PRD
129
+
130
+ **For Level 2+ projects (10+ stories):**
131
+
132
+ 1. Load the **PM agent** in a new chat
133
+ 2. Tell it to run the PRD workflow
134
+ 3. Once complete, you'll have two files:
135
+ - **PRD.md** - Your Product Requirements Document
136
+ - **Epics.md** - High-level epics with stories
137
+
138
+ **For smaller projects (Levels 0-1):**
139
+
140
+ - Use **tech-spec** instead of PRD (no architecture needed)
141
+
142
+ #### Phase 2 (Optional): UX Design
143
+
144
+ If your project has a user interface:
145
+
146
+ 1. Load the **UX-Designer agent** in a new chat
147
+ 2. Tell it to run the UX design workflow
148
+ 3. After completion, run validations to ensure the Epics file stays updated
149
+
150
+ #### Phase 3: Architecture
151
+
152
+ **For Level 2+ projects only:**
153
+
154
+ 1. Load the **Architect agent** in a new chat
155
+ 2. Tell it to run the create-architecture workflow
156
+ 3. After completion, run validations to ensure the Epics file stays updated
157
+
158
+ #### Phase 3: Solutioning Gate Check (Highly Recommended)
159
+
160
+ Once architecture is complete:
161
+
162
+ 1. Load the **Architect agent** in a new chat
163
+ 2. Tell it to run "solutioning-gate-check"
164
+ 3. This validates cohesion across all your planning documents (PRD, UX, Architecture, Epics)
165
+ 4. This was called the "PO Master Checklist" in v4
166
+
167
+ **Why run this?** It ensures all your planning assets align properly before you start building.
168
+
169
+ #### Context Management Tips
170
+
171
+ - **Use 200k+ context models** for best results (Claude Sonnet 4.5, GPT-4, etc.)
172
+ - **Fresh chat for each workflow** - Brainstorming, Briefs, Research, and PRD generation are all context-intensive
173
+ - **No document sharding needed** - Unlike v4, you don't need to split documents
174
+ - **Web Bundles coming soon** - Will help save LLM tokens for users with limited plans
175
+
176
+ ### Step 3: Start Building (Phase 4 - Implementation)
177
+
178
+ Once planning and architecture are complete, you'll move to Phase 4. **Important: Each workflow below should be run in a fresh chat to avoid context limitations and hallucinations.**
179
+
180
+ #### 3.1 Initialize Sprint Planning
181
+
182
+ 1. **Start a new chat** with the **SM (Scrum Master) agent**
183
+ 2. Wait for the menu to appear
184
+ 3. Tell the agent: "Run sprint-planning"
185
+ 4. This creates your `sprint-status.yaml` file that tracks all epics and stories
186
+
187
+ #### 3.2 Create Epic Context (Optional but Recommended)
188
+
189
+ 1. **Start a new chat** with the **SM agent**
190
+ 2. Wait for the menu
191
+ 3. Tell the agent: "Run epic-tech-context"
192
+ 4. This creates technical context for the current epic before drafting stories
193
+
194
+ #### 3.3 Draft Your First Story
195
+
196
+ 1. **Start a new chat** with the **SM agent**
197
+ 2. Wait for the menu
198
+ 3. Tell the agent: "Run create-story"
199
+ 4. This drafts the story file from the epic
200
+
201
+ #### 3.4 Add Story Context (Optional but Recommended)
202
+
203
+ 1. **Start a new chat** with the **SM agent**
204
+ 2. Wait for the menu
205
+ 3. Tell the agent: "Run story-context"
206
+ 4. This creates implementation-specific technical context for the story
207
+
208
+ #### 3.5 Implement the Story
209
+
210
+ 1. **Start a new chat** with the **DEV agent**
211
+ 2. Wait for the menu
212
+ 3. Tell the agent: "Run dev-story"
213
+ 4. The DEV agent will implement the story and update the sprint status
214
+
215
+ #### 3.6 Review the Code (Optional but Recommended)
216
+
217
+ 1. **Start a new chat** with the **DEV agent**
218
+ 2. Wait for the menu
219
+ 3. Tell the agent: "Run code-review"
220
+ 4. The DEV agent performs quality validation (this was called QA in v4)
221
+
222
+ ### Step 4: Keep Going
223
+
224
+ For each subsequent story, repeat the cycle using **fresh chats** for each workflow:
225
+
226
+ 1. **New chat** → SM agent → "Run create-story"
227
+ 2. **New chat** → SM agent → "Run story-context"
228
+ 3. **New chat** → DEV agent → "Run dev-story"
229
+ 4. **New chat** → DEV agent → "Run code-review" (optional but recommended)
230
+
231
+ After completing all stories in an epic:
232
+
233
+ 1. **Start a new chat** with the **SM agent**
234
+ 2. Tell the agent: "Run retrospective"
235
+
236
+ **Why fresh chats?** Context-intensive workflows can cause hallucinations if you keep issuing commands in the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow.
237
+
238
+ ---
239
+
240
+ ## Understanding the Agents
241
+
242
+ Each agent is a specialized AI persona:
243
+
244
+ - **Analyst** - Initializes workflows and tracks progress
245
+ - **PM** - Creates requirements and specifications
246
+ - **UX-Designer** - If your project has a front end - this designer will help produce artifacts, come up with mock updates, and design a great look and feel with you giving it guidance.
247
+ - **Architect** - Designs system architecture
248
+ - **SM (Scrum Master)** - Manages sprints and creates stories
249
+ - **DEV** - Implements code and reviews work
250
+
251
+ ## How Workflows Work
252
+
253
+ 1. **Load an agent** - Open the agent file in your IDE to activate it
254
+ 2. **Wait for the menu** - The agent will present its available workflows
255
+ 3. **Tell the agent what to run** - Say "Run [workflow-name]"
256
+ 4. **Follow the prompts** - The agent guides you through each step
257
+
258
+ The agent creates documents, asks questions, and helps you make decisions throughout the process.
259
+
260
+ ## Project Tracking Files
261
+
262
+ BMad creates two files to track your progress:
263
+
264
+ **1. bmm-workflow-status.md**
265
+
266
+ - Shows which phase you're in and what's next
267
+ - Created by workflow-init
268
+ - Updated automatically as you progress through phases
269
+
270
+ **2. sprint-status.yaml** (Phase 4 only)
271
+
272
+ - Tracks all your epics and stories during implementation
273
+ - Critical for SM and DEV agents to know what to work on next
274
+ - Created by sprint-planning workflow
275
+ - Updated automatically as stories progress
276
+
277
+ **You don't need to edit these manually** - agents update them as you work.
278
+
279
+ ---
280
+
281
+ ## The Complete Flow Visualized
282
+
283
+ ```
284
+ Phase 1 (Optional) Phase 2 (Required) Phase 3 (Conditional) Phase 4 (Required)
285
+ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ ┌──────────────────┐
286
+ │ Analysis │ │ Planning │ │ Architecture │ │ Implementation │
287
+ │ │ │ │ │ │ │ │
288
+ │ • Brainstorm │ │ Level 0-1: │ │ Level 2+: │ │ Per Epic: │
289
+ │ • Research │───────▶│ • tech-spec │───────▶│ • architecture │────────▶│ • epic context │
290
+ │ • Brief │ │ │ │ • gate-check │ │ │
291
+ │ │ │ Level 2+: │ │ │ │ Per Story: │
292
+ │ (Analyst) │ │ • PRD │ │ (Architect) │ │ • create-story │
293
+ │ │ │ • UX (opt) │ │ │ │ • story-context │
294
+ │ │ │ │ │ │ │ • dev-story │
295
+ │ │ │ (PM, UX) │ │ │ │ • code-review │
296
+ │ │ │ │ │ │ │ │
297
+ │ │ │ │ │ │ │ (SM, DEV) │
298
+ └─────────────────┘ └─────────────────┘ └─────────────────┘ └──────────────────┘
299
+ ```
300
+
301
+ ## Common Questions
302
+
303
+ **Q: Do I always need architecture?**
304
+ A: Only for larger projects (10+ stories). Small projects can skip straight from tech-spec to implementation.
305
+
306
+ **Q: Can I change my plan later?**
307
+ A: Yes! The SM agent has a "correct-course" workflow for handling scope changes.
308
+
309
+ **Q: What if I want to brainstorm first?**
310
+ A: Load the Analyst agent and tell it to "Run brainstorm-project" before running workflow-init.
311
+
312
+ **Q: Why do I need fresh chats for each workflow?**
313
+ A: Context-intensive workflows can cause hallucinations if run in sequence. Fresh chats ensure maximum context capacity.
314
+
315
+ **Q: Can I skip workflow-init and workflow-status?**
316
+ A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directly to the workflows you need.
317
+
318
+ ## Getting Help
319
+
320
+ - **During workflows**: Agents guide you with questions and explanations
321
+ - **Community**: [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues
322
+ - **Complete guide**: [BMM Workflows README](../src/modules/bmm/workflows/README.md)
323
+ - **YouTube tutorials**: [BMad Code Channel](https://www.youtube.com/@BMadCode)
324
+
325
+ ---
326
+
327
+ ## Key Takeaways
328
+
329
+ ✅ **Always use fresh chats** - Load agents in new chats for each workflow to avoid context issues
330
+ ✅ **Let workflow-status guide you** - Load any agent and ask for status when unsure what's next
331
+ ✅ **Level matters** - Small projects (0-1) use tech-spec, larger projects (2+) need PRD and architecture
332
+ ✅ **Tracking is automatic** - The status files update themselves, no manual editing needed
333
+ ✅ **Agents are flexible** - Use menu numbers, shortcuts (\*prd), or natural language
334
+
335
+ **Ready to start building?** Install BMad, load the Analyst, run workflow-init, and let the agents guide you!
336
+
337
+ ---
338
+
339
+ **Version**: v6-alpha
340
+ **Last Updated**: 2025-01
341
+ **For detailed documentation**: [Complete BMM Workflows Guide](../src/modules/bmm/workflows/README.md)
package/docs/index.md ADDED
@@ -0,0 +1,229 @@
1
+ # BMad Documentation Index
2
+
3
+ Complete map of all BMad Method v6 documentation with recommended reading paths.
4
+
5
+ ---
6
+
7
+ ## 🎯 Getting Started (Start Here!)
8
+
9
+ **New users:** Start with one of these based on your situation:
10
+
11
+ | Your Situation | Start Here | Then Read |
12
+ | ---------------------- | ---------------------------------------------------- | ------------------------------------------------------------- |
13
+ | **Brand new to BMad** | [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) | [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) |
14
+ | **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) |
15
+ | **Brownfield project** | [Brownfield Guide](./bmad-brownfield-guide.md) | [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) |
16
+
17
+ ---
18
+
19
+ ## 📋 Core Documentation
20
+
21
+ ### Project-Level Docs (Root)
22
+
23
+ - **[README.md](../README.md)** - Main project overview, feature summary, and module introductions
24
+ - **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
25
+ - **[CHANGELOG.md](../CHANGELOG.md)** - Version history and breaking changes
26
+ - **[CLAUDE.md](../CLAUDE.md)** - Claude Code specific guidelines for this project
27
+
28
+ ### Installation & Setup
29
+
30
+ - **[BMad Method V6 Quick Start](./BMad-Method-V6-Quick-Start.md)** - Step-by-step guide to building your first project with BMM
31
+ - **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
32
+ - **[Brownfield Guide](./bmad-brownfield-guide.md)** - Guidance for working with existing codebases
33
+
34
+ ---
35
+
36
+ ## 🏗️ Module Documentation
37
+
38
+ ### BMad Method (BMM) - Software & Game Development
39
+
40
+ The flagship module for agile AI-driven development.
41
+
42
+ - **[BMM Module README](../src/modules/bmm/README.md)** - Module overview, agents, and structure
43
+ - **[BMM Workflows Guide](../src/modules/bmm/workflows/README.md)** - **ESSENTIAL READING** - Complete v6 workflow system explanation
44
+ - Phase 1: Analysis (optional)
45
+ - Phase 2: Planning (required, scale-adaptive)
46
+ - Phase 3: Solutioning (complex projects)
47
+ - Phase 4: Implementation (iterative)
48
+ - **[Test Architect Guide](../src/modules/bmm/testarch/README.md)** - Testing strategy and quality assurance
49
+
50
+ ### BMad Builder (BMB) - Create Custom Solutions
51
+
52
+ Build your own agents, workflows, and modules.
53
+
54
+ - **[BMB Module README](../src/modules/bmb/README.md)** - Module overview and capabilities
55
+ - **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents
56
+
57
+ ### Creative Intelligence Suite (CIS) - Innovation & Creativity
58
+
59
+ AI-powered creative thinking and brainstorming.
60
+
61
+ - **[CIS Module README](../src/modules/cis/README.md)** - Module overview and workflows
62
+
63
+ ---
64
+
65
+ ## 🖥️ IDE-Specific Guides
66
+
67
+ Instructions for loading agents and running workflows in your development environment.
68
+
69
+ **Popular IDEs:**
70
+
71
+ - [Claude Code](./ide-info/claude-code.md)
72
+ - [Cursor](./ide-info/cursor.md)
73
+ - [VS Code](./ide-info/windsurf.md)
74
+
75
+ **Other Supported IDEs:**
76
+
77
+ - [Augment](./ide-info/auggie.md)
78
+ - [Cline](./ide-info/cline.md)
79
+ - [Codex](./ide-info/codex.md)
80
+ - [Crush](./ide-info/crush.md)
81
+ - [Gemini](./ide-info/gemini.md)
82
+ - [GitHub Copilot](./ide-info/github-copilot.md)
83
+ - [IFlow](./ide-info/iflow.md)
84
+ - [Kilo](./ide-info/kilo.md)
85
+ - [OpenCode](./ide-info/opencode.md)
86
+ - [Qwen](./ide-info/qwen.md)
87
+ - [Roo](./ide-info/roo.md)
88
+ - [Trae](./ide-info/trae.md)
89
+
90
+ **Key concept:** Every reference to "load an agent" or "activate an agent" in the main docs links to the [ide-info](./ide-info/) directory for IDE-specific instructions.
91
+
92
+ ---
93
+
94
+ ## 🔧 Advanced Topics
95
+
96
+ ### Installation & Bundling
97
+
98
+ - [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
99
+ - [Installers & Platforms Reference](./installers-bundlers/installers-modules-platforms-reference.md) - CLI tool and platform support
100
+ - [Web Bundler Usage](./installers-bundlers/web-bundler-usage.md) - Creating web-compatible bundles
101
+
102
+ ---
103
+
104
+ ## 📊 Documentation Map
105
+
106
+ ```
107
+ docs/
108
+ ├── index.md (this file)
109
+ ├── BMad-Method-V6-Quick-Start.md
110
+ ├── v4-to-v6-upgrade.md
111
+ ├── bmad-brownfield-guide.md
112
+ ├── ide-info/
113
+ │ ├── claude-code.md
114
+ │ ├── cursor.md
115
+ │ ├── windsurf.md
116
+ │ └── [14+ other IDEs]
117
+ └── installers-bundlers/
118
+ ├── ide-injections.md
119
+ ├── installers-modules-platforms-reference.md
120
+ └── web-bundler-usage.md
121
+
122
+ src/
123
+ ├── modules/
124
+ │ ├── bmm/
125
+ │ │ ├── README.md
126
+ │ │ ├── workflows/README.md (ESSENTIAL)
127
+ │ │ └── testarch/README.md
128
+ │ ├── bmb/
129
+ │ │ ├── README.md
130
+ │ │ └── workflows/create-agent/README.md
131
+ │ └── cis/
132
+ │ └── README.md
133
+ ```
134
+
135
+ ---
136
+
137
+ ## 🎓 Recommended Reading Paths
138
+
139
+ ### Path 1: Brand New to BMad (Software Project)
140
+
141
+ 1. [README.md](../README.md) - Understand the vision
142
+ 2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Get hands-on
143
+ 3. [BMM Module README](../src/modules/bmm/README.md) - Understand agents
144
+ 4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
145
+ 5. [Your IDE guide](./ide-info/) - Optimize your workflow
146
+
147
+ ### Path 2: Game Development Project
148
+
149
+ 1. [README.md](../README.md) - Understand the vision
150
+ 2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Get hands-on
151
+ 3. [BMM Module README](../src/modules/bmm/README.md) - Game agents are included
152
+ 4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Game workflows
153
+ 5. [Your IDE guide](./ide-info/) - Optimize your workflow
154
+
155
+ ### Path 3: Upgrading from v4
156
+
157
+ 1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
158
+ 2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Reorient yourself
159
+ 3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Learn new v6 workflows
160
+
161
+ ### Path 4: Working with Existing Codebase (Brownfield)
162
+
163
+ 1. [Brownfield Guide](./bmad-brownfield-guide.md) - Approach for legacy code
164
+ 2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Follow the process
165
+ 3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
166
+
167
+ ### Path 5: Building Custom Solutions
168
+
169
+ 1. [BMB Module README](../src/modules/bmb/README.md) - Understand capabilities
170
+ 2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
171
+ 3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure
172
+
173
+ ### Path 6: Contributing to BMad
174
+
175
+ 1. [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines
176
+ 2. Relevant module README - Understand the area you're contributing to
177
+ 3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards
178
+
179
+ ---
180
+
181
+ ## 🔍 Quick Reference
182
+
183
+ **What is each module for?**
184
+
185
+ - **BMM** - AI-driven software and game development
186
+ - **BMB** - Create custom agents and workflows
187
+ - **CIS** - Creative thinking and brainstorming
188
+
189
+ **How do I load an agent?**
190
+ → See [ide-info](./ide-info/) folder for your IDE
191
+
192
+ **I'm stuck, what's next?**
193
+ → Check the [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) or run `workflow-status`
194
+
195
+ **I want to contribute**
196
+ → Start with [CONTRIBUTING.md](../CONTRIBUTING.md)
197
+
198
+ ---
199
+
200
+ ## 📚 Important Concepts
201
+
202
+ ### Fresh Chats
203
+
204
+ Each workflow should run in a fresh chat with the specified agent to avoid context limitations. This is emphasized throughout the docs because it's critical to successful workflows.
205
+
206
+ ### Scale Levels
207
+
208
+ BMM adapts to project complexity (Levels 0-4). Documentation is scale-adaptive - you only need what's relevant to your project size.
209
+
210
+ ### Update-Safe Customization
211
+
212
+ All agent customizations go in `bmad/_cfg/agents/` and survive updates. See your IDE guide and module README for details.
213
+
214
+ ---
215
+
216
+ ## 🆘 Getting Help
217
+
218
+ - **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
219
+ - #general-dev - Technical questions
220
+ - #bugs-issues - Bug reports
221
+ - **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
222
+ - **YouTube**: [BMad Code Channel](https://www.youtube.com/@BMadCode)
223
+
224
+ ---
225
+
226
+ **Version**: v6-alpha
227
+ **Last Updated**: 2025-10-30
228
+
229
+ ---
@@ -196,14 +196,16 @@ If you're using:
196
196
 
197
197
  After installation:
198
198
 
199
- ```bash
200
- # Start the analyst and tell the analyst after it loads - claude code instructions:
201
- claude # wait for claude to launch in terminal
202
- - `/analyst` # wait for analyst greeting and menu
203
- - `*workflow-init` # v6 now supports much better natural language fuzzy matching - so you could also say `workflow init` or possibly `please init the workflow`
204
- ```
199
+ 1. **Load the Analyst agent** - See your IDE-specific instructions in [docs/ide-info](./ide-info/) for how to activate agents:
200
+ - [Claude Code](./ide-info/claude-code.md)
201
+ - [Cursor](./ide-info/cursor.md)
202
+ - [VS Code/Windsurf](./ide-info/) - Check your IDE folder
203
+
204
+ 2. **Wait for the agent's menu** to appear
205
+
206
+ 3. **Tell the agent**: `*workflow-init` - v6 supports excellent natural language fuzzy matching, so you could also say "workflow init" or "please init the workflow"
205
207
 
206
- Since you are migrating an existing project from v4, its most likely **Level 3 or 4** you will want to suggest when asked - if you've already completed PRD/architecture in v4.
208
+ Since you are migrating an existing project from v4, it's most likely **Level 3 or 4** you will want to suggest when asked - if you've already completed PRD/architecture in v4.
207
209
 
208
210
  ---
209
211
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "bmad-method",
4
- "version": "6.0.0-alpha.2",
4
+ "version": "6.0.0-alpha.3",
5
5
  "description": "Breakthrough Method of Agile AI-driven Development",
6
6
  "keywords": [
7
7
  "agile",