bmad-method 4.22.1 → 4.24.0

package/bmad-core/tasks/create-workflow-plan.md

@@ -0,0 +1,289 @@
+# Create Workflow Plan Task
+
+## Purpose
+
+Guide users through workflow selection and create a detailed plan document that outlines the selected workflow steps, decision points, and expected outputs. This task helps users understand what will happen before starting a complex workflow and provides a checklist to track progress.
+
+## Task Instructions
+
+### 1. Understand User's Goal
+
+[[LLM: Start with discovery questions to understand what the user wants to accomplish]]
+
+Ask the user:
+
+1. **Project Type**:
+   - Are you starting a new project (greenfield) or enhancing an existing one (brownfield)?
+   - What type of application? (web app, service/API, UI only, full-stack)
+
+2. **For Greenfield**:
+   - Do you need a quick prototype or production-ready application?
+   - Will this have a UI component?
+   - Single service or multiple services?
+
+3. **For Brownfield**:
+   - What's the scope of the enhancement?
+     - Single bug fix or small feature (few hours)
+     - Small enhancement (1-3 stories)
+     - Major feature requiring coordination
+     - Architectural changes or modernization
+   - Do you have existing documentation?
+   - Are you following existing patterns or introducing new ones?
+
+### 2. Recommend Appropriate Workflow
+
+Based on the answers, recommend:
+
+**Greenfield Options:**
+
+- `greenfield-fullstack` - Complete web application
+- `greenfield-service` - Backend API/service only
+- `greenfield-ui` - Frontend only
+
+**Brownfield Options:**
+
+- `brownfield-create-story` - Single small change
+- `brownfield-create-epic` - Small feature (1-3 stories)
+- `brownfield-fullstack` - Major enhancement
+
+**Simplified Option:**
+
+- For users unsure or wanting flexibility, suggest starting with individual agent tasks
+
+### 3. Explain Selected Workflow
+
+[[LLM: Once workflow is selected, provide clear explanation]]
+
+For the selected workflow, explain:
+
+1. **Overview**: What this workflow accomplishes
+2. **Duration**: Estimated time for planning phase
+3. **Outputs**: What documents will be created
+4. **Decision Points**: Where user input will be needed
+5. **Requirements**: What information should be ready
+
+### 4. Create Workflow Plan Document
+
+[[LLM: Generate a comprehensive plan document with the following structure]]
+
+```markdown
+# Workflow Plan: {{Workflow Name}}
+
+<!-- WORKFLOW-PLAN-META
+workflow-id: {{workflow-id}}
+status: active
+created: {{ISO-8601 timestamp}}
+updated: {{ISO-8601 timestamp}}
+version: 1.0
+-->
+
+**Created Date**: {{current date}}
+**Project**: {{project name}}
+**Type**: {{greenfield/brownfield}}
+**Status**: Active
+**Estimated Planning Duration**: {{time estimate}}
+
+## Objective
+
+{{Clear description of what will be accomplished}}
+
+## Selected Workflow
+
+**Workflow**: `{{workflow-id}}`
+**Reason**: {{Why this workflow fits the user's needs}}
+
+## Workflow Steps
+
+### Planning Phase
+
+- [ ] Step 1: {{step name}} <!-- step-id: 1.1, agent: {{agent}}, task: {{task}} -->
+  - **Agent**: {{agent name}}
+  - **Action**: {{what happens}}
+  - **Output**: {{what's created}}
+  - **User Input**: {{if any}}
+
+- [ ] Step 2: {{step name}} <!-- step-id: 1.2, agent: {{agent}}, task: {{task}} -->
+  - **Agent**: {{agent name}}
+  - **Action**: {{what happens}}
+  - **Output**: {{what's created}}
+  - **Decision Point**: {{if any}} <!-- decision-id: D1 -->
+
+{{Continue for all planning steps}}
+
+### Development Phase (IDE)
+
+- [ ] Document Sharding <!-- step-id: 2.1, agent: po, task: shard-doc -->
+  - Prepare documents for story creation
+
+- [ ] Story Development Cycle <!-- step-id: 2.2, repeats: true -->
+  - [ ] Create story (SM agent) <!-- step-id: 2.2.1, agent: sm, task: create-next-story -->
+  - [ ] Review story (optional) <!-- step-id: 2.2.2, agent: analyst, optional: true -->
+  - [ ] Implement story (Dev agent) <!-- step-id: 2.2.3, agent: dev -->
+  - [ ] QA review (optional) <!-- step-id: 2.2.4, agent: qa, optional: true -->
+  - [ ] Repeat for all stories
+
+- [ ] Epic Retrospective (optional) <!-- step-id: 2.3, agent: po, optional: true -->
+
+## Key Decision Points
+
+1. **{{Decision Name}}** (Step {{n}}): <!-- decision-id: D1, status: pending -->
+   - Trigger: {{what causes this decision}}
+   - Options: {{available choices}}
+   - Impact: {{how it affects the workflow}}
+   - Decision Made: _Pending_
+
+{{List all decision points}}
+
+## Expected Outputs
+
+### Planning Documents
+- [ ] {{document 1}} - {{description}}
+- [ ] {{document 2}} - {{description}}
+{{etc...}}
+
+### Development Artifacts
+- [ ] Stories in `docs/stories/`
+- [ ] Implementation code
+- [ ] Tests
+- [ ] Updated documentation
+
+## Prerequisites Checklist
+
+Before starting this workflow, ensure you have:
+
+- [ ] {{prerequisite 1}}
+- [ ] {{prerequisite 2}}
+- [ ] {{prerequisite 3}}
+{{etc...}}
+
+## Customization Options
+
+Based on your project needs, you may:
+- Skip {{optional step}} if {{condition}}
+- Add {{additional step}} if {{condition}}
+- Choose {{alternative}} instead of {{default}}
+
+## Risk Considerations
+
+{{For brownfield only}}
+- Integration complexity: {{assessment}}
+- Rollback strategy: {{approach}}
+- Testing requirements: {{special needs}}
+
+## Next Steps
+
+1. Review this plan and confirm it matches your expectations
+2. Gather any missing prerequisites
+3. Start workflow with: `*task workflow {{workflow-id}}`
+4. Or begin with first agent: `@{{first-agent}}`
+
+## Notes
+
+{{Any additional context or warnings}}
+
+---
+*This plan can be updated as you progress through the workflow. Check off completed items to track progress.*
+```
+
+### 5. Save and Present Plan
+
+1. Save the plan as `docs/workflow-plan.md`
+2. Inform user: "Workflow plan created at docs/workflow-plan.md"
+3. Offer options:
+   - Review the plan together
+   - Start the workflow now
+   - Gather prerequisites first
+   - Modify the plan
+
+### 6. Plan Variations
+
+[[LLM: Adjust plan detail based on workflow complexity]]
+
+**For Simple Workflows** (create-story, create-epic):
+
+- Simpler checklist format
+- Focus on immediate next steps
+- Less detailed explanations
+
+**For Complex Workflows** (full greenfield/brownfield):
+
+- Detailed step breakdowns
+- All decision points documented
+- Comprehensive output descriptions
+- Risk mitigation sections
+
+**For Brownfield Workflows**:
+
+- Include existing system impact analysis
+- Document integration checkpoints
+- Add rollback considerations
+- Note documentation dependencies
+
+### 7. Interactive Planning Mode
+
+[[LLM: If user wants to customize the workflow]]
+
+If user wants to modify the standard workflow:
+
+1. Present workflow steps as options
+2. Allow skipping optional steps
+3. Let user reorder certain steps
+4. Document customizations in plan
+5. Warn about dependencies if steps are skipped
+
+### 8. Execution Guidance
+
+After plan is created, provide clear guidance:
+
+```text
+Your workflow plan is ready! Here's how to proceed:
+
+1. **Review the plan**: Check that all steps align with your goals
+2. **Gather prerequisites**: Use the checklist to ensure you're ready
+3. **Start execution**:
+   - Full workflow: `*task workflow {{workflow-id}}`
+   - Step by step: Start with `@{{first-agent}}`
+4. **Track progress**: Check off steps in the plan as completed
+
+Would you like to:
+a) Review the plan together
+b) Start the workflow now
+c) Gather prerequisites first
+d) Modify the plan
+```
+
+## Success Criteria
+
+The workflow plan is successful when:
+
+1. User clearly understands what will happen
+2. All decision points are documented
+3. Prerequisites are identified
+4. Expected outputs are clear
+5. User feels confident to proceed
+6. Plan serves as useful progress tracker
+
+## Integration with BMad Master and Orchestrator
+
+When used by BMad Master or BMad Orchestrator, this task should:
+
+1. Be offered when user asks about workflows
+2. Be suggested before starting complex workflows
+3. Create a plan that the agent can reference during execution
+4. Allow the agent to track progress against the plan
+
+## Example Usage
+
+```text
+User: "I need to add a payment system to my existing app"
+
+BMad Orchestrator: "Let me help you create a workflow plan for that enhancement. I'll ask a few questions to recommend the best approach..."
+
+[Runs through discovery questions]
+
+BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack workflow. Let me create a detailed plan for you..."
+
+[Creates and saves plan]
+
+BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
+```

package/bmad-core/tasks/update-workflow-plan.md

@@ -0,0 +1,248 @@
+# Update Workflow Plan Task
+
+## Purpose
+
+Update the status of steps in an active workflow plan, mark completions, add notes about deviations, and maintain an accurate record of workflow progress. This task can be called directly by users or automatically by other tasks upon completion.
+
+## Task Instructions
+
+### 0. Load Plan Configuration
+
+[[LLM: First load core-config.yml to get plan settings]]
+
+Check workflow configuration:
+
+- `workflow.planFile` - Location of the plan (default: docs/workflow-plan.md)
+- `workflow.trackProgress` - Whether tracking is enabled
+- `workflow.updateOnCompletion` - Whether to auto-update on task completion
+
+If tracking is disabled, inform user and exit.
+
+### 1. Verify Plan Exists
+
+[[LLM: Check if workflow plan exists at configured location]]
+
+If no plan exists:
+
+```
+No active workflow plan found at {location}.
+Would you like to create one? Use *plan command.
+```
+
+### 2. Determine Update Type
+
+[[LLM: Ask user what type of update they want to make]]
+
+Present options:
+
+```
+What would you like to update in the workflow plan?
+
+1. Mark step as complete
+2. Update current step
+3. Add deviation note
+4. Mark decision point resolution
+5. Update overall status
+6. View current plan status only
+
+Please select an option (1-6):
+```
+
+### 3. Parse Current Plan
+
+[[LLM: Read and parse the plan to understand current state]]
+
+Extract:
+
+- All steps with their checkbox status
+- Step IDs from comments (if present)
+- Current completion percentage
+- Any existing deviation notes
+- Decision points and their status
+
+### 4. Execute Updates
+
+#### 4.1 Mark Step Complete
+
+If user selected option 1:
+
+1. Show numbered list of incomplete steps
+2. Ask which step to mark complete
+3. Update the checkbox from `[ ]` to `[x]`
+4. Add completion timestamp: `<!-- completed: YYYY-MM-DD HH:MM -->`
+5. If this was the current step, identify next step
+
+#### 4.2 Update Current Step
+
+If user selected option 2:
+
+1. Show all steps with current status
+2. Ask which step is now current
+3. Add/move `<!-- current-step -->` marker
+4. Optionally add note about why sequence changed
+
+#### 4.3 Add Deviation Note
+
+If user selected option 3:
+
+1. Ask for deviation description
+2. Ask which step this relates to (or general)
+3. Insert note in appropriate location:
+
+```markdown
+> **Deviation Note** (YYYY-MM-DD): {user_note}
+> Related to: Step X.Y or General workflow
+```
+
+#### 4.4 Mark Decision Resolution
+
+If user selected option 4:
+
+1. Show pending decision points
+2. Ask which decision was made
+3. Record the decision and chosen path
+4. Update related steps based on decision
+
+#### 4.5 Update Overall Status
+
+If user selected option 5:
+
+1. Show current overall status
+2. Provide options:
+   - Active (continuing with plan)
+   - Paused (temporarily stopped)
+   - Abandoned (no longer following)
+   - Complete (all steps done)
+3. Update plan header with new status
+
+### 5. Automatic Updates (When Called by Tasks)
+
+[[LLM: When called automatically by another task]]
+
+If called with parameters:
+
+```
+task: {task_name}
+step_id: {step_identifier}
+status: complete|skipped|failed
+note: {optional_note}
+```
+
+Automatically:
+
+1. Find the corresponding step
+2. Update its status
+3. Add completion metadata
+4. Add note if provided
+5. Calculate new progress percentage
+
+### 6. Generate Update Summary
+
+After updates, show summary:
+
+```
+✅ Workflow Plan Updated
+
+Changes made:
+- {change_1}
+- {change_2}
+
+New Status:
+- Progress: {X}% complete ({completed}/{total} steps)
+- Current Step: {current_step}
+- Next Recommended: {next_step}
+
+Plan location: {file_path}
+```
+
+### 7. Integration with Other Tasks
+
+[[LLM: How other tasks should call this]]
+
+Other tasks can integrate by:
+
+1. **After Task Completion**:
+
+```
+At end of task execution:
+- Check if task corresponds to a plan step
+- If yes, call update-workflow-plan with:
+  - task: {current_task_name}
+  - step_id: {matching_step}
+  - status: complete
+```
+
+2. **On Task Failure**:
+
+```
+If task fails:
+- Call update-workflow-plan with:
+  - task: {current_task_name}
+  - status: failed
+  - note: {failure_reason}
+```
+
+### 8. Plan Status Display
+
+[[LLM: When user selects view status only]]
+
+Display comprehensive status:
+
+```markdown
+📋 Workflow Plan Status
+━━━━━━━━━━━━━━━━━━━━
+Workflow: {workflow_name}
+Status: {Active|Paused|Complete}
+Progress: {X}% complete ({completed}/{total} steps)
+Last Updated: {timestamp}
+
+✅ Completed Steps:
+- [x] Step 1.1: {description} (completed: {date})
+- [x] Step 1.2: {description} (completed: {date})
+
+🔄 Current Step:
+- [ ] Step 2.1: {description} <!-- current-step -->
+  Agent: {agent_name}
+  Task: {task_name}
+
+📌 Upcoming Steps:
+- [ ] Step 2.2: {description}
+- [ ] Step 3.1: {description}
+
+⚠️ Deviations/Notes:
+{any_deviation_notes}
+
+📊 Decision Points:
+- Decision 1: {status} - {choice_made}
+- Decision 2: Pending
+
+💡 Next Action:
+Based on the plan, you should {recommended_action}
+```
+
+## Success Criteria
+
+The update is successful when:
+
+1. Plan accurately reflects current workflow state
+2. All updates are clearly timestamped
+3. Deviations are documented with reasons
+4. Progress calculation is correct
+5. Next steps are clear to user
+6. Plan remains readable and well-formatted
+
+## Error Handling
+
+- **Plan file not found**: Offer to create new plan
+- **Malformed plan**: Attempt basic updates, warn user
+- **Write permission error**: Show changes that would be made
+- **Step not found**: Show available steps, ask for clarification
+- **Concurrent updates**: Implement simple locking or warn about conflicts
+
+## Notes
+
+- Always preserve plan history (don't delete old information)
+- Keep updates atomic to prevent corruption
+- Consider creating backup before major updates
+- Updates should enhance, not complicate, the workflow experience
+- If plan becomes too cluttered, suggest creating fresh plan for next phase

package/bmad-core/templates/brownfield-prd-tmpl.md

@@ -22,34 +22,45 @@ Do not proceed with any recommendations until the user has validated your unders
 
 ### Existing Project Overview
 
-[[LLM: If working in IDE with project loaded, analyze the project structure and existing documentation. If working in web interface, request project upload or detailed project information from user.]]
+[[LLM: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.]]
 
-**Project Location**: [[LLM: Note if this is IDE-based analysis or user-provided information]]
+**Analysis Source**: [[LLM: Indicate one of the following:
+- Document-project output available at: {{path}}
+- IDE-based fresh analysis
+- User-provided information
+]]
 
-**Current Project State**: [[LLM: Brief description of what the project currently does and its primary purpose]]
+**Current Project State**: [[LLM: 
+- If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
+- Otherwise: Brief description of what the project currently does and its primary purpose
+]]
 
 ### Available Documentation Analysis
 
-[[LLM: Check for existing documentation in docs folder or provided by user. List what documentation is available and assess its completeness. Required documents include:
+[[LLM: 
+If document-project was run:
+- Note: "Document-project analysis available - using existing technical documentation"
+- List key documents created by document-project
+- Skip the missing documentation check below
 
-- Tech stack documentation
-- Source tree/architecture overview
-- Coding standards
-- API documentation or OpenAPI specs
-- External API integrations
-- UX/UI guidelines or existing patterns]]
+Otherwise, check for existing documentation:
+]]
 
 **Available Documentation**:
 
-- [ ] Tech Stack Documentation
-- [ ] Source Tree/Architecture
-- [ ] Coding Standards
-- [ ] API Documentation
-- [ ] External API Documentation
-- [ ] UX/UI Guidelines
+- [ ] Tech Stack Documentation [[LLM: If from document-project, check ✓]]
+- [ ] Source Tree/Architecture [[LLM: If from document-project, check ✓]]
+- [ ] Coding Standards [[LLM: If from document-project, may be partial]]
+- [ ] API Documentation [[LLM: If from document-project, check ✓]]
+- [ ] External API Documentation [[LLM: If from document-project, check ✓]]
+- [ ] UX/UI Guidelines [[LLM: May not be in document-project]]
+- [ ] Technical Debt Documentation [[LLM: If from document-project, check ✓]]
 - [ ] Other: \***\*\_\_\_\*\***
 
-[[LLM: If critical documentation is missing, STOP and recommend: "I recommend running the document-project task first to generate baseline documentation including tech-stack, source-tree, coding-standards, APIs, external-APIs, and UX/UI information. This will provide the foundation needed for a comprehensive brownfield PRD."]]
+[[LLM: 
+- If document-project was already run: "Using existing project analysis from document-project output."
+- If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
+]]
 
 ### Enhancement Scope Definition
 
@@ -139,13 +150,19 @@ Do not proceed with any recommendations until the user has validated your unders
 
 ### Existing Technology Stack
 
-[[LLM: Document the current technology stack that must be maintained or integrated with]]
+[[LLM: 
+If document-project output available:
+- Extract from "Actual Tech Stack" table in High Level Architecture section
+- Include version numbers and any noted constraints
 
-**Languages**: [[LLM: Current programming languages in use]]
-**Frameworks**: [[LLM: Current frameworks and their versions]]
-**Database**: [[LLM: Current database technology and schema considerations]]
-**Infrastructure**: [[LLM: Current deployment and hosting infrastructure]]
-**External Dependencies**: [[LLM: Current third-party services and APIs]]
+Otherwise, document the current technology stack:
+]]
+
+**Languages**: [[LLM: From document-project or fresh analysis]]
+**Frameworks**: [[LLM: From document-project or fresh analysis]]
+**Database**: [[LLM: From document-project or fresh analysis]]
+**Infrastructure**: [[LLM: From document-project or fresh analysis]]
+**External Dependencies**: [[LLM: From document-project "External Services" section or fresh analysis]]
 
 ### Integration Approach
 
@@ -176,12 +193,19 @@ Do not proceed with any recommendations until the user has validated your unders
 
 ### Risk Assessment and Mitigation
 
-[[LLM: Identify risks specific to working with existing codebase]]
+[[LLM: 
+If document-project output available:
+- Reference "Technical Debt and Known Issues" section
+- Include "Workarounds and Gotchas" that might impact enhancement
+- Note any identified constraints from "Critical Technical Debt"
+
+Build risk assessment incorporating existing known issues:
+]]
 
-**Technical Risks**: [[LLM: Risks related to modifying existing code]]
-**Integration Risks**: [[LLM: Risks in integrating with existing systems]]
-**Deployment Risks**: [[LLM: Risks in deploying alongside existing features]]
-**Mitigation Strategies**: [[LLM: Specific strategies to address identified risks]]
+**Technical Risks**: [[LLM: Include risks from document-project + new enhancement risks]]
+**Integration Risks**: [[LLM: Reference integration constraints from document-project]]
+**Deployment Risks**: [[LLM: Include deployment gotchas from document-project]]
+**Mitigation Strategies**: [[LLM: Address both existing and new risks]]
 
 ## Epic and Story Structure