@devo-bmad-custom/agent-orchestration 1.0.0

package/src/bmb/workflows/workflow/data/workflow-examples.md

@@ -0,0 +1,232 @@
+# Novel Workflow Examples
+
+**Purpose:** Illustrative examples across diverse domains.
+
+---
+
+## Workflow Structure
+
+**Each arrow (→) = one step file. Each step file contains:**
+- STEP GOAL
+- MANDATORY EXECUTION RULES
+- EXECUTION PROTOCOLS
+- MANDATORY SEQUENCE (numbered sub-steps)
+- Menu options
+- Success/failure metrics
+
+**Simple workflow:** 3-4 step files. **Complex workflow:** 10+ step files.
+
+---
+
+## Example 1: Personalized Meal Plan Generator
+
+**Domain:** Health & Fitness
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Discovery → Assessment → Strategy → Shopping List → Prep Schedule |
+| **Step Files** | ~5: step-01-discovery, step-02-assessment, step-03-strategy, step-04-shopping, step-05-prep |
+| **Output** | Direct-to-final document, each step appends section |
+| **Intent/Prescriptive** | Intent-based - Facilitates discovery |
+| **Planning** | No - builds directly |
+| **Continuable** | Yes - 200+ tokens possible |
+| **Structure** | Linear, 5 steps |
+| **Conversation** | Open-ended, progressive questioning (1-2 at a time) |
+
+---
+
+## Example 2: Year-End Tax Organizer
+
+**Domain:** Finance
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Input Discovery → Document Categorization → Missing Document Alert → Final Summary |
+| **Step Files** | 4: step-01-input-discovery, step-02-categorize, step-03-missing-alerts, step-04-summary |
+| **Output** | Analysis-only + checklist |
+| **Intent/Prescriptive** | Highly Prescriptive - Tax compliance, exact categories |
+| **Planning** | N/A |
+| **Continuable** | No - single-session |
+| **Structure** | Linear, 4 steps |
+| **Conversation** | Focused - specific questions, document what provided |
+
+---
+
+## Example 3: Employee Termination Checklist
+
+**Domain:** Legal / HR / Compliance
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Context → Regulatory Check → Document Requirements → Notification Timeline → Final Checklist |
+| **Step Files** | 5: step-01-context, step-02-regulatory, step-03-documents, step-04-timeline, step-05-checklist |
+| **Output** | Direct-to-final compliance checklist |
+| **Intent/Prescriptive** | Highly Prescriptive - Legal compliance, state-specific |
+| **Planning** | No |
+| **Continuable** | No - single-session |
+| **Structure** | Branching within steps by: reason, location, employee count |
+| **Conversation** | Focused - classification questions, present requirements |
+
+---
+
+## Example 4: Tabletop RPG Campaign Builder
+
+**Domain:** Entertainment / Games
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Session Concept → NPC Creation → Scene Setup → Key Beats → Generate → [Repeat per session] |
+| **Step Files** | 4 core files reused each session: step-01-concept, step-02-npc, step-03-scene, step-04-beats, step-05-generate |
+| **Output** | Per-session document, maintains campaign continuity |
+| **Intent/Prescriptive** | Intent-based - Creative facilitation |
+| **Planning** | No - builds directly |
+| **Continuable** | Yes - months-long campaigns |
+| **Structure** | Repeating loop - same steps, new content |
+| **Conversation** | Open-ended creative facilitation, "What if..." prompts |
+
+---
+
+## Example 5: Course Syllabus Creator
+
+**Domain:** Education
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Course Type → Learning Objectives → Module Breakdown → Assessment → [Branch: academic] → Accreditation → [Branch: vocational] → Certification → Final |
+| **Output** | Direct-to-final syllabus |
+| **Intent/Prescriptive** | Balanced - Framework prescriptive, content flexible |
+| **Planning** | No |
+| **Continuable** | Yes - complex syllabi |
+| **Structure** | Branching by course type |
+| **Conversation** | Mixed - framework (prescriptive) + content discovery (intent) |
+
+---
+
+## Example 6: SOP Writer
+
+**Domain:** Business Process
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Process Selection → Scope Definition → Documentation → Review → [Generate] → "Create another?" → If yes, repeat |
+| **Output** | Independent SOPs stored in `{sop_folder}/` |
+| **Intent/Prescriptive** | Prescriptive - SOPs must be exact |
+| **Planning** | No - direct generation |
+| **Continuable** | No - single SOP per run, repeatable workflow |
+| **Structure** | Repeating - multiple SOPs per session |
+| **Conversation** | Focused on process details - "Walk me through step 1" |
+
+---
+
+## Example 7: Novel Outliner
+
+**Domain:** Creative Writing
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Structure Selection → Character Arcs → Beat Breakdown → Pacing Review → Final Polish |
+| **Output** | Free-form with Final Polish for coherence |
+| **Intent/Prescriptive** | Intent-based - "What does your character want?" |
+| **Planning** | No - builds directly |
+| **Continuable** | Yes - weeks-long sessions |
+| **Structure** | Branching by structure choice |
+| **Conversation** | Open-ended creative coaching, provocations |
+
+---
+
+## Example 8: Wedding Itinerary Coordinator
+
+**Domain:** Event Planning
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Venue Type → Vendor Coordination → Timeline → Guest Experience → [Branch: hybrid] → Virtual Setup → Day-of Schedule |
+| **Output** | Direct-to-final itinerary |
+| **Intent/Prescriptive** | Intent-based - Facilitates vision |
+| **Planning** | No |
+| **Continuable** | Yes - months-long planning |
+| **Structure** | Branching by venue type |
+| **Conversation** | Open-ended discovery of preferences, budget, constraints |
+
+---
+
+## Example 9: Annual Life Review
+
+**Domain:** Personal Development
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Input Discovery (prior goals) → Life Areas Assessment → Reflections → Goal Setting → Action Planning → Final Polish |
+| **Output** | Free-form with Final Polish, discovers prior review first |
+| **Intent/Prescriptive** | Intent-based - Coaching questions |
+| **Planning** | No - direct to life plan |
+| **Continuable** | Yes - deep reflection |
+| **Structure** | Linear with Input Discovery |
+| **Conversation** | Open-ended coaching, progressive questioning |
+
+---
+
+## Example 10: Room Renovation Planner
+
+**Domain:** Home Improvement
+
+| Aspect | Details |
+|--------|---------|
+| **Flow** | Room Type → Budget Assessment → Phase Planning → Materials → Contractor Timeline → [Branch: DIY] → Instructions |
+| **Output** | Direct-to-final renovation plan |
+| **Intent/Prescriptive** | Balanced - Code compliance prescriptive, design intent-based |
+| **Planning** | No |
+| **Continuable** | Yes - complex planning |
+| **Structure** | Branching by room type and DIY vs pro |
+| **Conversation** | Mixed - budget questions + vision discovery |
+
+---
+
+## Pattern Analysis
+
+### Structure Types
+
+| Type | Count | Examples |
+|------|-------|----------|
+| Linear | 5 | Meal Plan, Tax, Termination, Life Review, Renovation |
+| Branching | 5 | Termination, Syllabus, Novel, Wedding, Renovation |
+| Repeating Loop | 2 | RPG Campaign, SOP Writer |
+
+### Intent Spectrum
+
+| Type | Count | Examples |
+|------|-------|----------|
+| Intent-based | 7 | Meal Plan, RPG, Syllabus (partial), Novel, Wedding, Life Review, Renovation (partial) |
+| Prescriptive | 3 | Tax, Termination, SOP |
+| Balanced | 2 | Syllabus, Renovation |
+
+### Continuable vs Single-Session
+
+| Type | Count | Examples |
+|------|-------|----------|
+| Continuable | 7 | Meal Plan, RPG, Syllabus, Novel, Wedding, Life Review, Renovation |
+| Single-Session | 3 | Tax, Termination, SOP |
+
+### Output Patterns
+
+| Type | Count | Examples |
+|------|-------|----------|
+| Direct-to-Final | 9 | All except Tax |
+| Analysis Only | 1 | Tax |
+| With Final Polish | 2 | Novel, Life Review |
+| Repeating Output | 2 | RPG (sessions), SOP (multiple) |
+
+---
+
+## Design Questions
+
+1. **Domain:** Problem space?
+2. **Output:** What is produced? (Document, checklist, analysis, physical?)
+3. **Intent:** Prescriptive (compliance) or intent-based (creative)?
+4. **Planning:** Plan-then-build or direct-to-final?
+5. **Continuable:** Multiple sessions or high token count?
+6. **Structure:** Linear, branching, or repeating loop?
+7. **Inputs:** Requires prior workflow documents or external sources?
+8. **Chaining:** Part of module sequence? What comes before/after?
+9. **Polish:** Final output need optimization for flow/coherence?
+10. **Conversation:** Focused questions or open-ended facilitation?

package/src/bmb/workflows/workflow/data/workflow-type-criteria.md

@@ -0,0 +1,134 @@
+# Workflow Type Criteria
+
+## Key Decisions
+
+1. **Module affiliation** - Standalone or part of a module?
+2. **Continuable** - Can it span multiple sessions?
+3. **Edit/Validate support** - Will it have edit and validate flows?
+4. **Document output** - Does it produce a document?
+
+## 1. Module Affiliation
+
+### Standalone Workflow
+- NOT part of any module
+- Stored in user's custom location
+- Only standard variables available
+
+### Module-Based Workflow
+- Part of a specific module (e.g., BMB)
+- Has access to module-specific variables
+- Stored in module's workflows directory
+
+**BMB additional variable:** `{bmb_creations_output_folder}`
+
+## 2. Continuable or Single-Session?
+
+### Continuable (Multi-Session)
+**Use when:** Workflow might consume MASSIVE tokens, complex, many steps
+
+**Required:**
+- `step-01-init.md` with continuation detection
+- `step-01b-continue.md` for resuming
+- `stepsCompleted` tracking in output frontmatter
+
+**Frontmatter:**
+```yaml
+stepsCompleted: ['step-01-init', 'step-02-gather']
+lastStep: 'step-02-gather'
+lastContinued: '2025-01-02'
+```
+
+**Rule:** Each step appends its NAME to `stepsCompleted`
+
+### Single-Session
+**Use when:** Simple, quick (<15 min), token-efficient
+
+**Required:**
+- Standard `step-01-init.md` (no continuation logic)
+- No `stepsCompleted` tracking needed
+
+## 3. Edit/Validate Support
+
+### Create-Only
+```
+workflow-folder/
+├── workflow.md
+├── data/
+└── steps-c/
+    ├── step-01-init.md
+    └── step-N-final.md
+```
+
+**Use when:** Simple workflows, experimental, one-off
+
+### Create + Edit + Validate (Tri-Modal)
+```
+workflow-folder/
+├── workflow.md
+├── data/                    # SHARED
+├── steps-c/                 # Create
+├── steps-e/                 # Edit
+└── steps-v/                 # Validate
+```
+
+**Key:**
+- Each mode is SELF-CONTAINED
+- NO shared step files between modes
+- DATA folder is SHARED (prevents drift)
+- Duplicative steps OK (better than confusion)
+
+**Use when:** Complex workflows that will be maintained
+
+## 4. Document Output
+
+### Document-Producing
+- Creates persistent output file
+- Uses templates for structure
+- Each step contributes to document
+- Consider final polish step
+
+### Non-Document
+- Performs actions without persistent output
+- May produce temporary files
+- Focus on execution, not creation
+
+## Decision Tree
+
+```
+START: Creating a workflow
+│
+├─ Part of a module?
+│  ├─ YES → Module-based (include module variables)
+│  └─ NO  → Standalone (standard variables only)
+│
+├─ Could this take multiple sessions / lots of tokens?
+│  ├─ YES → Continuable (add step-01b-continue.md)
+│  └─ NO  → Single-session (simpler init)
+│
+└─ Will users need to edit/validate this workflow?
+   ├─ YES → Tri-modal (steps-c/, steps-e/, steps-v/)
+   └─ NO  → Create-only (steps-c/ only)
+```
+
+## Output Format Decision
+
+| Workflow Type           | Init Template            | Output Format |
+| ----------------------- | ------------------------ | ------------- |
+| Continuable + Document  | step-01-init-continuable | Free-form     |
+| Single-Session + Document| Standard init           | Free-form     |
+| Continuable + No Doc    | step-01-init-continuable | N/A           |
+| Single-Session + No Doc  | Standard init            | N/A           |
+
+**Free-form template** (recommended):
+```yaml
+---
+stepsCompleted: []
+lastStep: ''
+date: ''
+user_name: ''
+---
+
+# {{document_title}}
+
+[Content appended progressively]
+```

package/src/bmb/workflows/workflow/steps-c/step-00-conversion.md

@@ -0,0 +1,263 @@
+---
+name: 'step-00-conversion'
+description: 'Convert existing workflow to BMAD compliant format by reading all instructions and extracting plan'
+
+nextStepFile: './step-02-classification.md'
+workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md'
+---
+
+# Step 0: Workflow Conversion
+
+## STEP GOAL:
+
+Convert an existing workflow (any format) to BMAD compliant format by fully reading and understanding every instruction, extracting the essence, and creating a plan document.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER skip reading the entire source workflow
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not an autonomous converter
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a workflow analyst and conversion specialist
+- ✅ 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 workflow architecture expertise, user brings their existing workflow
+- ✅ Together we will extract the essence and rebuild compliantly
+
+### Step-Specific Rules:
+
+- 🎯 Focus on understanding the COMPLETE existing workflow
+- 🚫 FORBIDDEN to skip any instruction or file
+- 💬 Read EVERYTHING - instructions.md, workflow.yaml, step files, templates
+- 📋 Document the essence succinctly
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load and read the ENTIRE source workflow
+- 💾 Extract: goal, steps, output, input requirements
+- 📖 Create plan with conversionFrom metadata
+- 🚫 FORBIDDEN to proceed without complete understanding
+
+## CONTEXT BOUNDARIES:
+
+- User provides existing workflow path (from routing or direct)
+- This REPLACES step-01-discovery - we skip to step-02-classification
+- The source workflow can be ANY format (legacy XML, partial, other systems)
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise.
+
+### 1. Get Source Workflow Path
+
+**If path was passed from routing (e.g., from edit workflow):**
+- Use `{sourceWorkflowPath}` provided
+
+**If no path was passed:**
+
+"I can help you convert an existing workflow to BMAD compliant format.
+
+**Please provide the path to the workflow you want to convert:**
+
+This could be:
+- A folder containing workflow.md
+- A folder with workflow.yaml (legacy format)
+- A folder with instructions.md
+- Any workflow from another system
+
+**Path:** {user provides path}"
+
+### 2. Load EVERYTHING - DO NOT BE LAZY
+
+"**Loading source workflow for complete analysis...**
+
+**CRITICAL:** I will read EVERY file in this workflow to understand it completely."
+
+**Load these files based on what exists:**
+
+**If workflow.md exists:**
+- Load workflow.md completely
+- Load all step files (steps/*, steps-c/*, steps-v/*, steps-e/*)
+- Load all data files (data/*)
+- Load all templates (templates/*)
+
+**If workflow.yaml exists (legacy XML format):**
+- Load workflow.yaml completely
+- Load instructions.md completely
+- Load all step files, templates, data
+
+**If other format:**
+- Load every file that exists
+- Read everything to understand the structure
+
+**⚠️ DO NOT BE LAZY - Load and READ COMPLETELY:**
+
+For each step file, read:
+- The STEP GOAL
+- All MANDATORY EXECUTION RULES
+- All instructions in EXECUTION PROTOCOLS
+- All menu options
+- All templates and outputs
+
+"**✅ Source workflow loaded completely**
+
+**Files read:** {count} files
+**Format detected:** {format}
+**Structure identified:** {brief description}"
+
+### 3. Extract and Document Workflow Essence
+
+Create the workflow plan with complete extraction:
+
+"**Extracting workflow essence...**"
+
+Create `{workflowPlanFile}`:
+
+```markdown
+---
+conversionFrom: '{sourceWorkflowPath}'
+originalFormat: '{detected format}'
+stepsCompleted: ['step-00-conversion']
+created: {current date}
+status: CONVERSION
+---
+
+# Workflow Creation Plan
+
+## Conversion Source
+
+**Original Path:** {sourceWorkflowPath}
+**Original Format:** {workflow.yaml / workflow.md / custom / etc.}
+**Detected Structure:** {describe what was found}
+
+---
+
+## Original Workflow Analysis
+
+### Goal (from source)
+
+{Extract the exact goal from the source workflow}
+
+### Original Steps (Complete List)
+
+{Create succinct bullet list of EVERY step from the source:}
+
+**Step 1:** {Step name} - {Brief purpose}
+**Step 2:** {Step name} - {Brief purpose}
+**Step 3:** {Step name} - {Brief purpose}
+...
+**Step N:** {Step name} - {Brief purpose}
+
+### Output / Deliverable
+
+{What does this workflow produce?}
+
+### Input Requirements
+
+{What inputs does this workflow need from the user?}
+
+### Key Instructions to LLM
+
+{Extract the key instruction patterns - how does the workflow talk to the LLM?
+What style? What level of detail? What collaborative approach?}
+
+---
+
+## Conversion Notes
+
+**What works well in original:**
+{List strengths to preserve}
+
+**What needs improvement:**
+{List issues to address}
+
+**Compliance gaps identified:**
+{List what's missing for BMAD compliance}
+```
+
+### 4. Present Extracted Information to User
+
+"**I've analyzed your existing workflow completely. Here's what I found:**
+
+---
+
+**Workflow Goal:**
+{goal from analysis}
+
+**Steps ({count}):**
+{Display succinct bullet list}
+
+**Output:**
+{what it produces}
+
+**Input Requirements:**
+{what it needs from user}
+
+---
+
+**Format:** {originalFormat}
+**Compliance Status:** {compliant / non-compliant / partial}
+
+**Key observations:**
+{Share 2-3 key insights about the workflow}"
+
+### 5. Discovery Questions for Conversion
+
+Even though this is a conversion, we need to understand some things:
+
+"**A few questions to ensure the conversion captures your intent:**
+
+1. **What's working well** in this workflow that we should definitely preserve?
+
+2. **What problems** have you encountered with this workflow that we should fix?
+
+3. **Any missing features** or improvements you'd like to add during conversion?
+
+4. **Who will use** the converted workflow - same audience or different?"
+
+### 6. Confirm and Proceed to Classification
+
+"**Based on my analysis and your answers, I'm ready to proceed with classification.**
+
+**Next step:** We'll classify the workflow type (document, action, interactive, autonomous, meta), determine structure (continuable or single-session), and decide if it needs validation steps.
+
+**Ready to proceed?** [AR] Adversarial Review [C] Continue to Classification"
+
+#### Menu Handling Logic:
+
+- IF AR: Execute {project-root}/_bmad/core/tasks/review-adversarial-general.xml — pass the current editPlan (or plan document in context) as the content to review; display findings with recommendations; then redisplay this menu
+- IF C: Update workflowPlanFile with conversion notes, then load, read entirely, then execute {nextStepFile}
+- IF Any other: help user respond, then redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN the entire source workflow has been read and analyzed, and the plan document contains the complete extraction (goal, steps, output, inputs) and conversionFrom metadata, will you then load and read fully `{nextStepFile}` to execute classification.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- ENTIRE source workflow loaded and read
+- Every step documented in plan
+- Goal, output, inputs extracted
+- conversionFrom metadata set
+- User confirms understanding
+- Proceeding to classification
+
+### ❌ SYSTEM FAILURE:
+
+- Not loading all files in source workflow
+- Skipping step files
+- Not reading instructions completely
+- Missing steps in documentation
+- Not setting conversionFrom metadata
+- Proceeding without complete understanding
+
+**Master Rule:** DO NOT BE LAZY. Read EVERYTHING. Document the COMPLETE workflow essence. The conversion must capture ALL of the original workflow's intent and functionality.