bmad-method 4.7.0 → 4.8.0
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.
- package/.prettierignore +0 -1
- package/CHANGELOG.md +17 -0
- package/README.md +18 -1
- package/bmad-core/agents/analyst.md +11 -8
- package/bmad-core/agents/architect.md +10 -7
- package/bmad-core/agents/bmad-master.md +13 -11
- package/bmad-core/agents/bmad-orchestrator.md +3 -0
- package/bmad-core/agents/dev.md +19 -14
- package/bmad-core/agents/pm.md +8 -5
- package/bmad-core/agents/po.md +13 -10
- package/bmad-core/agents/qa.md +8 -5
- package/bmad-core/agents/sm.md +15 -25
- package/bmad-core/agents/ux-expert.md +11 -8
- package/bmad-core/core-config.yml +24 -0
- package/bmad-core/data/bmad-kb.md +6 -3
- package/bmad-core/tasks/create-next-story.md +63 -45
- package/bmad-core/utils/file-resolution-context.md +10 -0
- package/dist/agents/analyst.txt +404 -17
- package/dist/agents/architect.txt +14 -6
- package/dist/agents/bmad-master.txt +485 -109
- package/dist/agents/bmad-orchestrator.txt +402 -22
- package/dist/agents/dev.txt +26 -34
- package/dist/agents/pm.txt +9 -5
- package/dist/agents/po.txt +10 -10
- package/dist/agents/qa.txt +4 -4
- package/dist/agents/sm.txt +74 -63
- package/dist/agents/ux-expert.txt +9 -7
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +49 -20
- package/dist/expansion-packs/expansion-creator/agents/bmad-the-creator.txt +6 -3
- package/dist/teams/team-all.txt +561 -158
- package/dist/teams/team-fullstack.txt +457 -57
- package/dist/teams/team-ide-minimal.txt +516 -133
- package/dist/teams/team-no-ui.txt +448 -50
- package/docs/bmad-workflow-guide.md +1 -1
- package/docs/claude-code-guide.md +1 -1
- package/docs/core-architecture.md +4 -4
- package/docs/cursor-guide.md +1 -1
- package/docs/roo-code-guide.md +1 -1
- package/docs/user-guide.md +1 -1
- package/docs/windsurf-guide.md +1 -1
- package/expansion-packs/expansion-creator/templates/agent-tmpl.md +4 -1
- package/package.json +1 -1
- package/tools/builders/web-builder.js +158 -94
- package/tools/installer/bin/bmad.js +34 -2
- package/tools/installer/lib/file-manager.js +3 -2
- package/tools/installer/lib/ide-setup.js +39 -123
- package/tools/installer/lib/installer.js +13 -1
- package/tools/installer/package.json +1 -1
- /package/bmad-core/{templates/web-agent-startup-instructions-template.md → utils/web-agent-startup-instructions.md} +0 -0
|
@@ -4,45 +4,42 @@
|
|
|
4
4
|
|
|
5
5
|
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
|
|
6
6
|
|
|
7
|
-
## Inputs for this Task
|
|
8
|
-
|
|
9
|
-
- Access to the project's documentation repository, specifically:
|
|
10
|
-
- `docs/index.md` (hereafter "Index Doc")
|
|
11
|
-
- All Epic files - located in one of these locations:
|
|
12
|
-
- Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
|
|
13
|
-
- Secondary: `docs/epics/epic-{n}-{description}.md`
|
|
14
|
-
- User-specified location if not found in above paths
|
|
15
|
-
- Existing story files in `docs/stories/`
|
|
16
|
-
- Main PRD (hereafter "PRD Doc")
|
|
17
|
-
- Main Architecture Document (hereafter "Main Arch Doc")
|
|
18
|
-
- Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
|
|
19
|
-
- Project Structure Guide (`docs/project-structure.md`)
|
|
20
|
-
- Operational Guidelines Document (`docs/operational-guidelines.md`)
|
|
21
|
-
- Technology Stack Document (`docs/tech-stack.md`)
|
|
22
|
-
- Data Models Document (as referenced in Index Doc)
|
|
23
|
-
- API Reference Document (as referenced in Index Doc)
|
|
24
|
-
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
|
|
25
|
-
- The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
|
|
26
|
-
- The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
|
|
27
|
-
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
|
|
28
|
-
|
|
29
7
|
## Task Execution Instructions
|
|
30
8
|
|
|
9
|
+
### 0. Load Core Configuration
|
|
10
|
+
|
|
11
|
+
[[LLM: CRITICAL - This MUST be your first step]]
|
|
12
|
+
|
|
13
|
+
- Load `.bmad-core/core-config.yml` from the project root
|
|
14
|
+
- If the file does not exist:
|
|
15
|
+
- HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
|
|
16
|
+
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
|
|
17
|
+
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
|
18
|
+
Please add and configure core-config.yml before proceeding."
|
|
19
|
+
- Extract the following key configurations:
|
|
20
|
+
- `dev-story-location`: Where to save story files
|
|
21
|
+
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
22
|
+
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
|
|
23
|
+
- `prd.prdShardedLocation`: Location of sharded epic files
|
|
24
|
+
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
|
25
|
+
- `architecture.architectureVersion`: Architecture document version
|
|
26
|
+
- `architecture.architectureSharded`: Whether architecture is sharded
|
|
27
|
+
- `architecture.architecture-file`: Location of monolithic architecture
|
|
28
|
+
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
|
29
|
+
|
|
31
30
|
### 1. Identify Next Story for Preparation
|
|
32
31
|
|
|
33
32
|
#### 1.1 Locate Epic Files
|
|
34
33
|
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
- If
|
|
38
|
-
- If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
|
|
39
|
-
- Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
|
|
34
|
+
- Based on `prdSharded` from config:
|
|
35
|
+
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
|
36
|
+
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
|
|
40
37
|
|
|
41
38
|
#### 1.2 Review Existing Stories
|
|
42
39
|
|
|
43
|
-
-
|
|
40
|
+
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
|
|
41
|
+
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
|
44
42
|
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
|
45
|
-
|
|
46
43
|
- Verify its `Status` is 'Done' (or equivalent).
|
|
47
44
|
- If not 'Done', present an alert to the user:
|
|
48
45
|
|
|
@@ -60,17 +57,17 @@ To identify the next logical story based on project progress and epic definition
|
|
|
60
57
|
```
|
|
61
58
|
|
|
62
59
|
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
|
63
|
-
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}
|
|
64
|
-
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}
|
|
60
|
+
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
|
|
61
|
+
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
|
|
65
62
|
|
|
66
63
|
- **If no story files exist in `docs/stories/`:**
|
|
67
64
|
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
|
|
68
65
|
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
|
|
69
66
|
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
|
70
67
|
|
|
71
|
-
### 2. Gather Core Story Requirements (from Epic
|
|
68
|
+
### 2. Gather Core Story Requirements (from Epic)
|
|
72
69
|
|
|
73
|
-
- For the identified story,
|
|
70
|
+
- For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
|
|
74
71
|
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
|
|
75
72
|
- Keep a record of this original epic-defined scope for later deviation analysis.
|
|
76
73
|
|
|
@@ -79,7 +76,7 @@ To identify the next logical story based on project progress and epic definition
|
|
|
79
76
|
[[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
|
|
80
77
|
|
|
81
78
|
- If this is not the first story (i.e., previous story exists):
|
|
82
|
-
- Read the previous story
|
|
79
|
+
- Read the previous sequential story from `docs/stories`
|
|
83
80
|
- Pay special attention to:
|
|
84
81
|
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
|
|
85
82
|
- Any deviations from planned implementation
|
|
@@ -88,18 +85,30 @@ To identify the next logical story based on project progress and epic definition
|
|
|
88
85
|
- Any "lessons learned" or notes for future stories
|
|
89
86
|
- Extract relevant insights that might inform the current story's preparation
|
|
90
87
|
|
|
91
|
-
### 4. Gather & Synthesize Architecture Context
|
|
88
|
+
### 4. Gather & Synthesize Architecture Context
|
|
89
|
+
|
|
90
|
+
[[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
|
|
92
91
|
|
|
93
|
-
|
|
92
|
+
#### 4.1 Determine Architecture Document Strategy
|
|
94
93
|
|
|
95
|
-
|
|
94
|
+
Based on configuration loaded in Step 0:
|
|
96
95
|
|
|
97
|
-
-
|
|
98
|
-
-
|
|
96
|
+
- **If `architectureVersion: v4` and `architectureSharded: true`**:
|
|
97
|
+
- Read `{architectureShardedLocation}/index.md` to understand available documentation
|
|
98
|
+
- Follow the structured reading order in section 4.2 below
|
|
99
|
+
|
|
100
|
+
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
|
101
|
+
- Load the monolithic architecture from `architecture-file`
|
|
102
|
+
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
|
103
|
+
|
|
104
|
+
- **If `architectureVersion` is NOT v4**:
|
|
105
|
+
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
|
106
|
+
- If `architectureSharded: true`: Search sharded files by filename relevance
|
|
107
|
+
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
|
|
99
108
|
|
|
100
|
-
#### 4.2 Recommended Reading Order Based on Story Type
|
|
109
|
+
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
|
101
110
|
|
|
102
|
-
[[LLM:
|
|
111
|
+
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
|
|
103
112
|
|
|
104
113
|
**For ALL Stories:**
|
|
105
114
|
|
|
@@ -108,9 +117,18 @@ To identify the next logical story based on project progress and epic definition
|
|
|
108
117
|
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
|
|
109
118
|
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
|
|
110
119
|
|
|
111
|
-
**For Backend/API Stories, additionally read:**
|
|
120
|
+
**For Backend/API Stories, additionally read:**
|
|
121
|
+
5. `docs/architecture/data-models.md` - Data structures and validation rules
|
|
122
|
+
6. `docs/architecture/database-schema.md` - Database design and relationships
|
|
123
|
+
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
|
|
124
|
+
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
|
|
125
|
+
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
|
|
112
126
|
|
|
113
|
-
**For Frontend/UI Stories, additionally read:**
|
|
127
|
+
**For Frontend/UI Stories, additionally read:**
|
|
128
|
+
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
|
|
129
|
+
6. `docs/architecture/components.md` - Specific component designs
|
|
130
|
+
7. `docs/architecture/core-workflows.md` - User interaction flows
|
|
131
|
+
8. `docs/architecture/data-models.md` - Frontend data handling
|
|
114
132
|
|
|
115
133
|
**For Full-Stack Stories:**
|
|
116
134
|
|
|
@@ -143,7 +161,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
143
161
|
|
|
144
162
|
### 6. Populate Story Template with Full Context
|
|
145
163
|
|
|
146
|
-
- Create a new story file: `
|
|
164
|
+
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
|
|
147
165
|
- Use the Story Template to structure the file.
|
|
148
166
|
- Fill in:
|
|
149
167
|
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
|
@@ -190,7 +208,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
190
208
|
- Verify all source references are included for technical details
|
|
191
209
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
192
210
|
- Update status to "Draft"
|
|
193
|
-
- Save the story file to `
|
|
211
|
+
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
|
|
194
212
|
|
|
195
213
|
### 9. Report Completion
|
|
196
214
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# File Resolution Context
|
|
2
|
+
|
|
3
|
+
Update the installer/upgrader so that when agents are added to a project (under Add these two lines to any agent's `activation-instructions` for ide installation:
|
|
4
|
+
|
|
5
|
+
```yaml
|
|
6
|
+
- IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
7
|
+
- REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
and add `root: .bmad-core` as the first root yml property.
|
package/dist/agents/analyst.txt
CHANGED
|
@@ -76,13 +76,13 @@ persona:
|
|
|
76
76
|
startup:
|
|
77
77
|
- Greet the user with your name and role, and inform of the *help command.
|
|
78
78
|
commands:
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
79
|
+
- help: Show numbered list of the following commands to allow selection
|
|
80
|
+
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
|
|
81
|
+
- create-doc {template}: Create doc (no template = show available templates)
|
|
82
|
+
- brainstorm {topic}: Facilitate structured brainstorming session
|
|
83
|
+
- research {topic}: Generate deep research prompt for investigation
|
|
84
|
+
- elicit: Run advanced elicitation to clarify requirements
|
|
85
|
+
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
|
86
86
|
dependencies:
|
|
87
87
|
tasks:
|
|
88
88
|
- brainstorming-techniques
|
|
@@ -820,6 +820,8 @@ Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
|
|
820
820
|
==================== START: templates#project-brief-tmpl ====================
|
|
821
821
|
# Project Brief: {{Project Name}}
|
|
822
822
|
|
|
823
|
+
[[LLM: The default path and filename unless specified is docs/brief.md]]
|
|
824
|
+
|
|
823
825
|
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
824
826
|
|
|
825
827
|
Start by asking the user which mode they prefer:
|
|
@@ -1051,6 +1053,8 @@ These replace the standard elicitation options when working on project brief doc
|
|
|
1051
1053
|
==================== START: templates#market-research-tmpl ====================
|
|
1052
1054
|
# Market Research Report: {{Project/Product Name}}
|
|
1053
1055
|
|
|
1056
|
+
[[LLM: The default path and filename unless specified is docs/market-research.md]]
|
|
1057
|
+
|
|
1054
1058
|
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
|
|
1055
1059
|
|
|
1056
1060
|
## Executive Summary
|
|
@@ -1315,6 +1319,8 @@ These replace the standard elicitation options when working on market research d
|
|
|
1315
1319
|
==================== START: templates#competitor-analysis-tmpl ====================
|
|
1316
1320
|
# Competitive Analysis Report: {{Project/Product Name}}
|
|
1317
1321
|
|
|
1322
|
+
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
|
|
1323
|
+
|
|
1318
1324
|
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
|
|
1319
1325
|
|
|
1320
1326
|
## Executive Summary
|
|
@@ -1619,6 +1625,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
1619
1625
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
1620
1626
|
- **Slash Command Integration**: Quick agent switching and control
|
|
1621
1627
|
|
|
1628
|
+
### When to Use BMAD
|
|
1629
|
+
|
|
1630
|
+
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
1631
|
+
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
1632
|
+
- **Team Collaboration**: Multiple roles working together
|
|
1633
|
+
- **Quality Assurance**: Structured testing and validation
|
|
1634
|
+
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
1635
|
+
|
|
1636
|
+
## Getting Started
|
|
1637
|
+
|
|
1638
|
+
### Quick Start Options
|
|
1639
|
+
|
|
1640
|
+
#### Option 1: Web UI
|
|
1641
|
+
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
|
1642
|
+
|
|
1643
|
+
1. Navigate to `dist/teams/`
|
|
1644
|
+
2. Copy `team-fullstack.txt` content
|
|
1645
|
+
3. Create new Gemini Gem or CustomGPT
|
|
1646
|
+
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
1647
|
+
5. Type `/help` to see available commands
|
|
1648
|
+
|
|
1649
|
+
#### Option 2: IDE Integration
|
|
1650
|
+
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
|
|
1651
|
+
|
|
1652
|
+
```bash
|
|
1653
|
+
# Interactive installation (recommended)
|
|
1654
|
+
npx bmad-method install
|
|
1655
|
+
```
|
|
1656
|
+
|
|
1657
|
+
**Installation Steps**:
|
|
1658
|
+
- Choose "Complete installation"
|
|
1659
|
+
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
|
1660
|
+
|
|
1661
|
+
**Verify Installation**:
|
|
1662
|
+
- `.bmad-core/` folder created with all agents
|
|
1663
|
+
- IDE-specific integration files created
|
|
1664
|
+
- All agent commands/rules/modes available
|
|
1665
|
+
|
|
1666
|
+
### Environment Selection Guide
|
|
1667
|
+
|
|
1668
|
+
**Use Web UI for**:
|
|
1669
|
+
- Initial planning and documentation (PRD, architecture)
|
|
1670
|
+
- Cost-effective document creation (especially with Gemini)
|
|
1671
|
+
- Brainstorming and analysis phases
|
|
1672
|
+
- Multi-agent consultation and planning
|
|
1673
|
+
|
|
1674
|
+
**Use IDE for**:
|
|
1675
|
+
- Active development and coding
|
|
1676
|
+
- File operations and project integration
|
|
1677
|
+
- Document sharding and story management
|
|
1678
|
+
- Implementation workflow (SM/Dev cycles)
|
|
1679
|
+
|
|
1680
|
+
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
|
|
1681
|
+
|
|
1622
1682
|
## Core Philosophy
|
|
1623
1683
|
|
|
1624
1684
|
### Vibe CEO'ing
|
|
@@ -1640,18 +1700,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
1640
1700
|
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
|
|
1641
1701
|
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
|
|
1642
1702
|
|
|
1643
|
-
|
|
1703
|
+
### Key Workflow Principles
|
|
1704
|
+
|
|
1705
|
+
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
|
|
1706
|
+
2. **Clean Handoffs**: Always start fresh when switching between agents
|
|
1707
|
+
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
|
|
1708
|
+
4. **Iterative Development**: Complete one story before starting the next
|
|
1709
|
+
5. **Documentation First**: Always start with solid PRD and architecture
|
|
1710
|
+
|
|
1711
|
+
## Agent System
|
|
1712
|
+
|
|
1713
|
+
### Core Development Team
|
|
1714
|
+
|
|
1715
|
+
| Agent | Role | Primary Functions | When to Use |
|
|
1716
|
+
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
|
|
1717
|
+
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
|
|
1718
|
+
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
|
|
1719
|
+
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
|
|
1720
|
+
| `dev` | Developer | Code implementation, debugging | All development tasks |
|
|
1721
|
+
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
|
|
1722
|
+
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
|
|
1723
|
+
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
|
|
1724
|
+
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
|
|
1725
|
+
|
|
1726
|
+
### Meta Agents
|
|
1727
|
+
|
|
1728
|
+
| Agent | Role | Primary Functions | When to Use |
|
|
1729
|
+
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
|
|
1730
|
+
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
|
|
1731
|
+
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
|
|
1732
|
+
|
|
1733
|
+
### Agent Interaction Commands
|
|
1734
|
+
|
|
1735
|
+
#### IDE-Specific Syntax
|
|
1736
|
+
|
|
1737
|
+
**Agent Loading by IDE**:
|
|
1738
|
+
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
1739
|
+
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
1740
|
+
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
1741
|
+
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
1742
|
+
|
|
1743
|
+
**Chat Management Guidelines**:
|
|
1744
|
+
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
1745
|
+
- **Roo Code**: Switch modes within the same conversation
|
|
1746
|
+
|
|
1747
|
+
**Common Task Commands**:
|
|
1748
|
+
- `*help` - Show available commands
|
|
1749
|
+
- `*status` - Show current context/progress
|
|
1750
|
+
- `*exit` - Exit the agent mode
|
|
1751
|
+
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
|
|
1752
|
+
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
|
|
1753
|
+
- `*create` - Run create-next-story task (SM agent)
|
|
1754
|
+
|
|
1755
|
+
**In Web UI**:
|
|
1756
|
+
```text
|
|
1757
|
+
/pm create-doc prd
|
|
1758
|
+
/architect review system design
|
|
1759
|
+
/dev implement story 1.2
|
|
1760
|
+
/help - Show available commands
|
|
1761
|
+
/switch agent-name - Change active agent (if orchestrator available)
|
|
1762
|
+
```
|
|
1763
|
+
|
|
1764
|
+
## Team Configurations
|
|
1765
|
+
|
|
1766
|
+
### Pre-Built Teams
|
|
1767
|
+
|
|
1768
|
+
#### Team All
|
|
1769
|
+
- **Includes**: All 10 agents + orchestrator
|
|
1770
|
+
- **Use Case**: Complete projects requiring all roles
|
|
1771
|
+
- **Bundle**: `team-all.txt`
|
|
1772
|
+
|
|
1773
|
+
#### Team Fullstack
|
|
1774
|
+
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
|
1775
|
+
- **Use Case**: End-to-end web/mobile development
|
|
1776
|
+
- **Bundle**: `team-fullstack.txt`
|
|
1777
|
+
|
|
1778
|
+
#### Team No-UI
|
|
1779
|
+
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
|
1780
|
+
- **Use Case**: Backend services, APIs, system development
|
|
1781
|
+
- **Bundle**: `team-no-ui.txt`
|
|
1782
|
+
|
|
1783
|
+
## Core Architecture
|
|
1784
|
+
|
|
1785
|
+
### System Overview
|
|
1786
|
+
|
|
1787
|
+
The BMAD-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
|
1788
|
+
|
|
1789
|
+
### Key Architectural Components
|
|
1790
|
+
|
|
1791
|
+
#### 1. Agents (`bmad-core/agents/`)
|
|
1792
|
+
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
|
1793
|
+
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
|
1794
|
+
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
|
1795
|
+
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
|
1796
|
+
|
|
1797
|
+
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
1798
|
+
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
1799
|
+
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
|
|
1800
|
+
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
1801
|
+
|
|
1802
|
+
#### 3. Workflows (`bmad-core/workflows/`)
|
|
1803
|
+
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
|
1804
|
+
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
|
1805
|
+
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
|
1806
|
+
|
|
1807
|
+
#### 4. Reusable Resources
|
|
1808
|
+
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
|
1809
|
+
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
|
1810
|
+
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
|
1811
|
+
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
|
|
1812
|
+
|
|
1813
|
+
### Dual Environment Architecture
|
|
1814
|
+
|
|
1815
|
+
#### IDE Environment
|
|
1816
|
+
|
|
1817
|
+
- Users interact directly with agent markdown files
|
|
1818
|
+
- Agents can access all dependencies dynamically
|
|
1819
|
+
- Supports real-time file operations and project integration
|
|
1820
|
+
- Optimized for development workflow execution
|
|
1821
|
+
|
|
1822
|
+
#### Web UI Environment
|
|
1823
|
+
|
|
1824
|
+
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
|
|
1825
|
+
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
|
|
1826
|
+
- Created by the web-builder tool for upload to web interfaces
|
|
1827
|
+
- Provides complete context in one package
|
|
1828
|
+
|
|
1829
|
+
### Template Processing System
|
|
1830
|
+
|
|
1831
|
+
BMAD employs a sophisticated template system with three key components:
|
|
1832
|
+
|
|
1833
|
+
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
|
1834
|
+
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
|
1835
|
+
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
|
1836
|
+
|
|
1837
|
+
**Template Features**:
|
|
1838
|
+
|
|
1839
|
+
- **Self-contained**: Templates embed both output structure and processing instructions
|
|
1840
|
+
- **Variable Substitution**: `{{placeholders}}` for dynamic content
|
|
1841
|
+
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
|
|
1842
|
+
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
|
|
1843
|
+
|
|
1844
|
+
### Technical Preferences Integration
|
|
1845
|
+
|
|
1846
|
+
The `technical-preferences.md` file serves as a persistent technical profile that:
|
|
1847
|
+
- Ensures consistency across all agents and projects
|
|
1848
|
+
- Eliminates repetitive technology specification
|
|
1849
|
+
- Provides personalized recommendations aligned with user preferences
|
|
1850
|
+
- Evolves over time with lessons learned
|
|
1851
|
+
|
|
1852
|
+
### Build and Delivery Process
|
|
1853
|
+
|
|
1854
|
+
The `web-builder.js` tool creates web-ready bundles by:
|
|
1855
|
+
1. Reading agent or team definition files
|
|
1856
|
+
2. Recursively resolving all dependencies
|
|
1857
|
+
3. Concatenating content into single text files with clear separators
|
|
1858
|
+
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
1859
|
+
|
|
1860
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
|
1861
|
+
|
|
1862
|
+
## Complete Development Workflow
|
|
1863
|
+
|
|
1864
|
+
### Planning Phase (Web UI Recommended)
|
|
1865
|
+
|
|
1866
|
+
**Ideal for cost efficiency, especially with Gemini:**
|
|
1867
|
+
|
|
1868
|
+
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
|
1869
|
+
2. **Project Brief**: Create foundation document (Analyst or user)
|
|
1870
|
+
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
|
1871
|
+
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
|
|
1872
|
+
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
|
|
1873
|
+
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
|
|
1874
|
+
|
|
1875
|
+
#### Example Planning Prompts
|
|
1876
|
+
|
|
1877
|
+
**For PRD Creation**:
|
|
1878
|
+
```text
|
|
1879
|
+
"I want to build a [type] application that [core purpose].
|
|
1880
|
+
Help me brainstorm features and create a comprehensive PRD."
|
|
1881
|
+
```
|
|
1882
|
+
|
|
1883
|
+
**For Architecture Design**:
|
|
1884
|
+
```text
|
|
1885
|
+
"Based on this PRD, design a scalable technical architecture
|
|
1886
|
+
that can handle [specific requirements]."
|
|
1887
|
+
```
|
|
1888
|
+
|
|
1889
|
+
### Critical Transition: Web UI to IDE
|
|
1890
|
+
|
|
1891
|
+
**Once planning is complete, you MUST switch to IDE for development:**
|
|
1892
|
+
|
|
1893
|
+
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
|
|
1894
|
+
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
|
|
1895
|
+
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
|
|
1896
|
+
|
|
1897
|
+
### IDE Development Workflow
|
|
1898
|
+
|
|
1899
|
+
**Prerequisites**: Planning documents must exist in `docs/` folder
|
|
1900
|
+
|
|
1901
|
+
1. **Document Sharding**:
|
|
1902
|
+
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
|
|
1903
|
+
- If architecture exists, shard to `docs/architecture/` folder
|
|
1904
|
+
- Results in multiple manageable documents and epic files
|
|
1905
|
+
|
|
1906
|
+
2. **Verify Sharded Content**:
|
|
1907
|
+
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
|
1908
|
+
- Source tree document and coding standards for dev agent reference
|
|
1909
|
+
- Sharded docs for SM agent story creation
|
|
1910
|
+
|
|
1911
|
+
**Resulting Folder Structure**:
|
|
1912
|
+
- `docs/prd/` - Broken down PRD sections
|
|
1913
|
+
- `docs/architecture/` - Broken down architecture sections
|
|
1914
|
+
- `docs/stories/` - Generated user stories
|
|
1915
|
+
|
|
1916
|
+
3. **Development Cycle** (Sequential, one story at a time):
|
|
1917
|
+
|
|
1918
|
+
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
|
|
1919
|
+
- SM executes create-next-story task
|
|
1920
|
+
- Review generated story in `docs/stories/`
|
|
1921
|
+
- Update status from "Draft" to "Approved"
|
|
1922
|
+
|
|
1923
|
+
**Step 2 - Story Implementation**: New chat window → `@dev`
|
|
1924
|
+
- Agent asks which story to implement
|
|
1925
|
+
- Include story file content to save dev agent lookup time
|
|
1926
|
+
- Dev follows tasks/subtasks, marking completion
|
|
1927
|
+
- Dev leaves notes for SM about any deviations
|
|
1928
|
+
- Update status to "Done"
|
|
1929
|
+
|
|
1930
|
+
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
|
|
1931
|
+
|
|
1932
|
+
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
|
1933
|
+
|
|
1934
|
+
### Status Tracking Workflow
|
|
1935
|
+
|
|
1936
|
+
Stories progress through defined statuses:
|
|
1937
|
+
- **Draft** → **Approved** → **InProgress** → **Done**
|
|
1938
|
+
|
|
1939
|
+
Each status change requires user verification and approval before proceeding.
|
|
1940
|
+
|
|
1941
|
+
### Workflow Types
|
|
1942
|
+
|
|
1943
|
+
#### Greenfield Development
|
|
1944
|
+
- Business analysis and market research
|
|
1945
|
+
- Product requirements and feature definition
|
|
1946
|
+
- System architecture and design
|
|
1947
|
+
- Development execution
|
|
1948
|
+
- Testing and deployment
|
|
1949
|
+
|
|
1950
|
+
#### Brownfield Enhancement
|
|
1951
|
+
- Current system analysis
|
|
1952
|
+
- Enhancement planning
|
|
1953
|
+
- Impact assessment
|
|
1954
|
+
- Incremental development
|
|
1955
|
+
- Integration testing
|
|
1956
|
+
|
|
1957
|
+
## Document Creation Best Practices
|
|
1958
|
+
|
|
1959
|
+
### Required File Naming for Framework Integration
|
|
1960
|
+
|
|
1961
|
+
- `docs/prd.md` - Product Requirements Document
|
|
1962
|
+
- `docs/architecture.md` - System Architecture Document
|
|
1963
|
+
|
|
1964
|
+
**Why These Names Matter**:
|
|
1965
|
+
- Agents automatically reference these files during development
|
|
1966
|
+
- Sharding tasks expect these specific filenames
|
|
1967
|
+
- Workflow automation depends on standard naming
|
|
1968
|
+
|
|
1969
|
+
### Cost-Effective Document Creation Workflow
|
|
1970
|
+
|
|
1971
|
+
**Recommended for Large Documents (PRD, Architecture):**
|
|
1972
|
+
|
|
1973
|
+
1. **Use Web UI**: Create documents in web interface for cost efficiency
|
|
1974
|
+
2. **Copy Final Output**: Save complete markdown to your project
|
|
1975
|
+
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
|
|
1976
|
+
4. **Switch to IDE**: Use IDE agents for development and smaller documents
|
|
1977
|
+
|
|
1978
|
+
### Document Sharding
|
|
1979
|
+
|
|
1980
|
+
Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
1981
|
+
|
|
1982
|
+
**Original PRD**:
|
|
1983
|
+
```markdown
|
|
1984
|
+
## Goals and Background Context
|
|
1985
|
+
## Requirements
|
|
1986
|
+
## User Interface Design Goals
|
|
1987
|
+
## Success Metrics
|
|
1988
|
+
```
|
|
1989
|
+
|
|
1990
|
+
**After Sharding**:
|
|
1991
|
+
- `docs/prd/goals-and-background-context.md`
|
|
1992
|
+
- `docs/prd/requirements.md`
|
|
1993
|
+
- `docs/prd/user-interface-design-goals.md`
|
|
1994
|
+
- `docs/prd/success-metrics.md`
|
|
1995
|
+
|
|
1996
|
+
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
|
|
1997
|
+
|
|
1998
|
+
## Usage Patterns and Best Practices
|
|
1999
|
+
|
|
2000
|
+
### Environment-Specific Usage
|
|
2001
|
+
|
|
2002
|
+
**Web UI Best For**:
|
|
2003
|
+
- Initial planning and documentation phases
|
|
2004
|
+
- Cost-effective large document creation
|
|
2005
|
+
- Agent consultation and brainstorming
|
|
2006
|
+
- Multi-agent workflows with orchestrator
|
|
2007
|
+
|
|
2008
|
+
**IDE Best For**:
|
|
2009
|
+
- Active development and implementation
|
|
2010
|
+
- File operations and project integration
|
|
2011
|
+
- Story management and development cycles
|
|
2012
|
+
- Code review and debugging
|
|
2013
|
+
|
|
2014
|
+
### Quality Assurance
|
|
2015
|
+
|
|
2016
|
+
- Use appropriate agents for specialized tasks
|
|
2017
|
+
- Follow Agile ceremonies and review processes
|
|
2018
|
+
- Maintain document consistency with PO agent
|
|
2019
|
+
- Regular validation with checklists and templates
|
|
2020
|
+
|
|
2021
|
+
### Performance Optimization
|
|
2022
|
+
|
|
2023
|
+
- Use specific agents vs. `bmad-master` for focused tasks
|
|
2024
|
+
- Choose appropriate team size for project needs
|
|
2025
|
+
- Leverage technical preferences for consistency
|
|
2026
|
+
- Regular context management and cache clearing
|
|
2027
|
+
|
|
2028
|
+
## Success Tips
|
|
2029
|
+
|
|
2030
|
+
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
2031
|
+
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
2032
|
+
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
2033
|
+
- **Keep conversations focused** - One agent, one task per conversation
|
|
2034
|
+
- **Review everything** - Always review and approve before marking complete
|
|
1644
2035
|
|
|
1645
|
-
|
|
1646
|
-
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
|
|
1647
|
-
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
|
|
1648
|
-
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
|
|
1649
|
-
5. Use a new chat window to allow the SM agent to `draft the next story`.
|
|
1650
|
-
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
|
|
1651
|
-
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
|
|
1652
|
-
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
|
|
2036
|
+
## Getting Help
|
|
1653
2037
|
|
|
1654
|
-
|
|
2038
|
+
- **Commands**: Use `/help` in any environment to see available commands
|
|
2039
|
+
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
|
2040
|
+
- **Documentation**: Check `docs/` folder for project-specific context
|
|
2041
|
+
- **Community**: Discord and GitHub resources available for support
|
|
1655
2042
|
==================== END: data#bmad-kb ====================
|
|
1656
2043
|
|
|
1657
2044
|
==================== START: utils#template-format ====================
|