bmad-method 4.27.0 → 4.27.2
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/CHANGELOG.md +14 -0
- package/bmad-core/agent-teams/team-all.yaml +6 -6
- package/bmad-core/agent-teams/team-fullstack.yaml +6 -6
- package/bmad-core/agent-teams/team-no-ui.yaml +2 -2
- package/bmad-core/agents/analyst.md +17 -20
- package/bmad-core/agents/architect.md +15 -18
- package/bmad-core/agents/bmad-master.md +55 -56
- package/bmad-core/agents/bmad-orchestrator.md +24 -23
- package/bmad-core/agents/dev.md +10 -10
- package/bmad-core/agents/pm.md +17 -20
- package/bmad-core/agents/po.md +12 -15
- package/bmad-core/agents/qa.md +7 -8
- package/bmad-core/agents/sm.md +8 -13
- package/bmad-core/agents/ux-expert.md +7 -11
- package/bmad-core/core-config.yaml +1 -1
- package/bmad-core/templates/architecture-tmpl.yaml +650 -0
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +293 -0
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +206 -0
- package/bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +805 -0
- package/bmad-core/templates/market-research-tmpl.yaml +252 -0
- package/bmad-core/templates/{prd-tmpl2.yaml → prd-tmpl.yaml} +3 -3
- package/bmad-core/templates/project-brief-tmpl.yaml +221 -0
- package/bmad-core/templates/story-tmpl.yaml +137 -0
- package/common/tasks/create-doc.md +55 -67
- package/common/utils/bmad-doc-template.md +29 -0
- package/dist/agents/analyst.txt +1004 -1061
- package/dist/agents/architect.txt +2460 -2872
- package/dist/agents/bmad-master.txt +3842 -4354
- package/dist/agents/bmad-orchestrator.txt +211 -87
- package/dist/agents/dev.txt +4 -8
- package/dist/agents/pm.txt +557 -587
- package/dist/agents/po.txt +149 -102
- package/dist/agents/qa.txt +145 -35
- package/dist/agents/sm.txt +145 -100
- package/dist/agents/ux-expert.txt +413 -522
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +1258 -1236
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +623 -573
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +263 -248
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +9135 -4942
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +288 -251
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +1123 -1145
- package/dist/teams/team-all.txt +4583 -4837
- package/dist/teams/team-fullstack.txt +5276 -5520
- package/dist/teams/team-ide-minimal.txt +375 -185
- package/dist/teams/team-no-ui.txt +4875 -5051
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +2 -2
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +17 -15
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +13 -11
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +13 -11
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +613 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +356 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +343 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +253 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
- package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +14 -12
- package/expansion-packs/bmad-creator-tools/config.yaml +1 -1
- package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +178 -0
- package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +154 -0
- package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +120 -0
- package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +14 -14
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +424 -0
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +629 -0
- package/package.json +1 -1
- package/tools/builders/web-builder.js +65 -85
- package/tools/installer/package.json +1 -1
- package/tools/lib/dependency-resolver.js +8 -19
- package/zoo/docs/architecture.md +812 -0
- package/zoo/docs/brief.md +253 -0
- package/zoo/docs/prd.md +500 -0
- package/zoo/docs/stories/1.1.story.md +278 -0
- package/bmad-core/templates/architecture-tmpl.md +0 -776
- package/bmad-core/templates/brainstorming-output-tmpl.md +0 -149
- package/bmad-core/templates/brownfield-architecture-tmpl.md +0 -544
- package/bmad-core/templates/brownfield-prd-tmpl.md +0 -266
- package/bmad-core/templates/competitor-analysis-tmpl.md +0 -291
- package/bmad-core/templates/front-end-architecture-tmpl.md +0 -175
- package/bmad-core/templates/front-end-spec-tmpl.md +0 -413
- package/bmad-core/templates/fullstack-architecture-tmpl.md +0 -1018
- package/bmad-core/templates/market-research-tmpl.md +0 -263
- package/bmad-core/templates/prd-tmpl.md +0 -202
- package/bmad-core/templates/project-brief-tmpl.md +0 -232
- package/bmad-core/templates/story-tmpl.md +0 -58
- package/common/tasks/create-doc2.md +0 -65
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md +0 -560
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md +0 -345
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md +0 -331
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.md +0 -235
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md +0 -470
- package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.md +0 -154
- package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.md +0 -143
- package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +0 -91
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +0 -415
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
|
@@ -1,91 +1,79 @@
|
|
|
1
|
-
# Create Document from Template
|
|
1
|
+
# Create Document from Template (YAML Driven)
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## CRITICAL: Mandatory Elicitation Format
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**When `elicit: true`, ALWAYS use this exact format:**
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
1. Present section content
|
|
8
|
+
2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
|
|
9
|
+
3. Present numbered options 1-9:
|
|
10
|
+
- **Option 1:** Always "Proceed to next section"
|
|
11
|
+
- **Options 2-9:** Select 8 methods from data/elicitation-methods
|
|
12
|
+
- End with: "Select 1-9 or just type your question/feedback:"
|
|
8
13
|
|
|
9
|
-
|
|
10
|
-
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
|
11
|
-
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
|
12
|
-
4. **WAIT for user input** - At review points and after elicitation tasks
|
|
14
|
+
**NEVER ask yes/no questions or use any other format.**
|
|
13
15
|
|
|
14
|
-
##
|
|
16
|
+
## Processing Flow
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
1. **Parse YAML template** - Load template metadata and sections
|
|
19
|
+
2. **Set preferences** - Show current mode (Interactive), confirm output file
|
|
20
|
+
3. **Process each section:**
|
|
21
|
+
- Skip if condition unmet
|
|
22
|
+
- Check agent permissions (owner/editors) - note if section is restricted to specific agents
|
|
23
|
+
- Draft content using section instruction
|
|
24
|
+
- Present content + detailed rationale
|
|
25
|
+
- **IF elicit: true** → MANDATORY 1-9 options format
|
|
26
|
+
- Save to file if possible
|
|
27
|
+
4. **Continue until complete**
|
|
17
28
|
|
|
18
|
-
|
|
29
|
+
## Detailed Rationale Requirements
|
|
19
30
|
|
|
20
|
-
|
|
21
|
-
- If plan exists and this document creation is part of the plan:
|
|
22
|
-
- Verify this is the expected next step
|
|
23
|
-
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
|
24
|
-
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
|
25
|
-
- Continue with normal execution after plan check
|
|
31
|
+
When presenting section content, ALWAYS include rationale that explains:
|
|
26
32
|
|
|
27
|
-
|
|
33
|
+
- Trade-offs and choices made (what was chosen over alternatives and why)
|
|
34
|
+
- Key assumptions made during drafting
|
|
35
|
+
- Interesting or questionable decisions that need user attention
|
|
36
|
+
- Areas that might need validation
|
|
28
37
|
|
|
29
|
-
|
|
30
|
-
- Agent-specific templates are listed in agent's dependencies
|
|
31
|
-
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
|
38
|
+
## Elicitation Results Flow
|
|
32
39
|
|
|
33
|
-
|
|
40
|
+
After user selects elicitation method (2-9):
|
|
34
41
|
|
|
35
|
-
|
|
36
|
-
|
|
42
|
+
1. Execute method from data/elicitation-methods
|
|
43
|
+
2. Present results with insights
|
|
44
|
+
3. Offer options:
|
|
45
|
+
- **1. Apply changes and update section**
|
|
46
|
+
- **2. Return to elicitation menu**
|
|
47
|
+
- **3. Ask any questions or engage further with this elicitation**
|
|
37
48
|
|
|
38
|
-
|
|
49
|
+
## Agent Permissions
|
|
39
50
|
|
|
40
|
-
|
|
41
|
-
- Execute [[LLM:]] instructions as you encounter them
|
|
42
|
-
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
|
43
|
-
- Use @{examples} for guidance but never output them
|
|
51
|
+
When processing sections with agent permission fields:
|
|
44
52
|
|
|
45
|
-
|
|
53
|
+
- **owner**: Note which agent role initially creates/populates the section
|
|
54
|
+
- **editors**: List agent roles allowed to modify the section
|
|
55
|
+
- **readonly**: Mark sections that cannot be modified after creation
|
|
46
56
|
|
|
47
|
-
**
|
|
57
|
+
**For sections with restricted access:**
|
|
48
58
|
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
- IMMEDIATELY execute the task
|
|
52
|
-
- Wait for completion before continuing
|
|
59
|
+
- Include a note in the generated document indicating the responsible agent
|
|
60
|
+
- Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
|
|
53
61
|
|
|
54
|
-
|
|
62
|
+
## YOLO Mode
|
|
55
63
|
|
|
56
|
-
|
|
57
|
-
- STOP and execute the task
|
|
58
|
-
- Wait for user input
|
|
64
|
+
User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
59
65
|
|
|
60
|
-
|
|
66
|
+
## CRITICAL REMINDERS
|
|
61
67
|
|
|
62
|
-
|
|
63
|
-
- Present clean, formatted content only
|
|
64
|
-
- No truncation or summarization
|
|
65
|
-
- Begin directly with content (no preamble)
|
|
66
|
-
- Include any handoff prompts from template
|
|
68
|
+
**❌ NEVER:**
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
- Ask yes/no questions for elicitation
|
|
71
|
+
- Use any format other than 1-9 numbered options
|
|
72
|
+
- Create new elicitation methods
|
|
69
73
|
|
|
70
|
-
|
|
74
|
+
**✅ ALWAYS:**
|
|
71
75
|
|
|
72
|
-
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
## Common Mistakes to Avoid
|
|
78
|
-
|
|
79
|
-
❌ Skipping elicitation tasks
|
|
80
|
-
❌ Showing template markup to users
|
|
81
|
-
❌ Continuing past STOP signals
|
|
82
|
-
❌ Combining multiple review points
|
|
83
|
-
|
|
84
|
-
✅ Execute ALL instructions in sequence
|
|
85
|
-
✅ Present only clean, formatted content
|
|
86
|
-
✅ Stop at every elicitation point
|
|
87
|
-
✅ Wait for user confirmation when instructed
|
|
88
|
-
|
|
89
|
-
## Remember
|
|
90
|
-
|
|
91
|
-
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
|
76
|
+
- Use exact 1-9 format when elicit: true
|
|
77
|
+
- Select options 2-9 from data/elicitation-methods only
|
|
78
|
+
- Provide detailed rationale explaining decisions
|
|
79
|
+
- End with "Select 1-9 or just type your question/feedback:"
|
|
@@ -67,6 +67,12 @@ sections:
|
|
|
67
67
|
- **repeatable**: Boolean - Section can be repeated multiple times
|
|
68
68
|
- **condition**: String - Condition for including section (e.g., "has ui requirements")
|
|
69
69
|
|
|
70
|
+
#### Agent Permissions
|
|
71
|
+
|
|
72
|
+
- **owner**: String - Agent role that initially creates/populates this section
|
|
73
|
+
- **editors**: Array - List of agent roles allowed to modify this section
|
|
74
|
+
- **readonly**: Boolean - Section cannot be modified after initial creation
|
|
75
|
+
|
|
70
76
|
#### Content Guidance
|
|
71
77
|
|
|
72
78
|
- **examples**: Array of example content (not included in output)
|
|
@@ -169,6 +175,29 @@ choices:
|
|
|
169
175
|
- `block` - Block diagrams
|
|
170
176
|
- `kanban` - Kanban boards
|
|
171
177
|
|
|
178
|
+
### Agent Permissions Example
|
|
179
|
+
|
|
180
|
+
```yaml
|
|
181
|
+
- id: story-details
|
|
182
|
+
title: Story
|
|
183
|
+
owner: scrum-master
|
|
184
|
+
editors: [scrum-master]
|
|
185
|
+
readonly: false
|
|
186
|
+
sections:
|
|
187
|
+
- id: dev-notes
|
|
188
|
+
title: Dev Notes
|
|
189
|
+
owner: dev-agent
|
|
190
|
+
editors: [dev-agent]
|
|
191
|
+
readonly: false
|
|
192
|
+
instruction: Implementation notes and technical details
|
|
193
|
+
- id: qa-results
|
|
194
|
+
title: QA Results
|
|
195
|
+
owner: qa-agent
|
|
196
|
+
editors: [qa-agent]
|
|
197
|
+
readonly: true
|
|
198
|
+
instruction: Quality assurance test results
|
|
199
|
+
```
|
|
200
|
+
|
|
172
201
|
### Repeatable Sections
|
|
173
202
|
|
|
174
203
|
```yaml
|