bmad-method 5.1.3 → 6.0.0-alpha.1

package/src/modules/bmm/workflows/workflow-status/instructions.md

@@ -0,0 +1,324 @@
+# Workflow Status Check - Multi-Mode Service
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml</critical>
+<critical>This workflow operates in multiple modes: interactive (default), validate, data, init-check, update</critical>
+<critical>Other workflows can call this as a service to avoid duplicating status logic</critical>
+
+<workflow>
+
+<step n="0" goal="Determine execution mode">
+  <action>Check for {{mode}} parameter passed by calling workflow</action>
+  <action>Default mode = "interactive" if not specified</action>
+
+  <check if="mode == interactive">
+    <action>Continue to Step 1 for normal status check flow</action>
+  </check>
+
+  <check if="mode == validate">
+    <action>Jump to Step 10 for workflow validation service</action>
+  </check>
+
+  <check if="mode == data">
+    <action>Jump to Step 20 for data extraction service</action>
+  </check>
+
+  <check if="mode == init-check">
+    <action>Jump to Step 30 for simple init check</action>
+  </check>
+
+  <check if="mode == update">
+    <action>Jump to Step 40 for status update service</action>
+  </check>
+</step>
+
+<step n="1" goal="Check for status file">
+<action>Search {output_folder}/ for file: bmm-workflow-status.md</action>
+
+<check if="no status file found">
+  <output>No workflow status found. To get started:
+
+Load analyst agent and run: `workflow-init`
+
+This will guide you through project setup and create your workflow path.</output>
+<action>Exit workflow</action>
+</check>
+
+<check if="status file found">
+  <action>Continue to step 2</action>
+</check>
+</step>
+
+<step n="2" goal="Read and parse status">
+<action>Read bmm-workflow-status.md</action>
+<action>Extract key-value pairs from status file:</action>
+
+Parse these fields:
+
+- PROJECT_NAME
+- PROJECT_TYPE
+- PROJECT_LEVEL
+- FIELD_TYPE
+- CURRENT_PHASE
+- CURRENT_WORKFLOW
+- NEXT_ACTION
+- NEXT_COMMAND
+- NEXT_AGENT
+  </step>
+
+<step n="3" goal="Display current status and options">
+<action>Load workflow path file to check for optional steps</action>
+<action>Check if current workflow is in progress or complete</action>
+
+<output>
+## 📊 Current Status
+
+**Project:** {{PROJECT_NAME}} (Level {{PROJECT_LEVEL}} {{PROJECT_TYPE}})
+**Phase:** {{CURRENT_PHASE}}
+**Current Workflow:** {{CURRENT_WORKFLOW}}
+
+## 🎯 Your Options
+
+{{#if CURRENT_WORKFLOW != "complete"}}
+**Continue in progress:**
+
+- {{CURRENT_WORKFLOW}} ({{CURRENT_AGENT}} agent)
+  {{/if}}
+
+**Next required step:**
+
+- Command: `{{NEXT_COMMAND}}`
+- Agent: {{NEXT_AGENT}}
+
+{{#if optional_workflows_available}}
+**Optional workflows available:**
+{{#each optional_workflows}}
+
+- {{workflow_name}} ({{agent}})
+  {{/each}}
+  {{/if}}
+  </output>
+  </step>
+
+<step n="4" goal="Offer actions">
+<ask>What would you like to do?
+
+{{#if CURRENT_WORKFLOW != "complete"}}
+
+1. **Continue current** - Resume {{CURRENT_WORKFLOW}}
+   {{/if}}
+2. **Next required** - {{NEXT_COMMAND}}
+   {{#if optional_workflows_available}}
+3. **Optional workflow** - Choose from available options
+   {{/if}}
+4. **View full status** - See complete status file
+5. **Exit** - Return to agent
+
+Your choice:</ask>
+
+<action>Handle user selection based on available options</action>
+</step>
+
+<!-- ============================================= -->
+<!-- SERVICE MODES - Called by other workflows -->
+<!-- ============================================= -->
+
+<step n="10" goal="Validate mode - Check if calling workflow should proceed">
+<action>Read {output_folder}/bmm-workflow-status.md if exists</action>
+
+<check if="status file not found">
+  <template-output>status_exists = false</template-output>
+  <template-output>should_proceed = true</template-output>
+  <template-output>warning = "No status file found. Running without progress tracking."</template-output>
+  <template-output>suggestion = "Consider running workflow-init first for progress tracking"</template-output>
+  <action>Return to calling workflow</action>
+</check>
+
+<check if="status file found">
+  <action>Parse status file fields</action>
+  <action>Load workflow path file from WORKFLOW_PATH field</action>
+  <action>Check if {{calling_workflow}} matches CURRENT_WORKFLOW or NEXT_COMMAND</action>
+
+<template-output>status_exists = true</template-output>
+<template-output>current_phase = {{CURRENT_PHASE}}</template-output>
+<template-output>current_workflow = {{CURRENT_WORKFLOW}}</template-output>
+<template-output>next_workflow = {{NEXT_COMMAND}}</template-output>
+<template-output>project_level = {{PROJECT_LEVEL}}</template-output>
+<template-output>project_type = {{PROJECT_TYPE}}</template-output>
+<template-output>field_type = {{FIELD_TYPE}}</template-output>
+
+  <check if="calling_workflow == current_workflow">
+    <template-output>should_proceed = true</template-output>
+    <template-output>warning = ""</template-output>
+    <template-output>suggestion = "Resuming {{current_workflow}}"</template-output>
+  </check>
+
+  <check if="calling_workflow == next_workflow">
+    <template-output>should_proceed = true</template-output>
+    <template-output>warning = ""</template-output>
+    <template-output>suggestion = "Proceeding with planned next step"</template-output>
+  </check>
+
+  <check if="calling_workflow != current_workflow AND calling_workflow != next_workflow">
+    <action>Check if calling_workflow is in optional workflows list</action>
+
+    <check if="is optional">
+      <template-output>should_proceed = true</template-output>
+      <template-output>warning = "Running optional workflow {{calling_workflow}}"</template-output>
+      <template-output>suggestion = "This is optional. Expected next: {{next_workflow}}"</template-output>
+    </check>
+
+    <check if="not optional">
+      <template-output>should_proceed = true</template-output>
+      <template-output>warning = "⚠️ Out of sequence: Expected {{next_workflow}}, running {{calling_workflow}}"</template-output>
+      <template-output>suggestion = "Consider running {{next_workflow}} instead, or continue if intentional"</template-output>
+    </check>
+
+  </check>
+
+<template-output>status_file_path = {{path to bmm-workflow-status.md}}</template-output>
+</check>
+
+<action>Return control to calling workflow with all template outputs</action>
+</step>
+
+<step n="20" goal="Data mode - Extract specific information">
+<action>Read {output_folder}/bmm-workflow-status.md if exists</action>
+
+<check if="status file not found">
+  <template-output>status_exists = false</template-output>
+  <template-output>error = "No status file to extract data from"</template-output>
+  <action>Return to calling workflow</action>
+</check>
+
+<check if="status file found">
+  <action>Parse status file completely</action>
+  <template-output>status_exists = true</template-output>
+
+  <check if="data_request == project_config">
+    <template-output>project_name = {{PROJECT_NAME}}</template-output>
+    <template-output>project_type = {{PROJECT_TYPE}}</template-output>
+    <template-output>project_level = {{PROJECT_LEVEL}}</template-output>
+    <template-output>field_type = {{FIELD_TYPE}}</template-output>
+    <template-output>workflow_path = {{WORKFLOW_PATH}}</template-output>
+  </check>
+
+  <check if="data_request == phase_status">
+    <template-output>current_phase = {{CURRENT_PHASE}}</template-output>
+    <template-output>phase_1_complete = {{PHASE_1_COMPLETE}}</template-output>
+    <template-output>phase_2_complete = {{PHASE_2_COMPLETE}}</template-output>
+    <template-output>phase_3_complete = {{PHASE_3_COMPLETE}}</template-output>
+    <template-output>phase_4_complete = {{PHASE_4_COMPLETE}}</template-output>
+  </check>
+
+  <check if="data_request == all">
+    <action>Return all parsed fields as template outputs</action>
+  </check>
+
+<template-output>status_file_path = {{path to bmm-workflow-status.md}}</template-output>
+</check>
+
+<action>Return control to calling workflow with requested data</action>
+</step>
+
+<step n="30" goal="Init-check mode - Simple existence check">
+<action>Check if {output_folder}/bmm-workflow-status.md exists</action>
+
+<check if="exists">
+  <template-output>status_exists = true</template-output>
+  <template-output>suggestion = "Status file found. Ready to proceed."</template-output>
+</check>
+
+<check if="not exists">
+  <template-output>status_exists = false</template-output>
+  <template-output>suggestion = "No status file. Run workflow-init to create one (optional for progress tracking)"</template-output>
+</check>
+
+<action>Return immediately to calling workflow</action>
+</step>
+
+<step n="40" goal="Update mode - Centralized status file updates">
+<action>Read {output_folder}/bmm-workflow-status.md</action>
+
+<check if="status file not found">
+  <template-output>success = false</template-output>
+  <template-output>error = "No status file found. Cannot update."</template-output>
+  <action>Return to calling workflow</action>
+</check>
+
+<check if="status file found">
+  <action>Parse all current values from status file</action>
+  <action>Load workflow path file from WORKFLOW_PATH field</action>
+  <action>Check {{action}} parameter to determine update type</action>
+
+  <!-- ============================================= -->
+  <!-- ACTION: complete_workflow -->
+  <!-- ============================================= -->
+  <check if="action == complete_workflow">
+    <action>Get {{workflow_name}} parameter (required)</action>
+
+    <action>Mark workflow complete:</action>
+    - Update CURRENT_WORKFLOW to "{{workflow_name}} - Complete"
+
+    <action>Find {{workflow_name}} in loaded path YAML</action>
+    <action>Determine next workflow from path sequence</action>
+
+    <action>Update Next Action fields:</action>
+    - NEXT_ACTION: Description from next workflow in path
+    - NEXT_COMMAND: Command for next workflow
+    - NEXT_AGENT: Agent for next workflow
+    - CURRENT_WORKFLOW: Set to next workflow name (or "Complete" if no more)
+    - CURRENT_AGENT: Set to next agent
+
+    <action>Check if phase complete:</action>
+    - If {{workflow_name}} is last required workflow in current phase
+    - Update PHASE_X_COMPLETE to true
+    - Update CURRENT_PHASE to next phase (if applicable)
+
+    <action>Update LAST_UPDATED to {{date}}</action>
+    <action>Save status file</action>
+
+    <template-output>success = true</template-output>
+    <template-output>next_workflow = {{determined next workflow}}</template-output>
+    <template-output>next_agent = {{determined next agent}}</template-output>
+    <template-output>phase_complete = {{true/false}}</template-output>
+
+  </check>
+
+  <!-- ============================================= -->
+  <!-- ACTION: set_current_workflow (manual override) -->
+  <!-- ============================================= -->
+  <check if="action == set_current_workflow">
+    <action>Get {{workflow_name}} parameter (required)</action>
+    <action>Get {{agent_name}} parameter (optional)</action>
+
+    <action>Update current workflow:</action>
+    - CURRENT_WORKFLOW: {{workflow_name}}
+    - CURRENT_AGENT: {{agent_name or infer from path}}
+
+    <action>Find {{workflow_name}} in path to determine next:</action>
+    - NEXT_ACTION: Next workflow description
+    - NEXT_COMMAND: Next workflow command
+    - NEXT_AGENT: Next workflow agent
+
+    <action>Update LAST_UPDATED to {{date}}</action>
+    <action>Save status file</action>
+
+    <template-output>success = true</template-output>
+
+  </check>
+
+  <!-- ============================================= -->
+  <!-- Unknown action -->
+  <!-- ============================================= -->
+  <check if="action not recognized">
+    <template-output>success = false</template-output>
+    <template-output>error = "Unknown action: {{action}}. Valid actions: complete_workflow, set_current_workflow"</template-output>
+  </check>
+
+</check>
+
+<action>Return control to calling workflow with template outputs</action>
+</step>
+
+</workflow>

package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml

@@ -0,0 +1,54 @@
+# Brownfield Level 0 - Single Atomic Change in Existing Codebase
+# One change to existing system
+
+project_type: "software"
+level: 0
+field_type: "brownfield"
+description: "Single atomic change to existing codebase"
+
+phases:
+  - prerequisite: true
+    name: "Documentation"
+    conditional: "if_undocumented"
+    note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup"
+    workflows:
+      - id: "document-project"
+        required: true
+        agent: "analyst"
+        command: "document-project"
+        output: "Comprehensive project documentation"
+        purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4"
+
+  - phase: 1
+    name: "Analysis"
+    optional: true
+    workflows:
+      - id: "brainstorm-project"
+        optional: true
+        agent: "analyst"
+        command: "brainstorm-project"
+
+  - phase: 2
+    name: "Planning"
+    required: true
+    workflows:
+      - id: "tech-spec"
+        required: true
+        agent: "architect"
+        command: "tech-spec"
+        output: "Creates single story file"
+        note: "Must understand existing patterns"
+
+  - phase: 3
+    name: "Solutioning"
+    skip: true
+
+  - phase: 4
+    name: "Implementation"
+    required: true
+    workflows:
+      - id: "sprint-planning"
+        required: true
+        agent: "sm"
+        command: "sprint-planning"
+        note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status"

package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml

@@ -0,0 +1,58 @@
+# Brownfield Level 1 - Small Feature in Existing Codebase
+# 1-10 stories adding to existing system
+
+project_type: "software"
+level: 1
+field_type: "brownfield"
+description: "Small feature addition to existing codebase"
+
+phases:
+  - prerequisite: true
+    name: "Documentation"
+    conditional: "if_undocumented"
+    note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup"
+    workflows:
+      - id: "document-project"
+        required: true
+        agent: "analyst"
+        command: "document-project"
+        output: "Comprehensive project documentation"
+        purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4"
+
+  - phase: 1
+    name: "Analysis"
+    optional: true
+    workflows:
+      - id: "brainstorm-project"
+        optional: true
+        agent: "analyst"
+        command: "brainstorm-project"
+      - id: "research"
+        optional: true
+        agent: "analyst"
+        command: "research"
+
+  - phase: 2
+    name: "Planning"
+    required: true
+    workflows:
+      - id: "tech-spec"
+        required: true
+        agent: "pm"
+        command: "tech-spec"
+        output: "Creates story files for feature"
+        note: "Must integrate with existing architecture"
+
+  - phase: 3
+    name: "Solutioning"
+    skip: true
+
+  - phase: 4
+    name: "Implementation"
+    required: true
+    workflows:
+      - id: "sprint-planning"
+        required: true
+        agent: "sm"
+        command: "sprint-planning"
+        note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status"

package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml

@@ -0,0 +1,76 @@
+# Brownfield Level 2 - Medium Project in Existing Codebase
+# 5-15 stories, multiple features added to existing system
+
+project_type: "software"
+level: 2
+field_type: "brownfield"
+description: "Medium project adding multiple features to existing codebase"
+
+phases:
+  - prerequisite: true
+    name: "Documentation"
+    conditional: "if_undocumented"
+    note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup"
+    workflows:
+      - id: "document-project"
+        required: true
+        agent: "analyst"
+        command: "document-project"
+        output: "Comprehensive project documentation"
+        purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4"
+
+  - phase: 1
+    name: "Analysis"
+    optional: true
+    workflows:
+      - id: "brainstorm-project"
+        optional: true
+        agent: "analyst"
+        command: "brainstorm-project"
+      - id: "research"
+        optional: true
+        agent: "analyst"
+        command: "research"
+      - id: "product-brief"
+        optional: true
+        agent: "analyst"
+        command: "product-brief"
+
+  - phase: 2
+    name: "Planning"
+    required: true
+    workflows:
+      - id: "prd"
+        recommended: true
+        agent: "pm"
+        command: "prd"
+        output: "Focused PRD for new features"
+        note: "Must consider existing system constraints"
+      - id: "validate-prd"
+        optional: true
+        agent: "pm"
+        command: "validate-prd"
+      - id: "tech-spec"
+        required: true
+        agent: "pm"
+        command: "tech-spec"
+        output: "Creates spec with multiple story files"
+        note: "Integrate with existing patterns"
+      - id: "create-design"
+        conditional: "if_has_ui"
+        agent: "ux-designer"
+        command: "create-design"
+
+  - phase: 3
+    name: "Solutioning"
+    skip: true
+
+  - phase: 4
+    name: "Implementation"
+    required: true
+    workflows:
+      - id: "sprint-planning"
+        required: true
+        agent: "sm"
+        command: "sprint-planning"
+        note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status"

package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml

@@ -0,0 +1,95 @@
+# Brownfield Level 3 - Complex Integration with Existing System
+# Major feature addition requiring architectural integration
+
+project_type: "software"
+level: 3
+field_type: "brownfield"
+description: "Complex integration with existing system architecture"
+
+phases:
+  - prerequisite: true
+    name: "Documentation"
+    conditional: "if_undocumented"
+    note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup"
+    workflows:
+      - id: "document-project"
+        required: true
+        agent: "analyst"
+        command: "document-project"
+        output: "Comprehensive project documentation"
+        purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4"
+
+  - phase: 1
+    name: "Analysis"
+    recommended: true
+    workflows:
+      - id: "brainstorm-project"
+        optional: true
+        agent: "analyst"
+        command: "brainstorm-project"
+      - id: "research"
+        recommended: true
+        agent: "analyst"
+        command: "research"
+        note: "Research existing architecture patterns"
+      - id: "product-brief"
+        recommended: true
+        agent: "analyst"
+        command: "product-brief"
+
+  - phase: 2
+    name: "Planning"
+    required: true
+    workflows:
+      - id: "prd"
+        required: true
+        agent: "pm"
+        command: "prd"
+        output: "Requirements with integration points"
+      - id: "validate-prd"
+        optional: true
+        agent: "pm"
+        command: "validate-prd"
+      - id: "create-design"
+        conditional: "if_has_ui"
+        agent: "ux-designer"
+        command: "create-design"
+        note: "Must align with existing UI patterns"
+
+  - phase: 3
+    name: "Solutioning"
+    required: true
+    workflows:
+      - id: "architecture-review"
+        required: true
+        agent: "architect"
+        command: "architecture-review"
+        note: "Review existing architecture first"
+      - id: "integration-planning"
+        required: true
+        agent: "architect"
+        command: "integration-planning"
+        output: "Integration strategy document"
+      - id: "create-architecture"
+        required: true
+        agent: "architect"
+        command: "create-architecture"
+        note: "Extension of existing architecture"
+      - id: "validate-architecture"
+        optional: true
+        agent: "architect"
+        command: "validate-architecture"
+      - id: "solutioning-gate-check"
+        required: true
+        agent: "architect"
+        command: "solutioning-gate-check"
+
+  - phase: 4
+    name: "Implementation"
+    required: true
+    workflows:
+      - id: "sprint-planning"
+        required: true
+        agent: "sm"
+        command: "sprint-planning"
+        note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status"