bmad-method 4.26.0 → 4.27.1

package/bmad-core/templates/story-tmpl.yaml

@@ -0,0 +1,137 @@
+template:
+  id: story-template-v2
+  name: Story Document
+  version: 2.0
+  output:
+    format: markdown
+    filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
+    title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
+
+workflow:
+  mode: interactive
+  elicitation: advanced-elicitation
+
+agent_config:
+  editable_sections: 
+    - Status
+    - Story
+    - Acceptance Criteria
+    - Tasks / Subtasks
+    - Dev Notes
+    - Testing
+    - Change Log
+
+sections:
+  - id: status
+    title: Status
+    type: choice
+    choices: [Draft, Approved, InProgress, Review, Done]
+    instruction: Select the current status of the story
+    owner: scrum-master
+    editors: [scrum-master, dev-agent]
+    
+  - id: story
+    title: Story
+    type: template-text
+    template: |
+      **As a** {{role}},
+      **I want** {{action}},
+      **so that** {{benefit}}
+    instruction: Define the user story using the standard format with role, action, and benefit
+    elicit: true
+    owner: scrum-master
+    editors: [scrum-master]
+    
+  - id: acceptance-criteria
+    title: Acceptance Criteria
+    type: numbered-list
+    instruction: Copy the acceptance criteria numbered list from the epic file
+    elicit: true
+    owner: scrum-master
+    editors: [scrum-master]
+    
+  - id: tasks-subtasks
+    title: Tasks / Subtasks
+    type: bullet-list
+    instruction: |
+      Break down the story into specific tasks and subtasks needed for implementation.
+      Reference applicable acceptance criteria numbers where relevant.
+    template: |
+      - [ ] Task 1 (AC: # if applicable)
+        - [ ] Subtask1.1...
+      - [ ] Task 2 (AC: # if applicable)
+        - [ ] Subtask 2.1...
+      - [ ] Task 3 (AC: # if applicable)
+        - [ ] Subtask 3.1...
+    elicit: true
+    owner: scrum-master
+    editors: [scrum-master, dev-agent]
+    
+  - id: dev-notes
+    title: Dev Notes
+    instruction: |
+      Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
+      - Do not invent information
+      - If known add Relevant Source Tree info that relates to this story
+      - If there were important notes from previous story that are relevant to this one, include them here
+      - Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
+    elicit: true
+    owner: scrum-master
+    editors: [scrum-master]
+    sections:
+      - id: testing-standards
+        title: Testing
+        instruction: |
+          List Relevant Testing Standards from Architecture the Developer needs to conform to:
+          - Test file location
+          - Test standards
+          - Testing frameworks and patterns to use
+          - Any specific testing requirements for this story
+        elicit: true
+        owner: scrum-master
+        editors: [scrum-master]
+        
+  - id: change-log
+    title: Change Log
+    type: table
+    columns: [Date, Version, Description, Author]
+    instruction: Track changes made to this story document
+    owner: scrum-master
+    editors: [scrum-master, dev-agent, qa-agent]
+    
+  - id: dev-agent-record
+    title: Dev Agent Record
+    instruction: This section is populated by the development agent during implementation
+    owner: dev-agent
+    editors: [dev-agent]
+    sections:
+      - id: agent-model
+        title: Agent Model Used
+        template: "{{agent_model_name_version}}"
+        instruction: Record the specific AI agent model and version used for development
+        owner: dev-agent
+        editors: [dev-agent]
+        
+      - id: debug-log-references
+        title: Debug Log References
+        instruction: Reference any debug logs or traces generated during development
+        owner: dev-agent
+        editors: [dev-agent]
+        
+      - id: completion-notes
+        title: Completion Notes List
+        instruction: Notes about the completion of tasks and any issues encountered
+        owner: dev-agent
+        editors: [dev-agent]
+        
+      - id: file-list
+        title: File List
+        instruction: List all files created, modified, or affected during story implementation
+        owner: dev-agent
+        editors: [dev-agent]
+        
+  - id: qa-results
+    title: QA Results
+    instruction: Results from QA Agent QA review of the completed story implementation
+    owner: qa-agent
+    editors: [qa-agent]

package/bmad-core/utils/plan-management.md

@@ -8,14 +8,10 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
 
 ### 1. Check Plan Existence
 
-[[LLM: When any agent starts or task begins, check if a workflow plan exists]]
-
-```
 Check for workflow plan:
+
 1. Look for docs/workflow-plan.md (default location)
-2. Check core-config.yaml for custom plan location
-3. Return plan status (exists/not exists)
-```
+2. Return plan status to user (exists/not exists) - if not exists then HALT.
 
 ### 2. Parse Plan Status
 
@@ -56,7 +52,7 @@ Check for workflow plan:
 
 **Warning Templates:**
 
-```
+```text
 SEQUENCE WARNING: 
 The workflow plan shows you should complete "{expected_step}" next.
 You're attempting to: "{requested_action}"
@@ -90,7 +86,7 @@ In flexible mode: Allow with confirmation
 
 **For Agents (startup sequence)**:
 
-```
+```text
 1. Check if plan exists using this utility
 2. If exists:
    - Parse current status
@@ -101,7 +97,7 @@ In flexible mode: Allow with confirmation
 
 **For Tasks (pre-execution)**:
 
-```
+```text
 1. Check if plan exists
 2. If exists:
    - Verify this task aligns with plan
@@ -117,7 +113,7 @@ In flexible mode: Allow with confirmation
 
 [[LLM: Standard format for showing plan status]]
 
-```
+```text
 📋 Workflow Plan Status
 ━━━━━━━━━━━━━━━━━━━━
 Workflow: {workflow_name}
@@ -170,7 +166,7 @@ If user wants to abandon plan:
 
 ### Example 1: Agent Startup Check
 
-```
+```text
 BMad Master starting...
 
 [Check for plan]
@@ -184,7 +180,7 @@ Use *agent pm to switch, or *plan-status to see full progress.
 
 ### Example 2: Task Sequence Warning
 
-```
+```text
 User: *task create-next-story
 
 [Plan check triggered]
@@ -200,7 +196,7 @@ Would you like to:
 
 ### Example 3: Automatic Plan Update
 
-```
+```text
 [After completing create-doc task for PRD]
 
 ✅ Plan Updated: Marked "Create PRD" as complete

package/bmad-core/workflows/greenfield-service.yaml

@@ -136,7 +136,7 @@ workflow:
         All stories implemented and reviewed!
         Service development phase complete.
         
-        Reference: data#bmad-kb:IDE Development Workflow
+        Reference: {root}/data/bmad-kb.md#IDE Development Workflow
 
   flow_diagram: |
     ```mermaid

package/common/tasks/create-doc.md

@@ -1,91 +1,79 @@
-# Create Document from Template Task
+# Create Document from Template (YAML Driven)
 
-## Purpose
+## CRITICAL: Mandatory Elicitation Format
 
-Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
+**When `elicit: true`, ALWAYS use this exact format:**
 
-## CRITICAL RULES
+1. Present section content
+2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
+3. Present numbered options 1-9:
+   - **Option 1:** Always "Proceed to next section"
+   - **Options 2-9:** Select 8 methods from data/elicitation-methods
+   - End with: "Select 1-9 or just type your question/feedback:"
 
-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
+**NEVER ask yes/no questions or use any other format.**
 
-## Execution Flow
+## Processing Flow
 
-### 0. Check Workflow Plan (if configured)
+1. **Parse YAML template** - Load template metadata and sections
+2. **Set preferences** - Show current mode (Interactive), confirm output file
+3. **Process each section:**
+   - Skip if condition unmet
+   - Check agent permissions (owner/editors) - note if section is restricted to specific agents
+   - Draft content using section instruction
+   - Present content + detailed rationale
+   - **IF elicit: true** → MANDATORY 1-9 options format
+   - Save to file if possible
+4. **Continue until complete**
 
-[[LLM: Check if plan tracking is enabled in core-config.yaml]]
+## Detailed Rationale Requirements
 
-- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
-- If plan exists and this document creation is part of the plan:
-  - Verify this is the expected next step
-  - If out of sequence and `enforceSequence: true`, warn user and halt without user override
-  - If out of sequence and `enforceSequence: false`, ask for confirmation
-- Continue with normal execution after plan check
+When presenting section content, ALWAYS include rationale that explains:
 
-### 1. Identify Template
+- Trade-offs and choices made (what was chosen over alternatives and why)
+- Key assumptions made during drafting
+- Interesting or questionable decisions that need user attention
+- Areas that might need validation
 
-- Load from `templates#*` or `{root}/templates directory`
-- Agent-specific templates are listed in agent's dependencies
-- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
+## Elicitation Results Flow
 
-### 2. Ask Interaction Mode
+After user selects elicitation method (2-9):
 
-> 1. **Incremental** - Section by section with reviews
-> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
+1. Execute method from data/elicitation-methods
+2. Present results with insights
+3. Offer options:
+   - **1. Apply changes and update section**
+   - **2. Return to elicitation menu**
+   - **3. Ask any questions or engage further with this elicitation**
 
-### 3. Execute Template
+## Agent Permissions
 
-- Replace {{placeholders}} with real content
-- Execute [[LLM:]] instructions as you encounter them
-- Process <<REPEAT>> loops and ^^CONDITIONS^^
-- Use @{examples} for guidance but never output them
+When processing sections with agent permission fields:
 
-### 4. Key Execution Patterns
+- **owner**: Note which agent role initially creates/populates the section
+- **editors**: List agent roles allowed to modify the section
+- **readonly**: Mark sections that cannot be modified after creation
 
-**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
+**For sections with restricted access:**
 
-- Draft the content
-- Present it to user
-- IMMEDIATELY execute the task
-- Wait for completion before continuing
+- Include a note in the generated document indicating the responsible agent
+- Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
 
-**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
+## YOLO Mode
 
-- Finish the section
-- STOP and execute the task
-- Wait for user input
+User can type `#yolo` to toggle to YOLO mode (process all sections at once).
 
-### 5. Validation & Final Presentation
+## CRITICAL REMINDERS
 
-- Run any specified checklists
-- Present clean, formatted content only
-- No truncation or summarization
-- Begin directly with content (no preamble)
-- Include any handoff prompts from template
+**❌ NEVER:**
 
-### 6. Update Workflow Plan (if applicable)
+- Ask yes/no questions for elicitation
+- Use any format other than 1-9 numbered options
+- Create new elicitation methods
 
-[[LLM: After successful document creation]]
+**✅ ALWAYS:**
 
-- If plan tracking is enabled and document was part of plan:
-  - Call update-workflow-plan task to mark step complete
-  - Parameters: task: create-doc, step_id: {from plan}, status: complete
-  - Show next recommended step from plan
-
-## Common Mistakes to Avoid
-
-❌ 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.
+- Use exact 1-9 format when elicit: true
+- Select options 2-9 from data/elicitation-methods only
+- Provide detailed rationale explaining decisions
+- End with "Select 1-9 or just type your question/feedback:"

package/common/utils/bmad-doc-template.md

@@ -0,0 +1,325 @@
+# BMad Document Template Specification
+
+## Overview
+
+BMad document templates are defined in YAML format to drive interactive document generation and agent interaction. Templates separate structure definition from content generation, making them both human and LLM-agent-friendly.
+
+## Template Structure
+
+```yaml
+template:
+  id: template-identifier
+  name: Human Readable Template Name
+  version: 1.0
+  output:
+    format: markdown
+    filename: default-path/to/{{filename}}.md
+    title: "{{variable}} Document Title"
+
+workflow:
+  mode: interactive
+  elicitation: advanced-elicitation
+
+sections:
+  - id: section-id
+    title: Section Title
+    instruction: |
+      Detailed instructions for the LLM on how to handle this section
+    # ... additional section properties
+```
+
+## Core Fields
+
+### Template Metadata
+
+- **id**: Unique identifier for the template
+- **name**: Human-readable name displayed in UI
+- **version**: Template version for tracking changes
+- **output.format**: Default "markdown" for document templates
+- **output.filename**: Default output file path (can include variables)
+- **output.title**: Document title (becomes H1 in markdown)
+
+### Workflow Configuration
+
+- **workflow.mode**: Default interaction mode ("interactive" or "yolo")
+- **workflow.elicitation**: Elicitation task to use ("advanced-elicitation")
+
+## Section Properties
+
+### Required Fields
+
+- **id**: Unique section identifier
+- **title**: Section heading text
+- **instruction**: Detailed guidance for LLM on handling this section
+
+### Optional Fields
+
+#### Content Control
+
+- **type**: Content type hint for structured sections
+- **template**: Fixed template text for section content
+- **item_template**: Template for repeatable items within section
+- **prefix**: Prefix for numbered items (e.g., "FR", "NFR")
+
+#### Behavior Flags
+
+- **elicit**: Boolean - Apply elicitation after section rendered
+- **repeatable**: Boolean - Section can be repeated multiple times
+- **condition**: String - Condition for including section (e.g., "has ui requirements")
+
+#### Agent Permissions
+
+- **owner**: String - Agent role that initially creates/populates this section
+- **editors**: Array - List of agent roles allowed to modify this section
+- **readonly**: Boolean - Section cannot be modified after initial creation
+
+#### Content Guidance
+
+- **examples**: Array of example content (not included in output)
+- **choices**: Object with choice options for common decisions
+- **placeholder**: Default placeholder text
+
+#### Structure
+
+- **sections**: Array of nested child sections
+
+## Supported Types
+
+### Content Types
+
+- **bullet-list**: Unordered list items
+- **numbered-list**: Ordered list with optional prefix
+- **paragraphs**: Free-form paragraph text
+- **table**: Structured table data
+- **code-block**: Code or configuration blocks
+- **template-text**: Fixed template with variable substitution
+- **mermaid**: Mermaid diagram with specified type and details
+
+### Special Types
+
+- **repeatable-container**: Container for multiple instances
+- **conditional-block**: Content shown based on conditions
+- **choice-selector**: Present choices to user
+
+## Advanced Features
+
+### Variable Substitution
+
+Use `{{variable_name}}` in titles, templates, and content:
+
+```yaml
+title: "Epic {{epic_number}} {{epic_title}}"
+template: "As a {{user_type}}, I want {{action}}, so that {{benefit}}."
+```
+
+### Conditional Sections
+
+```yaml
+- id: ui-section
+  title: User Interface Design
+  condition: Project has UX/UI Requirements
+  instruction: Only include if project has UI components
+```
+
+### Choice Integration
+
+```yaml
+choices:
+  architecture: [Monolith, Microservices, Serverless]
+  testing: [Unit Only, Unit + Integration, Full Pyramid]
+```
+
+### Mermaid Diagrams
+
+```yaml
+- id: system-architecture
+  title: System Architecture Diagram
+  type: mermaid
+  instruction: Create a system architecture diagram showing key components and data flow
+  mermaid_type: flowchart
+  details: |
+    Show the following components:
+    - User interface layer
+    - API gateway
+    - Core services
+    - Database layer
+    - External integrations
+```
+
+**Supported mermaid_type values:**
+
+**Core Diagram Types:**
+
+- `flowchart` - Flow charts and process diagrams
+- `sequenceDiagram` - Sequence diagrams for interactions
+- `classDiagram` - Class relationship diagrams (UML)
+- `stateDiagram` - State transition diagrams
+- `erDiagram` - Entity relationship diagrams
+- `gantt` - Gantt charts for timelines
+- `pie` - Pie charts for data visualization
+
+**Advanced Diagram Types:**
+
+- `journey` - User journey maps
+- `mindmap` - Mindmaps for brainstorming
+- `timeline` - Timeline diagrams for chronological events
+- `quadrantChart` - Quadrant charts for data categorization
+- `xyChart` - XY charts (bar charts, line charts)
+- `sankey` - Sankey diagrams for flow visualization
+
+**Specialized Types:**
+
+- `c4Context` - C4 context diagrams (experimental)
+- `requirement` - Requirement diagrams
+- `packet` - Network packet diagrams
+- `block` - Block diagrams
+- `kanban` - Kanban boards
+
+### Agent Permissions Example
+
+```yaml
+- id: story-details
+  title: Story
+  owner: scrum-master
+  editors: [scrum-master]
+  readonly: false
+  sections:
+    - id: dev-notes
+      title: Dev Notes
+      owner: dev-agent
+      editors: [dev-agent]
+      readonly: false
+      instruction: Implementation notes and technical details
+    - id: qa-results
+      title: QA Results
+      owner: qa-agent
+      editors: [qa-agent]
+      readonly: true
+      instruction: Quality assurance test results
+```
+
+### Repeatable Sections
+
+```yaml
+- id: epic-details
+  title: Epic {{epic_number}} {{epic_title}}
+  repeatable: true
+  sections:
+    - id: story
+      title: Story {{epic_number}}.{{story_number}} {{story_title}}
+      repeatable: true
+      sections:
+        - id: criteria
+          title: Acceptance Criteria
+          type: numbered-list
+          item_template: "{{criterion_number}}: {{criteria}}"
+          repeatable: true
+```
+
+### Examples with Code Blocks
+
+````yaml
+examples:
+  - "FR6: The system must authenticate users within 2 seconds"
+  - |
+    ```mermaid
+    sequenceDiagram
+        participant User
+        participant API
+        participant DB
+        User->>API: POST /login
+        API->>DB: Validate credentials
+        DB-->>API: User data
+        API-->>User: JWT token
+    ```
+  - |
+    **Architecture Decision Record**
+
+    **Decision**: Use PostgreSQL for primary database
+    **Rationale**: ACID compliance and JSON support needed
+    **Consequences**: Requires database management expertise
+````
+
+## Section Hierarchy
+
+Templates define the complete document structure starting with the first H2 - each level in is the next H#:
+
+```yaml
+sections:
+  - id: overview
+    title: Project Overview
+    sections:
+      - id: goals
+        title: Goals
+      - id: scope
+        title: Scope
+        sections:
+          - id: in-scope
+            title: In Scope
+          - id: out-scope
+            title: Out of Scope
+```
+
+## Processing Flow
+
+1. **Parse Template**: Load and validate YAML structure
+2. **Initialize Workflow**: Set interaction mode and elicitation
+3. **Process Sections**: Handle each section in order:
+   - Check conditions
+   - Apply instructions
+   - Generate content
+   - Handle choices and variables
+   - Apply elicitation if specified
+   - Process nested sections
+4. **Generate Output**: Create clean markdown document
+
+## Best Practices
+
+### Template Design
+
+- Keep instructions clear and specific
+- Use examples for complex content
+- Structure sections logically
+- Include all necessary guidance for LLM
+
+### Content Instructions
+
+- Be explicit about expected format
+- Include reasoning for decisions
+- Specify interaction patterns
+- Reference other documents when needed
+
+### Variable Naming
+
+- Use descriptive variable names
+- Follow consistent naming conventions
+- Document expected variable values
+
+### Examples Usage
+
+- Provide concrete examples for complex sections
+- Include both simple and complex cases
+- Use realistic project scenarios
+- Include code blocks and diagrams when helpful
+
+## Validation
+
+Templates should be validated for:
+
+- Valid YAML syntax
+- Required fields present
+- Consistent section IDs
+- Proper nesting structure
+- Valid variable references
+
+## Migration from Legacy
+
+When converting from markdown+frontmatter templates:
+
+1. Extract embedded `[[LLM:]]` instructions to `instruction` fields
+2. Convert `<<REPEAT>>` blocks to `repeatable: true` sections
+3. Extract `^^CONDITIONS^^` to `condition` fields
+4. Move `@{examples}` to `examples` arrays
+5. Convert `{{placeholders}}` to proper variable syntax
+
+This specification ensures templates are both human-readable and machine-processable while maintaining the flexibility needed for complex document generation.