Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6e094c8359 | ||
|
|
86d5139aea |
@@ -1,3 +1,10 @@
|
|||||||
|
## [4.21.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.1...v4.21.2) (2025-06-30)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* improve create-doc task clarity for template execution ([86d5139](https://github.com/bmadcode/BMAD-METHOD/commit/86d5139aea7097cc5d4ee9da0f7d3e395ce0835e))
|
||||||
|
|
||||||
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)
|
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -2,73 +2,70 @@
|
|||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||||
|
|
||||||
## Instructions
|
## CRITICAL RULES
|
||||||
|
|
||||||
### 1. Identify Template and Context
|
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||||
|
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||||
|
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||||
|
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||||
|
|
||||||
- Determine which template to use (user-provided or list available for selection to user)
|
## Execution Flow
|
||||||
|
|
||||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
### 1. Identify Template
|
||||||
|
|
||||||
@{example}
|
- Load from `templates#*` or `{root}/templates directory`
|
||||||
dependencies:
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
templates: - prd-tmpl - architecture-tmpl
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]`, offer to create "PRD" and "Architecture" documents
|
||||||
@{/example}
|
|
||||||
|
|
||||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
### 2. Ask Interaction Mode
|
||||||
|
|
||||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
> 1. **Incremental** - Section by section with reviews
|
||||||
- Understand the document purpose and target audience
|
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||||
|
|
||||||
### 2. Determine Interaction Mode
|
|
||||||
|
|
||||||
Confirm with the user their preferred interaction style:
|
|
||||||
|
|
||||||
- **Incremental:** Work through chunks of the document.
|
|
||||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
|
||||||
|
|
||||||
### 3. Execute Template
|
### 3. Execute Template
|
||||||
|
|
||||||
- Load specified template from `templates#*` or the `{root}/templates directory`
|
- Replace {{placeholders}} with real content
|
||||||
- Follow ALL embedded LLM instructions within the template
|
- Execute [[LLM:]] instructions as you encounter them
|
||||||
- Process template markup according to `utils#template-format` or `{root}/utils/template-format` conventions
|
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||||
|
|
||||||
### 4. Template Processing Rules
|
|
||||||
|
|
||||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
|
||||||
|
|
||||||
- Replace all {{placeholders}} with actual content
|
|
||||||
- Execute all [[LLM: instructions]] internally
|
|
||||||
- Process `<<REPEAT>>` sections as needed
|
|
||||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
|
||||||
- Use @{examples} for guidance but never output them
|
- Use @{examples} for guidance but never output them
|
||||||
|
|
||||||
### 5. Content Generation
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
- **Incremental Mode**: Present each major section for review before proceeding
|
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
|
||||||
- Apply any elicitation protocols specified in template
|
|
||||||
- Incorporate user feedback and iterate as needed
|
|
||||||
|
|
||||||
### 6. Validation
|
- Draft the content
|
||||||
|
- Present it to user
|
||||||
|
- IMMEDIATELY execute the task
|
||||||
|
- Wait for completion before continuing
|
||||||
|
|
||||||
If template specifies a checklist:
|
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||||
|
|
||||||
- Run the appropriate checklist against completed document
|
- Finish the section
|
||||||
- Document completion status for each item
|
- STOP and execute the task
|
||||||
- Address any deficiencies found
|
- Wait for user input
|
||||||
- Present validation summary to user
|
|
||||||
|
|
||||||
### 7. Final Presentation
|
### 5. Validation & Final Presentation
|
||||||
|
|
||||||
|
- Run any specified checklists
|
||||||
- Present clean, formatted content only
|
- Present clean, formatted content only
|
||||||
- Ensure all sections are complete
|
- No truncation or summarization
|
||||||
- DO NOT truncate or summarize content
|
- Begin directly with content (no preamble)
|
||||||
- Begin directly with document content (no preamble)
|
- Include any handoff prompts from template
|
||||||
- Include any handoff prompts specified in template
|
|
||||||
|
|
||||||
## Important Notes
|
## Common Mistakes to Avoid
|
||||||
|
|
||||||
- Template markup is for AI processing only - never expose to users
|
❌ Skipping elicitation tasks
|
||||||
|
❌ Showing template markup to users
|
||||||
|
❌ Continuing past STOP signals
|
||||||
|
❌ Combining multiple review points
|
||||||
|
|
||||||
|
✅ Execute ALL instructions in sequence
|
||||||
|
✅ Present only clean, formatted content
|
||||||
|
✅ Stop at every elicitation point
|
||||||
|
✅ Wait for user confirmation when instructed
|
||||||
|
|
||||||
|
## Remember
|
||||||
|
|
||||||
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.21.1",
|
"version": "4.21.2",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.21.1",
|
"version": "4.21.2",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.21.1",
|
"version": "4.21.2",
|
||||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||||
"main": "tools/cli.js",
|
"main": "tools/cli.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.21.1",
|
"version": "4.21.2",
|
||||||
"description": "BMAD Method installer - AI-powered Agile development framework",
|
"description": "BMAD Method installer - AI-powered Agile development framework",
|
||||||
"main": "lib/installer.js",
|
"main": "lib/installer.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
|
|||||||
Reference in New Issue
Block a user