siesa-agents 2.1.36 → 2.1.38

package/_bmad/bmb/docs/workflows/templates/step-1b-template.md

@@ -0,0 +1,223 @@
+# BMAD Workflow Step 1B Continuation Template
+
+This template provides the standard structure for workflow continuation steps. It handles resuming workflows that were started but not completed, ensuring seamless continuation across multiple sessions.
+
+Use this template alongside **step-01-init-continuable-template.md** to create workflows that can be paused and resumed. The init template handles the detection and routing logic, while this template handles the resumption logic.
+
+<!-- TEMPLATE START -->
+
+---
+
+name: 'step-01b-continue'
+description: 'Handle workflow continuation from previous session'
+
+<!-- Path Definitions -->
+
+workflow\*path: '{project-root}/_bmad/[module-path]/workflows/[workflow-name]'
+
+# File References (all use {variable} format in file)
+
+thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
+outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
+workflowFile: '{workflow_path}/workflow.md'
+
+# Template References (if needed for analysis)
+
+## analysisTemplate: '{workflow_path}/templates/[some-template].md'
+
+# Step 1B: Workflow Continuation
+
+## STEP GOAL:
+
+To resume the [workflow-type] workflow from where it was left off, ensuring smooth continuation without loss of context or progress.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a [specific role, e.g., "business analyst" or "technical architect"]
+- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
+- ✅ Maintain collaborative [adjective] tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on analyzing and resuming workflow state
+- 🚫 FORBIDDEN to modify content completed in previous steps
+- 💬 Maintain continuity with previous sessions
+- 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile}
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis of current state before taking action
+- 💾 Keep existing frontmatter `stepsCompleted` values intact
+- 📖 Review the template content already generated in {outputFile}
+- 🚫 FORBIDDEN to modify content that was completed in previous steps
+- 📝 Update frontmatter with continuation timestamp when resuming
+
+## CONTEXT BOUNDARIES:
+
+- Current [output-file-name] document is already loaded
+- Previous context = complete template + existing frontmatter
+- [Key data collected] already gathered in previous sessions
+- Last completed step = last value in `stepsCompleted` array from frontmatter
+
+## CONTINUATION SEQUENCE:
+
+### 1. Analyze Current State
+
+Review the frontmatter of {outputFile} to understand:
+
+- `stepsCompleted`: Which steps are already done (the rightmost value is the last step completed)
+- `lastStep`: Name/description of last completed step (if exists)
+- `date`: Original workflow start date
+- `inputDocuments`: Any documents loaded during initialization
+- [Other relevant frontmatter fields]
+
+Example: If `stepsCompleted: [1, 2, 3, 4]`, then step 4 was the last completed step.
+
+### 2. Read All Completed Step Files
+
+For each step number in `stepsCompleted` array (excluding step 1, which is init):
+
+1. **Construct step filename**: `step-[N]-[name].md`
+2. **Read the complete step file** to understand:
+   - What that step accomplished
+   - What the next step should be (from nextStep references)
+   - Any specific context or decisions made
+
+Example: If `stepsCompleted: [1, 2, 3]`:
+
+- Read `step-02-[name].md`
+- Read `step-03-[name].md`
+- The last file will tell you what step-04 should be
+
+### 3. Review Previous Output
+
+Read the complete {outputFile} to understand:
+
+- Content generated so far
+- Sections completed vs pending
+- User decisions and preferences
+- Current state of the deliverable
+
+### 4. Determine Next Step
+
+Based on the last completed step file:
+
+1. **Find the nextStep reference** in the last completed step file
+2. **Validate the file exists** at the referenced path
+3. **Confirm the workflow is incomplete** (not all steps finished)
+
+### 5. Welcome Back Dialog
+
+Present a warm, context-aware welcome:
+
+"Welcome back! I see we've completed [X] steps of your [workflow-type].
+
+We last worked on [brief description of last step].
+
+Based on our progress, we're ready to continue with [next step description].
+
+Are you ready to continue where we left off?"
+
+### 6. Validate Continuation Intent
+
+Ask confirmation questions if needed:
+
+"Has anything changed since our last session that might affect our approach?"
+"Are you still aligned with the goals and decisions we made earlier?"
+"Would you like to review what we've accomplished so far?"
+
+### 7. Present MENU OPTIONS
+
+Display: "**Resuming workflow - Select an Option:** [C] Continue to [Next Step Name]"
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- User can chat or ask questions - always respond and then end with display again of the menu options
+- Update frontmatter with continuation timestamp when 'C' is selected
+
+#### Menu Handling Logic:
+
+- IF C:
+  1. Update frontmatter: add `lastContinued: [current date]`
+  2. Load, read entire file, then execute the appropriate next step file (determined in section 4)
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and continuation analysis is complete, will you then:
+
+1. Update frontmatter in {outputFile} with continuation timestamp
+2. Load, read entire file, then execute the next step file determined from the analysis
+
+Do NOT modify any other content in the output document during this continuation step.
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Correctly identified last completed step from `stepsCompleted` array
+- Read and understood all previous step contexts
+- User confirmed readiness to continue
+- Frontmatter updated with continuation timestamp
+- Workflow resumed at appropriate next step
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping analysis of existing state
+- Modifying content from previous steps
+- Loading wrong next step file
+- Not updating frontmatter with continuation info
+- Proceeding without user confirmation
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
+
+<!-- TEMPLATE END -->
+
+## Customization Guidelines
+
+When adapting this template for your specific workflow:
+
+### 1. Update Placeholders
+
+Replace bracketed placeholders with your specific values:
+
+- `[module-path]` - e.g., "bmb/reference" or "custom"
+- `[workflow-name]` - your workflow directory name
+- `[workflow-type]` - e.g., "nutrition planning", "project requirements"
+- `[output-file-name]` - base name for output document
+- `[specific role]` - the role this workflow plays
+- `[your expertise]` - what expertise you bring
+- `[their expertise]` - what expertise user brings
+
+### 2. Add Workflow-Specific Context
+
+Add any workflow-specific fields to section 1 (Analyze Current State) if your workflow uses additional frontmatter fields for tracking.
+
+### 3. Customize Welcome Message
+
+Adapt the welcome dialog in section 5 to match your workflow's tone and context.
+
+### 4. Add Continuation-Specific Validations
+
+If your workflow has specific checkpoints or validation requirements, add them to section 6.
+
+## Implementation Notes
+
+1. **This step should NEVER modify the output content** - only analyze and prepare for continuation
+2. **Always preserve the `stepsCompleted` array** - don't modify it in this step
+3. **Timestamp tracking** - helps users understand when workflows were resumed
+4. **Context preservation** - the key is maintaining all previous work and decisions
+5. **Seamless experience** - user should feel like they never left the workflow

package/_bmad/bmb/docs/workflows/templates/step-file.md

@@ -0,0 +1,139 @@
+---
+name: "step-{{stepNumber}}-{{stepName}}"
+description: "{{stepDescription}}"
+
+# Path Definitions
+workflow_path: "{project-root}/_bmad/{{targetModule}}/workflows/{{workflowName}}"
+
+# File References
+thisStepFile: "{workflow_path}/steps/step-{{stepNumber}}-{{stepName}}.md"
+{{#hasNextStep}}
+nextStepFile: "{workflow_path}/steps/step-{{nextStepNumber}}-{{nextStepName}}.md"
+{{/hasNextStep}}
+workflowFile: "{workflow_path}/workflow.md"
+{{#hasOutput}}
+outputFile: "{output_folder}/{{outputFileName}}-{project_name}.md"
+{{/hasOutput}}
+
+# Task References (list only if used in THIS step file instance and only the ones used, there might be others)
+advancedElicitationTask: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml"
+partyModeWorkflow: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
+
+{{#hasTemplates}}
+# Template References
+{{#templates}}
+{{name}}: "{workflow_path}/templates/{{file}}"
+{{/templates}}
+{{/hasTemplates}}
+---
+
+# Step {{stepNumber}}: {{stepTitle}}
+
+## STEP GOAL:
+
+{{stepGoal}}
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a {{aiRole}}
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring {{aiExpertise}}, user brings {{userExpertise}}
+- ✅ Maintain collaborative {{collaborationStyle}} tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on {{stepFocus}}
+- 🚫 FORBIDDEN to {{forbiddenAction}}
+- 💬 Approach: {{stepApproach}}
+- 📋 {{additionalRule}}
+
+## EXECUTION PROTOCOLS:
+
+{{#executionProtocols}}
+
+- 🎯 {{.}}
+  {{/executionProtocols}}
+
+## CONTEXT BOUNDARIES:
+
+- Available context: {{availableContext}}
+- Focus: {{contextFocus}}
+- Limits: {{contextLimits}}
+- Dependencies: {{contextDependencies}}
+
+## SEQUENCE OF INSTRUCTIONS (Do not deviate, skip, or optimize)
+
+{{#instructions}}
+
+### {{number}}. {{title}}
+
+{{content}}
+
+{{#hasContentToAppend}}
+
+#### Content to Append (if applicable):
+
+```markdown
+{{contentToAppend}}
+```
+
+{{/hasContentToAppend}}
+
+{{/instructions}}
+
+{{#hasMenu}}
+
+### {{menuNumber}}. Present MENU OPTIONS
+
+Display: **{{menuDisplay}}**
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+- Use menu handling logic section below
+
+#### Menu Handling Logic:
+
+{{#menuOptions}}
+
+- IF {{key}}: {{action}}
+  {{/menuOptions}}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#{{menuNumber}}-present-menu-options)
+  {{/hasMenu}}
+
+## CRITICAL STEP COMPLETION NOTE
+
+{{completionNote}}
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+{{#successCriteria}}
+
+- {{.}}
+  {{/successCriteria}}
+
+### ❌ SYSTEM FAILURE:
+
+{{#failureModes}}
+
+- {{.}}
+  {{/failureModes}}
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/_bmad/bmb/docs/workflows/templates/step-template.md

@@ -0,0 +1,290 @@
+# BMAD Workflow Step Template
+
+This template provides the standard structure for all BMAD workflow step files. Copy and modify this template for each new step you create.
+
+<!-- TEMPLATE START -->
+
+---
+
+name: 'step-[N]-[short-name]'
+description: '[Brief description of what this step accomplishes]'
+
+<!-- Path Definitions -->
+
+workflow\*path: '{project-root}/_bmad/[module]/reference/workflows/[workflow-name]' # the folder the workflow.md file is in
+
+# File References (all use {variable} format in file)
+
+thisStepFile: '{workflow_path}/steps/step-[N]-[short-name].md'
+nextStep{N+1}: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step or no next step
+altStep{Y}: '{workflow_path}/steps/step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic
+workflowFile: '{workflow_path}/workflow.md'
+outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
+
+# Task References (IF THE workflow uses and it makes sense in this step to have these )
+
+advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+
+# Template References (if this step uses a specific templates)
+
+profileTemplate: '{workflow_path}/templates/profile-section.md'
+assessmentTemplate: '{workflow_path}/templates/assessment-section.md'
+strategyTemplate: '{workflow_path}/templates/strategy-section.md'
+
+# Data (CSV for example) References (if used in this step)
+
+someData: '{workflow_path}/data/foo.csv'
+
+# Add more as needed - but ONLY what is used in this specific step file!
+
+---
+
+# Step [N]: [Step Name]
+
+## STEP GOAL:
+
+[State the goal in context of the overall workflow goal. Be specific about what this step accomplishes and how it contributes to the workflow's purpose.]
+
+Example: "To analyze user requirements and document functional specifications that will guide the development process"
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a [specific role, e.g., "business analyst" or "technical architect"]
+- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
+- ✅ Maintain collaborative [adjective] tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on [specific task for this step]
+- 🚫 FORBIDDEN to [what not to do in this step]
+- 💬 Approach: [how to handle this specific task]
+- 📋 Additional rule relevant to this step
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 [Step-specific protocol 1]
+- 💾 [Step-specific protocol 2 - e.g., document updates]
+- 📖 [Step-specific protocol 3 - e.g., tracking requirements]
+- 🚫 [Step-specific restriction]
+
+## CONTEXT BOUNDARIES:
+
+- Available context: [what context is available from previous steps]
+- Focus: [what this step should concentrate on]
+- Limits: [what not to assume or do]
+- Dependencies: [what this step depends on]
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+[Detailed instructions for the step's work]
+
+### 1. Title
+
+[Specific instructions for first part of the work]
+
+### 2. Title
+
+[Specific instructions for second part of the work]
+
+### N. Title (as many as needed)
+
+<!-- not ever step will include advanced elicitation or party mode, in which case generally will just have the C option -->
+<!-- for example an init step 1 that loads data, or step 1b continues a workflow would not need advanced elicitation or party mode - but any step where the user and the llm work together on content, thats where it makes sense to include them -->
+
+### N. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask} # Or custom action
+- IF P: Execute {partyModeWorkflow} # Or custom action
+- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution completes, redisplay the menu
+- User can chat or ask questions - always respond when conversation ends, redisplay the menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+[Specific conditions for completing this step and transitioning to the next, such as output to file being created with this tasks updates]
+
+ONLY WHEN [C continue option] is selected and [completion requirements], will you then load and read fully `[installed_path]/step-[next-number]-[name].md` to execute and begin [next step description].
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- [Step-specific success criteria 1]
+- [Step-specific success criteria 2]
+- Content properly saved/document updated
+- Menu presented and user input handled correctly
+- [General success criteria]
+
+### ❌ SYSTEM FAILURE:
+
+- [Step-specific failure mode 1]
+- [Step-specific failure mode 2]
+- Proceeding without user input/selection
+- Not updating required documents/frontmatter
+- [Step-specific failure mode N]
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
+
+<!-- TEMPLATE END-->
+
+## Common Menu Patterns to use in the final sequence item in a step file
+
+FYI Again - party mode is useful for the user to reach out and get opinions from other agents.
+
+Advanced elicitation is use to direct you to think of alternative outputs of a sequence you just performed.
+
+### Standard Menu - when a sequence in a step results in content produced by the agent or human that could be improved before proceeding
+
+```markdown
+### N. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] [Advanced Elicitation] [P] Party Mode [C] Continue"
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask}
+- IF P: Execute {partyModeWorkflow}
+- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+```
+
+### Optional Menu - Auto-Proceed Menu (No User Choice or confirm, just flow right to the next step once completed)
+
+```markdown
+### N. Present MENU OPTIONS
+
+Display: "**Proceeding to [next action]...**"
+
+#### Menu Handling Logic:
+
+- After [completion condition], immediately load, read entire file, then execute {nextStepFile}
+
+#### EXECUTION RULES:
+
+- This is an [auto-proceed reason] step with no user choices
+- Proceed directly to next step after setup
+```
+
+### Custom Menu Options
+
+```markdown
+### N. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] [Custom Action 1] [B] [Custom Action 2] [C] Continue"
+
+#### Menu Handling Logic:
+
+- IF A: [Custom handler route for option A]
+- IF B: [Custom handler route for option B]
+- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+```
+
+### Conditional Menu (Based on Workflow State)
+
+```markdown
+### N. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step Bar]"
+
+#### Menu Handling Logic:
+
+- IF A: Execute {customAction}
+- IF C: Save content to {outputFile}, update frontmatter, check [condition]:
+  - IF [condition true]: load, read entire file, then execute {pathA}
+  - IF [condition false]: load, read entire file, then execute {pathB}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+```
+
+## Example Step Implementations
+
+### Initialization Step Example
+
+See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of:
+
+- Detecting existing workflow state and short circuit to 1b
+- Creating output documents from templates
+- Auto-proceeding to the next step (this is not the normal behavior of most steps)
+- Handling continuation scenarios
+
+### Continuation Step Example
+
+See [step-01b-continue.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of:
+
+- Handling already-in-progress workflows
+- Detecting completion status
+- Presenting update vs new plan options
+- Seamless workflow resumption
+
+### Standard Step with Menu Example
+
+See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of:
+
+- Presenting a menu with A/P/C options
+- Forcing halt until user selects 'C' (Continue)
+- Writing all collected content to output file only when 'C' is selected
+- Updating frontmatter with step completion before proceeding
+- Using frontmatter variables for file references
+
+### Final Step Example
+
+See [step-06-prep-schedule.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of:
+
+- Completing workflow deliverables
+- Marking workflow as complete in frontmatter
+- Providing final success messages
+- Ending the workflow session gracefully
+
+## Best Practices
+
+1. **Keep step files focused** - Each step should do one thing well
+2. **Be explicit in instructions** - No ambiguity about what to do
+3. **Include all critical rules** - Don't assume anything from other steps
+4. **Use clear, concise language** - Avoid jargon unless necessary
+5. **Ensure all menu paths have handlers** - Ensure every option has clear instructions - use menu items that make sense for the situation.
+6. **Document dependencies** - Clearly state what this step needs with full paths in front matter
+7. **Define success and failure clearly** - Both for the step and the workflow
+8. **Mark completion clearly** - Ensure final steps update frontmatter to indicate workflow completion