bmad-method 4.23.0 → 4.24.0

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

@@ -0,0 +1,223 @@
+# Plan Management Utility
+
+## Purpose
+
+Provides utilities for agents and tasks to interact with workflow plans, check progress, update status, and ensure workflow steps are executed in the appropriate sequence.
+
+## Core Functions
+
+### 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.yml for custom plan location
+3. Return plan status (exists/not exists)
+```
+
+### 2. Parse Plan Status
+
+[[LLM: Extract current progress from the plan document]]
+
+**Plan Parsing Logic:**
+
+1. **Identify Step Structure**:
+   - Look for checkbox lines: `- [ ]` or `- [x]`
+   - Extract step IDs from comments: `<!-- step-id: X.Y -->`
+   - Identify agent assignments: `<!-- agent: pm -->`
+
+2. **Determine Current State**:
+   - Last completed step (highest numbered `[x]`)
+   - Next expected step (first `[ ]` after completed steps)
+   - Overall progress percentage
+
+3. **Extract Metadata**:
+   - Workflow type from plan header
+   - Decision points and their status
+   - Any deviation notes
+
+### 3. Sequence Validation
+
+[[LLM: Check if requested action aligns with plan sequence]]
+
+**Validation Rules:**
+
+1. **Strict Mode** (enforceSequence: true):
+   - Must complete steps in exact order
+   - Warn and block if out of sequence
+   - Require explicit override justification
+
+2. **Flexible Mode** (enforceSequence: false):
+   - Warn about sequence deviation
+   - Allow with confirmation
+   - Log deviation reason
+
+**Warning Templates:**
+
+```
+SEQUENCE WARNING: 
+The workflow plan shows you should complete "{expected_step}" next.
+You're attempting to: "{requested_action}"
+
+In strict mode: Block and require plan update
+In flexible mode: Allow with confirmation
+```
+
+### 4. Plan Update Operations
+
+[[LLM: Provide consistent way to update plan progress]]
+
+**Update Actions:**
+
+1. **Mark Step Complete**:
+   - Change `- [ ]` to `- [x]`
+   - Add completion timestamp comment
+   - Update any status metadata
+
+2. **Add Deviation Note**:
+   - Insert note explaining why sequence changed
+   - Reference the deviation in plan
+
+3. **Update Current Step Pointer**:
+   - Add/move `<!-- current-step -->` marker
+   - Update last-modified timestamp
+
+### 5. Integration Instructions
+
+[[LLM: How agents and tasks should use this utility]]
+
+**For Agents (startup sequence)**:
+
+```
+1. Check if plan exists using this utility
+2. If exists:
+   - Parse current status
+   - Show user: "Active workflow plan detected. Current step: {X}"
+   - Suggest: "Next recommended action: {next_step}"
+3. Continue with normal startup
+```
+
+**For Tasks (pre-execution)**:
+
+```
+1. Check if plan exists
+2. If exists:
+   - Verify this task aligns with plan
+   - If not aligned:
+     - In strict mode: Show warning and stop
+     - In flexible mode: Show warning and ask for confirmation
+3. After task completion:
+   - Update plan if task was a planned step
+   - Add note if task was unplanned
+```
+
+### 6. Plan Status Report Format
+
+[[LLM: Standard format for showing plan status]]
+
+```
+📋 Workflow Plan Status
+━━━━━━━━━━━━━━━━━━━━
+Workflow: {workflow_name}
+Progress: {X}% complete ({completed}/{total} steps)
+
+✅ Completed:
+- {completed_step_1}
+- {completed_step_2}
+
+🔄 Current Step:
+- {current_step_description}
+
+📌 Upcoming:
+- {next_step_1}
+- {next_step_2}
+
+⚠️ Notes:
+- {any_deviations_or_notes}
+```
+
+### 7. Decision Point Handling
+
+[[LLM: Special handling for workflow decision points]]
+
+When encountering a decision point in the plan:
+
+1. **Identify Decision Marker**: `<!-- decision: {decision_id} -->`
+2. **Check Decision Status**: Made/Pending
+3. **If Pending**: 
+   - Block progress until decision made
+   - Show options to user
+   - Record decision when made
+4. **If Made**: 
+   - Verify current path aligns with decision
+   - Warn if attempting alternate path
+
+### 8. Plan Abandonment
+
+[[LLM: Graceful handling when user wants to stop following plan]]
+
+If user wants to abandon plan:
+
+1. Confirm abandonment intent
+2. Add abandonment note to plan
+3. Mark plan as "Abandoned" in header
+4. Stop plan checking for remainder of session
+5. Suggest creating new plan if needed
+
+## Usage Examples
+
+### Example 1: Agent Startup Check
+
+```
+BMad Master starting...
+
+[Check for plan]
+Found active workflow plan: brownfield-fullstack
+Progress: 40% complete (4/10 steps)
+Current step: Create PRD (pm agent)
+
+Suggestion: Based on your plan, you should work with the PM agent next.
+Use *agent pm to switch, or *plan-status to see full progress.
+```
+
+### Example 2: Task Sequence Warning
+
+```
+User: *task create-next-story
+
+[Plan check triggered]
+⚠️ SEQUENCE WARNING: 
+Your workflow plan indicates the PRD hasn't been created yet.
+Creating stories before the PRD may lead to incomplete requirements.
+
+Would you like to:
+1. Continue anyway (will note deviation in plan)
+2. Switch to creating PRD first (*agent pm)
+3. View plan status (*plan-status)
+```
+
+### Example 3: Automatic Plan Update
+
+```
+[After completing create-doc task for PRD]
+
+✅ Plan Updated: Marked "Create PRD" as complete
+📍 Next step: Create Architecture Document (architect agent)
+```
+
+## Implementation Notes
+
+- This utility should be lightweight and fast
+- Plan parsing should be resilient to format variations
+- Always preserve user agency - warnings not blocks (unless strict mode)
+- Plan updates should be atomic to prevent corruption
+- Consider plan versioning for rollback capability
+
+## Error Handling
+
+- Missing plan: Return null, don't error
+- Malformed plan: Warn but continue, treat as no plan
+- Update failures: Log but don't block task completion
+- Parse errors: Fallback to basic text search

package/bmad-core/workflows/brownfield-fullstack.yml

@@ -12,23 +12,76 @@ workflow:
     - integration-enhancement
 
   sequence:
+    - step: enhancement_classification
+      agent: analyst
+      action: classify enhancement scope
+      notes: |
+        Determine enhancement complexity to route to appropriate path:
+        - Single story (< 4 hours) → Use brownfield-create-story task
+        - Small feature (1-3 stories) → Use brownfield-create-epic task  
+        - Major enhancement (multiple epics) → Continue with full workflow
+        
+        Ask user: "Can you describe the enhancement scope? Is this a small fix, a feature addition, or a major enhancement requiring architectural changes?"
+
+    - step: routing_decision
+      condition: based_on_classification
+      routes:
+        single_story:
+          agent: pm
+          uses: brownfield-create-story
+          notes: "Create single story for immediate implementation. Exit workflow after story creation."
+        small_feature:
+          agent: pm
+          uses: brownfield-create-epic
+          notes: "Create focused epic with 1-3 stories. Exit workflow after epic creation."
+        major_enhancement:
+          continue: to_next_step
+          notes: "Continue with comprehensive planning workflow below."
+
+    - step: documentation_check
+      agent: analyst
+      action: check existing documentation
+      condition: major_enhancement_path
+      notes: |
+        Check if adequate project documentation exists:
+        - Look for existing architecture docs, API specs, coding standards
+        - Assess if documentation is current and comprehensive
+        - If adequate: Skip document-project, proceed to PRD
+        - If inadequate: Run document-project first
+
     - step: project_analysis
       agent: architect
       action: analyze existing project and use task document-project
-      creates: multiple documents per the document-project template
-      notes: "Review existing documentation, codebase structure, and identify integration points. Document current system understanding before proceeding."
+      creates: brownfield-architecture.md (or multiple documents)
+      condition: documentation_inadequate
+      notes: "Run document-project to capture current system state, technical debt, and constraints. Pass findings to PRD creation."
 
     - agent: pm
       creates: prd.md
       uses: brownfield-prd-tmpl
-      requires: existing_project_analysis
-      notes: "Creates comprehensive PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
+      requires: existing_documentation_or_analysis
+      notes: |
+        Creates PRD for major enhancement. If document-project was run, reference its output to avoid re-analysis.
+        If skipped, use existing project documentation.
+        SAVE OUTPUT: Copy final prd.md to your project's docs/ folder.
+
+    - step: architecture_decision
+      agent: pm/architect
+      action: determine if architecture document needed
+      condition: after_prd_creation
+      notes: |
+        Review PRD to determine if architectural planning is needed:
+        - New architectural patterns → Create architecture doc
+        - New libraries/frameworks → Create architecture doc
+        - Platform/infrastructure changes → Create architecture doc
+        - Following existing patterns → Skip to story creation
 
     - agent: architect
       creates: architecture.md
       uses: brownfield-architecture-tmpl
       requires: prd.md
-      notes: "Creates architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
+      condition: architecture_changes_needed
+      notes: "Creates architecture ONLY for significant architectural changes. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
 
     - agent: po
       validates: all_artifacts
@@ -40,60 +93,162 @@ workflow:
       condition: po_checklist_issues
       notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
 
+    - agent: po
+      action: shard_documents
+      creates: sharded_docs
+      requires: all_artifacts_in_project
+      notes: |
+        Shard documents for IDE development:
+        - Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
+        - Option B: Manual: Drag shard-doc task + docs/prd.md into chat
+        - Creates docs/prd/ and docs/architecture/ folders with sharded content
+
+    - agent: sm
+      action: create_story
+      creates: story.md
+      requires: sharded_docs_or_brownfield_docs
+      repeats: for_each_epic_or_enhancement
+      notes: |
+        Story creation cycle:
+        - For sharded PRD: @sm → *create (uses create-next-story)
+        - For brownfield docs: @sm → use create-brownfield-story task
+        - Creates story from available documentation
+        - Story starts in "Draft" status
+        - May require additional context gathering for brownfield
+
+    - agent: analyst/pm
+      action: review_draft_story
+      updates: story.md
+      requires: story.md
+      optional: true
+      condition: user_wants_story_review
+      notes: |
+        OPTIONAL: Review and approve draft story
+        - NOTE: story-review task coming soon
+        - Review story completeness and alignment
+        - Update story status: Draft → Approved
+
+    - agent: dev
+      action: implement_story
+      creates: implementation_files
+      requires: story.md
+      notes: |
+        Dev Agent (New Chat): @dev
+        - Implements approved story
+        - Updates File List with all changes
+        - Marks story as "Review" when complete
+
+    - agent: qa
+      action: review_implementation
+      updates: implementation_files
+      requires: implementation_files
+      optional: true
+      notes: |
+        OPTIONAL: QA Agent (New Chat): @qa → review-story
+        - Senior dev review with refactoring ability
+        - Fixes small issues directly
+        - Leaves checklist for remaining items
+        - Updates story status (Review → Done or stays Review)
+
+    - agent: dev
+      action: address_qa_feedback
+      updates: implementation_files
+      condition: qa_left_unchecked_items
+      notes: |
+        If QA left unchecked items:
+        - Dev Agent (New Chat): Address remaining items
+        - Return to QA for final approval
+
+    - repeat_development_cycle:
+      action: continue_for_all_stories
+      notes: |
+        Repeat story cycle (SM → Dev → QA) for all epic stories
+        Continue until all stories in PRD are complete
+
+    - agent: po
+      action: epic_retrospective
+      creates: epic-retrospective.md
+      condition: epic_complete
+      optional: true
+      notes: |
+        OPTIONAL: After epic completion
+        - NOTE: epic-retrospective task coming soon
+        - Validate epic was completed correctly
+        - Document learnings and improvements
+
     - workflow_end:
-      action: move_to_ide
+      action: project_complete
       notes: |
-        Planning phase complete! Now transition to IDE Development:
-        
-        1. ENSURE DOCUMENTS ARE IN PROJECT:
-           - Copy final prd.md to project's docs/prd.md
-           - Copy final architecture.md to project's docs/architecture.md
-           - All documents must be in the project before proceeding
-        
-        2. SHARD DOCUMENTS (in IDE):
-           - Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
-           - Option B: Manual: Drag shard-doc task + docs/prd.md into chat
-           - This creates docs/prd/ and docs/architecture/ folders with sharded content
-        
-        3. START DEVELOPMENT CYCLE:
-           a. SM Agent (New Chat): @sm → *create
-              - Creates next story from sharded docs
-              - Review and approve story (Draft → Approved)
-           
-           b. Dev Agent (New Chat): @dev
-              - Implements approved story
-              - Updates File List with all changes
-              - Marks story as "Review" when complete
-           
-           c. QA Agent (New Chat): @qa → review-story
-              - Senior dev review with refactoring ability
-              - Fixes small issues directly
-              - Leaves checklist for remaining items
-              - Updates story status (Review → Done or stays Review)
-           
-           d. If QA left unchecked items:
-              - Dev Agent (New Chat): Address remaining items
-              - Return to QA for final approval
-        
-        4. REPEAT: Continue cycle for all epic stories
+        All stories implemented and reviewed!
+        Project development phase complete.
         
         Reference: data#bmad-kb:IDE Development Workflow
 
   flow_diagram: |
     ```mermaid
     graph TD
-        A[Start: Brownfield Enhancement] --> B[analyst: analyze existing project]
-        B --> C[pm: prd.md]
-        C --> D[architect: architecture.md]
-        D --> E[po: validate with po-master-checklist]
-        E --> F{PO finds issues?}
-        F -->|Yes| G[Return to relevant agent for fixes]
-        F -->|No| H[Move to IDE Environment]
-        G --> E
-
-        style H fill:#90EE90
-        style C fill:#FFE4B5
-        style D fill:#FFE4B5
+        A[Start: Brownfield Enhancement] --> B[analyst: classify enhancement scope]
+        B --> C{Enhancement Size?}
+        
+        C -->|Single Story| D[pm: brownfield-create-story]
+        C -->|1-3 Stories| E[pm: brownfield-create-epic]
+        C -->|Major Enhancement| F[analyst: check documentation]
+        
+        D --> END1[To Dev Implementation]
+        E --> END2[To Story Creation]
+        
+        F --> G{Docs Adequate?}
+        G -->|No| H[architect: document-project]
+        G -->|Yes| I[pm: brownfield PRD]
+        H --> I
+        
+        I --> J{Architecture Needed?}
+        J -->|Yes| K[architect: architecture.md]
+        J -->|No| L[po: validate artifacts]
+        K --> L
+        
+        L --> M{PO finds issues?}
+        M -->|Yes| N[Fix issues]
+        M -->|No| O[po: shard documents]
+        N --> L
+        
+        O --> P[sm: create story]
+        P --> Q{Story Type?}
+        Q -->|Sharded PRD| R[create-next-story]
+        Q -->|Brownfield Docs| S[create-brownfield-story]
+        
+        R --> T{Review draft?}
+        S --> T
+        T -->|Yes| U[review & approve]
+        T -->|No| V[dev: implement]
+        U --> V
+        
+        V --> W{QA review?}
+        W -->|Yes| X[qa: review]
+        W -->|No| Y{More stories?}
+        X --> Z{Issues?}
+        Z -->|Yes| AA[dev: fix]
+        Z -->|No| Y
+        AA --> X
+        Y -->|Yes| P
+        Y -->|No| AB{Retrospective?}
+        AB -->|Yes| AC[po: retrospective]
+        AB -->|No| AD[Complete]
+        AC --> AD
+
+        style AD fill:#90EE90
+        style END1 fill:#90EE90
+        style END2 fill:#90EE90
+        style D fill:#87CEEB
+        style E fill:#87CEEB
+        style I fill:#FFE4B5
+        style K fill:#FFE4B5
+        style O fill:#ADD8E6
+        style P fill:#ADD8E6
+        style V fill:#ADD8E6
+        style U fill:#F0E68C
+        style X fill:#F0E68C
+        style AC fill:#F0E68C
     ```
 
   decision_guidance:
@@ -105,8 +260,38 @@ workflow:
       - Multiple team members will work on related changes
 
   handoff_prompts:
-    analyst_to_pm: "Existing project analysis complete. Create comprehensive PRD with integration strategy."
-    pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the integration architecture."
+    classification_complete: |
+      Enhancement classified as: {{enhancement_type}}
+      {{if single_story}}: Proceeding with brownfield-create-story task for immediate implementation.
+      {{if small_feature}}: Creating focused epic with brownfield-create-epic task.
+      {{if major_enhancement}}: Continuing with comprehensive planning workflow.
+    
+    documentation_assessment: |
+      Documentation assessment complete:
+      {{if adequate}}: Existing documentation is sufficient. Proceeding directly to PRD creation.
+      {{if inadequate}}: Running document-project to capture current system state before PRD.
+    
+    document_project_to_pm: |
+      Project analysis complete. Key findings documented in:
+      - {{document_list}}
+      Use these findings to inform PRD creation and avoid re-analyzing the same aspects.
+    
+    pm_to_architect_decision: |
+      PRD complete and saved as docs/prd.md. 
+      Architectural changes identified: {{yes/no}}
+      {{if yes}}: Proceeding to create architecture document for: {{specific_changes}}
+      {{if no}}: No architectural changes needed. Proceeding to validation.
+    
     architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
-    po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
-    complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
+    
+    po_to_sm: |
+      All artifacts validated. 
+      Documentation type available: {{sharded_prd / brownfield_docs}}
+      {{if sharded}}: Use standard create-next-story task.
+      {{if brownfield}}: Use create-brownfield-story task to handle varied documentation formats.
+    
+    sm_story_creation: |
+      Creating story from {{documentation_type}}.
+      {{if missing_context}}: May need to gather additional context from user during story creation.
+    
+    complete: "All planning artifacts validated and development can begin. Stories will be created based on available documentation format."