bmad-method 4.21.1 → 4.21.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 +7 -0
- package/common/tasks/create-doc.md +45 -48
- package/package.json +1 -1
- package/tools/installer/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [4.21.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.1...v4.21.2) (2025-06-30)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* improve create-doc task clarity for template execution ([86d5139](https://github.com/bmadcode/BMAD-METHOD/commit/86d5139aea7097cc5d4ee9da0f7d3e395ce0835e))
|
|
7
|
+
|
|
1
8
|
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)
|
|
2
9
|
|
|
3
10
|
|
|
@@ -2,73 +2,70 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## CRITICAL RULES
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
|
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
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
## Execution Flow
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
### 1. Identify Template
|
|
14
17
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
@{/example}
|
|
18
|
+
- Load from `templates#*` or `{root}/templates directory`
|
|
19
|
+
- Agent-specific templates are listed in agent's dependencies
|
|
20
|
+
- If agent has `templates: [prd-tmpl, architecture-tmpl]`, offer to create "PRD" and "Architecture" documents
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
### 2. Ask Interaction Mode
|
|
21
23
|
|
|
22
|
-
|
|
23
|
-
-
|
|
24
|
-
|
|
25
|
-
### 2. Determine Interaction Mode
|
|
26
|
-
|
|
27
|
-
Confirm with the user their preferred interaction style:
|
|
28
|
-
|
|
29
|
-
- **Incremental:** Work through chunks of the document.
|
|
30
|
-
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
|
24
|
+
> 1. **Incremental** - Section by section with reviews
|
|
25
|
+
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
|
31
26
|
|
|
32
27
|
### 3. Execute Template
|
|
33
28
|
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
- Process
|
|
29
|
+
- Replace {{placeholders}} with real content
|
|
30
|
+
- Execute [[LLM:]] instructions as you encounter them
|
|
31
|
+
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
|
32
|
+
- Use @{examples} for guidance but never output them
|
|
37
33
|
|
|
38
|
-
### 4.
|
|
34
|
+
### 4. Key Execution Patterns
|
|
39
35
|
|
|
40
|
-
|
|
36
|
+
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
|
41
37
|
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
- Use @{examples} for guidance but never output them
|
|
38
|
+
- Draft the content
|
|
39
|
+
- Present it to user
|
|
40
|
+
- IMMEDIATELY execute the task
|
|
41
|
+
- Wait for completion before continuing
|
|
47
42
|
|
|
48
|
-
|
|
43
|
+
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
|
49
44
|
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
- Incorporate user feedback and iterate as needed
|
|
45
|
+
- Finish the section
|
|
46
|
+
- STOP and execute the task
|
|
47
|
+
- Wait for user input
|
|
54
48
|
|
|
55
|
-
###
|
|
49
|
+
### 5. Validation & Final Presentation
|
|
56
50
|
|
|
57
|
-
|
|
51
|
+
- Run any specified checklists
|
|
52
|
+
- Present clean, formatted content only
|
|
53
|
+
- No truncation or summarization
|
|
54
|
+
- Begin directly with content (no preamble)
|
|
55
|
+
- Include any handoff prompts from template
|
|
58
56
|
|
|
59
|
-
|
|
60
|
-
- Document completion status for each item
|
|
61
|
-
- Address any deficiencies found
|
|
62
|
-
- Present validation summary to user
|
|
57
|
+
## Common Mistakes to Avoid
|
|
63
58
|
|
|
64
|
-
|
|
59
|
+
❌ Skipping elicitation tasks
|
|
60
|
+
❌ Showing template markup to users
|
|
61
|
+
❌ Continuing past STOP signals
|
|
62
|
+
❌ Combining multiple review points
|
|
65
63
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
- Include any handoff prompts specified in template
|
|
64
|
+
✅ Execute ALL instructions in sequence
|
|
65
|
+
✅ Present only clean, formatted content
|
|
66
|
+
✅ Stop at every elicitation point
|
|
67
|
+
✅ Wait for user confirmation when instructed
|
|
71
68
|
|
|
72
|
-
##
|
|
69
|
+
## Remember
|
|
73
70
|
|
|
74
|
-
|
|
71
|
+
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
package/package.json
CHANGED