bmad-method 4.6.3 → 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 +24 -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 +391 -10
- 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 +10 -8
- 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 +30 -21
- package/docs/windsurf-guide.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +3 -0
- 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
|
@@ -55,9 +55,9 @@ workflows:
|
|
|
55
55
|
==================== END: agent-teams#team-no-ui ====================
|
|
56
56
|
|
|
57
57
|
==================== START: agents#bmad-orchestrator ====================
|
|
58
|
-
# bmad
|
|
58
|
+
# bmad-orchestrator
|
|
59
59
|
|
|
60
|
-
CRITICAL: Read the full YML
|
|
60
|
+
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
61
61
|
|
|
62
62
|
```yaml
|
|
63
63
|
agent:
|
|
@@ -89,9 +89,9 @@ startup:
|
|
|
89
89
|
- If clear match to an agent's expertise, suggest transformation with *agent command
|
|
90
90
|
- If project-oriented, suggest *workflow-guidance to explore options
|
|
91
91
|
- Load resources only when needed - never pre-load
|
|
92
|
-
commands:
|
|
92
|
+
commands:
|
|
93
93
|
help: Show this guide with available agents and workflows
|
|
94
|
-
chat-mode: Start conversational mode for detailed assistance
|
|
94
|
+
chat-mode: Start conversational mode for detailed assistance
|
|
95
95
|
kb-mode: Load full BMAD knowledge base
|
|
96
96
|
status: Show current context, active agent, and progress
|
|
97
97
|
agent: Transform into a specialized agent (list if name not specified)
|
|
@@ -106,41 +106,40 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
|
|
106
106
|
help-display-template: |
|
|
107
107
|
=== BMAD Orchestrator Commands ===
|
|
108
108
|
All commands must start with * (asterisk)
|
|
109
|
-
|
|
109
|
+
|
|
110
110
|
Core Commands:
|
|
111
111
|
*help ............... Show this guide
|
|
112
112
|
*chat-mode .......... Start conversational mode for detailed assistance
|
|
113
113
|
*kb-mode ............ Load full BMAD knowledge base
|
|
114
114
|
*status ............. Show current context, active agent, and progress
|
|
115
115
|
*exit ............... Return to BMad or exit session
|
|
116
|
-
|
|
116
|
+
|
|
117
117
|
Agent & Task Management:
|
|
118
118
|
*agent [name] ....... Transform into specialized agent (list if no name)
|
|
119
119
|
*task [name] ........ Run specific task (list if no name, requires agent)
|
|
120
120
|
*checklist [name] ... Execute checklist (list if no name, requires agent)
|
|
121
|
-
|
|
121
|
+
|
|
122
122
|
Workflow Commands:
|
|
123
123
|
*workflow [name] .... Start specific workflow (list if no name)
|
|
124
124
|
*workflow-guidance .. Get personalized help selecting the right workflow
|
|
125
|
-
|
|
125
|
+
|
|
126
126
|
Other Commands:
|
|
127
127
|
*yolo ............... Toggle skip confirmations mode
|
|
128
128
|
*party-mode ......... Group chat with all agents
|
|
129
129
|
*doc-out ............ Output full document
|
|
130
|
-
|
|
130
|
+
|
|
131
131
|
=== Available Specialist Agents ===
|
|
132
132
|
[Dynamically list each agent in bundle with format:
|
|
133
133
|
*agent {id}: {title}
|
|
134
134
|
When to use: {whenToUse}
|
|
135
135
|
Key deliverables: {main outputs/documents}]
|
|
136
|
-
|
|
136
|
+
|
|
137
137
|
=== Available Workflows ===
|
|
138
138
|
[Dynamically list each workflow in bundle with format:
|
|
139
139
|
*workflow {id}: {name}
|
|
140
140
|
Purpose: {description}]
|
|
141
|
-
|
|
142
|
-
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
|
|
143
141
|
|
|
142
|
+
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
|
|
144
143
|
fuzzy-matching:
|
|
145
144
|
- 85% confidence threshold
|
|
146
145
|
- Show numbered list if unsure
|
|
@@ -212,13 +211,13 @@ persona:
|
|
|
212
211
|
startup:
|
|
213
212
|
- Greet the user with your name and role, and inform of the *help command.
|
|
214
213
|
commands:
|
|
215
|
-
-
|
|
216
|
-
-
|
|
217
|
-
-
|
|
218
|
-
-
|
|
219
|
-
-
|
|
220
|
-
-
|
|
221
|
-
-
|
|
214
|
+
- help: Show numbered list of the following commands to allow selection
|
|
215
|
+
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
|
|
216
|
+
- create-doc {template}: Create doc (no template = show available templates)
|
|
217
|
+
- brainstorm {topic}: Facilitate structured brainstorming session
|
|
218
|
+
- research {topic}: Generate deep research prompt for investigation
|
|
219
|
+
- elicit: Run advanced elicitation to clarify requirements
|
|
220
|
+
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
|
222
221
|
dependencies:
|
|
223
222
|
tasks:
|
|
224
223
|
- brainstorming-techniques
|
|
@@ -241,7 +240,7 @@ dependencies:
|
|
|
241
240
|
|
|
242
241
|
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
243
242
|
|
|
244
|
-
```
|
|
243
|
+
```yaml
|
|
245
244
|
activation-instructions:
|
|
246
245
|
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
247
246
|
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
@@ -271,10 +270,10 @@ persona:
|
|
|
271
270
|
startup:
|
|
272
271
|
- Greet the user with your name and role, and inform of the *help command.
|
|
273
272
|
commands:
|
|
274
|
-
-
|
|
275
|
-
-
|
|
276
|
-
-
|
|
277
|
-
-
|
|
273
|
+
- help: Show numbered list of the following commands to allow selection
|
|
274
|
+
- chat-mode: (Default) Deep conversation with advanced-elicitation
|
|
275
|
+
- create-doc {template}: Create doc (no template = show available templates)
|
|
276
|
+
- exit: Say goodbye as the PM, and then abandon inhabiting this persona
|
|
278
277
|
dependencies:
|
|
279
278
|
tasks:
|
|
280
279
|
- create-doc
|
|
@@ -335,12 +334,12 @@ startup:
|
|
|
335
334
|
- Greet the user with your name and role, and inform of the *help command.
|
|
336
335
|
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
|
337
336
|
commands:
|
|
338
|
-
-
|
|
339
|
-
-
|
|
340
|
-
-
|
|
341
|
-
-
|
|
342
|
-
-
|
|
343
|
-
-
|
|
337
|
+
- help: Show numbered list of the following commands to allow selection
|
|
338
|
+
- chat-mode: (Default) Architect consultation with advanced-elicitation for complex system design
|
|
339
|
+
- create-doc {template}: Create doc (no template = show available templates)
|
|
340
|
+
- execute-checklist {checklist}: Run architectural validation checklist
|
|
341
|
+
- research {topic}: Generate deep research prompt for architectural decisions
|
|
342
|
+
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
|
|
344
343
|
dependencies:
|
|
345
344
|
tasks:
|
|
346
345
|
- create-doc
|
|
@@ -366,7 +365,7 @@ dependencies:
|
|
|
366
365
|
|
|
367
366
|
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
368
367
|
|
|
369
|
-
```
|
|
368
|
+
```yaml
|
|
370
369
|
activation-instructions:
|
|
371
370
|
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
372
371
|
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
@@ -398,15 +397,15 @@ persona:
|
|
|
398
397
|
startup:
|
|
399
398
|
- Greet the user with your name and role, and inform of the *help command.
|
|
400
399
|
commands:
|
|
401
|
-
-
|
|
402
|
-
-
|
|
403
|
-
-
|
|
404
|
-
-
|
|
405
|
-
-
|
|
406
|
-
-
|
|
407
|
-
-
|
|
408
|
-
-
|
|
409
|
-
-
|
|
400
|
+
- help: Show numbered list of the following commands to allow selection
|
|
401
|
+
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
|
|
402
|
+
- create-doc {template}: Create doc (no template = show available templates)
|
|
403
|
+
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
|
|
404
|
+
- shard-doc {document}: Break down document into actionable parts
|
|
405
|
+
- correct-course: Analyze and suggest project course corrections
|
|
406
|
+
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
|
|
407
|
+
- create-story: Create user story from requirements (task brownfield-create-story)
|
|
408
|
+
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
|
|
410
409
|
dependencies:
|
|
411
410
|
tasks:
|
|
412
411
|
- execute-checklist
|
|
@@ -611,6 +610,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
611
610
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
612
611
|
- **Slash Command Integration**: Quick agent switching and control
|
|
613
612
|
|
|
613
|
+
### When to Use BMAD
|
|
614
|
+
|
|
615
|
+
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
616
|
+
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
617
|
+
- **Team Collaboration**: Multiple roles working together
|
|
618
|
+
- **Quality Assurance**: Structured testing and validation
|
|
619
|
+
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
620
|
+
|
|
621
|
+
## Getting Started
|
|
622
|
+
|
|
623
|
+
### Quick Start Options
|
|
624
|
+
|
|
625
|
+
#### Option 1: Web UI
|
|
626
|
+
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
|
627
|
+
|
|
628
|
+
1. Navigate to `dist/teams/`
|
|
629
|
+
2. Copy `team-fullstack.txt` content
|
|
630
|
+
3. Create new Gemini Gem or CustomGPT
|
|
631
|
+
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
632
|
+
5. Type `/help` to see available commands
|
|
633
|
+
|
|
634
|
+
#### Option 2: IDE Integration
|
|
635
|
+
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
|
|
636
|
+
|
|
637
|
+
```bash
|
|
638
|
+
# Interactive installation (recommended)
|
|
639
|
+
npx bmad-method install
|
|
640
|
+
```
|
|
641
|
+
|
|
642
|
+
**Installation Steps**:
|
|
643
|
+
- Choose "Complete installation"
|
|
644
|
+
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
|
645
|
+
|
|
646
|
+
**Verify Installation**:
|
|
647
|
+
- `.bmad-core/` folder created with all agents
|
|
648
|
+
- IDE-specific integration files created
|
|
649
|
+
- All agent commands/rules/modes available
|
|
650
|
+
|
|
651
|
+
### Environment Selection Guide
|
|
652
|
+
|
|
653
|
+
**Use Web UI for**:
|
|
654
|
+
- Initial planning and documentation (PRD, architecture)
|
|
655
|
+
- Cost-effective document creation (especially with Gemini)
|
|
656
|
+
- Brainstorming and analysis phases
|
|
657
|
+
- Multi-agent consultation and planning
|
|
658
|
+
|
|
659
|
+
**Use IDE for**:
|
|
660
|
+
- Active development and coding
|
|
661
|
+
- File operations and project integration
|
|
662
|
+
- Document sharding and story management
|
|
663
|
+
- Implementation workflow (SM/Dev cycles)
|
|
664
|
+
|
|
665
|
+
**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.
|
|
666
|
+
|
|
614
667
|
## Core Philosophy
|
|
615
668
|
|
|
616
669
|
### Vibe CEO'ing
|
|
@@ -632,18 +685,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
632
685
|
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
|
|
633
686
|
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
|
|
634
687
|
|
|
635
|
-
|
|
688
|
+
### Key Workflow Principles
|
|
689
|
+
|
|
690
|
+
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
|
|
691
|
+
2. **Clean Handoffs**: Always start fresh when switching between agents
|
|
692
|
+
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
|
|
693
|
+
4. **Iterative Development**: Complete one story before starting the next
|
|
694
|
+
5. **Documentation First**: Always start with solid PRD and architecture
|
|
695
|
+
|
|
696
|
+
## Agent System
|
|
697
|
+
|
|
698
|
+
### Core Development Team
|
|
699
|
+
|
|
700
|
+
| Agent | Role | Primary Functions | When to Use |
|
|
701
|
+
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
|
|
702
|
+
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
|
|
703
|
+
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
|
|
704
|
+
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
|
|
705
|
+
| `dev` | Developer | Code implementation, debugging | All development tasks |
|
|
706
|
+
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
|
|
707
|
+
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
|
|
708
|
+
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
|
|
709
|
+
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
|
|
710
|
+
|
|
711
|
+
### Meta Agents
|
|
712
|
+
|
|
713
|
+
| Agent | Role | Primary Functions | When to Use |
|
|
714
|
+
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
|
|
715
|
+
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
|
|
716
|
+
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
|
|
717
|
+
|
|
718
|
+
### Agent Interaction Commands
|
|
719
|
+
|
|
720
|
+
#### IDE-Specific Syntax
|
|
721
|
+
|
|
722
|
+
**Agent Loading by IDE**:
|
|
723
|
+
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
724
|
+
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
725
|
+
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
726
|
+
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
727
|
+
|
|
728
|
+
**Chat Management Guidelines**:
|
|
729
|
+
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
730
|
+
- **Roo Code**: Switch modes within the same conversation
|
|
731
|
+
|
|
732
|
+
**Common Task Commands**:
|
|
733
|
+
- `*help` - Show available commands
|
|
734
|
+
- `*status` - Show current context/progress
|
|
735
|
+
- `*exit` - Exit the agent mode
|
|
736
|
+
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
|
|
737
|
+
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
|
|
738
|
+
- `*create` - Run create-next-story task (SM agent)
|
|
739
|
+
|
|
740
|
+
**In Web UI**:
|
|
741
|
+
```text
|
|
742
|
+
/pm create-doc prd
|
|
743
|
+
/architect review system design
|
|
744
|
+
/dev implement story 1.2
|
|
745
|
+
/help - Show available commands
|
|
746
|
+
/switch agent-name - Change active agent (if orchestrator available)
|
|
747
|
+
```
|
|
748
|
+
|
|
749
|
+
## Team Configurations
|
|
750
|
+
|
|
751
|
+
### Pre-Built Teams
|
|
752
|
+
|
|
753
|
+
#### Team All
|
|
754
|
+
- **Includes**: All 10 agents + orchestrator
|
|
755
|
+
- **Use Case**: Complete projects requiring all roles
|
|
756
|
+
- **Bundle**: `team-all.txt`
|
|
757
|
+
|
|
758
|
+
#### Team Fullstack
|
|
759
|
+
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
|
760
|
+
- **Use Case**: End-to-end web/mobile development
|
|
761
|
+
- **Bundle**: `team-fullstack.txt`
|
|
762
|
+
|
|
763
|
+
#### Team No-UI
|
|
764
|
+
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
|
765
|
+
- **Use Case**: Backend services, APIs, system development
|
|
766
|
+
- **Bundle**: `team-no-ui.txt`
|
|
767
|
+
|
|
768
|
+
## Core Architecture
|
|
769
|
+
|
|
770
|
+
### System Overview
|
|
771
|
+
|
|
772
|
+
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).
|
|
773
|
+
|
|
774
|
+
### Key Architectural Components
|
|
775
|
+
|
|
776
|
+
#### 1. Agents (`bmad-core/agents/`)
|
|
777
|
+
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
|
778
|
+
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
|
779
|
+
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
|
780
|
+
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
|
781
|
+
|
|
782
|
+
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
783
|
+
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
784
|
+
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
|
|
785
|
+
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
786
|
+
|
|
787
|
+
#### 3. Workflows (`bmad-core/workflows/`)
|
|
788
|
+
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
|
789
|
+
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
|
790
|
+
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
|
791
|
+
|
|
792
|
+
#### 4. Reusable Resources
|
|
793
|
+
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
|
794
|
+
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
|
795
|
+
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
|
796
|
+
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
|
|
797
|
+
|
|
798
|
+
### Dual Environment Architecture
|
|
799
|
+
|
|
800
|
+
#### IDE Environment
|
|
801
|
+
|
|
802
|
+
- Users interact directly with agent markdown files
|
|
803
|
+
- Agents can access all dependencies dynamically
|
|
804
|
+
- Supports real-time file operations and project integration
|
|
805
|
+
- Optimized for development workflow execution
|
|
806
|
+
|
|
807
|
+
#### Web UI Environment
|
|
808
|
+
|
|
809
|
+
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
|
|
810
|
+
- 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
|
|
811
|
+
- Created by the web-builder tool for upload to web interfaces
|
|
812
|
+
- Provides complete context in one package
|
|
813
|
+
|
|
814
|
+
### Template Processing System
|
|
815
|
+
|
|
816
|
+
BMAD employs a sophisticated template system with three key components:
|
|
817
|
+
|
|
818
|
+
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
|
819
|
+
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
|
820
|
+
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
|
821
|
+
|
|
822
|
+
**Template Features**:
|
|
823
|
+
|
|
824
|
+
- **Self-contained**: Templates embed both output structure and processing instructions
|
|
825
|
+
- **Variable Substitution**: `{{placeholders}}` for dynamic content
|
|
826
|
+
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
|
|
827
|
+
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
|
|
828
|
+
|
|
829
|
+
### Technical Preferences Integration
|
|
636
830
|
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
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.
|
|
643
|
-
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.
|
|
644
|
-
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.
|
|
831
|
+
The `technical-preferences.md` file serves as a persistent technical profile that:
|
|
832
|
+
- Ensures consistency across all agents and projects
|
|
833
|
+
- Eliminates repetitive technology specification
|
|
834
|
+
- Provides personalized recommendations aligned with user preferences
|
|
835
|
+
- Evolves over time with lessons learned
|
|
645
836
|
|
|
646
|
-
|
|
837
|
+
### Build and Delivery Process
|
|
838
|
+
|
|
839
|
+
The `web-builder.js` tool creates web-ready bundles by:
|
|
840
|
+
1. Reading agent or team definition files
|
|
841
|
+
2. Recursively resolving all dependencies
|
|
842
|
+
3. Concatenating content into single text files with clear separators
|
|
843
|
+
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
844
|
+
|
|
845
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
|
846
|
+
|
|
847
|
+
## Complete Development Workflow
|
|
848
|
+
|
|
849
|
+
### Planning Phase (Web UI Recommended)
|
|
850
|
+
|
|
851
|
+
**Ideal for cost efficiency, especially with Gemini:**
|
|
852
|
+
|
|
853
|
+
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
|
854
|
+
2. **Project Brief**: Create foundation document (Analyst or user)
|
|
855
|
+
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
|
856
|
+
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
|
|
857
|
+
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
|
|
858
|
+
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
|
|
859
|
+
|
|
860
|
+
#### Example Planning Prompts
|
|
861
|
+
|
|
862
|
+
**For PRD Creation**:
|
|
863
|
+
```text
|
|
864
|
+
"I want to build a [type] application that [core purpose].
|
|
865
|
+
Help me brainstorm features and create a comprehensive PRD."
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
**For Architecture Design**:
|
|
869
|
+
```text
|
|
870
|
+
"Based on this PRD, design a scalable technical architecture
|
|
871
|
+
that can handle [specific requirements]."
|
|
872
|
+
```
|
|
873
|
+
|
|
874
|
+
### Critical Transition: Web UI to IDE
|
|
875
|
+
|
|
876
|
+
**Once planning is complete, you MUST switch to IDE for development:**
|
|
877
|
+
|
|
878
|
+
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
|
|
879
|
+
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
|
|
880
|
+
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
|
|
881
|
+
|
|
882
|
+
### IDE Development Workflow
|
|
883
|
+
|
|
884
|
+
**Prerequisites**: Planning documents must exist in `docs/` folder
|
|
885
|
+
|
|
886
|
+
1. **Document Sharding**:
|
|
887
|
+
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
|
|
888
|
+
- If architecture exists, shard to `docs/architecture/` folder
|
|
889
|
+
- Results in multiple manageable documents and epic files
|
|
890
|
+
|
|
891
|
+
2. **Verify Sharded Content**:
|
|
892
|
+
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
|
893
|
+
- Source tree document and coding standards for dev agent reference
|
|
894
|
+
- Sharded docs for SM agent story creation
|
|
895
|
+
|
|
896
|
+
**Resulting Folder Structure**:
|
|
897
|
+
- `docs/prd/` - Broken down PRD sections
|
|
898
|
+
- `docs/architecture/` - Broken down architecture sections
|
|
899
|
+
- `docs/stories/` - Generated user stories
|
|
900
|
+
|
|
901
|
+
3. **Development Cycle** (Sequential, one story at a time):
|
|
902
|
+
|
|
903
|
+
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
|
|
904
|
+
- SM executes create-next-story task
|
|
905
|
+
- Review generated story in `docs/stories/`
|
|
906
|
+
- Update status from "Draft" to "Approved"
|
|
907
|
+
|
|
908
|
+
**Step 2 - Story Implementation**: New chat window → `@dev`
|
|
909
|
+
- Agent asks which story to implement
|
|
910
|
+
- Include story file content to save dev agent lookup time
|
|
911
|
+
- Dev follows tasks/subtasks, marking completion
|
|
912
|
+
- Dev leaves notes for SM about any deviations
|
|
913
|
+
- Update status to "Done"
|
|
914
|
+
|
|
915
|
+
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
|
|
916
|
+
|
|
917
|
+
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
|
918
|
+
|
|
919
|
+
### Status Tracking Workflow
|
|
920
|
+
|
|
921
|
+
Stories progress through defined statuses:
|
|
922
|
+
- **Draft** → **Approved** → **InProgress** → **Done**
|
|
923
|
+
|
|
924
|
+
Each status change requires user verification and approval before proceeding.
|
|
925
|
+
|
|
926
|
+
### Workflow Types
|
|
927
|
+
|
|
928
|
+
#### Greenfield Development
|
|
929
|
+
- Business analysis and market research
|
|
930
|
+
- Product requirements and feature definition
|
|
931
|
+
- System architecture and design
|
|
932
|
+
- Development execution
|
|
933
|
+
- Testing and deployment
|
|
934
|
+
|
|
935
|
+
#### Brownfield Enhancement
|
|
936
|
+
- Current system analysis
|
|
937
|
+
- Enhancement planning
|
|
938
|
+
- Impact assessment
|
|
939
|
+
- Incremental development
|
|
940
|
+
- Integration testing
|
|
941
|
+
|
|
942
|
+
## Document Creation Best Practices
|
|
943
|
+
|
|
944
|
+
### Required File Naming for Framework Integration
|
|
945
|
+
|
|
946
|
+
- `docs/prd.md` - Product Requirements Document
|
|
947
|
+
- `docs/architecture.md` - System Architecture Document
|
|
948
|
+
|
|
949
|
+
**Why These Names Matter**:
|
|
950
|
+
- Agents automatically reference these files during development
|
|
951
|
+
- Sharding tasks expect these specific filenames
|
|
952
|
+
- Workflow automation depends on standard naming
|
|
953
|
+
|
|
954
|
+
### Cost-Effective Document Creation Workflow
|
|
955
|
+
|
|
956
|
+
**Recommended for Large Documents (PRD, Architecture):**
|
|
957
|
+
|
|
958
|
+
1. **Use Web UI**: Create documents in web interface for cost efficiency
|
|
959
|
+
2. **Copy Final Output**: Save complete markdown to your project
|
|
960
|
+
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
|
|
961
|
+
4. **Switch to IDE**: Use IDE agents for development and smaller documents
|
|
962
|
+
|
|
963
|
+
### Document Sharding
|
|
964
|
+
|
|
965
|
+
Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
966
|
+
|
|
967
|
+
**Original PRD**:
|
|
968
|
+
```markdown
|
|
969
|
+
## Goals and Background Context
|
|
970
|
+
## Requirements
|
|
971
|
+
## User Interface Design Goals
|
|
972
|
+
## Success Metrics
|
|
973
|
+
```
|
|
974
|
+
|
|
975
|
+
**After Sharding**:
|
|
976
|
+
- `docs/prd/goals-and-background-context.md`
|
|
977
|
+
- `docs/prd/requirements.md`
|
|
978
|
+
- `docs/prd/user-interface-design-goals.md`
|
|
979
|
+
- `docs/prd/success-metrics.md`
|
|
980
|
+
|
|
981
|
+
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
|
|
982
|
+
|
|
983
|
+
## Usage Patterns and Best Practices
|
|
984
|
+
|
|
985
|
+
### Environment-Specific Usage
|
|
986
|
+
|
|
987
|
+
**Web UI Best For**:
|
|
988
|
+
- Initial planning and documentation phases
|
|
989
|
+
- Cost-effective large document creation
|
|
990
|
+
- Agent consultation and brainstorming
|
|
991
|
+
- Multi-agent workflows with orchestrator
|
|
992
|
+
|
|
993
|
+
**IDE Best For**:
|
|
994
|
+
- Active development and implementation
|
|
995
|
+
- File operations and project integration
|
|
996
|
+
- Story management and development cycles
|
|
997
|
+
- Code review and debugging
|
|
998
|
+
|
|
999
|
+
### Quality Assurance
|
|
1000
|
+
|
|
1001
|
+
- Use appropriate agents for specialized tasks
|
|
1002
|
+
- Follow Agile ceremonies and review processes
|
|
1003
|
+
- Maintain document consistency with PO agent
|
|
1004
|
+
- Regular validation with checklists and templates
|
|
1005
|
+
|
|
1006
|
+
### Performance Optimization
|
|
1007
|
+
|
|
1008
|
+
- Use specific agents vs. `bmad-master` for focused tasks
|
|
1009
|
+
- Choose appropriate team size for project needs
|
|
1010
|
+
- Leverage technical preferences for consistency
|
|
1011
|
+
- Regular context management and cache clearing
|
|
1012
|
+
|
|
1013
|
+
## Success Tips
|
|
1014
|
+
|
|
1015
|
+
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
1016
|
+
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
1017
|
+
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
1018
|
+
- **Keep conversations focused** - One agent, one task per conversation
|
|
1019
|
+
- **Review everything** - Always review and approve before marking complete
|
|
1020
|
+
|
|
1021
|
+
## Getting Help
|
|
1022
|
+
|
|
1023
|
+
- **Commands**: Use `/help` in any environment to see available commands
|
|
1024
|
+
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
|
1025
|
+
- **Documentation**: Check `docs/` folder for project-specific context
|
|
1026
|
+
- **Community**: Discord and GitHub resources available for support
|
|
647
1027
|
==================== END: data#bmad-kb ====================
|
|
648
1028
|
|
|
649
1029
|
==================== START: utils#workflow-management ====================
|
|
@@ -1449,6 +1829,8 @@ Present these numbered options to the user:
|
|
|
1449
1829
|
==================== START: templates#project-brief-tmpl ====================
|
|
1450
1830
|
# Project Brief: {{Project Name}}
|
|
1451
1831
|
|
|
1832
|
+
[[LLM: The default path and filename unless specified is docs/brief.md]]
|
|
1833
|
+
|
|
1452
1834
|
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
1453
1835
|
|
|
1454
1836
|
Start by asking the user which mode they prefer:
|
|
@@ -1680,6 +2062,8 @@ These replace the standard elicitation options when working on project brief doc
|
|
|
1680
2062
|
==================== START: templates#market-research-tmpl ====================
|
|
1681
2063
|
# Market Research Report: {{Project/Product Name}}
|
|
1682
2064
|
|
|
2065
|
+
[[LLM: The default path and filename unless specified is docs/market-research.md]]
|
|
2066
|
+
|
|
1683
2067
|
[[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.]]
|
|
1684
2068
|
|
|
1685
2069
|
## Executive Summary
|
|
@@ -1944,6 +2328,8 @@ These replace the standard elicitation options when working on market research d
|
|
|
1944
2328
|
==================== START: templates#competitor-analysis-tmpl ====================
|
|
1945
2329
|
# Competitive Analysis Report: {{Project/Product Name}}
|
|
1946
2330
|
|
|
2331
|
+
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
|
|
2332
|
+
|
|
1947
2333
|
[[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.]]
|
|
1948
2334
|
|
|
1949
2335
|
## Executive Summary
|
|
@@ -2901,6 +3287,8 @@ Document sharded successfully:
|
|
|
2901
3287
|
==================== START: templates#prd-tmpl ====================
|
|
2902
3288
|
# {{Project Name}} Product Requirements Document (PRD)
|
|
2903
3289
|
|
|
3290
|
+
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
|
3291
|
+
|
|
2904
3292
|
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
|
|
2905
3293
|
|
|
2906
3294
|
## Goals and Background Context
|
|
@@ -3104,6 +3492,8 @@ so that {{benefit}}.
|
|
|
3104
3492
|
==================== START: templates#brownfield-prd-tmpl ====================
|
|
3105
3493
|
# {{Project Name}} Brownfield Enhancement PRD
|
|
3106
3494
|
|
|
3495
|
+
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
|
3496
|
+
|
|
3107
3497
|
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
|
|
3108
3498
|
|
|
3109
3499
|
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
|
|
@@ -4310,6 +4700,8 @@ Present a summary of what was created and ask if any additional documentation wo
|
|
|
4310
4700
|
|
|
4311
4701
|
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
|
|
4312
4702
|
|
|
4703
|
+
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
|
4704
|
+
|
|
4313
4705
|
## Introduction
|
|
4314
4706
|
|
|
4315
4707
|
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
|
@@ -5085,6 +5477,8 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
|
|
|
5085
5477
|
==================== START: templates#front-end-architecture-tmpl ====================
|
|
5086
5478
|
# {{Project Name}} Frontend Architecture Document
|
|
5087
5479
|
|
|
5480
|
+
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
|
|
5481
|
+
|
|
5088
5482
|
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
|
|
5089
5483
|
|
|
5090
5484
|
## Template and Framework Selection
|
|
@@ -5261,6 +5655,8 @@ Document the starter template decision and any constraints it imposes before pro
|
|
|
5261
5655
|
==================== START: templates#fullstack-architecture-tmpl ====================
|
|
5262
5656
|
# {{Project Name}} Fullstack Architecture Document
|
|
5263
5657
|
|
|
5658
|
+
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
|
5659
|
+
|
|
5264
5660
|
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
|
|
5265
5661
|
|
|
5266
5662
|
## Introduction
|
|
@@ -6280,6 +6676,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|
|
6280
6676
|
==================== START: templates#brownfield-architecture-tmpl ====================
|
|
6281
6677
|
# {{Project Name}} Brownfield Enhancement Architecture
|
|
6282
6678
|
|
|
6679
|
+
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
|
6680
|
+
|
|
6283
6681
|
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
|
|
6284
6682
|
|
|
6285
6683
|
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
|