From cd45d22eb68d200cd1895991e1a52fef1310aae7 Mon Sep 17 00:00:00 2001 From: Murat K Ozcan <34237651+muratkeremozcan@users.noreply.github.com> Date: Thu, 1 Jan 2026 05:06:55 -0600 Subject: [PATCH 1/7] docs: chose your tea engagement (#1228) * docs: chose your tea engagement * docs: addressed PR comments * docs: made refiements to the mermaid diagram * docs: wired in test architect discoverability nudges --------- Co-authored-by: Brian --- docs/modules/bmm-bmad-method/index.md | 2 + docs/modules/bmm-bmad-method/quick-start.md | 22 +++++++++- .../bmm-bmad-method/test-architecture.md | 43 +++++++++++++++++-- .../workflows-implementation.md | 5 ++- .../bmm-bmad-method/workflows-solutioning.md | 2 +- .../create-story/instructions.xml | 3 +- .../dev-story/instructions.xml | 3 +- 7 files changed, 69 insertions(+), 11 deletions(-) diff --git a/docs/modules/bmm-bmad-method/index.md b/docs/modules/bmm-bmad-method/index.md index 6541317d..c01f8978 100644 --- a/docs/modules/bmm-bmad-method/index.md +++ b/docs/modules/bmm-bmad-method/index.md @@ -40,6 +40,8 @@ First know there is the full BMad Method Process and then there is a Quick Flow - Implementation in minutes, not days - Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](./quick-flow-solo-dev.md)** +- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](./test-architecture.md)**. + ## 🤖 Agents and Collaboration Complete guide to BMM's AI agent team: diff --git a/docs/modules/bmm-bmad-method/quick-start.md b/docs/modules/bmm-bmad-method/quick-start.md index f5f73785..9358ba15 100644 --- a/docs/modules/bmm-bmad-method/quick-start.md +++ b/docs/modules/bmm-bmad-method/quick-start.md @@ -179,6 +179,16 @@ Once epics and stories are created: **Why run this?** It ensures all your planning assets align properly before you start building. +#### Optional: TEA Engagement + +Testing is not mandated by BMad. Decide how you want to engage TEA: + +- **No TEA** - Use your existing team testing approach +- **TEA-only (Standalone)** - Use TEA workflows with your own requirements and environment +- **TEA-integrated** - Use TEA as part of the BMad Method or Enterprise flow + +See the [Test Architect Guide](./test-architecture.md) for the five TEA engagement models and recommended sequences. + #### Context Management Tips - **Use 200k+ context models** for best results (Claude Sonnet 4.5, GPT-4, etc.) @@ -211,7 +221,14 @@ Once planning and architecture are complete, you'll move to Phase 4. **Important 3. Tell the agent: "Run dev-story" 4. The DEV agent will implement the story and update the sprint status -#### 3.4 Review the Code (Optional but Recommended) +#### 3.4 Generate Guardrail Tests (Optional) + +1. **Start a new chat** with the **TEA agent** +2. Wait for the menu +3. Tell the agent: "Run automate" +4. The TEA agent generates or expands tests to act as guardrails + +#### 3.5 Review the Code (Optional but Recommended) 1. **Start a new chat** with the **DEV agent** 2. Wait for the menu @@ -224,7 +241,8 @@ For each subsequent story, repeat the cycle using **fresh chats** for each workf 1. **New chat** → SM agent → "Run create-story" 2. **New chat** → DEV agent → "Run dev-story" -3. **New chat** → DEV agent → "Run code-review" (optional but recommended) +3. **New chat** → TEA agent → "Run automate" (optional) +4. **New chat** → DEV agent → "Run code-review" (optional but recommended) After completing all stories in an epic: diff --git a/docs/modules/bmm-bmad-method/test-architecture.md b/docs/modules/bmm-bmad-method/test-architecture.md index e64282d3..9d417a7a 100644 --- a/docs/modules/bmm-bmad-method/test-architecture.md +++ b/docs/modules/bmm-bmad-method/test-architecture.md @@ -6,6 +6,38 @@ - **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands. - **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA) +## Choose Your TEA Engagement Model + +BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally. + +1. **No TEA** + - Skip all TEA workflows. Use your existing team testing approach. + +2. **TEA-only (Standalone)** + - Use TEA on a non-BMad project. Bring your own requirements, acceptance criteria, and environments. + - Typical sequence: `*test-design` (system or epic) -> `*atdd` and/or `*automate` -> optional `*test-review` -> `*trace` for coverage and gate decisions. + - Run `*framework` or `*ci` only if you want TEA to scaffold the harness or pipeline. + +3. **Integrated: Greenfield - BMad Method (Simple/Standard Work)** + - Phase 3: system-level `*test-design`, then `*framework` and `*ci`. + - Phase 4: per-epic `*test-design`, optional `*atdd`, then `*automate` and optional `*test-review`. + - Gate (Phase 2): `*trace`. + +4. **Integrated: Brownfield - BMad Method or Enterprise (Simple or Complex)** + - Phase 2: baseline `*trace`. + - Phase 3: system-level `*test-design`, then `*framework` and `*ci`. + - Phase 4: per-epic `*test-design` focused on regression and integration risks. + - Gate (Phase 2): `*trace`; `*nfr-assess` (if not done earlier). + - For brownfield BMad Method, follow the same flow with `*nfr-assess` optional. + +5. **Integrated: Greenfield - Enterprise Method (Enterprise/Compliance Work)** + - Phase 2: `*nfr-assess`. + - Phase 3: system-level `*test-design`, then `*framework` and `*ci`. + - Phase 4: per-epic `*test-design`, plus `*atdd`/`*automate`/`*test-review`. + - Gate (Phase 2): `*trace`; archive artifacts as needed. + +If you are unsure, default to the integrated path for your track and adjust later. + ## TEA Workflow Lifecycle TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4): @@ -16,6 +48,9 @@ graph TB subgraph Phase2["Phase 2: PLANNING"] PM["PM: *prd (creates PRD with FRs/NFRs)"] PlanNote["Business requirements phase"] + NFR2["TEA: *nfr-assess (optional, enterprise)"] + PM -.-> NFR2 + NFR2 -.-> PlanNote PM -.-> PlanNote end @@ -23,8 +58,8 @@ graph TB Architecture["Architect: *architecture"] EpicsStories["PM/Architect: *create-epics-and-stories"] TestDesignSys["TEA: *test-design (system-level)"] - Framework["TEA: *framework"] - CI["TEA: *ci"] + Framework["TEA: *framework (optional if needed)"] + CI["TEA: *ci (optional if needed)"] GateCheck["Architect: *implementation-readiness"] Architecture --> EpicsStories Architecture --> TestDesignSys @@ -174,7 +209,7 @@ npm install -D @seontechnologies/playwright-utils **Enable during BMAD installation** by answering "Yes" when prompted. -**Supported utilities (11 total):** +**Supported utilities (10 total):** - api-request, network-recorder, auth-session, intercept-network-call, recurse - log, file-utils, burn-in, network-error-monitor @@ -429,7 +464,7 @@ Provides fixture-based utilities that integrate into TEA's test generation and r Benefit: Faster CI feedback, HTTP error detection -**Utilities available** (11 total): api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition +**Utilities available** (10 total): api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition **Enable during BMAD installation** by answering "Yes" when prompted, or manually set `tea_use_playwright_utils: true` in `_bmad/bmm/config.yaml`. diff --git a/docs/modules/bmm-bmad-method/workflows-implementation.md b/docs/modules/bmm-bmad-method/workflows-implementation.md index 73dfa432..02d9c471 100644 --- a/docs/modules/bmm-bmad-method/workflows-implementation.md +++ b/docs/modules/bmm-bmad-method/workflows-implementation.md @@ -98,8 +98,9 @@ Stories move through these states in the sprint status file: 1. SM runs `create-story` 2. DEV runs `dev-story` -3. DEV runs `code-review` -4. If code review fails: DEV fixes issues in `dev-story`, then re-runs `code-review` +3. (Optional) TEA runs `*automate` to generate or expand guardrail tests +4. DEV runs `code-review` +5. If code review fails: DEV fixes issues in `dev-story`, then re-runs `code-review` **After Epic Complete:** diff --git a/docs/modules/bmm-bmad-method/workflows-solutioning.md b/docs/modules/bmm-bmad-method/workflows-solutioning.md index 3b6590e2..8cd61852 100644 --- a/docs/modules/bmm-bmad-method/workflows-solutioning.md +++ b/docs/modules/bmm-bmad-method/workflows-solutioning.md @@ -434,7 +434,7 @@ Architecture documents are living. Update them as you learn during implementatio **Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method. -**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](../../../../docs/modules/bmm-bmad-method/test-architecture.md) for TEA's full lifecycle integration. +**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration. --- diff --git a/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml b/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml index 52405e71..701b438e 100644 --- a/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +++ b/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml @@ -336,9 +336,10 @@ 1. Review the comprehensive story in {{story_file}} 2. Run dev agents `dev-story` for optimized implementation 3. Run `code-review` when complete (auto-marks done) + 4. Optional: Run TEA `*automate` after `dev-story` to generate guardrail tests **The developer now has everything needed for flawless implementation!** - \ No newline at end of file + diff --git a/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml b/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml index 40c56244..4fb70efe 100644 --- a/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml +++ b/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml @@ -397,6 +397,7 @@ - Verify all acceptance criteria are met - Ensure deployment readiness if applicable - Run `code-review` workflow for peer review + - Optional: Run TEA `*automate` to expand guardrail tests 💡 **Tip:** For best results, run `code-review` using a **different** LLM than the one that implemented this story. @@ -406,4 +407,4 @@ Remain flexible - allow user to choose their own path or ask for other assistance - \ No newline at end of file + From 4142972b6ae71d7e6a9acffc94be408707707cdd Mon Sep 17 00:00:00 2001 From: Andaman Lekawat <79822017+andamanopal@users.noreply.github.com> Date: Thu, 1 Jan 2026 20:14:21 +0700 Subject: [PATCH 2/7] fix: standardize variable naming from {project_root} to {project-root} (#1217) Fixed inconsistent variable naming in workflow instruction files across CIS, BMGD, and BMM modules. The standard variable format uses hyphens ({project-root}) not underscores ({project_root}). Affected files: - CIS: problem-solving, innovation-strategy, design-thinking, storytelling - BMGD: brainstorm-game, narrative, create-story checklist - BMM: excalidraw diagrams, create-story checklist Co-authored-by: Claude Co-authored-by: Brian --- .../workflows/1-preproduction/brainstorm-game/instructions.md | 2 +- .../workflows/2-design/narrative/instructions-narrative.md | 2 +- .../bmgd/workflows/4-production/create-story/checklist.md | 4 ++-- .../bmm/workflows/4-implementation/create-story/checklist.md | 4 ++-- .../excalidraw-diagrams/create-dataflow/instructions.md | 2 +- .../excalidraw-diagrams/create-diagram/instructions.md | 2 +- .../excalidraw-diagrams/create-flowchart/instructions.md | 2 +- .../excalidraw-diagrams/create-wireframe/instructions.md | 2 +- src/modules/cis/workflows/design-thinking/instructions.md | 4 ++-- src/modules/cis/workflows/innovation-strategy/instructions.md | 4 ++-- src/modules/cis/workflows/problem-solving/instructions.md | 4 ++-- src/modules/cis/workflows/storytelling/instructions.md | 4 ++-- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md index 55574a3a..21afdc77 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md @@ -1,4 +1,4 @@ -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml Communicate all responses in {communication_language} This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques diff --git a/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md b/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md index d47263ea..213a922e 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md +++ b/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md @@ -2,7 +2,7 @@ -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already completed the GDD workflow Communicate all responses in {communication_language} This workflow creates detailed narrative content for story-driven games diff --git a/src/modules/bmgd/workflows/4-production/create-story/checklist.md b/src/modules/bmgd/workflows/4-production/create-story/checklist.md index b0f22385..55e6c397 100644 --- a/src/modules/bmgd/workflows/4-production/create-story/checklist.md +++ b/src/modules/bmgd/workflows/4-production/create-story/checklist.md @@ -33,7 +33,7 @@ This is a COMPETITION to create the **ULTIMATE story context** that makes LLM de ### **When Running from Create-Story Workflow:** -- The `{project_root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: +- The `{project-root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: - Load this checklist file - Load the newly created story file (`{story_file_path}`) - Load workflow variables from `{installed_path}/workflow.yaml` @@ -63,7 +63,7 @@ You will systematically re-do the entire story creation process, but with a crit 1. **Load the workflow configuration**: `{installed_path}/workflow.yaml` for variable inclusion 2. **Load the story file**: `{story_file_path}` (provided by user or discovered) -3. **Load validation framework**: `{project_root}/_bmad/core/tasks/validate-workflow.xml` +3. **Load validation framework**: `{project-root}/_bmad/core/tasks/validate-workflow.xml` 4. **Extract metadata**: epic_num, story_num, story_key, story_title from story file 5. **Resolve all workflow variables**: story_dir, output_folder, epics_file, architecture_file, etc. 6. **Understand current status**: What story implementation guidance is currently provided? diff --git a/src/modules/bmm/workflows/4-implementation/create-story/checklist.md b/src/modules/bmm/workflows/4-implementation/create-story/checklist.md index b0f22385..55e6c397 100644 --- a/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +++ b/src/modules/bmm/workflows/4-implementation/create-story/checklist.md @@ -33,7 +33,7 @@ This is a COMPETITION to create the **ULTIMATE story context** that makes LLM de ### **When Running from Create-Story Workflow:** -- The `{project_root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: +- The `{project-root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: - Load this checklist file - Load the newly created story file (`{story_file_path}`) - Load workflow variables from `{installed_path}/workflow.yaml` @@ -63,7 +63,7 @@ You will systematically re-do the entire story creation process, but with a crit 1. **Load the workflow configuration**: `{installed_path}/workflow.yaml` for variable inclusion 2. **Load the story file**: `{story_file_path}` (provided by user or discovered) -3. **Load validation framework**: `{project_root}/_bmad/core/tasks/validate-workflow.xml` +3. **Load validation framework**: `{project-root}/_bmad/core/tasks/validate-workflow.xml` 4. **Extract metadata**: epic_num, story_num, story_key, story_title from story file 5. **Resolve all workflow variables**: story_dir, output_folder, epics_file, architecture_file, etc. 6. **Understand current status**: What story implementation guidance is currently provided? diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md index 2902a8f6..30d32ed3 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md @@ -1,7 +1,7 @@ # Create Data Flow Diagram - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates data flow diagrams (DFD) in Excalidraw format. diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md index 1595bad1..407a76bf 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md @@ -1,7 +1,7 @@ # Create Diagram - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format. diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md index b70607c7..74267905 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md @@ -1,7 +1,7 @@ # Create Flowchart - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows. diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md index cc727434..dc9506b0 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md @@ -1,7 +1,7 @@ # Create Wireframe - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates website or app wireframes in Excalidraw format. diff --git a/src/modules/cis/workflows/design-thinking/instructions.md b/src/modules/cis/workflows/design-thinking/instructions.md index a1812f6a..84090391 100644 --- a/src/modules/cis/workflows/design-thinking/instructions.md +++ b/src/modules/cis/workflows/design-thinking/instructions.md @@ -1,7 +1,7 @@ # Design Thinking Workflow Instructions -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/design-thinking/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/design-thinking/workflow.yaml Load and understand design methods from: {design_methods} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/src/modules/cis/workflows/innovation-strategy/instructions.md b/src/modules/cis/workflows/innovation-strategy/instructions.md index cf0179a8..713da6e9 100644 --- a/src/modules/cis/workflows/innovation-strategy/instructions.md +++ b/src/modules/cis/workflows/innovation-strategy/instructions.md @@ -1,7 +1,7 @@ # Innovation Strategy Workflow Instructions -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml Load and understand innovation frameworks from: {innovation_frameworks} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/src/modules/cis/workflows/problem-solving/instructions.md b/src/modules/cis/workflows/problem-solving/instructions.md index c9ff9343..3d571898 100644 --- a/src/modules/cis/workflows/problem-solving/instructions.md +++ b/src/modules/cis/workflows/problem-solving/instructions.md @@ -1,7 +1,7 @@ # Problem Solving Workflow Instructions -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/problem-solving/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/problem-solving/workflow.yaml Load and understand solving methods from: {solving_methods} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/src/modules/cis/workflows/storytelling/instructions.md b/src/modules/cis/workflows/storytelling/instructions.md index 0c0fcbe3..f67dd101 100644 --- a/src/modules/cis/workflows/storytelling/instructions.md +++ b/src/modules/cis/workflows/storytelling/instructions.md @@ -3,8 +3,8 @@ ## Workflow -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/storytelling/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/storytelling/workflow.yaml Communicate all responses in {communication_language} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. From c748f0f6cc4d9c501ef80a07cb663d80d8ebdcc1 Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Thu, 1 Jan 2026 19:40:18 +0800 Subject: [PATCH 3/7] paths for workflow and sprint tatus files fixed --- docs/modules/bmgd-bmad-game-dev/workflows-guide.md | 2 +- .../bmgd/workflows/4-production/code-review/workflow.yaml | 2 +- .../workflows/4-production/correct-course/workflow.yaml | 2 +- .../workflows/4-production/create-story/workflow.yaml | 2 +- .../bmgd/workflows/4-production/dev-story/workflow.yaml | 2 +- .../workflows/4-production/retrospective/workflow.yaml | 2 +- .../workflows/4-production/sprint-status/workflow.yaml | 4 ++-- .../4-implementation/correct-course/workflow.yaml | 2 +- .../workflows/4-implementation/create-story/workflow.yaml | 2 +- .../4-implementation/sprint-status/workflow.yaml | 4 ++-- .../bmm/workflows/testarch/test-design/instructions.md | 4 ++-- src/modules/bmm/workflows/workflow-status/instructions.md | 8 ++++---- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/modules/bmgd-bmad-game-dev/workflows-guide.md b/docs/modules/bmgd-bmad-game-dev/workflows-guide.md index e2489224..3b839499 100644 --- a/docs/modules/bmgd-bmad-game-dev/workflows-guide.md +++ b/docs/modules/bmgd-bmad-game-dev/workflows-guide.md @@ -161,7 +161,7 @@ Production workflows inherit from BMM and add game-specific overrides. **Command:** `sprint-planning` **Agent:** Game Scrum Master **Input:** GDD with epics -**Output:** `{output_folder}/sprint-status.yaml` +**Output:** `{implementation_artifacts}/sprint-status.yaml` **Description:** Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking. diff --git a/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml b/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml index 9ab42a47..25a9382f 100644 --- a/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml @@ -12,7 +12,7 @@ user_skill_level: "{config_source}:user_skill_level" document_output_language: "{config_source}:document_output_language" date: system-generated implementation_artifacts: "{config_source}:implementation_artifacts" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Workflow components installed_path: "{project-root}/_bmad/bmgd/workflows/4-production/code-review" diff --git a/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml b/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml index 0af8a84e..77079c79 100644 --- a/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml @@ -11,7 +11,7 @@ user_skill_level: "{config_source}:user_skill_level" document_output_language: "{config_source}:document_output_language" date: system-generated implementation_artifacts: "{config_source}:implementation_artifacts" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Smart input file references - handles both whole docs and sharded docs # Priority: Whole document first, then sharded version diff --git a/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml b/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml index 5ce7dd10..508716b3 100644 --- a/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml @@ -19,7 +19,7 @@ validation: "{installed_path}/checklist.md" # Variables and inputs variables: - sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" # Primary source for story tracking + sprint_status: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" # Primary source for story tracking epics_file: "{output_folder}/epics.md" # Preferred source for epic/story breakdown prd_file: "{output_folder}/PRD.md" # Fallback for requirements architecture_file: "{planning_artifacts}/architecture.md" # Optional architecture context diff --git a/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml b/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml index dd213876..ea59b392 100644 --- a/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml @@ -16,7 +16,7 @@ story_file: "" # Explicit story path; auto-discovered if empty # Context file uses same story_key as story file (e.g., "1-2-user-authentication.context.xml") context_file: "{story_dir}/{{story_key}}.context.xml" implementation_artifacts: "{config_source}:implementation_artifacts" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" # Smart input file references - handles both whole docs and sharded docs # Priority: Whole document first, then sharded version diff --git a/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml b/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml index 4bbb3000..9ae82b6d 100644 --- a/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml @@ -54,7 +54,7 @@ input_file_patterns: load_strategy: "INDEX_GUIDED" # Required files -sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" story_directory: "{implementation_artifacts}" retrospectives_folder: "{implementation_artifacts}" diff --git a/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml b/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml index 7824ced7..10694176 100644 --- a/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml @@ -18,14 +18,14 @@ instructions: "{installed_path}/instructions.md" # Inputs variables: - sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" tracking_system: "file-system" # Smart input file references input_file_patterns: sprint_status: description: "Sprint status file generated by sprint-planning" - whole: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + whole: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" load_strategy: "FULL_LOAD" # Standalone so IDE commands get generated diff --git a/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml b/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml index 436aeff0..70813514 100644 --- a/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml @@ -13,7 +13,7 @@ implementation_artifacts: "{config_source}:implementation_artifacts" planning_artifacts: "{config_source}:planning_artifacts" project_knowledge: "{config_source}:project_knowledge" output_folder: "{implementation_artifacts}" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Smart input file references - handles both whole docs and sharded docs # Priority: Whole document first, then sharded version diff --git a/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml b/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml index e79a7f97..258794c7 100644 --- a/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml @@ -20,7 +20,7 @@ validation: "{installed_path}/checklist.md" # Variables and inputs variables: - sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" # Primary source for story tracking + sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Primary source for story tracking epics_file: "{planning_artifacts}/epics.md" # Enhanced epics+stories with BDD and source hints prd_file: "{planning_artifacts}/prd.md" # Fallback for requirements (if not in epics file) architecture_file: "{planning_artifacts}/architecture.md" # Fallback for constraints (if not in epics file) diff --git a/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml b/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml index 2dd2f25c..6f10a9a6 100644 --- a/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml @@ -19,14 +19,14 @@ instructions: "{installed_path}/instructions.md" # Inputs variables: - sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + sprint_status_file: "{implementation_artifacts}/sprint-status.yaml" tracking_system: "file-system" # Smart input file references input_file_patterns: sprint_status: description: "Sprint status file generated by sprint-planning" - whole: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + whole: "{implementation_artifacts}/sprint-status.yaml" load_strategy: "FULL_LOAD" # Standalone so IDE commands get generated diff --git a/src/modules/bmm/workflows/testarch/test-design/instructions.md b/src/modules/bmm/workflows/testarch/test-design/instructions.md index 217d7c86..86561cfd 100644 --- a/src/modules/bmm/workflows/testarch/test-design/instructions.md +++ b/src/modules/bmm/workflows/testarch/test-design/instructions.md @@ -25,11 +25,11 @@ The workflow auto-detects which mode to use based on project phase. ### Mode Detection 1. **Check for sprint-status.yaml** - - If `{output_folder}/bmm-sprint-status.yaml` exists → **Epic-Level Mode** (Phase 4) + - If `{implementation_artifacts}/sprint-status.yaml` exists → **Epic-Level Mode** (Phase 4) - If NOT exists → Check workflow status 2. **Check workflow-status.yaml** - - Read `{output_folder}/bmm-workflow-status.yaml` + - Read `{planning_artifacts}/bmm-workflow-status.yaml` - If `implementation-readiness: required` or `implementation-readiness: recommended` → **System-Level Mode** (Phase 3) - Otherwise → **Epic-Level Mode** (Phase 4 without sprint status yet) diff --git a/src/modules/bmm/workflows/workflow-status/instructions.md b/src/modules/bmm/workflows/workflow-status/instructions.md index 5f816aa6..6c25bdb1 100644 --- a/src/modules/bmm/workflows/workflow-status/instructions.md +++ b/src/modules/bmm/workflows/workflow-status/instructions.md @@ -197,7 +197,7 @@ Your choice: -Read {output_folder}/bmm-workflow-status.yaml if exists +Read {planning_artifacts}/bmm-workflow-status.yaml if exists status_exists = false @@ -261,7 +261,7 @@ Your choice: -Read {output_folder}/bmm-workflow-status.yaml if exists +Read {planning_artifacts}/bmm-workflow-status.yaml if exists status_exists = false @@ -309,7 +309,7 @@ Your choice: -Check if {output_folder}/bmm-workflow-status.yaml exists +Check if {planning_artifacts}/bmm-workflow-status.yaml exists status_exists = true @@ -325,7 +325,7 @@ Your choice: -Read {output_folder}/bmm-workflow-status.yaml +Read {planning_artifacts}/bmm-workflow-status.yaml success = false From 05ddc2d29b75d5297f1fe51f3128c05aa5a19e53 Mon Sep 17 00:00:00 2001 From: Alex Verkhovsky Date: Fri, 2 Jan 2026 17:14:09 -0800 Subject: [PATCH 4/7] fix(dev): allow full project-context usage with conflict precedence (#1220) --- src/modules/bmm/agents/dev.agent.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/modules/bmm/agents/dev.agent.yaml b/src/modules/bmm/agents/dev.agent.yaml index c5d79017..0b14d984 100644 --- a/src/modules/bmm/agents/dev.agent.yaml +++ b/src/modules/bmm/agents/dev.agent.yaml @@ -20,12 +20,12 @@ agent: - Never implement anything not mapped to a specific task/subtask in the story file - All existing tests must pass 100% before story is ready for review - Every task/subtask must be covered by comprehensive unit tests before marking complete - - Project context provides coding standards but never overrides story requirements - - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` + - Follow project-context.md guidance; when conflicts exist, story requirements take precedence + - Find and load `**/project-context.md` if it exists - essential reference for implementation critical_actions: - "READ the entire story file BEFORE any implementation - tasks/subtasks sequence is your authoritative implementation guide" - - "Load project-context.md if available for coding standards only - never let it override story requirements" + - "Load project-context.md if available and follow its guidance - when conflicts exist, story requirements always take precedence" - "Execute tasks/subtasks IN ORDER as written in story file - no skipping, no reordering, no doing what you want" - "For each task/subtask: follow red-green-refactor cycle - write failing test first, then implementation" - "Mark task/subtask [x] ONLY when both implementation AND tests are complete and passing" From d1f3844449274b400eb2055d9b5c0468f22434ab Mon Sep 17 00:00:00 2001 From: forcetrainer Date: Sat, 3 Jan 2026 04:09:42 -0500 Subject: [PATCH 5/7] Docusaurus build fix - Sidebar and missing image issues (#1243) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix(docs): align sidebar with actual docs structure and fix image path Sidebar referenced non-existent paths (modules/bmm/, getting-started/, etc.) while actual docs live in different locations (modules/bmm-bmad-method/, bmad-core-concepts/, etc.). Updated sidebar to match reality so Docusaurus can build successfully. Also fixed broken image reference in workflows-guide.md that used an incorrect relative path. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 * fix(docs): update build script to include docs/modules directory The build script was excluding the modules folder when copying from docs/, but module docs now live in docs/modules/ instead of src/modules/*/docs/. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 * fix(docs): correct broken internal links Fixed relative paths that were pointing to non-existent locations: - bmgd index: ../../bmm/docs/index.md → ../bmm/index.md - cis index: ../../bmm/docs/index.md → ../bmm/index.md - bmm faq: ./README.md → GitHub URL 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 --------- Co-authored-by: Claude Opus 4.5 --- docs/modules/bmgd-bmad-game-dev/index.md | 2 +- .../bmgd-bmad-game-dev/workflows-guide.md | 2 +- docs/modules/bmm-bmad-method/faq.md | 2 +- .../cis-creative-intelligence-suite/index.md | 2 +- tools/build-docs.js | 3 +- website/sidebars.js | 125 +++++++++--------- 6 files changed, 66 insertions(+), 70 deletions(-) diff --git a/docs/modules/bmgd-bmad-game-dev/index.md b/docs/modules/bmgd-bmad-game-dev/index.md index 510cf899..9d53e295 100644 --- a/docs/modules/bmgd-bmad-game-dev/index.md +++ b/docs/modules/bmgd-bmad-game-dev/index.md @@ -161,7 +161,7 @@ BMGD Documentation ### Related Documentation -- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation +- **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation ## Tips for Using This Documentation diff --git a/docs/modules/bmgd-bmad-game-dev/workflows-guide.md b/docs/modules/bmgd-bmad-game-dev/workflows-guide.md index 3b839499..d649bc09 100644 --- a/docs/modules/bmgd-bmad-game-dev/workflows-guide.md +++ b/docs/modules/bmgd-bmad-game-dev/workflows-guide.md @@ -8,7 +8,7 @@ Complete reference for all BMGD workflows organized by development phase. BMGD workflows are organized into four phases: -![BMGD Workflow Overview](../../../../docs/modules/bmgd-bmad-game-dev/workflow-overview.jpg) +![BMGD Workflow Overview](./workflow-overview.jpg) --- diff --git a/docs/modules/bmm-bmad-method/faq.md b/docs/modules/bmm-bmad-method/faq.md index 628d265e..1849f6b9 100644 --- a/docs/modules/bmm-bmad-method/faq.md +++ b/docs/modules/bmm-bmad-method/faq.md @@ -510,7 +510,7 @@ Trust your expertise - BMM supports your decisions. **A:** -1. Search [Complete Documentation](./README.md) for related topics +1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics 2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#general-dev) 3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) 4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode) diff --git a/docs/modules/cis-creative-intelligence-suite/index.md b/docs/modules/cis-creative-intelligence-suite/index.md index 46fb6e0a..05b567f3 100644 --- a/docs/modules/cis-creative-intelligence-suite/index.md +++ b/docs/modules/cis-creative-intelligence-suite/index.md @@ -142,7 +142,7 @@ CIS workflows integrate with: ## Related Documentation -- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation +- **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation --- diff --git a/tools/build-docs.js b/tools/build-docs.js index fbab38aa..bfeda390 100644 --- a/tools/build-docs.js +++ b/tools/build-docs.js @@ -129,7 +129,8 @@ function buildDocusaurusSite(artifactsDir) { function copyMainDocs(destDir) { console.log(' → Copying main docs...'); const docsDir = path.join(PROJECT_ROOT, 'docs'); - copyDirectory(docsDir, destDir, ['modules', 'llms.txt', 'llms-full.txt'], true); + // Include modules folder - docs now live in docs/modules/ instead of src/modules/*/docs/ + copyDirectory(docsDir, destDir, ['llms.txt', 'llms-full.txt'], true); } function copyRootDocs(destDir) { diff --git a/website/sidebars.js b/website/sidebars.js index 827fa131..aa6b183a 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -4,40 +4,56 @@ const sidebars = { 'index', { type: 'category', - label: 'Getting Started', + label: 'Core Concepts', items: [ - 'getting-started/installation', + 'bmad-core-concepts/index', + 'bmad-core-concepts/agents', + 'bmad-core-concepts/workflows', + 'bmad-core-concepts/modules', { type: 'category', - label: 'IDE Guides', + label: 'Installing', collapsed: true, - items: [], + items: ['bmad-core-concepts/installing/index', 'bmad-core-concepts/installing/upgrading'], }, - 'v4-to-v6-upgrade', + { + type: 'category', + label: 'Customization', + collapsed: true, + items: [ + 'bmad-core-concepts/bmad-customization/index', + 'bmad-core-concepts/bmad-customization/agents', + 'bmad-core-concepts/bmad-customization/workflows', + ], + }, + 'bmad-core-concepts/web-bundles/index', ], }, { type: 'category', label: 'BMM - Method', items: [ - 'modules/bmm/index', - 'modules/bmm/quick-start', - 'modules/bmm/scale-adaptive-system', + 'modules/bmm-bmad-method/index', + 'modules/bmm-bmad-method/quick-start', { type: 'category', label: 'Quick Flows', collapsed: true, - items: ['modules/bmm/bmad-quick-flow', 'modules/bmm/quick-flow-solo-dev', 'modules/bmm/quick-spec-flow'], + items: [ + 'modules/bmm-bmad-method/bmad-quick-flow', + 'modules/bmm-bmad-method/quick-flow-solo-dev', + 'modules/bmm-bmad-method/quick-spec-flow', + ], }, { type: 'category', label: 'Workflows', collapsed: true, items: [ - 'modules/bmm/workflows-planning', - 'modules/bmm/workflows-solutioning', - 'modules/bmm/workflows-analysis', - 'modules/bmm/workflows-implementation', + 'modules/bmm-bmad-method/workflows-planning', + 'modules/bmm-bmad-method/workflows-solutioning', + 'modules/bmm-bmad-method/workflows-analysis', + 'modules/bmm-bmad-method/workflows-implementation', ], }, { @@ -45,11 +61,10 @@ const sidebars = { label: 'Advanced Topics', collapsed: true, items: [ - 'modules/bmm/party-mode', - 'modules/bmm/agents-guide', - 'modules/bmm/brownfield-guide', - 'modules/bmm/enterprise-agentic-development', - 'modules/bmm/test-architecture', + 'modules/bmm-bmad-method/party-mode', + 'modules/bmm-bmad-method/agents-guide', + 'modules/bmm-bmad-method/brownfield-guide', + 'modules/bmm-bmad-method/test-architecture', ], }, { @@ -57,11 +72,10 @@ const sidebars = { label: 'Reference', collapsed: true, items: [ - 'modules/bmm/workflow-architecture-reference', - 'modules/bmm/workflow-document-project-reference', - 'modules/bmm/troubleshooting', - 'modules/bmm/faq', - 'modules/bmm/glossary', + 'modules/bmm-bmad-method/workflow-document-project-reference', + 'modules/bmm-bmad-method/troubleshooting', + 'modules/bmm-bmad-method/faq', + 'modules/bmm-bmad-method/glossary', ], }, ], @@ -71,32 +85,11 @@ const sidebars = { label: 'BMB - Builder', collapsed: true, items: [ - 'modules/bmb/index', - { - type: 'category', - label: 'Building Agents', - collapsed: true, - items: [ - 'modules/bmb/agents/index', - 'modules/bmb/agents/understanding-agent-types', - 'modules/bmb/agents/simple-agent-architecture', - 'modules/bmb/agents/expert-agent-architecture', - 'modules/bmb/agents/agent-compilation', - 'modules/bmb/agents/agent-menu-patterns', - ], - }, - { - type: 'category', - label: 'Building Workflows', - collapsed: true, - items: [ - 'modules/bmb/workflows/index', - 'modules/bmb/workflows/architecture', - 'modules/bmb/workflows/terms', - 'modules/bmb/workflows/intent-vs-prescriptive-spectrum', - 'modules/bmb/workflows/csv-data-file-standards', - ], - }, + 'modules/bmb-bmad-builder/index', + 'modules/bmb-bmad-builder/agent-creation-guide', + 'modules/bmb-bmad-builder/workflow-vendoring-customization-inheritance', + 'modules/bmb-bmad-builder/custom-content', + 'modules/bmb-bmad-builder/custom-content-installation', ], }, { @@ -104,33 +97,35 @@ const sidebars = { label: 'BMGD - Game Dev', collapsed: true, items: [ - 'modules/bmgd/index', - 'modules/bmgd/quick-start', - 'modules/bmgd/quick-flow-guide', - 'modules/bmgd/agents-guide', - 'modules/bmgd/workflows-guide', - 'modules/bmgd/game-types-guide', - 'modules/bmgd/troubleshooting', - 'modules/bmgd/glossary', + 'modules/bmgd-bmad-game-dev/index', + 'modules/bmgd-bmad-game-dev/quick-start', + 'modules/bmgd-bmad-game-dev/quick-flow-guide', + 'modules/bmgd-bmad-game-dev/agents-guide', + 'modules/bmgd-bmad-game-dev/workflows-guide', + 'modules/bmgd-bmad-game-dev/game-types-guide', + 'modules/bmgd-bmad-game-dev/troubleshooting', + 'modules/bmgd-bmad-game-dev/glossary', ], }, { type: 'category', label: 'CIS - Creative Intelligence', collapsed: true, - items: ['modules/cis/index'], + items: ['modules/cis-creative-intelligence-suite/index'], }, { type: 'category', - label: 'Reference', + label: 'Core Module', collapsed: true, items: [ - 'document-sharding-guide', - 'custom-content', - 'custom-content-installation', - 'agent-customization-guide', - 'web-bundles-gemini-gpt-guide', - 'BUNDLE_DISTRIBUTION_SETUP', + 'modules/core/index', + 'modules/core/party-mode', + 'modules/core/core-tasks', + 'modules/core/core-workflows', + 'modules/core/advanced-elicitation', + 'modules/core/brainstorming', + 'modules/core/document-sharding-guide', + 'modules/core/global-core-config', ], }, ], From f31659765e84d89df233444e0feac27be095ba9a Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Fri, 2 Jan 2026 21:07:23 +0800 Subject: [PATCH 6/7] trimodal viarate workflow creation --- .../bmb/agents/workflow-builder.agent.yaml | 18 +- .../bmb/docs/workflows/architecture.md | 220 -------- .../docs/workflows/csv-data-file-standards.md | 206 -------- .../intent-vs-prescriptive-spectrum.md | 220 -------- .../bmb/docs/workflows/step-file-rules.md | 469 ------------------ .../bmb/docs/workflows/templates/step-file.md | 139 ------ .../bmb/docs/workflows/templates/workflow.md | 58 --- src/modules/bmb/docs/workflows/terms.md | 97 ---- .../agent/steps-c/step-01-brainstorm.md | 4 +- .../agent/steps-c/step-02-discovery.md | 4 +- .../agent/steps-c/step-03-type-metadata.md | 4 +- .../agent/steps-c/step-04-persona.md | 4 +- .../agent/steps-c/step-05-commands-menu.md | 4 +- .../agent/steps-c/step-06-activation.md | 4 +- .../agent/steps-c/step-07a-build-simple.md | 4 +- .../steps-c/step-08a-plan-traceability.md | 4 +- .../steps-c/step-08e-structure-validation.md | 4 +- .../steps-c/step-08f-sidecar-validation.md | 4 +- .../agent/steps-c/step-09-celebrate.md | 4 +- .../agent/steps-e/e-01-load-existing.md | 4 +- .../agent/steps-e/e-02-discover-edits.md | 4 +- .../agent/steps-e/e-03-placeholder.md | 1 + .../agent/steps-e/e-04-type-metadata.md | 4 +- .../workflows/agent/steps-e/e-05-persona.md | 4 +- .../agent/steps-e/e-06-commands-menu.md | 4 +- .../agent/steps-e/e-07-activation.md | 4 +- .../agent/steps-e/e-08a-edit-simple.md | 4 +- .../agent/steps-e/e-08b-edit-expert.md | 4 +- .../agent/steps-e/e-08c-edit-module.md | 4 +- .../agent/steps-e/e-09a-validate-metadata.md | 4 +- .../agent/steps-e/e-09b-validate-persona.md | 4 +- .../agent/steps-e/e-09c-validate-menu.md | 4 +- .../agent/steps-e/e-09d-validate-structure.md | 4 +- .../agent/steps-e/e-09e-validate-sidecar.md | 4 +- .../agent/steps-e/e-09f-validation-summary.md | 4 +- .../workflows/agent/steps-e/e-10-celebrate.md | 4 +- .../agent/steps-v/v-01-load-review.md | 4 +- .../agent/steps-v/v-02a-validate-metadata.md | 4 +- .../agent/steps-v/v-02b-validate-persona.md | 4 +- .../agent/steps-v/v-02c-validate-menu.md | 4 +- .../agent/steps-v/v-02d-validate-structure.md | 4 +- .../agent/steps-v/v-02e-validate-sidecar.md | 4 +- .../workflows/agent/steps-v/v-03-summary.md | 4 +- .../create-workflow/steps/step-01-init.md | 158 ------ .../create-workflow/steps/step-02-gather.md | 212 -------- .../steps/step-03-tools-configuration.md | 251 ---------- .../steps/step-04-plan-review.md | 217 -------- .../steps/step-05-output-format-design.md | 290 ----------- .../create-workflow/steps/step-07-build.md | 323 ------------ .../create-workflow/steps/step-08-review.md | 285 ----------- .../create-workflow/steps/step-09-complete.md | 188 ------- .../edit-workflow/steps/step-01-analyze.md | 217 -------- .../edit-workflow/steps/step-02-discover.md | 254 ---------- .../edit-workflow/steps/step-03-improve.md | 218 -------- .../edit-workflow/steps/step-04-validate.md | 194 -------- .../steps/step-05-compliance-check.md | 246 --------- .../templates/completion-summary.md | 75 --- .../templates/improvement-goals.md | 68 --- .../templates/improvement-log.md | 40 -- .../templates/validation-results.md | 51 -- .../templates/workflow-analysis.md | 56 --- .../bmb/workflows/edit-workflow/workflow.md | 59 --- .../steps/step-01-validate-goal.md | 153 ------ .../steps/step-02-workflow-validation.md | 244 --------- .../steps/step-03-step-validation.md | 275 ---------- .../steps/step-04-file-validation.md | 296 ----------- .../step-05-intent-spectrum-validation.md | 265 ---------- .../step-06-web-subprocess-validation.md | 361 -------------- .../steps/step-07-holistic-analysis.md | 259 ---------- .../steps/step-08-generate-report.md | 302 ----------- .../templates/compliance-report.md | 140 ------ .../workflow-compliance-check/workflow.md | 59 --- .../workflows/workflow/data/architecture.md | 152 ++++++ .../workflow/data}/common-workflow-tools.csv | 0 .../workflow/data/csv-data-file-standards.md | 81 +++ .../data/dietary-restrictions.csv | 0 .../data/macro-calculator.csv | 0 .../data/recipe-database.csv | 0 .../steps-c}/step-01-init.md | 13 +- .../steps-c}/step-01b-continue.md | 18 +- .../steps-c}/step-02-profile.md | 10 +- .../steps-c}/step-03-assessment.md | 14 +- .../steps-c}/step-04-strategy.md | 14 +- .../steps-c}/step-05-shopping.md | 10 +- .../steps-c}/step-06-prep-schedule.md | 8 +- .../templates/assessment-section.md | 0 .../templates/nutrition-plan.md | 0 .../templates/prep-schedule-section.md | 0 .../templates/profile-section.md | 0 .../templates/shopping-section.md | 0 .../templates/strategy-section.md | 0 .../examples/meal-prep-nutrition/workflow.md | 2 +- .../workflow/data/frontmatter-standards.md | 179 +++++++ .../data/input-discovery-standards.md | 269 ++++++++++ .../data/intent-vs-prescriptive-spectrum.md | 50 ++ .../workflow/data/menu-handling-standards.md | 167 +++++++ .../workflow/data/output-format-standards.md | 188 +++++++ .../workflow/data/step-file-rules.md | 235 +++++++++ .../workflow/data/step-type-patterns.md | 312 ++++++++++++ .../data/trimodal-workflow-structure.md | 209 ++++++++ .../data/workflow-chaining-standards.md | 271 ++++++++++ .../workflow/data/workflow-examples.md | 276 +++++++++++ .../workflow/data/workflow-type-criteria.md | 172 +++++++ .../workflow/steps-c/step-00-conversion.md | 262 ++++++++++ .../workflow/steps-c/step-01-discovery.md | 194 ++++++++ .../steps-c/step-02-classification.md | 269 ++++++++++ .../workflow/steps-c/step-03-requirements.md | 282 +++++++++++ .../workflow/steps-c/step-04-tools.md | 281 +++++++++++ .../workflow/steps-c/step-05-plan-review.md | 242 +++++++++ .../steps-c}/step-06-design.md | 88 ++-- .../workflow/steps-c/step-07-foundation.md | 238 +++++++++ .../workflow/steps-c/step-08-build-step-01.md | 333 +++++++++++++ .../steps-c/step-09-build-next-step.md | 306 ++++++++++++ .../workflow/steps-c/step-10-confirmation.md | 320 ++++++++++++ .../workflow/steps-c/step-11-completion.md | 191 +++++++ .../steps-e/step-e-01-assess-workflow.md | 237 +++++++++ .../steps-e/step-e-02-discover-edits.md | 248 +++++++++ .../steps-e/step-e-03-fix-validation.md | 252 ++++++++++ .../workflow/steps-e/step-e-04-direct-edit.md | 275 ++++++++++ .../workflow/steps-e/step-e-05-apply-edit.md | 154 ++++++ .../steps-e/step-e-06-validate-after.md | 190 +++++++ .../workflow/steps-e/step-e-07-complete.md | 206 ++++++++ .../workflow/steps-v/step-01-validate.md | 245 +++++++++ .../steps-v/step-02-frontmatter-validation.md | 153 ++++++ .../steps-v/step-03-menu-validation.md | 161 ++++++ .../steps-v/step-04-step-type-validation.md | 186 +++++++ .../step-05-output-format-validation.md | 195 ++++++++ .../step-06-validation-design-check.md | 186 +++++++ .../step-07-instruction-style-check.md | 192 +++++++ .../step-08-collaborative-experience-check.md | 199 ++++++++ .../steps-v/step-09-cohesive-review.md | 235 +++++++++ .../steps-v/step-10-report-complete.md | 234 +++++++++ .../steps-v/step-11-plan-validation.md | 209 ++++++++ .../templates/minimal-output-template.md | 11 + .../step-01-init-continuable-template.md | 0 .../workflow}/templates/step-1b-template.md | 0 .../workflow}/templates/step-template.md | 6 +- .../workflow}/templates/workflow-template.md | 0 .../{create-workflow => workflow}/workflow.md | 50 +- 139 files changed, 9480 insertions(+), 7320 deletions(-) delete mode 100644 src/modules/bmb/docs/workflows/architecture.md delete mode 100644 src/modules/bmb/docs/workflows/csv-data-file-standards.md delete mode 100644 src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md delete mode 100644 src/modules/bmb/docs/workflows/step-file-rules.md delete mode 100644 src/modules/bmb/docs/workflows/templates/step-file.md delete mode 100644 src/modules/bmb/docs/workflows/templates/workflow.md delete mode 100644 src/modules/bmb/docs/workflows/terms.md create mode 100644 src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-01-init.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-07-build.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-08-review.md delete mode 100644 src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/templates/validation-results.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md delete mode 100644 src/modules/bmb/workflows/edit-workflow/workflow.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md delete mode 100644 src/modules/bmb/workflows/workflow-compliance-check/workflow.md create mode 100644 src/modules/bmb/workflows/workflow/data/architecture.md rename src/modules/bmb/{docs/workflows => workflows/workflow/data}/common-workflow-tools.csv (100%) create mode 100644 src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/data/macro-calculator.csv (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/data/recipe-database.csv (100%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-01-init.md (91%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-01b-continue.md (88%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-02-profile.md (93%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-03-assessment.md (90%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-04-strategy.md (91%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-05-shopping.md (93%) rename src/modules/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/steps => workflow/data/examples/meal-prep-nutrition/steps-c}/step-06-prep-schedule.md (94%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/templates/assessment-section.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/templates/nutrition-plan.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/templates/profile-section.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/templates/shopping-section.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/templates/strategy-section.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/data/examples/meal-prep-nutrition/workflow.md (95%) create mode 100644 src/modules/bmb/workflows/workflow/data/frontmatter-standards.md create mode 100644 src/modules/bmb/workflows/workflow/data/input-discovery-standards.md create mode 100644 src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md create mode 100644 src/modules/bmb/workflows/workflow/data/menu-handling-standards.md create mode 100644 src/modules/bmb/workflows/workflow/data/output-format-standards.md create mode 100644 src/modules/bmb/workflows/workflow/data/step-file-rules.md create mode 100644 src/modules/bmb/workflows/workflow/data/step-type-patterns.md create mode 100644 src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md create mode 100644 src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md create mode 100644 src/modules/bmb/workflows/workflow/data/workflow-examples.md create mode 100644 src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md rename src/modules/bmb/workflows/{create-workflow/steps => workflow/steps-c}/step-06-design.md (76%) create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md create mode 100644 src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md create mode 100644 src/modules/bmb/workflows/workflow/templates/minimal-output-template.md rename src/modules/bmb/{docs/workflows => workflows/workflow}/templates/step-01-init-continuable-template.md (100%) rename src/modules/bmb/{docs/workflows => workflows/workflow}/templates/step-1b-template.md (100%) rename src/modules/bmb/{docs/workflows => workflows/workflow}/templates/step-template.md (98%) rename src/modules/bmb/{docs/workflows => workflows/workflow}/templates/workflow-template.md (100%) rename src/modules/bmb/workflows/{create-workflow => workflow}/workflow.md (54%) diff --git a/src/modules/bmb/agents/workflow-builder.agent.yaml b/src/modules/bmb/agents/workflow-builder.agent.yaml index 73550646..36281c98 100644 --- a/src/modules/bmb/agents/workflow-builder.agent.yaml +++ b/src/modules/bmb/agents/workflow-builder.agent.yaml @@ -29,13 +29,17 @@ agent: menu: - trigger: CW or fuzzy match on create-workflow - exec: "{project-root}/_bmad/bmb/workflows/create-workflow/workflow.md" + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" description: "[CW] Create a new BMAD workflow with proper structure and best practices" - # - trigger: EW or fuzzy match on edit-workflow - # exec: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.md" - # description: "[EW] Edit existing BMAD workflows while maintaining integrity" + - trigger: EW or fuzzy match on edit-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[EW] Edit existing BMAD workflows while maintaining integrity" - # - trigger: VW or fuzzy match on validate-workflow - # exec: "{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md" - # description: "[VW] Run compliance check on BMAD workflows against best practices" + - trigger: VW or fuzzy match on validate-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[VW] Run validation check on BMAD workflows against best practices" + + - trigger: RW or fuzzy match on convert-or-rework-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[RW] Rework a Workflow to a V6 Compliant Version" diff --git a/src/modules/bmb/docs/workflows/architecture.md b/src/modules/bmb/docs/workflows/architecture.md deleted file mode 100644 index d4ccac4e..00000000 --- a/src/modules/bmb/docs/workflows/architecture.md +++ /dev/null @@ -1,220 +0,0 @@ -# Standalone Workflow Builder Architecture - -This document describes the architecture of the standalone workflow builder system - a pure markdown approach to creating structured workflows. - -## Core Architecture Principles - -### 1. Micro-File Design - -Each workflow consists of multiple focused, self-contained files, driven from a workflow.md file that is initially loaded: - -``` -workflow-folder/ -├── workflow.md # Main workflow configuration -├── steps/ # Step instruction files (focused, self-contained) -│ ├── step-01-init.md -│ ├── step-02-profile.md -│ └── step-N-[name].md -├── templates/ # Content templates -│ ├── profile-section.md -│ └── [other-sections].md -└── data/ # Optional data files - └── [data-files].csv/.json -``` - -### 2. Just-In-Time (JIT) Loading - -- **Single File in Memory**: Only the current step file is loaded -- **No Future Peeking**: Step files must not reference future steps -- **Sequential Processing**: Steps execute in strict order -- **On-Demand Loading**: Templates load only when needed - -### 3. State Management - -- **Frontmatter Tracking**: Workflow state stored in output document frontmatter -- **Progress Array**: `stepsCompleted` tracks completed steps -- **Last Step Marker**: `lastStep` indicates where to resume -- **Append-Only Building**: Documents grow by appending content - -### 4. Execution Model - -``` -1. Load workflow.md → Read configuration -2. Execute step-01-init.md → Initialize or detect continuation -3. For each step: - a. Load step file completely - b. Execute instructions sequentially - c. Wait for user input at menu points - d. Only proceed with 'C' (Continue) - e. Update document/frontmatter - f. Load next step -``` - -## Key Components - -### Workflow File (workflow.md) - -- **Purpose**: Entry point and configuration -- **Content**: Role definition, goal, architecture rules -- **Action**: Points to step-01-init.md - -### Step Files (step-NN-[name].md) - -- **Size**: Focused and concise (typically 5-10KB) -- **Structure**: Frontmatter + sequential instructions -- **Features**: Self-contained rules, menu handling, state updates - -### Frontmatter Variables - -Standard variables in step files: - -```yaml -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/[workflow-name]' -thisStepFile: '{workflow_path}/steps/step-[N]-[name].md' -nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/[output-name]-{project_name}.md' -``` - -## Execution Flow - -### Fresh Workflow - -``` -workflow.md - ↓ -step-01-init.md (creates document) - ↓ -step-02-[name].md - ↓ -step-03-[name].md - ↓ -... - ↓ -step-N-[final].md (completes workflow) -``` - -### Continuation Workflow - -``` -workflow.md - ↓ -step-01-init.md (detects existing document) - ↓ -step-01b-continue.md (analyzes state) - ↓ -step-[appropriate-next].md -``` - -## Menu System - -### Standard Menu Pattern - -``` -Display: **Select an Option:** [A] [Action] [P] Party Mode [C] Continue - -#### Menu Handling Logic: -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content, update frontmatter, load next step -``` - -### Menu Rules - -- **Halt Required**: Always wait for user input -- **Continue Only**: Only proceed with 'C' selection -- **State Persistence**: Save before loading next step -- **Loop Back**: Return to menu after other actions - -## Collaborative Dialogue Model - -### Not Command-Response - -- **Facilitator Role**: AI guides, user decides -- **Equal Partnership**: Both parties contribute -- **No Assumptions**: Don't assume user wants next step -- **Explicit Consent**: Always ask for input - -### Example Pattern - -``` -AI: "Tell me about your dietary preferences." -User: [provides information] -AI: "Thank you. Now let's discuss your cooking habits." -[Continue conversation] -AI: **Menu Options** -``` - -## CSV Intelligence (Optional) - -### Data-Driven Behavior - -- Configuration in CSV files -- Dynamic menu options -- Variable substitution -- Conditional logic - -### Example Structure - -```csv -variable,type,value,description -cooking_frequency,choice,"daily|weekly|occasionally","How often user cooks" -meal_type,multi,"breakfast|lunch|dinner|snacks","Types of meals to plan" -``` - -## Best Practices - -### File Size Limits - -- **Step Files**: Keep focused and reasonably sized (5-10KB typical) -- **Templates**: Keep focused and reusable -- **Workflow File**: Keep lean, no implementation details - -### Sequential Enforcement - -- **Numbered Steps**: Use sequential numbering (1, 2, 3...) -- **No Skipping**: Each step must complete -- **State Updates**: Mark completion in frontmatter - -### Error Prevention - -- **Path Variables**: Use frontmatter variables, never hardcode -- **Complete Loading**: Always read entire file before execution -- **Menu Halts**: Never proceed without 'C' selection - -## Migration from XML - -### Advantages - -- **No Dependencies**: Pure markdown, no XML parsing -- **Human Readable**: Files are self-documenting -- **Git Friendly**: Clean diffs and merges -- **Flexible**: Easier to modify and extend - -### Key Differences - -| XML Workflows | Standalone Workflows | -| ----------------- | ----------------------- | -| Single large file | Multiple micro-files | -| Complex structure | Simple sequential steps | -| Parser required | Any markdown viewer | -| Rigid format | Flexible organization | - -## Implementation Notes - -### Critical Rules - -- **NEVER** load multiple step files -- **ALWAYS** read complete step file first -- **NEVER** skip steps or optimize -- **ALWAYS** update frontmatter of the output file when a step is complete -- **NEVER** proceed without user consent - -### Success Metrics - -- Documents created correctly -- All steps completed sequentially -- User satisfied with collaborative process -- Clean, maintainable file structure - -This architecture ensures disciplined, predictable workflow execution while maintaining flexibility for different use cases. diff --git a/src/modules/bmb/docs/workflows/csv-data-file-standards.md b/src/modules/bmb/docs/workflows/csv-data-file-standards.md deleted file mode 100644 index 8e7402db..00000000 --- a/src/modules/bmb/docs/workflows/csv-data-file-standards.md +++ /dev/null @@ -1,206 +0,0 @@ -# CSV Data File Standards for BMAD Workflows - -## Purpose and Usage - -CSV data files in BMAD workflows serve specific purposes for different workflow types: - -**For Agents:** Provide structured data that agents need to reference but cannot realistically generate (such as specific configurations, domain-specific data, or structured knowledge bases). - -**For Expert Agents:** Supply specialized knowledge bases, reference data, or persistent information that the expert agent needs to access consistently across sessions. - -**For Workflows:** Include reference data, configuration parameters, or structured inputs that guide workflow execution and decision-making. - -**Key Principle:** CSV files should contain data that is essential, structured, and not easily generated by LLMs during execution. - -## Intent-Based Design Principle - -**Core Philosophy:** The closer workflows stay to **intent** rather than **prescriptive** instructions, the more creative and adaptive the LLM experience becomes. - -**CSV Enables Intent-Based Design:** - -- **Instead of:** Hardcoded scripts with exact phrases LLM must say -- **CSV Provides:** Clear goals and patterns that LLM adapts creatively to context -- **Result:** Natural, contextual conversations rather than rigid scripts - -**Example - Advanced Elicitation:** - -- **Prescriptive Alternative:** 50 separate files with exact conversation scripts -- **Intent-Based Reality:** One CSV row with method goal + pattern → LLM adapts to user -- **Benefit:** Same method works differently for different users while maintaining essence - -**Intent vs Prescriptive Spectrum:** - -- **Highly Prescriptive:** "Say exactly: 'Based on my analysis, I recommend...'" -- **Balanced Intent:** "Help the user understand the implications using your professional judgment" -- **CSV Goal:** Provide just enough guidance to enable creative, context-aware execution - -## Primary Use Cases - -### 1. Knowledge Base Indexing (Document Lookup Optimization) - -**Problem:** Large knowledge bases with hundreds of documents cause context blowup and missed details when LLMs try to process them all. - -**CSV Solution:** Create a knowledge base index with: - -- **Column 1:** Keywords and topics -- **Column 2:** Document file path/location -- **Column 3:** Section or line number where relevant content starts -- **Column 4:** Content type or summary (optional) - -**Result:** Transform from context-blowing document loads to surgical precision lookups, creating agents with near-infinite knowledge bases while maintaining optimal context usage. - -### 2. Workflow Sequence Optimization - -**Problem:** Complex workflows (e.g., game development) with hundreds of potential steps for different scenarios become unwieldy and context-heavy. - -**CSV Solution:** Create a workflow routing table: - -- **Column 1:** Scenario type (e.g., "2D Platformer", "RPG", "Puzzle Game") -- **Column 2:** Required step sequence (e.g., "step-01,step-03,step-07,step-12") -- **Column 3:** Document sections to include -- **Column 4:** Specialized parameters or configurations - -**Result:** Step 1 determines user needs, finds closest match in CSV, confirms with user, then follows optimized sequence - truly optimal for context usage. - -### 3. Method Registry (Dynamic Technique Selection) - -**Problem:** Tasks need to select optimal techniques from dozens of options based on context, without hardcoding selection logic. - -**CSV Solution:** Create a method registry with: - -- **Column 1:** Category (collaboration, advanced, technical, creative, etc.) -- **Column 2:** Method name and rich description -- **Column 3:** Execution pattern or flow guide (e.g., "analysis → insights → action") -- **Column 4:** Complexity level or use case indicators - -**Example:** Advanced Elicitation task analyzes content context, selects 5 best-matched methods from 50 options, then executes dynamically using CSV descriptions. - -**Result:** Smart, context-aware technique selection without hardcoded logic - infinitely extensible method libraries. - -### 4. Configuration Management - -**Problem:** Complex systems with many configuration options that vary by use case. - -**CSV Solution:** Configuration lookup tables mapping scenarios to specific parameter sets. - -## What NOT to Include in CSV Files - -**Avoid Web-Searchable Data:** Do not include information that LLMs can readily access through web search or that exists in their training data, such as: - -- Common programming syntax or standard library functions -- General knowledge about widely used technologies -- Historical facts or commonly available information -- Basic terminology or standard definitions - -**Include Specialized Data:** Focus on data that is: - -- Specific to your project or domain -- Not readily available through web search -- Essential for consistent workflow execution -- Too voluminous for LLM context windows - -## CSV Data File Standards - -### 1. Purpose Validation - -- **Essential Data Only:** CSV must contain data that cannot be reasonably generated by LLMs -- **Domain Specific:** Data should be specific to the workflow's domain or purpose -- **Consistent Usage:** All columns and data must be referenced and used somewhere in the workflow -- **No Redundancy:** Avoid data that duplicates functionality already available to LLMs - -### 2. Structural Standards - -- **Valid CSV Format:** Proper comma-separated values with quoted fields where needed -- **Consistent Columns:** All rows must have the same number of columns -- **No Missing Data:** Empty values should be explicitly marked (e.g., "", "N/A", or NULL) -- **Header Row:** First row must contain clear, descriptive column headers -- **Proper Encoding:** UTF-8 encoding required for special characters - -### 3. Content Standards - -- **No LLM-Generated Content:** Avoid data that LLMs can easily generate (e.g., generic phrases, common knowledge) -- **Specific and Concrete:** Use specific values rather than vague descriptions -- **Verifiable Data:** Data should be factual and verifiable when possible -- **Consistent Formatting:** Date formats, numbers, and text should follow consistent patterns - -### 4. Column Standards - -- **Clear Headers:** Column names must be descriptive and self-explanatory -- **Consistent Data Types:** Each column should contain consistent data types -- **No Unused Columns:** Every column must be referenced and used in the workflow -- **Appropriate Width:** Columns should be reasonably narrow and focused - -### 5. File Size Standards - -- **Efficient Structure:** CSV files should be as small as possible while maintaining functionality -- **No Redundant Rows:** Avoid duplicate or nearly identical rows -- **Compressed Data:** Use efficient data representation (e.g., codes instead of full descriptions) -- **Maximum Size:** Individual CSV files should not exceed 1MB unless absolutely necessary - -### 6. Documentation Standards - -- **Documentation Required:** Each CSV file should have documentation explaining its purpose -- **Column Descriptions:** Each column must be documented with its usage and format -- **Data Sources:** Source of data should be documented when applicable -- **Update Procedures:** Process for updating CSV data should be documented - -### 7. Integration Standards - -- **File References:** CSV files must be properly referenced in workflow configuration -- **Access Patterns:** Workflow must clearly define how and when CSV data is accessed -- **Error Handling:** Workflow must handle cases where CSV files are missing or corrupted -- **Version Control:** CSV files should be versioned when changes occur - -### 8. Quality Assurance - -- **Data Validation:** CSV data should be validated for correctness and completeness -- **Format Consistency:** Consistent formatting across all rows and columns -- **No Ambiguity:** Data entries should be clear and unambiguous -- **Regular Review:** CSV content should be reviewed periodically for relevance - -### 9. Security Considerations - -- **No Sensitive Data:** Avoid including sensitive, personal, or confidential information -- **Data Sanitization:** CSV data should be sanitized for security issues -- **Access Control:** Access to CSV files should be controlled when necessary -- **Audit Trail:** Changes to CSV files should be logged when appropriate - -### 10. Performance Standards - -- **Fast Loading:** CSV files must load quickly within workflow execution -- **Memory Efficient:** Structure should minimize memory usage during processing -- **Optimized Queries:** If data lookup is needed, optimize for efficient access -- **Caching Strategy**: Consider whether data can be cached for performance - -## Implementation Guidelines - -When creating CSV data files for BMAD workflows: - -1. **Start with Purpose:** Clearly define why CSV is needed instead of LLM generation -2. **Design Structure:** Plan columns and data types before creating the file -3. **Test Integration:** Ensure workflow properly accesses and uses CSV data -4. **Document Thoroughly:** Provide complete documentation for future maintenance -5. **Validate Quality:** Check data quality, format consistency, and integration -6. **Monitor Usage:** Track how CSV data is used and optimize as needed - -## Common Anti-Patterns to Avoid - -- **Generic Phrases:** CSV files containing common phrases or LLM-generated content -- **Redundant Data:** Duplicating information easily available to LLMs -- **Overly Complex:** Unnecessarily complex CSV structures when simple data suffices -- **Unused Columns:** Columns that are defined but never referenced in workflows -- **Poor Formatting:** Inconsistent data formats, missing values, or structural issues -- **No Documentation:** CSV files without clear purpose or usage documentation - -## Validation Checklist - -For each CSV file, verify: - -- [ ] Purpose is essential and cannot be replaced by LLM generation -- [ ] All columns are used in the workflow -- [ ] Data is properly formatted and consistent -- [ ] File is efficiently sized and structured -- [ ] Documentation is complete and clear -- [ ] Integration with workflow is tested and working -- [ ] Security considerations are addressed -- [ ] Performance requirements are met diff --git a/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md b/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md deleted file mode 100644 index 51e790de..00000000 --- a/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +++ /dev/null @@ -1,220 +0,0 @@ -# Intent vs Prescriptive Spectrum - -## Core Philosophy - -The **Intent vs Prescriptive Spectrum** is a fundamental design principle for BMAD workflows and agents. It determines how much creative freedom an LLM has versus how strictly it must follow predefined instructions. - -**Key Principle:** The closer workflows stay to **intent**, the more creative and adaptive the LLM experience becomes. The closer they stay to **prescriptive**, the more consistent and controlled the output becomes. - -## Understanding the Spectrum - -### **Intent-Based Design** (Creative Freedom) - -**Focus**: What goal should be achieved -**Approach**: Trust the LLM to determine the best method -**Result**: Creative, adaptive, context-aware interactions -**Best For**: Creative exploration, problem-solving, personalized experiences - -### **Prescriptive Design** (Structured Control) - -**Focus**: Exactly what to say and do -**Approach**: Detailed scripts and specific instructions -**Result**: Consistent, predictable, controlled outcomes -**Best For**: Compliance, safety-critical, standardized processes - -## Spectrum Examples - -### **Highly Intent-Based** (Creative End) - -```markdown -**Example:** Story Exploration Workflow -**Instruction:** "Help the user explore their dream imagery to craft compelling narratives, use multiple turns of conversation to really push users to develop their ideas, giving them hints and ideas also to prime them effectively to bring out their creativity" -**LLM Freedom:** Adapts questions, explores tangents, follows creative inspiration -**Outcome:** Unique, personalized storytelling experiences -``` - -### **Balanced Middle** (Professional Services) - -```markdown -**Example:** Business Strategy Workflow -**Instruction:** "Guide the user through SWOT analysis using your business expertise. when complete tell them 'here is your final report {report output}' -**LLM Freedom:** Professional judgment in analysis, structured but adaptive approach -**Outcome:** Professional, consistent yet tailored business insights -``` - -### **Highly Prescriptive** (Control End) - -```markdown -**Example:** Medical Intake Form -**Instruction:** "Ask exactly: 'Do you currently experience any of the following symptoms: fever, cough, fatigue?' Wait for response, then ask exactly: 'When did these symptoms begin?'" -**LLM Freedom:** Minimal - must follow exact script for medical compliance -**Outcome:** Consistent, medically compliant patient data collection -``` - -## Spectrum Positioning Guide - -### **Choose Intent-Based When:** - -- ✅ Creative exploration and innovation are goals -- ✅ Personalization and adaptation to user context are important -- ✅ Human-like conversation and natural interaction are desired -- ✅ Problem-solving requires flexible thinking -- ✅ User experience and engagement are priorities - -**Examples:** - -- Creative brainstorming sessions -- Personal coaching or mentoring -- Exploratory research and discovery -- Artistic content creation -- Collaborative problem-solving - -### **Choose Prescriptive When:** - -- ✅ Compliance with regulations or standards is required -- ✅ Safety or legal considerations are paramount -- ✅ Exact consistency across multiple sessions is essential -- ✅ Training new users on specific procedures -- ✅ Data collection must follow specific protocols - -**Examples:** - -- Medical intake and symptom assessment -- Legal compliance questionnaires -- Safety checklists and procedures -- Standardized testing protocols -- Regulatory data collection - -### **Choose Balanced When:** - -- ✅ Professional expertise is required but adaptation is beneficial -- ✅ Consistent quality with flexible application is needed -- ✅ Domain expertise should guide but not constrain interactions -- ✅ User trust and professional credibility are important -- ✅ Complex processes require both structure and judgment - -**Examples:** - -- Business consulting and advisory -- Technical support and troubleshooting -- Educational tutoring and instruction -- Financial planning and advice -- Project management facilitation - -## Implementation Guidelines - -### **For Workflow Designers:** - -1. **Early Spectrum Decision**: Determine spectrum position during initial design -2. **User Education**: Explain spectrum choice and its implications to users -3. **Consistent Application**: Maintain chosen spectrum throughout workflow -4. **Context Awareness**: Adjust spectrum based on specific use case requirements - -### **For Workflow Implementation:** - -**Intent-Based Patterns:** - -```markdown -- "Help the user understand..." (vs "Explain that...") -- "Guide the user through..." (vs "Follow these steps...") -- "Use your professional judgment to..." (vs "Apply this specific method...") -- "Adapt your approach based on..." (vs "Regardless of situation, always...") -``` - -**Prescriptive Patterns:** - -```markdown -- "Say exactly: '...'" (vs "Communicate that...") -- "Follow this script precisely: ..." (vs "Cover these points...") -- "Do not deviate from: ..." (vs "Consider these options...") -- "Must ask in this order: ..." (vs "Ensure you cover...") -``` - -### **For Agents:** - -**Intent-Based Agent Design:** - -```yaml -persona: - communication_style: 'Adaptive professional who adjusts approach based on user context' - guiding_principles: - - 'Use creative problem-solving within professional boundaries' - - 'Personalize approach while maintaining expertise' - - 'Adapt conversation flow to user needs' -``` - -**Prescriptive Agent Design:** - -```yaml -persona: - communication_style: 'Follows standardized protocols exactly' - governing_rules: - - 'Must use approved scripts without deviation' - - 'Follow sequence precisely as defined' - - 'No adaptation of prescribed procedures' -``` - -## Spectrum Calibration Questions - -**Ask these during workflow design:** - -1. **Consequence of Variation**: What happens if the LLM says something different? -2. **User Expectation**: Does the user expect consistency or creativity? -3. **Risk Level**: What are the risks of creative deviation vs. rigid adherence? -4. **Expertise Required**: Is domain expertise application more important than consistency? -5. **Regulatory Requirements**: Are there external compliance requirements? - -## Best Practices - -### **DO:** - -- ✅ Make conscious spectrum decisions during design -- ✅ Explain spectrum choices to users -- ✅ Use intent-based design for creative and adaptive experiences -- ✅ Use prescriptive design for compliance and consistency requirements -- ✅ Consider balanced approaches for professional services -- ✅ Document spectrum rationale for future reference - -### **DON'T:** - -- ❌ Mix spectrum approaches inconsistently within workflows -- ❌ Default to prescriptive when intent-based would be more effective -- ❌ Use creative freedom when compliance is required -- ❌ Forget to consider user expectations and experience -- ❌ Overlook risk assessment in spectrum selection - -## Quality Assurance - -**When validating workflows:** - -- Check if spectrum position is intentional and consistent -- Verify prescriptive elements are necessary and justified -- Ensure intent-based elements have sufficient guidance -- Confirm spectrum alignment with user needs and expectations -- Validate that risks are appropriately managed - -## Examples in Practice - -### **Medical Intake (Highly Prescriptive):** - -- **Why**: Patient safety, regulatory compliance, consistent data collection -- **Implementation**: Exact questions, specific order, no deviation permitted -- **Benefit**: Reliable, medically compliant patient information - -### **Creative Writing Workshop (Highly Intent):** - -- **Why**: Creative exploration, personalized inspiration, artistic expression -- **Implementation**: Goal guidance, creative freedom, adaptive prompts -- **Benefit**: Unique, personalized creative works - -### **Business Strategy (Balanced):** - -- **Why**: Professional expertise with adaptive application -- **Implementation**: Structured framework with professional judgment -- **Benefit**: Professional, consistent yet tailored business insights - -## Conclusion - -The Intent vs Prescriptive Spectrum is not about good vs. bad - it's about **appropriate design choices**. The best workflows make conscious decisions about where they fall on this spectrum based on their specific requirements, user needs, and risk considerations. - -**Key Success Factor**: Choose your spectrum position intentionally, implement it consistently, and align it with your specific use case requirements. diff --git a/src/modules/bmb/docs/workflows/step-file-rules.md b/src/modules/bmb/docs/workflows/step-file-rules.md deleted file mode 100644 index 56e58899..00000000 --- a/src/modules/bmb/docs/workflows/step-file-rules.md +++ /dev/null @@ -1,469 +0,0 @@ -# BMAD Step File Guidelines - -**Version:** 1.0 -**Module:** bmb (BMAD Builder) -**Purpose:** Definitive guide for creating BMAD workflow step files - ---- - -## Overview - -BMAD workflow step files follow a strict structure to ensure consistency, progressive disclosure, and mode-aware routing. Every step file MUST adhere to these guidelines. - ---- - -## File Size Optimization - -**CRITICAL:** Keep step files **LT 200 lines** (250 lines absolute maximum). - -If a step exceeds this limit: -- Consider splitting into multiple steps -- Extract content to `/data/` reference files -- Optimize verbose explanations - ---- - -## Required Frontmatter Structure - -CRITICAL: Frontmatter should only have items that are used in the step file! - -```yaml ---- -name: 'step-2-foo.md' -description: 'Brief description of what this step accomplishes' - -# File References ## CRITICAL: Frontmatter references or variables should only have items that are used in the step file! -outputFile: {bmb_creations_output_folder}/output-file-name.md -nextStepFile: './step-3-bar.md' - -# Task References (as needed) -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# ... other task-specific references ---- -``` - -### Frontmatter Field Descriptions - -| Field | Required | Description | -| --------------- | --------- | --------------------------------- | -| `name` | Yes | Step identifier (kebab-case) | -| `description` | Yes | One-line summary of step purpose | -| `outputFile` | Yes | Where results are documented | -| Task references | As needed | Paths to external workflows/tasks | - ---- - -## Document Structure - -### 1. Title - -```markdown -# Step X: [Step Name] -``` - -### 2. STEP GOAL - -```markdown -## STEP GOAL: - -[Single sentence stating what this step accomplishes] -``` - -### 3. Role Reinforcement - -```markdown -### Role Reinforcement: - -- ✅ You are a [specific role] who [does what] -- ✅ 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], together we [achieve goal] -- ✅ Maintain [tone/approach] throughout -``` - -### 4. Language Preference - -```markdown -### Language Preference: -The user has chosen to communicate in the **{language}** language. -You MUST respond in **{language}** throughout this step. -``` - -**IMPORTANT:** Read `userPreferences.language` from tracking file (agentPlan, validationReport, etc.) and enforce it. - -### 5. Step-Specific Rules - -```markdown -### Step-Specific Rules: - -- 🎯 Focus only on [specific scope] -- 🚫 FORBIDDEN to [prohibited action] -- 💬 Approach: [how to engage] -- 📋 Ensure [specific outcome] -``` - -### 6. EXECUTION PROTOCOLS - -```markdown -## EXECUTION PROTOCOLS: - -- [What to do - use verbs] -- [Another action] -- 🚫 FORBIDDEN to [prohibited action] -``` - -### 7. CONTEXT BOUNDARIES - -```markdown -## CONTEXT BOUNDARIES: - -- Available context: [what's available] -- Focus: [what to focus on] -- Limits: [boundaries] -- Dependencies: [what this step depends on] -``` - -### 8. Sequence of Instructions - -```markdown -## Sequence of Instructions: - -### 1. [First Action] - -**[Action Description]** - -### 2. [Second Action] - -... -``` - -### 9. MENU OPTIONS - -```markdown -### X. Present MENU OPTIONS - -Display: "**Select:** [A] [menu item A] [P] [menu item P] [C] [menu item C]" - -#### Menu Handling Logic: -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#x-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 - -## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [completion conditions], will you then load and read fully `{nextStepFile}`... -``` - -### 10. SYSTEM SUCCESS/FAILURE METRICS - -```markdown -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: -- [Success criterion 1] -- [Success criterion 2] -- ... - -### ❌ SYSTEM FAILURE: -- [Failure criterion 1] -- [Failure criterion 2] -- ... - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. -``` - ---- - -## A/P/C Menu Convention - -BMAD workflows use a fixed menu structure: - -| Option | Meaning | Behavior | -| ------ | -------------------- | ---------------------------------------------------- | -| **A** | Advanced Elicitation | Execute advancedElicitationTask, then redisplay menu | -| **P** | Party Mode | Execute partyModeWorkflow, then redisplay menu | -| **C** | Continue/Accept | Save output, update frontmatter, load nextStepFile | -| Other | Custom | Defined per step (e.g., F = Fix, X = Exit) | - -**Rules:** -- A and P MUST always be present -- C MUST be present except in final step (use X or similar for exit) -- After A/P → redisplay menu -- After C → proceed to next step -- Custom letters can be used for step-specific options - ---- - -## Progressive Disclosure - -**Core Principle:** Each step only knows about its immediate next step. - -### Implementation - -1. **Never pre-load future steps** - Only load `nextStepFile` when user selects [C] - -2. **Mode-aware routing** (for shared steps): - ```markdown - ## MODE-AWARE ROUTING: - ### If entered from CREATE mode: - Load ./s-next-step.md - - ### If entered from EDIT mode: - Load ./e-next-step.md - - ### If entered from VALIDATE mode: - Load ./v-next-step.md - ``` - -3. **Read tracking file first** - Always read the tracking file (agentPlan, validationReport, etc.) to determine current mode and routing - ---- - -## Mode-Aware Routing (Shared Steps) - -Shared steps (`s-*.md`) must route based on the mode stored in the tracking file. - -### Tracking File Frontmatter - -```yaml ---- -mode: create # or edit | validate -stepsCompleted: - - c-01-brainstorm.md - - s-01-discovery.md -# ... other tracking fields ---- -``` - -### Routing Implementation - -```markdown -## COMPLETION ROUTING: - -1. Append `./this-step-name.md` to {trackingFile}.stepsCompleted -2. Save content to {trackingFile} -3. Read {trackingFile}.mode -4. Route based on mode: - -### IF mode == create: -Load ./s-next-create-step.md - -### IF mode == edit: -Load ./e-next-edit-step.md - -### IF mode == validate: -Load ./s-next-validate-step.md -``` - ---- - -## File Naming Conventions - -### Tri-Modal Workflows - -| Prefix | Meaning | Example | -| ------ | ------------------ | ---------------------- | -| `c-` | Create-specific | `c-01-brainstorm.md` | -| `e-` | Edit-specific | `e-01-load-analyze.md` | -| `v-` | Validate-specific | `v-01-load-review.md` | -| `s-` | Shared by 2+ modes | `s-05-activation.md` | - -### Numbering - -- Within each prefix type, number sequentially -- Restart numbering for each prefix type (c-01, e-01, v-01, s-01) -- Use letters for sub-steps (s-06a, s-06b, s-06c) - ---- - -## Language Preference Enforcement - -**CRITICAL:** Every step MUST respect the user's chosen language. - -### Implementation - -```markdown -### Language Preference: -The user has chosen to communicate in the **{language}** language. -You MUST respond in **{language}** throughout this step. -``` - -### Reading Language Preference - -From tracking file frontmatter: -```yaml ---- -userPreferences: - language: spanish # or any language ---- -``` - -### Rules - -- **MUST** read language preference from tracking file at step start -- **MUST** respond in user's chosen language for ALL content -- **MUST** include menu options in user's chosen language -- **EXCEPTION:** Technical terms, file names, and code remain in English - ---- - -## Data File References - -When step content becomes too large (>200 lines), extract to `/data/` files: - -### When to Extract - -- Step file exceeds 200 lines -- Content is reference material (rules, examples, patterns) -- Content is reused across multiple steps - -### How to Reference - -```markdown -## Reference Material: - -Load and reference: `../data/{data-file-name}.md` - -Key points from that file: -- [Point 1] -- [Point 2] -``` - -### Data File Best Practices - -- Keep data files focused on single topic -- Use clear, descriptive names -- Include examples and non-examples -- Optimize for LLM usage (concise, structured) - ---- - -## Common Pitfalls to Avoid - -### ❌ DON'T: - -- Pre-load future steps (violates progressive disclosure) -- Exceed 250 lines without splitting -- Forget to update `stepsCompleted` array -- Ignore user's language preference -- Skip mode checking in shared steps -- Use vague menu option letters (stick to A/P/C plus 1-2 custom) - -### ✅ DO: - -- Keep files under 200 lines -- Read tracking file first thing -- Route based on `mode` field -- Include A/P in every menu -- Use descriptive step names -- Extract complex content to data files - ---- - -## Template: New Step File - -```markdown ---- -name: 'step-name' -description: 'What this step does' - -# File References -thisStepFile: ./step-name.md -workflowFile: ../workflow.md -outputFile: {bmb_creations_output_folder}/output.md - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step X: [Step Name] - -## STEP GOAL: - -[Single sentence goal] - -### Role Reinforcement: - -- ✅ You are a [role] who [does what] -- ✅ 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 [expertise], user brings [expertise], together we [achieve] -- ✅ Maintain [tone] throughout - -### Language Preference: -The user has chosen to communicate in the **{language}** language. -You MUST respond in **{language}** throughout this step. - -### Step-Specific Rules: - -- 🎯 Focus only on [scope] -- 🚫 FORBIDDEN to [prohibited action] -- 💬 Approach: [how to engage] -- 📋 Ensure [outcome] - -## EXECUTION PROTOCOLS: - -- [Action 1] -- [Action 2] -- 🚫 FORBIDDEN to [prohibited action] - -## CONTEXT BOUNDARIES: - -- Available context: [what's available] -- Focus: [what to focus on] -- Limits: [boundaries] -- Dependencies: [what depends on what] - -## Sequence of Instructions: - -### 1. [First Action] - -**Description of first action** - -### 2. [Second Action] - -**Description of second action** - -... - -### X. Present MENU OPTIONS - -Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#x-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 - -## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [conditions], will you then load and read fully `{nextStepFile}`... - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: -- [Success criteria] - -### ❌ SYSTEM FAILURE: -- [Failure criteria] - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. -``` - ---- - -**End of Guidelines** diff --git a/src/modules/bmb/docs/workflows/templates/step-file.md b/src/modules/bmb/docs/workflows/templates/step-file.md deleted file mode 100644 index d9b14704..00000000 --- a/src/modules/bmb/docs/workflows/templates/step-file.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -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. diff --git a/src/modules/bmb/docs/workflows/templates/workflow.md b/src/modules/bmb/docs/workflows/templates/workflow.md deleted file mode 100644 index 65a8eb26..00000000 --- a/src/modules/bmb/docs/workflows/templates/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: { { workflowDisplayName } } -description: { { workflowDescription } } -web_bundle: { { webBundleFlag } } ---- - -# {{workflowDisplayName}} - -**Goal:** {{workflowGoal}} - -**Your Role:** In addition to your name, communication_style, and persona, you are also a {{aiRole}} collaborating with {{userType}}. This is a partnership, not a client-vendor relationship. You bring {{aiExpertise}}, while the user brings {{userExpertise}}. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/{{targetModule}}/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/docs/workflows/terms.md b/src/modules/bmb/docs/workflows/terms.md deleted file mode 100644 index 71477ede..00000000 --- a/src/modules/bmb/docs/workflows/terms.md +++ /dev/null @@ -1,97 +0,0 @@ -# BMAD Workflow Terms - -## Core Components - -### BMAD Workflow - -A facilitated, guided process where the AI acts as a facilitator working collaboratively with a human. Workflows can serve any purpose - from document creation to brainstorming, technical implementation, or decision-making. The human may be a collaborative partner, beginner seeking guidance, or someone who wants the AI to execute specific tasks. Each workflow is self-contained and follows a disciplined execution model. - -### workflow.md - -The master control file that defines: - -- Workflow metadata (name, description, version) -- Step sequence and file paths -- Required data files and dependencies -- Execution rules and protocols - -### Step File - -An individual markdown file containing: - -- One discrete step of the workflow -- All rules and context needed for that step -- common global rules get repeated and reinforced also in each step file, ensuring even in long workflows the agent remembers important rules and guidelines -- Content generation guidance - -### step-01-init.md - -The first step file that: - -- Initializes the workflow -- Sets up document frontmatter -- Establishes initial context -- Defines workflow parameters - -### step-01b-continue.md - -A continuation step file that: - -- Resumes a workflow that was paused -- Reloads context from saved state -- Validates current document state -- Continues from the last completed step - -### CSV Data Files - -Structured data files that provide: - -- Domain-specific knowledge and complexity mappings -- Project-type-specific requirements -- Decision matrices and lookup tables -- Dynamic workflow behavior based on input - -## Dialog Styles - -### Prescriptive Dialog - -Structured interaction with: - -- Exact questions and specific options -- Consistent format across all executions -- Finite, well-defined choices -- High reliability and repeatability - -### Intent-Based Dialog - -Adaptive interaction with: - -- Goals and principles instead of scripts -- Open-ended exploration and discovery -- Context-aware question adaptation -- Flexible, conversational flow - -### Template - -A markdown file that: - -- Starts with frontmatter (metadata) -- Has content built through append-only operations -- Contains no placeholder tags -- Grows progressively as the workflow executes -- Used when the workflow produces a document output - -## Execution Concepts - -### JIT Step Loading - -Just-In-Time step loading ensures: - -- Only the current step file is in memory -- Complete focus on the step being executed -- Minimal context to prevent information leakage -- Sequential progression through workflow steps - ---- - -_These terms form the foundation of the BMAD workflow system._ diff --git a/src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md b/src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md index 7a7c6bac..eb739d3c 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md @@ -46,7 +46,9 @@ Optional creative exploration to generate agent ideas through structured brainst - Limits: No mandatory brainstorming, no pressure tactics - Dependencies: User choice to participate or skip brainstorming -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Present Brainstorming Opportunity diff --git a/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md b/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md index 57ca7af6..26d5e4e1 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md @@ -108,7 +108,9 @@ After documentation, present menu: - Clear articulation of value proposition - Comprehensive capability mapping -# EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. **Load Previous Context** - Check for brainstormContext file diff --git a/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md b/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md index 34f58f30..b9ddd416 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md @@ -125,7 +125,9 @@ Present structured options: --- -# INSTRUCTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ## 1. Load Documentation Read and internalize: diff --git a/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md b/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md index 2c81b6db..0e45d060 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md @@ -156,7 +156,9 @@ principles: - Workflow steps (belongs in orchestration) - Data structures (belongs in implementation) -# EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. **LOAD** personaProperties.md and principlesCrafting.md 2. **EXPLAIN** four-field system with clear examples diff --git a/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md b/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md index c5793515..7d4c8c81 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md @@ -121,7 +121,9 @@ menu: - **User-facing perspective** - triggers should feel natural - **Capability alignment** - every command maps to a capability -# EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. Load agent-menu-patterns.md to understand structure 2. Review capabilities from agent-plan step 3 diff --git a/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md b/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md index 6d2bf0ec..864b7d54 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md @@ -129,7 +129,9 @@ routing: - Expert agents: Sidecar + stand-alone module - Module agents: Sidecar + parent module integration -# EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ## 1. Load Reference Documents ```bash diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md b/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md index 812fa40b..5957a67e 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md @@ -60,7 +60,9 @@ Assemble the agent plan content into a Simple agent YAML configuration using the - Template placeholders (replace with actual content) - Comments or notes in final YAML -## EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Template and Architecture Files diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md b/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md index bc1989b7..15c98272 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md @@ -128,7 +128,9 @@ If YOLO mode: - Fix option should return to step-06-build, not earlier steps - If plan file is ambiguous, note ambiguity but use reasonable interpretation -# SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ## 1. Load Required Files ```yaml diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md index 3fcec5a5..94ff4d45 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md @@ -80,7 +80,9 @@ Validate the built agent YAML file for structural completeness and correctness a - YAML syntax errors preventing file parsing - Path references that don't exist -# EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ## 1. Load Validation Context diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md index 2ffcdaed..30ab330c 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md @@ -78,7 +78,9 @@ Validate the sidecar folder structure and referenced paths for Expert agents to - Path references pointing to non-existent files - Empty sidecar files that should have content -# EXECUTION SEQUENCE +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ## 1. Load Sidecar Context diff --git a/src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md b/src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md index 794766cc..25541e72 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md @@ -59,7 +59,9 @@ Celebrate the successful agent creation, recap the agent's capabilities, provide - Limits: No agent modifications, only installation guidance and celebration - Dependencies: Complete agent ready for installation -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. (Do not deviate, skip, or optimize) ### 1. Grand Celebration diff --git a/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md b/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md index 187e1e1f..ae4b4227 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md @@ -59,7 +59,9 @@ Load the existing agent file, parse its structure, and create an edit plan track - Limits: Analysis only, no modifications - Dependencies: Agent file must exist and be valid YAML -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Agent File diff --git a/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md b/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md index cdc50aef..ba82cee3 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md @@ -54,7 +54,9 @@ Conduct targeted discovery to understand exactly what the user wants to change a - Limits: Discovery and documentation only, no implementation - Dependencies: Agent must be loaded in editPlan -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Read Edit Plan Context diff --git a/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md b/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md new file mode 100644 index 00000000..5edd9caf --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md @@ -0,0 +1 @@ +# Placeholder - do not load this step. \ No newline at end of file diff --git a/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md b/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md index d7d37a52..eed424ea 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md @@ -36,7 +36,9 @@ Review the agent's type and metadata, and plan any changes. If edits involve typ - 💾 Document planned metadata changes - 🚫 FORBIDDEN to proceed without documenting changes -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md b/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md index 32b3cda7..df3b7378 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md @@ -37,7 +37,9 @@ Review the agent's persona and plan any changes using the four-field persona sys - 💾 Document planned persona changes - 🚫 FORBIDDEN to proceed without documenting changes -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md b/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md index 37bad720..a647dc52 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md @@ -35,7 +35,9 @@ Review the agent's command menu and plan any additions, modifications, or remova - 💾 Document planned command changes - 🚫 FORBIDDEN to proceed without documenting changes -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md b/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md index bd071a92..71b0b1d9 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md @@ -39,7 +39,9 @@ Review critical_actions and route to the appropriate type-specific edit step (Si - 💾 Route to appropriate type-specific edit step - ➡️ Auto-advance to type-specific edit on [C] -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md b/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md index d92bb27e..c7e66868 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md @@ -47,7 +47,9 @@ Apply all planned edits to the Simple agent YAML file using templates and archit - ✅ Validate YAML syntax - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md b/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md index 394ccdb3..662a1f2f 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md @@ -48,7 +48,9 @@ Apply all planned edits to the Expert agent YAML file and manage sidecar structu - ✅ Validate YAML and sidecar paths - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md b/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md index 035a4228..25317322 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md @@ -48,7 +48,9 @@ Apply all planned edits to the Module agent YAML file and manage workflow integr - ✅ Validate YAML and workflow paths - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Reference Documents diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md b/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md index 730c43c0..bf7bd6eb 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md @@ -26,9 +26,9 @@ Validate that the agent's metadata properties (id, name, title, icon, module, ha - **🚫 NO MENU in this step** - record findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -## EXECUTION PROTOCOLS +## MANDATORY SEQUENCE -### Protocol 1: Load and Compare +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. Read the metadata validation reference from `{agentMetadata}` 2. Read the built agent YAML from `{builtYaml}` 3. Read the edit plan from `{editPlan}` diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md b/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md index b74e691a..531f434a 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md @@ -28,9 +28,9 @@ Validate that the agent's persona (role, identity, communication_style, principl - **🚫 NO MENU in this step** - record findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -## EXECUTION PROTOCOLS +## MANDATORY SEQUENCE -### Protocol 1: Load and Compare +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. Read the persona validation reference from `{personaProperties}` 2. Read the principles crafting guide from `{principlesCrafting}` 3. Read the built agent YAML from `{builtYaml}` diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md b/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md index 2d627517..f46863b1 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md @@ -27,9 +27,9 @@ Validate that the agent's menu (commands/tools) follows BMAD patterns as defined - **🚫 NO MENU in this step** - record findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -## EXECUTION PROTOCOLS +## MANDATORY SEQUENCE -### Protocol 1: Load and Compare +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. Read the menu patterns reference from `{agentMenuPatterns}` 2. Read the built agent YAML from `{builtYaml}` 3. Read the edit plan from `{editPlan}` diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md b/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md index 74893d1a..bdb7757e 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md @@ -30,9 +30,9 @@ Validate the built agent YAML file for structural completeness and correctness a - **🚫 NO MENU in this step** - record findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -## EXECUTION PROTOCOLS +## MANDATORY SEQUENCE -### Protocol 1: Load and Compare +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. Read the agent compilation reference from `{agentCompilation}` 2. Read the simple validation checklist from `{simpleValidation}` 3. Read the expert validation checklist from `{expertValidation}` diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md b/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md index 7bb150fb..37c015bf 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md @@ -31,9 +31,9 @@ Validate the sidecar folder structure and referenced paths for Expert agents to - **🚫 NO MENU in this step** - record findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -## EXECUTION PROTOCOLS +## MANDATORY SEQUENCE -### Protocol 1: Load and Compare +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. 1. Read the expert validation reference from `{expertValidation}` 2. Read the critical actions reference from `{criticalActions}` 3. Read the built agent YAML from `{builtYaml}` diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md b/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md index dfbba1d2..223040b7 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md @@ -33,7 +33,9 @@ Display all post-edit validation findings and compare with pre-edit state. Prese - 📊 Display organized summary with before/after comparison - 💾 Allow user to decide how to proceed -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Validation Findings diff --git a/src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md b/src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md index 5486e16a..0ef0b983 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md @@ -48,7 +48,9 @@ Celebrate the successful agent edit, provide summary of changes, and mark edit w - Limits: No more edits, only acknowledgment - Dependencies: All edits successfully applied -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.: ### 1. Read Edit Plan diff --git a/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md b/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md index f1ba0e5e..2dc6e33a 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md @@ -34,7 +34,9 @@ Load the existing agent file and initialize a validation report to track all fin - 💾 Create validation report document - 🚫 FORBIDDEN to proceed without user confirmation -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Agent File diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md b/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md index dbf14996..381460fc 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md @@ -36,7 +36,9 @@ Validate the agent's metadata properties against BMAD standards as defined in ag - 💾 Append findings to validation report - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load References diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md b/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md index 7095c9cf..75629b6b 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md @@ -37,7 +37,9 @@ Validate the agent's persona against BMAD standards as defined in personaPropert - 💾 Append findings to validation report - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load References diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md b/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md index de0a74aa..1edbc616 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md @@ -36,7 +36,9 @@ Validate the agent's command menu structure against BMAD standards as defined in - 💾 Append findings to validation report - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load References diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md b/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md index f4707e54..636778c6 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md @@ -38,7 +38,9 @@ Validate the agent's YAML structure and completeness against BMAD standards as d - 💾 Append findings to validation report - ➡️ Auto-advance to next validation step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load References diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md b/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md index 18fc5a7b..5f74ce2a 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md @@ -38,7 +38,9 @@ Validate the agent's sidecar structure (if Expert type) against BMAD standards a - 💾 Append findings to validation report - ➡️ Auto-advance to summary step -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load References diff --git a/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md b/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md index 88666e91..5db18a83 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md @@ -32,7 +32,9 @@ Display the complete validation report to the user and offer options for fixing - 📊 Display organized summary - 💾 Allow user to decide next steps -## Sequence of Instructions: +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Load Validation Report diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md b/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md deleted file mode 100644 index a888d215..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -name: 'step-01-init' -description: 'Initialize workflow creation session by gathering project information and setting up unique workflow folder' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-gather.md' -workflowFile: '{workflow_path}/workflow.md' - -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' -# Template References -# No workflow plan template needed - will create plan file directly ---- - -# Step 1: Workflow Creation Initialization - -## STEP GOAL: - -To initialize the workflow creation process by understanding project context, determining a unique workflow name, and preparing for collaborative workflow design. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ 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 design expertise, user brings their specific requirements -- ✅ Together we will create a structured, repeatable workflow - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization and project understanding -- 🚫 FORBIDDEN to start designing workflow steps in this step -- 💬 Ask questions conversationally to understand context -- 🚪 ENSURE unique workflow naming to avoid conflicts - -## EXECUTION PROTOCOLS: - -- 🎯 Show analysis before taking any action -- 💾 Initialize document and update frontmatter -- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until initialization is complete - -## CONTEXT BOUNDARIES: - -- Variables from workflow.md are available in memory -- Previous context = what's in output document + frontmatter -- Don't assume knowledge from other steps -- Input discovery happens in this step - -## INITIALIZATION SEQUENCE: - -### 1. Project Discovery - -Welcome the user and understand their needs: -"Welcome! I'm excited to help you create a new workflow. Let's start by understanding what you want to build." - -Ask conversationally: - -- What type of workflow are you looking to create? -- What problem will this workflow solve? -- Who will use this workflow? -- What module will it belong to (bmb, bmm, cis, custom, stand-alone)? - -Also, Ask / suggest a workflow name / folder: (kebab-case, e.g., "user-story-generator") - -### 2. Ensure Unique Workflow Name - -After getting the workflow name: - -**Check for existing workflows:** - -- Look for folder at `{bmb_creations_output_folder}/workflows/{new_workflow_name}/` -- If it exists, inform the user and suggest or get from them a unique name or postfix - -**Example alternatives:** - -- Original: "user-story-generator" -- Alternatives: "user-story-creator", "user-story-generator-2025", "user-story-generator-enhanced" - -**Loop until we have a unique name that doesn't conflict.** - -### 3. Determine Target Location - -Based on the module selection, confirm the target location: - -- For bmb module: `{custom_workflow_location}` (defaults to `_bmad/custom/src/workflows`) -- For other modules: Check their module.yaml for custom workflow locations -- Confirm the exact folder path where the workflow will be created -- Store the confirmed path as `{targetWorkflowPath}` - -### 4. Create Workflow Plan Document - -Create the workflow plan document at `{workflowPlanFile}` with the following initial content: - -```markdown ---- -stepsCompleted: [1] ---- - -# Workflow Creation Plan: {new_workflow_name} - -## Initial Project Context - -- **Module:** [module from user] -- **Target Location:** {targetWorkflowPath} -- **Created:** [current date] -``` - -This plan will capture all requirements and design details before building the actual workflow. - -### 5. Present MENU OPTIONS - -Display: **Proceeding to requirements gathering...** - -#### EXECUTION RULES: - -- This is an initialization step with no user choices -- Proceed directly to next step after setup -- Use menu handling logic section below - -#### Menu Handling Logic: - -- After setup completion and the workflow folder with the workflow plan file created already, only then immediately load, read entire file, and then execute `{workflow_path}/steps/step-02-gather.md` to begin requirements gathering - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Workflow name confirmed and validated -- Target folder location determined -- User welcomed and project context understood -- Ready to proceed to step 2 - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without workflow name -- Not checking for existing workflow folders -- Not determining target location properly -- Skipping welcome message - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md b/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md deleted file mode 100644 index 5ef645d7..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -name: 'step-02-gather' -description: 'Gather comprehensive requirements for the workflow being created' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-gather.md' -nextStepFile: '{workflow_path}/steps/step-03-tools-configuration.md' -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append requirements directly to workflow plan ---- - -# Step 2: Requirements Gathering - -## STEP GOAL: - -To gather comprehensive requirements through collaborative conversation that will inform the design of a structured workflow tailored to the user's needs and use case. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ 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 design expertise and best practices -- ✅ User brings their domain knowledge and specific requirements - -### Step-Specific Rules: - -- 🎯 Focus ONLY on collecting requirements and understanding needs -- 🚫 FORBIDDEN to propose workflow solutions or step designs in this step -- 💬 Ask questions conversationally, not like a form -- 🚫 DO NOT skip any requirement area - each affects workflow design - -## EXECUTION PROTOCOLS: - -- 🎯 Engage in natural conversation to gather requirements -- 💾 Store all requirements information for workflow design -- 📖 Proceed to next step with 'C' selection -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Workflow name and target location from initialization -- Focus ONLY on collecting requirements and understanding needs -- Don't provide workflow designs in this step -- This is about understanding, not designing - -## REQUIREMENTS GATHERING PROCESS: - -### 1. Workflow Purpose and Scope - -Explore through conversation: - -- What specific problem will this workflow solve? -- Who is the primary user of this workflow? -- What is the main outcome or deliverable? - -### 2. Workflow Type Classification - -Help determine the workflow type: - -- **Document Workflow**: Generates documents (PRDs, specs, plans) -- **Action Workflow**: Performs actions (refactoring, tools orchestration) -- **Interactive Workflow**: Guided sessions (brainstorming, coaching, training, practice) -- **Autonomous Workflow**: Runs without human input (batch processing, multi-step tasks) -- **Meta-Workflow**: Coordinates other workflows - -### 3. Workflow Flow and Step Structure - -Let's load some examples to help you decide the workflow pattern: - -Load and reference the Meal Prep & Nutrition Plan workflow as an example: - -``` -Read: {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md -``` - -This shows a linear workflow structure. Now let's explore your desired pattern: - -- Should this be a linear workflow (step 1 → step 2 → step 3 → finish)? -- Or should it have loops/repeats (e.g., keep generating items until user says done)? -- Are there branching points based on user choices? -- Should some steps be optional? -- How many logical phases does this workflow need? (e.g., Gather → Design → Validate → Generate) - -**Based on our reference examples:** - -- **Linear**: Like Meal Prep Plan (Init → Profile → Assessment → Strategy → Shopping → Prep) - - See: `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/` -- **Looping**: User Story Generator (Generate → Review → Refine → Generate more... until done) -- **Branching**: Architecture Decision (Analyze → Choose pattern → Implement based on choice) -- **Iterative**: Document Review (Load → Analyze → Suggest changes → Implement → Repeat until approved) - -### 4. User Interaction Style - -Understand the desired interaction level: - -- How much user input is needed during execution? -- Should it be highly collaborative or mostly autonomous? -- Are there specific decision points where user must choose? -- Should the workflow adapt to user responses? - -### 5. Instruction Style (Intent-Based vs Prescriptive) - -Determine how the AI should execute in this workflow: - -**Intent-Based (Recommended for most workflows)**: - -- Steps describe goals and principles, letting the AI adapt conversation naturally -- More flexible, conversational, responsive to user context -- Example: "Guide user to define their requirements through open-ended discussion" - -**Prescriptive**: - -- Steps provide exact instructions and specific text to use -- More controlled, predictable, consistent across runs -- Example: "Ask: 'What is your primary goal? Choose from: A) Growth B) Efficiency C) Quality'" - -Which style does this workflow need, or should it be a mix of both? - -### 6. Input Requirements - -Identify what the workflow needs: - -- What documents or data does the workflow need to start? -- Are there prerequisites or dependencies? -- Will users need to provide specific information? -- Are there optional inputs that enhance the workflow? - -### 7. Output Specifications - -Define what the workflow produces: - -- What is the primary output (document, action, decision)? -- Are there intermediate outputs or checkpoints? -- Should outputs be saved automatically? -- What format should outputs be in? - -### 8. Success Criteria - -Define what makes the workflow successful: - -- How will you know the workflow achieved its goal? -- What are the quality criteria for outputs? -- Are there measurable outcomes? -- What would make a user satisfied with the result? - -#### STORE REQUIREMENTS: - -After collecting all requirements, append them to {workflowPlanFile} in a format that will be be used later to design in more detail and create the workflow structure. - -### 9. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Append requirements to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and requirements are stored in the output file, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow structure design step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Requirements collected through conversation (not interrogation) -- All workflow aspects documented -- Requirements stored using template -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Generating workflow designs without requirements -- Skipping requirement areas -- Proceeding to next step without 'C' selection -- Not storing requirements properly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md b/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md deleted file mode 100644 index c58d2581..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -name: 'step-03-tools-configuration' -description: 'Configure all required tools (core, memory, external) and installation requirements in one comprehensive step' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-tools-configuration.md' -nextStepFile: '{workflow_path}/steps/step-04-plan-review.md' - -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Documentation References -commonToolsCsv: '{project-root}/_bmad/bmb/docs/workflows/common-workflow-tools.csv' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append tools configuration directly to workflow plan ---- - -# Step 3: Tools Configuration - -## STEP GOAL: - -To comprehensively configure all tools needed for the workflow (core tools, memory, external tools) and determine installation requirements. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and integration 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 expertise in BMAD tools and integration patterns -- ✅ User brings their workflow requirements and preferences - -### Step-Specific Rules: - -- 🎯 Focus ONLY on configuring tools based on workflow requirements -- 🚫 FORBIDDEN to skip tool categories - each affects workflow design -- 💬 Present options clearly, let user make informed choices -- 🚫 DO NOT hardcode tool descriptions - reference CSV - -## EXECUTION PROTOCOLS: - -- 🎯 Load tools dynamically from CSV, not hardcoded -- 💾 Document all tool choices in workflow plan -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Requirements from step 2 inform tool selection -- All tool choices affect workflow design -- This is the ONLY tools configuration step -- Installation requirements affect implementation decisions - -## TOOLS CONFIGURATION PROCESS: - -### 1. Initialize Tools Configuration - -"Configuring **Tools and Integrations** - -Based on your workflow requirements, let's configure all the tools your workflow will need. This includes core BMAD tools, memory systems, and any external integrations." - -### 2. Load and Present Available Tools - -Load `{commonToolsCsv}` and present tools by category: - -"**Available BMAD Tools and Integrations:** - -**Core Tools (Always Available):** - -- [List tools from CSV where propose='always', with descriptions] - -**Optional Tools (Available When Needed):** - -- [List tools from CSV where propose='example', with descriptions] - -_Note: I'm loading these dynamically from our tools database to ensure you have the most current options._" - -### 3. Configure Core BMAD Tools - -"**Core BMAD Tools Configuration:** - -These tools significantly enhance workflow quality and user experience:" - -For each core tool from CSV (`propose='always'`): - -1. **Party-Mode** - - Use case: [description from CSV] - - Where to integrate: [ask user for decision points, creative phases] - -2. **Advanced Elicitation** - - Use case: [description from CSV] - - Where to integrate: [ask user for quality gates, review points] - -3. **Brainstorming** - - Use case: [description from CSV] - - Where to integrate: [ask user for idea generation, innovation points] - -### 4. Configure LLM Features - -"**LLM Feature Integration:** - -These capabilities enhance what your workflow can do:" - -From CSV (`propose='always'` LLM features): - -4. **Web-Browsing** - - Capability: [description from CSV] - - When needed: [ask user about real-time data needs] - -5. **File I/O** - - Capability: [description from CSV] - - Operations: [ask user about file operations needed] - -6. **Sub-Agents** - - Capability: [description from CSV] - - Use cases: [ask user about delegation needs] - -7. **Sub-Processes** - - Capability: [description from CSV] - - Use cases: [ask user about parallel processing needs] - -### 5. Configure Memory Systems - -"**Memory and State Management:** - -Determine if your workflow needs to maintain state between sessions:" - -From CSV memory tools: - -8. **Sidecar File** - - Use case: [description from CSV] - - Needed when: [ask about session continuity, agent initialization] - -### 6. Configure External Tools (Optional) - -"**External Integrations (Optional):** - -These tools connect your workflow to external systems:" - -From CSV (`propose='example'`): - -- MCP integrations, database connections, APIs, etc. -- For each relevant tool: present description and ask if needed -- Note any installation requirements - -### 7. Installation Requirements Assessment - -"**Installation and Dependencies:** - -Some tools require additional setup:" - -Based on selected tools: - -- Identify tools requiring installation -- Assess user's comfort level with installations -- Document installation requirements - -### 8. Document Complete Tools Configuration - -Append to {workflowPlanFile}: - -```markdown -## Tools Configuration - -### Core BMAD Tools - -- **Party-Mode**: [included/excluded] - Integration points: [specific phases] -- **Advanced Elicitation**: [included/excluded] - Integration points: [specific phases] -- **Brainstorming**: [included/excluded] - Integration points: [specific phases] - -### LLM Features - -- **Web-Browsing**: [included/excluded] - Use cases: [specific needs] -- **File I/O**: [included/excluded] - Operations: [file management needs] -- **Sub-Agents**: [included/excluded] - Use cases: [delegation needs] -- **Sub-Processes**: [included/excluded] - Use cases: [parallel processing needs] - -### Memory Systems - -- **Sidecar File**: [included/excluded] - Purpose: [state management needs] - -### External Integrations - -- [List selected external tools with purposes] - -### Installation Requirements - -- [List tools requiring installation] -- **User Installation Preference**: [willing/not willing] -- **Alternative Options**: [if not installing certain tools] -``` - -### 9. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save tools configuration to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and tools configuration is saved will you load {nextStepFile} to review the complete plan. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All tool categories configured based on requirements -- User made informed choices for each tool -- Complete configuration documented in plan -- Installation requirements identified -- Ready to proceed to plan review - -### ❌ SYSTEM FAILURE: - -- Skipping tool categories -- Hardcoding tool descriptions instead of using CSV -- Not documenting user choices -- Proceeding without user confirmation - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md b/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md deleted file mode 100644 index 5a541d73..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -name: 'step-04-plan-review' -description: 'Review complete workflow plan (requirements + tools) and get user approval before design' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-plan-review.md' -nextStepFormDesign: '{workflow_path}/steps/step-05-output-format-design.md' -nextStepDesign: '{workflow_path}/steps/step-06-design.md' - -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append review summary directly to workflow plan ---- - -# Step 4: Plan Review and Approval - -## STEP GOAL: - -To present the complete workflow plan (requirements and tools configuration) for user review and approval before proceeding to design. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ 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 expertise in workflow design review and quality assurance -- ✅ User brings their specific requirements and approval authority - -### Step-Specific Rules: - -- 🎯 Focus ONLY on reviewing and refining the plan -- 🚫 FORBIDDEN to start designing workflow steps in this step -- 💬 Present plan clearly and solicit feedback -- 🚫 DO NOT proceed to design without user approval - -## EXECUTION PROTOCOLS: - -- 🎯 Present complete plan summary from {workflowPlanFile} -- 💾 Capture any modifications or refinements -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step -- 🚫 FORBIDDEN to load next step until user approves plan - -## CONTEXT BOUNDARIES: - -- All requirements from step 2 are available -- Tools configuration from step 3 is complete -- Focus ONLY on review and approval -- This is the final check before design phase - -## PLAN REVIEW PROCESS: - -### 1. Initialize Plan Review - -"**Workflow Plan Review** - -We've gathered all requirements and configured tools for your workflow. Let's review the complete plan to ensure it meets your needs before we start designing the workflow structure." - -### 2. Present Complete Plan Summary - -Load and present from {workflowPlanFile}: - -"**Complete Workflow Plan: {new_workflow_name}** - -**1. Project Overview:** - -- [Present workflow purpose, user type, module from plan] - -**2. Workflow Requirements:** - -- [Present all gathered requirements] - -**3. Tools Configuration:** - -- [Present selected tools and integration points] - -**4. Technical Specifications:** - -- [Present technical constraints and requirements] - -**5. Success Criteria:** - -- [Present success metrics from requirements]" - -### 3. Detailed Review by Category - -"**Detailed Review:** - -**A. Workflow Scope and Purpose** - -- Is the workflow goal clearly defined? -- Are the boundaries appropriate? -- Any missing requirements? - -**B. User Interaction Design** - -- Does the interaction style match your needs? -- Are collaboration points clear? -- Any adjustments needed? - -**C. Tools Integration** - -- Are selected tools appropriate for your workflow? -- Are integration points logical? -- Any additional tools needed? - -**D. Technical Feasibility** - -- Are all requirements achievable? -- Any technical constraints missing? -- Installation requirements acceptable?" - -### 4. Collect Feedback and Refinements - -"**Review Feedback:** - -Please review each section and provide feedback: - -1. What looks good and should stay as-is? -2. What needs modification or refinement? -3. What's missing that should be added? -4. Anything unclear or confusing?" - -For each feedback item: - -- Document the requested change -- Discuss implications on workflow design -- Confirm the refinement with user - -### 5. Update Plan with Refinements - -Update {workflowPlanFile} with any approved changes: - -- Modify requirements section as needed -- Update tools configuration if changed -- Add any missing specifications -- Ensure all changes are clearly documented - -### 6. Output Document Check - -"**Output Document Check:** - -Before we proceed to design, does your workflow produce any output documents or files? - -Based on your requirements: - -- [Analyze if workflow produces documents/files] -- Consider: Does it create reports, forms, stories, or any persistent output?" - -**If NO:** -"Great! Your workflow focuses on actions/interactions without document output. We'll proceed directly to designing the workflow steps." - -**If YES:** -"Perfect! Let's design your output format to ensure your workflow produces exactly what you need." - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Design - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Check if workflow produces documents: - - If YES: Update frontmatter, then load nextStepFormDesign - - If NO: Update frontmatter, then load nextStepDesign -- 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 the user has explicitly approved the plan and the plan document is updated as needed, then you load either {nextStepFormDesign} or {nextStepDesign} - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete plan presented clearly from {workflowPlanFile} -- User feedback collected and documented -- All refinements incorporated -- User explicitly approves the plan -- Plan ready for design phase - -### ❌ SYSTEM FAILURE: - -- Not loading plan from {workflowPlanFile} -- Skipping review categories -- Proceeding without user approval -- Not documenting refinements - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md b/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md deleted file mode 100644 index 7062f2ed..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -name: 'step-05-output-format-design' -description: 'Design the output format for workflows that produce documents or files' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-output-format-design.md' -nextStepFile: '{workflow_path}/steps/step-06-design.md' - -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 5: Output Format Design - -## STEP GOAL: - -To design and document the output format for workflows that produce documents or files, determining whether they need strict templates or flexible formatting. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and output format 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 expertise in document design and template creation -- ✅ User brings their specific output requirements and preferences - -### Step-Specific Rules: - -- 🎯 Focus ONLY on output format design -- 🚫 FORBIDDEN to design workflow steps in this step -- 💬 Help user understand the format spectrum -- 🚫 DO NOT proceed without clear format requirements - -## EXECUTION PROTOCOLS: - -- 🎯 Guide user through format spectrum with examples -- 💾 Document format decisions in workflow plan -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Approved plan from step 4 is available -- Focus ONLY on output document formatting -- Skip this step if workflow produces no documents -- This step only runs when documents need structure - -## OUTPUT FORMAT DESIGN PROCESS: - -### 1. Initialize Output Format Discussion - -"**Designing Your Output Format** - -Based on your approved plan, your workflow will produce output documents. Let's design how these outputs should be formatted." - -### 2. Present the Format Spectrum - -"**Output Format Spectrum - Where does your workflow fit?** - -**Strictly Structured Examples:** - -- Government forms - exact fields, precise positions -- Legal documents - must follow specific templates -- Technical specifications - required sections, specific formats -- Compliance reports - mandatory fields, validation rules - -**Structured Examples:** - -- Project reports - required sections, flexible content -- Business proposals - consistent format, customizable sections -- Technical documentation - standard structure, adaptable content -- Research papers - IMRAD format, discipline-specific variations - -**Semi-structured Examples:** - -- Character sheets (D&D) - core stats + flexible background -- Lesson plans - required components, flexible delivery -- Recipes - ingredients/method format, flexible descriptions -- Meeting minutes - agenda/attendees/actions, flexible details - -**Free-form Examples:** - -- Creative stories - narrative flow, minimal structure -- Blog posts - title/body, organic organization -- Personal journals - date/entry, free expression -- Brainstorming outputs - ideas, flexible organization" - -### 3. Determine Format Type - -"**Which format type best fits your workflow?** - -1. **Strict Template** - Must follow exact format with specific fields -2. **Structured** - Required sections but flexible within each -3. **Semi-structured** - Core sections plus optional additions -4. **Free-form** - Content-driven with minimal structure - -Please choose 1-4:" - -### 4. Deep Dive Based on Choice - -#### IF Strict Template (Choice 1): - -"**Strict Template Design** - -You need exact formatting. Let's define your requirements: - -**Template Source Options:** -A. Upload existing template/image to follow -B. Create new template from scratch -C. Use standard form (e.g., government, industry) -D. AI proposes template based on your needs - -**Template Requirements:** - -- Exact field names and positions -- Required vs optional fields -- Validation rules -- File format (PDF, DOCX, etc.) -- Any legal/compliance considerations" - -#### IF Structured (Choice 2): - -"**Structured Document Design** - -You need consistent sections with flexibility: - -**Section Definition:** - -- What sections are required? -- Any optional sections? -- Section ordering rules? -- Cross-document consistency needs? - -**Format Guidelines:** - -- Any formatting standards (APA, MLA, corporate)? -- Section header styles? -- Content organization principles?" - -#### IF Semi-structured (Choice 3): - -"**Semi-structured Design** - -Core sections with flexibility: - -**Core Components:** - -- What information must always appear? -- Which parts can vary? -- Any organizational preferences? - -**Polishing Options:** - -- Would you like automatic TOC generation? -- Summary section at the end? -- Consistent formatting options?" - -#### IF Free-form (Choice 4): - -"**Free-form Content Design** - -Focus on content with minimal structure: - -**Organization Needs:** - -- Basic headers for readability? -- Date/title information? -- Any categorization needs? - -**Final Polish Options:** - -- Auto-generated summary? -- TOC based on content? -- Formatting for readability?" - -### 5. Template Creation (if applicable) - -For Strict/Structured workflows: - -"**Template Creation Approach:** - -A. **Design Together** - We'll create the template step by step -B. **AI Proposes** - I'll suggest a structure based on your needs -C. **Import Existing** - Use/upload your existing template - -Which approach would you prefer?" - -If A or B: - -- Design/create template sections -- Define placeholders -- Specify field types and validation -- Document template structure in plan - -If C: - -- Request file upload or detailed description -- Analyze template structure -- Document requirements - -### 6. Document Format Decisions - -Append to {workflowPlanFile}: - -```markdown -## Output Format Design - -**Format Type**: [Strict/Structured/Semi-structured/Free-form] - -**Output Requirements**: - -- Document type: [report/form/story/etc] -- File format: [PDF/MD/DOCX/etc] -- Frequency: [single/batch/continuous] - -**Structure Specifications**: -[Detailed structure based on format type] - -**Template Information**: - -- Template source: [created/imported/standard] -- Template file: [path if applicable] -- Placeholders: [list if applicable] - -**Special Considerations**: - -- Legal/compliance requirements -- Validation needs -- Accessibility requirements -``` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save output format design to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- 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 output format is documented will you load {nextStepFile} to begin workflow step design. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- User understands format spectrum -- Format type clearly identified -- Template requirements documented (if applicable) -- Output format saved in plan - -### ❌ SYSTEM FAILURE: - -- Not showing format examples -- Skipping format requirements -- Not documenting decisions in plan -- Assuming format without asking - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md b/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md deleted file mode 100644 index 01a7be8a..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -name: 'step-07-build' -description: 'Generate all workflow files based on the approved plan' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-07-build.md' -nextStepFile: '{workflow_path}/steps/step-08-review.md' -workflowFile: '{workflow_path}/workflow.md' -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Template References -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -stepInitContinuableTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md' -step1bTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md' -# No content templates needed - will create content as needed during build -# No build summary template needed - will append summary directly to workflow plan ---- - -# Step 7: Workflow File Generation - -## STEP GOAL: - -To generate all the workflow files (workflow.md, step files, templates, and supporting files) based on the approved plan from the previous design step. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ 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 implementation expertise and best practices -- ✅ User brings their specific requirements and design approvals - -### Step-Specific Rules: - -- 🎯 Focus ONLY on generating files based on approved design -- 🚫 FORBIDDEN to modify the design without user consent -- 💬 Generate files collaboratively, getting approval at each stage -- 🚪 CREATE files in the correct target location - -## EXECUTION PROTOCOLS: - -- 🎯 Generate files systematically from design -- 💾 Document all generated files and their locations -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and build is complete - -## CONTEXT BOUNDARIES: - -- Approved plan from step 6 guides implementation -- Generate files in target workflow location -- Load templates and documentation as needed during build -- Follow step-file architecture principles - -## BUILD REFERENCE MATERIALS: - -- When building each step file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` -- When building continuable step-01-init.md files, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md` -- When building continuation steps, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md` -- When building the main workflow.md file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` -- Example step files from {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns - this is an idealized workflow so all files can give good insight into format and structure to be followed - -## FILE GENERATION SEQUENCE: - -### 1. Confirm Build Readiness - -Based on the approved plan, confirm: -"I have your approved plan and I'm ready to generate the workflow files. The plan specifies creating: - -- Main workflow.md file -- [Number] step files -- [Number] templates -- Supporting files - -All in: {targetWorkflowPath} - -Ready to proceed?" - -### 2. Create Directory Structure - -Create the workflow folder structure in the target location: - -``` -{bmb_creations_output_folder}/workflows/{workflow_name}/ -├── workflow.md -├── steps/ -│ ├── step-01-init.md -│ ├── step-01b-continue.md (if continuation support needed) -│ ├── step-02-[name].md -│ └── ... -├── templates/ -│ └── [as needed] -└── data/ - └── [as needed] -``` - -For bmb module, this will be: `_bmad/custom/src/workflows/{workflow_name}/` -For other modules, check their module.yaml for custom_workflow_location - -### 3. Generate workflow.md - -Load and follow {workflowTemplate}: - -- Create workflow.md using template structure -- Insert workflow name and description -- Configure all path variables ({project-root}, _bmad, {workflow_path}) -- Set web_bundle flag to true unless user has indicated otherwise -- Define role and goal -- Include initialization path to step-01 - -### 4. Generate Step Files - -#### 4a. Check for Continuation Support - -**Check the workflow plan for continuation support:** - -- Look for "continuation support: true" or similar flag -- Check if step-01b-continue.md was included in the design -- If workflow generates output documents, continuation is typically needed - -#### 4b. Generate step-01-init.md (with continuation logic) - -If continuation support is needed: - -- Load and follow {stepInitContinuableTemplate} -- This template automatically includes all required continuation detection logic -- Customize with workflow-specific information: - - Update workflow_path references - - Set correct outputFile and templateFile paths - - Adjust role and persona to match workflow type - - Customize welcome message for workflow context - - Configure input document discovery patterns (if any) -- Template automatically handles: - - continueFile reference in frontmatter - - Logic to check for existing output files with stepsCompleted - - Routing to step-01b-continue.md for continuation - - Fresh workflow initialization - -#### 4c. Generate step-01b-continue.md (if needed) - -**If continuation support is required:** - -- Load and follow {step1bTemplate} -- Customize with workflow-specific information: - - Update workflow_path references - - Set correct outputFile path - - Adjust role and persona to match workflow type - - Customize welcome back message for workflow context -- Ensure proper nextStep detection logic based on step numbers - -#### 4d. Generate Remaining Step Files - -For each remaining step in the design: - -- Load and follow {stepTemplate} -- Create step file using template structure -- Customize with step-specific content -- Ensure proper frontmatter with path references -- Include appropriate menu handling and universal rules -- Follow all mandatory rules and protocols from template -- **Critical**: Ensure each step updates `stepsCompleted` array when completing - -### 5. Generate Templates (If Needed) - -For document workflows: - -- Create template.md with proper structure -- Include all variables from design -- Ensure variable naming consistency - -Remember that the output format design we aligned on chose one of the following - and what it means practically when creating the workflow steps: -1. **Strict Template** - Must follow exact format with specific fields - 1. This is similar to the example where there are multiple template fragements that are specific with all fields to be in the final output. - 2. generally there will be 1 fragment to a step to complete in the overall template. -2. **Structured** - Required sections but flexible within each - 1. Usually there will just be one template file - and in this mode it lists out all the section headings (generally level 2 sections in the md) with a handlebars style placeholder for each section. - 2. Step files responsible for a specific section will upon user Continue of that step ensure output is written to the templates proper section -3. **Semi-structured** - Core sections plus optional additions - 1. Similar to the prior 2, but not all sections or content are listed in the template, some steps might offer various paths or options to go to different steps (or variance within a step) that can determine what sections end up in the final document -4. **Free-form** - Content-driven with minimal structure - 1. These are the easiest and most flexible. The single template usually only has the front matter fence with a stepsCompleted array and maybe some other fields, and outside of the front matter just the level 1 doc title - 2. With free form, any step that could produce content just appends to the end of the document, so its progressively build in the order of ste[s completed. - 3. Its good to have in this type of workflow a final polish output doc type step that cohesively can update the doc built up in this progressive manner, improving flow, reducing duplication, and ensure all information is aligned and where it belongs. - -### 6. Generate Supporting Files - -Based on design requirements: - -- Create data files (csv) -- Generate README.md with usage instructions -- Create any configuration files -- Add validation checklists if designed - -### 7. Verify File Generation - -After creating all files: - -- Check all file paths are correct -- Validate frontmatter syntax -- Ensure variable consistency across files -- Confirm sequential step numbering -- Verify menu handling logic - -### 8. Document Generated Files - -Create a summary of what was generated: - -- List all files created with full paths -- Note any customizations from templates -- Identify any manual steps needed -- Provide next steps for testing - -## QUALITY CHECKS DURING BUILD: - -### Frontmatter Validation - -- All YAML syntax is correct -- Required fields are present -- Path variables use correct format -- No hardcoded paths exist - -### Step File Compliance - -- Each step follows the template structure -- All mandatory rules are included -- Menu handling is properly implemented -- Step numbering is sequential - -### Cross-File Consistency - -- Variable names match across files -- Path references are consistent -- Dependencies are correctly defined -- No orphaned references exist - -## BUILD PRINCIPLES: - -### Follow Design Exactly - -- Implement the design as approved -- Don't add or remove steps without consultation -- Maintain the interaction patterns designed -- Preserve the data flow architecture - -### Maintain Best Practices - -- Keep step files focused and reasonably sized (typically 5-10KB) -- Use collaborative dialogue patterns -- Include proper error handling -- Follow naming conventions - -### Ensure Extensibility - -- Design for future modifications -- Include clear documentation -- Make code readable and maintainable -- Provide examples where helpful - -## CONTENT TO APPEND TO PLAN: - -After generating all files, append to {workflowPlanFile}: - -Create a build summary including: - -- List of all files created with full paths -- Any customizations from templates -- Manual steps needed -- Next steps for testing - -### 9. Present MENU OPTIONS - -Display: **Build Complete - Select an Option:** [C] Continue to Review - -#### EXECUTION RULES: - -- Build complete - all files generated -- Present simple completion status -- User selects [C] to continue to review step - -#### Menu Handling Logic: - -- IF C: Save build summary to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to plan and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow review step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All workflow files generated in correct locations -- Files follow step-file architecture principles -- Plan implemented exactly as approved -- Build documented in {workflowPlanFile} -- Frontmatter updated with step completion - -### ❌ SYSTEM FAILURE: - -- Generating files without user approval -- Deviating from approved plan -- Creating files with incorrect paths -- Not updating plan frontmatter - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md b/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md deleted file mode 100644 index a3d7258e..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -name: 'step-08-review' -description: 'Review the generated workflow and provide final validation and next steps' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-08-review.md' -workflowFile: '{workflow_path}/workflow.md' - -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -# No review template needed - will append review summary directly to workflow plan -# No completion template needed - will append completion details directly - -# Next step reference -nextStepFile: '{workflow_path}/steps/step-09-complete.md' ---- - -# Step 8: Workflow Review and Completion - -## STEP GOAL: - -To review the generated workflow for completeness, accuracy, and adherence to best practices, then provide next steps for deployment and usage. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Always read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ 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 quality assurance expertise and validation knowledge -- ✅ User provides final approval and feedback - -### Step-Specific Rules: - -- 🎯 Focus ONLY on reviewing and validating generated workflow -- 🚫 FORBIDDEN to make changes without user approval -- 💬 Guide review process collaboratively -- 🚪 COMPLETE the workflow creation process - -## EXECUTION PROTOCOLS: - -- 🎯 Conduct thorough review of generated workflow -- 💾 Document review findings and completion status -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` and mark complete -- 🚫 This is the final step - no next step to load - -## CONTEXT BOUNDARIES: - -- Generated workflow files are available for review -- Focus on validation and quality assurance -- This step completes the workflow creation process -- No file modifications without explicit user approval - -## WORKFLOW REVIEW PROCESS: - -### 1. File Structure Review - -Verify the workflow organization: - -- Are all required files present? -- Is the directory structure correct? -- Are file names following conventions? -- Are paths properly configured? - -### 2. Configuration Validation - -Check workflow.yaml: - -- Is all metadata correctly filled? -- Are path variables properly formatted? -- Is the standalone property set correctly? -- Are all dependencies declared? - -### 3. Step File Compliance - -Review each step file: - -- Does each step follow the template structure? -- Are all mandatory rules included? -- Is menu handling properly implemented? -- Are frontmatter variables correct? -- Are steps properly numbered? - -### 4. Cross-File Consistency - -Verify integration between files: - -- Do variable names match across all files? -- Are path references consistent? -- Is the step sequence logical? -- Are there any broken references? - -### 5. Requirements Verification - -Confirm original requirements are met: - -- Does the workflow address the original problem? -- Are all user types supported? -- Are inputs and outputs as specified? -- Is the interaction style as designed? - -### 6. Best Practices Adherence - -Check quality standards: - -- Are step files focused and reasonably sized (5-10KB typical)? -- Is collaborative dialogue implemented? -- Is error handling included? -- Are naming conventions followed? - -### 7. Test Scenario Planning - -Prepare for testing: - -- What test data would be useful? -- What scenarios should be tested? -- How can the workflow be invoked? -- What would indicate successful execution? - -### 8. Deployment Preparation - -Provide next steps: - -- Installation requirements -- Invocation commands -- Testing procedures -- Documentation needs - -## REVIEW FINDINGS DOCUMENTATION: - -### Issues Found - -Document any issues discovered: - -- **Critical Issues**: Must fix before use -- **Warnings**: Should fix for better experience -- **Suggestions**: Nice to have improvements - -### Validation Results - -Record validation outcomes: - -- Configuration validation: PASSED/FAILED -- Step compliance: PASSED/FAILED -- Cross-file consistency: PASSED/FAILED -- Requirements verification: PASSED/FAILED - -### Recommendations - -Provide specific recommendations: - -- Immediate actions needed -- Future improvements -- Training needs -- Maintenance considerations - -## COMPLETION CHECKLIST: - -### Final Validations - -- [ ] All files generated successfully -- [ ] No syntax errors in YAML -- [ ] All paths are correct -- [ ] Variables are consistent -- [ ] Design requirements met -- [ ] Best practices followed - -### User Acceptance - -- [ ] User has reviewed generated workflow -- [ ] User approves of the implementation -- [ ] User understands next steps -- [ ] User satisfied with the result - -### Documentation - -- [ ] Build summary complete -- [ ] Review findings documented -- [ ] Next steps provided -- [ ] Contact information for support - -## CONTENT TO APPEND TO PLAN: - -After completing review, append to {workflowPlanFile}: - -Append review findings to {workflowPlanFile}: - -Create a review summary including: - -- Completeness check results -- Accuracy validation -- Compliance with best practices -- Any issues found - -Then append completion details: - -- Final approval status -- Deployment recommendations -- Usage guidance - -### 10. Present MENU OPTIONS - -Display: **Select an Option:** [C] Continue to Completion - -#### 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 -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF C: Save review to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options) - -## COMPLIANCE CHECK INSTRUCTIONS - -When user selects [C], provide these instructions: - -**🎯 Workflow Creation Complete! Your new workflow is ready at:** -`{target_workflow_path}` - -**⚠️ IMPORTANT - Run Compliance Check in New Context:** -To validate your workflow meets BMAD standards: - -1. **Start a new Claude conversation** (fresh context) -2. **Use this command:** `/bmad:bmm:workflows:workflow-compliance-check` -3. **Provide the path:** `{target_workflow_path}/workflow.md` -4. **Follow the validation process** to identify and fix any violations - -**Why New Context?** - -- Compliance checking requires fresh analysis without workflow creation context -- Ensures objective validation against template standards -- Provides detailed violation reporting with specific fix recommendations - -**Your workflow will be checked for:** - -- Template compliance and structure -- Step-by-step validation standards -- File optimization and formatting -- Meta-workflow best practices - -Ready to validate when you are! [Start new context and run compliance check] - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Generated workflow thoroughly reviewed -- All validations performed -- Issues documented with solutions -- User approves final workflow -- Complete documentation provided - -### ❌ SYSTEM FAILURE: - -- Skipping review steps -- Not documenting findings -- Ending without user approval -- Not providing next steps - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md b/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md deleted file mode 100644 index 4a9125b8..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -name: 'step-09-complete' -description: 'Final completion and wrap-up of workflow creation process' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-09-complete.md' -workflowFile: '{workflow_path}/workflow.md' -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' -completionFile: '{targetWorkflowPath}/completion-summary-{new_workflow_name}.md' ---- - -# Step 9: Workflow Creation Complete - -## STEP GOAL: - -To complete the workflow creation process with a final summary, confirmation, and next steps for using the new workflow. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ 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 expertise in workflow deployment and usage guidance -- ✅ User brings their specific workflow needs - -### Step-Specific Rules: - -- 🎯 Focus ONLY on completion and next steps -- 🚫 FORBIDDEN to modify the generated workflow -- 💬 Provide clear guidance on how to use the workflow -- 🚫 This is the final step - no next step to load - -## EXECUTION PROTOCOLS: - -- 🎯 Present completion summary -- 💾 Create final completion documentation -- 📖 Update plan frontmatter with completion status -- 🚫 This is the final step - -## CONTEXT BOUNDARIES: - -- All previous steps are complete -- Workflow has been generated and reviewed -- Focus ONLY on completion and next steps -- This step concludes the create-workflow process - -## COMPLETION PROCESS: - -### 1. Initialize Completion - -"**Workflow Creation Complete!** - -Congratulations! We've successfully created your new workflow. Let's finalize everything and ensure you have everything you need to start using it." - -### 2. Final Summary - -Present a complete summary of what was created: - -**Workflow Created:** {new_workflow_name} -**Location:** {targetWorkflowPath} -**Files Generated:** [list from build step] - -### 3. Create Completion Summary - -Create {completionFile} with: - -```markdown ---- -workflowName: { new_workflow_name } -creationDate: [current date] -module: [module from plan] -status: COMPLETE -stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9] ---- - -# Workflow Creation Summary - -## Workflow Information - -- **Name:** {new_workflow_name} -- **Module:** [module] -- **Created:** [date] -- **Location:** {targetWorkflowPath} - -## Generated Files - -[List all files created] - -## Quick Start Guide - -[How to run the new workflow] - -## Next Steps - -[Post-creation recommendations] -``` - -### 4. Usage Guidance - -Provide clear instructions on how to use the new workflow: - -**How to Use Your New Workflow:** - -1. **Running the Workflow:** - - [Instructions based on workflow type] - - [Initial setup if needed] - -2. **Common Use Cases:** - - [Typical scenarios for using the workflow] - - [Expected inputs and outputs] - -3. **Tips for Success:** - - [Best practices for this specific workflow] - - [Common pitfalls to avoid] - -### 5. Post-Creation Recommendations - -"**Next Steps:** - -1. **Test the Workflow:** Run it with sample data to ensure it works as expected -2. **Customize if Needed:** You can modify the workflow based on your specific needs -3. **Share with Team:** If others will use this workflow, provide them with the location and instructions -4. **Monitor Usage:** Keep track of how well the workflow meets your needs" - -### 6. Final Confirmation - -"**Is there anything else you need help with regarding your new workflow?** - -- I can help you test it -- We can make adjustments if needed -- I can help you create documentation for users -- Or any other support you need" - -### 7. Update Final Status - -Update {workflowPlanFile} frontmatter: - -- Set status to COMPLETE -- Set completion date -- Add stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9] - -## MENU OPTIONS - -Display: **Workflow Creation Complete!** [T] Test Workflow [M] Make Adjustments [D] Get Help - -### Menu Handling Logic: - -- IF T: Offer to run the newly created workflow with sample data -- IF M: Offer to make specific adjustments to the workflow -- IF D: Provide additional help and resources -- IF Any other: Respond to user needs - -## CRITICAL STEP COMPLETION NOTE - -This is the final step. When the user is satisfied, the workflow creation process is complete. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Workflow fully created and reviewed -- Completion summary generated -- User understands how to use the workflow -- All documentation is in place - -### ❌ SYSTEM FAILURE: - -- Not providing clear usage instructions -- Not creating completion summary -- Leaving user without next steps - -**Master Rule:** Ensure the user has everything needed to successfully use their new workflow. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md b/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md deleted file mode 100644 index 69742729..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -name: 'step-01-analyze' -description: 'Load and deeply understand the target workflow' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-analyze.md' -nextStepFile: '{workflow_path}/steps/step-02-discover.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Template References -analysisTemplate: '{workflow_path}/templates/workflow-analysis.md' ---- - -# Step 1: Workflow Analysis - -## STEP GOAL: - -To load and deeply understand the target workflow, including its structure, purpose, and potential improvement areas. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement 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 analysis expertise and best practices knowledge -- ✅ User brings their workflow context and improvement needs - -### Step-Specific Rules: - -- 🎯 Focus ONLY on analysis and understanding, not editing yet -- 🚫 FORBIDDEN to suggest specific changes in this step -- 💬 Ask questions to understand the workflow path -- 🚪 DETECT if this is a new format (standalone) or old format workflow - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze workflow thoroughly and systematically -- 💾 Document analysis findings in {outputFile} -- 📖 Update frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and analysis is complete - -## CONTEXT BOUNDARIES: - -- User provides the workflow path to analyze -- Load all workflow documentation for reference -- Focus on understanding current state, not improvements yet -- This is about discovery and analysis - -## WORKFLOW ANALYSIS PROCESS: - -### 1. Get Workflow Information - -Ask the user: -"I need two pieces of information to help you edit your workflow effectively: - -1. **What is the path to the workflow you want to edit?** - - Path to workflow.md file (new format) - - Path to workflow.yaml file (legacy format) - - Path to the workflow directory - - Module and workflow name (e.g., 'bmb/workflows/create-workflow') - -2. **What do you want to edit or improve in this workflow?** - - Briefly describe what you want to achieve - - Are there specific issues you've encountered? - - Any user feedback you've received? - - New features you want to add? - -This will help me focus my analysis on what matters most to you." - -### 2. Load Workflow Files - -Load the target workflow completely: - -- workflow.md (or workflow.yaml for old format) -- steps/ directory with all step files -- templates/ directory (if exists) -- data/ directory (if exists) -- Any additional referenced files - -### 3. Determine Workflow Format - -Detect if this is: - -- **New standalone format**: workflow.md with steps/ subdirectory -- **Legacy XML format**: workflow.yaml with instructions.md -- **Mixed format**: Partial migration - -### 4. Focused Analysis - -Analyze the workflow with attention to the user's stated goals: - -#### Initial Goal-Focused Analysis - -Based on what the user wants to edit: - -- If **user experience issues**: Focus on step clarity, menu patterns, instruction style -- If **functional problems**: Focus on broken references, missing files, logic errors -- If **new features**: Focus on integration points, extensibility, structure -- If **compliance issues**: Focus on best practices, standards, validation - -#### Structure Analysis - -- Identify workflow type (document, action, interactive, autonomous, meta) -- Count and examine all steps -- Map out step flow and dependencies -- Check for proper frontmatter in all files - -#### Content Analysis - -- Understand purpose and user journey -- Evaluate instruction style (intent-based vs prescriptive) -- Review menu patterns and user interaction points -- Check variable consistency across files - -#### Compliance Analysis - -Load reference documentation to understand what ideal workflow files sound be when doing the review: - -- `{project-root}/_bmad/bmb/docs/workflows/architecture.md` -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` -- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` - -Check against best practices: - -- Step file size and structure (each step file 80-250 lines) -- Menu handling implementation (every menu item has a handler, and continue will only proceed after writes to output if applicable have completed) -- Frontmatter variable usage - no unused variables in the specific step front matter, and all files referenced in the file are done through a variable in the front matter - -### 5. Present Analysis Findings - -Share your analysis with the user in a conversational way: - -- What this workflow accomplishes (purpose and value) -- How it's structured (type, steps, interaction pattern) -- Format type (new standalone vs legacy) -- Initial findings related to their stated goals -- Potential issues or opportunities in their focus area - -### 6. Confirm Understanding and Refine Focus - -Ask: -"Based on your goal to {{userGoal}}, I've noticed {{initialFindings}}. -Does this align with what you were expecting? Are there other areas you'd like me to focus on in my analysis?" - -This allows the user to: - -- Confirm you're on the right track -- Add or modify focus areas -- Clarify any misunderstandings before proceeding - -### 7. Final Confirmation - -Ask: "Does this analysis cover what you need to move forward with editing?" - -## CONTENT TO APPEND TO DOCUMENT: - -After analysis, append to {outputFile}: - -Load and append the content from {analysisTemplate} - -### 8. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save analysis 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](#7-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and analysis is saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin improvement discovery step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Target workflow loaded completely -- Analysis performed systematically -- Findings documented clearly -- User confirms understanding -- Analysis saved to {outputFile} - -### ❌ SYSTEM FAILURE: - -- Skipping analysis steps -- Not loading all workflow files -- Making suggestions without understanding -- Not saving analysis findings - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md b/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md deleted file mode 100644 index bf9fbca0..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -name: 'step-02-discover' -description: 'Discover improvement goals collaboratively' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-discover.md' -nextStepFile: '{workflow_path}/steps/step-03-improve.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -goalsTemplate: '{workflow_path}/templates/improvement-goals.md' ---- - -# Step 2: Discover Improvement Goals - -## STEP GOAL: - -To collaboratively discover what the user wants to improve and why, before diving into any edits. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement 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 guide discovery with thoughtful questions -- ✅ User brings their context, feedback, and goals - -### Step-Specific Rules: - -- 🎯 Focus ONLY on understanding improvement goals -- 🚫 FORBIDDEN to suggest specific solutions yet -- 💬 Ask open-ended questions to understand needs -- 🚪 ORGANIZE improvements by priority and impact - -## EXECUTION PROTOCOLS: - -- 🎯 Guide collaborative discovery conversation -- 💾 Document goals in {outputFile} -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and goals are documented - -## CONTEXT BOUNDARIES: - -- Analysis from step 1 is available and informs discovery -- Focus areas identified in step 1 guide deeper exploration -- Focus on WHAT to improve and WHY -- Don't discuss HOW to improve yet -- This is about detailed needs assessment, not solution design - -## DISCOVERY PROCESS: - -### 1. Understand Motivation - -Engage in collaborative discovery with open-ended questions: - -"What prompted you to want to edit this workflow?" - -Listen for: - -- User feedback they've received -- Issues they've encountered -- New requirements that emerged -- Changes in user needs or context - -### 2. Explore User Experience - -Ask about how users interact with the workflow: - -"What feedback have you gotten from users running this workflow?" - -Probe for: - -- Confusing steps or unclear instructions -- Points where users get stuck -- Repetitive or tedious parts -- Missing guidance or context -- Friction in the user journey - -### 3. Assess Current Performance - -Discuss effectiveness: - -"Is the workflow achieving its intended outcome?" - -Explore: - -- Are users successful with this workflow? -- What are the success/failure rates? -- Where do most users drop off? -- Are there quality issues with outputs? - -### 4. Identify Growth Opportunities - -Ask about future needs: - -"Are there new capabilities you want to add?" - -Consider: - -- New features or steps -- Integration with other workflows -- Expanded use cases -- Enhanced flexibility - -### 5. Evaluate Instruction Style - -Discuss communication approach: - -"How is the instruction style working for your users?" - -Explore: - -- Is it too rigid or too loose? -- Should certain steps be more adaptive? -- Do some steps need more specificity? -- Does the style match the workflow's purpose? - -### 6. Dive Deeper into Focus Areas - -Based on the focus areas identified in step 1, explore more deeply: - -#### For User Experience Issues - -"Let's explore the user experience issues you mentioned: - -- Which specific steps feel clunky or confusing? -- At what points do users get stuck? -- What kind of guidance would help them most?" - -#### For Functional Problems - -"Tell me more about the functional issues: - -- When do errors occur? -- What specific functionality isn't working? -- Are these consistent issues or intermittent?" - -#### For New Features - -"Let's detail the new features you want: - -- What should these features accomplish? -- How should users interact with them? -- Are there examples of similar workflows to reference?" - -#### For Compliance Issues - -"Let's understand the compliance concerns: - -- Which best practices need addressing? -- Are there specific standards to meet? -- What validation would be most valuable?" - -### 7. Organize Improvement Opportunities - -Based on their responses and your analysis, organize improvements: - -**CRITICAL Issues** (blocking successful runs): - -- Broken references or missing files -- Unclear or confusing instructions -- Missing essential functionality - -**IMPORTANT Improvements** (enhancing user experience): - -- Streamlining step flow -- Better guidance and context -- Improved error handling - -**NICE-TO-HAVE Enhancements** (for polish): - -- Additional validation -- Better documentation -- Performance optimizations - -### 8. Prioritize Collaboratively - -Work with the user to prioritize: -"Looking at all these opportunities, which ones matter most to you right now?" - -Help them consider: - -- Impact on users -- Effort to implement -- Dependencies between improvements -- Timeline constraints - -## CONTENT TO APPEND TO DOCUMENT: - -After discovery, append to {outputFile}: - -Load and append the content from {goalsTemplate} - -### 8. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save goals 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](#8-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and goals are saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin collaborative improvement step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- User improvement goals clearly understood -- Issues and opportunities identified -- Priorities established collaboratively -- Goals documented in {outputFile} -- User ready to proceed with improvements - -### ❌ SYSTEM FAILURE: - -- Skipping discovery dialogue -- Making assumptions about user needs -- Not documenting discovered goals -- Rushing to solutions without understanding - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md b/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md deleted file mode 100644 index ea9b5139..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -name: 'step-03-improve' -description: 'Facilitate collaborative improvements to the workflow' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-improve.md' -nextStepFile: '{workflow_path}/steps/step-04-validate.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -improvementLogTemplate: '{workflow_path}/templates/improvement-log.md' ---- - -# Step 3: Collaborative Improvement - -## STEP GOAL: - -To facilitate collaborative improvements to the workflow, working iteratively on each identified issue. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement 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 guide improvements with explanations and options -- ✅ User makes decisions and approves changes - -### Step-Specific Rules: - -- 🎯 Work on ONE improvement at a time -- 🚫 FORBIDDEN to make changes without user approval -- 💬 Explain the rationale for each proposed change -- 🚪 ITERATE: improve, review, refine - -## EXECUTION PROTOCOLS: - -- 🎯 Facilitate improvements collaboratively and iteratively -- 💾 Document all changes in improvement log -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and improvements are complete - -## CONTEXT BOUNDARIES: - -- Analysis and goals from previous steps guide improvements -- Load workflow creation documentation as needed -- Focus on improvements prioritized in step 2 -- This is about collaborative implementation, not solo editing - -## IMPROVEMENT PROCESS: - -### 1. Load Reference Materials - -Load documentation as needed for specific improvements: - -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` -- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` -- `{project-root}/_bmad/bmb/docs/workflows/architecture.md` - -### 2. Address Each Improvement Iteratively - -For each prioritized improvement: - -#### A. Explain Current State - -Show the relevant section: -"Here's how this step currently works: -[Display current content] - -This can cause {{problem}} because {{reason}}." - -#### B. Propose Improvement - -Suggest specific changes: -"Based on best practices, we could: -{{proposedSolution}} - -This would help users by {{benefit}}." - -#### C. Collaborate on Approach - -Ask for input: -"Does this approach address your need?" -"Would you like to modify this suggestion?" -"What concerns do you have about this change?" - -#### D. Get Explicit Approval - -"Should I apply this change?" - -#### E. Apply and Show Result - -Make the change and display: -"Here's the updated version: -[Display new content] - -Does this look right to you?" - -### 3. Common Improvement Patterns - -#### Step Flow Improvements - -- Merge redundant steps -- Split complex steps -- Reorder for better flow -- Add missing transitions - -#### Instruction Style Refinement - -Load step-template.md for reference: - -- Convert prescriptive to intent-based for discovery steps -- Add structure to vague instructions -- Balance guidance with autonomy - -#### Variable Consistency Fixes - -- Identify all variable references -- Ensure consistent naming (snake_case) -- Verify variables are defined in workflow.md -- Update all occurrences - -#### Menu System Updates - -- Standardize menu patterns -- Ensure proper A/P/C options -- Fix menu handling logic -- Add Advanced Elicitation where useful - -#### Frontmatter Compliance - -- Add required fields to workflow.md -- Ensure proper path variables -- Include web_bundle configuration if needed -- Remove unused fields - -#### Template Updates - -- Align template variables with step outputs -- Improve variable naming -- Add missing template sections -- Test variable substitution - -### 4. Track All Changes - -For each improvement made, document: - -- What was changed -- Why it was changed -- Files modified -- User approval - -## CONTENT TO APPEND TO DOCUMENT: - -After each improvement iteration, append to {outputFile}: - -Load and append content from {improvementLogTemplate} - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### 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: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save improvement log 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](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and all prioritized improvements are complete and documented, will you then load, read entire file, then execute {nextStepFile} to execute and begin validation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All prioritized improvements addressed -- User approved each change -- Changes documented clearly -- Workflow follows best practices -- Improvement log updated - -### ❌ SYSTEM FAILURE: - -- Making changes without user approval -- Not documenting changes -- Skipping prioritized improvements -- Breaking workflow functionality - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md b/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md deleted file mode 100644 index ae98a2b3..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -name: 'step-04-validate' -description: 'Validate improvements and prepare for completion' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-validate.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' -nextStepFile: '{workflow_path}/steps/step-05-compliance-check.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -validationTemplate: '{workflow_path}/templates/validation-results.md' -completionTemplate: '{workflow_path}/templates/completion-summary.md' ---- - -# Step 4: Validation and Completion - -## STEP GOAL: - -To validate all improvements and prepare a completion summary of the workflow editing 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: Always read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement 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 ensure quality and completeness -- ✅ User confirms final state - -### Step-Specific Rules: - -- 🎯 Focus ONLY on validation and completion -- 🚫 FORBIDDEN to make additional edits at this stage -- 💬 Explain validation results clearly -- 🚪 PREPARE final summary and next steps - -## EXECUTION PROTOCOLS: - -- 🎯 Validate all changes systematically -- 💾 Document validation results -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and validation is complete - -## CONTEXT BOUNDARIES: - -- All improvements from step 3 should be implemented -- Focus on validation, not additional changes -- Reference best practices for validation criteria -- This completes the editing process - -## VALIDATION PROCESS: - -### 1. Comprehensive Validation Checks - -Validate the improved workflow systematically: - -#### File Structure Validation - -- [ ] All required files present -- [ ] Directory structure correct -- [ ] File names follow conventions -- [ ] Path references resolve correctly - -#### Configuration Validation - -- [ ] workflow.md frontmatter complete -- [ ] All variables properly formatted -- [ ] Path variables use correct syntax -- [ ] No hardcoded paths exist - -#### Step File Compliance - -- [ ] Each step follows template structure -- [ ] Mandatory rules included -- [ ] Menu handling implemented properly -- [ ] Step numbering sequential -- [ ] Step files reasonably sized (5-10KB) - -#### Cross-File Consistency - -- [ ] Variable names match across files -- [ ] No orphaned references -- [ ] Dependencies correctly defined -- [ ] Template variables match outputs - -#### Best Practices Adherence - -- [ ] Collaborative dialogue implemented -- [ ] Error handling included -- [ ] Naming conventions followed -- [ ] Instructions clear and specific - -### 2. Present Validation Results - -Load validationTemplate and document findings: - -- If issues found: Explain clearly and propose fixes -- If all passes: Confirm success warmly - -### 3. Create Completion Summary - -Load completionTemplate and prepare: - -- Story of transformation -- Key improvements made -- Impact on users -- Next steps for testing - -### 4. Guide Next Steps - -Based on changes made, suggest: - -- Testing the edited workflow -- Running it with sample data -- Getting user feedback -- Additional refinements if needed - -### 5. Document Final State - -Update {outputFile} with: - -- Validation results -- Completion summary -- Change log summary -- Recommendations - -## CONTENT TO APPEND TO DOCUMENT: - -After validation, append to {outputFile}: - -Load and append content from {validationTemplate} - -Then load and append content from {completionTemplate} - -## FINAL MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -### 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: - -- 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](#final-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to {outputFile} with frontmatter updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin compliance validation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All improvements validated successfully -- No critical issues remain -- Completion summary provided -- Next steps clearly outlined -- User satisfied with results - -### ❌ SYSTEM FAILURE: - -- Skipping validation steps -- Not documenting final state -- Ending without user confirmation -- Leaving issues unresolved - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md b/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md deleted file mode 100644 index d53c3aff..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -name: 'step-05-compliance-check' -description: 'Run comprehensive compliance validation on the edited workflow' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-compliance-check.md' -workflowFile: '{workflow_path}/workflow.md' -editedWorkflowPath: '{target_workflow_path}' -complianceCheckWorkflow: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Task References -complianceCheckTask: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md' ---- - -# Step 5: Compliance Validation - -## STEP GOAL: - -Run comprehensive compliance validation on the edited workflow using the workflow-compliance-check workflow to ensure it meets all BMAD standards before completion. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a workflow editor and quality assurance specialist -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD standards and workflow validation -- ✅ User brings their edited workflow and needs quality assurance - -### Step-Specific Rules: - -- 🎯 Focus only on running compliance validation on the edited workflow -- 🚫 FORBIDDEN to skip compliance validation or declare workflow complete without it -- 💬 Approach: Quality-focused, thorough, and collaborative -- 📋 Ensure user understands compliance results and next steps - -## EXECUTION PROTOCOLS: - -- 🎯 Launch workflow-compliance-check on the edited workflow -- 💾 Review compliance report and present findings to user -- 📖 Explain any issues found and provide fix recommendations -- 🚫 FORBIDDEN to proceed without compliance validation completion - -## CONTEXT BOUNDARIES: - -- Available context: Edited workflow files from previous improve step -- Focus: Compliance validation using workflow-compliance-check workflow -- Limits: Validation and reporting only, no further workflow modifications -- Dependencies: Successful workflow improvements in previous step - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Compliance Validation - -"**Final Quality Check: Workflow Compliance Validation** - -Your workflow has been edited! Now let's run a comprehensive compliance check to ensure it meets all BMAD standards and follows best practices. - -This validation will check: - -- Template compliance (workflow-template.md and step-template.md) -- File size optimization and markdown formatting -- CSV data file standards (if applicable) -- Intent vs Prescriptive spectrum alignment -- Web search and subprocess optimization -- Overall workflow flow and goal alignment" - -### 2. Launch Compliance Check Workflow - -**A. Execute Compliance Validation:** - -"Running comprehensive compliance validation on your edited workflow... -Target: `{editedWorkflowPath}` - -**Executing:** {complianceCheckTask} -**Validation Scope:** Full 8-phase compliance analysis -**Expected Duration:** Thorough validation may take several minutes" - -**B. Monitor Validation Progress:** - -Provide updates as the validation progresses: - -- "✅ Workflow.md validation in progress..." -- "✅ Step-by-step compliance checking..." -- "✅ File size and formatting analysis..." -- "✅ Intent spectrum assessment..." -- "✅ Web search optimization analysis..." -- "✅ Generating comprehensive compliance report..." - -### 3. Compliance Report Analysis - -**A. Review Validation Results:** - -"**Compliance Validation Complete!** - -**Overall Assessment:** [PASS/PARTIAL/FAIL - based on compliance report] - -- **Critical Issues:** [number found] -- **Major Issues:** [number found] -- **Minor Issues:** [number found] -- **Compliance Score:** [percentage]%" - -**B. Present Key Findings:** - -"**Key Compliance Results:** - -- **Template Adherence:** [summary of template compliance] -- **File Optimization:** [file size and formatting issues] -- **Intent Spectrum:** [spectrum positioning validation] -- **Performance Optimization:** [web search and subprocess findings] -- **Overall Flow:** [workflow structure and completion validation]" - -### 4. Issue Resolution Options - -**A. Review Compliance Issues:** - -If issues are found: -"**Issues Requiring Attention:** - -**Critical Issues (Must Fix):** -[List any critical violations that prevent workflow functionality] - -**Major Issues (Should Fix):** -[List major issues that impact quality or maintainability] - -**Minor Issues (Nice to Fix):** -[List minor standards compliance issues]" - -**B. Resolution Options:** - -"**Resolution Options:** - -1. **Automatic Fixes** - I can apply automated fixes where possible -2. **Manual Guidance** - I'll guide you through manual fixes step by step -3. **Return to Edit** - Go back to step 3 for additional improvements -4. **Accept as Is** - Proceed with current state (if no critical issues) -5. **Detailed Review** - Review full compliance report in detail" - -### 5. Final Validation Confirmation - -**A. User Choice Handling:** - -Based on user selection: - -- **If Automatic Fixes**: Apply fixes and re-run validation -- **If Manual Guidance**: Provide step-by-step fix instructions -- **If Return to Edit**: Load step-03-discover.md with compliance report context -- **If Accept as Is**: Confirm understanding of any remaining issues -- **If Detailed Review**: Present full compliance report - -**B. Final Status Confirmation:** - -"**Workflow Compliance Status:** [FINAL/PROVISIONAL] - -**Completion Criteria:** - -- ✅ All critical issues resolved -- ✅ Major issues addressed or accepted -- ✅ Compliance documentation complete -- ✅ User understands any remaining minor issues - -**Your edited workflow is ready!**" - -### 6. Completion Documentation - -**A. Update Compliance Status:** - -Document final compliance status in {outputFile}: - -- **Validation Date:** [current date] -- **Compliance Score:** [final percentage] -- **Issues Resolved:** [summary of fixes applied] -- **Remaining Issues:** [any accepted minor issues] - -**B. Final User Guidance:** - -"**Next Steps for Your Edited Workflow:** - -1. **Test the workflow** with real users to validate functionality -2. **Monitor performance** and consider optimization opportunities -3. **Gather feedback** for potential future improvements -4. **Consider compliance check** periodically for maintenance - -**Support Resources:** - -- Use workflow-compliance-check for future validations -- Refer to BMAD documentation for best practices -- Use edit-workflow again for future modifications" - -### 7. Final Menu Options - -"**Workflow Edit and Compliance Complete!** - -**Select an Option:** - -- [C] Complete - Finish workflow editing with compliance validation -- [R] Review Compliance - View detailed compliance report -- [M] More Modifications - Return to editing for additional changes -- [T] Test Workflow - Try a test run (if workflow supports testing)" - -## Menu Handling Logic: - -- IF C: End workflow editing successfully with compliance validation summary -- IF R: Present detailed compliance report findings -- IF M: Return to step-03-discover.md for additional improvements -- IF T: If workflow supports testing, suggest test execution method -- IF Any other comments or queries: respond and redisplay completion options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN compliance validation is complete and user confirms final workflow status, will the workflow editing process be considered successfully finished. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Comprehensive compliance validation executed on edited workflow -- All compliance issues identified and documented with severity rankings -- User provided with clear understanding of validation results -- Appropriate resolution options offered and implemented -- Final edited workflow meets BMAD standards and is ready for production -- User satisfaction with workflow quality and compliance - -### ❌ SYSTEM FAILURE: - -- Skipping compliance validation before workflow completion -- Not addressing critical compliance issues found during validation -- Failing to provide clear guidance on issue resolution -- Declaring workflow complete without ensuring standards compliance -- Not documenting final compliance status for future reference - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md b/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md deleted file mode 100644 index ca888ffb..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md +++ /dev/null @@ -1,75 +0,0 @@ -## Workflow Edit Complete! - -### Transformation Summary - -#### Starting Point - -- **Workflow**: {{workflowName}} -- **Initial State**: {{initialState}} -- **Primary Issues**: {{primaryIssues}} - -#### Improvements Made - -{{#improvements}} - -- **{{area}}**: {{description}} - - **Impact**: {{impact}} - {{/improvements}} - -#### Key Changes - -1. {{change1}} -2. {{change2}} -3. {{change3}} - -### Impact Assessment - -#### User Experience Improvements - -- **Before**: {{beforeUX}} -- **After**: {{afterUX}} -- **Benefit**: {{uxBenefit}} - -#### Technical Improvements - -- **Compliance**: {{complianceImprovement}} -- **Maintainability**: {{maintainabilityImprovement}} -- **Performance**: {{performanceImpact}} - -### Files Modified - -{{#modifiedFiles}} - -- **{{type}}**: {{path}} - {{/modifiedFiles}} - -### Next Steps - -#### Immediate Actions - -1. {{immediateAction1}} -2. {{immediateAction2}} - -#### Testing Recommendations - -- {{testingRecommendation1}} -- {{testingRecommendation2}} - -#### Future Considerations - -- {{futureConsideration1}} -- {{futureConsideration2}} - -### Support Information - -- **Edited by**: {{userName}} -- **Date**: {{completionDate}} -- **Documentation**: {{outputFile}} - -### Thank You! - -Thank you for collaboratively improving this workflow. Your workflow now follows best practices and should provide a better experience for your users. - ---- - -_Edit workflow completed successfully on {{completionDate}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md b/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md deleted file mode 100644 index 895cb7dc..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md +++ /dev/null @@ -1,68 +0,0 @@ -## Improvement Goals - -### Motivation - -- **Trigger**: {{editTrigger}} -- **User Feedback**: {{userFeedback}} -- **Success Issues**: {{successIssues}} - -### User Experience Issues - -{{#uxIssues}} - -- {{.}} - {{/uxIssues}} - -### Performance Gaps - -{{#performanceGaps}} - -- {{.}} - {{/performanceGaps}} - -### Growth Opportunities - -{{#growthOpportunities}} - -- {{.}} - {{/growthOpportunities}} - -### Instruction Style Considerations - -- **Current Style**: {{currentStyle}} -- **Desired Changes**: {{styleChanges}} -- **Style Fit Assessment**: {{styleFit}} - -### Prioritized Improvements - -#### Critical (Must Fix) - -{{#criticalItems}} - -1. {{.}} - {{/criticalItems}} - -#### Important (Should Fix) - -{{#importantItems}} - -1. {{.}} - {{/importantItems}} - -#### Nice-to-Have (Could Fix) - -{{#niceItems}} - -1. {{.}} - {{/niceItems}} - -### Focus Areas for Next Step - -{{#focusAreas}} - -- {{.}} - {{/focusAreas}} - ---- - -_Goals identified on {{date}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md b/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md deleted file mode 100644 index d5445235..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md +++ /dev/null @@ -1,40 +0,0 @@ -## Improvement Log - -### Change Summary - -- **Date**: {{date}} -- **Improvement Area**: {{improvementArea}} -- **User Goal**: {{userGoal}} - -### Changes Made - -#### Change #{{changeNumber}} - -**Issue**: {{issueDescription}} -**Solution**: {{solutionDescription}} -**Rationale**: {{changeRationale}} - -**Files Modified**: -{{#modifiedFiles}} - -- {{.}} - {{/modifiedFiles}} - -**Before**: - -```markdown -{{beforeContent}} -``` - -**After**: - -```markdown -{{afterContent}} -``` - -**User Approval**: {{userApproval}} -**Impact**: {{expectedImpact}} - ---- - -{{/improvementLog}} diff --git a/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md b/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md deleted file mode 100644 index 5ca76893..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md +++ /dev/null @@ -1,51 +0,0 @@ -## Validation Results - -### Overall Status - -**Result**: {{validationResult}} -**Date**: {{date}} -**Validator**: {{validator}} - -### Validation Categories - -#### File Structure - -- **Status**: {{fileStructureStatus}} -- **Details**: {{fileStructureDetails}} - -#### Configuration - -- **Status**: {{configurationStatus}} -- **Details**: {{configurationDetails}} - -#### Step Compliance - -- **Status**: {{stepComplianceStatus}} -- **Details**: {{stepComplianceDetails}} - -#### Cross-File Consistency - -- **Status**: {{consistencyStatus}} -- **Details**: {{consistencyDetails}} - -#### Best Practices - -- **Status**: {{bestPracticesStatus}} -- **Details**: {{bestPracticesDetails}} - -### Issues Found - -{{#validationIssues}} - -- **{{severity}}**: {{description}} - - **Impact**: {{impact}} - - **Recommendation**: {{recommendation}} - {{/validationIssues}} - -### Validation Summary - -{{validationSummary}} - ---- - -_Validation completed on {{date}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md b/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md deleted file mode 100644 index 1ef52217..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md +++ /dev/null @@ -1,56 +0,0 @@ -## Workflow Analysis - -### Target Workflow - -- **Path**: {{workflowPath}} -- **Name**: {{workflowName}} -- **Module**: {{workflowModule}} -- **Format**: {{workflowFormat}} (Standalone/Legacy) - -### Structure Analysis - -- **Type**: {{workflowType}} -- **Total Steps**: {{stepCount}} -- **Step Flow**: {{stepFlowPattern}} -- **Files**: {{fileStructure}} - -### Content Characteristics - -- **Purpose**: {{workflowPurpose}} -- **Instruction Style**: {{instructionStyle}} -- **User Interaction**: {{interactionPattern}} -- **Complexity**: {{complexityLevel}} - -### Initial Assessment - -#### Strengths - -{{#strengths}} - -- {{.}} - {{/strengths}} - -#### Potential Issues - -{{#issues}} - -- {{.}} - {{/issues}} - -#### Format-Specific Notes - -{{#formatNotes}} - -- {{.}} - {{/formatNotes}} - -### Best Practices Compliance - -- **Step File Structure**: {{stepCompliance}} -- **Frontmatter Usage**: {{frontmatterCompliance}} -- **Menu Implementation**: {{menuCompliance}} -- **Variable Consistency**: {{variableCompliance}} - ---- - -_Analysis completed on {{date}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/workflow.md b/src/modules/bmb/workflows/edit-workflow/workflow.md deleted file mode 100644 index 738c3c56..00000000 --- a/src/modules/bmb/workflows/edit-workflow/workflow.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: edit-workflow -description: Intelligent workflow editor that helps modify existing workflows while following best practices -web_bundle: true ---- - -# Edit Workflow - -**Goal:** Collaboratively edit and improve existing workflows, ensuring they follow best practices and meet user needs effectively. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a workflow editor and improvement specialist collaborating with a workflow owner. This is a partnership, not a client-vendor relationship. You bring expertise in workflow design patterns, best practices, and collaborative facilitation, while the user brings their workflow context, user feedback, and improvement goals. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-analyze.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md deleted file mode 100644 index b7c55d4a..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -name: 'step-01-validate-goal' -description: 'Confirm workflow path and validation goals before proceeding' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-validate-goal.md' -nextStepFile: '{workflow_path}/steps/step-02-workflow-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 1: Goal Confirmation and Workflow Target - -## STEP GOAL: - -Confirm the target workflow path and validation objectives before proceeding with systematic compliance analysis. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring compliance expertise and systematic validation skills -- ✅ User brings their workflow and specific compliance concerns - -### Step-Specific Rules: - -- 🎯 Focus only on confirming workflow path and validation scope -- 🚫 FORBIDDEN to proceed without clear target confirmation -- 💬 Approach: Systematic and thorough confirmation of validation objectives -- 📋 Ensure user understands the compliance checking process and scope - -## EXECUTION PROTOCOLS: - -- 🎯 Confirm target workflow path exists and is accessible -- 💾 Establish clear validation objectives and scope -- 📖 Explain the three-phase compliance checking process -- 🚫 FORBIDDEN to proceed without user confirmation of goals - -## CONTEXT BOUNDARIES: - -- Available context: User-provided workflow path and validation concerns -- Focus: Goal confirmation and target validation setup -- Limits: No actual compliance analysis yet, just setup and confirmation -- Dependencies: Clear workflow path and user agreement on validation scope - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Workflow Target Confirmation - -Present this to the user: - -"I'll systematically validate your workflow against BMAD standards through three phases: - -1. **Workflow.md Validation** - Against workflow-template.md standards -2. **Step-by-Step Compliance** - Each step against step-template.md -3. **Holistic Analysis** - Flow optimization and goal alignment" - -IF {user_provided_path} has NOT been provided, ask the user: - -**What workflow should I validate?** Please provide the full path to the workflow.md file." - -### 2. Workflow Path Validation - -Once user provides path: - -"Validating workflow path: `{user_provided_path}`" -[Check if path exists and is readable] - -**If valid:** "✅ Workflow found and accessible. Ready to begin compliance analysis." -**If invalid:** "❌ Cannot access workflow at that path. Please check the path and try again." - -### 3. Validation Scope Confirmation - -"**Compliance Scope:** I will check: - -- ✅ Frontmatter structure and required fields -- ✅ Mandatory execution rules and sections -- ✅ Menu patterns and continuation logic -- ✅ Path variable format consistency -- ✅ Template usage appropriateness -- ✅ Workflow flow and goal alignment -- ✅ Meta-workflow failure analysis - -**Report Output:** I'll generate a detailed compliance report with: - -- Severity-ranked violations (Critical/Major/Minor) -- Specific template references for each violation -- Recommended fixes (automated where possible) -- Meta-feedback for create/edit workflow improvements - -**Is this validation scope acceptable?**" - -### 4. Final Confirmation - -"**Ready to proceed with compliance check of:** - -- **Workflow:** `{workflow_name}` -- **Validation:** Full systematic compliance analysis -- **Output:** Detailed compliance report with fix recommendations - -**Select an Option:** [C] Continue [X] Exit" - -## Menu Handling Logic: - -- IF C: Initialize compliance report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: End workflow gracefully with guidance on running again later -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-final-confirmation) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [workflow path validated and scope confirmed], will you then load and read fully `{nextStepFile}` to execute and begin workflow.md validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Workflow path successfully validated and accessible -- User confirms validation scope and objectives -- Compliance report initialization prepared -- User understands the three-phase validation process -- Clear next steps established for systematic analysis - -### ❌ SYSTEM FAILURE: - -- Proceeding without valid workflow path confirmation -- Not ensuring user understands validation scope and process -- Starting compliance analysis without proper setup -- Failing to establish clear reporting objectives - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md deleted file mode 100644 index 70d818da..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -name: 'step-02-workflow-validation' -description: 'Validate workflow.md against workflow-template.md standards' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-workflow-validation.md' -nextStepFile: '{workflow_path}/steps/step-03-step-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowFile: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 2: Workflow.md Validation - -## STEP GOAL: - -Perform adversarial validation of the target workflow.md against workflow-template.md standards, identifying all violations with severity rankings and specific fix recommendations. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring adversarial validation expertise - your success is finding violations -- ✅ User brings their workflow and needs honest, thorough validation - -### Step-Specific Rules: - -- 🎯 Focus only on workflow.md validation against template standards -- 🚫 FORBIDDEN to skip or minimize any validation checks -- 💬 Approach: Systematic, thorough adversarial analysis -- 📋 Document every violation with template reference and severity ranking - -## EXECUTION PROTOCOLS: - -- 🎯 Load and compare target workflow.md against workflow-template.md -- 💾 Document all violations with specific template references -- 📖 Rank violations by severity (Critical/Major/Minor) -- 🚫 FORBIDDEN to overlook any template violations - -## CONTEXT BOUNDARIES: - -- Available context: Validated workflow path and target workflow.md -- Focus: Systematic validation of workflow.md structure and content -- Limits: Only workflow.md validation, not step files yet -- Dependencies: Successful completion of goal confirmation step - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Compliance Report - -"Beginning **Phase 1: Workflow.md Validation** -Target: `{target_workflow_name}` - -**COMPLIANCE STANDARD:** All validation performed against `{workflowTemplate}` - this is THE authoritative standard for workflow.md compliance. - -Loading workflow templates and target files for systematic analysis..." -[Load workflowTemplate, targetWorkflowFile] - -### 2. Frontmatter Structure Validation - -**Check these elements systematically:** - -"**Frontmatter Validation:**" - -- Required fields: name, description, web_bundle -- Proper YAML format and syntax -- Boolean value format for web_bundle -- Missing or invalid fields - -For each violation found: - -- **Template Reference:** Section "Frontmatter Structure" in workflow-template.md -- **Severity:** Critical (missing required) or Major (format issues) -- **Specific Fix:** Exact correction needed - -### 3. Role Description Validation - -**Check role compliance:** - -"**Role Description Validation:**" - -- Follows partnership format: "In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals." -- Role accurately describes workflow function -- User type correctly identified -- Partnership language present - -For violations: - -- **Template Reference:** "Your Role" section in workflow-template.md -- **Severity:** Major (deviation from standard) or Minor (incomplete) -- **Specific Fix:** Exact wording or structure correction - -### 4. Workflow Architecture Validation - -**Validate architecture section:** - -"**Architecture Validation:**" - -- Core Principles section matches template exactly -- Step Processing Rules includes all 6 rules from template -- Critical Rules section matches template exactly (NO EXCEPTIONS) - -For each deviation: - -- **Template Reference:** "WORKFLOW ARCHITECTURE" section in workflow-template.md -- **Severity:** Critical (modified core principles) or Major (missing rules) -- **Specific Fix:** Restore template-compliant text - -### 5. Initialization Sequence Validation - -**Check initialization:** - -"**Initialization Validation:**" - -- Configuration Loading uses correct path format: `{project-root}/_bmad/[module]/config.yaml` (variable substitution pattern) -- First step follows pattern: `step-01-init.md` OR documented deviation -- Required config variables properly listed -- Variables use proper substitution pattern: {project-root}, _bmad, {workflow_path}, etc. - -For violations: - -- **Template Reference:** "INITIALIZATION SEQUENCE" section in workflow-template.md -- **Severity:** Major (incorrect paths or missing variables) or Minor (format issues) -- **Specific Fix:** Use proper variable substitution patterns for flexible installation - -### 6. Document Workflow.md Findings - -"**Workflow.md Validation Complete** -Found [X] Critical, [Y] Major, [Z] Minor violations - -**Summary:** - -- Critical violations must be fixed before workflow can function -- Major violations impact workflow reliability and maintainability -- Minor violations are cosmetic but should follow standards - -**Next Phase:** Step-by-step validation of all step files..." - -### 7. Update Compliance Report - -Append to {complianceReportFile}: - -```markdown -## Phase 1: Workflow.md Validation Results - -### Template Adherence Analysis - -**Reference Standard:** {workflowTemplate} - -### Frontmatter Structure Violations - -[Document each violation with severity and specific fix] - -### Role Description Violations - -[Document each violation with template reference and correction] - -### Workflow Architecture Violations - -[Document each deviation from template standards] - -### Initialization Sequence Violations - -[Document each path or reference issue] - -### Phase 1 Summary - -**Critical Issues:** [number] -**Major Issues:** [number] -**Minor Issues:** [number] - -### Phase 1 Recommendations - -[Prioritized fix recommendations with specific actions] -``` - -### 8. Continuation Confirmation - -"**Phase 1 Complete:** Workflow.md validation finished with detailed violation analysis. - -**Ready for Phase 3:** Step-by-step validation against step-template.md - -This will check each step file for: - -- Frontmatter completeness and format -- MANDATORY EXECUTION RULES compliance -- Menu pattern and continuation logic -- Path variable consistency -- Template appropriateness - -**Select an Option:** [C] Continue to Step Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save workflow.md findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end workflow with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [workflow.md validation complete with all violations documented], will you then load and read fully `{nextStepFile}` to execute and begin step-by-step validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete workflow.md validation against workflow-template.md -- All violations documented with severity rankings and template references -- Specific fix recommendations provided for each violation -- Compliance report updated with Phase 1 findings -- User confirms understanding before proceeding - -### ❌ SYSTEM FAILURE: - -- Skipping any workflow.md validation sections -- Not documenting violations with specific template references -- Failing to rank violations by severity -- Providing vague or incomplete fix recommendations -- Proceeding without user confirmation of findings - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md deleted file mode 100644 index 5d601a7b..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -name: 'step-03-step-validation' -description: 'Validate each step file against step-template.md standards' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-step-validation.md' -nextStepFile: '{workflow_path}/steps/step-04-file-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowStepsPath: '{target_workflow_steps_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 3: Step-by-Step Validation - -## STEP GOAL: - -Perform systematic adversarial validation of each step file against step-template.md standards, documenting all violations with specific template references and severity rankings. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read this 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring adversarial step-by-step validation expertise -- ✅ User brings their workflow steps and needs thorough validation - -### Step-Specific Rules: - -- 🎯 Focus only on step file validation against step-template.md -- 🚫 FORBIDDEN to skip any step files or validation checks -- 💬 Approach: Systematic file-by-file adversarial analysis -- 📋 Document every violation against each step file with template reference and specific proposed fixes - -## EXECUTION PROTOCOLS: - -- 🎯 Load and validate each step file individually against step-template.md -- 💾 Document violations by file with severity rankings -- 📖 Check for appropriate template usage based on workflow type -- 🚫 FORBIDDEN to overlook any step file or template requirement - -## CONTEXT BOUNDARIES: - -- Available context: Target workflow step files and step-template.md -- Focus: Systematic validation of all step files against template standards -- Limits: Only step file validation, holistic analysis comes next -- Dependencies: Completed workflow.md validation from previous phase - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Step Validation Phase - -"Beginning **Phase 2: Step-by-Step Validation** -Target: `{target_workflow_name}` - [number] step files found - -**COMPLIANCE STANDARD:** All validation performed against `{stepTemplate}` - this is THE authoritative standard for step file compliance. - -Loading step template and validating each step systematically..." -[Load stepTemplate, enumerate all step files]. Utilize sub processes if available but ensure all rules are passed in and all findings are returned from the sub process to collect and record the results. - -### 2. Systematic Step File Analysis - -For each step file in order: - -"**Validating step:** `{step_filename}`" - -**A. Frontmatter Structure Validation:** -Check each required field: - -```yaml ---- -name: 'step-[number]-[name]' # Single quotes, proper format -description: '[description]' # Single quotes -workflowFile: '{workflow_path}/workflow.md' # REQUIRED - often missing -outputFile: [if appropriate for workflow type] -# All other path references and variables -# Template References section (even if empty) -# Task References section ---- -``` - -**Violations to document:** - -- Missing `workflowFile` reference (Critical) -- Incorrect YAML format (missing quotes, etc.) (Major) -- Inappropriate `outputFile` for workflow type (Major) -- Missing `Template References` section (Major) - -**B. MANDATORY EXECUTION RULES Validation:** -Check for complete sections: - -```markdown -## 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: - -[Complete role reinforcement section] - -### Step-Specific Rules: - -[Step-specific rules with proper emoji usage] -``` - -**Violations to document:** - -- Missing Universal Rules (Critical) -- Modified/skipped Universal Rules (Critical) -- Missing Role Reinforcement (Major) -- Improper emoji usage in rules (Minor) - -**C. Task References Validation:** -Check for proper references: - -```yaml -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -``` - -**Violations to document:** - -- Missing Task References section (Major) -- Incorrect paths in task references (Major) -- Missing standard task references (Minor) - -**D. Menu Pattern Validation:** -Check menu structure: - -```markdown -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} -``` - -**Violations to document:** - -- Non-standard menu format (Major) -- Missing Menu Handling Logic section (Major) -- Incorrect "load, read entire file, then execute" pattern (Major) -- Improper continuation logic (Critical) - -### 3. Workflow Type Appropriateness Check - -"**Template Usage Analysis:**" - -- **Document Creation Workflows:** Should have outputFile references, templates -- **Editing Workflows:** Should NOT create unnecessary outputs, direct action focus -- **Validation/Analysis Workflows:** Should emphasize systematic checking - -For each step: - -- **Type Match:** Does step content match workflow type expectations? -- **Template Appropriate:** Are templates/outputs appropriate for this workflow type? -- **Alternative Suggestion:** What would be more appropriate? - -### 4. Path Variable Consistency Check - -"**Path Variable Validation:**" - -- Check format: `{project-root}/_bmad/bmb/...` vs `{project-root}/bmb/...` -- Ensure consistent variable usage across all step files -- Validate relative vs absolute path usage - -Document inconsistencies and standard format requirements. - -### 5. Document Step Validation Results - -For each step file with violations: - -```markdown -### Step Validation: step-[number]-[name].md - -**Critical Violations:** - -- [Violation] - Template Reference: [section] - Fix: [specific action] - -**Major Violations:** - -- [Violation] - Template Reference: [section] - Fix: [specific action] - -**Minor Violations:** - -- [Violation] - Template Reference: [section] - Fix: [specific action] - -**Workflow Type Assessment:** - -- Appropriate: [Yes/No] - Reason: [analysis] -- Recommended Changes: [specific suggestions] -``` - -### 6. Phase Summary and Continuation - -"**Phase 2 Complete:** Step-by-step validation finished - -- **Total Steps Analyzed:** [number] -- **Critical Violations:** [number] across [number] steps -- **Major Violations:** [number] across [number] steps -- **Minor Violations:** [number] across [number] steps - -**Most Common Violations:** - -1. [Most frequent violation type] -2. [Second most frequent] -3. [Third most frequent] - -**Ready for Phase 4:** File Validation workflow analysis - -- Flow optimization assessment -- Goal alignment verification -- Meta-workflow failure analysis - -**Select an Option:** [C] Continue to File Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save step validation findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all step files validated with violations documented], will you then load and read fully `{nextStepFile}` to execute and begin holistic analysis phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All step files systematically validated against step-template.md -- Every violation documented with specific template reference and severity -- Workflow type appropriateness assessed for each step -- Path variable consistency checked across all files -- Common violation patterns identified and prioritized -- Compliance report updated with complete Phase 2 findings - -### ❌ SYSTEM FAILURE: - -- Skipping step files or validation sections -- Not documenting violations with specific template references -- Failing to assess workflow type appropriateness -- Missing path variable consistency analysis -- Providing incomplete or vague fix recommendations - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md deleted file mode 100644 index 26505b47..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -name: 'step-04-file-validation' -description: 'Validate file sizes, markdown formatting, and CSV data files' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-file-validation.md' -nextStepFile: '{workflow_path}/steps/step-05-intent-spectrum-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowPath: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -csvStandards: '{project-root}/_bmad/bmb/docs/workflows/csv-data-file-standards.md' ---- - -# Step 4: File Size, Formatting, and Data Validation - -## STEP GOAL: - -Validate file sizes, markdown formatting standards, and CSV data file compliance to ensure optimal workflow performance and maintainability. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring file optimization and formatting validation expertise -- ✅ User brings their workflow files and needs performance optimization - -### Step-Specific Rules: - -- 🎯 Focus on file sizes, markdown formatting, and CSV validation -- 🚫 FORBIDDEN to skip file size analysis or CSV validation when present -- 💬 Approach: Systematic file analysis with optimization recommendations -- 📋 Ensure all findings include specific recommendations for improvement - -## EXECUTION PROTOCOLS: - -- 🎯 Validate file sizes against optimal ranges (≤5K best, 5-7K good, 7-10K acceptable, 10-12K concern, >15K action required) -- 💾 Check markdown formatting standards and conventions -- 📖 Validate CSV files against csv-data-file-standards.md when present -- 🚫 FORBIDDEN to overlook file optimization opportunities - -## CONTEXT BOUNDARIES: - -- Available context: Target workflow files and their sizes/formats -- Focus: File optimization, formatting standards, and CSV data validation -- Limits: File analysis only, holistic workflow analysis comes next -- Dependencies: Completed step-by-step validation from previous phase - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize File Validation Phase - -"Beginning **File Size, Formatting, and Data Validation** -Target: `{target_workflow_name}` - -Analyzing workflow files for: - -- File size optimization (smaller is better for performance) -- Markdown formatting standards compliance -- CSV data file standards validation (if present) -- Overall file maintainability and performance..." - -### 2. File Size Analysis - -**A. Step File Size Validation:** -For each step file: - -"**File Size Analysis:** `{step_filename}`" - -- **Size:** [file size in KB] -- **Optimization Rating:** [Optimal/Good/Acceptable/Concern/Action Required] -- **Performance Impact:** [Minimal/Moderate/Significant/Severe] - -**Size Ratings:** - -- **≤ 5K:** ✅ Optimal - Excellent performance and maintainability -- **5K-7K:** ✅ Good - Good balance of content and performance -- **7K-10K:** ⚠️ Acceptable - Consider content optimization -- **10K-12K:** ⚠️ Concern - Content should be consolidated or split -- **> 15K:** ❌ Action Required - File must be optimized (split content, remove redundancy) - -**Document optimization opportunities:** - -- Content that could be moved to templates -- Redundant explanations or examples -- Overly detailed instructions that could be condensed -- Opportunities to use references instead of inline content - -### 3. Markdown Formatting Validation - -**A. Heading Structure Analysis:** -"**Markdown Formatting Analysis:**" - -For each file: - -- **Heading Hierarchy:** Proper H1 → H2 → H3 structure -- **Consistent Formatting:** Consistent use of bold, italics, lists -- **Code Blocks:** Proper markdown code block formatting -- **Link References:** Valid internal and external links -- **Table Formatting:** Proper table structure when used - -**Common formatting issues to document:** - -- Missing blank lines around headings -- Inconsistent list formatting (numbered vs bullet) -- Improper code block language specifications -- Broken or invalid markdown links -- Inconsistent heading levels or skipping levels - -### 4. CSV Data File Validation (if present) - -**A. Identify CSV Files:** -"**CSV Data File Analysis:**" -Check for CSV files in workflow directory: - -- Look for `.csv` files in main directory -- Check for `data/` subdirectory containing CSV files -- Identify any CSV references in workflow configuration - -**B. Validate Against Standards:** -For each CSV file found, validate against `{csvStandards}`: - -**Purpose Validation:** - -- Does CSV contain essential data that LLMs cannot generate or web-search? -- Is all CSV data referenced and used in the workflow? -- Is data domain-specific and valuable? -- Does CSV optimize context usage (knowledge base indexing, workflow routing, method selection)? -- Does CSV reduce workflow complexity or step count significantly? -- Does CSV enable dynamic technique selection or smart resource routing? - -**Structural Validation:** - -- Valid CSV format with proper quoting -- Consistent column counts across all rows -- No missing data or properly marked empty values -- Clear, descriptive header row -- Proper UTF-8 encoding - -**Content Validation:** - -- No LLM-generated content (generic phrases, common knowledge) -- Specific, concrete data entries -- Consistent data formatting -- Verifiable and factual data - -**Column Standards:** - -- Clear, descriptive column headers -- Consistent data types per column -- All columns referenced in workflow -- Appropriate column width and focus - -**File Size and Performance:** - -- Efficient structure under 1MB when possible -- No redundant or duplicate rows -- Optimized data representation -- Fast loading characteristics - -**Documentation Standards:** - -- Purpose and usage documentation present -- Column descriptions and format specifications -- Data source documentation -- Update procedures documented - -### 5. File Validation Reporting - -For each file with issues: - -```markdown -### File Validation: {filename} - -**File Size Analysis:** - -- Size: {size}KB - Rating: {Optimal/Good/Concern/etc.} -- Performance Impact: {assessment} -- Optimization Recommendations: {specific suggestions} - -**Markdown Formatting:** - -- Heading Structure: {compliant/issues found} -- Common Issues: {list of formatting problems} -- Fix Recommendations: {specific corrections} - -**CSV Data Validation:** - -- Purpose Validation: {compliant/needs review} -- Structural Issues: {list of problems} -- Content Standards: {compliant/violations} -- Recommendations: {improvement suggestions} -``` - -### 6. Aggregate File Analysis Summary - -"**File Validation Summary:** - -**File Size Distribution:** - -- Optimal (≤5K): [number] files -- Good (5K-7K): [number] files -- Acceptable (7K-10K): [number] files -- Concern (10K-12K): [number] files -- Action Required (>15K): [number] files - -**Markdown Formatting Issues:** - -- Heading Structure: [number] files with issues -- List Formatting: [number] files with inconsistencies -- Code Blocks: [number] files with formatting problems -- Link References: [number] broken or invalid links - -**CSV Data Files:** - -- Total CSV files: [number] -- Compliant with standards: [number] -- Require attention: [number] -- Critical issues: [number] - -**Performance Impact Assessment:** - -- Overall workflow performance: [Excellent/Good/Acceptable/Concern/Poor] -- Most critical file size issue: {file and size} -- Primary formatting concerns: {main issues}" - -### 7. Continuation Confirmation - -"**File Validation Complete:** Size, formatting, and CSV analysis finished - -**Key Findings:** - -- **File Optimization:** [summary of size optimization opportunities] -- **Formatting Standards:** [summary of markdown compliance issues] -- **Data Validation:** [summary of CSV standards compliance] - -**Ready for Phase 5:** Intent Spectrum Validation analysis - -- Flow validation and goal alignment -- Meta-workflow failure analysis -- Strategic recommendations and improvement planning - -**Select an Option:** [C] Continue to Intent Spectrum Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save file validation findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all file sizes analyzed, markdown formatting validated, and CSV files checked against standards], will you then load and read fully `{nextStepFile}` to execute and begin Intent Spectrum Validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All workflow files analyzed for optimal size ranges with specific recommendations -- Markdown formatting validated against standards with identified issues -- CSV data files validated against csv-data-file-standards.md when present -- Performance impact assessed with optimization opportunities identified -- File validation findings documented with specific fix recommendations -- User ready for holistic workflow analysis - -### ❌ SYSTEM FAILURE: - -- Skipping file size analysis or markdown formatting validation -- Not checking CSV files against standards when present -- Failing to provide specific optimization recommendations -- Missing performance impact assessment -- Overlooking critical file size violations (>15K) - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md deleted file mode 100644 index 08992f90..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -name: 'step-05-intent-spectrum-validation' -description: 'Dedicated analysis and validation of intent vs prescriptive spectrum positioning' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-intent-spectrum-validation.md' -nextStepFile: '{workflow_path}/steps/step-06-web-subprocess-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowPath: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -intentSpectrum: '{project-root}/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md' ---- - -# Step 5: Intent vs Prescriptive Spectrum Validation - -## STEP GOAL: - -Analyze the workflow's position on the intent vs prescriptive spectrum, provide expert assessment, and confirm with user whether the current positioning is appropriate or needs adjustment. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and design philosophy specialist -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in intent vs prescriptive design principles -- ✅ User brings their workflow and needs guidance on spectrum positioning - -### Step-Specific Rules: - -- 🎯 Focus only on spectrum analysis and user confirmation -- 🚫 FORBIDDEN to make spectrum decisions without user input -- 💬 Approach: Educational, analytical, and collaborative -- 📋 Ensure user understands spectrum implications before confirming - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze workflow's current spectrum position based on all previous findings -- 💾 Provide expert assessment with specific examples and reasoning -- 📖 Educate user on spectrum implications for their workflow type -- 🚫 FORBIDDEN to proceed without user confirmation of spectrum position - -## CONTEXT BOUNDARIES: - -- Available context: Complete analysis from workflow, step, and file validation phases -- Focus: Intent vs prescriptive spectrum analysis and user confirmation -- Limits: Spectrum analysis only, holistic workflow analysis comes next -- Dependencies: Successful completion of file size and formatting validation - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Spectrum Analysis - -"Beginning **Intent vs Prescriptive Spectrum Validation** -Target: `{target_workflow_name}` - -**Reference Standard:** Analysis based on `{intentSpectrum}` - -This step will help ensure your workflow's approach to LLM guidance is intentional and appropriate for its purpose..." - -### 2. Spectrum Position Analysis - -**A. Current Position Assessment:** -Based on analysis of workflow.md, all step files, and implementation patterns: - -"**Current Spectrum Analysis:** -Based on my review of your workflow, I assess its current position as: - -**[Highly Intent-Based / Balanced Middle / Highly Prescriptive]**" - -**B. Evidence-Based Reasoning:** -Provide specific evidence from the workflow analysis: - -"**Assessment Evidence:** - -- **Instruction Style:** [Examples of intent-based vs prescriptive instructions found] -- **User Interaction:** [How user conversations are structured] -- **LLM Freedom:** [Level of creative adaptation allowed] -- **Consistency Needs:** [Workflow requirements for consistency vs creativity] -- **Risk Factors:** [Any compliance, safety, or regulatory considerations]" - -**C. Workflow Type Analysis:** -"**Workflow Type Analysis:** - -- **Primary Purpose:** {workflow's main goal} -- **User Expectations:** {What users likely expect from this workflow} -- **Success Factors:** {What makes this workflow successful} -- **Risk Level:** {Compliance, safety, or risk considerations}" - -### 3. Recommended Spectrum Position - -**A. Expert Recommendation:** -"**My Professional Recommendation:** -Based on the workflow's purpose, user needs, and implementation, I recommend positioning this workflow as: - -**[Highly Intent-Based / Balanced Middle / Highly Prescriptive]**" - -**B. Recommendation Rationale:** -"**Reasoning for Recommendation:** - -- **Purpose Alignment:** {Why this position best serves the workflow's goals} -- **User Experience:** {How this positioning enhances user interaction} -- **Risk Management:** {How this position addresses any compliance or safety needs} -- **Success Optimization:** {Why this approach will lead to better outcomes}" - -**C. Specific Examples:** -Provide concrete examples of how the recommended position would look: - -"**Examples at Recommended Position:** -**Intent-Based Example:** "Help users discover their creative potential through..." -**Prescriptive Example:** "Ask exactly: 'Have you experienced any of the following...'" - -**Current State Comparison:** -**Current Instructions Found:** [Examples from actual workflow] -**Recommended Instructions:** [How they could be improved]" - -### 4. Spectrum Education and Implications - -**A. Explain Spectrum Implications:** -"**Understanding Your Spectrum Choice:** - -**If Intent-Based:** Your workflow will be more creative, adaptive, and personalized. Users will have unique experiences, but interactions will be less predictable. - -**If Prescriptive:** Your workflow will be consistent, controlled, and predictable. Every user will have similar experiences, which is ideal for compliance or standardization. - -**If Balanced:** Your workflow will provide professional expertise with some adaptation, offering consistent quality with personalized application." - -**B. Context-Specific Guidance:** -"**For Your Specific Workflow Type:** -{Provide tailored guidance based on whether it's creative, professional, compliance, technical, etc.}" - -### 5. User Confirmation and Decision - -**A. Present Findings and Recommendation:** -"**Spectrum Analysis Summary:** - -**Current Assessment:** [Current position with confidence level] -**Expert Recommendation:** [Recommended position with reasoning] -**Key Considerations:** [Main factors to consider] - -**My Analysis Indicates:** [Brief summary of why I recommend this position] - -**The Decision is Yours:** While I provide expert guidance, the final spectrum position should reflect your vision for the workflow." - -**B. User Choice Confirmation:** -"**Where would you like to position this workflow on the Intent vs Prescriptive Spectrum?** - -**Options:** - -1. **Keep Current Position** - [Current position] - Stay with current approach -2. **Move to Recommended** - [Recommended position] - Adopt my expert recommendation -3. **Move Toward Intent-Based** - Increase creative freedom and adaptation -4. **Move Toward Prescriptive** - Increase consistency and control -5. **Custom Position** - Specify your preferred approach - -**Please select your preferred spectrum position (1-5):**" - -### 6. Document Spectrum Decision - -**A. Record User Decision:** -"**Spectrum Position Decision:** -**User Choice:** [Selected option] -**Final Position:** [Confirmed spectrum position] -**Rationale:** [User's reasoning, if provided] -**Implementation Notes:** [What this means for workflow design]" - -**B. Update Compliance Report:** -Append to {complianceReportFile}: - -```markdown -## Intent vs Prescriptive Spectrum Analysis - -### Current Position Assessment - -**Analyzed Position:** [Current spectrum position] -**Evidence:** [Specific examples from workflow analysis] -**Confidence Level:** [High/Medium/Low based on clarity of patterns] - -### Expert Recommendation - -**Recommended Position:** [Professional recommendation] -**Reasoning:** [Detailed rationale for recommendation] -**Workflow Type Considerations:** [Specific to this workflow's purpose] - -### User Decision - -**Selected Position:** [User's confirmed choice] -**Rationale:** [User's reasoning or preferences] -**Implementation Guidance:** [What this means for workflow] - -### Spectrum Validation Results - -✅ Spectrum position is intentional and understood -✅ User educated on implications of their choice -✅ Implementation guidance provided for final position -✅ Decision documented for future reference -``` - -### 7. Continuation Confirmation - -"**Spectrum Validation Complete:** - -- **Final Position:** [Confirmed spectrum position] -- **User Understanding:** Confirmed implications and benefits -- **Implementation Ready:** Guidance provided for maintaining position - -**Ready for Phase 6:** Web Subprocess Validation analysis - -- Flow validation and completion paths -- Goal alignment and optimization assessment -- Meta-workflow failure analysis and improvement recommendations - -**Select an Option:** [C] Continue to Web Subprocess Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save spectrum decision to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current spectrum findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [spectrum position confirmed with user understanding], will you then load and read fully `{nextStepFile}` to execute and begin Web Subprocess Validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Comprehensive spectrum position analysis with evidence-based reasoning -- Expert recommendation provided with specific rationale and examples -- User educated on spectrum implications for their workflow type -- User makes informed decision about spectrum positioning -- Spectrum decision documented with implementation guidance -- User understands benefits and trade-offs of their choice - -### ❌ SYSTEM FAILURE: - -- Making spectrum recommendations without analyzing actual workflow content -- Not providing evidence-based reasoning for assessment -- Failing to educate user on spectrum implications -- Proceeding without user confirmation of spectrum position -- Not documenting user decision for future reference - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md deleted file mode 100644 index c9b84af5..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +++ /dev/null @@ -1,361 +0,0 @@ ---- -name: 'step-06-web-subprocess-validation' -description: 'Analyze web search utilization and subprocess optimization opportunities across workflow steps' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-web-subprocess-validation.md' -nextStepFile: '{workflow_path}/steps/step-07-holistic-analysis.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowStepsPath: '{target_workflow_steps_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -intentSpectrum: '{project-root}/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md' ---- - -# Step 6: Web Search & Subprocess Optimization Analysis - -## STEP GOAL: - -Analyze each workflow step for optimal web search utilization and subprocess usage patterns, ensuring LLM resources are used efficiently while avoiding unnecessary searches or processing delays. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a performance optimization specialist and resource efficiency analyst -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in LLM optimization, web search strategy, and subprocess utilization -- ✅ User brings their workflow and needs efficiency recommendations - -### Step-Specific Rules: - -- 🎯 Focus only on web search necessity and subprocess optimization opportunities -- 🚫 FORBIDDEN to recommend web searches when LLM knowledge is sufficient -- 💬 Approach: Analytical and optimization-focused with clear efficiency rationale -- 📋 Use subprocesses when analyzing multiple steps to improve efficiency - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze each step for web search appropriateness vs. LLM knowledge sufficiency -- 💾 Identify subprocess optimization opportunities for parallel processing -- 📖 Use subprocesses/subagents when analyzing multiple steps for efficiency -- 🚫 FORBIDDEN to overlook inefficiencies or recommend unnecessary searches - -## CONTEXT BOUNDARIES: - -- Available context: All workflow step files and subprocess availability -- Focus: Web search optimization and subprocess utilization analysis -- Limits: Resource optimization analysis only, holistic workflow analysis comes next -- Dependencies: Completed Intent Spectrum validation from previous phase - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Web Search & Subprocess Analysis - -"Beginning **Phase 5: Web Search & Subprocess Optimization Analysis** -Target: `{target_workflow_name}` - -Analyzing each workflow step for: - -- Appropriate web search utilization vs. unnecessary searches -- Subprocess optimization opportunities for efficiency -- LLM resource optimization patterns -- Performance bottlenecks and speed improvements - -**Note:** Using subprocess analysis for efficient multi-step evaluation..." - -### 2. Web Search Necessity Analysis - -**A. Intelligent Search Assessment Criteria:** - -For each step, analyze web search appropriateness using these criteria: - -"**Web Search Appropriateness Analysis:** - -- **Knowledge Currency:** Is recent/real-time information required? -- **Specific Data Needs:** Are there specific facts/data not in LLM training? -- **Verification Requirements:** Does the task require current verification? -- **LLM Knowledge Sufficiency:** Can LLM adequately handle with existing knowledge? -- **Search Cost vs. Benefit:** Is search time worth the information gain?" - -**B. Step-by-Step Web Search Analysis:** - -Using subprocess for parallel analysis of multiple steps: - -"**Analyzing [number] steps for web search optimization...**" - -For each step file: - -```markdown -**Step:** {step_filename} - -**Current Web Search Usage:** - -- [Explicit web search instructions found] -- [Search frequency and scope] -- [Search-specific topics/queries] - -**Intelligent Assessment:** - -- **Appropriate Searches:** [Searches that are truly necessary] -- **Unnecessary Searches:** [Searches LLM could handle internally] -- **Optimization Opportunities:** [How to improve search efficiency] - -**Recommendations:** - -- **Keep:** [Essential web searches] -- **Remove:** [Unnecessary searches that waste time] -- **Optimize:** [Searches that could be more focused/efficient] -``` - -### 3. Subprocess & Parallel Processing Analysis - -**A. Subprocess Opportunity Identification:** - -"**Subprocess Optimization Analysis:** -Looking for opportunities where multiple steps or analyses can run simultaneously..." - -**Analysis Categories:** - -- **Parallel Step Execution:** Can any steps run simultaneously? -- **Multi-faceted Analysis:** Can single step analyses be broken into parallel sub-tasks? -- **Batch Processing:** Can similar operations be grouped for efficiency? -- **Background Processing:** Can any analyses run while user interacts? - -**B. Implementation Patterns:** - -```markdown -**Subprocess Implementation Opportunities:** - -**Multi-Step Validation:** -"Use subprocesses when checking 6+ validation items - just need results back" - -- Current: Sequential processing of all validation checks -- Optimized: Parallel subprocess analysis for faster completion - -**Parallel User Assistance:** - -- Can user interaction continue while background processing occurs? -- Can multiple analyses run simultaneously during user wait times? - -**Batch Operations:** - -- Can similar file operations be grouped? -- Can multiple data sources be processed in parallel? -``` - -### 4. LLM Resource Optimization Analysis - -**A. Context Window Optimization:** - -"**LLM Resource Efficiency Analysis:** -Analyzing how each step uses LLM resources efficiently..." - -**Optimization Areas:** - -- **JIT Loading:** Are references loaded only when needed? -- **Context Management:** Is context used efficiently vs. wasted? -- **Memory Efficiency:** Can large analyses be broken into smaller, focused tasks? -- **Parallel Processing:** Can LLM instances work simultaneously on different aspects? - -**B. Speed vs. Quality Trade-offs:** - -"**Performance Optimization Assessment:** - -- **Speed-Critical Steps:** Which steps benefit most from subprocess acceleration? -- **Quality-Critical Steps:** Which steps need focused LLM attention? -- **Parallel Candidates:** Which analyses can run without affecting user experience? -- **Background Processing:** What can happen while user is reading/responding?" - -### 5. Step-by-Step Optimization Recommendations - -**A. Using Subprocess for Efficient Analysis:** - -"**Processing all steps for optimization opportunities using subprocess analysis...**" - -**For each workflow step, analyze:** - -**1. Web Search Optimization:** - -```markdown -**Step:** {step_name} -**Current Search Usage:** {current_search_instructions} -**Intelligent Assessment:** {is_search_necessary} -**Recommendation:** - -- **Keep essential searches:** {specific_searches_to_keep} -- **Remove unnecessary searches:** {searches_to_remove} -- **Optimize search queries:** {improved_search_approach} -``` - -**2. Subprocess Opportunities:** - -```markdown -**Parallel Processing Potential:** - -- **Can run with user interaction:** {yes/no_specifics} -- **Can batch with other steps:** {opportunities} -- **Can break into sub-tasks:** {subtask_breakdown} -- **Background processing:** {what_can_run_in_background} -``` - -**3. LLM Efficiency:** - -```markdown -**Resource Optimization:** - -- **Context efficiency:** {current_vs_optimal} -- **Processing time:** {estimated_improvements} -- **User experience impact:** {better/same/worse} -``` - -### 6. Aggregate Optimization Analysis - -**A. Web Search Optimization Summary:** - -"**Web Search Optimization Results:** - -- **Total Steps Analyzed:** [number] -- **Steps with Web Searches:** [number] -- **Unnecessary Searches Found:** [number] -- **Optimization Opportunities:** [number] -- **Estimated Time Savings:** [time_estimate]" - -**B. Subprocess Implementation Summary:** - -"**Subprocess Optimization Results:** - -- **Parallel Processing Opportunities:** [number] -- **Batch Processing Groups:** [number] -- **Background Processing Tasks:** [number] -- **Estimated Performance Improvement:** [percentage_improvement]" - -### 7. User-Facing Optimization Report - -**A. Key Efficiency Findings:** - -"**Optimization Analysis Summary:** - -**Web Search Efficiency:** - -- **Current Issues:** [unnecessary searches wasting time] -- **Recommendations:** [specific improvements] -- **Expected Benefits:** [faster response, better user experience] - -**Processing Speed Improvements:** - -- **Parallel Processing Gains:** [specific opportunities] -- **Background Processing Benefits:** [user experience improvements] -- **Resource Optimization:** [LLM efficiency gains] - -**Implementation Priority:** - -1. **High Impact, Low Effort:** [Quick wins] -2. **High Impact, High Effort:** [Major improvements] -3. **Low Impact, Low Effort:** [Fine-tuning] -4. **Future Considerations:** [Advanced optimizations]" - -### 8. Document Optimization Findings - -Append to {complianceReportFile}: - -```markdown -## Web Search & Subprocess Optimization Analysis - -### Web Search Optimization - -**Unnecessary Searches Identified:** [number] -**Essential Searches to Keep:** [specific_list] -**Optimization Recommendations:** [detailed_suggestions] -**Estimated Time Savings:** [time_improvement] - -### Subprocess Optimization Opportunities - -**Parallel Processing:** [number] opportunities identified -**Batch Processing:** [number] grouping opportunities -**Background Processing:** [number] background task opportunities -**Performance Improvement:** [estimated_improvement_percentage]% - -### Resource Efficiency Analysis - -**Context Optimization:** [specific_improvements] -**LLM Resource Usage:** [efficiency_gains] -**User Experience Impact:** [positive_changes] - -### Implementation Recommendations - -**Immediate Actions:** [quick_improvements] -**Strategic Improvements:** [major_optimizations] -**Future Enhancements:** [advanced_optimizations] -``` - -### 9. Continuation Confirmation - -"**Web Search & Subprocess Analysis Complete:** - -- **Web Search Optimization:** [summary of improvements] -- **Subprocess Opportunities:** [number of optimization areas] -- **Performance Impact:** [expected efficiency gains] -- **User Experience Benefits:** [specific improvements] - -**Ready for Phase 7:** Holistic workflow analysis - -- Flow validation and completion paths -- Goal alignment with optimized resources -- Meta-workflow failure analysis -- Strategic recommendations with efficiency considerations - -**Select an Option:** [C] Continue to Holistic Analysis [X] Exit" - -## Menu Handling Logic: - -- IF C: Save optimization findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [web search and subprocess analysis complete with optimization recommendations documented], will you then load and read fully `{nextStepFile}` to execute and begin holistic analysis phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Intelligent assessment of web search necessity vs. LLM knowledge sufficiency -- Identification of unnecessary web searches that waste user time -- Discovery of subprocess optimization opportunities for parallel processing -- Analysis of LLM resource efficiency patterns -- Specific, actionable optimization recommendations provided -- Performance impact assessment with estimated improvements -- User experience benefits clearly articulated - -### ❌ SYSTEM FAILURE: - -- Recommending web searches when LLM knowledge is sufficient -- Missing subprocess optimization opportunities -- Not using subprocess analysis when evaluating multiple steps -- Overlooking LLM resource inefficiencies -- Providing vague or non-actionable optimization recommendations -- Failing to assess impact on user experience - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md deleted file mode 100644 index 005b852f..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -name: 'step-07-holistic-analysis' -description: 'Analyze workflow flow, goal alignment, and meta-workflow failures' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-07-holistic-analysis.md' -nextStepFile: '{workflow_path}/steps/step-08-generate-report.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowFile: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -intentSpectrum: '{project-root}/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md' ---- - -# Step 7: Holistic Workflow Analysis - -## STEP GOAL: - -Perform comprehensive workflow analysis including flow validation, goal alignment assessment, optimization opportunities, and meta-workflow failure identification to provide complete compliance picture. - -## 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 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring holistic workflow analysis and optimization expertise -- ✅ User brings their workflow and needs comprehensive assessment - -### Step-Specific Rules: - -- 🎯 Focus on holistic analysis beyond template compliance -- 🚫 FORBIDDEN to skip flow validation or optimization assessment -- 💬 Approach: Systematic end-to-end workflow analysis -- 📋 Identify meta-workflow failures and improvement opportunities - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze complete workflow flow from start to finish -- 💾 Validate goal alignment and optimization opportunities -- 📖 Identify what meta-workflows (create/edit) should have caught -- 🚫 FORBIDDEN to provide superficial analysis without specific recommendations - -## CONTEXT BOUNDARIES: - -- Available context: Complete workflow analysis from previous phases -- Focus: Holistic workflow optimization and meta-process improvement -- Limits: Analysis phase only, report generation comes next -- Dependencies: Completed workflow.md and step validation phases - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Holistic Analysis - -"Beginning **Phase 3: Holistic Workflow Analysis** -Target: `{target_workflow_name}` - -Analyzing workflow from multiple perspectives: - -- Flow and completion validation -- Goal alignment assessment -- Optimization opportunities -- Meta-workflow failure analysis..." - -### 2. Workflow Flow Validation - -**A. Completion Path Analysis:** -Trace all possible paths through the workflow: - -"**Flow Validation Analysis:**" - -- Does every step have a clear continuation path? -- Do all menu options have valid destinations? -- Are there any orphaned steps or dead ends? -- Can the workflow always reach a successful completion? - -**Document issues:** - -- **Critical:** Steps without completion paths -- **Major:** Inconsistent menu handling or broken references -- **Minor:** Inefficient flow patterns - -**B. Sequential Logic Validation:** -Check step sequence logic: - -- Does step order make logical sense? -- Are dependencies properly structured? -- Is information flow between steps optimal? -- Are there unnecessary steps or missing functionality? - -### 3. Goal Alignment Assessment - -**A. Stated Goal Analysis:** -Compare workflow.md goal with actual implementation: - -"**Goal Alignment Analysis:**" - -- **Stated Goal:** [quote from workflow.md] -- **Actual Implementation:** [what the workflow actually does] -- **Alignment Score:** [percentage match] -- **Gap Analysis:** [specific misalignments] - -**B. User Experience Assessment:** -Evaluate workflow from user perspective: - -- Is the workflow intuitive and easy to follow? -- Are user inputs appropriately requested? -- Is feedback clear and timely? -- Is the workflow efficient for the stated purpose? - -### 4. Optimization Opportunities - -**A. Efficiency Analysis:** -"**Optimization Assessment:**" - -- **Step Consolidation:** Could any steps be combined? -- **Parallel Processing:** Could any operations run simultaneously? -- **JIT Loading:** Are references loaded optimally? -- **User Experience:** Where could user experience be improved? - -**B. Architecture Improvements:** - -- **Template Usage:** Are templates used optimally? -- **Output Management:** Are outputs appropriate and necessary? -- **Error Handling:** Is error handling comprehensive? -- **Extensibility:** Can the workflow be easily extended? - -### 5. Meta-Workflow Failure Analysis - -**CRITICAL SECTION:** Identify what create/edit workflows should have caught - -"**Meta-Workflow Failure Analysis:** -**Issues that should have been prevented by create-workflow/edit-workflow:**" - -**A. Create-Workflow Failures:** - -- Missing frontmatter fields that should be validated during creation -- Incorrect path variable formats that should be standardized -- Template usage violations that should be caught during design -- Menu pattern deviations that should be enforced during build -- Workflow type mismatches that should be detected during planning - -**B. Edit-Workflow Failures (if applicable):** - -- Introduced compliance violations during editing -- Breaking template structure during modifications -- Inconsistent changes that weren't validated -- Missing updates to dependent files/references - -**C. Systemic Process Improvements:** -"**Recommended Improvements for Meta-Workflows:**" - -**For create-workflow:** - -- Add validation step for frontmatter completeness -- Implement path variable format checking -- Add workflow type template usage validation -- Include menu pattern enforcement -- Add flow validation before finalization -- **Add Intent vs Prescriptive spectrum selection early in design process** -- **Include spectrum education for users during workflow creation** -- **Validate spectrum consistency throughout workflow design** - -**For edit-workflow:** - -- Add compliance validation before applying changes -- Include template structure checking during edits -- Implement cross-file consistency validation -- Add regression testing for compliance -- **Validate that edits maintain intended spectrum position** -- **Check for unintended spectrum shifts during modifications** - -### 6. Severity-Based Recommendations - -"**Strategic Recommendations by Priority:**" - -**IMMEDIATE (Critical) - Must Fix for Workflow to Function:** - -1. [Most critical issue with specific fix] -2. [Second critical issue with specific fix] - -**HIGH PRIORITY (Major) - Significantly Impacts Quality:** - -1. [Major issue affecting maintainability] -2. [Major issue affecting user experience] - -**MEDIUM PRIORITY (Minor) - Standards Compliance:** - -1. [Minor template compliance issue] -2. [Cosmetic or consistency improvements] - -### 7. Continuation Confirmation - -"**Phase 5 Complete:** Holistic analysis finished - -- **Flow Validation:** [summary findings] -- **Goal Alignment:** [alignment percentage and key gaps] -- **Optimization Opportunities:** [number key improvements identified] -- **Meta-Workflow Failures:** [number issues that should have been prevented] - -**Ready for Phase 8:** Comprehensive compliance report generation - -- All findings compiled into structured report -- Severity-ranked violation list -- Specific fix recommendations -- Meta-workflow improvement suggestions - -**Select an Option:** [C] Continue to Report Generation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save holistic analysis findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [holistic analysis complete with meta-workflow failures identified], will you then load and read fully `{nextStepFile}` to execute and begin comprehensive report generation. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete workflow flow validation with all paths traced -- Goal alignment assessment with specific gap analysis -- Optimization opportunities identified with prioritized recommendations -- Meta-workflow failures documented with improvement suggestions -- Strategic recommendations provided by severity priority -- User ready for comprehensive report generation - -### ❌ SYSTEM FAILURE: - -- Skipping flow validation or goal alignment analysis -- Not identifying meta-workflow failure opportunities -- Failing to provide specific, actionable recommendations -- Missing strategic prioritization of improvements -- Providing superficial analysis without depth - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md deleted file mode 100644 index 43bfd3e5..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -name: 'step-08-generate-report' -description: 'Generate comprehensive compliance report with fix recommendations' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-08-generate-report.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowFile: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 8: Comprehensive Compliance Report Generation - -## STEP GOAL: - -Generate comprehensive compliance report compiling all validation findings, provide severity-ranked fix recommendations, and offer concrete next steps for achieving full compliance. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring report generation and strategic recommendation expertise -- ✅ User brings their validated workflow and needs actionable improvement plan - -### Step-Specific Rules: - -- 🎯 Focus only on compiling comprehensive compliance report -- 🚫 FORBIDDEN to generate report without including all findings from previous phases -- 💬 Approach: Systematic compilation with clear, actionable recommendations -- 📋 Ensure report is complete, accurate, and immediately useful - -## EXECUTION PROTOCOLS: - -- 🎯 Compile all findings from previous validation phases -- 💾 Generate structured compliance report with clear sections -- 📖 Provide severity-ranked recommendations with specific fixes -- 🚫 FORBIDDEN to overlook any validation findings or recommendations - -## CONTEXT BOUNDARIES: - -- Available context: Complete validation findings from all previous phases -- Focus: Comprehensive report generation and strategic recommendations -- Limits: Report generation only, no additional validation -- Dependencies: Successful completion of all previous validation phases - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Report Generation - -"**Phase 5: Comprehensive Compliance Report Generation** -Target: `{target_workflow_name}` - -Compiling all validation findings into structured compliance report with actionable recommendations..." - -### 2. Generate Compliance Report Structure - -Create comprehensive report at {complianceReportFile}: - -```markdown -# Workflow Compliance Report - -**Workflow:** {target_workflow_name} -**Date:** {current_date} -**Standards:** BMAD workflow-template.md and step-template.md - ---- - -## Executive Summary - -**Overall Compliance Status:** [PASS/FAIL/PARTIAL] -**Critical Issues:** [number] - Must be fixed immediately -**Major Issues:** [number] - Significantly impacts quality/maintainability -**Minor Issues:** [number] - Standards compliance improvements - -**Compliance Score:** [percentage]% based on template adherence - ---- - -## Phase 1: Workflow.md Validation Results - -### Critical Violations - -[Critical issues with template references and specific fixes] - -### Major Violations - -[Major issues with template references and specific fixes] - -### Minor Violations - -[Minor issues with template references and specific fixes] - ---- - -## Phase 2: Step-by-Step Validation Results - -### Summary by Step - -[Each step file with its violation summary] - -### Most Common Violations - -1. [Most frequent violation type with count] -2. [Second most frequent with count] -3. [Third most frequent with count] - -### Workflow Type Assessment - -**Workflow Type:** [editing/creation/validation/etc.] -**Template Appropriateness:** [appropriate/needs improvement] -**Recommendations:** [specific suggestions] - ---- - -## Phase 3: Holistic Analysis Results - -### Flow Validation - -[Flow analysis findings with specific issues] - -### Goal Alignment - -**Alignment Score:** [percentage]% -**Stated vs. Actual:** [comparison with gaps] - -### Optimization Opportunities - -[Priority improvements with expected benefits] - ---- - -## Meta-Workflow Failure Analysis - -### Issues That Should Have Been Prevented - -**By create-workflow:** - -- [Specific issues that should have been caught during creation] -- [Suggested improvements to create-workflow] - -**By edit-workflow (if applicable):** - -- [Specific issues introduced during editing] -- [Suggested improvements to edit-workflow] - -### Recommended Meta-Workflow Improvements - -[Specific actionable improvements for meta-workflows] - ---- - -## Severity-Ranked Fix Recommendations - -### IMMEDIATE - Critical (Must Fix for Functionality) - -1. **[Issue Title]** - [File: filename.md] - - **Problem:** [Clear description] - - **Template Reference:** [Specific section] - - **Fix:** [Exact action needed] - - **Impact:** [Why this is critical] - -### HIGH PRIORITY - Major (Significantly Impacts Quality) - -1. **[Issue Title]** - [File: filename.md] - - **Problem:** [Clear description] - - **Template Reference:** [Specific section] - - **Fix:** [Exact action needed] - - **Impact:** [Quality/maintainability impact] - -### MEDIUM PRIORITY - Minor (Standards Compliance) - -1. **[Issue Title]** - [File: filename.md] - - **Problem:** [Clear description] - - **Template Reference:** [Specific section] - - **Fix:** [Exact action needed] - - **Impact:** [Standards compliance] - ---- - -## Automated Fix Options - -### Fixes That Can Be Applied Automatically - -[List of violations that can be automatically corrected] - -### Fixes Requiring Manual Review - -[List of violations requiring human judgment] - ---- - -## Next Steps Recommendation - -**Recommended Approach:** - -1. Fix all Critical issues immediately (workflow may not function) -2. Address Major issues for reliability and maintainability -3. Implement Minor issues for full standards compliance -4. Update meta-workflows to prevent future violations - -**Estimated Effort:** - -- Critical fixes: [time estimate] -- Major fixes: [time estimate] -- Minor fixes: [time estimate] -``` - -### 3. Final Report Summary - -"**Compliance Report Generated:** `{complianceReportFile}` - -**Report Contents:** - -- ✅ Complete violation analysis from all validation phases -- ✅ Severity-ranked recommendations with specific fixes -- ✅ Meta-workflow failure analysis with improvement suggestions -- ✅ Automated vs manual fix categorization -- ✅ Strategic next steps and effort estimates - -**Key Findings:** - -- **Overall Compliance Score:** [percentage]% -- **Critical Issues:** [number] requiring immediate attention -- **Major Issues:** [number] impacting quality -- **Minor Issues:** [number] for standards compliance - -**Meta-Workflow Improvements Identified:** [number] specific suggestions - -### 4. Offer Next Steps - -"**Phase 6 Complete:** Comprehensive compliance analysis finished -All 8 validation phases completed with full report generation - -**Compliance Analysis Complete. What would you like to do next?**" - -**Available Options:** - -- **[A] Apply Automated Fixes** - I can automatically correct applicable violations -- **[B] Launch edit-agent** - Edit the workflow with this compliance report as guidance -- **[C] Manual Review** - Use the report for manual fixes at your pace -- **[D] Update Meta-Workflows** - Strengthen create/edit workflows with identified improvements - -**Recommendation:** Start with Critical issues, then proceed through High and Medium priority items systematically." - -### 5. Report Completion Options - -Display: "**Select an Option:** [A] Apply Automated Fixes [B] Launch Edit-Agent [C] Manual Review [D] Update Meta-Workflows [X] Exit" - -## Menu Handling Logic: - -- IF A: Begin applying automated fixes from the report -- IF B: Launch edit-agent workflow with this compliance report as context -- IF C: End workflow with guidance for manual review using the report -- IF D: Provide specific recommendations for meta-workflow improvements -- IF X: Save report and end workflow gracefully - -## CRITICAL STEP COMPLETION NOTE - -The workflow is complete when the comprehensive compliance report has been generated and the user has selected their preferred next step. The report contains all findings, recommendations, and strategic guidance needed to achieve full BMAD compliance. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Comprehensive compliance report generated with all validation findings -- Severity-ranked fix recommendations provided with specific actions -- Meta-workflow failure analysis completed with improvement suggestions -- Clear next steps offered based on user preferences -- Report saved and accessible for future reference -- User has actionable plan for achieving full compliance - -### ❌ SYSTEM FAILURE: - -- Generating incomplete report without all validation findings -- Missing severity rankings or specific fix recommendations -- Not providing clear next steps or options -- Failing to include meta-workflow improvement suggestions -- Creating report that is not immediately actionable - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md b/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md deleted file mode 100644 index 2fd5e8a4..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +++ /dev/null @@ -1,140 +0,0 @@ -# Workflow Compliance Report Template - -**Workflow:** {workflow_name} -**Date:** {validation_date} -**Standards:** BMAD workflow-template.md and step-template.md -**Report Type:** Comprehensive Compliance Validation - ---- - -## Executive Summary - -**Overall Compliance Status:** {compliance_status} -**Critical Issues:** {critical_count} - Must be fixed immediately -**Major Issues:** {major_count} - Significantly impacts quality/maintainability -**Minor Issues:** {minor_count} - Standards compliance improvements - -**Compliance Score:** {compliance_score}% based on template adherence - -**Workflow Type Assessment:** {workflow_type} - {type_appropriateness} - ---- - -## Phase 1: Workflow.md Validation Results - -### Template Adherence Analysis - -**Reference Standard:** {workflow_template_path} - -### Critical Violations - -{critical_violations} - -### Major Violations - -{major_violations} - -### Minor Violations - -{minor_violations} - ---- - -## Phase 2: Step-by-Step Validation Results - -### Summary by Step - -{step_validation_summary} - -### Most Common Violations - -1. {most_common_violation_1} -2. {most_common_violation_2} -3. {most_common_violation_3} - -### Workflow Type Appropriateness - -**Analysis:** {workflow_type_analysis} -**Recommendations:** {type_recommendations} - ---- - -## Phase 3: Holistic Analysis Results - -### Flow Validation - -{flow_validation_results} - -### Goal Alignment - -**Stated Goal:** {stated_goal} -**Actual Implementation:** {actual_implementation} -**Alignment Score:** {alignment_score}% -**Gap Analysis:** {gap_analysis} - -### Optimization Opportunities - -{optimization_opportunities} - ---- - -## Meta-Workflow Failure Analysis - -### Issues That Should Have Been Prevented - -**By create-workflow:** -{create_workflow_failures} - -**By edit-workflow:** -{edit_workflow_failures} - -### Recommended Meta-Workflow Improvements - -{meta_workflow_improvements} - ---- - -## Severity-Ranked Fix Recommendations - -### IMMEDIATE - Critical (Must Fix for Functionality) - -{critical_recommendations} - -### HIGH PRIORITY - Major (Significantly Impacts Quality) - -{major_recommendations} - -### MEDIUM PRIORITY - Minor (Standards Compliance) - -{minor_recommendations} - ---- - -## Automated Fix Options - -### Fixes That Can Be Applied Automatically - -{automated_fixes} - -### Fixes Requiring Manual Review - -{manual_fixes} - ---- - -## Next Steps Recommendation - -**Recommended Approach:** -{recommended_approach} - -**Estimated Effort:** - -- Critical fixes: {critical_effort} -- Major fixes: {major_effort} -- Minor fixes: {minor_effort} - ---- - -**Report Generated:** {timestamp} -**Validation Engine:** BMAD Workflow Compliance Checker -**Next Review Date:** {next_review_date} diff --git a/src/modules/bmb/workflows/workflow-compliance-check/workflow.md b/src/modules/bmb/workflows/workflow-compliance-check/workflow.md deleted file mode 100644 index 5fc29ff1..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: workflow-compliance-check -description: Systematic validation of workflows against BMAD standards with adversarial analysis and detailed reporting -web_bundle: false ---- - -# Workflow Compliance Check - -**Goal:** Systematically validate workflows against BMAD standards through adversarial analysis, generating detailed compliance reports with severity-ranked violations and improvement recommendations. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a compliance validator and quality assurance specialist collaborating with a workflow owner. This is a partnership, not a client-vendor relationship. You bring expertise in BMAD standards, workflow architecture, and systematic validation, while the user brings their workflow and specific compliance concerns. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in context for compliance checking (no output file frontmatter needed) -- **Append-Only Building**: Build compliance reports by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-validate-goal.md` to begin the workflow. If the path to a workflow was provided, set `user_provided_path` to that path. diff --git a/src/modules/bmb/workflows/workflow/data/architecture.md b/src/modules/bmb/workflows/workflow/data/architecture.md new file mode 100644 index 00000000..e0d0c2e1 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/architecture.md @@ -0,0 +1,152 @@ +# Workflow Architecture + +**Purpose:** Core structural patterns for BMAD workflows. + +--- + +## Structure + +``` +workflow-folder/ +├── workflow.md # Entry point, configuration +├── steps-c/ # Create flow steps +│ ├── step-01-init.md +│ ├── step-02-[name].md +│ └── step-N-[name].md +├── steps-e/ # Edit flow (if needed) +├── steps-v/ # Validate flow (if needed) +├── data/ # Shared reference files +└── templates/ # Output templates (if needed) +``` + +--- + +## workflow.md File Standards + +**CRITICAL:** The workflow.md file MUST be lean. It is the entry point and should NOT contain: + +- ❌ **Listing of all steps** - This defeats progressive disclosure +- ❌ **Detailed descriptions of what each step does** - Steps are self-documenting +- ❌ **Validation checklists** - These belong in steps-v/, not workflow.md +- ❌ **Implementation details** - These belong in step files + +**The workflow.md SHOULD contain:** +- ✅ Frontmatter: name, description, web_bundle +- ✅ Goal: What the workflow accomplishes +- ✅ Role: Who the AI embodies when running this workflow +- ✅ Meta-context: Background about the architecture (if demonstrating a pattern) +- ✅ Core architecture principles (step-file design, JIT loading, etc.) +- ✅ Initialization/routing: How to start and which step to load first + +**Progressive Disclosure Rule:** +Users should ONLY know about the current step they're executing. The workflow.md routes to the first step, and each step routes to the next. No step lists in workflow.md! + +--- + +## Core Principles + +### 1. Micro-File Design +- Each step is a focused file (~80-200 lines) +- One concept per step +- Self-contained instructions + +### 2. Just-In-Time Loading +- Only current step file is in memory +- Never load future steps until user selects 'C' +- Progressive disclosure - LLM stays focused + +### 3. Sequential Enforcement +- Steps execute in order +- No skipping, no optimization +- Each step completes before next loads + +### 4. State Tracking +For continuable workflows: +```yaml +stepsCompleted: ['step-01-init', 'step-02-gather', 'step-03-design'] +lastStep: 'step-03-design' +lastContinued: '2025-01-02' +``` + +Each step appends its name to `stepsCompleted` before loading next. + +--- + +## Execution Flow + +### Fresh Start +``` +workflow.md → step-01-init.md → step-02-[name].md → ... → step-N-final.md +``` + +### Continuation (Resumed) +``` +workflow.md → step-01-init.md (detects existing) → step-01b-continue.md → [appropriate next step] +``` + +--- + +## Frontmatter Variables + +### Standard (All Workflows) +```yaml +workflow_path: '{project-root}/_bmad/[module]/workflows/[name]' +thisStepFile: '{workflow_path}/steps/step-[N]-[name].md' +nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' +outputFile: '{output_folder}/[output].md' +``` + +### Module-Specific +```yaml +# BMB example: +bmb_creations_output_folder: '{project-root}/_bmad/bmb-creations' +``` + +### Critical Rules +- ONLY variables used in step body go in frontmatter +- All file references use `{variable}` format +- Paths within workflow folder are relative + +--- + +## Menu Pattern + +```markdown +### N. Present MENU OPTIONS + +Display: "**Select:** [A] [action] [P] [action] [C] Continue" + +#### Menu Handling Logic: +- IF A: Execute {task}, then redisplay menu +- IF P: Execute {task}, then redisplay menu +- IF C: Save to {outputFile}, update frontmatter, then load {nextStepFile} +- IF Any other: help user, then redisplay menu + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +``` + +**A/P not needed in:** Step 1 (init), validation sequences, simple data gathering + +--- + +## Output Pattern + +Every step writes to a document BEFORE loading next step: + +1. **Plan-then-build:** Steps append to plan.md → build step consumes plan +2. **Direct-to-final:** Steps append directly to final document + +See: `output-format-standards.md` + +--- + +## Critical Rules + +- 🛑 NEVER load multiple step files simultaneously +- 📖 ALWAYS read entire step file before execution +- 🚫 NEVER skip steps or optimize the sequence +- 💾 ALWAYS update frontmatter when step completes +- ⏸️ ALWAYS halt at menus and wait for input +- 📋 NEVER create mental todos from future steps diff --git a/src/modules/bmb/docs/workflows/common-workflow-tools.csv b/src/modules/bmb/workflows/workflow/data/common-workflow-tools.csv similarity index 100% rename from src/modules/bmb/docs/workflows/common-workflow-tools.csv rename to src/modules/bmb/workflows/workflow/data/common-workflow-tools.csv diff --git a/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md b/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md new file mode 100644 index 00000000..8b2df4ca --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md @@ -0,0 +1,81 @@ +# CSV Data File Standards + +**Purpose:** When workflows need structured data that LLMs cannot generate. + +--- + +## When to Use CSV + +Use CSV for data that is: +- Domain-specific and not in training data +- Too large for prompt context +- Needs structured lookup/reference +- Must be consistent across sessions + +**Don't use for:** +- Web-searchable information +- Common programming syntax +- General knowledge +- Things LLMs can generate + +--- + +## CSV Structure + +```csv +category,name,pattern,description +"collaboration","Think Aloud Protocol","user speaks thoughts → facilitator captures","Make thinking visible during work" +"creative","SCAMPER","substitute→combine→adapt→modify→put→eliminate→reverse","Systematic creative thinking" +``` + +**Rules:** +- Header row required, descriptive column names +- Consistent data types per column +- UTF-8 encoding +- All columns must be used in workflow + +--- + +## Common Use Cases + +### 1. Method Registry +Advanced Elicitation uses CSV to select techniques dynamically: +```csv +category,name,pattern +collaboration,Think Aloud,user speaks thoughts → facilitator captures +advanced,Six Thinking Hats,view problem from 6 perspectives +``` + +### 2. Knowledge Base Index +Map keywords to document locations for surgical lookup: +```csv +keywords,document_path,section +"nutrition,macros",data/nutrition-reference.md,## Daily Targets +``` + +### 3. Configuration Lookup +Map scenarios to parameters: +```csv +scenario,required_steps,output_sections +"2D Platformer",step-01,step-03,step-07,movement,physics,collision +``` + +--- + +## Best Practices + +- Keep files small (<1MB if possible) +- No unused columns +- Document each CSV's purpose +- Validate data quality +- Use efficient encoding (codes vs full descriptions) + +--- + +## Validation Checklist + +For each CSV file: +- [ ] Purpose is essential (can't be generated by LLM) +- [ ] All columns are used somewhere +- [ ] Properly formatted (consistent, UTF-8) +- [ ] Documented with examples diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md similarity index 91% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md index e72c3fe8..a3845ce3 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md @@ -2,18 +2,11 @@ name: 'step-01-init' description: 'Initialize the nutrition plan workflow by detecting continuation state and creating output document' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' +nextStepFile: './step-02-profile.md' +continueFile: './step-01b-continue.md' -# File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-profile.md' -workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/nutrition-plan-{project_name}.md' -templateFile: '{workflow_path}/templates/nutrition-plan.md' -continueFile: '{workflow_path}/steps/step-01b-continue.md' -# Template References -# This step doesn't use content templates, only the main template +templateFile: '../templates/nutrition-plan.md' --- # Step 1: Workflow Initialization diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md similarity index 88% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md index 704aabe7..a1ccef43 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md @@ -2,15 +2,7 @@ name: 'step-01b-continue' description: 'Handle workflow continuation from previous session' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/nutrition-plan-{project_name}.md' -# Template References -# This step doesn't use content templates, reads from existing output file --- # Step 1B: Workflow Continuation @@ -119,15 +111,15 @@ Display: **Resuming workflow - Select an Option:** [C] Continue #### Menu Handling Logic: - IF C: Update frontmatter with continuation info, then load, read entire file, then execute appropriate next step based on `lastStep` - - IF lastStep = "init": load {workflow_path}/step-03-assessment.md - - IF lastStep = "assessment": load {workflow_path}/step-04-strategy.md - - IF lastStep = "strategy": check cooking frequency, then load appropriate step - - IF lastStep = "shopping": load {workflow_path}/step-06-prep-schedule.md + - IF lastStep = "init": load ./step-03-assessment.md + - IF lastStep = "assessment": load ./step-04-strategy.md + - IF lastStep = "strategy": check cooking frequency, then load load ./step-04-shopping.md + - IF lastStep = "shopping": load ./step-06-prep-schedule.md - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN C is selected and continuation analysis is complete, will you then update frontmatter and load, read entire file, then execute the appropriate next step file. +ONLY WHEN C is selected and continuation analysis is complete, will you then update frontmatter and load, read entire file, then execute the appropriate next step file as outlined in menu handling logic. --- diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md similarity index 93% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md index 95a3ca86..4359cd9d 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md @@ -2,13 +2,7 @@ name: 'step-02-profile' description: 'Gather comprehensive user profile information through collaborative conversation' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-02-profile.md' -nextStepFile: '{workflow_path}/steps/step-03-assessment.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-03-assessment.md' outputFile: '{output_folder}/nutrition-plan-{project_name}.md' # Task References @@ -16,7 +10,7 @@ advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitati partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References -profileTemplate: '{workflow_path}/templates/profile-section.md' +profileTemplate: '../templates/profile-section.md' --- # Step 2: User Profile & Goals Collection diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md similarity index 90% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md index f77fd67e..4a06f6ef 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md @@ -2,13 +2,7 @@ name: 'step-03-assessment' description: 'Analyze nutritional requirements, identify restrictions, and calculate target macros' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-assessment.md' -nextStepFile: '{workflow_path}/steps/step-04-strategy.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-04-strategy.md'\ outputFile: '{output_folder}/nutrition-plan-{project_name}.md' # Task References @@ -16,11 +10,11 @@ advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitati partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Data References -dietaryRestrictionsDB: '{workflow_path}/data/dietary-restrictions.csv' -macroCalculatorDB: '{workflow_path}/data/macro-calculator.csv' +dietaryRestrictionsDB: '../data/dietary-restrictions.csv' +macroCalculatorDB: '../data/macro-calculator.csv' # Template References -assessmentTemplate: '{workflow_path}/templates/assessment-section.md' +assessmentTemplate: '../templates/assessment-section.md' --- # Step 3: Dietary Needs & Restrictions Assessment diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md similarity index 91% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md index 08ef67a0..8012ea63 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md @@ -2,14 +2,8 @@ name: 'step-04-strategy' description: 'Design a personalized meal strategy that meets nutritional needs and fits lifestyle' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-strategy.md' -nextStepFile: '{workflow_path}/steps/step-05-shopping.md' -alternateNextStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-05-shopping.md' +alternateNextStepFile: './step-06-prep-schedule.md' outputFile: '{output_folder}/nutrition-plan-{project_name}.md' # Task References @@ -17,10 +11,10 @@ advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitati partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Data References -recipeDatabase: '{workflow_path}/data/recipe-database.csv' +recipeDatabase: '../data/recipe-database.csv' # Template References -strategyTemplate: '{workflow_path}/templates/strategy-section.md' +strategyTemplate: '../templates/strategy-section.md' --- # Step 4: Meal Strategy Creation diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md similarity index 93% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md index 32900904..ab565a63 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md @@ -2,13 +2,7 @@ name: 'step-05-shopping' description: 'Create a comprehensive shopping list that supports the meal strategy' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-shopping.md' -nextStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-06-prep-schedule.md' outputFile: '{output_folder}/nutrition-plan-{project_name}.md' # Task References @@ -16,7 +10,7 @@ advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitati partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References -shoppingTemplate: '{workflow_path}/templates/shopping-section.md' +shoppingTemplate: '../templates/shopping-section.md' --- # Step 5: Shopping List Generation diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md similarity index 94% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md index e7adbf52..4db06828 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md @@ -2,12 +2,6 @@ name: 'step-06-prep-schedule' description: "Create a realistic meal prep schedule that fits the user's lifestyle" -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/nutrition-plan-{project_name}.md' # Task References @@ -15,7 +9,7 @@ advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitati partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References -prepScheduleTemplate: '{workflow_path}/templates/prep-schedule-section.md' +prepScheduleTemplate: '../templates/prep-schedule-section.md' --- # Step 6: Meal Prep Execution Schedule diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/profile-section.md similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/profile-section.md diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md similarity index 100% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md diff --git a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md similarity index 95% rename from src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md rename to src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md index a63fa50f..8c72e740 100644 --- a/src/modules/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md +++ b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md @@ -55,4 +55,4 @@ Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: ### 2. First Step EXECUTION -Load, read the full file and then execute `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md` to begin the workflow. +Load, read the full file and then execute `./steps-c/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md b/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md new file mode 100644 index 00000000..f33d44cb --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md @@ -0,0 +1,179 @@ +# Frontmatter Standards + +**Purpose:** Variables, paths, and frontmatter rules for workflow steps. + +--- + +## Golden Rules + +1. **Only variables USED in the step** may be in frontmatter +2. **All file references MUST use `{variable}` format** - no hardcoded paths +3. **Paths within workflow folder MUST be relative** + +--- + +## Standard Variables (Always Available) + +| Variable | Example Value | +| ----------------- | -------------------------------------- | +| `{project-root}` | `/Users/user/dev/BMAD-METHOD` | +| `{project_name}` | `my-project` | +| `{output_folder}` | `/Users/user/dev/BMAD-METHOD/output` | +| `{user_name}` | `Brian` | +| `{communication_language}` | `english` | +| `{document_output_language}` | `english` | + +--- + +## Module-Specific Variables + +Workflows in a MODULE can access additional variables from its `module.yaml`. + +**BMB Module example:** +```yaml +bmb_creations_output_folder: '{project-root}/_bmad/bmb-creations' +``` + +**Standalone workflows:** Only have access to standard variables. + +--- + +## Frontmatter Structure + +### Required Fields +```yaml +--- +name: 'step-[N]-[name]' +description: '[what this step does]' +--- +``` + +### File References (ONLY if used in this step) +```yaml +--- +# File References +workflow_path: '{project-root}/_bmad/[module]/workflows/[workflow-name]' +thisStepFile: '{workflow_path}/steps/step-[N]-[name].md' +nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' +workflowFile: '{workflow_path}/workflow.md' +outputFile: '{output_folder}/[output-name].md' + +# Task References (IF USED) +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' + +# Template References (IF USED) +someTemplate: '{workflow_path}/templates/[template].md' + +# Data References (IF USED) +someData: '{workflow_path}/data/[data].csv' +--- +``` + +--- + +## Critical Rule: Unused Variables Forbidden + +### ❌ VIOLATION +```yaml +--- +outputFile: '{output_folder}/output.md' +partyModeWorkflow: '{project-root}/.../party-mode/workflow.md' # ❌ NOT USED! +--- +# Step body never mentions {partyModeWorkflow} +``` + +### ✅ CORRECT +```yaml +--- +outputFile: '{output_folder}/output.md' +--- +# Step body uses {outputFile} +``` + +--- + +## Path Rules + +### 1. Paths Within Workflow Folder = RELATIVE +```yaml +# ❌ WRONG - absolute for same-folder +someTemplate: '{project-root}/_bmad/bmb/workflows/my-workflow/templates/template.md' + +# ✅ CORRECT - relative or via workflow_path +someTemplate: '{workflow_path}/templates/template.md' +``` + +### 2. External References = Full Variable Paths +```yaml +# ✅ CORRECT +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +``` + +### 3. Output Files = Use output_folder Variable +```yaml +# ✅ CORRECT +outputFile: '{output_folder}/workflow-output-{project_name}.md' +``` + +--- + +## Defining New Variables + +Steps can define NEW variables that future steps will use. + +**Step 01 defines:** +```yaml +--- +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{workflow_name}' +--- +``` + +**Step 02 uses:** +```yaml +--- +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/plan.md' +--- +``` + +--- + +## Continuable Workflow Frontmatter + +```yaml +--- +stepsCompleted: ['step-01-init', 'step-02-gather', 'step-03-design'] +lastStep: 'step-03-design' +lastContinued: '2025-01-02' +date: '2025-01-01' +--- +``` + +**Step tracking:** Each step appends its NAME to `stepsCompleted`. + +--- + +## Variable Naming + +Use `snake_case` with descriptive prefixes: + +| Pattern | Usage | Example | +| --------- | ---------------------- | -------------------------- | +| `{*_path}` | Folder paths | `workflow_path`, `data_path` | +| `{*_file}` | Files | `outputFile`, `planFile` | +| `{*_template}` | Templates | `profileTemplate` | +| `{*_data}` | Data files | `dietaryData` | + +--- + +## Validation Checklist + +For every step frontmatter: +- [ ] `name` present, kebab-case +- [ ] `description` present +- [ ] All variables in frontmatter ARE used in step body +- [ ] All file references use `{variable}` format +- [ ] Paths within workflow folder are relative +- [ ] External paths use `{project-root}` variable +- [ ] Module variables only if workflow belongs to that module diff --git a/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md b/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md new file mode 100644 index 00000000..12f19d78 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md @@ -0,0 +1,269 @@ +# Input Document Discovery Standards + +**Purpose:** How workflows discover, validate, and select input documents from prior workflows or external sources. + +--- + +## Discovery Patterns + +### Pattern 1: Prior Workflow Output +**Use when:** Workflow is part of a sequence (e.g., PRD → Architecture → Epics) + +**Example:** BMM module pipeline - each of these are a workflow with many steps: +``` +brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning +``` + +Each workflow checks for output from prior workflow(s). + +### Pattern 2: Module Folder Search +**Use when:** Documents stored in known project location + +**Example:** Manager review workflow searches `{project_folder}/employee-notes/` + +### Pattern 3: User-Specified Paths +**Use when:** User provides document locations + +**Example:** Tax workflow asks for financial statement paths + +### Pattern 4: Pattern-Based Discovery +**Use when:** Search by file naming pattern + +**Example:** Find all `*-brief.md` files in `{planning_artifacts}/` + +--- + +## Discovery Step Pattern + +**When:** Step 1 (init) or Step 2 (discovery) + +**Frontmatter:** +```yaml +--- +# Input discovery variables +inputDocuments: [] # Populated with discovered docs +requiredInputCount: 1 # Minimum required to proceed +optionalInputCount: 0 # Additional docs user may provide +moduleInputFolder: '{planning_artifacts}' # Where to search +inputFilePatterns: # File patterns to match + - '*-prd.md' + - '*-ux.md' +--- +``` + +**Discovery Logic:** +```markdown +## 1. Check for Known Prior Workflow Outputs + +Search in order: +1. {module_output_folder}/[known-prior-workflow-output].md +2. {project_folder}/[standard-locations]/ +3. {planning_artifacts}/ +4. User-provided paths + +## 2. Pattern-Based Search + +If no known prior workflow, search by patterns: +- Look for files matching {inputFilePatterns} +- Search in {moduleInputFolder} +- Search in {project_folder}/docs/ + +## 3. Present Findings to User + +"Found these documents that may be relevant: +- [1] prd-my-project.md (created 3 days ago) +- [2] ux-research.md (created 1 week ago) +- [3] competitor-analysis.md + +Which would you like to use? You can select multiple, or provide additional paths." + +## 4. Confirm and Load + +User confirms selection → Load selected documents +Add to {inputDocuments} array in output frontmatter +``` + +--- + +## Required vs Optional Inputs + +### Required Inputs +Workflow cannot proceed without these. + +**Example:** Architecture workflow requires PRD + +```markdown +## INPUT REQUIREMENT: + +This workflow requires a Product Requirements Document to proceed. + +Searching for PRD in: +- {bmm_creations_output_folder}/prd-*.md +- {planning_artifacts}/*-prd.md +- {project_folder}/docs/*-prd.md + +[If found:] +"Found PRD: prd-my-project.md. Use this?" +[If not found:] +"No PRD found. This workflow requires a PRD to continue. +Please provide the path to your PRD, or run the PRD workflow first." +``` + +### Optional Inputs +Workflow can proceed without these, but user may include. + +**Example:** UX workflow can use research docs if available + +```markdown +## OPTIONAL INPUTS: + +This workflow can incorporate research documents if available. + +Searching for research in: +- {bmm_creations_output_folder}/research-*.md +- {project_folder}/research/ + +[If found:] +"Found these research documents: +- [1] user-interviews.md +- [2] competitive-analysis.md +Include any? (None required to proceed)" +``` + +--- + +## Module Workflow Chaining + +**For modules with sequential workflows:** + +**Frontmatter in workflow.md:** +```yaml +--- +## INPUT FROM PRIOR WORKFLOFS + +### Required Inputs: +- {module_output_folder}/prd-{project_name}.md + +### Optional Inputs: +- {module_output_folder}/ux-research-{project_name}.md +- {project_folder}/docs/competitor-analysis.md +--- +``` + +**Step 1 discovery:** +```markdown +## 1. Discover Prior Workflow Outputs + +Check for required inputs: +1. Look for {module_output_folder}/prd-{project_name}.md +2. If missing → Error: "Please run PRD workflow first" +3. If found → Confirm with user + +Check for optional inputs: +1. Search {module_output_folder}/ for research-*.md +2. Search {project_folder}/docs/ for *-analysis.md +3. Present findings to user +4. Add selections to {inputDocuments} +``` + +--- + +## Input Validation + +After discovery, validate inputs: + +```markdown +## INPUT VALIDATION: + +For each discovered document: +1. Load and read frontmatter +2. Check workflowType field (should match expected) +3. Check completeness (stepsCompleted should be complete) +4. Check date (warn if document is very old) + +[If validation fails:] +"Document prd-my-project.md appears incomplete. +Last step: step-06 (of 11) +Recommend completing PRD workflow before proceeding. +Proceed anyway? [Y]es [N]o" +``` + +--- + +## Multiple Input Selection + +**When user can select multiple documents:** + +```markdown +## Document Selection + +"Found these relevant documents: +[1] prd-my-project.md (3 days ago) ✓ Recommended +[2] prd-v1.md (2 months ago) ⚠ Older version +[3] ux-research.md (1 week ago) + +Enter numbers to include (comma-separated), or 'none' to skip: +> 1, 3 + +Selected: prd-my-project.md, ux-research.md" +``` + +**Track in frontmatter:** +```yaml +--- +inputDocuments: + - path: '{output_folder}/prd-my-project.md' + type: 'prd' + source: 'prior-workflow' + selected: true + - path: '{output_folder}/ux-research.md' + type: 'research' + source: 'prior-workflow' + selected: true +--- +``` + +--- + +## Search Path Variables + +Common module variables for input discovery: + +| Variable | Purpose | +| ------------------------ | -------------------------- | +| `{module_output_folder}` | Prior workflow outputs | +| `{planning_artifacts}` | General planning docs | +| `{project_folder}/docs` | Project documentation | +| `{product_knowledge}` | Product-specific knowledge | +| `{user_documents}` | User-provided location | + +--- + +## Discovery Step Template + +```markdown +--- +name: 'step-01-init' +description: 'Initialize and discover input documents' + +# Input Discovery +inputDocuments: [] +requiredInputCount: 1 +moduleInputFolder: '{module_output_folder}' +inputFilePatterns: + - '*-prd.md' +--- +``` + +--- + +## Validation Checklist + +For input discovery: +- [ ] Required inputs defined in step frontmatter +- [ ] Search paths defined (module variables or patterns) +- [ ] User confirmation before using documents +- [ ] Validation of document completeness +- [ ] Clear error messages when required inputs missing +- [ ] Support for multiple document selection +- [ ] Optional inputs clearly marked as optional diff --git a/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md b/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md new file mode 100644 index 00000000..ed8df32d --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md @@ -0,0 +1,50 @@ +# Intent vs Prescriptive Spectrum + +**Principle:** Workflows lean toward **intent** (goals) not **prescription** (exact wording). The more intent-based, the more adaptive and creative the LLM can be. + +--- + +## When to Use Each + +### Intent-Based (Default) +**Use for:** Most workflows - creative, exploratory, collaborative +**Step instruction:** "Help the user understand X using multi-turn conversation. Probe to get good answers. Ask 1-2 questions at a time, not a laundry list." +**LLM figures out:** Exact wording, question order, how to respond + +### Prescriptive (Exception) +**Use for:** Compliance, safety, legal, medical, regulated industries +**Step instruction:** "Say exactly: 'Do you currently experience fever, cough, or fatigue?' Wait for response. Then ask exactly: 'When did symptoms begin?'" +**LLM follows:** Exact script, specific order, no deviation + +--- + +## Examples + +### Intent-Based (Good for most) +``` +"Guide the user through discovering their ideal nutrition plan. +Use multi-turn conversation. Ask 1-2 questions at a time. +Think about their responses before asking follow-ups. +Probe to understand preferences, restrictions, goals." +``` + +### Prescriptive (Only when required) +``` +"Medical intake - ask exactly: +1. 'Do you have any of these symptoms: fever, cough, fatigue?' +2. 'When did symptoms begin?' +3. 'Have you traveled recently in the last 14 days?' +Follow sequence precisely. Do not deviate." +``` + +--- + +## Step Writing Tips + +- **Default to intent** - give goals, not scripts +- **Use "think"** - "Think about their response before..." +- **Multi-turn** - "Use conversation, not interrogation" +- **Progressive** - "Ask 1-2 questions at a time" +- **Probe** - "Ask follow-ups to understand deeper" + +Only use prescriptive when compliance/regulation requires it. diff --git a/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md b/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md new file mode 100644 index 00000000..0247052e --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md @@ -0,0 +1,167 @@ +# Menu Handling Standards + +**CRITICAL:** Every menu MUST have a handler section. No exceptions. + +--- + +## Reserved Letters + +| Letter | Purpose | After Execution | +| ------ | -------------------- | ------------------------------ | +| **A** | Advanced Elicitation | Redisplay menu | +| **P** | Party Mode | Redisplay menu | +| **C** | Continue/Accept | Save → update → load next step | +| **X** | Exit/Cancel | End workflow | + +**Custom letters** allowed (L/R/F/etc.) but don't conflict with reserved. + +--- + +## Required Structure + +### Section 1: Display +```markdown +### N. Present MENU OPTIONS + +Display: "**Select:** [A] [action] [P] [action] [C] Continue" +``` + +### Section 2: Handler (MANDATORY) +```markdown +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, then [Redisplay Menu Options](#n-present-menu-options) +``` + +### Section 3: Execution Rules +```markdown +#### 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 +``` + +--- + +## When To Include A/P + +### DON'T Include A/P: +- Step 1 (init) - no content to refine yet +- Step 2 if only loading documents +- Validation sequences - auto-flow instead +- Simple data gathering + +### DO Include A/P: +- Collaborative content creation +- User might want alternatives +- Quality gate before proceeding +- Creative exploration valuable + +--- + +## Menu Patterns + +### Pattern 1: Standard A/P/C +```markdown +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, 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 +``` + +### Pattern 2: C Only (No A/P) +```markdown +Display: "**Select:** [C] Continue" + +#### Menu Handling Logic: +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, 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' +``` + +**Use for:** Step 1, document discovery, simple progression + +### Pattern 3: Auto-Proceed (No Menu) +```markdown +Display: "**Proceeding to [next step]...**" + +#### 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 +``` + +**Use for:** Init steps, validation sequences + +### Pattern 4: Branching +```markdown +Display: "**Select:** [L] Load Existing [N] Create New [C] Continue" + +#### Menu Handling Logic: +- IF L: Load existing document, then load, read entire file, then execute {stepForExisting} +- IF N: Create new document, then load, read entire file, then execute {stepForNew} +- IF C: Save content to {outputFile}, update frontmatter, check {condition}, then load appropriate step +- IF Any other: help user, then [Redisplay Menu Options](#n-present-menu-options) + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- Branching options load different steps based on user choice +``` + +--- + +## Critical Violations + +### ❌ DON'T: +```markdown +# Missing Handler Section +Display: "**Select:** [C] Continue" +[NO HANDLER - CRITICAL ERROR!] + +# A/P in Step 1 (doesn't make sense) +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +# Forgetting redisplay +- IF A: Execute {advancedElicitationTask} +# Should end with: ", and when finished redisplay the menu" + +# Missing halt instruction +#### EXECUTION RULES: +- ONLY proceed to next step when user selects 'C' +# MISSING: "ALWAYS halt and wait for user input after presenting menu" +``` + +### ✅ DO: +- Handler section immediately follows Display +- "Halt and wait" in EXECUTION RULES +- Non-C options specify "redisplay menu" +- A/P only when appropriate for step type + +--- + +## Validation Checklist + +For every menu: +- [ ] Display section present +- [ ] Handler section immediately follows +- [ ] EXECUTION RULES section present +- [ ] "Halt and wait" instruction included +- [ ] A/P options appropriate for step type +- [ ] Non-C options redisplay menu +- [ ] C option: save → update → load next +- [ ] All file references use variables diff --git a/src/modules/bmb/workflows/workflow/data/output-format-standards.md b/src/modules/bmb/workflows/workflow/data/output-format-standards.md new file mode 100644 index 00000000..23e6439f --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/output-format-standards.md @@ -0,0 +1,188 @@ +# Output Format Standards + +**Purpose:** How workflows produce documents and handle step output. + +--- + +## Golden Rule + +**Every step MUST output to a document BEFORE loading the next step.** + +Two patterns: +1. **Direct-to-Final:** Steps append to final document +2. **Plan-then-Build:** Steps append to plan → build step consumes plan + +--- + +## Menu C Option Sequence + +When user selects **C (Continue)**: +1. **Append/Write** to document (plan or final) +2. **Update frontmatter** (append this step to `stepsCompleted`) +3. **THEN** load next step + +```markdown +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +``` + +--- + +## Output Patterns + +### Pattern 1: Plan-then-Build + +**Use when:** Design/plan before building/creating + +``` +Step 1 (init) → Creates plan.md from template +Step 2 (gather) → Appends requirements to plan.md +Step 3 (design) → Appends design decisions to plan.md +Step 4 (review) → Appends review/approval to plan.md +Step 5 (build) → READS plan.md, CREATES final artifacts +``` + +**Plan frontmatter:** +```yaml +workflowName: [name] +creationDate: [date] +stepsCompleted: ['step-01-init', 'step-02-gather'] +status: PLANNING_COMPLETE +``` + +**Example:** Workflow creation - steps append to plan, build step generates files + +### Pattern 2: Direct-to-Final + +**Use when:** Each step contributes to final deliverable + +``` +Step 1 (init) → Creates final-doc.md from minimal template +Step 2 (section) → Appends Section 1 +Step 3 (section) → Appends Section 2 +Step 4 (section) → Appends Section 3 +Step 5 (polish) → Optimizes entire document +``` + +**Example:** Meal prep nutrition plan - each step adds a section + +--- + +## Four Template Types + +### 1. Free-Form (RECOMMENDED) + +**Characteristics:** Minimal template, progressive append, final polish + +**Template:** +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- + +# {{document_title}} + +[Content appended progressively by workflow steps] +``` + +**Use when:** Most workflows - flexible, collaborative + +### 2. Structured + +**Characteristics:** Single template with placeholders, clear sections + +**Template:** +```markdown +# {{title}} + +## {{section_1}} +[Content to be filled] + +## {{section_2}} +[Content to be filled] +``` + +**Use when:** Reports, proposals, documentation + +### 3. Semi-Structured + +**Characteristics:** Core required sections + optional additions + +**Use when:** Forms, checklists, meeting minutes + +### 4. Strict + +**Characteristics:** Multiple templates, exact field definitions + +**Use when:** Rarely - compliance, legal, regulated + +--- + +## Template Syntax + +```markdown +{{variable}} # Handlebars style (preferred) +[variable] # Bracket style (also supported) +``` + +**Keep templates lean** - structure only, not content. + +--- + +## Step-to-Output Mapping + +Steps should be in ORDER of document appearance: + +``` +Step 1: Init (creates doc) +Step 2: → ## Section 1 +Step 3: → ## Section 2 +Step 4: → ## Section 3 +Step 5: → ## Section 4 +Step 6: Polish (optimizes entire doc) +``` + +**Critical:** Use ## Level 2 headers for main sections - allows document splitting if needed. + +--- + +## Final Polish Step + +For free-form workflows, include a polish step that: +1. Loads entire document +2. Reviews for flow and coherence +3. Reduces duplication +4. Ensures proper ## Level 2 headers +5. Improves transitions +6. Keeps general order but optimizes readability + +--- + +## Output File Patterns + +```yaml +# Single output +outputFile: '{output_folder}/document-{project_name}.md' + +# Time-stamped +outputFile: '{output_folder}/document-{project_name}-{timestamp}.md' + +# User-specific +outputFile: '{output_folder}/document-{user_name}-{project_name}.md' +``` + +--- + +## Validation Checklist + +For workflow output design: +- [ ] Output format type selected +- [ ] Template created if needed +- [ ] Steps ordered to match document structure +- [ ] Each step outputs to document (except init/final) +- [ ] Level 2 headers for main sections +- [ ] Final polish step for free-form workflows +- [ ] Frontmatter tracking for continuable workflows +- [ ] Templates use consistent placeholder syntax diff --git a/src/modules/bmb/workflows/workflow/data/step-file-rules.md b/src/modules/bmb/workflows/workflow/data/step-file-rules.md new file mode 100644 index 00000000..b7d59d47 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/step-file-rules.md @@ -0,0 +1,235 @@ +# Step File Rules + +**Purpose:** Quick reference for step file structure and compliance. See linked data files for detailed standards. + +--- + +## File Size Limits + +| Metric | Value | +| ----------- | -------- | +| Recommended | < 200 lines | +| Absolute Maximum | 250 lines | + +**If exceeded:** Split into multiple steps or extract content to `/data/` files. + +--- + +## Required Step Structure + +```markdown +--- +name: 'step-[N]-[name]' +description: '[what this step does]' + +# File References (ONLY variables used in this step!) +[file references in {variable} format] +--- + +# Step [N]: [Name] + +## STEP GOAL: +[Single sentence: what this step accomplishes] + +## 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] +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring [expertise], user brings [theirs] +- ✅ Together we produce something better + +### Step-Specific Rules: +- 🎯 Focus only on [specific task] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage] + +## EXECUTION PROTOCOLS: +- 🎯 [Protocol 1] +- 💾 [Protocol 2 - save/update] +- 📖 [Protocol 3 - tracking] + +## CONTEXT BOUNDARIES: +- Available context: [what's available] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [what this depends on] + +## Sequence of Instructions: +### 1. [Action] +[Instructions] + +### N. Present MENU OPTIONS +[Menu section - see menu-handling-standards.md] + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: +[Success criteria] +### ❌ SYSTEM FAILURE: +[Failure criteria] +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +--- + +## Critical Rules (Quick Reference) + +### Frontmatter +- ✅ Only variables USED in the step body +- ✅ All file references use `{variable}` format +- ✅ Relative paths within workflow folder +- See: `frontmatter-standards.md` + +### Menus +- ✅ Handler section MUST follow display +- ✅ "Halt and wait" in execution rules +- ✅ A/P options only when appropriate +- ✅ Non-C options redisplay menu +- See: `menu-handling-standards.md` + +### Progressive Disclosure +- ✅ Only load next step when user selects 'C' +- ✅ Read entire step file before execution +- ✅ Don't create mental todos from future steps + +### Continuable Workflows +- ✅ Append step number to `stepsCompleted` +- ✅ Don't hardcode full array +- See: `workflow-type-criteria.md` + +--- + +## Data Files Reference + +| File | Purpose | +| ----------------------- | --------------------------------------------- | +| `frontmatter-standards.md` | Variables, paths, frontmatter rules | +| `menu-handling-standards.md` | Menu patterns, handler requirements | +| `output-format-standards.md` | Document output, template types | +| `workflow-type-criteria.md` | Continuable, module, tri-modal decisions | +| `step-type-patterns.md` | Templates for init/middle/final/branch steps | +| `trimodal-workflow-structure.md` | Create/Edit/Validate folder structure | + +--- + +## Step Type Reference + +| Step Type | Template/Reference | +| ------------------- | ------------------------------------------- | +| Init (non-continuable) | Auto-proceed, no continuation logic | +| Init (continuable) | `step-01-init-continuable-template.md` | +| Continuation (01b) | `step-1b-template.md` | +| Middle (standard) | A/P/C menu, collaborative content | +| Middle (simple) | C only menu, no A/P | +| Branch/Conditional | Custom menu options, routing to different steps | +| Validation sequence | Auto-proceed through checks | +| Final | No next step, completion message | + +See: `step-type-patterns.md` + +--- + +## Frontmatter Variables + +### Standard (Always Available) +- `{project-root}` +- `{project_name}` +- `{output_folder}` +- `{user_name}` +- `{communication_language}` +- `{document_output_language}` + +### Module-Specific (e.g., BMB) +- `{bmb_creations_output_folder}` + +### User-Defined +- New variables can be defined in steps for future steps + +See: `frontmatter-standards.md` + +--- + +## Validation Checklist + +For every step file: + +- [ ] File < 200 lines (250 max) +- [ ] `name` and `description` in frontmatter +- [ ] All frontmatter variables are used +- [ ] File references use `{variable}` format +- [ ] Relative paths within workflow folder +- [ ] Handler section follows menu display +- [ ] "Halt and wait" in execution rules +- [ ] A/P options appropriate for step type +- [ ] C option saves and loads next step +- [ ] Non-C options redisplay menu +- [ ] StepsCompleted appended (if continuable) +- [ ] Success/failure metrics present + +--- + +## Quick Menu Reference + +```markdown +### N. Present MENU OPTIONS + +Display: "**Select:** [A] [action A] [P] [action P] [C] Continue" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, 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 +``` + +--- + +## Common Violations + +| ❌ Violation | ✅ Fix | +| ------------------------------------- | ---------------------------------------------- | +| Unused variable in frontmatter | Remove unused variables | +| Hardcoded file path | Use `{variable}` format | +| A/P menu in step 1 | Remove A/P (inappropriate for init) | +| Missing handler section | Add handler after menu display | +| No "halt and wait" instruction | Add to EXECUTION RULES | +| Hardcoded `stepsCompleted: [1,2,3]` | Append: "update stepsCompleted to add this step" | +| File > 250 lines | Split into multiple steps or extract to /data/ | +| Absolute path for same-folder ref | Use relative path or `{workflow_path}` | + +--- + +## When to Extract to Data Files + +Extract step content to `/data/` when: +- Step file exceeds 200 lines +- Content is reference material +- Content is reused across steps +- Content is domain-specific (examples, patterns) + +**Data file types:** +- `.md` - Reference documentation +- `.csv` - Structured data for lookup +- `examples/` - Reference implementations + +--- + +## Tri-Modal Workflow Note + +For Create/Edit/Validate workflows: +- Each mode has its own `steps-c/`, `steps-e/`, `steps-v/` folder +- NO shared step files (`s-*.md`) between modes +- All modes share `/data/` folder +- This prevents confusion and routing errors + +See: `trimodal-workflow-structure.md` diff --git a/src/modules/bmb/workflows/workflow/data/step-type-patterns.md b/src/modules/bmb/workflows/workflow/data/step-type-patterns.md new file mode 100644 index 00000000..4bc9478a --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/step-type-patterns.md @@ -0,0 +1,312 @@ +# Step Type Patterns + +**Purpose:** Templates for different step types. + +--- + +## Core Step Structure + +All steps share this skeleton: +```markdown +--- +name: 'step-[N]-[name]' +description: '[what it does]' +[file references - ONLY used variables] +--- + +# Step [N]: [Name] + +## STEP GOAL: +[Single sentence goal] + +## MANDATORY EXECUTION RULES (READ FIRST): +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read complete step file before action +- 🔄 CRITICAL: When loading next with 'C', read entire file +- 📋 YOU ARE A FACILITATOR, not content generator + +### Role Reinforcement: +- ✅ You are [specific role] +- ✅ Collaborative dialogue, not command-response +- ✅ You bring [expertise], user brings [theirs] + +### Step-Specific Rules: +- 🎯 Focus only on [specific task] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage] + +## EXECUTION PROTOCOLS: +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 💾 [Additional protocol] +- 📖 [Additional protocol] + +## CONTEXT BOUNDARIES: +- Available context: [what's available] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [what this depends on] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. [First action] +[Instructions] + +### N. Present MENU OPTIONS +[Menu section - see menu-handling-standards.md] + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: [criteria] +### ❌ SYSTEM FAILURE: [criteria] +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +--- + +## Step Types + +### 1. Init Step (Non-Continuable) + +**Use:** Single-session workflow + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: 'Initialize [workflow]' +thisStepFile: '{workflow_path}/steps/step-01-init.md' +nextStepFile: '{workflow_path}/steps/step-02-[name].md' +outputFile: '{output_folder}/[output].md' +templateFile: '{workflow_path}/templates/[template].md' +--- +``` + +**Characteristics:** +- No continuation detection +- Auto-proceeds to step 2 +- No A/P menu +- Creates output from template + +**Menu:** Auto-proceed (no user choice) + +### 2. Init Step (Continuable) + +**Use:** Multi-session workflow + +**Frontmatter:** Add `continueFile` reference +```yaml +continueFile: '{workflow_path}/steps/step-01b-continue.md' +``` + +**Logic:** +```markdown +## 1. Check for Existing Workflow +- Look for {outputFile} +- If exists AND has stepsCompleted → STOP, load {continueFile} +- If not exists → continue to setup +``` + +**Reference:** `step-01-init-continuable-template.md` + +### 3. Continuation Step (01b) + +**Use:** Paired with continuable init + +**Frontmatter:** +```yaml +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation' +outputFile: '{output_folder}/[output].md' +workflowFile: '{workflow_path}/workflow.md' +--- +``` + +**Logic:** +1. Read `stepsCompleted` array from output +2. Read last completed step file to find nextStep +3. Welcome user back +4. Route to appropriate step + +**Reference:** `step-1b-template.md` + +### 4. Middle Step (Standard) + +**Use:** Collaborative content generation + +**Frontmatter:** +```yaml +--- +name: 'step-[N]-[name]' +nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' +outputFile: '{output_folder}/[output].md' +advancedElicitationTask: '{project-root}/.../advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/.../party-mode/workflow.md' +--- +``` + +**Menu:** A/P/C pattern + +### 5. Middle Step (Simple) + +**Use:** Data gathering, no refinement needed + +**Menu:** C only (no A/P) + +### 6. Branch Step + +**Use:** User choice determines next path + +**Frontmatter:** +```yaml +nextStepFile: '{workflow_path}/steps/step-[default].md' +altStepFile: '{workflow_path}/steps/step-[alternate].md' +``` + +**Menu:** Custom letters (L/R/etc.) with branching logic + +### 7. Validation Sequence Step + +**Use:** Multiple checks without user interruption + +**Menu:** Auto-proceed to next validation + +**Pattern:** +```markdown +## 1. Perform validation check +[Check logic] + +## 2. Write results to {outputFile} +Append findings + +## 3. Proceed to next validation +Display: "**Proceeding to next check...**" +→ Immediately load {nextValidationStep} +``` + +### 8. Init Step (With Input Discovery) + +**Use:** Workflow that requires documents from prior workflows or external sources + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: 'Initialize and discover input documents' +inputDocuments: [] +requiredInputCount: 1 +moduleInputFolder: '{module_output_folder}' +inputFilePatterns: + - '*-prd.md' + - '*-ux.md' +--- +``` + +**Characteristics:** +- Discovers documents from prior workflows +- Searches by folder, pattern, or user-provided paths +- Validates inputs are complete +- User confirms which documents to use +- Auto-proceeds when required inputs found + +**Logic:** +```markdown +## 1. Discover Required Inputs +Search {moduleInputFolder} for {inputFilePatterns} +Search {project_folder}/docs/ for {inputFilePatterns} + +## 2. Present Findings +"Found these documents: +[1] prd-my-project.md (3 days ago) ✓ +[2] ux-research.md (1 week ago) +Which would you like to use?" + +## 3. Validate and Load +Check workflowType, stepsCompleted, date +Load selected documents +Add to {inputDocuments} array + +## 4. Auto-Proceed +If all required inputs found → proceed to step 2 +If missing → Error with guidance +``` + +**Reference:** `input-discovery-standards.md` + +### 9. Final Polish Step + +**Use:** Optimizes document built section-by-section + +**Frontmatter:** +```yaml +--- +name: 'step-[N]-polish' +description: 'Optimize and finalize document' +outputFile: '{output_folder}/[document].md' +--- +``` + +**Characteristics:** +- Loads entire document +- Reviews for flow and coherence +- Reduces duplication +- Ensures proper ## Level 2 headers +- Improves transitions +- Keeps general order but optimizes readability + +**Logic:** +```markdown +## 1. Load Complete Document +Read {outputFile} entirely + +## 2. Document Optimization +Review entire document for: +1. Flow and coherence +2. Duplication (remove while preserving essential info) +3. Proper ## Level 2 section headers +4. Smooth transitions between sections +5. Overall readability + +## 3. Optimize +Make improvements while maintaining: +- General order of sections +- Essential information +- User's voice and intent + +## 4. Final Output +Save optimized document +Mark workflow complete +``` + +**Use for:** Free-form output workflows (most document-producing workflows) + +### 10. Final Step + +**Use:** Last step, completion + +**Frontmatter:** No `nextStepFile` + +**Logic:** +- Update frontmatter to mark workflow complete +- Provide final summary +- No next step + +--- + +## Step Size Guidelines + +| Type | Recommended | Maximum | +| ------------------------ | ----------- | ------- | +| Init | < 100 | 150 | +| Init (with discovery) | < 150 | 200 | +| Continuation | < 150 | 200 | +| Middle (simple) | < 150 | 200 | +| Middle (complex) | < 200 | 250 | +| Branch | < 150 | 200 | +| Validation sequence | < 100 | 150 | +| Final polish | < 150 | 200 | +| Final | < 150 | 200 | + +**If exceeded:** Split into multiple steps or extract to `/data/` files. diff --git a/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md b/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md new file mode 100644 index 00000000..bb425614 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md @@ -0,0 +1,209 @@ +# Tri-Modal Workflow Structure + +**Purpose:** The golden rule standard for complex critical workflows that require create, validate, and edit capabilities. + +--- + +## The Golden Rule + +**For complex critical workflows: Implement tri-modal structure (create/validate/edit) with cross-mode integration.** + +This pattern ensures: +- Quality through standalone validation +- Maintainability through dedicated edit mode +- Flexibility through conversion paths for non-compliant input + +**Cross-mode integration patterns:** +- Create → Validation (handoff after build) +- Edit → Validation (verify changes) +- Edit → Create/conversion (for non-compliant input) +- Validation → Edit (fix issues found) +- All modes run standalone via workflow.md routing + +--- + +## Directory Structure + +``` +workflow-name/ +├── workflow.md # Entry point with mode routing +├── data/ # SHARED standards and reference +│ ├── [domain]-standards.md +│ └── [domain]-patterns.md +├── steps-c/ # Create (self-contained) +│ ├── step-00-conversion.md # Entry for non-compliant input +│ ├── step-01-init.md +│ └── step-N-complete.md +├── steps-e/ # Edit (self-contained) +│ ├── step-01-assess.md # Checks compliance, routes if needed +│ └── step-N-complete.md +└── steps-v/ # Validate (self-contained, runs standalone) + └── step-01-validate.md +``` + +--- + +## Mode Responsibilities + +### Create Mode (steps-c/) + +**Primary:** Build new entities from scratch +**Secondary:** Convert non-compliant input via step-00-conversion + +**Key patterns:** +- step-00-conversion: Loads non-compliant input, extracts essence, creates plan with `conversionFrom` metadata +- Final step routes to validation (optional but recommended) +- Confirmation step checks `conversionFrom` to verify coverage vs new workflow + +### Edit Mode (steps-e/) + +**Primary:** Modify existing compliant entities +**Secondary:** Detect non-compliance and route to conversion + +**Key patterns:** +- step-01-assess: Checks compliance first +- Non-compliant → Offer route to step-00-conversion (not step-01-discovery) +- Post-edit → Offer validation (reuse validation workflow) +- During edits → Check standards, offer to fix non-compliance + +### Validate Mode (steps-v/) + +**Primary:** Standalone validation against standards +**Secondary:** Generates actionable reports + +**Key patterns:** +- Runs standalone (invoked via -v flag or direct call) +- Auto-proceeds through all checks +- Generates report with issue severity +- Report consumed by edit mode for fixes + +--- + +## workflow.md Routing Pattern + +```yaml +## INITIALIZATION SEQUENCE + +### 1. Mode Determination + +**Check invocation:** +- "create" / -c → mode = create +- "validate" / -v → mode = validate +- "edit" / -e → mode = edit + +**If create mode:** Ask "From scratch or convert existing?" +- From scratch → steps-c/step-01-init.md +- Convert → steps-c/step-00-conversion.md + +**If unclear:** Ask user to select mode + +### 2. Route to First Step + +**IF mode == create:** +Route to appropriate create entry (init or conversion) + +**IF mode == validate:** +Prompt for path → load steps-v/step-01-validate.md + +**IF mode == edit:** +Prompt for path → load steps-e/step-01-assess.md +``` + +**Critical:** workflow.md is lean. No step listings. Only routing logic. + +--- + +## Cross-Mode Integration Points + +### 1. Edit → Create (Non-Compliant Detection) + +**In edit step-01-assess:** +```yaml +Check workflow compliance: + - Compliant → Continue to edit steps + - Non-compliant → Offer conversion + - IF user accepts: Load steps-c/step-00-conversion.md with sourceWorkflowPath +``` + +### 2. Create/Edit → Validation + +**Both create and edit can invoke validation:** +```yaml +# In create final step or edit post-edit step +Offer: "Run validation?" + - IF yes: Load ../steps-v/step-01-validate.md + - Validation runs standalone, returns report + - Resume create/edit with validation results +``` + +### 3. Validation → Edit + +**After validation generates report:** +```yaml +# User can invoke edit mode with report as input +"Fix issues found?" + - IF yes: Load steps-e/step-01-assess.md with validationReport path +``` + +### 4. Conversion Coverage Tracking + +**In create step-10-confirmation:** +```yaml +Check workflowPlan metadata: + - IF conversionFrom exists: + - Load original workflow + - Compare each step/instruction + - Report coverage percentage + - ELSE (new workflow): + - Validate all plan requirements implemented +``` + +--- + +## When to Use Tri-Modal + +**Use Tri-Modal for:** +- Complex workflows requiring quality assurance +- Workflows that will be maintained over time +- Workflows where non-compliant input may be offered +- Critical workflows where standards compliance matters + +**Use Create-Only for:** +- Simple one-off workflows +- Experimental workflows +- Workflows unlikely to need editing or validation + +--- + +## Frontmatter Standards for Cross-Mode References + +**Never inline file paths. Always use frontmatter variables:** + +```yaml +--- +# Create mode step calling validation +validationWorkflow: '../steps-v/step-01-validate.md' +--- + +# Edit mode step routing to conversion +conversionStep: '../steps-c/step-00-conversion.md' +--- + +# Create conversion step receiving from edit +sourceWorkflowPath: '{targetWorkflowPath}' # Passed from edit +--- +``` + +--- + +## Validation Checklist + +For tri-modal workflow design: +- [ ] Each mode has self-contained steps folder +- [ ] No shared step files (shared data in /data/ only) +- [ ] workflow.md has lean routing (no step listings) +- [ ] Edit mode checks compliance, routes to conversion if needed +- [ ] Create mode has step-00-conversion for non-compliant input +- [ ] Create/Edit can invoke validation workflow +- [ ] Validation runs standalone and generates reports +- [ ] Confirmation step checks `conversionFrom` metadata diff --git a/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md b/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md new file mode 100644 index 00000000..cb5be95f --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md @@ -0,0 +1,271 @@ +# Workflow Chaining Standards + +**Purpose:** How workflows connect in sequences within modules, passing outputs as inputs to next workflows. + +--- + +## Module Workflow Pipeline + +**Example:** BMM Module - Idea to Implementation + +``` +brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning + ↓ + implement-story → review → repeat +``` + +Each workflow: +1. Checks for required inputs from prior workflows +2. Validates inputs are complete +3. Produces output for next workflow +4. Recommends next workflow in sequence + +--- + +## Input/Output Contract + +### Output Contract (What Each Workflow Produces) + +**Every workflow should:** +1. Create output document with predictable filename +2. Include `workflowType` in frontmatter for identification +3. Mark `stepsCompleted: [all steps]` when complete +4. Store in known location (`{module_output_folder}`) + +**Example frontmatter:** +```yaml +--- +workflowType: 'prd' +stepsCompleted: ['step-01-init', ..., 'step-11-complete'] +project_name: 'my-project' +date: '2025-01-02' +nextWorkflow: 'create-ux' +previousWorkflow: 'create-brief' +--- +``` + +### Input Contract (What Each Workflow Consumes) + +**Every workflow should:** +1. Define required inputs in Step 1 +2. Search in `{module_output_folder}` for prior outputs +3. Validate inputs are complete +4. Allow user to select from discovered documents + +--- + +## Step 1: Input Discovery Pattern + +```markdown +## 1. Discover Required Inputs + +### Required Inputs: +- {module_output_folder}/prd-{project_name}.md + +### Search: +1. Look for prd-{project_name}.md in {module_output_folder} +2. If found → validate completeness +3. If missing or incomplete → error with guidance + +"Error: This workflow requires a completed PRD. +Expected location: {module_output_folder}/prd-{project_name}.md +To fix: Run the PRD workflow first, or provide the path to your PRD." +``` + +--- + +## Final Step: Next Workflow Recommendation + +```markdown +## Next Steps + +Based on your completed [workflow], recommended next workflows: + +1. **[next-workflow-name]** - [why it's next] +2. **[alternative-workflow]** - [when to use this instead] + +Would you like to: +- Run [next-workflow-name] now? +- Run a different workflow? +- Exit for now? +``` + +**Update output frontmatter:** +```yaml +nextWorkflow: 'create-ux' +nextWorkflowRecommended: true +``` + +--- + +## Cross-Workflow Status Tracking + +**Optional:** Module can maintain `workflow-status.yaml`: + +```yaml +--- +current_workflow: 'create-prd' +completed_workflows: + - brainstorming + - research + - brief +pending_workflows: + - create-ux + - create-architecture + - create-epics + - sprint-planning +outputs: + brief: '{module_output_folder}/brief-{project_name}.md' + prd: '{module_output_folder}/prd-{project_name}.md' +--- +``` + +**Workflow checks this file to:** +- Validate sequence (don't run UX before PRD) +- Find output locations +- Track overall progress + +--- + +## Branching Workflows + +**Some workflows have multiple valid next steps:** + +```markdown +## Next Steps + +Based on your project type: + +**For software projects:** +- create-architecture - Technical architecture +- create-epics - Break down into epics + +**For data projects:** +- data-modeling - Database schema design +- etl-pipeline - Data pipeline design + +Which workflow would you like to run next? +``` + +--- + +## Required vs Optional Sequences + +### Required Sequence +**PRD must come before Architecture:** + +```yaml +# In architecture workflow.md +## PREREQUISITE: +This workflow requires a completed PRD. + +## INITIALIZATION: +IF prd-{project_name}.md exists AND is complete: + → Proceed with architecture workflow +ELSE: + → Error: "Please complete PRD workflow first" +``` + +### Optional Sequence +**UX research helps Architecture but isn't required:** + +```yaml +# In architecture workflow.md +## OPTIONAL INPUTS: +UX research documents can inform technical decisions. + +IF ux-research-{project_name}.md exists: + → "Found UX research. Include findings in architecture design?" +ELSE: + → "No UX research found. Continuing without it." +``` + +--- + +## Filename Conventions for Chaining + +**Standard pattern:** `{workflow-name}-{project-name}.md` + +| Workflow | Output Filename Pattern | +|----------| ---------------------- | +| brainstorming | `brainstorming-{project_name}.md` | +| brief | `brief-{project_name}.md` | +| PRD | `prd-{project_name}.md` | +| UX | `ux-design-{project_name}.md` | +| architecture | `architecture-{project_name}.md` | +| epics | `epics-{project_name}.md` | + +**Predictable filenames enable:** +- Automatic discovery +- Clear dependencies +- Easy validation + +--- + +## Module-Level Workflow Registry + +**Module can define `workflows.yaml`:** + +```yaml +--- +module: 'bmm' +workflows: + brainstorming: + output: 'brainstorming-{project_name}.md' + next: ['research'] + research: + output: 'research-{project_name}.md' + next: ['brief'] + brief: + output: 'brief-{project_name}.md' + next: ['prd'] + prd: + output: 'prd-{project_name}.md' + next: ['create-ux', 'create-architecture'] + create-ux: + output: 'ux-design-{project_name}.md' + next: ['create-architecture'] + create-architecture: + output: 'architecture-{project_name}.md' + next: ['create-epics'] + create-epics: + output: 'epics-{project_name}.md' + next: ['sprint-planning'] +--- +``` + +**Workflows read this to:** +- Know what outputs exist +- Know valid next steps +- Know output filenames + +--- + +## Cross-Module Dependencies + +**Workflows can depend on outputs from other modules:** + +```yaml +# In BMGD narrative workflow +## INPUT REQUIREMENTS: + +### Required: +- {bmm_output_folder}/prd-{project_name}.md +- {bmm_output_folder}/architecture-{project_name}.md + +### From BMGD: +- {bmgd_output_folder}/gdd-{project_name}.md (Game Design Document) +``` + +--- + +## Validation Checklist + +For workflow chaining: +- [ ] Output filename follows convention +- [ ] Frontmatter includes `workflowType` +- [ ] `stepsCompleted` marked complete when done +- [ ] Required inputs clearly defined +- [ ] Input validation with helpful errors +- [ ] Next workflow recommendations in final step +- [ ] Module registry (if using sequence tracking) diff --git a/src/modules/bmb/workflows/workflow/data/workflow-examples.md b/src/modules/bmb/workflows/workflow/data/workflow-examples.md new file mode 100644 index 00000000..9e83b090 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/workflow-examples.md @@ -0,0 +1,276 @@ +# Novel Workflow Examples + +**Purpose:** Illustrative examples of workflows across diverse domains to demonstrate the range of what users can create. + +--- + +## Understanding Workflow Structure + +**Each arrow (→) in the "Flow" column represents a potential step file.** + +``` +Flow: Discovery → Assessment → Strategy → Shopping List → Prep Schedule + ↓ ↓ ↓ ↓ ↓ + step-01- step-02- step-03- step-04- step-05- + discovery assessment strategy shopping-list prep-schedule +``` + +**Each step file contains internal structure:** +- STEP GOAL +- MANDATORY EXECUTION RULES +- EXECUTION PROTOCOLS +- MANDATORY SEQUENCE (numbered sub-steps) +- Menu options +- Success/failure metrics + +**Key insight:** A simple workflow might have 3-4 step files. A complex workflow might have 10+. Each step file is a focused, self-contained instruction. + +--- + +## Example 1: Personalized Meal Plan Generator + +**Domain:** Health & Fitness + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Discovery → Assessment → Strategy → Shopping List → Prep Schedule | +| **Step Files** | ~5 files: step-01-discovery, step-02-assessment, step-03-strategy, step-04-shopping, step-05-prep | +| **Output** | Direct-to-final document, each step appends a section | +| **Intent/Prescriptive** | Intent-based - Facilitates discovery of preferences | +| **Planning** | No - builds final meal plan directly | +| **Continuable** | Yes - Can be 200+ tokens, users may need multiple sessions | +| **Structure** | Linear, 5 steps, no branching | +| **Conversation** | Open-ended with progressive questioning (1-2 at a time, probe preferences) | + +**Description:** Helps users create personalized weekly meal plans based on dietary restrictions, health goals, and cooking habits. + +--- + +## Example 2: Year-End Tax Organizer + +**Domain:** Finance + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Input Discovery → Document Categorization → Missing Document Alert → Final Summary | +| **Step Files** | 4 files: step-01-input-discovery, step-02-categorize, step-03-missing-alerts, step-04-summary | +| **Output** | Analysis-only + checklist of missing docs | +| **Intent/Prescriptive** | Highly Prescriptive - Tax compliance, exact categories | +| **Planning** | N/A | +| **Continuable** | No - Simple single-session checklist | +| **Structure** | Linear, 4 steps | +| **Conversation** | Focused - specific questions, document what user provides | + +**Description:** Organizes financial documents for tax preparation, categorizes income/deductions, alerts to missing documents. + +--- + +## Example 3: Employee Termination Checklist + +**Domain:** Legal / HR / Compliance + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Context → Regulatory Check → Document Requirements → Notification Timeline → Final Checklist | +| **Step Files** | 5 files: step-01-context, step-02-regulatory, step-03-documents, step-04-timeline, step-05-checklist. Some steps branch internally based on reason/location. | +| **Output** | Direct-to-final compliance checklist | +| **Intent/Prescriptive** | Highly Prescriptive - Legal compliance, state-specific | +| **Planning** | No | +| **Continuable** | No - Focused, single-session | +| **Structure** | Branching - Different paths within steps based on: reason, location, employee count | +| **Conversation** | Focused - specific classification questions, present requirements | + +**Description:** Generates legally-compliant termination checklists that vary by state, termination reason, and employee count. + +--- + +## Example 4: Tabletop RPG Campaign Builder + +**Domain:** Entertainment / Games + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Session Concept → NPC Creation → Scene Setup → Key Beats → Generate → [Repeat for next session] | +| **Step Files** | 4 core files: step-01-concept, step-02-npc, step-03-scene, step-04-beats, step-05-generate. Same files reused each session. | +| **Output** | Per-session document, maintains campaign continuity | +| **Intent/Prescriptive** | Intent-based - Creative facilitation | +| **Planning** | No - Each session builds directly to playable content | +| **Continuable** | Yes - Campaign has many sessions over months | +| **Structure** | Repeating loop - Same steps, new content each session | +| **Conversation** | Open-ended creative facilitation, "What if..." prompts | + +**Description:** Helps Game Masters create individual RPG session content while tracking campaign continuity across multiple sessions. + +--- + +## 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 document | +| **Intent/Prescriptive** | Balanced - Framework prescriptive, content flexible | +| **Planning** | No | +| **Continuable** | Yes - Complex syllabus may require multiple sessions | +| **Structure** | Branching - Course type determines different sections | +| **Conversation** | Mixed - Framework questions (prescriptive) + content discovery (intent) | + +**Description:** Creates course syllabi that adapt based on course type (academic, vocational, self-paced) with appropriate accreditation requirements. + +--- + +## Example 6: SOP Writer + +**Domain:** Business Process + +| Aspect | Details | +|--------|---------| +| **Flow** | Process Selection → Scope Definition → Documentation → Review → [Generate] → "Create another?" → If yes, repeat | +| **Output** | Each SOP is independent, stored in `{sop_folder}/` | +| **Intent/Prescriptive** | Prescriptive - SOPs must be exact, unambiguous | +| **Planning** | No - Each SOP generated directly | +| **Continuable** | No - Single SOP per run, but workflow is repeatable | +| **Structure** | Repeating - Can create multiple SOPs in one session | +| **Conversation** | Focused on process details - "Walk me through step 1" | + +**Description:** Generates Standard Operating Procedure documents for business processes. Can create multiple SOPs in one session, each stored independently. + +--- + +## 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 step to ensure flow and coherence | +| **Intent/Prescriptive** | Intent-based - "What does your character want?" | +| **Planning** | No - Builds outline directly | +| **Continuable** | Yes - Long-form creative work, sessions span weeks | +| **Structure** | Branching - Different flows based on structure choice | +| **Conversation** | Open-ended creative coaching, provocations | + +**Description:** Helps authors create novel outlines with proper story structure (3-Act, Hero's Journey, etc.), character arcs, and beat sheets. + +--- + +## 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 couple's vision | +| **Planning** | No | +| **Continuable** | Yes - Wedding planning takes months | +| **Structure** | Branching - Venue type affects required sections | +| **Conversation** | Open-ended discovery of preferences, budget, constraints | + +**Description:** Creates detailed wedding day itineraries, adapting to venue type (indoor/outdoor/hybrid) and guest experience goals. + +--- + +## Example 9: Annual Life Review + +**Domain:** Personal Development + +| Aspect | Details | +|--------|---------| +| **Flow** | Input Discovery (last year's 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 document | +| **Continuable** | Yes - Deep reflection may need multiple sessions | +| **Structure** | Linear with Input Discovery at start | +| **Conversation** | Open-ended coaching, progressive questioning | + +**Description:** Annual review workflow that discovers prior year's goals, facilitates reflection across life areas, and sets intentional goals for coming year. + +--- + +## 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, multi-session | +| **Structure** | Branching - Room type and DIY vs pro affect content | +| **Conversation** | Mixed - "What's your budget?" + "Describe your vision" | + +**Description:** Creates room-specific renovation plans with material selection, contractor coordination, and optional DIY instructions. + +--- + +## 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 Campaign, Syllabus (partial), Novel, Wedding, Life Review, Renovation (partial) | +| Prescriptive | 1 | Tax, Termination, SOP | +| Balanced | 2 | Syllabus, Renovation | + +### Continuable vs Single-Session + +| Type | Count | Examples | +|------|-------|----------| +| Continuable | 7 | Meal Plan, RPG Campaign, Syllabus, Novel, Wedding, Life Review, Renovation | +| Single-Session | 3 | Tax, Termination, SOP (repeatable but single-output) | + +### Output Patterns + +| Type | Count | Examples | +|------|-------|----------| +| Direct-to-Final | 9 | All except Tax | +| Analysis Only | 1 | Tax | +| With Final Polish | 1 | Novel | +| Input Discovery | 1 | Life Review | +| Repeating Output | 2 | RPG Campaign (sessions), SOP Writer (multiple SOPs) | + +--- + +## Key Insights + +1. **Continuable workflows are the norm** - 7 of 10 examples are continuable +2. **Intent-based dominates** - 7 of 10 are primarily intent-based facilitation +3. **Branching is common** - 5 of 10 have conditional paths based on user choices +4. **Input discovery matters** - Workflows in sequences (like BMM pipeline) need to find prior documents +5. **Final polish is critical** - Complex documents built section-by-section need optimization step +6. **Repeating loops exist** - Some workflows generate multiple outputs per session or repeat across sessions +7. **Mixed conversation styles** - Most use focused questions for data, open-ended for creative + +--- + +## Workflow Design Questions + +When creating a new workflow, ask: + +1. **Domain:** What problem space does this operate in? +2. **Output:** What does this workflow produce? (Document, checklist, analysis, physical output?) +3. **Intent:** Is this prescriptive (compliance) or intent-based (creative)? +4. **Planning:** Plan-then-build or direct-to-final? +5. **Continuable:** Could this take multiple sessions or consume many tokens? +6. **Structure:** Linear, branching, or repeating loop? +7. **Inputs:** Does this require documents from prior workflows or external sources? +8. **Chaining:** Is this part of a module sequence? What comes before/after? +9. **Polish:** Does the final output need optimization for flow and coherence? +10. **Conversation:** Focused questions or open-ended facilitation? diff --git a/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md b/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md new file mode 100644 index 00000000..6d823471 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md @@ -0,0 +1,172 @@ +# Workflow Type Criteria + +**Purpose:** Key decisions when designing a workflow. + +--- + +## 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) +``` + +--- + +## Questions to Ask User + +**Module:** +"Is this workflow standalone or part of a specific module (BMB, BMM, CIS, BMGD)?" + +**Continuable:** +"Could this workflow consume many tokens or require multiple sessions? +- If YES: Add continuation support +- If NO: Keep it simple for single-session" + +**Edit/Validate:** +"Will this workflow need edit and validate capabilities, or just create? +- Create only: Simpler, faster +- Create + Edit + Validate: More robust, maintainable" + +**Document:** +"Does this workflow produce a document/output file?" +- If YES: Use free-form template (recommended) +- If NO: What does it produce? + +--- + +## 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] +``` diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md b/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md new file mode 100644 index 00000000..a9e2e001 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md @@ -0,0 +1,262 @@ +--- +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?** [C] Continue to Classification" + +#### Menu Handling Logic: + +- 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. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md b/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md new file mode 100644 index 00000000..a2e35772 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md @@ -0,0 +1,194 @@ +--- +name: 'step-01-discovery' +description: 'Discover and understand the user workflow idea through collaborative conversation' + +nextStepFile: './step-02-classification.md' +workflowExamples: '../data/workflow-examples.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +--- + +# Step 1: Discovery + +## STEP GOAL: + +To understand the user's workflow idea through open-ended conversation, showing them what's possible, and discovering their vision before making any structural decisions. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ 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 design expertise, user brings their vision +- ✅ Together we will discover what they need + +### Step-Specific Rules: + +- 🎯 Focus ONLY on understanding their idea +- 🚫 FORBIDDEN to ask for name, module, or technical decisions in this step +- 💬 Ask 1-2 questions at a time, think about their response before probing deeper +- 🚪 DON'T rush to classification - understand first + +## EXECUTION PROTOCOLS: + +- 🎯 Load examples FIRST to show what's possible +- 💬 Start with open-ended "Tell me about your idea..." +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until we understand their vision + +## CONTEXT BOUNDARIES: + +- Variables from workflow.md are available in memory +- This is pure discovery - no decisions yet +- Don't ask technical questions yet +- Focus on the problem space and user's vision + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Context FIRST + +Load `{workflowExamples}` BEFORE talking to the user. + +**Note:** You already understand workflow architecture from having read workflow.md to get here. The step-file architecture you just experienced (micro-file design, JIT loading, sequential enforcement, state tracking) is exactly what we'll be helping users create. + +**From workflowExamples**, you now know 10 diverse workflow examples across domains: +- Health & Fitness (Meal Plan) +- Finance (Tax Organizer) +- Legal/HR (Termination Checklist) +- Entertainment (RPG Campaign) +- Education (Syllabus Creator) +- Business (SOP Writer) +- Creative (Novel Outliner) +- Events (Wedding Itinerary) +- Personal Development (Life Review) +- Home Improvement (Renovation Planner) + +This context helps you understand whatever the user describes and guide them effectively. + +### 2. Open-Ended Invitation + +Start with: + +"**Welcome! I'm here to help you create a workflow.** + +Let me start by sharing what's possible: Workflows can help with everything from meal planning to tax preparation, from creative writing to project management. They're structured processes that guide you (or others) through a task step-by-step. + +**Tell me about your idea** - what problem are you trying to solve? What's the vision?" + +### 3. Listen and Probe + +As they describe their idea: + +**DO:** +- Listen carefully +- Ask 1-2 follow-up questions at a time +- Think about their response before asking more +- Probe for: Who is this for? What's the outcome? What's the challenge they're facing? +- Use "Think about their response before..." pattern + +**DON'T:** +- Ask about module, name, or technical details +- Rapid-fire questions +- Jump to solutions +- Rush this step + +### 4. Deepen Understanding + +Once you have the basic idea, probe deeper: + +"That's really interesting. Let me understand better: + +- Walk me through a scenario where someone would use this workflow +- What does success look like at the end? +- Who would be running this workflow - you, your team, customers? +- Is this something you'd do once, or repeat over time? + +**Think about their response before continuing...**" + +### 5. Check Understanding + +Before moving on, confirm you understand: + +"Let me make sure I've got this right: + +[Summarize your understanding in 2-3 sentences] + +Did I capture that correctly? What should I adjust?" + +### 6. Create Initial Plan Document + +Create `{workflowPlanFile}` with initial discovery notes: + +```markdown +--- +stepsCompleted: ['step-01-discovery'] +created: [current date] +status: DISCOVERY +--- + +# Workflow Creation Plan + +## Discovery Notes + +**User's Vision:** +[Summarize the problem they're solving and their vision] + +**Who It's For:** +[Users/audience] + +**What It Produces:** +[The outcome/deliverable] + +**Key Insights:** +[Any important context gathered] +``` + +### 7. Transition to Classification + +"Great! I understand what you're trying to build. Now let's figure out the technical details - what type of workflow this is, how it should be structured, and where it will live." + +### 8. Present MENU OPTIONS + +Display: **Proceeding to workflow classification...** + +#### EXECUTION RULES: + +- This is a discovery step with no user choices at the end +- Proceed directly to next step after discovery is complete +- Always halt if user wants to continue discussing their idea + +#### Menu Handling Logic: + +- After discovery complete and plan document created, immediately load and execute `{nextStepFile}` to begin classification +- IF user wants to keep discussing their idea: continue conversation, then repeat menu check + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- User's vision clearly understood +- Discovery notes captured in plan document +- User feels heard and understood +- Ready to proceed to classification + +### ❌ SYSTEM FAILURE: + +- Rushing to technical decisions before understanding +- Asking for name/module in this step +- Not loading examples first +- Rapid-fire questions without thinking about responses + +**Master Rule:** Understand first, classify second. Discovery comes before structure. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md b/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md new file mode 100644 index 00000000..131afbb5 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md @@ -0,0 +1,269 @@ +--- +name: 'step-02-classification' +description: 'Classify the workflow by answering the 4 key structural decisions' + +nextStepFile: './step-03-requirements.md' +workflowTypeCriteria: '../data/workflow-type-criteria.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +bmbCreationsOutputFolder: '{bmb_creations_output_folder}' +customWorkflowLocation: '{custom_workflow_location}' +--- + +# Step 2: Workflow Classification + +## STEP GOAL: + +To determine the 4 key structural decisions that define how the workflow will be built: module affiliation, continuable vs single-session, tri-modal vs create-only, and document output. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect helping classify their workflow +- ✅ Explain the trade-offs of each decision clearly +- ✅ Help them make informed choices +- ✅ These 4 decisions affect the entire workflow structure + +### Step-Specific Rules: + +- 🎯 Focus ONLY on the 4 key structural decisions +- 🚫 FORBIDDEN to skip any of the 4 decisions +- 💬 Explain each decision in plain language before asking +- 🚪 These decisions determine file structure, naming, and location + +## EXECUTION PROTOCOLS: + +- 🎯 Load workflowTypeCriteria for the decision framework +- 💾 Document each decision in the plan +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until all 4 decisions are made + +## CONTEXT BOUNDARIES: + +- Discovery from Step 1 informs these decisions +- These are STRUCTURAL decisions that affect everything else +- Once made, changing them is difficult +- Take time to explain trade-offs + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 0. Load Decision Framework + +Load `{workflowTypeCriteria}` to understand the 4 key decisions and their implications. + +### 1. Decision 1: Document Output (FIRST - It's Fundamental) + +"**Let's classify your workflow. I'll walk you through 4 key decisions that determine how it's built.** + +**Decision 1: What does your workflow produce?** + +Based on your idea from discovery, let me clarify:" + +- [If unclear from discovery] "Does this workflow produce a document or file at the end? A report, a plan, a story, a checklist?" + +Present the two options: + +**A. Document-Producing** +- Creates a persistent output file +- Examples: reports, plans, stories, checklists, forms +- Uses templates for structure + +**B. Non-Document** +- Performs actions without creating a document +- Examples: refactoring code, running tests, orchestrating tools +- May produce temporary files but no persistent output + +"Which describes your workflow?" + +**Think about their response before continuing...** + +Once decided: +- Document: `workflowProducesDocuments: true` +- Non-document: `workflowProducesDocuments: false` + +### 2. Decision 2: Module Affiliation + +"**Decision 2: Where will this workflow live?** + +Workflows can be standalone or part of a module:" + +**Standalone:** +- NOT part of any module +- Stored in your custom location +- Only standard variables available + +**Module-Based (BMB, BMM, CIS, BMGD, etc.):** +- Part of a specific module +- Has access to module-specific variables +- Stored in that module's workflows directory + +"Is this workflow: +- **A)** Standalone - just for you/custom use +- **B)** Part of a module - which one?" + +**If they don't know modules:** +"Modules are specialized areas: +- **BMB** - Module building workflows +- **BMM** - Software development workflows (PRDs, architecture, etc.) +- **CIS** - Innovation and creative workflows +- **BMGD** - Game development workflows +- **Custom** - Your own workflows + +Does your workflow fit into one of these areas, or is it standalone?" + +Document the result. + +### 3. Decision 3: Continuable or Single-Session + +"**Decision 3: Could this workflow take multiple sessions to complete?** + +Think about: Will this workflow consume many tokens or take a long time? Might users need to pause and come back later?" + +**Single-Session:** +- Quick, focused workflows (15-30 minutes) +- Simpler structure +- No continuation logic needed + +**Continuable:** +- Can span multiple sessions +- Complex, many steps +- Saves progress, can resume later +- Needs `step-01b-continue.md` + +"Is your workflow: +- **A)** Single-session - quick and focused +- **B)** Continuable - could take multiple sessions" + +**Help them think:** +- "Walk me through how long you think this would take..." +- "What happens if someone gets halfway through and has to stop?" + +Document the result. + +### 4. Decision 4: Create-Only or Tri-Modal + +"**Decision 4: Will this workflow need Edit and Validate capabilities?** + +Some workflows are simple - you create them once and use them. Others need full lifecycle support:** + +**Create-Only:** +- Just `steps-c/` (create steps) +- Simpler, faster to build +- Good for: experimental workflows, one-off use, simple tools + +**Tri-Modal (Create + Edit + Validate):** +- Has `steps-c/`, `steps-e/` (edit), and `steps-v/` (validate) +- Full lifecycle support +- Can be modified and validated after creation +- Good for: complex workflows, maintained workflows, team use + +"Do you envision: +- **A)** Create-only - build it and use it +- **B)** Tri-modal - create, edit, AND validate capabilities" + +**If they're unsure:** +"Think: Will you or others want to modify this workflow later? Does it need quality checking/validation?" + +Document the result. + +### 5. Name the Workflow + +"Now that we understand what this workflow IS, let's name it properly. + +Based on everything we've discovered, what would you call this? + +Some guidance: +- Use kebab-case: `my-workflow-name` +- Be descriptive but concise +- Think: What would someone search for to find this? + +[Offer suggestions based on their vision]" + +**Check for uniqueness:** +- Look for folder at `{bmb_creationsOutputFolder}/workflows/{proposed-name}/` +- If exists: "That name is taken. Want to try a variant like...?" +- Loop until unique name confirmed + +Document the final name. + +### 6. Confirm Target Location + +Based on module decision, confirm and document the target path: + +**For standalone/custom:** +- Target: `{customWorkflowLocation}/{workflow-name}/` +- Typically: `_bmad/custom/src/workflows/{workflow-name}/` + +**For modules:** +- Check module's workflow location from module.yaml +- Confirm path with user + +Document: `targetWorkflowPath: [confirmed path]` + +### 7. Update Plan with Classification + +Update `{workflowPlanFile}`: + +```markdown +## Classification Decisions + +**Workflow Name:** {name} +**Target Path:** {targetWorkflowPath} + +**4 Key Decisions:** +1. **Document Output:** {true/false} +2. **Module Affiliation:** {standalone/module-name} +3. **Session Type:** {single-session/continuable} +4. **Lifecycle Support:** {create-only/tri-modal} + +**Structure Implications:** +- [Document what this means: e.g., "Needs steps-c/, steps-e/, steps-v/", "Needs step-01b-continue.md", etc.] +``` + +### 8. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml +- IF P: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md +- IF C: Update plan frontmatter with stepsCompleted and classification, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All 4 key decisions made and documented +- Workflow named appropriately +- Target location confirmed +- Structural implications understood +- Plan updated with classification + +### ❌ SYSTEM FAILURE: + +- Skipping any of the 4 key decisions +- Naming before understanding (old pattern) +- Not explaining trade-offs +- Not checking for name conflicts + +**Master Rule:** The 4 key decisions determine everything else. Get them right before proceeding. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md b/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md new file mode 100644 index 00000000..32c26747 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md @@ -0,0 +1,282 @@ +--- +name: 'step-03-requirements' +description: 'Gather detailed requirements through collaborative conversation' + +nextStepFile: './step-04-tools.md' +workflowExamples: '../data/workflow-examples.md' +outputFormatStandards: '../data/output-format-standards.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 3: Requirements Gathering + +## STEP GOAL: + +To gather comprehensive requirements through conversation, building on the classification decisions, and document them in a standardized format for the design phase. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect gathering requirements +- ✅ Build on what we discovered and classified +- ✅ Ask 1-2 questions at a time, think about responses +- ✅ We already know the 4 key decisions - now we get details + +### Step-Specific Rules: + +- 🎯 Focus ONLY on requirements gathering +- 🚫 FORBIDDEN to propose workflow designs yet +- 💬 Ask conversationally, not like a form +- 📋 Use the standardized template (below) for consistent storage + +## EXECUTION PROTOCOLS: + +- 🎯 Load references as needed +- 💾 Store to standardized template in plan document +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until requirements are complete + +## CONTEXT BOUNDARIES: + +- Discovery (Step 1) gave us the vision +- Classification (Step 2) gave us the 4 key decisions +- Now we gather detailed requirements +- Don't design workflow steps yet - that's Step 6 + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Initialize Requirements + +"**Let's gather the requirements for your workflow.** + +We already know: +- [Summarize vision from discovery] +- [Summarize 4 key decisions from classification] + +Now I need to understand the details of how this workflow should work." + +### 2. Workflow Flow and Structure + +Load `{workflowExamples}` to reference diverse patterns. + +"**How should this workflow flow?** + +From our examples, workflows can be structured differently:" + +**Flow Patterns:** +- **Linear:** Step 1 → Step 2 → Step 3 → Finish +- **Looping:** Generate → Review → Generate more... until done +- **Branching:** Different paths based on user choices +- **Repeating:** Same steps, new content each session + +"Think about your workflow: +- Should it go straight through, or loop/branch? +- How many logical phases does it need? +- What are the major milestones?" + +**Think about their response...** + +### 3. User Interaction Style + +"**How collaborative should this be?** + +Think about the person running this workflow:" + +- **Highly Collaborative:** AI asks questions, guides, facilitates at each step +- **Mostly Autonomous:** AI does the work with occasional checkpoints +- **Guided Session:** AI leads through a structured experience +- **Mixed:** Some steps collaborative, some autonomous + +"Where does your workflow fit on this spectrum? + +And are there specific decision points where the user MUST choose something?" + +### 4. Input Requirements + +"**What does this workflow need to start?**" + +- What documents or data must be provided? +- Are there prerequisites or dependencies? +- Will users need to provide specific information? +- Any optional inputs that enhance the workflow? + +"**Think about their response before continuing...**" + +### 5. Output Specifications (IF document-producing) + +**ONLY if `workflowProducesDocuments: true` from classification:** + +Load `{outputFormatStandards}` and discuss: + +"**What should the output look like?** + +Since your workflow produces a document, let's decide the format:" + +**Four Template Types:** + +1. **Free-form (Recommended)** - Minimal structure, content-driven + - Use for: Most collaborative workflows + - Has: Basic frontmatter, progressive content, final polish step + +2. **Structured** - Required sections, flexible within each + - Use for: Reports, proposals, documentation + - Has: Clear section headers, consistent structure + +3. **Semi-structured** - Core sections + optional additions + - Use for: Forms, checklists, meeting minutes + - Has: Required fields, optional extras + +4. **Strict** - Exact format, specific fields + - Use for: Compliance, legal, regulated (rare) + - Has: Precise requirements, validation + +"Which format fits your workflow best?" + +**If Free-form (most common):** +- "We'll use a minimal template with basic frontmatter. The workflow will build the document section by section, with a final polish step to optimize flow." + +**If Structured/Semi-structured:** +- "What sections are required? Any optional sections?" + +**If Strict:** +- "Do you have an existing template to follow, or should we design one?" + +Document the output format decision. + +### 6. Output Specifications (IF non-document) + +**ONLY if `workflowProducesDocuments: false` from classification:** + +"**What does this workflow produce if not a document?** + +- Actions performed? +- Changes made to code/files? +- A decision or recommendation? +- A temporary artifact?" + +Document what the workflow produces. + +### 7. Success Criteria + +"**How will we know this workflow succeeded?** + +Think about the end result: +- What does 'done' look like? +- What would make a user satisfied? +- Are there quality criteria? +- Can we measure success?" + +"**Think about their response...**" + +### 8. Instruction Style (NOW, Not Earlier) + +**We ask this NOW because we understand the workflow:** + +"**How should the AI executing this workflow behave?**" + +**Intent-Based (Recommended for most):** +- Steps describe goals and principles +- AI adapts conversation naturally +- More flexible and responsive +- Example: "Guide user to define requirements through open-ended discussion" + +**Prescriptive:** +- Steps provide exact instructions +- More controlled and predictable +- Example: "Ask: 'What is your primary goal? A) Growth B) Efficiency C) Quality'" + +**Mixed:** +- Some steps prescriptive, others intent-based +- Use prescriptive for critical/required steps +- Use intent-based for creative/facilitative steps + +"Which style fits your workflow, or should it be mixed?" + +### 9. Store to Standardized Template + +Update `{workflowPlanFile}` with the requirements section: + +```markdown +## Requirements + +**Flow Structure:** +- Pattern: [linear/looping/branching/repeating] +- Phases: [list major phases] +- Estimated steps: [rough count] + +**User Interaction:** +- Style: [highly collaborative/mostly autonomous/guided/mixed] +- Decision points: [where user must choose] +- Checkpoint frequency: [how often to pause] + +**Inputs Required:** +- Required: [list] +- Optional: [list] +- Prerequisites: [list] + +**Output Specifications:** +- Type: [document/action/decision/temporary] +- Format: [free-form/structured/semi-structured/strict OR describe non-document output] +- Sections: [if structured] +- Frequency: [single/batch/continuous] + +**Success Criteria:** +- [list what success looks like] + +**Instruction Style:** +- Overall: [intent-based/prescriptive/mixed] +- Notes: [any specific style requirements] +``` + +### 10. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask} +- IF P: Execute {partyModeWorkflow} +- IF C: Save requirements to plan, update frontmatter, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Requirements gathered through conversation (not interrogation) +- Flow structure clearly understood +- Input/output specifications defined +- Output format decided (if document-producing) +- Success criteria established +- Instruction style determined +- All stored in standardized template + +### ❌ SYSTEM FAILURE: + +- Asking for instruction style before understanding the workflow +- Skipping output format discussion +- Not storing to standardized template +- Proceeding without understanding the flow + +**Master Rule:** Requirements build on classification. Use the standardized template so the next steps can read consistent data. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md b/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md new file mode 100644 index 00000000..2ffb3a20 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md @@ -0,0 +1,281 @@ +--- +name: 'step-04-tools' +description: 'Preview workflow structure, then configure tools with context' + +nextStepFile: './step-05-plan-review.md' +commonToolsCsv: '../data/common-workflow-tools.csv' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 4: Tools Configuration + +## STEP GOAL: + +To preview the workflow structure FIRST, then configure tools with clear context on where and how they'll be used. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect +- ✅ Tools need context to be configured intelligently +- ✅ We preview structure BEFORE deciding tool integration points + +### Step-Specific Rules: + +- 🎯 Preview workflow structure BEFORE configuring tools +- 🚫 FORBIDDEN to skip the preview - tools can't be configured without it +- 💬 Use the preview to make tool discussions concrete +- 🚫 Load tools from CSV, don't hardcode descriptions + +## EXECUTION PROTOCOLS: + +- 🎯 Present design preview based on requirements +- 💬 Discuss tools WITHIN the context of the preview +- 💾 Document tool decisions with integration points +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until tools are configured + +## CONTEXT BOUNDARIES: + +- Discovery → Classification → Requirements are complete +- We know the flow pattern, phases, interaction style +- NOW we can talk about tools with concrete examples +- This creates an intelligent tool configuration + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Present Design Preview + +"**Before we configure tools, let me preview what your workflow structure might look like.** + +Based on everything we've gathered, here's a rough outline:" + +Create a concrete preview showing: + +```markdown +## Workflow Structure Preview: {workflow-name} + +**Phase 1: Initialization** +- Welcome user, explain the workflow +- Gather any starting inputs +- [Specific to this workflow] + +**Phase 2: [Name from requirements]** +- [What happens in this phase] +- [User interaction point] + +**Phase 3: [Name from requirements]** +- [What happens in this phase] +- [User interaction point] + +**Phase 4: Completion** +- [What happens at the end] +- [Output/final step] +``` + +"This is just a preview - we'll design the actual steps in detail next. But this gives us context for discussing tools." + +**Ask:** "Does this structure feel right? Any major phases I'm missing?" + +### 2. Initialize Tools Discussion + +"**Now let's configure the tools and integrations for your workflow.** + +Since we can see the structure, we can talk about tools concretely: 'Party Mode could fit here in Phase 2 for creative brainstorming...' instead of abstractly." + +### 3. Load and Present Available Tools + +Load `{commonToolsCsv}` and present by category: + +"**Available BMAD Tools:** + +**Core Tools:** +- [List from CSV with descriptions] + +**Optional Tools:** +- [List from CSV with descriptions]" + +### 4. Configure Core Tools WITH Context + +Go through each core tool, referencing the preview: + +"**Party Mode** - For creative, unrestricted exploration + +Looking at your workflow structure, I see potential in: +- [Specific phase from preview] for [specific reason] + +Should we include Party Mode? If so, where would it fit best?" + +"**Advanced Elicitation** - For deep exploration and quality + +This could work well in: +- [Specific phase] for [specific reason] + +Should we include Advanced Elicitation? Where would you want quality gates or deeper exploration?" + +"**Brainstorming** - For idea generation + +In your workflow, this might fit in: +- [Specific phase if applicable] + +Should we include Brainstorming?" + +### 5. Configure LLM Features WITH Context + +"**LLM Features to enhance your workflow:**" + +"**Web-Browsing** - For real-time information + +Would your workflow benefit from: +- Current data/information +- Research during execution +- Live references + +If yes, where in the structure would this be needed?" + +"**File I/O** - For reading/writing files + +Your workflow [will/won't] need file operations based on: +- [Input requirements from requirements] +- [Output specifications from requirements] + +Any specific file operations needed?" + +"**Sub-Agents** - For delegating specialized tasks + +Could any part of your workflow benefit from: +- Specialized expertise +- Parallel processing +- Focused sub-tasks + +Looking at your structure, [specific phase] might benefit..." + +"**Sub-Processes** - For parallel workflows + +Would any phase benefit from: +- Running multiple processes in parallel +- Coordinating multiple workflows + +If so, which phase?" + +### 6. Configure Memory Systems + +"**Memory and State Management**" + +**If continuable from classification:** +"Since your workflow is continuable, it needs to track progress between sessions. + +We'll use: +- `stepsCompleted` array in output frontmatter +- `lastStep` tracking +- `step-01b-continue.md` for resuming + +Any additional state we need to track?" + +**If single-session:** +"Your workflow is single-session, so we'll keep state simple - no complex memory needed." + +### 7. External Integrations (Optional) + +"**External Integrations** - MCP, databases, APIs + +Based on your workflow, are there any external systems it needs to connect to? +- Databases? +- APIs? +- MCP servers? +- Other tools?" + +If yes, note installation requirements. + +### 8. Installation Assessment + +"**Installation and Dependencies** + +Some tools require additional setup. + +Based on what we've selected: +- [List any tools requiring installation] +- [Assess user comfort level] + +Are you comfortable with these installations, or should we consider alternatives?" + +### 9. Store Tools Configuration + +Update `{workflowPlanFile}`: + +```markdown +## Tools Configuration + +**Core BMAD Tools:** +- **Party Mode:** [included/excluded] - Integration point: [specific phase/reason] +- **Advanced Elicitation:** [included/excluded] - Integration point: [specific phase/reason] +- **Brainstorming:** [included/excluded] - Integration point: [specific phase/reason] + +**LLM Features:** +- **Web-Browsing:** [included/excluded] - Use case: [specific need] +- **File I/O:** [included/excluded] - Operations: [specific needs] +- **Sub-Agents:** [included/excluded] - Use case: [specific need] +- **Sub-Processes:** [included/excluded] - Use case: [specific need] + +**Memory:** +- Type: [continuable/single-session] +- Tracking: [stepsCompleted, lastStep, etc.] + +**External Integrations:** +- [List any selected with purposes] + +**Installation Requirements:** +- [List tools needing installation] +- User preference: [willing/not willing/alternatives] +``` + +### 10. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask} +- IF P: Execute {partyModeWorkflow} +- IF C: Save tools to plan, update frontmatter, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Design preview presented BEFORE tools discussion +- Tools discussed WITHIN concrete context +- Integration points clearly identified +- User can visualize where tools fit +- All decisions documented in plan + +### ❌ SYSTEM FAILURE: + +- Configuring tools without design preview +- Abstract tool discussions ("it could go somewhere") +- Not identifying concrete integration points +- Hardcoding tool descriptions instead of using CSV + +**Master Rule:** Tools need context. Preview structure first, then configure tools with concrete integration points. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md b/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md new file mode 100644 index 00000000..f0ff6625 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md @@ -0,0 +1,242 @@ +--- +name: 'step-05-plan-review' +description: 'Review the complete workflow plan and approve before design' + +nextStepFile: './step-06-design.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 5: Plan Review and Approval + +## STEP GOAL: + +To present the complete workflow plan (discovery, classification, requirements, tools) for review and approval before proceeding to the design phase. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect conducting a design review +- ✅ Present the complete plan clearly +- ✅ Solicit feedback and make refinements +- ✅ Get explicit approval before proceeding to design + +### Step-Specific Rules: + +- 🎯 Focus ONLY on review and refinement +- 🚫 FORBIDDEN to start designing workflow steps in this step +- 💬 Present plan clearly, ask targeted questions +- 🚫 DO NOT proceed to design without user approval + +## EXECUTION PROTOCOLS: + +- 🎯 Present complete plan from {workflowPlanFile} +- 💾 Capture any modifications or refinements +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until user approves + +## CONTEXT BOUNDARIES: + +- Discovery (Step 1) → Classification (Step 2) → Requirements (Step 3) → Tools (Step 4) +- ALL the information needed for design is now captured +- This is the final checkpoint before designing the workflow structure +- Once we proceed to Step 6, we'll be designing actual step files + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Initialize Review + +"**Let's review the complete plan before we start designing.** + +We've covered a lot of ground. Let me walk you through everything we've decided, and you can tell me what looks right and what needs adjustment." + +### 2. Present Complete Plan + +Load and present from `{workflowPlanFile}`: + +"**Complete Workflow Plan: {workflow-name}** + +--- + +**1. DISCOVERY** (from Step 1) + +**Your Vision:** +[Present user's vision] + +**Who It's For:** +[Present users/audience] + +**Key Insights:** +[Present important context] + +--- + +**2. CLASSIFICATION** (from Step 2) + +**The 4 Key Decisions:** +1. **Document Output:** {true/false} - [what it produces] +2. **Module Affiliation:** {standalone/module} - {target path} +3. **Session Type:** {single-session/continuable} - [implications] +4. **Lifecycle Support:** {create-only/tri-modal} - [implications] + +**Workflow Name:** {name} +**Target Location:** {path} + +--- + +**3. REQUIREMENTS** (from Step 3) + +**Flow Structure:** +- Pattern: {linear/looping/branching/repeating} +- Phases: {list major phases} +- Estimated steps: {count} + +**User Interaction:** +- Style: {collaborative/autonomous/guided/mixed} +- Decision points: {where user must choose} + +**Inputs:** {required and optional} +**Output:** {type and format} +**Success Criteria:** {what success looks like} +**Instruction Style:** {intent/prescriptive/mixed} + +--- + +**4. TOOLS CONFIGURATION** (from Step 4) + +**Core Tools:** +- Party Mode: {included/excluded} - {integration point} +- Advanced Elicitation: {included/excluded} - {integration point} +- Brainstorming: {included/excluded} - {integration point} + +**LLM Features:** +- Web-Browsing: {included/excluded} +- File I/O: {included/excluded} +- Sub-Agents: {included/excluded} +- Sub-Processes: {included/excluded} + +**Memory:** {continuable/single-session} + +--- + +### 3. Detailed Review by Section + +"**Let's go through this systematically. I want your feedback on each area:**" + +**A. Vision and Scope (Discovery)** +- "Does the 'Your Vision' section capture what you're trying to build?" +- "Anything we missed in the key insights?" + +**B. Structural Decisions (Classification)** +- "Do the 4 key decisions still feel right?" +- "Any second thoughts on continuable vs single-session?" +- "Create-only or tri-modal - still the right call?" + +**C. Requirements (Details)** +- "Does the flow structure match what you envisioned?" +- "Are the interaction style and decision points accurate?" +- "Input/output specifications complete?" +- "Success criteria clear?" + +**D. Tools (Integrations)** +- "Do the selected tools make sense?" +- "Integration points feel right?" +- "Any tools we should add or remove?" + +### 4. Collect Feedback + +"**Your feedback:** + +For each section above, tell me: +1. What looks good and should stay as-is +2. What needs modification or refinement +3. What's missing that should be added +4. Anything unclear or confusing + +**Take your time - this is our last chance to make changes before we start designing the actual workflow.**" + +### 5. Process Feedback and Refine + +For each feedback item: + +- Document the requested change +- Discuss implications on workflow design +- Make the refinement +- Confirm with user + +Update `{workflowPlanFile}` with all approved changes. + +### 6. Final Confirmation + +"**One last check before we proceed to design:** + +Based on everything we've discussed: + +- [Re-state the workflow's purpose in one sentence] +- [Re-state the key structural decision: continuable/tri-modal] +- [Re-state the flow pattern] + +You're approving this plan to move into the actual workflow design phase. + +Ready to proceed?" + +### 7. Update Plan Status + +Update `{workflowPlanFile}` frontmatter: + +```yaml +status: APPROVED_FOR_DESIGN +approvedDate: [current date] +``` + +### 8. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Design + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask} +- IF P: Execute {partyModeWorkflow} +- IF C: Update plan frontmatter with approval, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete plan presented clearly from the plan document +- All 4 sections reviewed systematically +- User feedback collected and incorporated +- User explicitly approves the plan +- Plan status updated to APPROVED_FOR_DESIGN +- Ready to proceed to design phase + +### ❌ SYSTEM FAILURE: + +- Not loading plan from {workflowPlanFile} +- Skipping review sections +- Not documenting refinements +- Proceeding without explicit approval +- Not updating plan status + +**Master Rule:** The plan must be complete and approved before design. This is the gatekeeper step. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-06-design.md b/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md similarity index 76% rename from src/modules/bmb/workflows/create-workflow/steps/step-06-design.md rename to src/modules/bmb/workflows/workflow/steps-c/step-06-design.md index f4031cad..f3b1da67 100644 --- a/src/modules/bmb/workflows/create-workflow/steps/step-06-design.md +++ b/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md @@ -2,22 +2,19 @@ name: 'step-06-design' description: 'Design the workflow structure and step sequence based on gathered requirements, tools configuration, and output format' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-design.md' -nextStepFile: '{workflow_path}/steps/step-07-build.md' -workflowFile: '{workflow_path}/workflow.md' -# Output files for workflow creation process +nextStepFile: './step-07-foundation.md' targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append design details directly to workflow plan +stepTemplate: '../templates/step-template.md' +stepTypePatterns: '../data/step-type-patterns.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +frontmatterStandards: '../data/frontmatter-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +inputDiscoveryStandards: '../data/input-discovery-standards.md' +workflowChainingStandards: '../data/workflow-chaining-standards.md' +trimodalWorkflowStructure: '../data/trimodal-workflow-structure.md' --- # Step 6: Workflow Structure Design @@ -55,7 +52,7 @@ To collaboratively design the workflow structure, step sequence, and interaction - 🎯 Guide collaborative design process - 💾 After completing design, append to {workflowPlanFile} -- 📖 Update plan frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step +- 📖 Update frontmatter stepsCompleted to add this step when completed. - 🚫 FORBIDDEN to load next step until user selects 'C' and design is saved ## CONTEXT BOUNDARIES: @@ -69,33 +66,37 @@ To collaboratively design the workflow structure, step sequence, and interaction ## DESIGN REFERENCE MATERIALS: -When designing, you may load these documents as needed: +When designing, you may load these data standards as needed: -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` - Step file structure -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md` - Continuable init step template -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md` - Continuation step template -- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` - Workflow configuration -- `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md` - Complete example +- {stepTemplate} - Step file structure template +- {stepTypePatterns} - Templates for different step types (init, middle, branch, validation, final) +- {menuHandlingStandards} - Menu patterns and handler rules +- {frontmatterStandards} - Variable definitions and path rules +- {outputFormatStandards} - Output document patterns +- {inputDiscoveryStandards} - How to discover documents from prior workflows +- {workflowChainingStandards} - How workflows connect in sequences +- {trimodalWorkflowStructure} - Tri-modal workflow patterns (if applicable) -## WORKFLOW DESIGN PROCESS: +Example workflow: +- `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md` + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Step Structure Design -Let's reference our step creation documentation for best practices: +Load {stepTypePatterns} for available step type templates: -Load and reference step-file architecture guide: - -``` -Read: {project-root}/_bmad/bmb/docs/workflows/templates/step-template.md -``` - -This shows the standard structure for step files. Also reference: - -``` -Read: {project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md -``` - -This shows the continuation step pattern for workflows that might take multiple sessions. +This shows the standard structure for all step types: +- Init Step (Continuable) +- Continuation Step (01b) +- Middle Step (Standard/Simple) +- Branch Step +- Validation Sequence Step +- Init Step (With Input Discovery) +- Final Polish Step +- Final Step Based on the approved plan, collaboratively design the info to answer the following for the build plan: @@ -126,10 +127,11 @@ If **YES** to any of these, we should include continuation support using step-01 ### 2. Interaction Pattern Design -Design how users will interact with the workflow: +Load {menuHandlingStandards} for menu pattern options: +Design how users will interact with the workflow: - Where should users provide input vs where the AI works autonomously? -- What type of menu options are needed at each step? +- What menu pattern does each step need? (Standard A/P/C, Auto-proceed, Custom, Conditional) - Should there be Advanced Elicitation or Party Mode options? - How will users know their progress? - What confirmation points are needed? @@ -182,6 +184,20 @@ Identify unique requirements: - Should it integrate with other workflows? - Does it need to handle multiple scenarios? +**Input Discovery:** + +If this workflow depends on documents from prior workflows, load {inputDiscoveryStandards}: +- What prior workflow outputs does this workflow need? +- Are these required or optional inputs? +- How will the workflow discover these documents? + +**Workflow Chaining:** + +If this workflow is part of a sequence, load {workflowChainingStandards}: +- What workflow comes before this one? +- What workflow comes after this one? +- What outputs does this workflow produce for the next? + ### 8. Design Review and Refinement Present the design for review: diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md b/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md new file mode 100644 index 00000000..c6b107d5 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md @@ -0,0 +1,238 @@ +--- +name: 'step-07-foundation' +description: 'Create workflow folder structure, workflow.md, and main output template(s)' + +nextStepFile: './step-08-build-step-01.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +workflowTemplate: '../templates/workflow-template.md' +outputFormatStandards: '../data/output-format-standards.md' +minimalOutputTemplate: '../templates/minimal-output-template.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 7: Foundation Build + +## STEP GOAL: + +To create the workflow folder structure, the main workflow.md file, and the primary output template(s) that step files will reference. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ 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 implementation expertise and best practices +- ✅ User brings their specific requirements and design approvals + +### Step-Specific Rules: + +- 🎯 Focus ONLY on creating foundation elements (folder, workflow.md, main template) +- 🚫 FORBIDDEN to create step files yet - that comes next +- 💬 Get confirmation before creating each foundation element +- 🚪 CREATE files in the correct target location + +## EXECUTION PROTOCOLS: + +- 🎯 Create foundation systematically from approved design +- 💾 Document what was created in the plan +- 📖 Update frontmatter stepsCompleted to add this step when completed +- 🚫 FORBIDDEN to load next step until user selects 'C' + +## CONTEXT BOUNDARIES: + +- Approved plan from step 6 guides implementation +- Design specifies: workflow name, continuable or not, document output type, step count +- Load templates and documentation as needed during build +- Follow step-file architecture principles + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Confirm Foundation Readiness + +Based on the approved design from step 6, confirm: + +"**I have your approved design and I'm ready to create the workflow foundation.** + +From your design, I'll be creating: + +**Workflow:** {new_workflow_name} +**Location:** {targetWorkflowPath} +**Type:** [continuable/single-session] +**Document Output:** [yes/no - template type if yes] +**Estimated Steps:** [number from design] + +Ready to proceed with creating the folder structure?" + +### 2. Create Folder Structure + +Create the workflow folder structure: + +``` +{targetWorkflowPath}/ +├── workflow.md # To be created +├── steps-c/ # Create flow steps +│ ├── step-01-init.md +│ ├── step-01b-continue.md # If continuable +│ └── [remaining steps] +├── steps-v/ # Validate flow steps (to be created later) +├── data/ # Shared reference data +└── templates/ # Output templates +``` + +**For BMB module workflows:** The target will be `_bmad/custom/src/workflows/{workflow_name}/` +**For other modules:** Check module's custom_workflow_location + +Create the folders and confirm structure. + +### 3. Generate workflow.md + +Load {workflowTemplate} and create workflow.md with: + +**Frontmatter:** +```yaml +--- +name: '{workflow-name-from-design}' +description: '{description-from-design}' +web_bundle: true +--- +``` + +**Content:** +- Workflow name and description +- Goal statement +- Role definition +- Meta-context (if applicable) +- Initialization sequence pointing to steps-c/step-01-init.md +- Configuration loading instructions + +**If tri-modal (Create + Edit + Validate):** +Add mode routing logic to workflow.md: +- IF invoked with -c: Load ./steps-c/step-01-init.md +- IF invoked with -v: Load ./steps-v/step-01-validate.md +- IF invoked with -e: Load ./steps-e/step-01-edit.md + +### 4. Create Main Output Template + +**Load {outputFormatStandards} to determine template type.** + +**From the design, determine:** +- Free-form (recommended) - Minimal frontmatter + progressive append +- Structured - Required sections with flexible content +- Semi-structured - Core sections + optional additions +- Strict - Exact format (rare, compliance/legal) + +**For Free-form (most common):** + +Create `templates/output-template.md`: +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- +``` + +If the workflow produces a document with sections: +```markdown +# {{document_title}} + +[Content appended progressively by workflow steps] +``` + +**For Structured/Semi-structured:** + +Create template with section placeholders based on design: +```markdown +# {{title}} + +## {{section_1}} +[Content to be filled] + +## {{section_2}} +[Content to be filled] +``` + +**For Non-Document Workflows:** + +No output template needed. Document this in the plan. + +### 5. Document Foundation in Plan + +Append to {workflowPlanFile}: + +```markdown +## Foundation Build Complete + +**Created:** +- Folder structure at: {targetWorkflowPath} +- workflow.md +- Main template: [template-name] + +**Configuration:** +- Workflow name: {name} +- Continuable: [yes/no] +- Document output: [yes/no - type] +- Mode: [create-only or tri-modal] + +**Next Steps:** +- Step 8: Build step-01 (and step-01b if continuable) +- Step 9: Build remaining steps (repeatable) +``` + +### 6. Present MENU OPTIONS + +Display: **Foundation Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Step 01 Build + +#### 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 redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save foundation summary to {workflowPlanFile}, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN C is selected and foundation is saved to plan will you load {nextStepFile} to begin building step-01. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Folder structure created in correct location +- workflow.md created with proper frontmatter and initialization +- Main output template created (if document-producing workflow) +- Foundation documented in {workflowPlanFile} +- Frontmatter updated with stepsCompleted + +### ❌ SYSTEM FAILURE: + +- Creating folders without user confirmation +- Missing mode routing for tri-modal workflows +- Wrong template type for output format +- Not documenting what was created + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md b/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md new file mode 100644 index 00000000..8179ed35 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md @@ -0,0 +1,333 @@ +--- +name: 'step-08-build-step-01' +description: 'Build step-01-init.md and step-01b-continue.md (if continuable) with any supporting files' + +nextStepFile: './step-09-build-next-step.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +stepTemplate: '../templates/step-template.md' +stepTypePatterns: '../data/step-type-patterns.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +inputDiscoveryStandards: '../data/input-discovery-standards.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 8: Build Step 01 (and 01b if Continuable) + +## STEP GOAL: + +To build the first step file(s) for the new workflow - step-01-init.md and step-01b-continue.md if the workflow is continuable - including any supporting files these steps need. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ 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 implementation expertise and best practices +- ✅ User brings their specific requirements and design approvals + +### Step-Specific Rules: + +- 🎯 Focus ONLY on building step-01 (and 01b if continuable) +- 🚫 FORBIDDEN to build other steps yet - use step-09 for those +- 💬 Generate step content collaboratively based on approved design +- 🚪 CREATE files in the correct target location + +## EXECUTION PROTOCOLS: + +- 🎯 Load standards to understand step type patterns +- 💾 Document what was created in the plan +- 📖 Update frontmatter stepsCompleted to add this step when completed +- 🚫 FORBIDDEN to load next step until user selects 'C' + +## CONTEXT BOUNDARIES: + +- Approved design from step 6 specifies step-01's purpose and type +- Load step type patterns to understand init step structure +- Frontmatter and menu standards ensure compliance +- This is the FIRST step - sets up everything that follows + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Standards for Init Steps + +**Load {stepTypePatterns}** to understand the init step patterns: +- Init Step (Non-Continuable) - For single-session workflows +- Init Step (Continuable) - For multi-session workflows +- Init Step (With Input Discovery) - If workflow needs prior documents + +**Load {frontmatterStandards}** for variable and path rules. + +**Load {menuHandlingStandards}** for menu patterns (init steps typically use auto-proceed or C-only). + +### 2. Determine Step 01 Type + +From the approved design, determine: + +**Is the workflow continuable?** +- **YES:** Use Init Step (Continuable) pattern +- **NO:** Use Init Step (Non-Continuable) pattern + +**Does the workflow need input discovery?** +- **YES:** Use Init Step (With Input Discovery) pattern +- **NO:** Standard init pattern + +Confirm with user: "Based on your design, step-01 will be [continuable/non-continuable] with [input discovery/standard init]. Is this correct?" + +### 3. Build step-01-init.md + +**Load {stepTemplate}** for base structure. + +Create `steps-c/step-01-init.md` with: + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: '[from design]' + +# File references (ONLY variables used in this step) +nextStepFile: './step-02-[next-step-name].md' +outputFile: '{output_folder}/[output-name].md' +templateFile: '../templates/output-template.md' # If applicable + +# Continuation support (if continuable) +continueFile: './step-01b-continue.md' # If continuable + +# Input discovery (if needed) +inputDocuments: [] +requiredInputCount: [number] +moduleInputFolder: '{module_output_folder}' +inputFilePatterns: ['*-prd.md', '*-ux.md'] # From design + +# Tasks (if A/P menu used) +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- +``` + +**Content Structure:** +```markdown +# Step 1: [Step Name From Design] + +## STEP GOAL: +[Single sentence goal from design] + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: +- ✅ You are [role from design] +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring [expertise], user brings [theirs] +- ✅ Together we produce something better + +### Step-Specific Rules: +- 🎯 Focus only on [specific task for step-01] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage] + +## EXECUTION PROTOCOLS: +- 🎯 [Protocol 1] +- 💾 [Protocol 2 - create/append to output] +- 📖 [Protocol 3 - tracking] +- 🚫 This is the init step - sets up everything + +## CONTEXT BOUNDARIES: +- [What's available at step 01] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [none - this is first step] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. [First action - from design] +[Instructions for step-01 - intent-based, not prescriptive] + +### 2. [Second action - from design] +[Instructions] + +### ... [continue for all actions in step-01] + +### N. Present MENU OPTIONS +[Menu from design - typically C-only for init, or A/P/C if appropriate] + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' + +#### Menu Handling Logic: +- IF C: Create/append to {outputFile} with content, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, then redisplay menu + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: +[What success looks like for step-01] + +### ❌ SYSTEM FAILURE: +[What failure looks like] + +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +**Customize content based on:** +- The step's goal from the design +- The workflow's role and persona +- Whether it's continuable +- Whether it needs input discovery +- The template type (if document-producing) + +### 4. Build step-01b-continue.md (If Continuable) + +**If workflow is continuable**, create `steps-c/step-01b-continue.md`: + +**Frontmatter:** +```yaml +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation from previous session' + +outputFile: '{output_folder}/[output-name].md' +workflowFile: '../workflow.md' +nextStepOptions: + step-02: './step-02-[name].md' + step-03: './step-03-[name].md' + # ... add all subsequent steps +--- +``` + +**Content:** +```markdown +# Step 1b: Continue Workflow + +## STEP GOAL: +To resume the workflow from where it was left off in a previous session. + +## MANDATORY EXECUTION RULES: +[Standard universal rules] + +## CONTEXT BOUNDARIES: +- User has run this workflow before +- Output file exists with stepsCompleted array +- Need to route to the correct next step + +## MANDATORY SEQUENCE + +### 1. Welcome Back +"**Welcome back!** Let me check where we left off..." + +### 2. Read stepsCompleted from Output +Load {outputFile} and read frontmatter `stepsCompleted` array. + +### 3. Determine Next Step +Find the last completed step and identify the next step to load. + +### 4. Route to Correct Step +Load the appropriate next step file based on stepsCompleted. + +## MENU OPTIONS +Display continuation status and offer to proceed. + +## SUCCESS/FAILURE METRICS +[Standard metrics] +``` + +### 5. Create Supporting Files (If Needed) + +**Does step-01 need any:** + +**Small templates?** (inline in step, no separate file needed) + +**Data files?** (create if step references CSV data) + +**Validation checklists?** (create if step validates something) + +**If supporting files are needed, create them in `data/` folder and update step-01 frontmatter to reference them.** + +### 6. Document Build in Plan + +Append to {workflowPlanFile}: + +```markdown +## Step 01 Build Complete + +**Created:** +- steps-c/step-01-init.md +- steps-c/step-01b-continue.md [if continuable] +- [any supporting files] + +**Step Configuration:** +- Type: [continuable/non-continuable] +- Input Discovery: [yes/no] +- Next Step: step-02-[name] + +**Supporting Files:** +- [list any data files, templates created] +``` + +### 7. Present MENU OPTIONS + +Display: **Step 01 Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Next Step Build + +#### 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 + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save build summary to {workflowPlanFile}, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} +- 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 build is saved to plan will you load {nextStepFile} to begin building the next step. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- step-01-init.md created with proper structure +- step-01b-continue.md created (if continuable) +- Frontmatter follows {frontmatterStandards} +- Menu handling follows {menuHandlingStandards} +- Step type pattern followed correctly +- Supporting files created (if needed) +- Build documented in plan + +### ❌ SYSTEM FAILURE: + +- Creating step without following template +- Missing continuation support for continuable workflow +- Wrong menu pattern for step type +- Frontmatter variables not used in step body +- Hardcoded paths instead of variables + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md b/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md new file mode 100644 index 00000000..e7dcbb5e --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md @@ -0,0 +1,306 @@ +--- +name: 'step-09-build-next-step' +description: 'Build the next step in the workflow sequence - repeatable until all steps are built' + +nextStepFile: './step-09-build-next-step.md' # Self-referencing - repeats until complete +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +stepTemplate: '../templates/step-template.md' +stepTypePatterns: '../data/step-type-patterns.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +csvDataFileStandards: '../data/csv-data-file-standards.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 9: Build Next Step (Repeatable) + +## STEP GOAL: + +To build the next step file in the workflow sequence based on the approved design. This step is REPEATABLE - continue running it until all steps from the design have been built. + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ 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 implementation expertise and best practices +- ✅ User brings their specific requirements and design approvals + +### Step-Specific Rules: + +- 🎯 Load the plan to determine WHICH step to build next +- 🚫 FORBIDDEN to skip steps or build out of order +- 💬 Each step is built collaboratively based on approved design +- 🚪 This step REPEATS until all workflow steps are built + +## EXECUTION PROTOCOLS: + +- 🎯 Always check what's been built, then build the next one +- 💾 Document each step in the plan as it's built +- 📖 Update frontmatter stepsCompleted to add each step when completed +- 🚫 Don't proceed to completion until ALL workflow steps are built + +## CONTEXT BOUNDARIES: + +- Approved design from step 6 specifies all steps +- The plan tracks which steps have been built +- Load step type patterns to understand each step's structure +- This step continues until the design is fully implemented + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Check Build Status + +Load {workflowPlanFile} and check: + +**What steps have been built so far?** +- Step 01: Always built in step-08 +- Subsequent steps: Track in plan + +**What is the NEXT step to build?** + +From the design in the plan, identify: +- Step number and name +- Step type (Middle/Standard, Middle/Simple, Branch, Validation, Final Polish, Final) +- This step's goal and purpose + +Confirm: "The next step to build is **step-{N}-{name}** which is a [step type]. Its goal is: [goal from design]. Ready to proceed?" + +### 2. Load Standards for This Step Type + +**Load {stepTypePatterns}** and find the pattern for this step type: +- Middle Step (Standard) - A/P/C menu, collaborative content +- Middle Step (Simple) - C only menu, no A/P +- Branch Step - Custom menu with routing logic +- Validation Sequence - Auto-proceed through checks +- Final Polish Step - Optimizes document built section-by-section +- Final Step - Completion, no next step + +**Load {frontmatterStandards}** for variable rules. + +**Load {menuHandlingStandards}** for menu patterns. + +**Load {outputFormatStandards}** if this step outputs to document. + +### 3. Build the Step File + +**Load {stepTemplate}** for base structure. + +Create `steps-c/step-{N}-{name}.md` with: + +**Frontmatter:** +```yaml +--- +name: 'step-{N}-{name}' +description: '[what this step does]' + +# File references (ONLY variables used in this step) +nextStepFile: './step-{N+1}-[next-name].md' # Omit for final step +outputFile: '{output_folder}/[output-name].md' +templateFile: '../templates/[template-name].md' # If applicable + +# Data files (if this step needs them) +someData: '../data/[data-file].csv' # If applicable + +# Tasks (if A/P menu used) +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- +``` + +**Content Structure:** (Same pattern as step-01, customized for this step) + +```markdown +# Step {N}: [Step Name From Design] + +## STEP GOAL: +[Single sentence goal from design] + +## 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: +- ✅ You are [role from design] +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring [expertise for this step], user brings [theirs] + +### Step-Specific Rules: +- 🎯 Focus only on [specific task for this step] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage for this step] + +## EXECUTION PROTOCOLS: +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 💾 [Protocol - append to output if this step outputs] +- 📖 [Protocol - tracking if applicable] + +## CONTEXT BOUNDARIES: +- [What's available at this step] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [what this step depends on from previous steps] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. [First action - from design] +[Intent-based instructions for this step] + +### 2. [Second action - from design] +[Intent-based instructions] + +### ... [continue for all actions in this step] + +### N. Present MENU OPTIONS +[Menu based on step type - Standard A/P/C, Simple C-only, Branching, Auto-proceed] + +#### EXECUTION RULES: +[Based on menu type from {menuHandlingStandards}] + +#### Menu Handling Logic: +[Handler for this step's menu] + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: +[What success looks like for this step] + +### ❌ SYSTEM FAILURE: +[What failure looks like] + +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +**Customize based on:** +- Step type pattern from {stepTypePatterns} +- The step's specific goal and actions from design +- What this step outputs (if document-producing workflow) +- Menu pattern appropriate for step type + +### 4. Create Supporting Files (If Needed) + +**Does this step need any:** + +**Small templates?** - Inline in step content or create small template file + +**Data files?** - If step references CSV data, create in `data/` folder +- Load {csvDataFileStandards} for CSV structure +- Create CSV with proper headers and data + +**Validation checklists?** - If this step validates something, create checklist + +**Section templates?** - If step outputs to specific document section + +**If supporting files are created:** +1. Create in appropriate folder (`data/` or `templates/`) +2. Update step frontmatter to reference them +3. Document in plan + +### 5. Document Build in Plan + +Append to {workflowPlanFile}: + +```markdown +## Step {N} Build Complete + +**Created:** +- steps-c/step-{N}-{name}.md +- [any supporting files] + +**Step Configuration:** +- Type: [step type] +- Outputs to: [output section or file] +- Next Step: [next step or "final step"] + +**Supporting Files:** +- [list any data files, templates created for this step] +``` + +### 6. Check If More Steps Needed + +After documenting, check the design: + +**Are all steps from the design now built?** +- **YES:** Proceed to completion menu (option 7 below) +- **NO:** Present continuation menu (option 6 below) + +### 6a. Present MENU OPTIONS (More Steps Remaining) + +Display: **Step {N} Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Build Next Step + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY build next step when user selects 'C' +- After other menu items execution, return to this menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save build summary to {workflowPlanFile}, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} (which is THIS FILE - self-referencing for next iteration) +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6a-present-menu-options-more-steps-remaining) + +### 6b. Present MENU OPTIONS (All Steps Complete) + +Display: **All Workflow Steps Built! Select an Option:** [R] Review Built Steps [V] Proceed to Validation [C] Complete Build + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User selects final action + +#### Menu Handling Logic: + +- IF R: List all built steps with their paths, allow review, then redisplay menu +- IF V: Save final build summary to {workflowPlanFile}, update frontmatter stepsCompleted to include ALL steps, then load `./step-10-confirmation.md` +- IF C: Same as V (complete and proceed) +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6b-present-menu-options-all-steps-complete) + +## CRITICAL STEP COMPLETION NOTE + +This step REPEATS until all workflow steps from the design are built. When complete, user selects V or C to proceed to completion. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Each step file created with proper structure for its type +- Frontmatter follows {frontmatterStandards} +- Menu handling follows {menuHandlingStandards} +- Step type pattern followed correctly +- Supporting files created as needed +- Each build documented in plan +- Process continues until ALL design steps are built + +### ❌ SYSTEM FAILURE: + +- Building steps out of order +- Skipping steps from the design +- Wrong menu pattern for step type +- Not documenting each step in plan +- Proceeding to completion before all steps built + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md b/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md new file mode 100644 index 00000000..c7534cb5 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md @@ -0,0 +1,320 @@ +--- +name: 'step-10-confirmation' +description: 'Confirm workflow completion - validate plan completion or conversion coverage' + +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +nextStepFile: './step-11-completion.md' +validationWorkflow: '{targetWorkflowPath}/steps-v/step-01-validate.md' +--- + +# Step 10: Confirmation + +## STEP GOAL: + +Confirm the workflow build is complete by checking plan metadata. If this is a conversion, verify all original workflow elements are covered. If new, validate all plan requirements were met. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER skip reading the plan file completely +- 📖 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 quality assurance 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 thorough review expertise +- ✅ User confirms everything is complete + +### Step-Specific Rules: + +- 🎯 Focus on confirmation and verification +- 🚫 FORBIDDEN to skip checking plan metadata +- 💬 MUST read the entire plan to verify completion +- 📋 Different paths for conversion vs new workflows + +## EXECUTION PROTOCOLS: + +- 🎯 Load and read workflow plan completely +- 💾 Check for conversionFrom metadata field +- 📖 Route to appropriate confirmation path +- 🚫 FORBIDDEN to proceed without verification + +## CONTEXT BOUNDARIES: + +- All build steps are complete +- This is the final verification before completion +- Conversion workflows get coverage check +- New workflows get plan completion check + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Load Workflow Plan + +**Load the workflowPlanFile completely:** + +Read `{workflowPlanFile}` entirely to extract: +- Frontmatter metadata (check for `conversionFrom`) +- Discovery notes +- All requirements from classification, design, tools sections +- Original workflow analysis (if conversion) + +"**Loading workflow plan for confirmation...**" + +### 2. Check Conversion Metadata + +**Examine plan frontmatter for `conversionFrom` field:** + +```yaml +conversionFrom: '{path to source workflow if this is a conversion}' +``` + +**IF conversionFrom EXISTS:** +Route to [Conversion Confirmation](#3-conversion-confirmation-path) + +**ELSE (no conversionFrom):** +Route to [New Workflow Confirmation](#4-new-workflow-confirmation-path) + +--- + +### 3. Conversion Confirmation Path + +**DO NOT BE LAZY - Load and review the ORIGINAL workflow completely:** + +"**This is a workflow conversion. Verifying all original elements are covered...**" + +**Load the original workflow from conversionFrom path:** +- Read EVERY file from the source workflow +- Extract original goal, steps, instructions + +**For each element from the original, verify coverage:** + +#### A. Original Goal Coverage + +"**Original Goal:** {from source} + +**✅ Covered in new workflow:** {how it's covered} + +OR + +**⚠️ Partial coverage:** {what's covered} - {what might be missing} + +OR + +**❌ Not covered:** {explain gap}" + +#### B. Original Step Coverage + +**For EACH step from the original workflow:** + +| Original Step | Purpose | Covered In | Status | +|---------------|---------|------------|--------| +| {step name} | {purpose} | {new step location} | ✅ Full / ⚠️ Partial / ❌ Missing | + +"**Step-by-step coverage:** {count} of {total} steps fully covered" + +#### C. Original Instruction Patterns + +**Review how the original workflow instructed the LLM:** + +"**Original instruction style:** {describe} + +**New workflow instruction style:** {describe} + +**Collaborative patterns preserved:** {yes/no + details} + +**Key LLM instructions covered:** +{List the key instruction patterns and how they're preserved}" + +#### D. Conversion Coverage Summary + +Present findings: + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Conversion Coverage Report** + +**Source:** {conversionFrom} +**Target:** {targetWorkflowPath} + +**Overall Coverage:** {percentage}% + +| Category | Total | Covered | Partial | Missing | +|----------|-------|---------|---------|---------| +| Goal | 1 | 1 | 0 | 0 | +| Steps | {count} | {count} | {count} | {count} | +| Instructions | {count} | {count} | {count} | {count} | +| Output | 1 | 1 | 0 | 0 | + +--- + +**Missing Elements:** {count} +{List any gaps found} + +**Improvements Made:** {count} +{List enhancements beyond original} + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Does this coverage look complete? Any gaps to address?** + +[C] Continue - Coverage is complete +[F] Fix gaps - Address missing elements +[R] Review details - See full comparison" + +**Menu Handling Logic:** + +- IF C: Proceed to [Completion Handoff](#5-completion-handoff) +- IF F: Return to build steps to address gaps (route to step-09-build-next-step.md) +- IF R: Present detailed step-by-step comparison, then redisplay menu +- IF Any other: help user respond, then redisplay menu + +--- + +### 4. New Workflow Confirmation Path + +**This is a new workflow (not a conversion). Validate all plan requirements were met.** + +"**Verifying all requirements from the plan were implemented...**" + +#### A. Load Plan Requirements + +**From workflowPlanFile, extract ALL requirements:** + +- Discovery: User's vision, who it's for, what it produces +- Classification: Type, structure, mode decisions +- Requirements: Specific features, inputs, outputs +- Design: Step structure, flow, key decisions +- Tools: Data files, templates, references + +#### B. Verify Each Requirement + +**For EACH requirement from the plan:** + +| Requirement Area | Specified | Implemented | Location | Status | +|------------------|-----------|-------------|----------|--------| +| {area} | {what was specified} | {what was built} | {file/step} | ✅/⚠️/❌ | + +#### C. Plan Completion Summary + +Present findings: + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Plan Completion Report** + +**Workflow:** {new_workflow_name} +**Location:** {targetWorkflowPath} + +**Overall Completion:** {percentage}% + +| Requirement Area | Specified | Implemented | Status | +|------------------|-----------|-------------|--------| +| Discovery Vision | {from plan} | {what was built} | ✅/⚠️ | +| Workflow Type | {from plan} | {what was built} | ✅/⚠️ | +| Structure | {from plan} | {what was built} | ✅/⚠️ | +| Key Features | {from plan} | {what was built} | ✅/⚠️ | +| Data/Tools | {from plan} | {what was built} | ✅/⚠️ | + +--- + +**Missing Requirements:** {count} +{List any unmet requirements} + +**Beyond Plan:** {count} +{List any additional features added during build} + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Does this implementation match your vision?** + +[C] Continue - Implementation is complete +[F] Fix gaps - Address missing requirements +[R] Review details - See full comparison" + +**Menu Handling Logic:** + +- IF C: Proceed to [Completion Handoff](#5-completion-handoff) +- IF F: Return to build steps to address gaps (route to step-09-build-next-step.md) +- IF R: Present detailed requirement-by-requirement comparison, then redisplay menu +- IF Any other: help user respond, then redisplay menu + +--- + +### 5. Completion Handoff + +**After user confirms coverage/completion:** + +Update `{workflowPlanFile}` frontmatter: + +```yaml +status: CONFIRMED +confirmationDate: {current date} +confirmationType: {conversion / new_workflow} +coverageStatus: {complete / gaps_accepted} +``` + +Proceed to [Validation Offer](#6-validation-offer). + +--- + +### 6. Validation Offer + +"**✅ Workflow build confirmed!** + +**Before using your workflow, I recommend running extensive validation.** + +The validation phase will systematically check: +- File structure & size +- Frontmatter compliance +- Menu handling patterns +- Step type patterns +- Output format standards +- Instruction style +- Overall quality + +**Would you like to run validation?**" + +Display: **Build Confirmed! Select an Option:** [V] Start Validation [S] Skip - Complete Now + +#### Menu Handling Logic: + +- IF V: "Loading validation phase..." → Save confirmation status, update frontmatter, then load, read entire file, then execute {validationWorkflow} +- IF S: "Skipping validation. Proceeding to completion..." → Load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ALWAYS check plan metadata for conversionFrom field. Route to appropriate confirmation path. Only proceed after user confirms coverage/completion is satisfactory. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Plan file loaded completely +- ConversionFrom metadata checked +- Appropriate confirmation path executed +- Original workflow reviewed (if conversion) +- Plan requirements verified (if new) +- Coverage/completion report presented clearly +- User confirms and proceeds + +### ❌ SYSTEM FAILURE: + +- Not loading plan file completely +- Not checking conversionFrom metadata +- Skipping original workflow review (conversion) +- Not verifying plan requirements (new) +- Proceeding without user confirmation +- Missing gaps in coverage + +**Master Rule:** Check conversionFrom metadata first. For conversions, REVIEW THE ORIGINAL COMPLETELY. For new workflows, VERIFY ALL PLAN REQUIREMENTS. Only proceed after user confirms. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md b/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md new file mode 100644 index 00000000..efa9fdf1 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md @@ -0,0 +1,191 @@ +--- +name: 'step-11-completion' +description: 'Complete the workflow creation and provide next steps' + +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Step 11: Completion + +## STEP GOAL: + +Complete the workflow creation process with a summary of what was built and next steps guidance. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER modify the completed workflow at this stage +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ 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 completion expertise +- ✅ User decides next steps + +### Step-Specific Rules: + +- 🎯 Focus ONLY on summary and next steps +- 🚫 FORBIDDEN to modify the built workflow +- 💬 Present options clearly +- 🚪 This is the final step + +## EXECUTION PROTOCOLS: + +- 🎯 Present completion summary +- 💾 Finalize plan document +- 📖 Provide usage guidance +- 🚫 No more modifications at this stage + +## CONTEXT BOUNDARIES: + +- All workflow steps have been built +- Confirmation has been completed +- Validation may or may not have been run +- This is the final step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Present Completion Summary + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +# Workflow Creation Complete! + +**Workflow:** {new_workflow_name} +**Location:** {targetWorkflowPath} +**Created:** {current date} + +--- + +## What Was Built + +**Workflow Structure:** +- **Type:** [continuable/single-session] +- **Mode:** [create-only/tri-modal] +- **Steps Created:** [count] + +**Files Created:** +- workflow.md (entry point) +- [count] step files in steps-c/ +- [count] validation files in steps-v/ (if tri-modal) +- [count] edit files in steps-e/ (if tri-modal) +- [count] supporting files in data/ +- [count] templates in templates/ + +--- + +## Your Workflow Is Ready! + +**To use your new workflow:** + +1. Navigate to: {targetWorkflowPath} +2. Load workflow.md to start +3. Follow the step-by-step instructions + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━**" + +### 2. Update Plan with Completion Status + +Update {workflowPlanFile} frontmatter: + +```yaml +--- +workflowName: {new_workflow_name} +creationDate: [original creation date] +completionDate: [current date] +status: COMPLETE +stepsCompleted: ['step-01-discovery' or 'step-00-conversion', 'step-02-classification', 'step-03-requirements', 'step-04-tools', 'step-05-plan-review', 'step-06-design', 'step-07-foundation', 'step-08-build-step-01', 'step-09-build-next-step', 'step-10-confirmation', 'step-11-completion'] +--- +``` + +### 3. Provide Next Steps Guidance + +"**Next Steps:** + +**Test your workflow:** +- Run through it end-to-end +- Try with sample data +- Verify all steps work as expected + +**Get user feedback:** +- If others will use it, have them test +- Gather feedback on facilitation +- Note any friction points + +**Future maintenance:** +- Use validation mode to check compliance +- Use edit mode to make changes +- Validation can be run anytime + +**Resources:** +- **Validate later:** Load {targetWorkflowPath}/workflow.md with -v flag +- **Edit later:** Load {targetWorkflowPath}/workflow.md with -e flag +- **Build more:** Use create workflow mode for new workflows" + +### 4. Conversion-Specific Summary (If Applicable) + +**Check workflowPlanFile frontmatter for `conversionFrom`:** + +**IF this was a conversion:** + +"**Conversion Complete!** + +**Original workflow:** {conversionFrom} +**New location:** {targetWorkflowPath} + +**Preserved:** +- Original goal and purpose +- All {count} steps +- Key instruction patterns +- Output format + +**Improvements made:** +- BMAD compliance +- Better structure +- Enhanced collaboration +- Standards adherence + +**Review the conversion report** in the confirmation step for full details." + +### 5. Final Completion Message + +"**Thank you for using BMAD Workflow Creator!** + +Your workflow **{new_workflow_name}** is complete and ready to use. + +**Workflow location:** {targetWorkflowPath}/workflow.md + +Happy workflowing! ✅" + +## CRITICAL STEP COMPLETION NOTE + +This is the final step. Present completion summary, finalize plan, and provide next steps. No further modifications. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Completion summary presented clearly +- Plan finalized with COMPLETE status +- Usage guidance provided +- Conversion specifics noted (if applicable) +- Session ends positively + +### ❌ SYSTEM FAILURE: + +- Not providing clear summary +- Not finalizing plan status +- Missing usage guidance + +**Master Rule:** End on a positive note with clear summary and next steps. The workflow is ready to use. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md new file mode 100644 index 00000000..295b7fa9 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md @@ -0,0 +1,237 @@ +--- +name: 'step-e-01-assess-workflow' +description: 'Load target workflow, check compliance, check for validation report, offer validation if needed' + +# File References +nextStepFile: './step-e-02-discover-edits.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +validationWorkflow: '../steps-v/step-01-validate.md' +conversionStep: '../steps-c/step-00-conversion.md' +--- + +# Edit Step 1: Assess Workflow + +## STEP GOAL: + +Load the target workflow, check if it follows BMAD step-file architecture, check for existing validation report, and offer to run validation if needed. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus ONLY on assessment - no editing yet +- 🚫 FORBIDDEN to proceed without loading workflow completely +- 💬 Explain findings clearly and get user confirmation +- 🚪 ROUTE non-compliant workflows to create flow + +## EXECUTION PROTOCOLS: + +- 🎯 Load and analyze target workflow +- 💾 Create edit plan document +- 📖 Check for validation report +- 🚫 FORBIDDEN to proceed without user confirmation + +## CONTEXT BOUNDARIES: + +- User provides workflow path from workflow.md routing +- Focus: Assessment and routing +- This is NOT about making changes yet + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Get Workflow Path + +From the user input provided by workflow.md routing, extract: +- `targetWorkflowPath` - path to workflow.md file +- `workflowName` - derived from path + +**If path was not provided:** + +"Which workflow would you like to edit? Please provide the path to the workflow.md file." + +### 2. Load Workflow Completely + +**Load these files:** + +1. `{targetWorkflowPath}/workflow.md` - Must exist - if the user indicates is something else, ask if this is a conversion to the compliant v6 format +2. Check for step folders: `steps*` +3. Check for `data/` folder +4. Check for `templates/` folder + +### 3. Compliance Check + +**Determine if workflow is BMAD-compliant:** + +**Compliant workflow has:** +- ✅ workflow.md file exists at root +- ✅ At least one step folder exists (steps-c/, steps-v/, or steps-e/) +- ✅ Step files use markdown format (.md) +- ✅ workflow.md has frontmatter (name, description) + +**Non-compliant workflow:** +- ❌ No workflow.md file +- ❌ Has workflow.yaml or instructions.md (legacy format) +- ❌ No step folders +- ❌ Step files are not markdown + +### 4. Route Based on Compliance + +**IF NON-COMPLIANT:** + +"**Workflow Assessment Result: Non-Compliant Format** + +I found that this workflow does not follow BMAD step-file architecture: +- [Describe what was found - e.g., legacy format, missing workflow.md, etc.] + +**Recommendation:** This workflow should be converted using the create workflow process. The create workflow can use your existing workflow as input discovery material to build a new compliant workflow. + +**Would you like to:** + +1. **[C]onvert to Compliant Workflow** - Use existing workflow as input to build compliant version +2. **[E]xplore manual conversion** - I can explain what needs to change +3. **[X] Exit** - Cancel this operation + +#### Menu Handling Logic: + +- IF C: Route to create workflow conversion mode → Load {conversionStep} with sourceWorkflowPath set to {targetWorkflowPath} +- IF E: Explain conversion requirements, then redisplay menu +- IF X: Exit with guidance +- IF Any other: help user, then redisplay menu" + +**IF COMPLIANT:** + +"**Workflow Assessment Result: Compliant Format** + +This workflow follows BMAD step-file architecture: +- ✅ workflow.md found +- ✅ Step folders: [list which ones exist] +- ✅ Data folder: [yes/no] +- ✅ Templates folder: [yes/no]" + +Continue to step 5. + +### 5. Check for Validation Report + +**Look for validation report:** +- Check `{targetWorkflowPath}/validation-report-{workflow_name}.md` +- Check if report exists and read completion status + +**IF NO VALIDATION REPORT EXISTS:** + +"This workflow has not been validated yet. + +**Recommendation:** Running validation first can help identify issues before editing. Would you like to: + +1. **[V]alidate first** - Run comprehensive validation, then proceed with edits +2. **[S]kip validation** - Proceed directly to editing + +#### Menu Handling Logic: + +- IF V: Load, read entirely, then execute {validationWorkflow}. After validation completes, return to this step and proceed to step 6. +- IF S: Proceed directly to step 6 (Discover Edits) +- IF Any other: help user, then redisplay menu" + +**IF VALIDATION REPORT EXISTS:** + +Read the validation report and note: +- Overall status (COMPLETE/INCOMPLETE) +- Critical issues count +- Warning issues count + +"**Existing Validation Report Found:** + +- Status: [status] +- Critical Issues: [count] +- Warnings: [count] + +I'll keep this report in mind during editing." + +Continue to step 6. + +### 6. Create Edit Plan Document + +**Initialize edit plan:** + +```markdown +--- +mode: edit +targetWorkflowPath: '{targetWorkflowPath}' +workflowName: '{workflow_name}' +editSessionDate: '{current-date}' +stepsCompleted: + - step-e-01-assess-workflow.md +hasValidationReport: [true/false] +validationStatus: [from report if exists] +--- + +# Edit Plan: {workflow_name} + +## Workflow Snapshot + +**Path:** {targetWorkflowPath} +**Format:** BMAD Compliant ✅ +**Step Folders:** [list found] + +## Validation Status + +[If report exists: summary of validation status] +[If no report: No validation run yet] + +--- + +## Edit Goals + +*To be populated in next step* + +--- + +## Edits Applied + +*To track changes made* +``` + +Write to `{editPlan}`. + +### 7. Present MENU OPTIONS + +Display: "**Assessment Complete. Select an Option:** [C] Continue to Discovery" + +#### Menu Handling Logic: + +- IF C: Update editPlan, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN user selects [C] and edit plan is created, will you then load and read fully `{nextStepFile}` to execute and begin edit discovery. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Workflow loaded completely +- Compliance status determined +- Non-compliant workflows routed to create flow +- Edit plan document created +- Validation report checked +- User confirmed to proceed + +### ❌ SYSTEM FAILURE: + +- Not loading workflow completely +- Misclassifying non-compliant workflow as compliant +- Not routing non-compliant to create flow +- Not checking for validation report +- Not creating edit plan + +**Master Rule:** Assessment must be thorough. Non-compliant workflows MUST be routed to create flow. Always check for validation report before editing. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md new file mode 100644 index 00000000..d54a9a50 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md @@ -0,0 +1,248 @@ +--- +name: 'step-e-02-discover-edits' +description: 'Discover what user wants to change - fix validation issues, make changes, or both' + +# File References +nextStepFile: './step-e-03-fix-validation.md' +directEditStep: './step-e-04-direct-edit.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' +--- + +# Edit Step 2: Discover Edits + +## STEP GOAL: + +Discover what the user wants to do: fix validation issues, make specific changes, or both. Document edit goals in the edit plan. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER assume what edits are needed +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus ONLY on understanding edit goals +- 🚫 FORBIDDEN to make any modifications yet +- 💬 Ask clarifying questions +- 🚪 CATEGORIZE edits by type + +## EXECUTION PROTOCOLS: + +- 🎯 Guide discovery conversation +- 💾 Document edit goals in edit plan +- 📖 Determine which next step to load +- 🚫 FORBIDDEN to proceed without user confirmation + +## CONTEXT BOUNDARIES: + +- Edit plan from previous step provides context +- Validation report (if exists) provides issues to fix +- Focus: What does user want to change? +- This is discovery, not implementation + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan Context + +**Load the editPlan file:** +Read `{editPlan}` to understand the workflow context and validation status. + +### 2. Determine Discovery Approach + +**IF validation report exists AND has issues:** + +Present fix-or-change options (step 3a) + +**ELSE (no validation report or no issues):** + +Present direct change options (step 3b) + +--- + +### 3a. Discovery With Validation Issues + +**IF validation report exists with issues:** + +"**I found an existing validation report for this workflow.** + +**Validation Summary:** +- Status: {status from report} +- Critical Issues: {count} +- Warnings: {count} + +**What would you like to do?** + +**[F]ix Validation Issues** - Systematically fix issues found in validation +**[C]hange Something** - Make a specific change (add feature, modify step, etc.) +**[B]oth** - Fix validation issues, then make a change +**[R]eview Report** - See detailed validation findings first + +#### Menu Handling Logic: + +- IF F: Proceed to [Document Fix Goals](#4-document-fix-goals), then route to {nextStepFile} +- IF C: Proceed to [Document Change Goals](#3b-discovery-for-direct-change) +- IF B: Document both fix and change goals, then route to {nextStepFile} for fixes first +- IF R: Present key findings from validation report, then redisplay this menu +- IF Any other: help user, then redisplay menu" + +--- + +### 3b. Discovery For Direct Change + +**IF no validation report or no issues:** + +"**What would you like to change about this workflow?** + +I can help you modify: + +**[W]orkflow.md** - Goal, role, initialization, routing +**[S]tep Files** - Add, remove, or modify steps +**[D]ata Files** - Add or modify reference data in data/ folder +**[T]emplates** - Add or modify output templates +**[M]ultiple** - Changes across multiple areas +**[O]ther** - Something else + +Which areas would you like to edit?" + +#### For Each Selected Category: + +**If Workflow.md selected:** +- "What aspects need change?" + - Goal or description? + - Role definition? + - Architecture principles? + - Initialization/routing? + +**If Step Files selected:** +- "What type of step changes?" + - Add new step? + - Remove existing step? + - Modify step content? + - Reorder steps? + +**If Data Files selected:** +- "What data changes?" + - Add new data file? + - Modify existing data? + - Add/remove data entries? + +**If Templates selected:** +- "What template changes?" + - Add new template? + - Modify template structure? + - Change variable references?" + +**If Multiple selected:** +- Walk through each area systematically + +**If Other selected:** +- "Describe what you'd like to change..." + +--- + +### 4. Document Fix Goals (For Validation Issues) + +**Append to editPlan:** + +```markdown +## Edit Goals + +### Fix Validation Issues + +**Priority: High** - These issues prevent compliance + +**Critical Issues to Fix:** +- [ ] {issue from validation report} +- [ ] {issue from validation report} + +**Warnings to Address:** +- [ ] {warning from validation report} +- [ ] {warning from validation report} +``` + +--- + +### 5. Document Change Goals + +**Append to editPlan:** + +```markdown +### Direct Changes + +**Category:** [workflow.md / step files / data / templates / other] + +**Changes Requested:** +- [ ] {specific change description} +- [ ] {specific change description} + +**Rationale:** +{user's explanation of why this change is needed} +``` + +--- + +### 6. Confirm and Route + +**Present summary for confirmation:** + +"**Here's what I heard you want to do:** + +{Summarize all edit goals clearly} + +**Did I capture everything correctly?** + +- [C] Yes, continue +- [M] Modify the plan +- [X] Cancel" + +#### Menu Handling Logic: + +- IF C: Update editPlan stepsCompleted, then route based on goals: + - **If Fix goals only**: Load, read entirely, then execute {nextStepFile} (fix-validation) + - **If Change goals only**: Load, read entirely, then execute {directEditStep} + - **If Both**: Load, read entirely, then execute {nextStepFile} (fix first, then direct edit after) +- IF M: Return to relevant discovery section +- IF X: Exit with explanation +- IF Any other: help user, then redisplay menu + +### 7. Present MENU OPTIONS (Final) + +Display: "**Edit Goals Confirmed. Select an Option:** [C] Continue to Edits" + +#### Menu Handling Logic: + +- IF C: Save editPlan with confirmed goals, then load appropriate next step based on [Route Based on Goals](#6-confirm-and-route) +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN user confirms goals and routing is determined, will you then load and read fully the appropriate next step file to execute. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Edit goals clearly documented +- User confirmed the plan +- Routing determined (fix vs direct vs both) +- Edit plan updated with goals +- Appropriate next step selected + +### ❌ SYSTEM FAILURE: + +- Not documenting edit goals +- Routing to wrong next step +- Not getting user confirmation +- Missing changes user mentioned + +**Master Rule:** Discovery must be thorough. Document all goals. Route correctly based on whether fixes, changes, or both are needed. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md new file mode 100644 index 00000000..7d4da1c7 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md @@ -0,0 +1,252 @@ +--- +name: 'step-e-03-fix-validation' +description: 'Systematically fix validation issues from validation report' + +# File References +nextStepFile: './step-e-05-apply-edit.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' + +# Standards References +architecture: '../data/architecture.md' +stepFileRules: '../data/step-file-rules.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +stepTypePatterns: '../data/step-type-patterns.md' +--- + +# Edit Step 3: Fix Validation Issues + +## STEP GOAL: + +Systematically fix all issues identified in the validation report, working through each issue with user approval and loading relevant standards. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER make changes without user approval +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on fixing validation issues systematically +- 🚫 FORBIDDEN to skip issues or fix without approval +- 💬 Explain each issue and proposed fix +- 📋 Load relevant standards for each fix type + +## EXECUTION PROTOCOLS: + +- 🎯 Work through issues systematically +- 💾 Document each fix in edit plan +- 📖 Load appropriate standards for each issue type +- 🚫 FORBIDDEN to proceed without user approval for each fix + +## CONTEXT BOUNDARIES: + +- Validation report provides list of issues +- Edit plan documents fix goals +- Focus: Fix each issue with standards adherence +- This is systematic remediation, not creative editing + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Context Files + +**Load these files first:** +1. `{editPlan}` - Review fix goals +2. `{validationReport}` - Get full list of issues + +### 2. Organize Issues by Type + +**From validation report, categorize issues:** + +| Issue Type | Standard File | Count | +|------------|---------------|-------| +| workflow.md violations | {architecture} | | +| Step file structure | {stepFileRules} | | +| Frontmatter issues | {frontmatterStandards} | | +| Menu handling | {menuHandlingStandards} | | +| Output format | {outputFormatStandards} | | +| Step type issues | {stepTypePatterns} | | + +### 3. Work Through Issues Systematically + +**For EACH issue in order of severity (Critical → Warning):** + +#### A. Load Relevant Standard + +**Before proposing fix, load the relevant standard file:** +- If workflow.md issue → Load {architecture} +- If step file issue → Load {stepFileRules} +- If frontmatter issue → Load {frontmatterStandards} +- If menu issue → Load {menuHandlingStandards} +- If output issue → Load {outputFormatStandards} +- If step type issue → Load {stepTypePatterns} + +#### B. Explain the Issue + +"**Issue: [{issue type}] {file}:{location if applicable}** + +**What the validation found:** +{Quote the validation finding} + +**Why this is a problem:** +{Explain the impact based on the standard} + +**Standard reference:** +{Cite the specific standard from the loaded file}" + +#### C. Propose Fix + +"**Proposed fix:** +{Specific change needed} + +**This will:** +- ✅ Fix the compliance issue +- ✅ Align with: {specific standard} +- ⚠️ Potential impact: {any side effects} + +**Should I apply this fix?**" + +#### D. Get User Approval + +Wait for user response: +- **Yes/Y** - Apply the fix +- **No/N** - Skip this issue (document why) +- **Modify** - User suggests alternative approach +- **Explain** - Provide more detail + +#### E. Apply Fix (If Approved) + +**Load the target file, make the change:** + +```markdown +**Applying fix to: {file}** + +**Before:** +{show relevant section} + +**After:** +{show modified section} + +**Fix applied.** ✅" +``` + +**Update editPlan:** +```markdown +### Fixes Applied + +**[{issue type}]** {file} +- ✅ Fixed: {description} +- Standard: {standard reference} +- User approved: Yes +``` + +### 4. Handle Skip/Modify Responses + +**IF user skips an issue:** + +"**Issue skipped.** + +Documenting in edit plan: +- [{issue type}] {file} - SKIPPED per user request +- Reason: {user's reason if provided} + +**Note:** This issue will remain in the validation report. + +Continue to next issue?" + +**IF user wants to modify the fix:** + +Discuss alternative approach, get agreement, then apply modified fix. + +### 5. After All Issues Complete + +**Present summary:** + +"**Validation Fix Summary:** + +**Total Issues Found:** {count} +**Fixed:** {count} +**Skipped:** {count} +**Modified:** {count} + +**Remaining Issues:** {list any skipped or remaining warnings} + +**Files Modified:** +- {file1} +- {file2} +- etc." + +### 6. Check for Direct Edit Goals + +**Load editPlan and check:** + +**IF edit plan includes direct change goals (beyond validation fixes):** + +"Your edit plan also includes direct changes. After we apply these validation fixes, we'll proceed to those changes." + +Update editPlan frontmatter: +```yaml +validationFixesComplete: true +``` + +Then route to {nextStepFile} for direct edits. + +**ELSE (no direct changes - validation fixes only):** + +"Validation fixes are complete! Would you like to: + +1. **[R]e-run validation** - Verify all fixes are working +2. **[C]omplete** - Finish editing with these fixes +3. **[M]ake additional changes** - Add more edits" + +#### Menu Handling Logic: + +- IF R: Run validation workflow, then return to this step +- IF C: Route to step-e-07-complete.md +- IF M: Route to step-e-02-discover-edits.md +- IF Any other: help user, then redisplay menu + +### 7. Present MENU OPTIONS (If Proceeding) + +Display: "**Validation Fixes Applied. Select an Option:** [C] Continue" + +#### Menu Handling Logic: + +- IF C: Update editPlan stepsCompleted, then load, read entirely, then execute appropriate next step +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN all validation issues are addressed (fixed, skipped, or documented) and user confirms, will you then route to the appropriate next step. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All issues presented to user systematically +- Relevant standards loaded for each issue +- User approval obtained for each fix +- Fixes applied correctly +- Edit plan updated with all changes +- Files properly modified + +### ❌ SYSTEM FAILURE: + +- Skipping issues without user approval +- Not loading relevant standards +- Making changes without user confirmation +- Not documenting fixes in edit plan +- Applying fixes incorrectly + +**Master Rule:** Work through issues systematically. Load standards for each issue type. Get explicit approval before applying any fix. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md new file mode 100644 index 00000000..96f8d71c --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md @@ -0,0 +1,275 @@ +--- +name: 'step-e-04-direct-edit' +description: 'Apply direct user-requested changes to workflow' + +# File References +nextStepFile: './step-e-05-apply-edit.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' + +# Standards References +architecture: '../data/architecture.md' +stepFileRules: '../data/step-file-rules.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +stepTypePatterns: '../data/step-type-patterns.md' +workflowTypeCriteria: '../data/workflow-type-criteria.md' +inputDiscoveryStandards: '../data/input-discovery-standards.md' +csvDataFileStandards: '../data/csv-data-file-standards.md' +intentVsPrescriptive: '../data/intent-vs-prescriptive-spectrum.md' +--- + +# Edit Step 4: Direct Edit + +## STEP GOAL: + +Apply direct user-requested changes to the workflow, loading relevant standards and checking for non-compliance during editing. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER make changes without user approval +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on user-requested changes +- 🚫 FORBIDDEN to make changes without approval +- 💬 Check for non-compliance while editing +- 📋 Load relevant standards for each change type + +## EXECUTION PROTOCOLS: + +- 🎯 Work through each requested change +- 💾 Document each change in edit plan +- 📖 Load appropriate standards for each change type +- 🚫 IF non-compliance found: offer to fix before proceeding + +## CONTEXT BOUNDARIES: + +- Edit plan contains direct change goals +- Focus: Apply user's requested changes +- Must check for compliance issues during edits + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan + +**Load the editPlan:** +Read `{editPlan}` to review direct change goals from step 2. + +### 2. For Each Direct Change Goal + +**Work through each change systematically:** + +#### A. Identify Change Type and Load Standards + +**For workflow.md changes:** +- Load {architecture} + +**For step file changes:** +- Load {stepFileRules} +- Load {stepTypePatterns} +- Load {intentVsPrescriptive} + +**For frontmatter changes:** +- Load {frontmatterStandards} + +**For menu changes:** +- Load {menuHandlingStandards} + +**For output/template changes:** +- Load {outputFormatStandards} + +**For data file changes:** +- Load {csvDataFileStandards} + +**For workflow type changes:** +- Load {workflowTypeCriteria} + +**For discovery/input changes:** +- Load {inputDiscoveryStandards} + +#### B. Load Target File and Check Compliance + +**Load the file to be edited and review against standards:** + +"**Loading: {filename}** +**Standard: {standard file loaded}** + +**Checking file against standards before making your change...**" + +**IF NON-COMPLIANCE FOUND:** + +"**⚠️ Compliance Issue Detected** + +Before I apply your change, I noticed this file is not fully compliant with {standard}: + +**Issue:** {describe the non-compliance} + +**This could cause:** {explain impact} + +**Should I fix this compliance issue before applying your change?** + +1. **[F]ix first** - Fix compliance, then apply your change +2. **[C]ontinue anyway** - Apply your change without fixing +3. **[E]xplain more** - More details about the issue + +#### Menu Handling Logic: + +- IF F: Fix compliance first, then proceed to apply change +- IF C: Document user accepted risk, proceed with change +- IF E: Provide more details, then redisplay menu +- IF Any other: help user, then redisplay menu" + +**IF COMPLIANT:** + +"**File is compliant.** Proceeding with your change." + +#### C. Present Current State and Proposed Change + +"**Current state of: {filename}** + +{show relevant section} + +**Your requested change:** +{summarize the change from edit plan} + +**Proposed modification:** +{show how the change will be made} + +**Should I apply this change?**" + +Wait for user approval. + +#### D. Apply Change (If Approved) + +**Load the file, make the change:** + +```markdown +**Applying change to: {filename}** + +**Before:** +{show relevant section} + +**After:** +{show modified section} + +**Change applied.** ✅" +``` + +**Update editPlan:** +```markdown +### Direct Changes Applied + +**[{change type}]** {filename} +- ✅ Changed: {description} +- User approved: Yes +- Compliance check: Passed/Fixed/Accepted risk +``` + +### 3. Handle Common Change Patterns + +#### Adding a New Step + +1. Load {stepFileRules}, {stepTypePatterns}, {intentVsPrescriptive} +2. Check existing step numbering +3. Determine appropriate step type +4. Create step file with proper structure +5. Update nextStepFile references in adjacent steps +6. Verify menu handling compliance + +#### Removing a Step + +1. Load {architecture} +2. Check if step is referenced by other steps +3. Update nextStepFile in previous step +4. Confirm with user about impact +5. Remove step file +6. Verify no broken references + +#### Modifying workflow.md + +1. Load {architecture} +2. Check for progressive disclosure compliance (no step listings!) +3. Update goal/role/routing as requested +4. Ensure last section is routing +5. Verify frontmatter completeness + +#### Adding/Modifying Data Files + +1. Load {csvDataFileStandards} +2. Check file size (warn if >500 lines) +3. Verify CSV format if applicable +4. Ensure proper headers +5. Update step frontmatter references + +#### Adding/Modifying Templates + +1. Load {outputFormatStandards} +2. Determine template type +3. Ensure variable consistency +4. Update step frontmatter references + +### 4. After All Changes Complete + +**Present summary:** + +"**Direct Edit Summary:** + +**Total Changes Requested:** {count} +**Applied:** {count} +**Skipped:** {count} +**Modified:** {count} + +**Compliance Issues Found During Editing:** {count} +- Fixed: {count} +- User accepted risk: {count} + +**Files Modified:** +- {file1} +- {file2} +- etc." + +### 5. Present MENU OPTIONS + +Display: "**Direct Edits Applied. Select an Option:** [C] Continue" + +#### Menu Handling Logic: + +- IF C: Update editPlan stepsCompleted, then load, read entirely, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN all direct changes are applied (or documented) and user confirms, will you then load and read fully `{nextStepFile}` to execute. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All requested changes presented to user +- Relevant standards loaded for each change +- Compliance checked before each change +- User approval obtained for each change +- Non-compliance found and offered fix +- Changes applied correctly +- Edit plan updated + +### ❌ SYSTEM FAILURE: + +- Not loading relevant standards +- Not checking compliance before editing +- Making changes without user approval +- Missing non-compliance issues +- Not documenting changes + +**Master Rule:** Load standards for each change type. Check compliance BEFORE applying changes. Offer to fix non-compliance when found. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md new file mode 100644 index 00000000..00b55fbc --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md @@ -0,0 +1,154 @@ +--- +name: 'step-e-05-apply-edit' +description: 'Offer validation after edits, complete or continue editing' + +# File References +nextStepFile: './step-e-06-validate-after.md' +completeStep: './step-e-07-complete.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationWorkflow: '../steps-v/step-01-validate.md' +--- + +# Edit Step 5: Post-Edit Options + +## STEP GOAL: + +Present options after edits are applied: run validation, make more edits, or complete. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on next steps after edits +- 💬 Present clear options +- 🚪 Route based on user choice + +## EXECUTION PROTOCOLS: + +- 🎯 Present post-edit options +- 💾 Update edit plan if needed +- 📖 Route to appropriate next step + +## CONTEXT BOUNDARIES: + +- Edits have been applied (validation fixes, direct changes, or both) +- Focus: What's next? +- This is a routing step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan + +**Load the editPlan:** +Read `{editPlan}` to understand what edits were applied. + +### 2. Present Edit Summary + +"**Edit Session Summary:** + +**Workflow:** {workflow_name} +**Path:** {targetWorkflowPath} + +**Edits Applied:** +{Summarize from edit plan} + +**Files Modified:** +{List files changed} + +**Compliance Status:** +{Any compliance issues found and fixed} + +--- + +**What would you like to do next?** + +**[V]alidate** - Run comprehensive validation to verify all changes +**[M]ore edits** - Make additional changes +**[C]omplete** - Finish editing (without validation) +**[R]eview changes** - See detailed change log" + +### 3. Menu Handling Logic + +- **IF V:** Load, read entirely, then execute {validationWorkflow}. After validation completes, return to this step. +- **IF M:** Route to step-e-02-discover-edits.md for more changes +- **IF C:** Load, read entirely, then execute {completeStep} +- **IF R:** Present detailed edit log from editPlan, then redisplay this menu +- **IF Any other:** help user respond, then redisplay menu + +### 4. Update Edit Plan (If Completing Without Validation) + +**IF user selects [C] Complete:** + +Update editPlan frontmatter: +```yaml +completionDate: '{current-date}' +validationAfterEdit: skipped +completionStatus: complete_without_validation +``` + +Document in editPlan: +```markdown +## Completion + +**Completed:** {current-date} +**Validation:** Skipped per user request +**Recommendation:** Run validation before using workflow in production +``` + +### 5. Handle Validation Return + +**IF validation was run and completed:** + +Load and review validation report. Present findings: + +"**Validation Complete:** + +**Overall Status:** {status} +**New Issues:** {count} +**Remaining Issues:** {count} + +**Would you like to:** + +1. **[F]ix new issues** - Return to fix-validation step +2. **[M]ore edits** - Make additional changes +3. **[C]omplete** - Finish with current validation status" + +#### Menu Handling Logic: + +- IF F: Route to step-e-03-fix-validation.md +- IF M: Route to step-e-02-discover-edits.md +- IF C: Load, read entirely, then execute {completeStep} +- IF Any other: help user, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +This is a routing step. Route user to appropriate next step based on their choice. Always offer validation before completing. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Edit summary presented clearly +- All options explained +- User routed to appropriate next step +- Validation offered before completion +- Edit plan updated if completing + +### ❌ SYSTEM FAILURE: + +- Not offering validation +- Routing to wrong step +- Not updating edit plan when completing + +**Master Rule:** Always offer validation after edits. Route correctly based on user choice. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md new file mode 100644 index 00000000..b3912f0b --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md @@ -0,0 +1,190 @@ +--- +name: 'step-e-06-validate-after' +description: 'Run validation after edits and present results' + +# File References +nextStepFile: './step-e-07-complete.md' +fixStep: './step-e-03-fix-validation.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationWorkflow: '../steps-v/step-01-validate.md' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' +--- + +# Edit Step 6: Validate After Edit + +## STEP GOAL: + +Run validation workflow after edits are complete, present results, and offer next steps. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on running validation and presenting results +- 💬 Explain validation outcomes clearly +- 🚪 Route based on validation results + +## EXECUTION PROTOCOLS: + +- 🎯 Execute validation workflow +- 💾 Present results to user +- 📖 Offer next steps based on findings + +## CONTEXT BOUNDARIES: + +- Edits have been applied +- Focus: Verify quality after edits +- This is quality assurance step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan + +**Load the editPlan:** +Read `{editPlan}` to understand what edits were applied. + +### 2. Execute Validation Workflow + +"**Running comprehensive validation on your edited workflow...** + +**Target:** {targetWorkflowPath} +**Validation scope:** Full workflow compliance check + +This may take a few moments..." + +**Load, read entirely, then execute:** {validationWorkflow} + +### 3. Review Validation Results + +**After validation completes, load the validation report:** + +Read `{validationReport}` and extract: +- Overall status +- Critical issues count +- Warning issues count +- New issues vs pre-existing issues + +### 4. Present Validation Results + +"**Validation Complete!** + +**Overall Assessment:** [PASS/PARTIAL/FAIL] + +**Summary:** +| Category | Before Edits | After Edits | Change | +|----------|--------------|-------------|--------| +| Critical Issues | {count} | {count} | {delta} | +| Warnings | {count} | {count} | {delta} | +| Compliance Score | {score} | {score} | {delta} | + +--- + +**New Issues Found:** {count} +**Issues Fixed:** {count} +**Remaining Issues:** {count} + +--- + +**What would you like to do?**" + +### 5. Menu Options Based on Results + +**IF NEW CRITICAL ISSUES FOUND:** + +"**[F]ix new issues** - Return to fix-validation step to address new critical issues +**[R]eview report** - See detailed validation findings +**[C]omplete anyway** - Finish editing with remaining issues (not recommended)" + +#### Menu Handling Logic: + +- IF F: Load, read entirely, then execute {fixStep} +- IF R: Present detailed findings from validation report, then redisplay this menu +- IF C: Warn user, then if confirmed, load, read entirely, then execute {nextStepFile} +- IF Any other: help user, then redisplay menu + +**IF NO NEW CRITICAL ISSUES (warnings OK):** + +"**[R]eview report** - See detailed validation findings +**[C]omplete** - Finish editing - workflow looks good! +**[M]ore edits** - Make additional changes" + +#### Menu Handling Logic (Issues Found): + +- IF R: Present detailed findings from validation report, then redisplay this menu +- IF C: Load, read entirely, then execute {nextStepFile} +- IF M: Route to step-e-02-discover-edits.md +- IF Any other: help user, then redisplay menu + +**IF FULL PASS (no issues):** + +"**🎉 Excellent! Your workflow is fully compliant!** + +**[C]omplete** - Finish editing +**[R]eview report** - See validation details +**[M]ore edits** - Make additional changes" + +#### Menu Handling Logic (Full Pass): + +- IF C: Load, read entirely, then execute {nextStepFile} +- IF R: Present validation summary, then redisplay this menu +- IF M: Route to step-e-02-discover-edits.md +- IF Any other: help user, then redisplay menu + +### 6. Update Edit Plan + +**Before routing to complete:** + +Update editPlan frontmatter: +```yaml +completionDate: '{current-date}' +validationAfterEdit: complete +finalValidationStatus: {status from validation report} +remainingCriticalIssues: {count} +remainingWarnings: {count} +``` + +Document in editPlan: +```markdown +## Final Validation + +**Validation Date:** {current-date} +**Status:** {status} +**Issues After Editing:** +- Critical: {count} +- Warnings: {count} + +**Recommendation:** {if issues remain, suggest next steps} +``` + +## CRITICAL STEP COMPLETION NOTE + +ALWAYS present validation results clearly. Route based on severity of findings. Update edit plan with final validation status before completing. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation workflow executed +- Results presented clearly with before/after comparison +- User routed appropriately based on findings +- Edit plan updated with final status + +### ❌ SYSTEM FAILURE: + +- Not running validation +- Not presenting results clearly +- Routing to complete with critical issues without warning +- Not updating edit plan + +**Master Rule:** Always run validation after edits. Present clear before/after comparison. Warn user about remaining issues. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md new file mode 100644 index 00000000..56ad0552 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md @@ -0,0 +1,206 @@ +--- +name: 'step-e-07-complete' +description: 'Complete the edit session with summary and next steps' + +# File References +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' +--- + +# Edit Step 7: Complete + +## STEP GOAL: + +Complete the edit session with a comprehensive summary of changes made and provide next steps guidance. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on summary and completion +- 💬 Present clear change summary +- 🚫 No more edits at this stage + +## EXECUTION PROTOCOLS: + +- 🎯 Generate comprehensive summary +- 💾 Finalize edit plan document +- 📖 Provide next steps guidance + +## CONTEXT BOUNDARIES: + +- All edits are complete +- Focus: Summary and closure +- This is the final step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan and Validation Report + +**Load both files:** +1. `{editPlan}` - Full edit session history +2. `{validationReport}` - Final validation status (if exists) + +### 2. Generate Completion Summary + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +# Edit Session Complete + +**Workflow:** {workflow_name} +**Path:** {targetWorkflowPath} +**Session Date:** {editSessionDate} + +--- + +## Changes Made + +**Validation Fixes Applied:** {count} +{list from edit plan} + +**Direct Changes Applied:** {count} +{list from edit plan} + +**Files Modified:** +{List all files that were changed} + +--- + +## Final Validation Status + +**Status:** {status from report or 'Not run'} + +**Issues:** +- Critical: {count} +- Warnings: {count} + +--- + +## Edit Session Summary + +Your workflow has been successfully edited. Here's what was accomplished: + +{Summarize the transformation in 2-3 sentences} + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━**" + +### 3. Update Edit Plan with Completion + +**Append final completion section to editPlan:** + +```markdown +## Completion Summary + +**Completed:** {current-date} +**Session Duration:** {from start to end} + +**Total Edits:** {count} +- Validation Fixes: {count} +- Direct Changes: {count} + +**Files Modified:** {count} +**Final Validation Status:** {status} + +**Workflow is ready for:** {use/testing/production with caveats} +``` + +### 4. Provide Next Steps Guidance + +"**Next Steps for Your Workflow:** + +1. **Test the workflow** - Run through the workflow end-to-end to verify changes +2. **Get user feedback** - If this is for others, have them test it +3. **Monitor for issues** - Watch for any problems in actual use +4. **Re-validate periodically** - Run validation again after future changes + +**Resources:** +- Edit this workflow again: Edit workflow mode +- Run validation: Validate workflow mode +- Build new workflow: Create workflow mode + +--- + +**Thank you for using BMAD Workflow Creator!** + +Your edit session for **{workflow_name}** is complete. ✅" + +### 5. Final Confirmation + +"**Edit Session Complete.** + +**[F]inish** - End the edit session +**[S]ave summary** - Save a copy of the edit summary to your output folder +**[R]eview** - Review the full edit plan one more time" + +#### Menu Handling Logic: + +- IF F: End the session +- IF S: Save edit summary to output folder, then end +- IF R: Display full edit plan, then redisplay this menu +- IF Any other: help user, then redisplay menu + +### 6. Save Summary (If Requested) + +**IF user selects [S]ave summary:** + +Create summary file at `{output_folder}/workflow-edit-summary-{workflow_name}-{date}.md`: + +```markdown +# Workflow Edit Summary + +**Workflow:** {workflow_name} +**Path:** {targetWorkflowPath} +**Edit Date:** {current-date} + +## Changes Made + +{All changes from edit plan} + +## Files Modified + +{List with paths} + +## Validation Status + +{Final validation results} + +## Next Steps + +{Recommendations} +``` + +"**Summary saved to:** {output_folder}/workflow-edit-summary-{workflow_name}-{date}.md" + +## CRITICAL STEP COMPLETION NOTE + +This is the final step. Ensure edit plan is complete, summary is presented, and user has all information needed. End session gracefully. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Comprehensive summary presented +- All changes documented clearly +- Edit plan finalized +- Next steps guidance provided +- Session ended gracefully + +### ❌ SYSTEM FAILURE: + +- Not summarizing all changes +- Missing files from change list +- Not providing next steps +- Ending without user confirmation + +**Master Rule:** Provide complete summary of all changes. Document everything. Give clear next steps. End on a positive note. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md new file mode 100644 index 00000000..f605f15a --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md @@ -0,0 +1,245 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +nextStepFile: './step-02-frontmatter-validation.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +stepFileRules: '../data/step-file-rules.md' +--- + +# Validation Step 1: File Structure & Size + +## STEP GOAL: + +To create the validation report and check that the workflow has correct file structure and all step files are within size limits. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure +- 🚫 DO NOT skip checking any file +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow +- 💾 Append findings to validation report +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Workflow has been built in steps-c/ +- Check the entire folder structure +- Verify all required files exist +- Check file sizes against limits + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Create Validation Report + +Create {validationReportFile} with header structure: + +```markdown +--- +validationDate: [current date] +workflowName: {new_workflow_name} +workflowPath: {targetWorkflowPath} +validationStatus: IN_PROGRESS +--- + +# Validation Report: {new_workflow_name} + +**Validation Started:** [current date] +**Validator:** BMAD Workflow Validation System +**Standards Version:** BMAD Workflow Standards + +--- + +## File Structure & Size + +*Validation in progress...* + +## Frontmatter Validation +*Pending...* + +## Menu Handling Validation +*Pending...* + +## Step Type Validation +*Pending...* + +## Output Format Validation +*Pending...* + +## Validation Design Check +*Pending...* + +## Instruction Style Check +*Pending...* + +## Collaborative Experience Check +*Pending...* + +## Cohesive Review +*Pending...* + +## Summary +*Pending...* +``` + +### 2. Load File Structure Standards + +Load {stepFileRules} to understand: +- File size limits (<200 recommended, 250 max) +- Required folder structure +- Required files + +### 3. Check Folder Structure + +**DO NOT BE LAZY - List EVERY folder and file:** + +Use bash commands to list the entire structure: +``` +{targetWorkflowPath}/ +├── workflow.md +├── steps-c/ +│ ├── step-01-init.md +│ ├── step-01b-continue.md (if continuable) +│ ├── step-02-*.md +│ └── ... +├── steps-v/ +│ └── [this validation] +├── data/ +│ └── [as needed] +└── templates/ + └── [as needed] +``` + +**Check:** +- ✅ workflow.md exists +- ✅ steps-c/ folder exists with all step files +- ✅ data/ folder exists (may be empty) +- ✅ templates/ folder exists (may be empty) +- ✅ No unexpected files +- ✅ Folder names follow conventions + +### 4. Check File Sizes + +**DO NOT BE LAZY - Check EVERY step file:** + +For each file in `steps-c/`: +1. Read the file +2. Count lines +3. Check against limits: + - < 200 lines: ✅ Good + - 200-250 lines: ⚠️ Approaching limit + - > 250 lines: ❌ Exceeds limit + +**Check for Large Data Files:** + +For each file in `data/` folder: +1. Check file size in lines +2. If > 500 lines: ⚠️ WARNING - Large data file detected +3. If > 1000 lines: ❌ ERROR - Data file too large for direct loading + +**For large data files, recommend:** +- Create an index/csv/yaml so LLM knows what's available and can load specific sections +- Use sharding technique (core module has sharding tool) to split large files +- Consider if all data is needed or if lookup/reference pattern would work better + +**Report format:** +```markdown +### File Size Check + +| File | Lines | Status | +|------|-------|--------| +| step-01-init.md | 180 | ✅ Good | +| step-02-*.md | 245 | ⚠️ Approaching limit | +| step-03-*.md | 267 | ❌ Exceeds limit - should split | + +### Data File Size Check + +| Data File | Lines | Status | +|-----------|-------|--------| +| reference-data.csv | 150 | ✅ Good | +| large-data.md | 2500 | ❌ Too large - use sharding or create index | +``` + +### 5. Verify File Presence + +From the design in {workflowPlanFile}, verify: +- Every step from design has a corresponding file +- Step files are numbered sequentially +- No gaps in numbering +- Final step exists + +### 6. Append Findings to Report + +Replace the "## File Structure & Size" section in {validationReportFile} with actual findings: + +```markdown +## File Structure & Size + +### Folder Structure +[Report findings - is structure correct?] + +### Files Present +[Report findings - are all required files present?] + +### File Size Check +[Table as shown above] + +### Issues Found +[List any issues: +- Missing files +- Extra files +- Size violations +- Naming convention violations] + +### Status +✅ PASS / ❌ FAIL / ⚠️ WARNINGS +``` + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**File Structure & Size validation complete.** Proceeding to Frontmatter Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report created with header structure +- EVERY file checked for structure and size +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file +- Skipping size checks +- Not saving report before proceeding +- Halting for user input + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md new file mode 100644 index 00000000..a5e5b1f0 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md @@ -0,0 +1,153 @@ +--- +name: 'step-02-frontmatter-validation' +description: 'Validate frontmatter compliance across all step files' + +nextStepFile: './step-03-menu-validation.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +frontmatterStandards: '../data/frontmatter-standards.md' +--- + +# Validation Step 2: Frontmatter Validation + +## STEP GOAL: + +To validate that EVERY step file's frontmatter follows the frontmatter standards - correct variables, proper path formatting, no unused variables. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Load and validate EVERY step file's frontmatter +- 🚫 DO NOT skip any files or checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load frontmatter standards first +- 💾 Check EVERY file against standards +- 📖 Append findings to validation report +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in steps-c/ must be validated +- Load {frontmatterStandards} for validation criteria +- Check for: unused variables, hardcoded paths, missing required fields + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Frontmatter Standards + +Load {frontmatterStandards} to understand validation criteria: + +**Golden Rules:** +1. Only variables USED in the step may be in frontmatter +2. All file references MUST use `{variable}` format +3. Paths within workflow folder MUST be relative + +**Required Fields:** +- `name` - must be present, kebab-case +- `description` - must be present + +### 2. Check EVERY Step File + +**DO NOT BE LAZY - For EACH file in steps-c/:** + +1. Load the file +2. Extract frontmatter +3. Validate against each rule: + +**Check 1: Required Fields** +- ✅ `name` exists and is kebab-case +- ✅ `description` exists + +**Check 2: All Frontmatter Variables Are Used** +- For each variable in frontmatter, check if it appears in step body +- ❌ If not used: mark as violation + +**Check 3: No Hardcoded Paths** +- Check all file references use `{variable}` format +- ❌ If absolute path found: mark as violation + +**Check 4: Relative Paths Within Workflow** +- Paths to same workflow should be relative (`../data/`) +- ❌ If absolute path for same-folder: mark as violation + +**Check 5: External References Use Full Variable Paths** +- `{project-root}` variables for external references +- ✅ Correct: `advancedElicitationTask: '{project-root}/_bmad/core/...'` + +### 3. Document Findings + +Create report table: + +```markdown +### Frontmatter Validation Results + +| File | Required Fields | Variables Used | Relative Paths | Status | +|------|----------------|----------------|----------------|--------| +| step-01-init.md | ✅ | ✅ | ✅ | ✅ PASS | +| step-02-*.md | ✅ | ❌ Unused: partyModeWorkflow | ✅ | ❌ FAIL | +| step-03-*.md | ❌ Missing description | ✅ | ❌ Hardcoded path | ❌ FAIL | +``` + +### 4. List Violations + +```markdown +### Violations Found + +**step-02-[name].md:** +- Unused variable in frontmatter: `partyModeWorkflow` (not used in step body) + +**step-03-[name].md:** +- Missing required field: `description` +- Hardcoded path: `someTemplate: '/absolute/path/template.md'` should use relative or variable + +**step-05-[name].md:** +- All checks passed ✅ +``` + +### 5. Append to Report + +Update {validationReportFile} - replace "## Frontmatter Validation *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Frontmatter validation complete.** Proceeding to Menu Handling Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step file's frontmatter validated +- All violations documented +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file +- Skipping frontmatter checks +- Not documenting violations +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file's frontmatter. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md new file mode 100644 index 00000000..77242856 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md @@ -0,0 +1,161 @@ +--- +name: 'step-03-menu-validation' +description: 'Validate menu handling compliance across all step files' + +nextStepFile: './step-04-step-type-validation.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +--- + +# Validation Step 3: Menu Handling Validation + +## STEP GOAL: + +To validate that EVERY step file's menus follow the menu handling standards - proper handlers, execution rules, appropriate menu types. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Load and validate EVERY step file's menus +- 🚫 DO NOT skip any files or checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load menu standards first +- 💾 Check EVERY file's menu structure +- 📖 Append findings to validation report +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in steps-c/ must be validated +- Load {menuHandlingStandards} for validation criteria +- Check for: handler section, execution rules, reserved letters, inappropriate A/P + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Menu Standards + +Load {menuHandlingStandards} to understand validation criteria: + +**Reserved Letters:** A (Advanced Elicitation), P (Party Mode), C (Continue/Accept), X (Exit/Cancel) + +**Required Structure:** +1. Display section +2. Handler section (MANDATORY) +3. Execution Rules section + +**When To Include A/P:** +- DON'T: Step 1 (init), validation sequences, simple data gathering +- DO: Collaborative content creation, user might want alternatives, quality gates + +### 2. Check EVERY Step File + +**DO NOT BE LAZY - For EACH file in steps-c/:** + +1. Load the file +2. Find the menu section (if present) +3. Validate against each rule: + +**Check 1: Handler Section Exists** +- ✅ Handler section immediately follows Display +- ❌ If missing: mark as violation + +**Check 2: Execution Rules Section Exists** +- ✅ "EXECUTION RULES" section present +- ✅ Contains "halt and wait" instruction +- ❌ If missing: mark as violation + +**Check 3: Non-C Options Redisplay Menu** +- ✅ A/P options specify "redisplay menu" +- ❌ If missing: mark as violation + +**Check 4: C Option Sequence** +- ✅ C option: save → update frontmatter → load next step +- ❌ If sequence wrong: mark as violation + +**Check 5: A/P Only Where Appropriate** +- Step 01 should NOT have A/P (inappropriate for init) +- Validation sequences should auto-proceed, not have menus +- ❌ If A/P in wrong place: mark as violation + +### 3. Document Findings + +Create report table: + +```markdown +### Menu Handling Validation Results + +| File | Has Menu | Handler Section | Exec Rules | A/P Appropriate | Status | +|------|----------|----------------|------------|-----------------|--------| +| step-01-init.md | ✅ (C-only) | ✅ | ✅ | N/A | ✅ PASS | +| step-02-*.md | ✅ (A/P/C) | ✅ | ✅ | ✅ | ✅ PASS | +| step-03-*.md | ✅ (C-only) | ❌ Missing | ⚠️ Incomplete | N/A | ❌ FAIL | +| step-04-*.md | ❌ No menu | N/A | N/A | Should have A/P/C | ⚠️ WARN | +``` + +### 4. List Violations + +```markdown +### Menu Violations Found + +**step-03-[name].md:** +- Missing handler section after menu display +- EXECUTION RULES section incomplete + +**step-04-[name].md:** +- No menu found - this is a collaborative content step, should have A/P/C menu + +**step-05-[name].md:** +- A/P options don't specify "redisplay menu" after execution + +**step-06-[name].md:** +- All checks passed ✅ +``` + +### 5. Append to Report + +Update {validationReportFile} - replace "## Menu Handling Validation *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Menu Handling validation complete.** Proceeding to Step Type Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step file's menus validated +- All violations documented +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file's menus +- Skipping menu structure checks +- Not documenting violations +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file's menus. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md new file mode 100644 index 00000000..cccc58be --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md @@ -0,0 +1,186 @@ +--- +name: 'step-04-step-type-validation' +description: 'Validate that each step follows its correct step type pattern' + +nextStepFile: './step-05-output-format-validation.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +stepTypePatterns: '../data/step-type-patterns.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Validation Step 4: Step Type Validation + +## STEP GOAL: + +To validate that each step file follows the correct pattern for its step type - init, continuation, middle, branch, validation, final polish, or final. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Load and validate EVERY step against its type pattern +- 🚫 DO NOT skip any files or checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load step type patterns first +- 💾 Check EACH file follows its designated type pattern +- 📖 Append findings to validation report +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in steps-c/ must be validated +- Load {stepTypePatterns} for pattern definitions +- The design in {workflowPlanFile} specifies what each step should be + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Step Type Patterns + +Load {stepTypePatterns} to understand the pattern for each type: + +**Step Types:** +1. **Init (Non-Continuable)** - Auto-proceed, no continuation logic +2. **Init (Continuable)** - Has continueFile reference, continuation detection +3. **Continuation (01b)** - Paired with continuable init, routes based on stepsCompleted +4. **Middle (Standard)** - A/P/C menu, collaborative content +5. **Middle (Simple)** - C only menu, no A/P +6. **Branch** - Custom menu with routing to different steps +7. **Validation Sequence** - Auto-proceed through checks, no menu +8. **Init (With Input Discovery)** - Has inputDocuments array, discovery logic +9. **Final Polish** - Loads entire doc, optimizes flow +10. **Final** - No next step, completion message + +### 2. Check EACH Step Against Its Type + +**DO NOT BE LAZY - For EACH file in steps-c/:** + +1. Determine what type this step SHOULD be from: + - Step number (01 = init, 01b = continuation, last = final) + - Design in {workflowPlanFile} + - Step name pattern + +2. Load the step file + +3. Validate it follows the pattern for its type: + +**For Init Steps:** +- ✅ Creates output from template (if document-producing) +- ✅ No A/P menu (or C-only) +- ✅ If continuable: has continueFile reference + +**For Continuation (01b):** +- ✅ Has nextStepOptions in frontmatter +- ✅ Reads stepsCompleted from output +- ✅ Routes to appropriate step + +**For Middle (Standard):** +- ✅ Has A/P/C menu +- ✅ Outputs to document (if applicable) +- ✅ Has mandatory execution rules + +**For Middle (Simple):** +- ✅ Has C-only menu +- ✅ No A/P options + +**For Branch:** +- ✅ Has custom menu letters +- ✅ Handler routes to different steps + +**For Validation Sequence:** +- ✅ Auto-proceeds (no user choice) +- ✅ Proceeds to next validation + +**For Final Polish:** +- ✅ Loads entire document +- ✅ Optimizes flow, removes duplication +- ✅ Uses ## Level 2 headers + +**For Final:** +- ✅ No nextStepFile in frontmatter +- ✅ Completion message +- ✅ No next step to load + +### 3. Document Findings + +Create report table: + +```markdown +### Step Type Validation Results + +| File | Should Be Type | Follows Pattern | Issues | Status | +|------|----------------|-----------------|--------|--------| +| step-01-init.md | Init (Continuable) | ✅ | None | ✅ PASS | +| step-01b-continue.md | Continuation | ✅ | None | ✅ PASS | +| step-02-*.md | Middle (Standard) | ✅ | None | ✅ PASS | +| step-03-*.md | Middle (Simple) | ❌ | Has A/P (should be C-only) | ❌ FAIL | +| step-04-*.md | Branch | ⚠️ | Missing custom menu letters | ⚠️ WARN | +| step-N-final.md | Final | ✅ | None | ✅ PASS | +``` + +### 4. List Violations + +```markdown +### Step Type Violations Found + +**step-03-[name].md:** +- Designated as Middle (Simple) but has A/P menu +- Should have C-only menu + +**step-04-[name].md:** +- Designated as Branch but missing custom menu letters +- Handler doesn't route to different steps + +**step-05-[name].md:** +- Designated as Validation Sequence but has user menu +- Should auto-proceed + +**All other steps:** ✅ Follow their type patterns correctly +``` + +### 5. Append to Report + +Update {validationReportFile} - replace "## Step Type Validation *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Step Type validation complete.** Proceeding to Output Format Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step validated against its type pattern +- All violations documented +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file's type pattern +- Skipping type-specific checks +- Not documenting violations +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file's type pattern. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md new file mode 100644 index 00000000..d5da8dad --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md @@ -0,0 +1,195 @@ +--- +name: 'step-05-output-format-validation' +description: 'Validate output format compliance - template type, final polish, step-to-output mapping' + +nextStepFile: './step-06-validation-design-check.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +outputFormatStandards: '../data/output-format-standards.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Validation Step 5: Output Format Validation + +## STEP GOAL: + +To validate that the workflow's output format matches the design - correct template type, proper final polish step if needed, and step-to-output mapping is correct. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Validate output format against design specifications +- 🚫 DO NOT skip any checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load output format standards first +- 💾 Check template type matches design +- 📖 Check for final polish step if needed +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Check template file in templates/ folder +- Review design in {workflowPlanFile} for output format specification +- Validate step-to-output mapping +- Check if final polish step is present (if needed) + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Output Format Standards + +Load {outputFormatStandards} to understand: + +**Golden Rule:** Every step MUST output to document BEFORE loading next step. + +**Four Template Types:** +1. **Free-form** (Recommended) - Minimal structure, progressive append +2. **Structured** - Required sections, flexible within each +3. **Semi-structured** - Core sections plus optional additions +4. **Strict** - Exact format, specific fields (rare) + +**Final Polish Step:** +- For free-form workflows, include a polish step that optimizes the entire document +- Loads entire document, reviews for flow, removes duplication + +### 2. Check Design Specification + +From {workflowPlanFile}, identify: +- Does this workflow produce a document? +- If yes, what template type was designed? +- Is a final polish step needed? + +### 3. Validate Template File + +**If workflow produces documents:** + +1. Load the template file from `templates/` folder +2. Check it matches the designed type: + +**For Free-form (most common):** +- ✅ Has frontmatter with `stepsCompleted: []` +- ✅ Has `lastStep: ''` +- ✅ Has `date: ''` +- ✅ Has `user_name: ''` +- ✅ Document title header +- ✅ No rigid section structure (progressive append) + +**For Structured:** +- ✅ Has clear section headers +- ✅ Section placeholders with {{variable}} syntax +- ✅ Consistent structure + +**For Semi-structured:** +- ✅ Has core required sections +- ✅ Has optional section placeholders + +**For Strict:** +- ✅ Has exact field definitions +- ✅ Validation rules specified + +### 4. Check for Final Polish Step + +**If free-form template:** +- ✅ A final polish step should exist in the design +- ✅ The step loads entire document +- ✅ The step optimizes flow and coherence +- ✅ The step removes duplication +- ✅ The step ensures ## Level 2 headers + +**If no final polish step for free-form:** +- ⚠️ WARNING - Free-form workflows typically need final polish + +### 5. Validate Step-to-Output Mapping + +**For EACH step that outputs to document:** + +1. Check the step has `outputFile` in frontmatter +2. Check the step appends/writes to output before loading next +3. Check the menu C option saves to output before proceeding + +**Steps should be in ORDER of document appearance:** +- Step 1 creates doc +- Step 2 → ## Section 1 +- Step 3 → ## Section 2 +- Step N → Polish step + +### 6. Document Findings + +```markdown +### Output Format Validation Results + +**Workflow Produces Documents:** [Yes/No] + +**Template Type:** [Free-form/Structured/Semi-structured/Strict] + +**Template File Check:** +- Template exists: ✅/❌ +- Matches designed type: ✅/❌ +- Proper frontmatter: ✅/❌ + +**Final Polish Step:** +- Required: [Yes/No - based on template type] +- Present: ✅/❌ +- Loads entire document: ✅/❌ +- Optimizes flow: ✅/❌ + +**Step-to-Output Mapping:** +| Step | Has Output Variable | Saves Before Next | Status | +|------|-------------------|-------------------|--------| +| step-01-init.md | ✅ | ✅ | ✅ | +| step-02-*.md | ✅ | ✅ | ✅ | +| step-03-*.md | ❌ | N/A | ❌ FAIL | + +**Issues Found:** +[List any issues with template, polish step, or mapping] + +**Status:** ✅ PASS / ❌ FAIL / ⚠️ WARNINGS +``` + +### 7. Append to Report + +Update {validationReportFile} - replace "## Output Format Validation *Pending...*" with actual findings. + +### 8. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Output Format validation complete.** Proceeding to Validation Design Check..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Template type matches design +- Final polish step present if needed +- Step-to-output mapping validated +- All findings documented +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking template file +- Missing final polish step for free-form +- Not documenting mapping issues +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check template, polish step, and mapping. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md new file mode 100644 index 00000000..f0f0cf32 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md @@ -0,0 +1,186 @@ +--- +name: 'step-06-validation-design-check' +description: 'Check if workflow has proper validation steps that load validation data (if validation is critical)' + +nextStepFile: './step-07-instruction-style-check.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +trimodalWorkflowStructure: '../data/trimodal-workflow-structure.md' +--- + +# Validation Step 6: Validation Design Check + +## STEP GOAL: + +To check if the workflow has proper validation steps when validation is critical - validation steps should load from validation data and perform systematic checks. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Check if workflow needs validation steps +- 🚫 DO NOT skip any validation step reviews +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Determine if validation is critical for this workflow +- 💾 Check validation steps exist and are well-designed +- 📖 Append findings to validation report +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Some workflows need validation (compliance, safety, quality gates) +- Others don't (creative, exploratory) +- Check the design to determine if validation steps are needed + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Determine If Validation Is Critical + +From {workflowPlanFile}, check: + +**Does this workflow NEED validation?** + +**YES - Validation Critical If:** +- Compliance/regulatory requirements (tax, legal, medical) +- Safety-critical outputs +- Quality gates required +- User explicitly requested validation steps + +**NO - Validation Not Critical If:** +- Creative/exploratory workflow +- User-driven without formal requirements +- Output is user's responsibility to validate + +### 2. If Validation Is Critical, Check Validation Steps + +**DO NOT BE LAZY - For EACH validation step in the workflow:** + +1. Find the step (usually named with "validate", "check", "review") +2. Load the step file +3. Check for: + +**Proper Validation Step Design:** +- ✅ Loads validation data/standards from `data/` folder +- ✅ Has systematic check sequence (not hand-wavy) +- ✅ Auto-proceeds through checks (not stopping for each) +- ✅ Clear pass/fail criteria +- ✅ Reports findings to user + +**"DO NOT BE LAZY" Language Check:** +- ✅ Step includes "DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE" or similar mandate +- ✅ Step instructs to "Load and review EVERY file" not "sample files" +- ✅ Step has "DO NOT SKIP" or "DO NOT SHORTCUT" language +- ⚠️ WARNING if validation step lacks anti-lazy language + +**Critical Flow Check:** +- ✅ For critical flows (compliance, safety, quality gates): validation steps are in steps-v/ folder (tri-modal) +- ✅ Validation steps are segregated from create flow +- ✅ Validation can be run independently +- ⚠️ For non-critical flows (entertainment, therapy, casual): validation may be inline +- ❌ ERROR if critical validation is mixed into create steps + +### 3. Check Validation Data Files + +**If workflow has validation steps:** + +1. Check `data/` folder for validation data +2. Verify data files exist and are properly structured: + - CSV files have headers + - Markdown files have clear criteria + - Data is referenced in step frontmatter + +### 4. Document Findings + +```markdown +### Validation Design Check Results + +**Workflow Requires Validation:** [Yes/No] + +**Workflow Domain Type:** [Critical/Compliance/Creative/Entertainment/Therapy/Casual] + +**If Yes:** + +**Validation Steps Found:** +- [List each validation step] + +**Validation Step Quality:** +| Step | Loads Data | Systematic | Auto-proceed | DO NOT BE LAZY | Criteria | Status | +|------|-----------|------------|--------------|----------------|----------|--------| +| step-04-validate.md | ✅ | ✅ | ✅ | ✅ | ✅ Clear | ✅ PASS | +| step-07-check.md | ❌ | ⚠️ Vague | ❌ User choice each | ❌ | ❌ Unclear | ❌ FAIL | + +**"DO NOT BE LAZY" Language Check:** +| Step | Has Anti-Lazy Language | Status | +|------|----------------------|--------| +| step-04-validate.md | ✅ "DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE" | ✅ PASS | +| step-07-check.md | ❌ No anti-lazy language found | ⚠️ WARN | + +**Critical Flow Check:** +- Workflow domain: [Critical/Creative/Therapy/etc.] +- Validation location: [steps-v/ folder / inline with create] +- For [critical] workflows: Validation is in steps-v/ ✅ / ❌ mixed in create +- Status: ✅ Properly segregated / ⚠️ Consider segregation / ❌ Should be in steps-v/ + +**Validation Data Files:** +- [List data files found, or note if missing] + +**Issues Found:** +[List issues with validation design] + +**If No (Validation Not Required):** +- Workflow is [creative/exploratory/type] +- Validation is user's responsibility +- No validation steps needed ✅ + +**Status:** ✅ PASS / ❌ FAIL / ⚠️ WARNINGS / N/A (not applicable) +``` + +### 5. Append to Report + +Update {validationReportFile} - replace "## Validation Design Check *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Validation Design check complete.** Proceeding to Instruction Style Check..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Determined if validation is critical +- If critical: checked all validation steps +- Validated validation step quality +- Checked validation data files +- Findings documented +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking validation steps when critical +- Missing validation data files +- Not documenting validation design issues +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check validation steps thoroughly. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md new file mode 100644 index 00000000..fe604633 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md @@ -0,0 +1,192 @@ +--- +name: 'step-07-instruction-style-check' +description: 'Check instruction style - intent-based vs prescriptive, appropriate for domain' + +nextStepFile: './step-08-collaborative-experience-check.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +intentVsPrescriptive: '../data/intent-vs-prescriptive-spectrum.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Validation Step 7: Instruction Style Check + +## STEP GOAL: + +To validate that workflow instructions use appropriate style - intent-based for creative/facilitative workflows, prescriptive only where absolutely required (compliance, legal). + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Review EVERY step's instruction style +- 🚫 DO NOT skip any files or style checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load intent vs prescriptive standards +- 💾 Check EACH step's instruction style +- 📖 Validate style is appropriate for domain +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Instruction style should match domain +- Creative/facilitative → Intent-based (default) +- Compliance/legal → Prescriptive (exception) +- Check EVERY step for style consistency + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Instruction Style Standards + +Load {intentVsPrescriptive} to understand: + +**Intent-Based (Default):** +- Use for: Most workflows - creative, exploratory, collaborative +- Step instruction describes goals and principles +- AI adapts conversation naturally +- More flexible and responsive +- Example: "Guide user to define requirements through open-ended discussion" + +**Prescriptive (Exception):** +- Use for: Compliance, safety, legal, medical, regulated industries +- Step provides exact instructions +- More controlled and predictable +- Example: "Ask exactly: 'Do you currently experience fever, cough, or fatigue?'" + +### 2. Determine Domain Type + +From {workflowPlanFile}, identify the workflow domain: + +**Intent-Based Domains (Default):** +- Creative work (writing, design, brainstorming) +- Personal development (planning, goals, reflection) +- Exploration (research, discovery) +- Collaboration (facilitation, coaching) + +**Prescriptive Domains (Exception):** +- Legal/Compliance (contracts, regulations) +- Medical (health assessments, triage) +- Financial (tax, regulatory compliance) +- Safety (risk assessments, safety checks) + +### 3. Check EACH Step's Instruction Style + +**DO NOT BE LAZY - For EACH step file:** + +1. Load the step +2. Read the instruction sections (MANDATORY SEQUENCE) +3. Classify style: + +**Intent-Based Indicators:** +- ✅ Describes goals/outcomes, not exact wording +- ✅ Uses "think about" language +- ✅ Multi-turn conversation encouraged +- ✅ "Ask 1-2 questions at a time, not a laundry list" +- ✅ "Probe to understand deeper" +- ✅ Flexible: "guide user through..." not "say exactly..." + +**Prescriptive Indicators:** +- Exact questions specified +- Specific wording required +- Sequence that must be followed precisely +- "Say exactly:" or "Ask precisely:" + +**Mixed Style:** +- Some steps prescriptive (critical/required) +- Others intent-based (creative/facilitative) + +### 4. Validate Appropriateness + +**For Intent-Based Domains:** +- ✅ Instructions should be intent-based +- ❌ Prescriptive instructions inappropriate (unless specific section requires it) + +**For Prescriptive Domains:** +- ✅ Instructions should be prescriptive where compliance matters +- ⚠️ May have intent-based sections for creative elements + +### 5. Document Findings + +```markdown +### Instruction Style Check Results + +**Domain Type:** [Creative/Personal/Exploratory OR Legal/Medical/Compliance] + +**Appropriate Style:** [Intent-based/Prescriptive/Mixed] + +**Step Instruction Style Analysis:** +| Step | Style Type | Appropriate | Notes | Status | +|------|-----------|-------------|-------|--------| +| step-01-init.md | Intent-based | ✅ | Goals described, flexible | ✅ PASS | +| step-02-*.md | Intent-based | ✅ | "Think about response" | ✅ PASS | +| step-03-*.md | Prescriptive | ❌ | Domain is creative, too rigid | ⚠️ WARN | +| step-04-*.md | Intent-based | ✅ | Good facilitation language | ✅ PASS | +| step-05-*.md | Mixed | ✅ | Prescriptive for compliance, intent elsewhere | ✅ PASS | + +**Issues Found:** + +**Overly Prescriptive Steps:** +- [List steps that are too prescriptive for their domain] +- Example: "step-03-*.md says 'Ask exactly: X, Y, Z' but this is a creative workflow" + +**Overly Flexible Steps (if prescriptive domain):** +- [List steps that should be more prescriptive] +- Example: "step-04-*.md is vague but this is a compliance workflow" + +**Style Inconsistencies:** +- [List steps where style doesn't match domain] + +**Good Examples Found:** +- [Highlight steps with excellent intent-based instructions] +- [Highlight steps with appropriate prescriptive language] + +**Status:** ✅ PASS / ❌ FAIL / ⚠️ WARNINGS +``` + +### 6. Append to Report + +Update {validationReportFile} - replace "## Instruction Style Check *Pending...*" with actual findings. + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Instruction Style check complete.** Proceeding to Collaborative Experience Check..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step's instruction style reviewed +- Style validated against domain appropriateness +- Issues documented with specific examples +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every step's style +- Not validating against domain +- Not documenting style issues +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY step's instruction style. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md new file mode 100644 index 00000000..b5aacfcc --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md @@ -0,0 +1,199 @@ +--- +name: 'step-08-collaborative-experience-check' +description: 'Check collaborative quality - does this workflow facilitate well or just interrogate?' + +nextStepFile: './step-09-cohesive-review.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Validation Step 8: Collaborative Experience Check + +## STEP GOAL: + +To validate that the workflow actually facilitates well - natural conversation, not interrogation. Questions asked progressively, not in laundry lists. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Review EVERY step for collaborative quality +- 🚫 DO NOT skip any files or experience checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Walk through the workflow as a user would +- 💾 Check conversation flow in each step +- 📖 Validate facilitation quality +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Good workflows facilitate, don't interrogate +- Questions should be 1-2 at a time +- Conversation should feel natural +- Check EVERY step for collaborative patterns + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load the Workflow Design + +From {workflowPlanFile}, understand: +- What is the workflow's goal? +- Who is the user? +- What interaction style was designed? + +### 2. Review EACH Step for Collaborative Quality + +**DO NOT BE LAZY - For EACH step file:** + +1. Load the step +2. Read the MANDATORY SEQUENCE section +3. Evaluate against collaborative quality criteria: + +**Good Facilitation Indicators:** +- ✅ "Ask 1-2 questions at a time" +- ✅ "Think about their response before continuing" +- ✅ "Use conversation, not interrogation" +- ✅ "Probe to understand deeper" +- ✅ Natural language in instructions +- ✅ Allows for back-and-forth + +**Bad Interrogation Indicators:** +- ❌ Laundry lists of questions +- ❌ "Ask the following: 1, 2, 3, 4, 5, 6..." +- ❌ Form-filling approach +- ❌ No space for conversation +- ❌ Rigid sequences without flexibility + +**Role Reinforcement Check:** +- ✅ "You are a [role], we engage in collaborative dialogue" +- ✅ "Together we produce something better" +- ❌ "You are a form filler" (obviously bad, but check for patterns) + +### 3. Check Progression and Arc + +**Does the workflow have:** +- ✅ Clear progression from step to step? +- ✅ Each step builds on previous work? +- ✅ User knows where they are in the process? +- ✅ Satisfying completion at the end? + +**Or does it:** +- ❌ Feel disjointed? +- ❌ Lack clear progression? +- ❌ Leave user unsure of status? + +### 4. Check Error Handling + +**Do steps handle:** +- ✅ Invalid input gracefully? +- ✅ User uncertainty with guidance? +- ✅ Off-track conversation with redirection? +- ✅ Edge cases with helpful messages? + +### 5. Document Findings + +```markdown +### Collaborative Experience Check Results + +**Overall Facilitation Quality:** [Excellent/Good/Fair/Poor] + +**Step-by-Step Analysis:** + +**step-01-init.md:** +- Question style: [Progressive/Laundry list] +- Conversation flow: [Natural/Rigid] +- Role clarity: ✅/❌ +- Status: ✅ PASS / ❌ FAIL + +**step-02-*.md:** +- Question style: [Progressive/laundry list - "Ask 1-2 at a time" / Lists 5+ questions] +- Allows conversation: ✅/❌ +- Thinks before continuing: ✅/❌ +- Status: ✅ PASS / ❌ FAIL + +[Continue for ALL steps...] + +**Collaborative Strengths Found:** +- [List examples of good facilitation] +- [Highlight steps that excel at collaboration] + +**Collaborative Issues Found:** + +**Laundry List Questions:** +- [List steps with question dumps] +- Example: "step-03-*.md asks 7 questions at once" + +**Rigid Sequences:** +- [List steps that don't allow conversation] +- Example: "step-04-*.md has no space for back-and-forth" + +**Form-Filling Patterns:** +- [List steps that feel like form filling] +- Example: "step-05-*.md collects data without facilitation" + +**Progression Issues:** +- [List problems with flow/arc] +- Example: "step-06-*.md doesn't connect to previous step" + +**User Experience Assessment:** + +**Would this workflow feel like:** +- [ ] A collaborative partner working WITH the user +- [ ] A form collecting data FROM the user +- [ ] An interrogation extracting information +- [ ] A mix - depends on step + +**Overall Collaborative Rating:** ⭐⭐⭐⭐⭐ [1-5 stars] + +**Status:** ✅ EXCELLENT / ✅ GOOD / ⚠️ NEEDS IMPROVEMENT / ❌ POOR +``` + +### 6. Append to Report + +Update {validationReportFile} - replace "## Collaborative Experience Check *Pending...*" with actual findings. + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Collaborative Experience check complete.** Proceeding to Cohesive Review..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step reviewed for collaborative quality +- Question patterns analyzed (progressive vs laundry list) +- Conversation flow validated +- Issues documented with specific examples +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every step's collaborative quality +- Missing question pattern analysis +- Not documenting experience issues +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY step's collaborative quality. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md b/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md new file mode 100644 index 00000000..0453ab93 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md @@ -0,0 +1,235 @@ +--- +name: 'step-09-cohesive-review' +description: 'Cohesive ultra-think review - overall quality, does this workflow actually facilitate well?' + +nextStepFile: './step-10-report-complete.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Validation Step 9: Cohesive Review + +## STEP GOAL: + +To perform a cohesive "ultra-think" review of the entire workflow - walk through it as a whole, assess overall quality, does it actually facilitate well? + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Review the workflow as a cohesive whole +- 🚫 DO NOT skip any aspect of the review +- 💬 Think deeply about quality and facilitation +- 🚪 This is the meta-review - overall assessment + +## EXECUTION PROTOCOLS: + +- 🎯 Walk through the ENTIRE workflow end-to-end +- 💾 Assess overall quality, not just individual components +- 📖 Think deeply: would this actually work well? +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- This is the cohesive review - look at the workflow as a whole +- Consider user experience from start to finish +- Assess whether the workflow achieves its goal +- Be thorough and thoughtful + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load the Entire Workflow + +**DO NOT BE LAZY - Load EVERY step file:** + +1. Load workflow.md +2. Load EVERY step file in steps-c/ in order +3. Read through each step +4. Understand the complete flow + +### 2. Walk Through the Workflow Mentally + +**Imagine you are a user running this workflow:** + +- Starting from workflow.md +- Going through step-01 +- Progressing through each step +- Experiencing the interactions +- Reaching the end + +**Ask yourself:** +- Does this make sense? +- Is the flow logical? +- Would I feel guided or confused? +- Does it achieve its goal? + +### 3. Assess Cohesiveness + +**Check for:** + +**✅ Cohesive Indicators:** +- Each step builds on previous work +- Clear progression toward goal +- Consistent voice and approach throughout +- User always knows where they are +- Satisfying completion + +**❌ Incohesive Indicators:** +- Steps feel disconnected +- Jumps in logic or flow +- Inconsistent patterns +- User might be confused +- Abrupt or unclear ending + +### 4. Assess Overall Quality + +**Rate the workflow on:** + +| Aspect | Rating (1-5) | Notes | +|--------|-------------|-------| +| Clear Goal | ⭐⭐⭐⭐⭐ | Is the purpose clear? | +| Logical Flow | ⭐⭐⭐⭐⭐ | Do steps progress logically? | +| Facilitation Quality | ⭐⭐⭐⭐⭐ | Does it facilitate well? | +| User Experience | ⭐⭐⭐⭐⭐ | Would users enjoy this? | +| Goal Achievement | ⭐⭐⭐⭐⭐ | Does it accomplish what it set out to? | +| Overall Quality | ⭐⭐⭐⭐⭐ | Total assessment | + +### 5. Identify Strengths and Weaknesses + +**Strengths:** +- What does this workflow do well? +- What makes it excellent? +- What should other workflows emulate? + +**Weaknesses:** +- What could be improved? +- What doesn't work well? +- What would confuse users? + +**Critical Issues:** +- Are there any show-stopper problems? +- Would this workflow fail in practice? + +### 6. Provide Recommendation + +**Overall Assessment:** +- ✅ **EXCELLENT** - Ready to use, exemplifies best practices +- ✅ **GOOD** - Solid workflow, minor improvements possible +- ⚠️ **NEEDS WORK** - Has issues that should be addressed +- ❌ **PROBLEMATIC** - Major issues, needs significant revision + +**Recommendation:** +- [Ready for use / Ready with minor tweaks / Needs revision / Major rework needed] + +### 7. Document Findings + +```markdown +### Cohesive Review Results + +**Overall Assessment:** [EXCELLENT/GOOD/NEEDS WORK/PROBLEMATIC] + +**Quality Ratings:** +| Aspect | Rating | Notes | +|--------|--------|-------| +| Clear Goal | ⭐⭐⭐⭐⭐ | [Notes] | +| Logical Flow | ⭐⭐⭐⭐⭐ | [Notes] | +| Facilitation Quality | ⭐⭐⭐⭐⭐ | [Notes] | +| User Experience | ⭐⭐⭐⭐⭐ | [Notes] | +| Goal Achievement | ⭐⭐⭐⭐⭐ | [Notes] | +| **Overall Quality** | **⭐⭐⭐⭐⭐** | [Total assessment] | + +**Cohesiveness Analysis:** + +**Flow Assessment:** +- [Describe the overall flow - does it work?] +- [Are there any jarring transitions?] +- [Does each step connect to the next?] + +**Progression Assessment:** +- [Does the workflow build toward its goal?] +- [Is there a clear arc?] +- [Would a user feel they're making progress?] + +**Voice and Tone:** +- [Is the voice consistent throughout?] +- [Does the AI persona work well?] +- [Is the collaboration style appropriate?] + +**Strengths:** +1. [Major strength #1] +2. [Major strength #2] +3. [What makes this workflow excellent] + +**Weaknesses:** +1. [Issue #1 that could be improved] +2. [Issue #2 that could be improved] +3. [What doesn't work as well] + +**Critical Issues (if any):** +- [List any show-stopper problems] +- [Or note: No critical issues] + +**What Makes This Work Well:** +- [Describe the excellent elements] +- [What should other workflows learn from this?] + +**What Could Be Improved:** +- [Specific actionable improvements] +- [Priority: High/Medium/Low] + +**User Experience Forecast:** +- [How would a user experience this workflow?] +- [Would they feel: guided/confused/satisfied/frustrated?] + +**Recommendation:** +- [Ready for use / Ready with minor tweaks / Needs revision / Major rework needed] + +**Status:** ✅ EXCELLENT / ✅ GOOD / ⚠️ NEEDS WORK / ❌ PROBLEMATIC +``` + +### 8. Append to Report + +Update {validationReportFile} - replace "## Cohesive Review *Pending...*" with actual findings. + +### 9. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Cohesive Review complete.** Proceeding to finalize validation report..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- ENTIRE workflow reviewed end-to-end +- Quality assessed across multiple dimensions +- Strengths and weaknesses documented +- Thoughtful recommendation provided +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not reviewing the entire workflow +- Superficial or lazy assessment +- Not documenting strengths/weaknesses +- Not providing clear recommendation +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Review the ENTIRE workflow cohesively. Think deeply about quality. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md b/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md new file mode 100644 index 00000000..c011bc33 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md @@ -0,0 +1,234 @@ +--- +name: 'step-10-report-complete' +description: 'Finalize validation report - check for plan file, summarize all findings, present to user' + +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +planValidationStep: './step-11-plan-validation.md' +--- + +# Validation Step 10: Report Complete + +## STEP GOAL: + +To check if a plan file exists (and run plan validation if it does), then summarize all validation findings and present to the user. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 This is the final validation step - present findings +- 🚫 DO NOT modify the workflow without user request +- 💬 Present summary and ask what changes are needed +- 🚪 This ends validation - user decides next steps + +## EXECUTION PROTOCOLS: + +- 🎯 Load the complete validation report +- 💾 Summarize ALL findings +- 📖 Update report status to COMPLETE +- 🚫 DO NOT proceed without user review + +## CONTEXT BOUNDARIES: + +- All 9 previous validation steps have completed +- Report contains findings from all checks +- User needs to see summary and decide on changes +- This step DOES NOT auto-proceed + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Check for Plan File + +Before finalizing the report, check if a plan file exists: + +**Check if {workflowPlanFile} exists:** +- **IF YES:** Run plan validation first + - Load, read entire file, then execute {planValidationStep} + - The plan validation will append its findings to the report + - Then return to this step to finalize the report +- **IF NO:** Proceed to finalize the report (no plan to validate) + +### 2. Load Complete Validation Report + +After plan validation (if applicable), load {validationReportFile} and read ALL findings from every validation step. + +### 3. Create Summary Section + +At the end of {validationReportFile}, replace "## Summary *Pending...*" with: + +```markdown +## Summary + +**Validation Completed:** [current date] + +**Overall Status:** +[Based on all validation steps, determine overall status] + +**Validation Steps Completed:** +1. ✅ File Structure & Size - [PASS/FAIL/WARN] +2. ✅ Frontmatter Validation - [PASS/FAIL/WARN] +3. ✅ Menu Handling Validation - [PASS/FAIL/WARN] +4. ✅ Step Type Validation - [PASS/FAIL/WARN] +5. ✅ Output Format Validation - [PASS/FAIL/WARN] +6. ✅ Validation Design Check - [PASS/FAIL/WARN/N/A] +7. ✅ Instruction Style Check - [PASS/FAIL/WARN] +8. ✅ Collaborative Experience Check - [PASS/FAIL/WARN] +9. ✅ Cohesive Review - [EXCELLENT/GOOD/NEEDS WORK/PROBLEMATIC] +10. ✅ Plan Quality Validation - [FULLY IMPLEMENTED/PARTIALLY/MISSING/N/A] + +**Issues Summary:** + +**Critical Issues (Must Fix):** +- [List any critical issues from all validation steps] +- [If none, state: No critical issues found] + +**Warnings (Should Fix):** +- [List any warnings from all validation steps] +- [If none, state: No warnings found] + +**Strengths:** +- [List key strengths identified in validation] + +**Overall Assessment:** +[Summarize the overall quality of the workflow] + +**Recommendation:** +- [Ready to use / Ready with minor tweaks / Needs revision / Major rework needed] + +**Next Steps:** +- Review the detailed findings above +- Decide what changes to make +- Either fix issues directly or use edit workflow (if tri-modal) +``` + +### 3. Update Report Status + +Update frontmatter of {validationReportFile}: + +```yaml +--- +validationDate: [original date] +completionDate: [current date] +workflowName: {new_workflow_name} +workflowPath: {targetWorkflowPath} +validationStatus: COMPLETE +--- +``` + +### 4. Present Summary to User + +"**✅ Validation Complete!** + +I've completed extensive validation of your workflow. Here's the summary:" + +**Overall Status:** [Overall status from summary] + +**Quick Results:** +| Validation Step | Result | +|-----------------|--------| +| File Structure & Size | [emoji] [result] | +| Frontmatter | [emoji] [result] | +| Menu Handling | [emoji] [result] | +| Step Types | [emoji] [result] | +| Output Format | [emoji] [result] | +| Validation Design | [emoji] [result or N/A] | +| Instruction Style | [emoji] [result] | +| Collaborative Experience | [emoji] [result] | +| Cohesive Review | [emoji] [result] | +| Plan Quality | [emoji] [result or N/A] | + +**Issues Found:** +- **Critical:** [count or "none"] +- **Warnings:** [count or "none"] + +**Recommendation:** [Ready to use / Needs tweaks / Needs revision] + +"**The full validation report is available at:** +`{validationReportFile}` + +**Would you like me to:** +1. Review the detailed findings with you +2. Make specific changes to address issues +3. Explain any validation result in detail +4. Something else" + +### 5. Present MENU OPTIONS + +Display: **Validation Complete! Select an Option:** [R] Review Detailed Findings [F] Fix Issues [X] Exit Validation + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User chooses their next action + +#### Menu Handling Logic: + +- IF R: Walk through the validation report section by section, explaining findings, then redisplay menu +- IF F: "What issues would you like to fix?" → Discuss specific changes needed → User can make edits manually OR you can help edit files +- IF X: "Validation complete. Your workflow is at: {targetWorkflowPath}. You can make changes and re-run validation anytime." +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +### 6. If User Wants to Fix Issues + +**Options for fixing:** + +**Option A: Manual Edits** +- User edits files directly +- Re-run validation to check fixes + +**Option B: Guided Edits** +- User specifies what to fix +- Help create specific edits for user approval +- User applies edits + +**Option C: Edit Workflow (if tri-modal)** +- If workflow has steps-e/, use edit workflow +- Edit workflow can make systematic changes + +### 7. Update Plan with Validation Status + +Update {workflowPlanFile} frontmatter: + +```yaml +--- +validationStatus: COMPLETE +validationDate: [current date] +validationReport: {validationReportFile} +--- +``` + +## CRITICAL STEP COMPLETION NOTE + +This is the final validation step. User reviews findings and decides whether to make changes. Validation workflow ends here. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All validation findings summarized +- Complete report presented to user +- Summary section added to report +- Report status updated to COMPLETE +- User can review findings and decide on changes +- Plan updated with validation status + +### ❌ SYSTEM FAILURE: + +- Not summarizing all findings +- Not presenting complete report to user +- Not updating report status +- Not giving user clear options for next steps + +**Master Rule:** Validation is complete. User reviews findings and decides what changes to make. Provide clear summary and options. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md new file mode 100644 index 00000000..83f55cae --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md @@ -0,0 +1,209 @@ +--- +name: 'step-11-plan-validation' +description: 'Validate plan quality - ensure all user intent and requirements are implemented' + +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Validation Step 11: Plan Quality Validation + +## STEP GOAL: + +To validate that a workflow plan (if it exists) has been fully implemented - all user intent captured, all requirements met with high quality. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ This validation step only runs if a plan file exists + +### Step-Specific Rules: + +- 🎯 Load the complete plan file +- 🚫 DO NOT skip checking any requirement from the plan +- 💬 Validate that built workflow matches plan specifications +- 🚪 This ensures the build actually delivered what was planned + +## EXECUTION PROTOCOLS: + +- 🎯 Load plan and extract all requirements/intent +- 💾 Check built workflow against plan +- 📖 Document gaps and quality issues +- 🚫 Only run this step if workflowPlanFile exists + +## CONTEXT BOUNDARIES: + +- This step runs AFTER the workflow is built +- Compares what was planned vs what was implemented +- Checks for: missing features, quality gaps, unmet user intent + +## MANDATORY SEQUENCE + +**CRITICAL:** Only run this step if {workflowPlanFile} exists. If it doesn't exist, skip to final summary. + +### 1. Check if Plan Exists + +First, check if {workflowPlanFile} exists: + +**IF plan file does NOT exist:** +- Skip this validation step +- Proceed to summary with note: "No plan file found - workflow may have been built without BMAD create-workflow process" + +**IF plan file exists:** +- Load the complete plan file +- Proceed with validation + +### 2. Extract Plan Requirements + +**DO NOT BE LAZY - Extract EVERY requirement from the plan:** + +From {workflowPlanFile}, extract: + +**From Discovery Section:** +- User's original idea/vision +- Core problem being solved + +**From Classification Section:** +- 4 key decisions (document output, module, continuable, tri-modal) +- Target path +- Workflow name + +**From Requirements Section:** +- Flow structure (linear/looping/branching) +- User interaction style +- Inputs required +- Output specifications +- Success criteria + +**From Design Section:** +- Step outline with names and purposes +- Flow diagram +- Interaction patterns +- File structure requirements + +**From Tools Section:** +- Tools configured +- Data files specified + +### 3. Validate Each Requirement Against Built Workflow + +**For EACH requirement extracted:** + +Check the built workflow to see if it was implemented: + +**Discovery Validation:** +- ✅ Built workflow addresses the original problem? +- ✅ Vision from discovery is reflected in final workflow? + +**Classification Validation:** +- ✅ Document output matches plan (yes/no)? +- ✅ Module affiliation correct? +- ✅ Continuable support as specified? +- ✅ Tri-modal structure as specified? + +**Requirements Validation:** +- ✅ Flow structure matches plan? +- ✅ User interaction style as specified? +- ✅ All required inputs configured? +- ✅ Output format matches specification? +- ✅ Success criteria achievable? + +**Design Validation:** +- ✅ All steps from design present in workflow? +- ✅ Step purposes match design? +- ✅ Flow follows design diagram? +- ✅ Interaction patterns as specified? + +**Tools Validation:** +- ✅ Specified tools configured in workflow? +- ✅ Data files created as specified? + +### 4. Check Implementation Quality + +For each implemented requirement, assess quality: + +**Quality Questions:** +- Is the implementation high quality or minimal/barely working? +- Would this actually facilitate well? +- Are there obvious gaps or issues? + +**Example:** +- Plan: "Highly collaborative, intent-based facilitation" +- Implementation: Has A/P menus, uses intent-based language ✅ + +- Plan: "Continuable workflow with session resume" +- Implementation: Has step-01b-continue.md, tracks stepsCompleted ✅ + +### 5. Document Findings + +```markdown +### Plan Quality Validation Results + +**Plan File:** {workflowPlanFile} +**Plan Exists:** ✅ Yes + +**Requirements Extracted:** [number] requirements from plan sections + +**Implementation Coverage:** + +| Requirement Area | Specified | Implemented | Quality | Status | +|------------------|-----------|--------------|---------|--------| +| Discovery/Vision | [summary] | ✅/❌ | High/Med/Low | ✅/❌ | +| Document Output | [yes/no] | ✅/❌ | High/Med/Low | ✅/❌ | +| Continuable | [yes/no] | ✅/❌ | High/Med/Low | ✅/❌ | +| Tri-Modal | [yes/no] | ✅/❌ | High/Med/Low | ✅/❌ | +| Flow Structure | [type] | ✅/❌ | High/Med/Low | ✅/❌ | +| Interaction Style | [style] | ✅/❌ | High/Med/Low | ✅/❌ | +| [Step 01] | [purpose] | ✅/❌ | High/Med/Low | ✅/❌ | +| [Step 02] | [purpose] | ✅/❌ | High/Med/Low | ✅/❌ | +| ... | ... | ... | ... | ... | + +**Missing Implementations:** +- [List any requirements from plan that are NOT in the built workflow] + +**Quality Issues:** +- [List any requirements that are implemented but with poor quality] + +**Gaps Between Plan and Reality:** +- [List where the built workflow doesn't match the plan] + +**Plan Implementation Score:** [X]% + +**Status:** ✅ FULLY IMPLEMENTED / ⚠️ PARTIALLY IMPLEMENTED / ❌ POORLY IMPLEMENTED / ❌ MISSING CRITICAL ITEMS +``` + +### 6. Append to Report + +Append findings to {validationReportFile} after the "## Cohesive Review" section. + +### 7. Save and Complete + +Save the validation report. This is the final validation step. + +**Display:** +"**Plan Quality validation complete.** Validation report finalized." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Plan file loaded completely +- Every requirement extracted and validated +- Implementation gaps documented +- Quality assessed for each requirement +- Findings appended to report + +### ❌ SYSTEM FAILURE: + +- Not loading complete plan +- Skipping requirement checks +- Not documenting implementation gaps +- Not assessing quality + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY requirement from the plan. Document all gaps. diff --git a/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md b/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md new file mode 100644 index 00000000..ecb1fb97 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md @@ -0,0 +1,11 @@ +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +project_name: '' +--- + +# {{document_title}} + +[Content will be progressively appended by workflow steps] diff --git a/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md b/src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md similarity index 100% rename from src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md rename to src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md diff --git a/src/modules/bmb/docs/workflows/templates/step-1b-template.md b/src/modules/bmb/workflows/workflow/templates/step-1b-template.md similarity index 100% rename from src/modules/bmb/docs/workflows/templates/step-1b-template.md rename to src/modules/bmb/workflows/workflow/templates/step-1b-template.md diff --git a/src/modules/bmb/docs/workflows/templates/step-template.md b/src/modules/bmb/workflows/workflow/templates/step-template.md similarity index 98% rename from src/modules/bmb/docs/workflows/templates/step-template.md rename to src/modules/bmb/workflows/workflow/templates/step-template.md index 38b447e4..a6758603 100644 --- a/src/modules/bmb/docs/workflows/templates/step-template.md +++ b/src/modules/bmb/workflows/workflow/templates/step-template.md @@ -74,7 +74,7 @@ Example: "To analyze user requirements and document functional specifications th ## EXECUTION PROTOCOLS: -- 🎯 [Step-specific protocol 1] +- 🎯 Follow the MANDATORY SEQUENCE exactly - 💾 [Step-specific protocol 2 - e.g., document updates] - 📖 [Step-specific protocol 3 - e.g., tracking requirements] - 🚫 [Step-specific restriction] @@ -86,9 +86,9 @@ Example: "To analyze user requirements and document functional specifications th - Limits: [what not to assume or do] - Dependencies: [what this step depends on] -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE -[Detailed instructions for the step's work] +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Title diff --git a/src/modules/bmb/docs/workflows/templates/workflow-template.md b/src/modules/bmb/workflows/workflow/templates/workflow-template.md similarity index 100% rename from src/modules/bmb/docs/workflows/templates/workflow-template.md rename to src/modules/bmb/workflows/workflow/templates/workflow-template.md diff --git a/src/modules/bmb/workflows/create-workflow/workflow.md b/src/modules/bmb/workflows/workflow/workflow.md similarity index 54% rename from src/modules/bmb/workflows/create-workflow/workflow.md rename to src/modules/bmb/workflows/workflow/workflow.md index 568edc88..47feff81 100644 --- a/src/modules/bmb/workflows/create-workflow/workflow.md +++ b/src/modules/bmb/workflows/workflow/workflow.md @@ -1,6 +1,6 @@ --- name: create-workflow -description: Create structured standalone workflows using markdown-based step architecture +description: Create structured standalone workflows using markdown-based step architecture (tri-modal: create, validate, edit) web_bundle: true --- @@ -10,6 +10,8 @@ web_bundle: true **Your Role:** In addition to your name, communication_style, and persona, you are also a workflow architect and systems designer collaborating with a workflow creator. This is a partnership, not a client-vendor relationship. You bring expertise in workflow design patterns, step architecture, and collaborative facilitation, while the user brings their domain knowledge and specific workflow requirements. Work together as equals. +**Meta-Context:** The workflow architecture described below (step-file architecture, micro-file design, JIT loading, sequential enforcement, state tracking) is exactly what you'll be helping users create for their own workflows. You're demonstrating the pattern while building it with them. + --- ## WORKFLOW ARCHITECTURE @@ -23,6 +25,7 @@ This uses **step-file architecture** for disciplined execution: - **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed - **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document - **Append-Only Building**: Build documents by appending content as directed to the output file +- **Tri-Modal Structure**: Separate step folders for Create (steps-c/), Validate (steps-v/), and Edit (steps-e/) modes ### Step Processing Rules @@ -53,7 +56,48 @@ This uses **step-file architecture** for disciplined execution: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -### 2. First Step EXECUTION +### 2. Mode Determination -Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. +**Check if mode was specified in the command invocation:** + +- If user invoked with "create workflow" or "new workflow" or "build workflow" → Set mode to **create** +- If user invoked with "validate workflow" or "review workflow" or "-v" or "--validate" → Set mode to **validate** +- If user invoked with "edit workflow" or "modify workflow" or "-e" or "--edit" → Set mode to **edit** + +**If mode is still unclear, ask user:** + +"Welcome to the BMAD Workflow Creator! What would you like to do? + +**[C]reate** - Build a new workflow from scratch +**[V]alidate** - Review an existing workflow and generate validation report +**[E]dit** - Modify an existing workflow + +Please select: [C]reate / [V]alidate / [E]dit" + +### 3. Route to First Step + +**IF mode == create:** + +"**Creating a new workflow. How would you like to start?** + +**[F]rom scratch** - Start with a blank slate - I'll help you discover your idea +**[C]onvert existing** - Convert an existing workflow to BMAD compliant format + +Please select: [F]rom scratch / [C]onvert existing" + +#### Create Mode Routing: + +- **IF F:** Load, read completely, then execute `steps-c/step-01-discovery.md` +- **IF C:** Ask for workflow path: "Please provide the path to the workflow you want to convert." + Then load, read completely, then execute `steps-c/step-00-conversion.md` +- **IF Any other:** help user respond, then redisplay create mode menu + +**IF mode == validate:** +Prompt for workflow path: "Which workflow would you like to validate? Please provide the path to the workflow.md file." +Then load, read completely, and execute `steps-v/step-01-validate.md` + +**IF mode == edit:** +Prompt for workflow path: "Which workflow would you like to edit? Please provide the path to the workflow.md file." +Then load, read completely, and execute `steps-e/step-e-01-assess-workflow.md` From 35ae4fd024e0fac525e0033b361b960a73014469 Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Sat, 3 Jan 2026 00:32:56 +0800 Subject: [PATCH 7/7] quadrivariate module workflow --- .../bmb/agents/module-builder.agent.yaml | 12 +- .../workflows-legacy/edit-module/README.md | 171 ------- .../workflows-legacy/edit-module/checklist.md | 163 ------ .../edit-module/instructions.md | 340 ------------- .../edit-module/workflow.yaml | 34 -- .../workflows-legacy/module-brief/README.md | 264 ---------- .../module-brief/checklist.md | 116 ----- .../module-brief/instructions.md | 268 ---------- .../workflows-legacy/module-brief/template.md | 275 ----------- .../module-brief/workflow.yaml | 36 -- .../workflows/agent/data/critical-actions.md | 4 +- .../agent/data/expert-agent-architecture.md | 2 +- .../agent/steps-c/step-03-type-metadata.md | 6 +- .../agent/steps-c/step-04-persona.md | 2 +- .../agent/steps-c/step-05-commands-menu.md | 2 +- .../agent/steps-c/step-06-activation.md | 14 +- .../agent/steps-c/step-07a-build-simple.md | 8 +- .../agent/steps-c/step-07b-build-expert.md | 32 +- .../agent/steps-c/step-07c-build-module.md | 4 +- ...p-09-celebrate.md => step-08-celebrate.md} | 19 +- .../steps-c/step-08a-plan-traceability.md | 205 -------- .../steps-c/step-08b-metadata-validation.md | 130 ----- .../steps-c/step-08c-persona-validation.md | 161 ------ .../agent/steps-c/step-08d-menu-validation.md | 175 ------- .../steps-c/step-08e-structure-validation.md | 308 ------------ .../steps-c/step-08f-sidecar-validation.md | 464 ------------------ .../agent/steps-e/e-01-load-existing.md | 5 +- .../agent/steps-e/e-07-activation.md | 19 +- .../agent/steps-e/e-08a-edit-simple.md | 9 +- .../agent/steps-e/e-08b-edit-expert.md | 8 +- .../agent/steps-e/e-08c-edit-module.md | 7 +- .../{e-10-celebrate.md => e-09-celebrate.md} | 17 +- .../agent/steps-e/e-09a-validate-metadata.md | 128 ----- .../agent/steps-e/e-09b-validate-persona.md | 138 ------ .../agent/steps-e/e-09c-validate-menu.md | 163 ------ .../agent/steps-e/e-09d-validate-structure.md | 154 ------ .../agent/steps-e/e-09e-validate-sidecar.md | 160 ------ .../agent/steps-e/e-09f-validation-summary.md | 113 ----- .../agent/steps-v/v-01-load-review.md | 7 +- .../agent/steps-v/v-02e-validate-sidecar.md | 6 +- .../module/data/agent-architecture.md | 179 +++++++ .../module/data/agent-spec-template.md | 79 +++ .../module/data/module-installer-standards.md | 348 +++++++++++++ .../workflows/module/data/module-standards.md | 280 +++++++++++ .../module/data/module-yaml-conventions.md | 392 +++++++++++++++ .../module/steps-b/step-01-welcome.md | 147 ++++++ .../workflows/module/steps-b/step-02-spark.md | 140 ++++++ .../module/steps-b/step-03-module-type.md | 148 ++++++ .../module/steps-b/step-04-vision.md | 82 ++++ .../module/steps-b/step-05-identity.md | 96 ++++ .../workflows/module/steps-b/step-06-users.md | 85 ++++ .../workflows/module/steps-b/step-07-value.md | 75 +++ .../module/steps-b/step-08-agents.md | 96 ++++ .../module/steps-b/step-09-workflows.md | 82 ++++ .../workflows/module/steps-b/step-10-tools.md | 90 ++++ .../module/steps-b/step-11-scenarios.md | 83 ++++ .../module/steps-b/step-12-creative.md | 94 ++++ .../module/steps-b/step-13-review.md | 104 ++++ .../module/steps-b/step-14-finalize.md | 117 +++++ .../module/steps-c/step-01-load-brief.md | 178 +++++++ .../module/steps-c/step-01b-continue.md | 83 ++++ .../module/steps-c/step-02-structure.md | 109 ++++ .../module/steps-c/step-03-config.md | 118 +++++ .../module/steps-c/step-04-installer.md | 160 ++++++ .../module/steps-c/step-05-agents.md | 167 +++++++ .../module/steps-c/step-06-workflows.md | 183 +++++++ .../workflows/module/steps-c/step-07-docs.md | 402 +++++++++++++++ .../module/steps-c/step-08-complete.md | 123 +++++ .../module/steps-e/step-01-load-target.md | 81 +++ .../module/steps-e/step-02-select-edit.md | 77 +++ .../module/steps-e/step-03-apply-edit.md | 77 +++ .../module/steps-e/step-04-review.md | 80 +++ .../module/steps-e/step-05-confirm.md | 75 +++ .../module/steps-v/step-01-load-target.md | 96 ++++ .../module/steps-v/step-02-file-structure.md | 94 ++++ .../module/steps-v/step-03-module-yaml.md | 99 ++++ .../module/steps-v/step-04-agent-specs.md | 152 ++++++ .../module/steps-v/step-05-workflow-specs.md | 152 ++++++ .../module/steps-v/step-06-documentation.md | 143 ++++++ .../module/steps-v/step-07-installation.md | 113 +++++ .../module/steps-v/step-08-report.md | 197 ++++++++ .../module/templates/brief-template.md | 154 ++++++ .../templates/workflow-spec-template.md | 96 ++++ src/modules/bmb/workflows/module/workflow.md | 100 ++++ 84 files changed, 6121 insertions(+), 4054 deletions(-) delete mode 100644 src/modules/bmb/workflows-legacy/edit-module/README.md delete mode 100644 src/modules/bmb/workflows-legacy/edit-module/checklist.md delete mode 100644 src/modules/bmb/workflows-legacy/edit-module/instructions.md delete mode 100644 src/modules/bmb/workflows-legacy/edit-module/workflow.yaml delete mode 100644 src/modules/bmb/workflows-legacy/module-brief/README.md delete mode 100644 src/modules/bmb/workflows-legacy/module-brief/checklist.md delete mode 100644 src/modules/bmb/workflows-legacy/module-brief/instructions.md delete mode 100644 src/modules/bmb/workflows-legacy/module-brief/template.md delete mode 100644 src/modules/bmb/workflows-legacy/module-brief/workflow.yaml rename src/modules/bmb/workflows/agent/steps-c/{step-09-celebrate.md => step-08-celebrate.md} (89%) delete mode 100644 src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md delete mode 100644 src/modules/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md delete mode 100644 src/modules/bmb/workflows/agent/steps-c/step-08c-persona-validation.md delete mode 100644 src/modules/bmb/workflows/agent/steps-c/step-08d-menu-validation.md delete mode 100644 src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md delete mode 100644 src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md rename src/modules/bmb/workflows/agent/steps-e/{e-10-celebrate.md => e-09-celebrate.md} (81%) delete mode 100644 src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md delete mode 100644 src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md delete mode 100644 src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md delete mode 100644 src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md delete mode 100644 src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md delete mode 100644 src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md create mode 100644 src/modules/bmb/workflows/module/data/agent-architecture.md create mode 100644 src/modules/bmb/workflows/module/data/agent-spec-template.md create mode 100644 src/modules/bmb/workflows/module/data/module-installer-standards.md create mode 100644 src/modules/bmb/workflows/module/data/module-standards.md create mode 100644 src/modules/bmb/workflows/module/data/module-yaml-conventions.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-01-welcome.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-02-spark.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-03-module-type.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-04-vision.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-05-identity.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-06-users.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-07-value.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-08-agents.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-09-workflows.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-10-tools.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-12-creative.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-13-review.md create mode 100644 src/modules/bmb/workflows/module/steps-b/step-14-finalize.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-01b-continue.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-02-structure.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-03-config.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-04-installer.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-05-agents.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-06-workflows.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-07-docs.md create mode 100644 src/modules/bmb/workflows/module/steps-c/step-08-complete.md create mode 100644 src/modules/bmb/workflows/module/steps-e/step-01-load-target.md create mode 100644 src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md create mode 100644 src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md create mode 100644 src/modules/bmb/workflows/module/steps-e/step-04-review.md create mode 100644 src/modules/bmb/workflows/module/steps-e/step-05-confirm.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-01-load-target.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-06-documentation.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-07-installation.md create mode 100644 src/modules/bmb/workflows/module/steps-v/step-08-report.md create mode 100644 src/modules/bmb/workflows/module/templates/brief-template.md create mode 100644 src/modules/bmb/workflows/module/templates/workflow-spec-template.md create mode 100644 src/modules/bmb/workflows/module/workflow.md diff --git a/src/modules/bmb/agents/module-builder.agent.yaml b/src/modules/bmb/agents/module-builder.agent.yaml index 9ccad18f..5a6fc9b9 100644 --- a/src/modules/bmb/agents/module-builder.agent.yaml +++ b/src/modules/bmb/agents/module-builder.agent.yaml @@ -28,22 +28,18 @@ agent: - modules: "{project-root}/_bmad/bmb/docs/modules/kb.csv" menu: - - trigger: BM or fuzzy match on brainstorm-module - exec: "{project-root}/_bmad/bmb/workflows/brainstorm-module/workflow.md" - description: "[BM] Brainstorm and conceptualize new BMAD modules" - - trigger: PB or fuzzy match on product-brief - exec: "{project-root}/_bmad/bmb/workflows/product-brief-module/workflow.md" + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" description: "[PB] Create product brief for BMAD module development" - trigger: CM or fuzzy match on create-module - exec: "{project-root}/_bmad/bmb/workflows/create-module/workflow.md" + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" description: "[CM] Create a complete BMAD module with agents, workflows, and infrastructure" - trigger: EM or fuzzy match on edit-module - exec: "{project-root}/_bmad/bmb/workflows/edit-module/workflow.md" + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" description: "[EM] Edit existing BMAD modules while maintaining coherence" - trigger: VM or fuzzy match on validate-module - exec: "{project-root}/_bmad/bmb/workflows/module-compliance-check/workflow.md" + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" description: "[VM] Run compliance check on BMAD modules against best practices" diff --git a/src/modules/bmb/workflows-legacy/edit-module/README.md b/src/modules/bmb/workflows-legacy/edit-module/README.md deleted file mode 100644 index d14308cb..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/README.md +++ /dev/null @@ -1,171 +0,0 @@ -# Edit Module Workflow - -Interactive workflow for editing existing BMAD modules, including structure, agents, workflows, configuration, and documentation. - -## Purpose - -This workflow helps you improve and maintain BMAD modules by: - -- Analyzing module structure against best practices -- Managing agents and workflows within the module -- Updating configuration and documentation -- Ensuring cross-module integration works correctly -- Maintaining installer configuration (for source modules) - -## When to Use - -Use this workflow when you need to: - -- Add new agents or workflows to a module -- Update module configuration -- Improve module documentation -- Reorganize module structure -- Set up cross-module workflow sharing -- Fix issues in module organization -- Update installer configuration - -## What You'll Need - -- Path to the module directory you want to edit -- Understanding of what changes you want to make -- Access to module documentation (loaded automatically) - -## Workflow Steps - -1. **Load and analyze target module** - Provide path to module directory -2. **Analyze against best practices** - Automatic audit of module structure -3. **Select editing focus** - Choose what aspect to edit -4. **Load relevant documentation and tools** - Auto-loads guides and workflows -5. **Perform edits** - Review and approve changes iteratively -6. **Validate all changes** - Comprehensive validation checklist -7. **Generate change summary** - Summary of improvements made - -## Editing Options - -The workflow provides 12 focused editing options: - -1. **Fix critical issues** - Address missing files, broken references -2. **Update module config** - Edit config.yaml fields -3. **Manage agents** - Add, edit, or remove agents -4. **Manage workflows** - Add, edit, or remove workflows -5. **Update documentation** - Improve README files and guides -6. **Reorganize structure** - Fix directory organization -7. **Add new agent** - Create and integrate new agent -8. **Add new workflow** - Create and integrate new workflow -9. **Update installer** - Modify installer configuration (source only) -10. **Cross-module integration** - Set up workflow sharing with other modules -11. **Remove deprecated items** - Delete unused agents, workflows, or files -12. **Full module review** - Comprehensive analysis and improvements - -## Integration with Other Workflows - -This workflow integrates with: - -- **edit-agent** - For editing individual agents -- **edit-workflow** - For editing individual workflows -- **create-agent** - For adding new agents -- **create-workflow** - For adding new workflows - -When you select options to manage agents or workflows, the appropriate specialized workflow is invoked automatically. - -## Module Structure - -A proper BMAD module has: - -``` -module-code/ -├── agents/ # Agent definitions -│ └── *.agent.yaml -├── workflows/ # Workflow definitions -│ └── workflow-name/ -│ ├── workflow.yaml -│ ├── instructions.md -│ ├── checklist.md -│ └── README.md -├── config.yaml # Module configuration -└── README.md # Module documentation -``` - -## Standard Module Config - -Every module config.yaml should have: - -```yaml -module_name: 'Full Module Name' -module_code: 'xyz' -user_name: 'User Name' -communication_language: 'english' -output_folder: 'path/to/output' -``` - -Optional fields may be added for module-specific needs. - -## Cross-Module Integration - -Modules can share workflows: - -```yaml -# In agent menu item: -workflow: '{project-root}/_bmad/other-module/workflows/shared-workflow/workflow.yaml' -``` - -Common patterns: - -- BMM uses CIS brainstorming workflows -- All modules can use core workflows -- Modules can invoke each other's workflows - -## Output - -The workflow modifies module files in place, including: - -- config.yaml -- Agent files -- Workflow files -- README and documentation files -- Directory structure (if reorganizing) - -Changes are reviewed and approved by you before being applied. - -## Best Practices - -- **Start with analysis** - Let the workflow audit your module first -- **Use specialized workflows** - Let edit-agent and edit-workflow handle detailed edits -- **Update documentation** - Keep README files current with changes -- **Validate thoroughly** - Use the validation step to catch structural issues -- **Test after editing** - Invoke agents and workflows to verify they work - -## Tips - -- For adding agents/workflows, use options 7-8 to create and integrate in one step -- For quick config changes, use option 2 (update module config) -- Cross-module integration (option 10) helps set up workflow sharing -- Full module review (option 12) is great for inherited or legacy modules -- The workflow handles path updates when you reorganize structure - -## Example Usage - -``` -User: I want to add a new workflow to BMM for API design -Workflow: Analyzes BMM → You choose option 8 (add new workflow) - → Invokes create-workflow → Creates workflow - → Integrates it into module → Updates README → Done -``` - -## Activation - -Invoke via BMad Builder agent: - -``` -/bmad:bmb:agents:bmad-builder -Then select: *edit-module -``` - -Or directly via workflow.xml with this workflow config. - -## Related Resources - -- **Module Structure Guide** - Comprehensive module architecture documentation -- **BMM Module** - Example of full-featured module -- **BMB Module** - Example of builder/tooling module -- **CIS Module** - Example of workflow library module diff --git a/src/modules/bmb/workflows-legacy/edit-module/checklist.md b/src/modules/bmb/workflows-legacy/edit-module/checklist.md deleted file mode 100644 index 779ec5c4..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/checklist.md +++ /dev/null @@ -1,163 +0,0 @@ -# Edit Module - Validation Checklist - -Use this checklist to validate module edits meet BMAD Core standards. - -## Module Structure Validation - -- [ ] Module has clear abbreviation code (bmm, bmb, cis, etc.) -- [ ] agents/ directory exists -- [ ] workflows/ directory exists -- [ ] config.yaml exists in module root -- [ ] README.md exists in module root -- [ ] Directory structure follows BMAD conventions - -## Configuration Validation - -### Required Fields - -- [ ] module_name is descriptive and clear -- [ ] module_code is 3-letter code matching directory name -- [ ] user_name field present -- [ ] communication_language field present -- [ ] output_folder field present - -### Optional Fields (if used) - -- [ ] bmb_creations_output_folder documented -- [ ] Module-specific fields documented in README - -### File Quality - -- [ ] config.yaml is valid YAML syntax -- [ ] No duplicate keys -- [ ] Values are appropriate types (strings, paths, etc.) -- [ ] Comments explain non-obvious fields - -## Agent Validation - -### Agent Files - -- [ ] All agents in agents/ directory -- [ ] Agent files follow naming: {agent-name}.agent.yaml or .md -- [ ] Agent filenames use kebab-case -- [ ] No orphaned or temporary agent files - -### Agent Content - -- [ ] Each agent has clear role and purpose -- [ ] Agents reference workflows correctly -- [ ] Agent workflow paths are valid -- [ ] Agents load module config correctly (if needed) -- [ ] Agent menu items reference existing workflows - -### Agent Integration - -- [ ] All agents listed in module README -- [ ] Agent relationships documented (if applicable) -- [ ] Cross-agent workflows properly linked - -## Workflow Validation - -### Workflow Structure - -- [ ] All workflows in workflows/ directory -- [ ] Each workflow directory has workflow.yaml -- [ ] Each workflow directory has instructions.md -- [ ] Workflow directories use kebab-case naming -- [ ] No orphaned or incomplete workflow directories - -### Workflow Content - -- [ ] workflow.yaml is valid YAML -- [ ] workflow.yaml has name field -- [ ] workflow.yaml has description field -- [ ] workflow.yaml has author field -- [ ] instructions.md has proper structure -- [ ] Workflow steps are numbered and logical - -### Workflow Integration - -- [ ] All workflows listed in module README -- [ ] Workflow paths in agents are correct -- [ ] Cross-module workflow references are valid -- [ ] Sub-workflow references exist - -## Documentation Validation - -### Module README - -- [ ] Module README describes purpose clearly -- [ ] README lists all agents with descriptions -- [ ] README lists all workflows with descriptions -- [ ] README includes installation instructions (if applicable) -- [ ] README explains module's role in BMAD ecosystem - -### Workflow READMEs - -- [ ] Each workflow has its own README.md -- [ ] Workflow READMEs explain purpose -- [ ] Workflow READMEs list inputs/outputs -- [ ] Workflow READMEs include usage examples - -### Other Documentation - -- [ ] Usage guides present (if needed) -- [ ] Architecture docs present (if complex module) -- [ ] Examples provided (if applicable) - -## Cross-References Validation - -- [ ] Agent workflow references point to existing workflows -- [ ] Workflow sub-workflow references are valid -- [ ] Cross-module references use correct paths -- [ ] Config file paths use {project-root} correctly -- [ ] No hardcoded absolute paths - -## Installer Validation (Source Modules Only) - -- [ ] Installer script exists in tools/cli/installers/ -- [ ] Installer script name: install-{module-code}.js -- [ ] Module metadata in installer is correct -- [ ] Web bundle configuration valid (if applicable) -- [ ] Installation paths are correct -- [ ] Dependencies documented in installer - -## Web Bundle Validation (If Applicable) - -- [ ] Web bundles configured in workflow.yaml files -- [ ] All referenced files included in web_bundle_files -- [ ] Paths are _bmad/-relative (not project-root) -- [ ] No config_source references in web bundles -- [ ] Invoked workflows included in dependencies - -## Quality Checks - -- [ ] No placeholder text remains ({MODULE_NAME}, {CODE}, etc.) -- [ ] No broken file references -- [ ] No duplicate content across files -- [ ] Consistent naming conventions throughout -- [ ] Module purpose is clear from README alone - -## Integration Checks - -- [ ] Module doesn't conflict with other modules -- [ ] Shared resources properly documented -- [ ] Dependencies on other modules explicit -- [ ] Module can be installed independently (if designed that way) - -## User Experience - -- [ ] Module purpose is immediately clear -- [ ] Agents have intuitive names -- [ ] Workflows have descriptive names -- [ ] Menu items are logically organized -- [ ] Error messages are helpful -- [ ] Success messages confirm actions - -## Final Checks - -- [ ] All files have been saved -- [ ] File permissions are correct -- [ ] Git status shows expected changes -- [ ] Module is ready for testing -- [ ] Documentation accurately reflects changes diff --git a/src/modules/bmb/workflows-legacy/edit-module/instructions.md b/src/modules/bmb/workflows-legacy/edit-module/instructions.md deleted file mode 100644 index 6f3e2b8b..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/instructions.md +++ /dev/null @@ -1,340 +0,0 @@ -# Edit Module - Module Editor Instructions - -The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/edit-module/workflow.yaml -This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs -The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them -Communicate all responses in {communication_language} - - - - -What is the path to the module source you want to edit? - -Load the module directory structure completely: - -- Scan all directories and files -- Load config.yaml -- Load README.md -- List all agents in agents/ directory -- List all workflows in workflows/ directory -- Identify any custom structure or patterns - - -Load ALL module documentation to inform understanding: - -- Module structure guide: {module_structure_guide} -- Study reference modules: BMM, BMB, CIS -- Understand BMAD module patterns and conventions - - -Analyze the module deeply: - -- Identify module purpose and role in BMAD ecosystem -- Understand agent organization and relationships -- Map workflow organization and dependencies -- Evaluate config structure and completeness -- Check documentation quality and currency -- Assess installer configuration (if source module) -- Identify cross-module integrations -- Evaluate against best practices from loaded guides - - -Reflect understanding back to {user_name}: - -Present a warm, conversational summary adapted to the module's complexity: - -- What this module provides (its purpose and value in BMAD) -- How it's organized (agents, workflows, structure) -- What you notice (strengths, potential improvements, issues) -- How it fits in the larger BMAD ecosystem -- Your initial assessment based on best practices - -Be conversational and insightful. Help {user_name} see their module through your eyes. - - -Does this match your understanding of what this module should provide? -module_understanding - - - -Understand WHAT the user wants to improve and WHY before diving into edits - -Engage in collaborative discovery: - -Ask open-ended questions to understand their goals: - -- What prompted you to want to edit this module? -- What feedback have you gotten from users of this module? -- Are there specific agents or workflows that need attention? -- Is the module fulfilling its intended purpose? -- Are there new capabilities you want to add? -- How well does it integrate with other modules? -- Is the documentation helping users understand and use the module? - -Listen for clues about: - -- Structural issues (poor organization, hard to navigate) -- Agent/workflow issues (outdated, broken, missing functionality) -- Configuration issues (missing fields, incorrect setup) -- Documentation issues (outdated, incomplete, unclear) -- Integration issues (doesn't work well with other modules) -- Installer issues (installation problems, missing files) -- User experience issues (confusing, hard to use) - - -Based on their responses and your analysis from step 1, identify improvement opportunities: - -Organize by priority and user goals: - -- CRITICAL issues blocking module functionality -- IMPORTANT improvements enhancing user experience -- NICE-TO-HAVE enhancements for polish - -Present these conversationally, explaining WHY each matters and HOW it would help. - - -Collaborate on priorities: - -Don't just list options - discuss them: - -- "I noticed {{issue}} - this could make it hard for users to {{problem}}. Want to address this?" -- "The module could be more {{improvement}} which would help when {{use_case}}. Worth exploring?" -- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?" - -Let the conversation flow naturally. Build a shared vision of what "better" looks like. - - -improvement_goals - - - -Work iteratively - improve, review, refine. Never dump all changes at once. -For agent and workflow edits, invoke specialized workflows rather than doing inline - -For each improvement area, facilitate collaboratively: - -1. **Explain the current state and why it matters** - - Show relevant sections of the module - - Explain how it works now and implications - - Connect to user's goals from step 2 - -2. **Propose improvements with rationale** - - Suggest specific changes that align with best practices - - Explain WHY each change helps - - Provide examples from reference modules: {bmm_module_dir}, {bmb_module_dir}, {cis_module_dir} - - Reference agents from: {existing_agents_dir} - - Reference workflows from: {existing_workflows_dir} - - Reference the structure guide's patterns naturally - -3. **Collaborate on the approach** - - Ask if the proposed change addresses their need - - Invite modifications or alternative approaches - - Explain tradeoffs when relevant - - Adapt based on their feedback - -4. **Apply changes appropriately** - - For agent edits: Invoke edit-agent workflow - - For workflow edits: Invoke edit-workflow workflow - - For module-level changes: Make directly and iteratively - - Show updates and confirm satisfaction - - -Common improvement patterns to facilitate: - -**If improving module organization:** - -- Discuss how the current structure serves (or doesn't serve) users -- Propose reorganization that aligns with mental models -- Consider feature-based vs type-based organization -- Plan the reorganization steps -- Update all references after moving files - -**If updating module configuration:** - -- Review current config.yaml fields -- Check for missing standard fields (user_name, communication_language, output_folder) -- Add module-specific fields as needed -- Remove unused or outdated fields -- Ensure config is properly documented - -**If managing agents:** - -- Ask which agent needs attention and why -- For editing existing agent: -- For adding new agent: Guide creation and integration -- For removing agent: Confirm, remove, update references -- Ensure all agent references in workflows remain valid - -**If managing workflows:** - -- Ask which workflow needs attention and why -- For editing existing workflow: -- For adding new workflow: Guide creation and integration -- For removing workflow: Confirm, remove, update agent references -- Ensure all workflow files are properly organized - -**If improving documentation:** - -- Review current README and identify gaps -- Discuss what users need to know -- Update module overview and purpose -- List agents and workflows with clear descriptions -- Add usage examples if helpful -- Ensure installation/setup instructions are clear - -**If setting up cross-module integration:** - -- Identify which workflows from other modules are needed -- Show how to reference workflows properly: {project-root}/_bmad/{{module}}/workflows/{{workflow}}/workflow.yaml -- Document the integration in README -- Ensure dependencies are clear -- Consider adding example usage - -**If updating installer (source modules only):** - -- Review installer script for correctness -- Check web bundle configurations -- Verify all files are included -- Test installation paths -- Update module metadata - - -When invoking specialized workflows: - -Explain why you're handing off: - -- "This agent needs detailed attention. Let me invoke the edit-agent workflow to give it proper focus." -- "The workflow editor can handle this more thoroughly. I'll pass control there." - -After the specialized workflow completes, return and continue: - -- "Great! That agent/workflow is updated. Want to work on anything else in the module?" - - -Throughout improvements, educate when helpful: - -Share insights from the guides naturally: - -- "The module structure guide recommends {{pattern}} for this scenario" -- "Looking at how BMM organized this, we could use {{approach}}" -- "The BMAD convention is to {{pattern}} which helps with {{benefit}}" - -Connect improvements to broader BMAD principles without being preachy. - - -After each significant change: - -- "Does this organization feel more intuitive?" -- "Want to refine this further, or move to the next improvement?" -- "How does this change affect users of the module?" - - -improvement_implementation - - - -Run comprehensive validation conversationally: - -Don't just check boxes - explain what you're validating and why it matters: - -- "Let me verify the module structure is solid..." -- "Checking that all agent workflow references are valid..." -- "Making sure config.yaml has all necessary fields..." -- "Validating documentation is complete and accurate..." -- "Ensuring cross-module references work correctly..." - - -Load validation checklist: {installed_path}/checklist.md -Check all items from checklist systematically - - - Present issues conversationally: - -Explain what's wrong and implications: - -- "I found {{issue}} which could cause {{problem}} for users" -- "The {{component}} needs {{fix}} because {{reason}}" - -Propose fixes immediately: - -- "I can fix this by {{solution}}. Should I?" -- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?" - - -Fix approved issues and re-validate - - - - Confirm success warmly: - -"Excellent! Everything validates cleanly: - -- Module structure is well-organized -- All agent and workflow references are valid -- Configuration is complete -- Documentation is thorough and current -- Cross-module integrations work properly -- Installer is correct (if applicable) - -Your module is in great shape." - - - -validation_results - - - -Create a conversational summary of what improved: - -Tell the story of the transformation: - -- "We started with {{initial_state}}" -- "You wanted to {{user_goals}}" -- "We made these key improvements: {{changes_list}}" -- "Now your module {{improved_capabilities}}" - -Highlight the impact: - -- "This means users will experience {{benefit}}" -- "The module is now more {{quality}}" -- "It follows best practices for {{patterns}}" - - -Guide next steps based on changes made: - -If structure changed significantly: - -- "Since we reorganized the structure, you should update any external references to this module" - -If agents or workflows were updated: - -- "The updated agents/workflows should be tested with real user interactions" - -If cross-module integration was added: - -- "Test the integration with {{other_module}} to ensure it works smoothly" - -If installer was updated: - -- "Test the installation process to verify all files are included correctly" - -If this is part of larger BMAD work: - -- "Consider if patterns from this module could benefit other modules" - -Be a helpful guide to what comes next, not just a task completer. - - -Would you like to: - -- Test the edited module by invoking one of its agents -- Edit a specific agent or workflow in more detail -- Make additional refinements to the module -- Work on a different module - - -completion_summary - - - diff --git a/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml b/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml deleted file mode 100644 index d66ef667..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml +++ /dev/null @@ -1,34 +0,0 @@ -# Edit Module - Module Editor Configuration -name: "edit-module" -description: "Edit existing BMAD modules (structure, agents, workflows, documentation) while following all best practices" -author: "BMad" - -# Critical variables load from config_source -config_source: "{project-root}/_bmad/bmb/config.yaml" -communication_language: "{config_source}:communication_language" -user_name: "{config_source}:user_name" - -# Required Data Files - Critical for understanding module conventions -module_structure_guide: "{project-root}/_bmad/bmb/workflows/create-module/module-structure.md" - -# Related workflow editors -agent_editor: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.yaml" -workflow_editor: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.yaml" - -# Reference examples - for learning patterns -bmm_module_dir: "{project-root}/_bmad/bmm/" -bmb_module_dir: "{project-root}/_bmad/bmb/" -cis_module_dir: "{project-root}/_bmad/cis/" -existing_agents_dir: "{project-root}/_bmad/*/agents/" -existing_workflows_dir: "{project-root}/_bmad/*/workflows/" - -# Module path and component files -installed_path: "{project-root}/_bmad/bmb/workflows/edit-module" -template: false # This is an action workflow - no template needed -instructions: "{installed_path}/instructions.md" -validation: "{installed_path}/checklist.md" - -standalone: true - -# Web bundle configuration -web_bundle: false # BMB workflows run locally in BMAD-METHOD project diff --git a/src/modules/bmb/workflows-legacy/module-brief/README.md b/src/modules/bmb/workflows-legacy/module-brief/README.md deleted file mode 100644 index ccf6173c..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/README.md +++ /dev/null @@ -1,264 +0,0 @@ -# Module Brief Workflow - -## Overview - -The Module Brief workflow creates comprehensive blueprints for building new BMAD modules using strategic analysis and creative vision. It serves as the essential planning phase that transforms initial ideas into detailed, actionable specifications ready for implementation with the create-module workflow. - -## Key Features - -- **Strategic Module Planning** - Comprehensive analysis from concept to implementation roadmap -- **Multi-Mode Operation** - Interactive, Express, and YOLO modes for different planning needs -- **Creative Vision Development** - Guided process for innovative module concepts and unique value propositions -- **Architecture Design** - Detailed agent and workflow ecosystem planning with interaction models -- **User Journey Mapping** - Scenario-based validation ensuring practical usability -- **Technical Planning** - Infrastructure requirements, dependencies, and complexity assessment -- **Risk Assessment** - Proactive identification of challenges with mitigation strategies -- **Implementation Roadmap** - Phased development plan with clear deliverables and timelines - -## Usage - -### Basic Invocation - -```bash -workflow module-brief -``` - -### With Brainstorming Input - -```bash -# If you have brainstorming results from previous sessions -workflow module-brief --input brainstorming-session-2024-09-26.md -``` - -### Express Mode - -```bash -# For quick essential planning only -workflow module-brief --mode express -``` - -### Configuration - -The workflow uses standard BMB configuration: - -- **output_folder**: Where the module brief will be saved -- **user_name**: Brief author information -- **communication_language**: Language for brief generation -- **date**: Automatic timestamp for versioning - -## Workflow Structure - -### Files Included - -``` -module-brief/ -├── workflow.yaml # Configuration and metadata -├── instructions.md # Step-by-step execution guide -├── template.md # Module brief document structure -├── checklist.md # Validation criteria -└── README.md # This file -``` - -## Workflow Process - -### Phase 1: Foundation and Context (Steps 1-3) - -**Mode Selection and Input Gathering** - -- Choose operational mode (Interactive, Express, YOLO) -- Check for and optionally load existing brainstorming results -- Gather background context and inspiration sources - -**Module Vision Development** - -- Define core problem the module solves -- Identify target user audience and use cases -- Establish unique value proposition and differentiators -- Explore creative themes and personality concepts - -**Module Identity Establishment** - -- Generate module code (kebab-case) with multiple options -- Create compelling, memorable module name -- Select appropriate category (Domain-Specific, Creative, Technical, Business, Personal) -- Define optional personality theme for consistent agent character - -### Phase 2: Architecture Planning (Steps 4-5) - -**Agent Architecture Design** - -- Plan agent team composition and roles -- Define agent archetypes (Orchestrator, Specialist, Helper, Creator, Analyzer) -- Specify personality traits and communication styles -- Map key capabilities and signature commands - -**Workflow Ecosystem Design** - -- Categorize workflows by purpose and complexity: - - **Core Workflows**: Essential value-delivery functions (2-3) - - **Feature Workflows**: Specialized capabilities (3-5) - - **Utility Workflows**: Supporting operations (1-3) -- Define input-process-output flows for each workflow -- Assess complexity levels and implementation priorities - -### Phase 3: Validation and User Experience (Steps 6-7) - -**User Journey Mapping** - -- Create detailed user scenarios and stories -- Map step-by-step usage flows through the module -- Validate end-to-end functionality and value delivery -- Identify potential friction points and optimization opportunities - -**Technical Planning and Requirements** - -- Assess data requirements and storage needs -- Map integration points with other modules and external systems -- Evaluate technical complexity and resource requirements -- Document dependencies and infrastructure needs - -### Phase 4: Success Planning (Steps 8-9) - -**Success Metrics Definition** - -- Establish module success criteria and performance indicators -- Define quality standards and reliability requirements -- Create user experience goals and feedback mechanisms -- Set measurable outcomes for module effectiveness - -**Development Roadmap Creation** - -- Design phased approach with MVP, Enhancement, and Polish phases -- Define deliverables and timelines for each phase -- Prioritize features and capabilities by value and complexity -- Create clear milestones and success checkpoints - -### Phase 5: Enhancement and Risk Management (Steps 10-12) - -**Creative Features and Special Touches** (Optional) - -- Design easter eggs and delightful user interactions -- Plan module lore and thematic consistency -- Add personality quirks and creative responses -- Develop backstories and universe building - -**Risk Assessment and Mitigation** - -- Identify technical, usability, and scope risks -- Develop mitigation strategies for each risk category -- Plan contingency approaches for potential challenges -- Document decision points and alternative paths - -**Final Review and Export Preparation** - -- Comprehensive review of all brief sections -- Validation against quality and completeness criteria -- Preparation for seamless handoff to create-module workflow -- Export readiness confirmation with actionable specifications - -## Output - -### Generated Files - -- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md` -- **Strategic Specifications**: Ready-to-implement blueprint for create-module workflow - -### Output Structure - -The module brief contains detailed specifications across multiple sections: - -1. **Executive Summary** - Vision, category, complexity, target users -2. **Module Identity** - Core concept, value proposition, personality theme -3. **Agent Architecture** - Agent roster, roles, interaction models -4. **Workflow Ecosystem** - Core, feature, and utility workflow specifications -5. **User Scenarios** - Primary use cases, secondary scenarios, user journey -6. **Technical Planning** - Data requirements, integrations, dependencies -7. **Success Metrics** - Success criteria, quality standards, performance targets -8. **Development Roadmap** - Phased implementation plan with deliverables -9. **Creative Features** - Special touches, easter eggs, module lore -10. **Risk Assessment** - Technical, usability, scope risks with mitigation -11. **Implementation Notes** - Priority order, design decisions, open questions -12. **Resources and References** - Inspiration sources, similar modules, technical references - -## Requirements - -- **Creative Vision** - Initial module concept or problem domain -- **Strategic Thinking** - Ability to plan architecture and user experience -- **Brainstorming Results** (optional) - Previous ideation sessions enhance planning quality - -## Best Practices - -### Before Starting - -1. **Gather Inspiration** - Research similar tools, modules, and solutions in your domain -2. **Run Brainstorming Session** - Use ideation techniques to generate initial concepts -3. **Define Success Criteria** - Know what "successful module" means for your context - -### During Execution - -1. **Think User-First** - Always consider the end user experience and value delivery -2. **Be Specific** - Provide concrete examples and detailed specifications rather than abstractions -3. **Validate Early** - Use user scenarios to test if the module concept actually works -4. **Plan Iteratively** - Start with MVP and build complexity through phases - -### After Completion - -1. **Use as Blueprint** - Feed the brief directly into create-module workflow for implementation -2. **Review with Stakeholders** - Validate assumptions and gather feedback before building -3. **Update as Needed** - Treat as living document that evolves with implementation learnings -4. **Reference During Development** - Use as north star for design decisions and scope management - -## Troubleshooting - -### Common Issues - -**Issue**: Stuck on module concept or vision - -- **Solution**: Use creative prompts provided in the workflow -- **Check**: Review existing modules for inspiration and patterns - -**Issue**: Agent or workflow architecture too complex - -- **Solution**: Focus on MVP first, plan enhancement phases for additional complexity -- **Check**: Validate each component against user scenarios - -**Issue**: Technical requirements unclear - -- **Solution**: Research similar modules and their implementation approaches -- **Check**: Consult with technical stakeholders early in planning - -**Issue**: Scope creep during planning - -- **Solution**: Use phased roadmap to defer non-essential features -- **Check**: Regularly validate against core user scenarios and success criteria - -## Customization - -To customize this workflow: - -1. **Modify Template Structure** - Update template.md to add new sections or reorganize content -2. **Extend Creative Prompts** - Add domain-specific ideation techniques in instructions.md -3. **Add Planning Tools** - Integrate additional analysis frameworks or planning methodologies -4. **Customize Validation** - Enhance checklist.md with specific quality criteria for your context - -## Version History - -- **v1.0.0** - Initial release - - Comprehensive strategic module planning - - Multi-mode operation (Interactive, Express, YOLO) - - Creative vision and architecture design tools - - User journey mapping and validation - - Risk assessment and mitigation planning - -## Support - -For issues or questions: - -- Review the workflow creation guide at `/_bmad/bmb/workflows/create-workflow/workflow-creation-guide.md` -- Study existing module examples in `/_bmad/` for patterns and inspiration -- Validate output using `checklist.md` -- Consult module structure guide at `create-module/module-structure.md` - ---- - -_Part of the BMad Method v6 - BMB (Builder) Module_ diff --git a/src/modules/bmb/workflows-legacy/module-brief/checklist.md b/src/modules/bmb/workflows-legacy/module-brief/checklist.md deleted file mode 100644 index 80c23962..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/checklist.md +++ /dev/null @@ -1,116 +0,0 @@ -# Module Brief Validation Checklist - -## Core Identity - -- [ ] Module code follows kebab-case convention -- [ ] Module name is clear and memorable -- [ ] Module category is identified -- [ ] Target users are clearly defined -- [ ] Unique value proposition is articulated - -## Vision and Concept - -- [ ] Problem being solved is clearly stated -- [ ] Solution approach is explained -- [ ] Module scope is well-defined -- [ ] Success criteria are measurable - -## Agent Architecture - -- [ ] At least one agent is defined -- [ ] Each agent has a clear role and purpose -- [ ] Agent personalities are defined (if using personality themes) -- [ ] Agent interactions are mapped (for multi-agent modules) -- [ ] Key commands for each agent are listed - -## Workflow Ecosystem - -- [ ] Core workflows (2-3) are identified -- [ ] Each workflow has clear purpose -- [ ] Workflow complexity is assessed -- [ ] Input/output for workflows is defined -- [ ] Workflow categories are logical - -## User Experience - -- [ ] Primary use case is documented -- [ ] User scenarios demonstrate value -- [ ] User journey is realistic -- [ ] Learning curve is considered -- [ ] User feedback mechanism planned - -## Technical Planning - -- [ ] Data requirements are identified -- [ ] Integration points are mapped -- [ ] Dependencies are listed -- [ ] Technical complexity is assessed -- [ ] Performance requirements stated - -## Development Roadmap - -- [ ] Phase 1 MVP is clearly scoped -- [ ] Phase 2 enhancements are outlined -- [ ] Phase 3 polish items listed -- [ ] Timeline estimates provided -- [ ] Deliverables are specific - -## Risk Management - -- [ ] Technical risks identified -- [ ] Usability risks considered -- [ ] Scope risks acknowledged -- [ ] Mitigation strategies provided -- [ ] Open questions documented - -## Creative Elements (Optional) - -- [ ] Personality theme is consistent (if used) -- [ ] Special features add value -- [ ] Module feels cohesive -- [ ] Fun elements don't compromise functionality - -## Documentation Quality - -- [ ] All sections have content (no empty placeholders) -- [ ] Writing is clear and concise -- [ ] Technical terms are explained -- [ ] Examples are provided where helpful -- [ ] Next steps are actionable - -## Implementation Readiness - -- [ ] Brief provides enough detail for create-module workflow -- [ ] Agent specifications sufficient for create-agent workflow -- [ ] Workflow descriptions ready for create-workflow -- [ ] Resource requirements are clear -- [ ] Success metrics are measurable - -## Final Validation - -- [ ] Module concept is viable -- [ ] Scope is achievable -- [ ] Value is clear -- [ ] Brief is complete -- [ ] Ready for development - -## Issues Found - -### Critical Issues - - - -### Recommendations - - - -### Nice-to-Haves - - - ---- - -**Validation Complete:** ⬜ Yes / ⬜ With Issues / ⬜ Needs Revision - -**Validated By:** {name} -**Date:** {date} diff --git a/src/modules/bmb/workflows-legacy/module-brief/instructions.md b/src/modules/bmb/workflows-legacy/module-brief/instructions.md deleted file mode 100644 index 1693c3c5..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/instructions.md +++ /dev/null @@ -1,268 +0,0 @@ -# Module Brief Instructions - -The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/module-brief/workflow.yaml -Communicate in {communication_language} throughout the module brief creation process -⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. - - - - -Ask the user which mode they prefer: -1. **Interactive Mode** - Work through each section collaboratively with detailed questions -2. **Express Mode** - Quick essential questions only -3. **YOLO Mode** (#yolo) - Generate complete draft based on minimal input - -Check for available inputs: - -- Brainstorming results from previous sessions -- Existing module ideas or notes -- Similar modules for inspiration - -If brainstorming results exist, offer to load and incorporate them - - - -Ask the user to describe their module idea. Probe for: -- What problem does this module solve? -- Who would use this module? -- What makes this module exciting or unique? -- Any inspiring examples or similar tools? - -If they're stuck, offer creative prompts: - -- "Imagine you're a [role], what tools would make your life easier?" -- "What repetitive tasks could be automated with agents?" -- "What domain expertise could be captured in workflows?" - -module_vision - - - -Based on the vision, work with user to define: - -**Module Code** (kebab-case): - -- Suggest 2-3 options based on their description -- Ensure it's memorable and descriptive - -**Module Name** (friendly): - -- Creative, engaging name that captures the essence - -**Module Category:** - -- Domain-Specific (legal, medical, finance) -- Creative (writing, gaming, music) -- Technical (devops, testing, architecture) -- Business (project management, marketing) -- Personal (productivity, learning) - -**Personality Theme** (optional but fun!): - -- Should the module have a consistent personality across agents? -- Star Trek crew? Fantasy party? Corporate team? Reality show cast? - -module_identity - - - -Help user envision their agent team - -For each agent, capture: - -- **Role**: What's their specialty? -- **Personality**: How do they communicate? (reference communication styles) -- **Key Capabilities**: What can they do? -- **Signature Commands**: 2-3 main commands - -Suggest agent archetypes based on module type: - -- The Orchestrator (manages other agents) -- The Specialist (deep expertise) -- The Helper (utility functions) -- The Creator (generates content) -- The Analyzer (processes and evaluates) - -agent_architecture - - - -Map out the workflow landscape - -Categorize workflows: - -**Core Workflows** (2-3 essential ones): - -- The primary value-delivery workflows -- What users will use most often - -**Feature Workflows** (3-5 specialized): - -- Specific capabilities -- Advanced features - -**Utility Workflows** (1-3 supporting): - -- Setup, configuration -- Maintenance, cleanup - -For each workflow, define: - -- Purpose (one sentence) -- Input → Process → Output -- Complexity (simple/standard/complex) - -workflow_ecosystem - - - -Create usage scenarios to validate the design - -Write 2-3 user stories: -"As a [user type], I want to [goal], so that [outcome]" - -Then walk through how they'd use the module: - -1. They load [agent] -2. They run [command/workflow] -3. They get [result] -4. This helps them [achievement] - -This validates the module makes sense end-to-end. - -user_scenarios - - - -Assess technical requirements: - -**Data Requirements:** - -- What data/files does the module need? -- Any external APIs or services? -- Storage or state management needs? - -**Integration Points:** - -- Other BMAD modules it might use -- External tools or platforms -- Import/export formats - -**Complexity Assessment:** - -- Simple (standalone, no dependencies) -- Standard (some integrations, moderate complexity) -- Complex (multiple systems, advanced features) - -technical_planning - - - -Define what success looks like: - -**Module Success Criteria:** - -- What indicates the module is working well? -- How will users measure value? -- What feedback mechanisms? - -**Quality Standards:** - -- Performance expectations -- Reliability requirements -- User experience goals - -success_metrics - - - -Create a phased approach: - -**Phase 1 - MVP (Minimum Viable Module):** - -- 1 primary agent -- 2-3 core workflows -- Basic functionality - -**Phase 2 - Enhancement:** - -- Additional agents -- More workflows -- Refined features - -**Phase 3 - Polish:** - -- Advanced features -- Optimizations -- Nice-to-haves - -development_roadmap - - - -If user wants to add special touches: - -**Easter Eggs:** - -- Hidden commands or responses -- Fun interactions between agents - -**Delighters:** - -- Unexpected helpful features -- Personality quirks -- Creative responses - -**Module Lore:** - -- Backstory for agents -- Thematic elements -- Consistent universe - -creative_features - - - -Identify potential challenges: - -**Technical Risks:** - -- Complex integrations -- Performance concerns -- Dependency issues - -**Usability Risks:** - -- Learning curve -- Complexity creep -- User confusion - -**Scope Risks:** - -- Feature bloat -- Timeline expansion -- Resource constraints - -For each risk, note mitigation strategy. - -risk_assessment - - - -Review all sections with {user_name} -Ensure module brief is ready for create-module workflow - -Would {user_name} like to: - -1. Proceed directly to create-module workflow -2. Save and refine later -3. Generate additional planning documents - - -Inform {user_name} in {communication_language} that this brief can be fed directly into create-module workflow - -final_brief - - - diff --git a/src/modules/bmb/workflows-legacy/module-brief/template.md b/src/modules/bmb/workflows-legacy/module-brief/template.md deleted file mode 100644 index 0738fe02..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/template.md +++ /dev/null @@ -1,275 +0,0 @@ -# Module Brief: {{module_name}} - -**Date:** {{date}} -**Author:** {{user_name}} -**Module Code:** {{module_code}} -**Status:** Ready for Development - ---- - -## Executive Summary - -{{module_vision}} - -**Module Category:** {{module_category}} -**Complexity Level:** {{complexity_level}} -**Target Users:** {{target_users}} - ---- - -## Module Identity - -### Core Concept - -{{module_identity}} - -### Unique Value Proposition - -What makes this module special: -{{unique_value}} - -### Personality Theme - -{{personality_theme}} - ---- - -## Agent Architecture - -{{agent_architecture}} - -### Agent Roster - -{{agent_roster}} - -### Agent Interaction Model - -How agents work together: -{{agent_interactions}} - ---- - -## Workflow Ecosystem - -{{workflow_ecosystem}} - -### Core Workflows - -Essential functionality that delivers primary value: -{{core_workflows}} - -### Feature Workflows - -Specialized capabilities that enhance the module: -{{feature_workflows}} - -### Utility Workflows - -Supporting operations and maintenance: -{{utility_workflows}} - ---- - -## User Scenarios - -### Primary Use Case - -{{primary_scenario}} - -### Secondary Use Cases - -{{secondary_scenarios}} - -### User Journey - -Step-by-step walkthrough of typical usage: -{{user_journey}} - ---- - -## Technical Planning - -### Data Requirements - -{{data_requirements}} - -### Integration Points - -{{integration_points}} - -### Dependencies - -{{dependencies}} - -### Technical Complexity Assessment - -{{technical_planning}} - ---- - -## Success Metrics - -### Module Success Criteria - -How we'll know the module is successful: -{{success_criteria}} - -### Quality Standards - -{{quality_standards}} - -### Performance Targets - -{{performance_targets}} - ---- - -## Development Roadmap - -### Phase 1: MVP (Minimum Viable Module) - -**Timeline:** {{phase1_timeline}} - -{{phase1_components}} - -**Deliverables:** -{{phase1_deliverables}} - -### Phase 2: Enhancement - -**Timeline:** {{phase2_timeline}} - -{{phase2_components}} - -**Deliverables:** -{{phase2_deliverables}} - -### Phase 3: Polish and Optimization - -**Timeline:** {{phase3_timeline}} - -{{phase3_components}} - -**Deliverables:** -{{phase3_deliverables}} - ---- - -## Creative Features - -### Special Touches - -{{creative_features}} - -### Easter Eggs and Delighters - -{{easter_eggs}} - -### Module Lore and Theming - -{{module_lore}} - ---- - -## Risk Assessment - -### Technical Risks - -{{technical_risks}} - -### Usability Risks - -{{usability_risks}} - -### Scope Risks - -{{scope_risks}} - -### Mitigation Strategies - -{{risk_mitigation}} - ---- - -## Implementation Notes - -### Priority Order - -1. {{priority_1}} -2. {{priority_2}} -3. {{priority_3}} - -### Key Design Decisions - -{{design_decisions}} - -### Open Questions - -{{open_questions}} - ---- - -## Resources and References - -### Inspiration Sources - -{{inspiration_sources}} - -### Similar Modules - -{{similar_modules}} - -### Technical References - -{{technical_references}} - ---- - -## Appendices - -### A. Detailed Agent Specifications - -{{detailed_agent_specs}} - -### B. Workflow Detailed Designs - -{{detailed_workflow_specs}} - -### C. Data Structures and Schemas - -{{data_schemas}} - -### D. Integration Specifications - -{{integration_specs}} - ---- - -## Next Steps - -1. **Review this brief** with stakeholders -2. **Run create-module workflow** using this brief as input -3. **Create first agent** using create-agent workflow -4. **Develop initial workflows** using create-workflow -5. **Test MVP** with target users - ---- - -_This Module Brief is ready to be fed directly into the create-module workflow for scaffolding and implementation._ - -**Module Viability Score:** {{viability_score}}/10 -**Estimated Development Effort:** {{effort_estimate}} -**Confidence Level:** {{confidence_level}} - ---- - -**Approval for Development:** - -- [ ] Concept Approved -- [ ] Scope Defined -- [ ] Resources Available -- [ ] Ready to Build - ---- - -_Generated on {{date}} by {{user_name}} using the BMAD Method Module Brief workflow_ diff --git a/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml b/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml deleted file mode 100644 index 772f6801..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# Module Brief Workflow Configuration -name: module-brief -description: "Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision" -author: "BMad Builder" - -# Critical variables -config_source: "{project-root}/_bmad/bmb/config.yaml" -output_folder: "{config_source}:output_folder" -user_name: "{config_source}:user_name" -communication_language: "{config_source}:communication_language" -date: system-generated - -# Reference examples and documentation -existing_modules_dir: "{project-root}/_bmad/" -module_structure_guide: "{project-root}/_bmad/bmb/workflows/create-module/module-structure.md" - -# Optional user inputs - discovered if they exist -input_file_patterns: - brainstorming: - description: "Brainstorming session outputs (optional)" - whole: "{output_folder}/brainstorming-*.md" - load_strategy: "FULL_LOAD" - -# Module path and component files -installed_path: "{project-root}/_bmad/bmb/workflows/module-brief" -template: "{installed_path}/template.md" -instructions: "{installed_path}/instructions.md" -validation: "{installed_path}/checklist.md" - -# Output configuration -default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md" - -standalone: true - -# Web bundle configuration -web_bundle: false # BMB workflows run locally in BMAD-METHOD project diff --git a/src/modules/bmb/workflows/agent/data/critical-actions.md b/src/modules/bmb/workflows/agent/data/critical-actions.md index ddb99eb1..5b8de8e6 100644 --- a/src/modules/bmb/workflows/agent/data/critical-actions.md +++ b/src/modules/bmb/workflows/agent/data/critical-actions.md @@ -31,8 +31,8 @@ critical_actions: **CRITICAL Path Format:** - `{project-root}` = literal text (not replaced) -- Sidecar copied to `_memory/` at build time -- Use `{project-root}/_bmad/_memory/{sidecar-folder}/` format +- Sidecar created next to agent.yaml during BUILD, then copied to `_memory/` during BMAD INSTALLATION +- Use `{project-root}/_bmad/_memory/{sidecar-folder}/` format for RUNTIME paths in agent YAML --- diff --git a/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md b/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md index b442a0e6..936b4022 100644 --- a/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md +++ b/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md @@ -39,7 +39,7 @@ Agents with a sidecar folder for persistent memory, custom workflows, and restri ## CRITICAL: Sidecar Path Format -At build/install, sidecar is copied to `{project-root}/_bmad/_memory/{sidecar-folder}/` +During BMAD INSTALLATION, sidecar folder is copied from the agent location to `{project-root}/_bmad/_memory/{sidecar-folder}/` **ALL agent YAML references MUST use:** diff --git a/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md b/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md index b9ddd416..c0da3974 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md @@ -1,5 +1,5 @@ --- -name: 'step-02-type-metadata' +name: 'step-03-type-metadata' description: 'Determine agent type and define metadata' # File References @@ -27,7 +27,7 @@ Determine the agent's classification (Simple/Expert/Module) and define all manda # MANDATORY EXECUTION RULES ## Universal Rules -- ALWAYS use `{agent-language}` for all conversational text +- ALWAYS use `{communication_language}` for all conversational text - MAINTAIN step boundaries - complete THIS step only - DOCUMENT all decisions to agent plan file - HONOR user's creative control throughout @@ -136,7 +136,7 @@ Read and internalize: - Keep examples accessible for reference ## 2. Purpose Discovery Conversation -Engage user with questions in `{agent-language}`: +Engage user with questions in `{communication_language}`: - "What is the primary function this agent will perform?" - "How complex are the tasks this agent will handle?" - "Will this agent need to manage workflows or other agents?" diff --git a/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md b/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md index 0e45d060..4e88a030 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md @@ -1,5 +1,5 @@ --- -name: 'step-03-persona' +name: 'step-04-persona' description: 'Shape the agent personality through four-field persona system' # File References diff --git a/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md b/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md index 7d4c8c81..78629503 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md @@ -1,5 +1,5 @@ --- -name: 'step-04-commands-menu' +name: 'step-05-commands-menu' description: 'Build capabilities and command structure' # File References diff --git a/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md b/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md index 864b7d54..001d83ad 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md @@ -1,5 +1,5 @@ --- -name: 'step-05-activation' +name: 'step-06-activation' description: 'Plan activation behavior and route to build' # File References @@ -30,7 +30,7 @@ Define activation behavior through critical_actions and route to the appropriate - These are non-negotiable prerequisites 2. **MUST Determine Route Before Activation Discussion** - - Check hasSidecar from plan metadata + - Check `module` and `hasSidecar` from plan metadata - Determine destination build step FIRST - Inform user of routing decision @@ -41,10 +41,12 @@ Define activation behavior through critical_actions and route to the appropriate 4. **MUST Follow Routing Logic Exactly** ```yaml - # Route determination based on hasSidecar and module - hasSidecar: false → step-06-build-simple.md - hasSidecar: true + module: "stand-alone" → step-06-build-expert.md - hasSidecar: true + module: ≠ "stand-alone" → step-06-build-module.md + # Route determination based on module and hasSidecar + # Module agents: any module value other than "stand-alone" + module ≠ "stand-alone" → step-07c-build-module.md + # Stand-alone agents: determined by hasSidecar + module = "stand-alone" + hasSidecar: true → step-07b-build-expert.md + module = "stand-alone" + hasSidecar: false → step-07a-build-simple.md ``` 5. **NEVER Skip Documentation** diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md b/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md index 5957a67e..c76cef4f 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md @@ -1,9 +1,9 @@ --- -name: 'step-06-build-simple' +name: 'step-07a-build-simple' description: 'Generate Simple agent YAML from plan' # File References -nextStepFile: './step-08a-plan-traceability.md' +nextStepFile: './step-08-celebrate.md' agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}.agent.yaml' @@ -143,7 +143,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont ### 6. Route Based on User Choice **If user chooses "one-at-a-time":** -- Proceed to `nextStepFile` (step-07a-plan-traceability.md) +- Proceed to `nextStepFile` (step-08-celebrate.md) - Continue through each validation step sequentially - Allow review between each validation @@ -155,7 +155,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and begin validation. +ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. ## SUCCESS METRICS diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md b/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md index fe8df2e0..a0c16005 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md @@ -3,7 +3,7 @@ name: 'step-06-build-expert' description: 'Generate Expert agent YAML with sidecar from plan' # File References -nextStepFile: './step-08a-plan-traceability.md' +nextStepFile: './step-08-celebrate.md' agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}/' agentYamlOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' @@ -21,12 +21,12 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # STEP GOAL -Assemble the agent plan content into a complete Expert agent YAML file with sidecar folder structure. Expert agents require persistent memory storage for specialized operations, accessed via `{project-root}/_bmad/_memory/{sidecar-folder}/` paths in critical_actions. +Assemble the agent plan content into a complete Expert agent YAML file with sidecar folder structure. Expert agents require persistent memory storage, so the build creates a sidecar folder next to the agent.yaml (which gets installed to `_bmad/_memory/` during BMAD installation). ## MANDATORY EXECUTION RULES -1. **EXPERT AGENT = SIDECAR REQUIRED**: Every Expert agent MUST have a sidecar folder created under `_bmad/_memory/` -2. **CRITICAL_ACTIONS FORMAT**: All critical_actions MUST use `{project-root}/_bmad/_memory/{sidecar-folder}/` for file operations +1. **EXPERT AGENT = SIDECAR REQUIRED**: Every Expert agent MUST have a sidecar folder created next to agent.yaml (build location), which will be installed to `_bmad/_memory/` during BMAD installation +2. **CRITICAL_ACTIONS FORMAT**: All critical_actions MUST use `{project-root}/_bmad/_memory/{sidecar-folder}/` for file operations (runtime path) 3. **TEMPLATE COMPLIANCE**: Follow expert-agent-template.md structure exactly 4. **YAML VALIDATION**: Ensure valid YAML syntax with proper indentation (2-space) 5. **EXISTING CHECK**: If agentYamlOutput exists, ask user before overwriting @@ -55,8 +55,6 @@ Using expertTemplate as structure: ```yaml name: '{agent-name}' description: '{short-description}' -type: 'expert' -version: '1.0.0' author: name: '{author}' @@ -109,19 +107,20 @@ metadata: ### Phase 4: Create Sidecar Structure -1. **Create Sidecar Directory**: - - Path: `{project-root}/_bmad/_memory/{sidecar-folder}/` +1. **Create Sidecar Directory** (NEXT TO agent.yaml): + - Path: `{agentBuildOutput}/{agent-name}-sidecar/` - Use `mkdir -p` to create full path + - Note: This folder gets installed to `_bmad/_memory/` during BMAD installation 2. **Create Starter Files** (if specified in critical_actions): ```bash - touch _bmad/_memory/{sidecar-folder}/{file1}.md - touch _bmad/_memory/{sidecar-folder}/{file2}.md + touch {agentBuildOutput}/{agent-name}-sidecar/{file1}.md + touch {agentBuildOutput}/{agent-name}-sidecar/{file2}.md ``` 3. **Add README to Sidecar**: ```markdown - # {sidecar-folder} Memory + # {sidecar-folder} Sidecar This folder stores persistent memory for the **{agent-name}** Expert agent. @@ -132,8 +131,9 @@ metadata: - {file1}.md: {description} - {file2}.md: {description} - ## Access Pattern - Agent accesses these files via: `{project-root}/_bmad/_memory/{sidecar-folder}/{filename}.md` + ## Runtime Access + After BMAD installation, this folder will be accessible at: + `{project-root}/_bmad/_memory/{sidecar-folder}/{filename}.md` ``` ### Phase 5: Write Agent YAML @@ -171,11 +171,11 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and begin validation. +ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. This step produces TWO artifacts: 1. **Agent YAML**: Complete expert agent definition at `{agentYamlOutput}` -2. **Sidecar Structure**: Folder and files at `{project-root}/_bmad/_memory/{sidecar-folder}/` +2. **Sidecar Structure**: Folder and files at `{agentBuildOutput}/{agent-name}-sidecar/` (build location, installs to `_bmad/_memory/` during BMAD installation) Both must exist before proceeding to validation. @@ -184,7 +184,7 @@ Both must exist before proceeding to validation. ✅ Agent YAML file created at expected location ✅ Valid YAML syntax (no parse errors) ✅ All template fields populated -✅ Sidecar folder created under `_bmad/_memory/` +✅ Sidecar folder created at `{agentBuildOutput}/{agent-name}-sidecar/` (build location) ✅ Sidecar folder contains starter files from critical_actions ✅ critical_actions reference `{project-root}/_bmad/_memory/{sidecar-folder}/` paths ✅ metadata.sidecar-folder populated diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md b/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md index baab0380..eb246b0e 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md @@ -3,7 +3,7 @@ name: 'step-06-build-module' description: 'Generate Module agent YAML from plan' # File References -nextStepFile: './step-08a-plan-traceability.md' +nextStepFile: './step-08-celebrate.md' agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}/' agentYamlOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' @@ -205,7 +205,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont # CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and begin validation. +ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. **THIS STEP IS COMPLETE WHEN:** 1. Module agent YAML file exists at agentYamlOutput path diff --git a/src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md b/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md similarity index 89% rename from src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md rename to src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md index 25541e72..51b898cd 100644 --- a/src/modules/bmb/workflows/agent/steps-c/step-09-celebrate.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md @@ -1,9 +1,9 @@ --- -name: 'step-09-celebrate' +name: 'step-08-celebrate' description: 'Celebrate completion and guide next steps for using the agent' # File References -thisStepFile: ./step-09-celebrate.md +thisStepFile: ./step-08-celebrate.md workflowFile: ../workflow.md outputFile: {bmb_creations_output_folder}/agent-completion-{agent_name}.md @@ -11,9 +11,10 @@ outputFile: {bmb_creations_output_folder}/agent-completion-{agent_name}.md advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' installationDocs: 'https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/modules/bmb-bmad-builder/custom-content-installation.md#standalone-content-agents-workflows-tasks-tools-templates-prompts' +validationWorkflow: '{project-root}/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md' --- -# Step 9: Celebration and Installation Guidance +# Step 8: Celebration and Installation Guidance ## STEP GOAL: @@ -198,25 +199,27 @@ Save this content to `{outputFile}` for reference. ### 7. Present MENU OPTIONS -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [X] Exit Workflow" +Display: "**✅ Agent Build Complete! Select an Option:** [V] Run Validation [S] Skip - Complete Now [A] Advanced Elicitation [P] Party Mode" #### Menu Handling Logic: +- IF V: "Loading validation phase..." → Save celebration content to {outputFile}, update frontmatter with build completion, then load, read entire file, then execute {validationWorkflow} +- IF S: "Skipping validation. Completing workflow..." → Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully - IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu - IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF X: Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) #### EXECUTION RULES: - ALWAYS halt and wait for user input after presenting menu -- ONLY complete workflow when user selects 'X' -- After other menu items execution, return to this menu +- User can choose validation (V), skip to complete (S), or use advanced elicitation (A) or party mode (P) +- After other menu items execution (A/P), return to this menu - User can chat or ask questions - always respond and then end with display again of the menu options ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [X exit option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for installation. +ONLY WHEN [S skip option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for installation. +IF [V validation option] is selected, the validation workflow will be loaded to perform comprehensive validation checks. --- diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md b/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md deleted file mode 100644 index 15c98272..00000000 --- a/src/modules/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -name: 'step-07a-plan-traceability' -description: 'Verify build matches original plan' - -# File References -nextStepFile: './step-08b-metadata-validation.md' -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL -Verify that the built agent YAML file contains all elements specified in the original agent plan. This step ensures plan traceability - confirming that what we planned is what we actually built. - -# MANDATORY EXECUTION RULES -- MUST load both agentPlan and builtYaml files before comparison -- MUST compare ALL planned elements against built implementation -- MUST report specific missing items, not just "something is missing" -- MUST offer fix option before proceeding to next validation -- MUST handle missing files gracefully (report clearly, don't crash) -- MUST respect YOLO mode behavior (part of combined validation report) - -# EXECUTION PROTOCOLS - -## File Loading Protocol -1. Load agentPlan from `{bmb_creations_output_folder}/agent-plan-{agent_name}.md` -2. Load builtYaml from `{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml` -3. If either file is missing, report the specific missing file and stop comparison -4. Use Read tool to access both files with absolute paths - -## Comparison Protocol -Compare the following categories systematically: - -### 1. Metadata Comparison -- Agent name -- Description -- Version -- Author/creator information -- Location/module path -- Language settings (if specified in plan) - -### 2. Persona Field Comparison -For each field in persona section: -- Check presence in built YAML -- Verify field content matches planned intent -- Note any significant deviations (minor wording differences ok) - -### 3. Commands Comparison -- Verify all planned commands are present -- Check command names match -- Verify command descriptions are present -- Confirm critical actions are referenced - -### 4. Critical Actions Comparison -- Verify all planned critical_actions are present -- Check action names match exactly -- Verify action descriptions are present -- Confirm each action has required fields - -### 5. Additional Elements -- Dependencies (if planned) -- Configuration (if planned) -- Installation instructions (if planned) - -## Reporting Protocol -Present findings in clear, structured format: - -``` -PLAN TRACEABILITY REPORT -======================== - -Agent: {agent_name} -Plan File: {path to agent plan} -Build File: {path to built YAML} - -COMPARISON RESULTS: -------------------- - -✅ Metadata: All present / Missing: {list} -✅ Persona Fields: All present / Missing: {list} -✅ Commands: All present / Missing: {list} -✅ Critical Actions: All present / Missing: {list} -✅ Other Elements: All present / Missing: {list} - -OVERALL STATUS: [PASS / FAIL] - -``` - -If ANY elements are missing: -- List each missing element with category -- Provide specific location reference (what was planned) -- Ask if user wants to fix items or continue anyway - -## Menu Protocol - -### 8. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [F] Fix Findings [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF F: Apply auto-fixes to {builtYaml} for identified missing elements, then redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Proceed to next validation step, 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](#8-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 - -If YOLO mode: -- Include this report in combined validation report -- Auto-select [C] Continue if all elements present -- Auto-select [F] Fix if missing critical elements (name, commands) -- Flag non-critical missing items in summary - -# CONTEXT BOUNDARIES -- ONLY compare plan vs build - do NOT evaluate quality or correctness -- Do NOT suggest improvements or changes beyond planned elements -- Do NOT re-open persona/commands discovery - this is verification only -- Fix option should return to step-06-build, not earlier steps -- If plan file is ambiguous, note ambiguity but use reasonable interpretation - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. - -## 1. Load Required Files -```yaml -action: read -target: - - agentPlan - - builtYaml -on_failure: report which file is missing and suggest resolution -``` - -## 2. Perform Structured Comparison -```yaml -action: compare -categories: - - metadata - - persona_fields - - commands - - critical_actions - - other_elements -method: systematic category-by-category check -``` - -## 3. Generate Comparison Report -```yaml -action: report -format: structured pass/fail with specific missing items -output: console display + optional save to validation log -``` - -## 4. Present Menu Options -```yaml -action: menu -options: - - F: Fix missing items - - C: Continue to metadata validation - - V: View detailed comparison (optional) -default: C if pass, F if fail -``` - -## 5. Handle User Choice -- **[F] Fix Findings**: Apply auto-fixes to {builtYaml} for identified missing elements, then re-present menu -- **[C] Continue**: Proceed to step-07b-metadata-validation -- **[A] Advanced Elicitation**: Execute advanced elicitation workflow, then re-present menu -- **[P] Party Mode**: Execute party mode workflow, then re-present menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation complete with any findings addressed], will you then load and read fully `{nextStepFile}` to execute and begin [metadata validation]. - -# SUCCESS/FAILURE METRICS - -## Success Criteria -- All planned elements present in built YAML: **COMPLETE PASS** -- Minor deviations (wording, formatting) but all core elements present: **PASS** -- Missing elements identified and user chooses to continue: **PASS WITH NOTED DEFICIENCIES** - -## Failure Criteria -- Unable to load plan or build file: **BLOCKING FAILURE** -- Critical elements missing (name, commands, or critical_actions): **FAIL** -- Comparison cannot be completed due to file corruption: **BLOCKING FAILURE** - -## Next Step Triggers -- **PASS → step-07b-metadata-validation** -- **PASS WITH DEFICIENCIES → step-07b-metadata-validation** (user choice) -- **FAIL → step-06-build** (with specific fix instructions) -- **BLOCKING FAILURE → STOP** (resolve file access issues first) - -## YOLO Mode Behavior -- Auto-fix missing critical elements by returning to build step -- Log non-critical missing items for review but continue validation -- Include traceability report in final YOLO summary -- Do NOT stop for user confirmation unless plan file is completely missing diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md deleted file mode 100644 index a52fc41b..00000000 --- a/src/modules/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -name: 'step-07b-metadata-validation' -description: 'Validate agent metadata properties' - -# File References -nextStepFile: './step-08c-persona-validation.md' -agentMetadata: ../data/agent-metadata.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL - -Validate that the agent's metadata properties (name, description, version, tags, category, etc.) are properly formatted, complete, and follow BMAD standards. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation checks** - All metadata fields must be verified -- **ALWAYS load both reference documents** - agentMetadata.md AND the builtYaml -- **NEVER modify files without user approval** - Report findings first, await menu selection -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** This is a validation step, not an editing step - -## EXECUTION PROTOCOLS - -### Protocol 1: Load and Compare -1. Read the metadata validation reference from `{agentMetadata}` -2. Read the built agent YAML from `{builtYaml}` -3. Extract the metadata section from the builtYaml -4. Compare actual metadata against validation rules - -### Protocol 2: Validation Checks -Perform these checks systematically: - -1. **Required Fields Existence** - - [ ] name: Present and non-empty - - [ ] description: Present and non-empty - - [ ] category: Present and matches valid category - - [ ] tags: Present as array, not empty - -2. **Format Validation** - - [ ] name: Uses kebab-case, no spaces - - [ ] description: 50-200 characters (unless intentionally brief) - - [ ] tags: Array of lowercase strings with hyphens - - [ ] category: Matches one of the allowed categories - -3. **Content Quality** - - [ ] description: Clear and concise, explains what the agent does - - [ ] tags: Relevant to agent's purpose (3-7 tags recommended) - - [ ] category: Most appropriate classification - -4. **Standards Compliance** - - [ ] No prohibited characters in fields - - [ ] No redundant or conflicting information - - [ ] Consistent formatting with other agents - -### Protocol 3: Report Findings -Organize your report into three sections: - -**PASSING CHECKS** (List what passed) -``` -✓ Required fields present -✓ Name follows kebab-case convention -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Description is brief (45 chars, recommended 50-200) -⚠ Only 2 tags provided, 3-7 recommended -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ Category "custom-type" not in allowed list -``` - -### Protocol 4: Menu System - -#### 5. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [F] Fix Findings [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF F: Apply auto-fixes to {builtYaml} for identified issues, then redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Proceed to next validation step, 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](#5-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 - -## CONTEXT BOUNDARIES - -**IN SCOPE:** -- Metadata section of agent.yaml (name, description, version, tags, category, author, license, etc.) -- Referencing the agentMetadata.md validation rules -- Comparing against BMAD standards - -**OUT OF SCOPE:** -- Persona fields (handled in step-07c) -- Menu items (handled in step-07d) -- System architecture (handled in step-07e) -- Capability implementation (handled in step-07f) - -**DO NOT:** -- Validate persona properties in this step -- Suggest major feature additions -- Question the agent's core purpose -- Modify fields beyond metadata - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation complete with any findings addressed], will you then load and read fully `{nextStepFile}` to execute and begin [persona validation]. - -## SUCCESS METRICS - -✓ **Complete Success:** All checks pass, no failures, warnings are optional -✓ **Partial Success:** Failures fixed via [F] option, warnings acknowledged -✓ **Failure:** Blocking failures remain when user selects [C] - -**CRITICAL:** Never proceed to next step if blocking failures exist and user hasn't acknowledged them. diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08c-persona-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08c-persona-validation.md deleted file mode 100644 index 7b21c4f1..00000000 --- a/src/modules/bmb/workflows/agent/steps-c/step-08c-persona-validation.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -name: 'step-07c-persona-validation' -description: 'Validate persona fields and principles' - -# File References -nextStepFile: './step-08d-menu-validation.md' -personaProperties: ../data/persona-properties.md -principlesCrafting: ../data/principles-crafting.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL - -Validate that the agent's persona (role, tone, expertise, principles, constraints) is well-defined, consistent, and aligned with its purpose. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation checks** - All persona fields must be verified -- **ALWAYS load both reference documents** - personaProperties.md AND principlesCrafting.md -- **NEVER modify files without user approval** - Report findings first, await menu selection -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** This is a validation step, not an editing step - -## EXECUTION PROTOCOLS - -### Protocol 1: Load and Compare -1. Read the persona validation reference from `{personaProperties}` -2. Read the principles crafting guide from `{principlesCrafting}` -3. Read the built agent YAML from `{builtYaml}` -4. Extract the persona section from the builtYaml -5. Compare actual persona against validation rules - -### Protocol 2: Validation Checks -Perform these checks systematically: - -1. **Required Fields Existence** - - [ ] role: Present, clear, and specific - - [ ] tone: Present and appropriate to role - - [ ] expertise: Present and relevant to agent's purpose - - [ ] principles: Present as array, not empty (if applicable) - - [ ] constraints: Present as array, not empty (if applicable) - -2. **Content Quality - Role** - - [ ] Role is specific (not generic like "assistant") - - [ ] Role aligns with agent's purpose and menu items - - [ ] Role is achievable within LLM capabilities - - [ ] Role scope is appropriate (not too broad/narrow) - -3. **Content Quality - Tone** - - [ ] Tone is clearly defined (professional, friendly, authoritative, etc.) - - [ ] Tone matches the role and target users - - [ ] Tone is consistent throughout the definition - - [ ] Tone examples or guidance provided if nuanced - -4. **Content Quality - Expertise** - - [ ] Expertise areas are relevant to role - - [ ] Expertise claims are realistic for LLM - - [ ] Expertise domains are specific (not just "knowledgeable") - - [ ] Expertise supports the menu capabilities - -5. **Content Quality - Principles** - - [ ] Principles are actionable (not vague platitudes) - - [ ] Principles guide behavior and decisions - - [ ] Principles are consistent with role - - [ ] 3-7 principles recommended (not overwhelming) - - [ ] Each principle is clear and specific - -6. **Content Quality - Constraints** - - [ ] Constraints define boundaries clearly - - [ ] Constraints are enforceable (measurable/observable) - - [ ] Constraints prevent undesirable behaviors - - [ ] Constraints don't contradict principles - -7. **Consistency Checks** - - [ ] Role, tone, expertise, principles all align - - [ ] No contradictions between principles and constraints - - [ ] Persona supports the menu items defined - - [ ] Language and terminology consistent - -### Protocol 3: Report Findings -Organize your report into three sections: - -**PASSING CHECKS** (List what passed) -``` -✓ Role is specific and well-defined -✓ Tone clearly articulated and appropriate -✓ Expertise aligns with agent purpose -✓ Principles are actionable and clear -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Only 2 principles provided, 3-7 recommended for richer guidance -⚠ No constraints defined - consider adding boundaries -⚠ Expertise areas are broad, could be more specific -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ Role is generic ("assistant") - needs specificity -✗ Tone undefined - creates inconsistent behavior -✗ Principles are vague ("be helpful" - not actionable) -✗ Contradiction: Principle says "be creative", constraint says "follow strict rules" -``` - -### Protocol 4: Menu System - -#### 5. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [F] Fix Findings [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF F: Apply auto-fixes to {builtYaml} for identified issues, then redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Proceed to next validation step, 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](#5-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 - -## CONTEXT BOUNDARIES - -**IN SCOPE:** -- Persona section of agent.yaml (role, tone, expertise, principles, constraints) -- Referencing personaProperties.md and principlesCrafting.md -- Evaluating persona clarity, specificity, and consistency -- Checking alignment between persona elements - -**OUT OF SCOPE:** -- Metadata fields (handled in step-07b) -- Menu items (handled in step-07d) -- System architecture (handled in step-07e) -- Technical implementation details - -**DO NOT:** -- Validate metadata properties in this step -- Question the agent's core purpose (that's for earlier steps) -- Suggest additional menu items -- Modify fields beyond persona - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation complete with any findings addressed], will you then load and read fully `{nextStepFile}` to execute and begin [menu validation]. - -## SUCCESS METRICS - -✓ **Complete Success:** All checks pass, persona is well-defined and consistent -✓ **Partial Success:** Failures fixed via [F] option, warnings acknowledged -✓ **Failure:** Blocking failures remain when user selects [C] - -**CRITICAL:** A weak or generic persona is a blocking issue that should be fixed before proceeding. diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08d-menu-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08d-menu-validation.md deleted file mode 100644 index 0284cea9..00000000 --- a/src/modules/bmb/workflows/agent/steps-c/step-08d-menu-validation.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -name: 'step-07d-menu-validation' -description: 'Validate menu items and patterns' - -# File References -nextStepFile: './step-08e-structure-validation.md' -agentMenuPatterns: ../data/agent-menu-patterns.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL - -Validate that the agent's menu (commands/tools) follows BMAD patterns, is well-structured, properly documented, and aligns with the agent's persona and purpose. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation checks** - All menu items must be verified -- **ALWAYS load the reference document** - agentMenuPatterns.md -- **NEVER modify files without user approval** - Report findings first, await menu selection -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** This is a validation step, not an editing step - -## EXECUTION PROTOCOLS - -### Protocol 1: Load and Compare -1. Read the menu patterns reference from `{agentMenuPatterns}` -2. Read the built agent YAML from `{builtYaml}` -3. Extract the menu/commands section from the builtYaml -4. Compare actual menu against validation rules - -### Protocol 2: Validation Checks -Perform these checks systematically: - -1. **Menu Structure** - - [ ] Menu section exists and is properly formatted - - [ ] At least one menu item defined (unless intentionally tool-less) - - [ ] Menu items follow proper YAML structure - - [ ] Each item has required fields (name, description, pattern) - -2. **Menu Item Requirements** - For each menu item: - - [ ] name: Present, unique, uses kebab-case - - [ ] description: Clear and concise - - [ ] pattern: Valid regex pattern or tool reference - - [ ] scope: Appropriate scope defined (if applicable) - -3. **Pattern Quality** - - [ ] Patterns are valid and testable - - [ ] Patterns are specific enough to match intended inputs - - [ ] Patterns are not overly restrictive - - [ ] Patterns use appropriate regex syntax - -4. **Description Quality** - - [ ] Each item has clear description - - [ ] Descriptions explain what the item does - - [ ] Descriptions are consistent in style - - [ ] Descriptions help users understand when to use - -5. **Alignment Checks** - - [ ] Menu items align with agent's role/purpose - - [ ] Menu items are supported by agent's expertise - - [ ] Menu items fit within agent's constraints - - [ ] Menu items are appropriate for target users - -6. **Completeness** - - [ ] Core capabilities for this role are covered - - [ ] No obvious missing functionality - - [ ] Menu scope is appropriate (not too sparse/overloaded) - - [ ] Related functionality is grouped logically - -7. **Standards Compliance** - - [ ] No prohibited patterns or commands - - [ ] No security vulnerabilities in patterns - - [ ] No ambiguous or conflicting items - - [ ] Consistent naming conventions - -8. **Menu Link Validation (Agent Type Specific)** - - [ ] Determine agent type: Simple (no sidecar), Expert (hasSidecar: true), or Module agent - - [ ] For Expert agents (hasSidecar: true): - - Menu handlers SHOULD reference external sidecar files (e.g., `./{agent-name}-sidecar/...`) - - OR have inline prompts defined directly in the handler - - [ ] For Module agents (module property is a code like 'bmm', 'bmb', etc.): - - Menu handlers SHOULD reference external module files under the module path - - Exec paths must start with `{project-root}/_bmad/{module}/...` - - Referenced files must exist under the module directory - - [ ] For Simple agents (stand-alone module, no sidecar): - - Menu handlers MUST NOT have external file links - - Menu handlers SHOULD only use relative links within the same file (e.g., `#section-name`) - - OR have inline prompts defined directly in the handler - -### Protocol 3: Report Findings -Organize your report into three sections: - -**PASSING CHECKS** (List what passed) -``` -✓ Menu structure properly formatted -✓ 5 menu items defined, all with required fields -✓ All patterns are valid regex -✓ Menu items align with agent role -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Item "analyze-data" description is vague -⚠ No menu item for [common capability X] -⚠ Pattern for "custom-command" very broad, may over-match -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ Duplicate menu item name: "process" appears twice -✗ Invalid regex pattern: "[unclosed bracket" -✗ Menu item "system-admin" violates security guidelines -✗ No menu items defined for agent type that requires tools -✗ Simple agent has external link in menu handler (should be relative # or inline) -✗ Expert agent with sidecar has no external file links or inline prompts defined -✗ Module agent exec path doesn't start with {project-root}/_bmad/{module}/... -``` - -### Protocol 4: Menu System - -#### 5. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [F] Fix Findings [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF F: Apply auto-fixes to {builtYaml} for identified issues, then redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Proceed to next validation step, 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](#5-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 - -## CONTEXT BOUNDARIES - -**IN SCOPE:** -- Menu/commands section of agent.yaml -- Referencing agentMenuPatterns.md -- Menu structure, patterns, and alignment -- Individual menu item validation - -**OUT OF SCOPE:** -- Metadata fields (handled in step-07b) -- Persona fields (handled in step-07c) -- System architecture (handled in step-07e) -- Workflow/capability implementation (handled in step-07f) - -**DO NOT:** -- Validate metadata or persona in this step -- Suggest entirely new capabilities (that's for earlier steps) -- Question whether menu items are "good enough" qualitatively beyond standards -- Modify fields beyond menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation complete with any findings addressed], will you then load and read fully `{nextStepFile}` to execute and begin [structure validation]. - -## SUCCESS METRICS - -✓ **Complete Success:** All checks pass, menu is well-structured and aligned -✓ **Partial Success:** Failures fixed via [F] option, warnings acknowledged -✓ **Failure:** Blocking failures remain when user selects [C] - -**CRITICAL:** Invalid regex patterns or security vulnerabilities in menu items are blocking issues. diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md deleted file mode 100644 index 94ff4d45..00000000 --- a/src/modules/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -name: 'step-07e-structure-validation' -description: 'Validate YAML structure and completeness' - -# File References -# Routes to 8F if Expert, else to 9 -nextStepFileExpert: './step-08f-sidecar-validation.md' -nextStepFileSimple: './step-09-celebrate.md' -simpleValidation: ../data/simple-agent-validation.md -expertValidation: ../data/expert-agent-validation.md -agentCompilation: ../data/agent-compilation.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL - -Validate the built agent YAML file for structural completeness and correctness against the appropriate validation checklist (simple or expert), then route to sidecar validation if needed or proceed to celebration. - -# MANDATORY EXECUTION RULES - -1. **NEVER skip validation** - All agents must pass structural validation before completion -2. **ALWAYS use the correct validation checklist** based on agent type (simple vs expert) -3. **NEVER auto-fix without user consent** - Report issues and ask for permission -4. **ALWAYS check hasSidecar flag** before determining next step routing -5. **MUST load and parse the actual built YAML** - Not just show it, but validate it -6. **ALWAYS provide clear, actionable feedback** for any validation failures - -# EXECUTION PROTOCOLS - -## Context Awareness - -- User is in the final validation phase -- Agent has been built and written to disk -- This is the "quality gate" before completion -- User expects thorough but fair validation -- Route depends on agent type (expert vs simple) - -## User Expectations - -- Clear validation results with specific issues identified -- Line-number references for YAML problems -- Option to fix issues or continue (if minor) -- Logical routing based on agent type -- Professional, constructive feedback tone - -## Tone and Style - -- Professional and thorough -- Constructive, not pedantic -- Clear prioritization of issues (critical vs optional) -- Encouraging when validation passes -- Actionable when issues are found - -# CONTEXT BOUNDARIES - -## What to Validate - -- YAML syntax and structure -- Required frontmatter fields presence -- Required sections completeness -- Field format correctness -- Path validity (for references) -- Agent type consistency (simple vs expert requirements) - -## What NOT to Validate - -- Artistic choices in descriptions -- Persona writing style -- Command naming creativity -- Feature scope decisions - -## When to Escalate - -- Critical structural errors that break agent loading -- Missing required fields -- YAML syntax errors preventing file parsing -- Path references that don't exist - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. - -## 1. Load Validation Context - -```bash -# Load the appropriate validation checklist based on agent type -if agentType == "expert": - validationFile = expertValidation -else: - validationFile = simpleValidation - -# Load the built agent YAML -builtAgent = read(builtYaml) - -# Load compilation rules for reference -compilationRules = read(agentCompilation) -``` - -**Action:** Present a brief status message: -``` -🔍 LOADING VALIDATION FRAMEWORK - Agent Type: {detected type} - Validation Standard: {simple|expert} - Built File: {builtYaml path} -``` - -## 2. Execute Structural Validation - -Run systematic checks against the validation checklist: - -### A. YAML Syntax Validation -- Parse YAML without errors -- Check indentation consistency -- Validate proper escaping of special characters -- Verify no duplicate keys - -### B. Frontmatter Validation -- All required fields present -- Field values correct type (string, boolean, array) -- No empty required fields -- Proper array formatting - -### C. Section Completeness -- All required sections present (based on agent type) -- Sections not empty unless explicitly optional -- Proper markdown heading hierarchy - -### D. Field-Level Validation -- Path references exist and are valid -- Boolean fields are actual booleans (not strings) -- Array fields properly formatted -- No malformed YAML structures - -### E. Agent Type Specific Checks - -**For Simple Agents:** -- No sidecar requirements -- Basic fields complete -- No advanced configuration - -**For Expert Agents:** -- Sidecar flag set correctly -- Sidecar folder path specified -- All expert fields present -- Advanced features properly configured - -## 3. Generate Validation Report - -Present findings in structured format: - -```markdown -# 🎯 STRUCTURAL VALIDATION REPORT - -## Agent: {agent-name} -Type: {simple|expert} -File: {builtYaml} - ---- - -## ✅ PASSED CHECKS ({count}) -{List of all validations that passed} - -## ⚠️ ISSUES FOUND ({count}) -{If any issues, list each with:} -### Issue #{number}: {type} -**Severity:** [CRITICAL|MODERATE|MINOR] -**Location:** Line {line} or Section {section} -**Problem:** {clear description} -**Impact:** {what this breaks} -**Suggested Fix:** {specific action} - ---- - -## 📊 VALIDATION SUMMARY -**Overall Status:** [PASSED|FAILED|CONDITIONAL] -**Critical Issues:** {count} -**Moderate Issues:** {count} -**Minor Issues:** {count} -**Can Load Safely:** [YES|NO] - ---- - -{If PASSED} -## 🎉 VALIDATION SUCCESSFUL -Your agent YAML is structurally sound and ready for use! -All required fields present and correctly formatted. - -{If ISSUES FOUND} -## 🔧 RECOMMENDED ACTIONS -1. Address critical issues first -2. Review moderate issues -3. Minor issues can be deferred -``` - -## 4. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [F] Fix Findings [P] Party Mode [C] Continue" - -### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF F: Apply auto-fixes to {builtYaml} for identified issues, then redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Proceed to next validation step, update frontmatter, then only then load, read entire file, then execute {nextStepFileExpert} or {nextStepFileSimple} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-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 - -If [F] selected: Work through issues systematically -- Load specific section needing fix -- Present current state -- Apply auto-fixes or guide user through corrections -- Re-validate after each fix -- Confirm resolution and re-present menu - -If [C] selected: -- Warn about implications if issues exist -- Get explicit confirmation if critical issues -- Document acceptance of issues -- Proceed to routing - -## 5. Route to Next Step - -After validation passes or user chooses to continue: - -### Check Agent Type and Route - -```yaml -# Check for sidecar requirement -hasSidecar = checkBuiltYamlForSidecarFlag() - -if hasSidecar == true: - # Expert agent with sidecar - nextStep = nextStepFileExpert - routeMessage = """ - 📦 Expert agent detected with sidecar configuration. - → Proceeding to sidecar validation (Step 7F) - """ -else: - # Simple agent or expert without sidecar - nextStep = nextStepFileSimple - routeMessage = """ - ✅ Simple agent validation complete. - → Proceeding to celebration (Step 8) - """ -``` - -**Action:** Present routing decision and transition: -```markdown -# 🚀 VALIDATION COMPLETE - ROUTING DECISION - -{routeMessage} - -**Next Step:** {nextStep filename} -**Reason:** Agent type {simple|expert} with sidecar={hasSidecar} - -Press [Enter] to continue to {next step description}... -``` - -# CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation complete with any findings addressed], will you then load and read fully `{nextStepFileExpert}` or `{nextStepFileSimple}` to execute and begin [sidecar validation or celebration]. - -**BEFORE proceeding to next step:** - -1. ✅ Validation checklist executed completely -2. ✅ All critical issues resolved or explicitly accepted -3. ✅ User informed of routing decision -4. ✅ Next step file path determined correctly -5. ⚠️ **CRITICAL:** For expert agents, verify hasSidecar is TRUE before routing to 7F -6. ⚠️ **CRITICAL:** For simple agents, verify hasSidecar is FALSE before routing to 8 - -**DO NOT PROCEED IF:** -- YAML has critical syntax errors preventing loading -- User has not acknowledged validation results -- Routing logic is unclear or conflicting - -# SUCCESS METRICS - -## Step Complete When: -- [ ] Validation report generated and presented -- [ ] User has reviewed findings -- [ ] Critical issues resolved or accepted -- [ ] Routing decision communicated and confirmed -- [ ] Next step path verified and ready - -## Quality Indicators: -- Validation thoroughness (all checklist items covered) -- Issue identification clarity and specificity -- User satisfaction with resolution process -- Correct routing logic applied -- Clear transition to next step - -## Failure Modes: -- Skipping validation checks -- Auto-fixing without permission -- Incorrect routing (simple→7F or expert→8 with sidecar) -- Unclear or missing validation report -- Proceeding with critical YAML errors diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md b/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md deleted file mode 100644 index 30ab330c..00000000 --- a/src/modules/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +++ /dev/null @@ -1,464 +0,0 @@ ---- -name: 'step-07f-sidecar-validation' -description: 'Validate sidecar structure and paths' - -# File References -nextStepFile: './step-09-celebrate.md' -criticalActions: ../data/critical-actions.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' -sidecarFolder: '{bmb_creations_output_folder}/{agent-name}/{agent-name}-sidecar/' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- -# STEP GOAL - -Validate the sidecar folder structure and referenced paths for Expert agents to ensure all sidecar files exist, are properly structured, and paths in the main agent YAML correctly reference them. - -# MANDATORY EXECUTION RULES - -1. **ONLY runs for Expert agents** - Simple agents should never reach this step -2. **MUST verify sidecar folder exists** before proceeding -3. **ALWAYS cross-reference YAML paths** with actual files -4. **NEVER create missing sidecar files** - Report issues, don't auto-fix -5. **MUST validate sidecar file structure** for completeness -6. **ALWAYS check critical actions file** if referenced -7. **PROVIDE clear remediation steps** for any missing or malformed files - -# EXECUTION PROTOCOLS - -## Context Awareness - -- User has an Expert agent with sidecar configuration -- Structural validation (7E) already passed -- Sidecar folder should have been created during build -- This is the final validation before celebration -- Missing sidecar components may break agent functionality - -## User Expectations - -- Comprehensive sidecar structure validation -- Clear identification of missing files -- Path reference verification -- Actionable remediation guidance -- Professional but approachable tone - -## Tone and Style - -- Thorough and systematic -- Clear and specific about issues -- Solution-oriented (focus on how to fix) -- Encouraging when sidecar is complete -- Not pedantic about minor formatting issues - -# CONTEXT BOUNDARIES - -## What to Validate - -- Sidecar folder existence and location -- All referenced files exist in sidecar -- Sidecar file structure completeness -- Path references in main YAML accuracy -- Critical actions file if referenced -- File naming conventions -- File content completeness (not empty) - -## What NOT to Validate - -- Content quality of sidecar files -- Artistic choices in sidecar documentation -- Optional sidecar components -- File formatting preferences - -## When to Escalate - -- Sidecar folder completely missing -- Critical files missing (actions, core modules) -- Path references pointing to non-existent files -- Empty sidecar files that should have content - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. - -## 1. Load Sidecar Context - -```bash -# Verify main agent YAML exists -agentYaml = read(builtYaml) - -# Extract sidecar path from YAML or use template default -sidecarPath = extractSidecarPath(agentYaml) or sidecarFolder - -# Check if sidecar folder exists -sidecarExists = directoryExists(sidecarPath) - -# Load critical actions reference if needed -criticalActionsRef = read(criticalActions) -``` - -**Action:** Present discovery status: -```markdown -🔍 SIDECAR VALIDATION INITIALIZED - -Agent: {agent-name} -Type: Expert (requires sidecar) - -Main YAML: {builtYaml} -Sidecar Path: {sidecarPath} - -Status: {✅ Folder Found | ❌ Folder Missing} -``` - -## 2. Validate Sidecar Structure - -### A. Folder Existence Check - -```markdown -## 📁 FOLDER STRUCTURE VALIDATION - -**Sidecar Location:** {sidecarPath} -**Status:** [EXISTS | MISSING | WRONG LOCATION] -``` - -If missing: -```markdown -❌ **CRITICAL ISSUE:** Sidecar folder not found! - -**Expected Location:** {sidecarPath} - -**Possible Causes:** -1. Build process didn't create sidecar -2. Sidecar path misconfigured in agent YAML -3. Folder moved or deleted after build - -**Required Action:** -[ ] Re-run build process with sidecar enabled -[ ] Verify sidecar configuration in agent YAML -[ ] Check folder was created in correct location -``` - -### B. Sidecar File Inventory - -If folder exists, list all files: -```bash -sidecarFiles = listFiles(sidecarPath) -``` - -```markdown -## 📄 SIDECAR FILE INVENTORY - -Found {count} files in sidecar: - -{For each file:} -- {filename} ({size} bytes) -``` - -### C. Cross-Reference Validation - -Extract all sidecar path references from agent YAML: -```yaml -# Common sidecar reference patterns -sidecar: - critical-actions: './{agent-name}-sidecar/critical-actions.md' - modules: - - path: './{agent-name}-sidecar/modules/module-01.md' -``` - -Validate each reference: -```markdown -## 🔗 PATH REFERENCE VALIDATION - -**Checked {count} references from agent YAML:** - -{For each reference:} -**Source:** {field in agent YAML} -**Expected Path:** {referenced path} -**Status:** [✅ Found | ❌ Missing | ⚠️ Wrong Location] -``` - -## 3. Validate Sidecar File Contents - -For each sidecar file found, check: - -### A. File Completeness -```markdown -## 📋 FILE CONTENT VALIDATION - -{For each file:} -### {filename} -**Size:** {bytes} -**Status:** [✅ Complete | ⚠️ Empty | ❌ Too Small] -**Last Modified:** {timestamp} -``` - -### B. Critical Actions File (if present) - -Special validation for critical-actions.md: -```markdown -## 🎯 CRITICAL ACTIONS VALIDATION - -**File:** {sidecarPath}/critical-actions.md -**Status:** [PRESENT | MISSING | EMPTY] - -{If Present:} -**Sections Found:** -{List sections detected} - -**Completeness:** -[ ] Header/metadata present -[ ] Actions defined -[ ] No critical sections missing -``` - -### C. Module Files (if present) - -If sidecar contains modules: -```markdown -## 📚 MODULE VALIDATION - -**Modules Found:** {count} - -{For each module:} -### {module-filename} -**Status:** [✅ Valid | ⚠️ Issues Found] -**Checks:** -[ ] Frontmatter complete -[ ] Content present -[ ] References valid -``` - -## 4. Generate Validation Report - -```markdown -# 🎯 SIDECAR VALIDATION REPORT - -## Agent: {agent-name} -Sidecar Path: {sidecarPath} -Validation Date: {timestamp} - ---- - -## ✅ VALIDATION CHECKS PASSED - -**Folder Structure:** -- [x] Sidecar folder exists -- [x] Located at expected path -- [x] Accessible and readable - -**File Completeness:** -- [x] All referenced files present -- [x] No broken path references -- [x] Files have content (not empty) - -**Content Quality:** -- [x] Critical actions complete -- [x] Module files structured -- [x] No obvious corruption - ---- - -## ⚠️ ISSUES IDENTIFIED ({count}) - -{If issues:} -### Issue #{number}: {issue type} -**Severity:** [CRITICAL|MODERATE|MINOR] -**Component:** {file or folder} -**Problem:** {clear description} -**Impact:** {what this breaks} -**Remediation:** -1. {specific step 1} -2. {specific step 2} -3. {specific step 3} - -{If no issues:} -### 🎉 NO ISSUES FOUND -Your agent's sidecar is complete and properly structured! -All path references are valid and files are in place. - ---- - -## 📊 SUMMARY - -**Overall Status:** [PASSED|FAILED|CONDITIONAL] -**Files Validated:** {count} -**Issues Found:** {count} -**Critical Issues:** {count} -**Sidecar Ready:** [YES|NO] - ---- - -## 5. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [F] Fix Findings [P] Party Mode [C] Continue" - -### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF F: Apply auto-fixes to {builtYaml} or sidecar files for identified issues, then redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Proceed to celebration step, 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](#5-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 - -## 6. Issue Resolution (if [F] selected) - -Work through each issue systematically: - -**For Missing Files:** -```markdown -### 🔧 FIXING: Missing {filename} - -**Required File:** {path} -**Purpose:** {why it's needed} - -**Option 1:** Re-run Build -- Sidecar may not have been created completely -- Return to build step and re-execute - -**Option 2:** Manual Creation -- Create file at: {full path} -- Use template from: {template reference} -- Minimum required content: {specification} - -**Option 3:** Update References -- Remove reference from agent YAML if not truly needed -- Update path if file exists in different location - -Which option? [1/2/3]: -``` - -**For Broken Path References:** -```markdown -### 🔧 FIXING: Invalid Path Reference - -**Reference Location:** {agent YAML field} -**Current Path:** {incorrect path} -**Expected File:** {filename} -**Actual Location:** {where file actually is} - -**Fix Options:** -1. Update path in agent YAML to: {correct path} -2. Move file to expected location: {expected path} -3. Remove reference if file not needed - -Which option? [1/2/3]: -``` - -**For Empty/Malformed Files:** -```markdown -### 🔧 FIXING: {filename} - {Issue} - -**Problem:** {empty/too small/malformed} -**Location:** {full path} - -**Remediation:** -- View current content -- Compare to template/standard -- Add missing sections -- Correct formatting - -Ready to view and fix? [Y/N]: -``` - -After each fix: -- Re-validate the specific component -- Confirm resolution -- Move to next issue -- Final re-validation when all complete - -## 6. Route to Celebration - -When validation passes or user chooses to continue: - -```markdown -# 🚀 SIDECAR VALIDATION COMPLETE - -## Expert Agent: {agent-name} - -✅ **Sidecar Structure:** Validated -✅ **Path References:** All correct -✅ **File Contents:** Complete - ---- - -## 🎯 READY FOR CELEBRATION - -Your Expert agent with sidecar is fully validated and ready! - -**Next Step:** Celebration (Step 8) -**Final Status:** All checks passed - -Press [Enter] to proceed to celebration... -``` - -# CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation complete with any findings addressed], will you then load and read fully `{nextStepFile}` to execute and begin [celebration]. - -**BEFORE proceeding to Step 8:** - -1. ✅ Sidecar folder exists and is accessible -2. ✅ All referenced files present -3. ✅ Path references validated -4. ✅ File contents checked for completeness -5. ✅ User informed of validation status -6. ✅ Issues resolved or explicitly accepted -7. ⚠️ **CRITICAL:** Only Expert agents should reach this step -8. ⚠️ **CRITICAL:** Sidecar must be complete for agent to function - -**DO NOT PROCEED IF:** -- Sidecar folder completely missing -- Critical files absent (actions, core modules) -- User unaware of sidecar issues -- Validation not completed - -# SUCCESS METRICS - -## Step Complete When: -- [ ] Sidecar folder validated -- [ ] All path references checked -- [ ] File contents verified -- [ ] Validation report presented -- [ ] Issues resolved or accepted -- [ ] User ready to proceed - -## Quality Indicators: -- Thoroughness of file inventory -- Accuracy of path reference validation -- Clarity of issue identification -- Actionability of remediation steps -- User confidence in sidecar completeness - -## Failure Modes: -- Missing sidecar folder completely -- Skipping file existence checks -- Not validating path references -- Proceeding with critical files missing -- Unclear validation report -- Not providing remediation guidance - ---- - -## 🎓 NOTE: Expert Agent Sidecars - -Sidecars are what make Expert agents powerful. They enable: -- Modular architecture -- Separation of concerns -- Easier updates and maintenance -- Shared components across agents - -A validated sidecar ensures your Expert agent will: -- Load correctly at runtime -- Find all referenced resources -- Execute critical actions as defined -- Provide the advanced capabilities designed - -Take the time to validate thoroughly - it pays off in agent reliability! diff --git a/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md b/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md index ae4b4227..15444a2c 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md @@ -88,9 +88,8 @@ If a module agent also hasSidecar: true - this means it is a modules expert agen # Basic Metadata - name: {agent-name} - description: {agent-description} -- type: {simple|expert|module} +- module: {stand-alone|bmm|cis|bmgd|custom} - hasSidecar: {true|false} -- version: {version} # Persona - persona: {full persona text} @@ -113,7 +112,7 @@ If a module agent also hasSidecar: true - this means it is a modules expert agen ```markdown ## Agent Analysis: {agent-name} -**Type:** {simple|expert|module} +**Type:** {simple|expert|module} (derived from module + hasSidecar) **Status:** ready-for-edit ### Current Structure: diff --git a/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md b/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md index 71b0b1d9..c731d00c 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md @@ -58,12 +58,13 @@ If user wants to add/modify critical_actions: ### 3. Determine Routing -Check `{editPlan}` metadataEdits.typeConversion.to or current agentType: +Check `{editPlan}` for agent metadata (module and hasSidecar): ```yaml -agentType: simple → route to e-08a-edit-simple.md -agentType: expert → route to e-08b-edit-expert.md -agentType: module → route to e-08c-edit-module.md +# Determine agent type from module + hasSidecar combination +module ≠ "stand-alone" → route to e-08c-edit-module.md +module = "stand-alone" + hasSidecar: true → route to e-08b-edit-expert.md +module = "stand-alone" + hasSidecar: false → route to e-08a-edit-simple.md ``` ### 4. Document to Edit Plan @@ -77,7 +78,7 @@ activationEdits: modifications: [] routing: destinationEdit: {e-08a|e-08b|e-08c} - targetType: {simple|expert|module} + sourceType: {simple|expert|module} # Derived from module + hasSidecar ``` ### 5. Present MENU OPTIONS @@ -88,7 +89,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont - IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu - IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF C: Save to {editPlan}, determine routing based on targetType, then only then load and execute the appropriate type-specific edit step +- IF C: Save to {editPlan}, determine routing based on module + hasSidecar, then only then load and execute the appropriate type-specific edit step - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) #### EXECUTION RULES: @@ -101,9 +102,9 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont This is the **ROUTING HUB** for edit flow. ONLY WHEN [C continue option] is selected and [routing determined], load and execute the appropriate type-specific edit step: -- targetType: simple → e-08a-edit-simple.md -- targetType: expert → e-08b-edit-expert.md -- targetType: module → e-08c-edit-module.md +- module ≠ "stand-alone" → e-08c-edit-module.md (Module agent) +- module = "stand-alone" + hasSidecar: true → e-08b-edit-expert.md (Expert agent) +- module = "stand-alone" + hasSidecar: false → e-08a-edit-simple.md (Simple agent) --- diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md b/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md index c7e66868..6b0ac608 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md @@ -2,7 +2,7 @@ name: 'e-08a-edit-simple' description: 'Apply edits to Simple agent' -nextStepFile: './e-09a-validate-metadata.md' +nextStepFile: './e-09-celebrate.md' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' agentFile: '{original-agent-path}' agentBackup: '{original-agent-path}.backup' @@ -76,9 +76,10 @@ Confirm: "Backup created at: `{agentBackup}`" For each planned edit: -**Type Conversion:** -- Update `type:` field if converting -- Add/remove type-specific fields +**Type Conversion (Simple ← Expert/Module):** +- Converting TO Simple: Remove `metadata.sidecar-folder`, remove all sidecar references +- Set `module: stand-alone` and `hasSidecar: false` +- Remove type-specific fields from source type **Metadata Edits:** - Apply each field change from metadataEdits diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md b/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md index 662a1f2f..2888b16a 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md @@ -2,7 +2,7 @@ name: 'e-08b-edit-expert' description: 'Apply edits to Expert agent' -nextStepFile: './e-09a-validate-metadata.md' +nextStepFile: './e-09-celebrate.md' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' agentFile: '{original-agent-path}' agentBackup: '{original-agent-path}.backup' @@ -72,10 +72,10 @@ ALWAYS backup before editing: ### 4. Apply Edits in Sequence -**Type Conversion to Expert:** -- Update `type: expert` +**Type Conversion TO Expert:** +- Set `module: stand-alone` and `hasSidecar: true` - Add `metadata.sidecar-folder` if not present -- Create sidecar directory: `mkdir -p {project-root}/_bmad/_memory/{sidecar-folder}/` +- Create sidecar directory next to agent.yaml: `{agent-folder}/{agent-name}-sidecar/` **Sidecar Management:** - If changing sidecar-folder: update all critical_actions references diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md b/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md index 25317322..87f1ef48 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md @@ -2,7 +2,7 @@ name: 'e-08c-edit-module' description: 'Apply edits to Module agent' -nextStepFile: './e-09a-validate-metadata.md' +nextStepFile: './e-09-celebrate.md' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' agentFile: '{original-agent-path}' agentBackup: '{original-agent-path}.backup' @@ -72,9 +72,10 @@ ALWAYS backup before editing: ### 4. Apply Edits in Sequence -**Type Conversion to Module:** -- Update `type: module` +**Type Conversion TO Module:** +- Set `module` to module code (e.g., `bmm`, `cis`, `bmgd`, or custom) - Add workflow integration paths +- Optionally set `hasSidecar: true` if complex multi-workflow module **Workflow Path Management:** - Add: `skills: - workflow: {path}` diff --git a/src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md b/src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md similarity index 81% rename from src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md rename to src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md index 0ef0b983..e7e935cd 100644 --- a/src/modules/bmb/workflows/agent/steps-e/e-10-celebrate.md +++ b/src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md @@ -1,14 +1,15 @@ --- -name: 'e-10-celebrate' +name: 'e-09-celebrate' description: 'Celebrate successful agent edit completion' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +validationWorkflow: '{project-root}/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md' --- -# Edit Step 10: Celebration +# Edit Step 9: Celebration ## STEP GOAL: @@ -112,24 +113,26 @@ Append to editPlan: ### 6. Present MENU OPTIONS -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [X] Exit Workflow" +Display: "**✅ Agent Edit Complete! Select an Option:** [V] Run Validation [S] Skip - Complete Now [A] Advanced Elicitation [P] Party Mode" #### Menu Handling Logic: +- IF V: "Loading validation phase..." → Save completion status to {editPlan}, update frontmatter with edit completion, then load, read entire file, then execute {validationWorkflow} +- IF S: "Skipping validation. Completing workflow..." → Save completion status to {editPlan} and end workflow gracefully - IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu - IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF X: Save completion status to {editPlan} and end workflow gracefully - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) #### EXECUTION RULES: - ALWAYS halt and wait for user input after presenting menu -- ONLY complete workflow when user selects 'X' -- After other menu items execution, return to this menu +- User can choose validation (V), skip to complete (S), or use advanced elicitation (A) or party mode (P) +- After other menu items execution (A/P), return to this menu ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [X exit option] is selected and [completion documented], will the workflow end gracefully with agent edit complete. +ONLY WHEN [S skip option] is selected and [completion documented], will the workflow end gracefully with agent edit complete. +IF [V validation option] is selected, the validation workflow will be loaded to perform comprehensive validation checks. --- diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md b/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md deleted file mode 100644 index bf7bd6eb..00000000 --- a/src/modules/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -name: 'e-09a-validate-metadata' -description: 'Validate metadata (after edit) - no menu, auto-advance' - -nextStepFile: './e-09b-validate-persona.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentMetadata: ../data/agent-metadata.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Edit Step 9a: Validate Metadata (After Edit) - -## STEP GOAL - -Validate that the agent's metadata properties (id, name, title, icon, module, hasSidecar, etc.) are properly formatted, complete, and follow BMAD standards as defined in agentMetadata.md. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation checks** - All metadata fields must be verified -- **ALWAYS load both reference documents** - agentMetadata.md AND the builtYaml -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** Load and validate EVERYTHING specified in the agentMetadata.md file -- **🚫 NO MENU in this step** - record findings and auto-advance -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. -1. Read the metadata validation reference from `{agentMetadata}` -2. Read the built agent YAML from `{builtYaml}` -3. Read the edit plan from `{editPlan}` -4. Extract the metadata section from the builtYaml -5. Compare actual metadata against ALL validation rules in agentMetadata.md - -### Protocol 2: Validation Checks - -Perform these checks systematically - validate EVERY rule specified in agentMetadata.md: - -1. **Required Fields Existence** - - [ ] id: Present and non-empty - - [ ] name: Present and non-empty (display name) - - [ ] title: Present and non-empty - - [ ] icon: Present (emoji or symbol) - - [ ] module: Present and valid format - - [ ] hasSidecar: Present (boolean, if applicable) - -2. **Format Validation** - - [ ] id: Uses kebab-case, no spaces, unique identifier - - [ ] name: Clear display name for UI - - [ ] title: Concise functional description - - [ ] icon: Appropriate emoji or unicode symbol - - [ ] module: Either a 3-4 letter module code (e.g., 'bmm', 'bmb') OR 'stand-alone' - - [ ] hasSidecar: Boolean value, matches actual agent structure - -3. **Content Quality** - - [ ] id: Unique and descriptive - - [ ] name: Clear and user-friendly - - [ ] title: Accurately describes agent's function - - [ ] icon: Visually representative of agent's purpose - - [ ] module: Correctly identifies module membership - - [ ] hasSidecar: Correctly indicates if agent uses sidecar files - -4. **Agent Type Consistency** - - [ ] If hasSidecar: true, sidecar folder path must be specified - - [ ] If module is a module code, agent is a module agent - - [ ] If module is 'stand-alone', agent is not part of a module - - [ ] No conflicting type indicators - -5. **Standards Compliance** - - [ ] No prohibited characters in fields - - [ ] No redundant or conflicting information - - [ ] Consistent formatting with other agents - - [ ] All required BMAD metadata fields present - -### Protocol 3: Record Findings - -Organize findings into three sections and append to editPlan frontmatter under `validationAfter.metadata`: - -```yaml -validationAfter: - metadata: - status: [pass|fail|warning] - passing: - - "{check description}" - - "{check description}" - warnings: - - "{non-blocking issue}" - failures: - - "{blocking issue that must be fixed}" -``` - -**PASSING CHECKS** (List what passed) -``` -✓ All required fields present -✓ id follows kebab-case convention -✓ module value is valid -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Description is brief -⚠ Only 2 tags provided, 3-7 recommended -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ id field is empty -✗ module value is invalid -✗ hasSidecar is true but no sidecar-folder specified -``` - -### Protocol 4: Auto-Advance - -**🚫 NO MENU PRESENTED** - After recording findings, immediately load and execute `{nextStepFile}` - ---- - -**Auto-advancing to persona validation...** - -## SUCCESS METRICS - -✅ All metadata checks from agentMetadata.md performed -✅ All checks validated against the actual builtYaml -✅ Findings saved to editPlan with detailed status -✅ Auto-advanced to next step diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md b/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md deleted file mode 100644 index 531f434a..00000000 --- a/src/modules/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -name: 'e-09b-validate-persona' -description: 'Validate persona (after edit) - no menu, auto-advance' - -nextStepFile: './e-09c-validate-menu.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -personaProperties: ../data/persona-properties.md -principlesCrafting: ../data/principles-crafting.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Edit Step 9b: Validate Persona (After Edit) - -## STEP GOAL - -Validate that the agent's persona (role, identity, communication_style, principles) is well-defined, consistent, and aligned with its purpose as defined in personaProperties.md and principlesCrafting.md. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation checks** - All persona fields must be verified -- **ALWAYS load both reference documents** - personaProperties.md AND principlesCrafting.md -- **ALWAYS load the builtYaml** for actual persona content validation -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** Load and validate EVERYTHING specified in the personaProperties.md file -- **🚫 NO MENU in this step** - record findings and auto-advance -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. -1. Read the persona validation reference from `{personaProperties}` -2. Read the principles crafting guide from `{principlesCrafting}` -3. Read the built agent YAML from `{builtYaml}` -4. Read the edit plan from `{editPlan}` -5. Extract the persona section from the builtYaml -6. Compare actual persona against ALL validation rules - -### Protocol 2: Validation Checks - -Perform these checks systematically - validate EVERY rule specified in personaProperties.md: - -1. **Required Fields Existence** - - [ ] role: Present, clear, and specific - - [ ] identity: Present and defines who the agent is - - [ ] communication_style: Present and appropriate to role - - [ ] principles: Present as array, not empty (if applicable) - -2. **Content Quality - Role** - - [ ] Role is specific (not generic like "assistant") - - [ ] Role aligns with agent's purpose and menu items - - [ ] Role is achievable within LLM capabilities - - [ ] Role scope is appropriate (not too broad/narrow) - -3. **Content Quality - Identity** - - [ ] Identity clearly defines the agent's character - - [ ] Identity is consistent with the role - - [ ] Identity provides context for behavior - - [ ] Identity is not generic or cliché - -4. **Content Quality - Communication Style** - - [ ] Communication style is clearly defined - - [ ] Style matches the role and target users - - [ ] Style is consistent throughout the definition - - [ ] Style examples or guidance provided if nuanced - - [ ] Style focuses on speech patterns only (not behavior) - -5. **Content Quality - Principles** - - [ ] Principles are actionable (not vague platitudes) - - [ ] Principles guide behavior and decisions - - [ ] Principles are consistent with role - - [ ] 3-7 principles recommended (not overwhelming) - - [ ] Each principle is clear and specific - - [ ] First principle activates expert knowledge domain - -6. **Consistency Checks** - - [ ] Role, identity, communication_style, principles all align - - [ ] No contradictions between principles - - [ ] Persona supports the menu items defined - - [ ] Language and terminology consistent - -### Protocol 3: Record Findings - -Organize findings into three sections and append to editPlan frontmatter under `validationAfter.persona`: - -```yaml -validationAfter: - persona: - status: [pass|fail|warning] - passing: - - "{check description}" - - "{check description}" - warnings: - - "{non-blocking issue}" - failures: - - "{blocking issue that must be fixed}" -``` - -**PASSING CHECKS** (List what passed) -``` -✓ Role is specific and well-defined -✓ Identity clearly articulated and appropriate -✓ Communication style clearly defined -✓ Principles are actionable and clear -✓ First principle activates expert knowledge -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Only 2 principles provided, 3-7 recommended for richer guidance -⚠ Communication style could be more specific -⚠ Expertise areas are broad, could be more specific -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ Role is generic ("assistant") - needs specificity -✗ Communication style undefined - creates inconsistent behavior -✗ Principles are vague ("be helpful" - not actionable) -✗ First principle doesn't activate expert knowledge -``` - -### Protocol 4: Auto-Advance - -**🚫 NO MENU PRESENTED** - After recording findings, immediately load and execute `{nextStepFile}` - ---- - -**Auto-advancing to menu validation...** - -## SUCCESS METRICS - -✅ All persona checks from personaProperties.md performed -✅ All checks validated against the actual builtYaml -✅ Findings saved to editPlan with detailed status -✅ Auto-advanced to next step diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md b/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md deleted file mode 100644 index f46863b1..00000000 --- a/src/modules/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -name: 'e-09c-validate-menu' -description: 'Validate menu structure (after edit) - no menu, auto-advance' - -nextStepFile: './e-09d-validate-structure.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentMenuPatterns: ../data/agent-menu-patterns.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Edit Step 9c: Validate Menu (After Edit) - -## STEP GOAL - -Validate that the agent's menu (commands/tools) follows BMAD patterns as defined in agentMenuPatterns.md, is well-structured, properly documented, and aligns with the agent's persona and purpose. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation checks** - All menu items must be verified -- **ALWAYS load the reference document** - agentMenuPatterns.md -- **ALWAYS load the builtYaml** for actual menu content validation -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** Load and validate EVERYTHING specified in the agentMenuPatterns.md file -- **🚫 NO MENU in this step** - record findings and auto-advance -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. -1. Read the menu patterns reference from `{agentMenuPatterns}` -2. Read the built agent YAML from `{builtYaml}` -3. Read the edit plan from `{editPlan}` -4. Extract the menu/commands section from the builtYaml -5. Determine agent type (Simple, Expert, or Module) from metadata -6. Compare actual menu against ALL validation rules - -### Protocol 2: Validation Checks - -Perform these checks systematically - validate EVERY rule specified in agentMenuPatterns.md: - -1. **Menu Structure** - - [ ] Menu section exists and is properly formatted - - [ ] At least one menu item defined (unless intentionally tool-less) - - [ ] Menu items follow proper YAML structure - - [ ] Each item has required fields (name, description, pattern) - -2. **Menu Item Requirements** - For each menu item: - - [ ] name: Present, unique, uses kebab-case - - [ ] description: Clear and concise - - [ ] pattern: Valid regex pattern or tool reference - - [ ] scope: Appropriate scope defined (if applicable) - -3. **Pattern Quality** - - [ ] Patterns are valid and testable - - [ ] Patterns are specific enough to match intended inputs - - [ ] Patterns are not overly restrictive - - [ ] Patterns use appropriate regex syntax - -4. **Description Quality** - - [ ] Each item has clear description - - [ ] Descriptions explain what the item does - - [ ] Descriptions are consistent in style - - [ ] Descriptions help users understand when to use - -5. **Alignment Checks** - - [ ] Menu items align with agent's role/purpose - - [ ] Menu items are supported by agent's expertise - - [ ] Menu items fit within agent's constraints - - [ ] Menu items are appropriate for target users - -6. **Completeness** - - [ ] Core capabilities for this role are covered - - [ ] No obvious missing functionality - - [ ] Menu scope is appropriate (not too sparse/overloaded) - - [ ] Related functionality is grouped logically - -7. **Standards Compliance** - - [ ] No prohibited patterns or commands - - [ ] No security vulnerabilities in patterns - - [ ] No ambiguous or conflicting items - - [ ] Consistent naming conventions - -8. **Menu Link Validation (Agent Type Specific)** - - [ ] Determine agent type from metadata: - - Simple: module property is 'stand-alone' AND hasSidecar is false/absent - - Expert: hasSidecar is true - - Module: module property is a module code (e.g., 'bmm', 'bmb', 'bmgd', 'bmad') - - [ ] For Expert agents (hasSidecar: true): - - Menu handlers SHOULD reference external sidecar files (e.g., `./{agent-name}-sidecar/...`) - - OR have inline prompts defined directly in the handler - - [ ] For Module agents (module property is a module code): - - Menu handlers SHOULD reference external module files under the module path - - Exec paths must start with `{project-root}/_bmad/{module}/...` - - Verify referenced files exist under the module directory - - [ ] For Simple agents (stand-alone, no sidecar): - - Menu handlers MUST NOT have external file links - - Menu handlers SHOULD only use relative links within the same file (e.g., `#section-name`) - - OR have inline prompts defined directly in the handler - -### Protocol 3: Record Findings - -Organize findings into three sections and append to editPlan frontmatter under `validationAfter.menu`: - -```yaml -validationAfter: - menu: - status: [pass|fail|warning] - passing: - - "{check description}" - - "{check description}" - warnings: - - "{non-blocking issue}" - failures: - - "{blocking issue that must be fixed}" -``` - -**PASSING CHECKS** (List what passed) -``` -✓ Menu structure properly formatted -✓ 5 menu items defined, all with required fields -✓ All patterns are valid regex -✓ Menu items align with agent role -✓ Agent type appropriate menu links verified -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Item "analyze-data" description is vague -⚠ No menu item for [common capability X] -⚠ Pattern for "custom-command" very broad, may over-match -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ Duplicate menu item name: "process" appears twice -✗ Invalid regex pattern: "[unclosed bracket" -✗ Menu item "system-admin" violates security guidelines -✗ No menu items defined for agent type that requires tools -✗ Simple agent has external link in menu handler (should be relative # or inline) -✗ Expert agent with sidecar has no external file links or inline prompts defined -✗ Module agent exec path doesn't start with {project-root}/_bmad/{module}/... -✗ Module agent references file that doesn't exist in module directory -``` - -### Protocol 4: Auto-Advance - -**🚫 NO MENU PRESENTED** - After recording findings, immediately load and execute `{nextStepFile}` - ---- - -**Auto-advancing to structure validation...** - -## SUCCESS METRICS - -✅ All menu checks from agentMenuPatterns.md performed -✅ All checks validated against the actual builtYaml -✅ Agent type-specific link validation performed -✅ Findings saved to editPlan with detailed status -✅ Auto-advanced to next step diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md b/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md deleted file mode 100644 index bdb7757e..00000000 --- a/src/modules/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -name: 'e-09d-validate-structure' -description: 'Validate YAML structure (after edit) - no menu, auto-advance' - -nextStepFile: './e-09e-validate-sidecar.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -simpleValidation: ../data/simple-agent-validation.md -expertValidation: ../data/expert-agent-validation.md -agentCompilation: ../data/agent-compilation.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' - -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Edit Step 9d: Validate Structure (After Edit) - -## STEP GOAL - -Validate the built agent YAML file for structural completeness and correctness against the appropriate validation checklist (simple or expert) from agentCompilation.md. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES - -- **NEVER skip validation** - All agents must pass structural validation -- **ALWAYS use the correct validation checklist** based on agent type (simple vs expert) -- **ALWAYS load the builtYaml** for actual structure validation -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** Load and validate EVERYTHING specified in the agentCompilation.md file -- **MUST check hasSidecar flag** to determine correct validation standard -- **🚫 NO MENU in this step** - record findings and auto-advance -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. -1. Read the agent compilation reference from `{agentCompilation}` -2. Read the simple validation checklist from `{simpleValidation}` -3. Read the expert validation checklist from `{expertValidation}` -4. Read the built agent YAML from `{builtYaml}` -5. Read the edit plan from `{editPlan}` -6. Determine agent type (simple vs expert) to select correct checklist - -### Protocol 2: Validation Checks - -Perform these checks systematically - validate EVERY rule specified in agentCompilation.md: - -#### A. YAML Syntax Validation -- [ ] Parse YAML without errors -- [ ] Check indentation consistency (2-space standard) -- [ ] Validate proper escaping of special characters -- [ ] Verify no duplicate keys in any section - -#### B. Frontmatter Validation -- [ ] All required fields present (name, description, version, etc.) -- [ ] Field values are correct type (string, boolean, array) -- [ ] No empty required fields -- [ ] Proper array formatting with dashes -- [ ] Boolean fields are actual booleans (not strings) - -#### C. Section Completeness -- [ ] All required sections present based on agent type -- [ ] Sections not empty unless explicitly optional -- [ ] Proper markdown heading hierarchy (##, ###) -- [ ] No orphaned content without section headers - -#### D. Field-Level Validation -- [ ] Path references exist and are valid -- [ ] Array fields properly formatted -- [ ] No malformed YAML structures -- [ ] File references use correct path format - -#### E. Agent Type Specific Checks - -**For Simple Agents (hasSidecar is false/absent, module is 'stand-alone'):** -- [ ] No sidecar requirements -- [ ] No sidecar-folder path in metadata -- [ ] Basic fields complete -- [ ] No expert-only configuration present -- [ ] Menu handlers use only internal references (#) or inline prompts - -**For Expert Agents (hasSidecar is true):** -- [ ] Sidecar flag set correctly in metadata -- [ ] Sidecar folder path specified in metadata -- [ ] All expert fields present -- [ ] Advanced features properly configured -- [ ] Menu handlers reference sidecar files or have inline prompts - -**For Module Agents (module is a module code like 'bmm', 'bmb', etc.):** -- [ ] Module property is valid module code -- [ ] Exec paths for menu handlers start with `{project-root}/_bmad/{module}/...` -- [ ] Referenced files exist under the module directory -- [ ] If also hasSidecar: true, sidecar configuration is valid - -### Protocol 3: Record Findings - -Organize findings into three sections and append to editPlan frontmatter under `validationAfter.structure`: - -```yaml -validationAfter: - structure: - agentType: [simple|expert|module] - status: [pass|fail|warning] - passing: - - "{check description}" - - "{check description}" - warnings: - - "{non-blocking issue}" - failures: - - "{blocking issue that must be fixed}" -``` - -**PASSING CHECKS** (List what passed) -``` -✓ Valid YAML syntax, no parse errors -✓ All required frontmatter fields present -✓ Proper 2-space indentation throughout -✓ All required sections complete for agent type -✓ Path references are valid -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Some optional sections are empty -⚠ Minor formatting inconsistencies -⚠ Some descriptions are brief -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ YAML syntax error preventing parsing -✗ Duplicate key 'name' in metadata -✗ Required field 'description' is empty -✗ Invalid boolean value 'yes' (should be true/false) -✗ Path reference points to non-existent file -✗ Simple agent has sidecar-folder specified -✗ Expert agent missing sidecar-folder path -``` - -### Protocol 4: Auto-Advance - -**🚫 NO MENU PRESENTED** - After recording findings, immediately load and execute `{nextStepFile}` - ---- - -**Auto-advancing to sidecar validation...** - -## SUCCESS METRICS - -✅ All structure checks from agentCompilation.md performed -✅ Correct validation checklist used based on agent type -✅ All checks validated against the actual builtYaml -✅ Findings saved to editPlan with detailed status -✅ Agent type correctly identified and validated -✅ Auto-advanced to next step diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md b/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md deleted file mode 100644 index 37c015bf..00000000 --- a/src/modules/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -name: 'e-09e-validate-sidecar' -description: 'Validate sidecar structure (after edit) - no menu, auto-advance' - -nextStepFile: './e-09f-validation-summary.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -expertValidation: ../data/expert-agent-validation.md -criticalActions: ../data/critical-actions.md -builtYaml: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' -sidecarFolder: '{bmb_creations_output_folder}/{agent-name}/{agent-name}-sidecar/' - -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Edit Step 9e: Validate Sidecar (After Edit) - -## STEP GOAL - -Validate the sidecar folder structure and referenced paths for Expert agents to ensure all sidecar files exist, are properly structured, and paths in the main agent YAML correctly reference them. Record findings to editPlan and auto-advance. For Simple agents without sidecar, mark as N/A. - -## MANDATORY EXECUTION RULES - -- **ONLY validates for Expert agents** - Simple agents should have no sidecar -- **MUST verify sidecar folder exists** before validating contents -- **ALWAYS cross-reference YAML paths** with actual files -- **ALWAYS load the builtYaml** to get sidecar configuration -- **ALWAYS use absolute paths** when referencing files -- **CRITICAL:** Load and validate EVERYTHING specified in the expertValidation.md file -- **PROVIDE clear remediation steps** for any missing or malformed files -- **🚫 NO MENU in this step** - record findings and auto-advance -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. -1. Read the expert validation reference from `{expertValidation}` -2. Read the critical actions reference from `{criticalActions}` -3. Read the built agent YAML from `{builtYaml}` -4. Read the edit plan from `{editPlan}` -5. Determine if agent has sidecar from metadata - -### Protocol 2: Conditional Validation - -**IF agent has hasSidecar: false OR agent is Simple:** -- [ ] Mark sidecar validation as N/A -- [ ] Confirm no sidecar-folder path in metadata -- [ ] Confirm no sidecar references in menu handlers - -**IF agent has hasSidecar: true OR agent is Expert/Module with sidecar:** -- [ ] Proceed with full sidecar validation - -### Protocol 3: Sidecar Validation Checks (For Expert Agents) - -Perform these checks systematically - validate EVERY rule specified in expertValidation.md: - -#### A. Sidecar Folder Validation -- [ ] Sidecar folder exists at specified path -- [ ] Sidecar folder is accessible and readable -- [ ] Sidecar folder path in metadata matches actual location -- [ ] Folder naming follows convention: `{agent-name}-sidecar` - -#### B. Sidecar File Inventory -- [ ] List all files in sidecar folder -- [ ] Verify expected files are present -- [ ] Check for unexpected files -- [ ] Validate file names follow conventions - -#### C. Path Reference Validation -For each sidecar path reference in agent YAML: -- [ ] Extract path from YAML reference -- [ ] Verify file exists at referenced path -- [ ] Check path format is correct (relative/absolute as expected) -- [ ] Validate no broken path references - -#### D. Critical Actions File Validation (if present) -- [ ] critical-actions.md file exists -- [ ] File has proper frontmatter -- [ ] Actions section is present and not empty -- [ ] No critical sections missing -- [ ] File content is complete (not just placeholder) - -#### E. Module Files Validation (if present) -- [ ] Module files exist at referenced paths -- [ ] Each module file has proper frontmatter -- [ ] Module file content is complete -- [ ] No empty or placeholder module files - -#### F. Sidecar Structure Completeness -- [ ] All referenced sidecar files present -- [ ] No orphaned references (files referenced but not present) -- [ ] No unreferenced files (files present but not referenced) -- [ ] File structure matches expert agent requirements - -### Protocol 4: Record Findings - -Organize findings into three sections and append to editPlan frontmatter under `validationAfter.sidecar`: - -```yaml -validationAfter: - sidecar: - hasSidecar: [true|false] - status: [pass|fail|warning|n/a] - passing: - - "{check description}" - - "{check description}" - warnings: - - "{non-blocking issue}" - failures: - - "{blocking issue that must be fixed}" -``` - -**PASSING CHECKS** (List what passed - for Expert agents)** -``` -✓ Sidecar folder exists at expected path -✓ All referenced files present -✓ No broken path references -✓ Critical actions file complete -✓ Module files properly structured -✓ File structure matches expert requirements -``` - -**WARNINGS** (Non-blocking issues) -``` -⚠ Additional files in sidecar not referenced -⚠ Some module files are minimal -⚠ Sidecar has no modules (may be intentional) -``` - -**FAILURES** (Blocking issues that must be fixed) -``` -✗ Sidecar folder completely missing -✗ Sidecar folder path in metadata doesn't match actual location -✗ Critical file missing: critical-actions.md -✗ Broken path reference: {path} not found -✗ Referenced file is empty or placeholder -✗ Module file missing frontmatter -✗ Simple agent has sidecar configuration (should not) -``` - -**N/A FOR SIMPLE AGENTS:** -``` -N/A - Agent is Simple type (hasSidecar: false, no sidecar required) -``` - -### Protocol 5: Auto-Advance - -**🚫 NO MENU PRESENTED** - After recording findings, immediately load and execute `{nextStepFile}` - ---- - -**Auto-advancing to validation summary...** - -## SUCCESS METRICS - -✅ All sidecar checks from expertValidation.md performed (or N/A for Simple) -✅ All checks validated against the actual builtYaml and file system -✅ Findings saved to editPlan with detailed status -✅ Agent type correctly identified (sidecar vs non-sidecar) -✅ Auto-advanced to next step diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md b/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md deleted file mode 100644 index 223040b7..00000000 --- a/src/modules/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -name: 'e-09f-validation-summary' -description: 'Display all validation findings after edit' - -nextStepFile: './e-10-celebrate.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' - -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Edit Step 9f: Validation Summary (After Edit) - -## STEP GOAL: - -Display all post-edit validation findings and compare with pre-edit state. Present findings and await confirmation to proceed to celebration. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan to collect all validation findings -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Step-Specific Rules: - -- 🎯 Display all validation findings clearly organized -- 📊 Compare before/after states -- 💬 Present options for handling any remaining issues - -## EXECUTION PROTOCOLS: - -- 🎯 Read editPlan to get validation findings -- 📊 Display organized summary with before/after comparison -- 💾 Allow user to decide how to proceed - -## MANDATORY SEQUENCE - -**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. - -### 1. Load Validation Findings - -Read `{editPlan}` frontmatter to collect validationBefore and validationAfter findings. - -### 2. Display Validation Summary - -```markdown -## Post-Edit Validation Report for {agent-name} - -### Before vs After Comparison - -| Component | Before | After | Status | -|-----------|--------|-------|--------| -| Metadata | {status} | {status} | {Δ} | -| Persona | {status} | {status} | {Δ} | -| Menu | {status} | {status} | {Δ} | -| Structure | {status} | {status} | {Δ} | -| Sidecar | {status} | {status} | {Δ} | - -### Detailed Findings (After Edit) - -**Metadata:** {summary} -**Persona:** {summary} -**Menu:** {summary} -**Structure:** {summary} -**Sidecar:** {summary} -``` - -### 3. Present Options - -"How do the edits look? - -**[R]eview** - Show detailed before/after for any component -**[F]ix** - Address any remaining issues -**[A]ccept** - Proceed to celebration" - -### 4. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Celebration" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF R: Show detailed before/after comparison, then redisplay menu -- IF C: Save validation summary to {editPlan}, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-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 - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [validation summary displayed], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All validation findings displayed clearly -- Before/after comparison shown -- User given options for handling issues - -### ❌ SYSTEM FAILURE: - -- Findings not displayed to user -- Proceeding without user acknowledgment - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md b/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md index 2dc6e33a..3a4b259e 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md @@ -70,7 +70,7 @@ Initialize the validation report: ```markdown --- agentName: '{agent-name}' -agentType: '{simple|expert|module}' +agentType: '{simple|expert|module}' # Derived from module + hasSidecar agentFile: '{agent-file-path}' validationDate: '{YYYY-MM-DD}' stepsCompleted: @@ -82,8 +82,9 @@ stepsCompleted: ## Agent Overview **Name:** {agent-name} -**Type:** {simple|expert|module} -**Version:** {version} +**Type:** {simple|expert|module} # Derived from: module + hasSidecar +**module:** {module-value} +**hasSidecar:** {true|false} **File:** {agent-file-path} --- diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md b/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md index 5f74ce2a..0b9054c6 100644 --- a/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +++ b/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md @@ -48,7 +48,7 @@ Read `{expertValidation}`, `{criticalActions}`, `{validationReport}`, and `{agen ### 2. Conditional Validation -**IF agentType == expert OR (agentType == module AND hasSidecar == true):** +**IF (module = "stand-alone" AND hasSidecar = true) OR (module ≠ "stand-alone" AND hasSidecar = true):** Perform these checks systematically - validate EVERY rule specified in expertValidation.md: #### A. Sidecar Folder Validation @@ -89,7 +89,7 @@ For each sidecar path reference in agent YAML: - [ ] No unreferenced files (files present but not referenced) - [ ] File structure matches expert agent requirements -**IF agentType is Simple (no sidecar):** +**IF (module = "stand-alone" AND hasSidecar = false):** - [ ] Mark sidecar validation as N/A - [ ] Confirm no sidecar-folder path in metadata - [ ] Confirm no sidecar references in menu handlers @@ -124,7 +124,7 @@ Append to `{validationReport}`: {List of blocking issues that must be fixed} *N/A (for Simple agents):* -N/A - Agent is Simple type (hasSidecar: false, no sidecar required) +N/A - Agent is Simple type (module = "stand-alone" + hasSidecar: false, no sidecar required) ``` ### 4. Auto-Advance diff --git a/src/modules/bmb/workflows/module/data/agent-architecture.md b/src/modules/bmb/workflows/module/data/agent-architecture.md new file mode 100644 index 00000000..7cfac331 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/agent-architecture.md @@ -0,0 +1,179 @@ +# Agent Architecture for Modules + +**Purpose:** High-level guidance for planning agents in your module — not implementation details (that's what the agent-builder workflow is for). + +--- + +## Single Agent vs. Multi-Agent Module + +### Single Agent Module + +**Use when:** One persona can handle the module's purpose. + +**Characteristics:** +- Simpler, focused +- Clear single point of contact +- Good for narrow domains + +**Question:** Could one expert agent with a sidecar handle this entire module? + +--- + +### Multi-Agent Module + +**Use when:** Different expertise areas justify specialized personas. + +**Characteristics:** +- Each agent has a distinct role and expertise +- Agents form a cohesive team around the module's theme +- Menus coordinate to guide users to the right agent + +**Why multi-agent?** +- Different workflows need different expert perspectives +- Users expect to talk to "the right expert" for each task +- The module covers a domain too broad for one persona + +--- + +## Flagship Example: BMM Agent Team + +BMM demonstrates a multi-agent module with **9 specialized agents** forming a complete software development team. + +### The BMM Theme + +**"Agile software delivery, AI-driven"** + +Every agent serves this theme — they're a complete team working together. + +### BMM Agent Overview + +| Agent | Name | Role | Responsible For | +|-------|------|------|-----------------| +| PM | John | Product Manager | PRDs, requirements, user stories | +| Architect | Winston | System Architect | Technical design, architecture | +| UX | | UX Designer | User research, UX design | +| Dev | | Developer | Implementation, coding | +| TEA | | Test Engineer Architect | Test architecture, QA | +| SM | | Scrum Master | Sprint planning, workflow status | +| Tech Writer | | Technical Writer | Documentation | +| Analyst | | Business Analyst | Analysis, metrics | +| Quick Flow | | Solo Developer | Quick standalone work | + +### Key Patterns + +1. **Shared commands** — All agents have `[WS]` Workflow Status +2. **Specialty commands** — Each agent has unique commands (PM→PRD, Architect→Architecture) +3. **No overlap** — Each command has one clear owner +4. **Collaboration** — Agents reference each other's work (PRD → Architecture → Implementation) + +--- + +## Planning Your Agents + +### For Each Agent, Document: + +1. **Role** — What is this agent responsible for? +2. **Workflows** — Which workflows will this agent trigger/own? +3. **Human Name** — What's their persona name? (e.g., "John", "Winston") +4. **Communication Style** — How do they talk? (e.g., "Direct and data-sharp", "Calm and pragmatic") +5. **Skills/Expertise** — What knowledge does this agent bring? +6. **Memory/Learning** — Does this agent need to remember things over time? (hasSidecar) + +That's it! The agent-builder workflow will handle the detailed implementation. + +--- + +## Agent Memory & Learning + +### Sidecar Agents (hasSidecar: true) + +**Use when:** The agent needs to remember context across sessions. + +**Characteristics:** +- Has a sidecar file that persists between conversations +- Learns from user interactions +- Remembers project details, preferences, past work + +**Examples:** +- An agent that tracks project decisions over time +- An agent that learns user preferences +- An agent that maintains ongoing project context + +### Stateless Agents (hasSidecar: false) + +**Use when:** The agent doesn't need persistent memory. + +**Characteristics:** +- Each conversation starts fresh +- Relies on shared context files (like project-context.md) +- Simpler, more predictable + +**Most module agents are stateless** — they reference shared project context rather than maintaining their own memory. + +--- + +## Agent-Workflow Coordination + +### Menu Triggers + +Each agent has menu items that trigger workflows: + +| Trigger Type | Pattern | Example | +|--------------|---------|---------| +| Shared | Same across all agents | `[WS]` Workflow Status | +| Specialty | Unique to this agent | `[PR]` Create PRD (PM only) | +| Cross-reference | Points to another agent's workflow | "See architecture" | + +### Simple Planning Format + +For each agent, just document: + +``` +Agent: PM (John) +Role: Product Manager, requirements, PRDs +Triggers: + - WS → Workflow Status (shared) + - PR → Create PRD (specialty) + - ES → Epics and Stories (specialty) +Memory: No (uses shared project-context) +``` + +The agent-builder workflow will convert this into the proper format. + +--- + +## When to Use Multiple Agents + +**Consider multiple agents when:** +- Different workflows require different expertise +- The domain has clear specialization areas +- Users would expect to talk to different "experts" +- The module covers a broad process (like software development) + +**Use a single agent when:** +- The domain is focused and narrow +- One expertise area covers all workflows +- Simplicity is preferred +- The agent could reasonably handle everything with a sidecar + +--- + +## Quick Agent Planning Checklist + +For each agent in your module: + +- [ ] Role defined (what they're responsible for) +- [ ] Workflows assigned (which workflows they trigger) +- [ ] Human name chosen (persona) +- [ ] Communication style described +- [ ] Skills/expertise identified +- [ ] Memory decision (hasSidecar: true/false) + +--- + +## Notes + +- **Don't worry about the exact YAML format** — agent-builder handles that +- **Focus on the planning** — who does what, how they work together +- **Keep it high-level** — this is about the module's agent architecture, not implementation details +- **BMM is the reference** — look at how their agents form a cohesive team diff --git a/src/modules/bmb/workflows/module/data/agent-spec-template.md b/src/modules/bmb/workflows/module/data/agent-spec-template.md new file mode 100644 index 00000000..5452abb6 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/agent-spec-template.md @@ -0,0 +1,79 @@ +# Agent Specification: {agent_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-agent workflow +**Created:** {date} + +--- + +## Agent Metadata + +```yaml +agent: + metadata: + id: "_bmad/{module_code}/agents/{agent_file_name}.md" + name: {agent_human_name} + title: {agent_title} + icon: {agent_icon} + module: {module_code} + hasSidecar: false +``` + +--- + +## Agent Persona + +### Role + +{agent_role} + +### Identity + +{agent_identity} + +### Communication Style + +{agent_communication_style} + +### Principles + +{agent_principles} + +--- + +## Agent Menu + +### Planned Commands + +| Trigger | Command | Description | Workflow | +|---------|---------|-------------|----------| +{agent_menu_table} + +--- + +## Agent Integration + +### Shared Context + +- References: `{shared_context_files}` +- Collaboration with: {collaborating_agents} + +### Workflow References + +{workflow_references} + +--- + +## Implementation Notes + +**Use the create-agent workflow to build this agent.** + +Inputs needed: +- Agent name and human name +- Role and expertise area +- Communication style preferences +- Menu commands and workflow mappings + +--- + +_Spec created on {date} via BMAD Module workflow_ diff --git a/src/modules/bmb/workflows/module/data/module-installer-standards.md b/src/modules/bmb/workflows/module/data/module-installer-standards.md new file mode 100644 index 00000000..c95746a6 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/module-installer-standards.md @@ -0,0 +1,348 @@ +# Module Installer Standards + +**Purpose:** How the `_module-installer` folder works, including installer.js patterns and platform-specific configuration. + +--- + +## Overview + +The `_module-installer` folder contains optional installation logic for your module. It runs AFTER the IDE installations and can: +- Create directories specified in module.yaml +- Copy assets or templates +- Configure IDE-specific settings +- Set up platform-specific integrations + +--- + +## When Do You Need an Installer? + +### Use an Installer When: + +- Creating directories based on user configuration +- Copying template files to the user's project +- IDE-specific setup (Claude Code, Windsurf, Cursor, etc.) +- Platform-specific integrations + +### Skip the Installer When: + +- Module only provides agents and workflows +- No file operations needed +- No IDE-specific configuration + +--- + +## Folder Structure + +``` +_module-installer/ +├── installer.js # Main installer (REQUIRED if folder exists) +└── platform-specifics/ # IDE-specific handlers (optional) + ├── claude-code.js + ├── windsurf.js + ├── cursor.js + └── ... +``` + +--- + +## installer.js Pattern + +### Function Signature + +```javascript +/** + * Module Installer + * + * @param {Object} options - Installation options + * @param {string} options.projectRoot - The root directory of the target project + * @param {Object} options.config - Module configuration from module.yaml (resolved variables) + * @param {Array} options.installedIDEs - Array of IDE codes that were installed + * @param {Object} options.logger - Logger instance for output + * @returns {Promise} - Success status (true = success, false = failure) + */ +async function install(options) { + const { projectRoot, config, installedIDEs, logger } = options; + + try { + // Installation logic here + logger.log(chalk.blue('Installing {Module Name}...')); + + // ... your logic ... + + logger.log(chalk.green('✓ {Module Name} installation complete')); + return true; + } catch (error) { + logger.error(chalk.red(`Error installing module: ${error.message}`)); + return false; + } +} + +module.exports = { install }; +``` + +--- + +### What You Receive + +| Parameter | Type | Description | +|-----------|------|-------------| +| `projectRoot` | string | Absolute path to the user's project root | +| `config` | object | Resolved module.yaml variables | +| `installedIDEs` | array | List of IDE codes installed (e.g., `['claude-code', 'windsurf']`) | +| `logger` | object | Logger with `.log()`, `.warn()`, `.error()` methods | + +The `config` object contains your module.yaml variables **after** user input: + +```javascript +// If module.yaml defined: +// project_name: +// prompt: "What is your project name?" +// result: "{value}" + +config.project_name // = user's input +config.planning_artifacts // = resolved path +``` + +--- + +## Common Installation Tasks + +### 1. Create Directories + +```javascript +const fs = require('fs-extra'); +const path = require('node:path'); + +// Create directory from config +if (config['planning_artifacts']) { + const dirConfig = config['planning_artifacts'].replace('{project-root}/', ''); + const dirPath = path.join(projectRoot, dirConfig); + + if (!(await fs.pathExists(dirPath))) { + logger.log(chalk.yellow(`Creating directory: ${dirConfig}`)); + await fs.ensureDir(dirPath); + } +} +``` + +### 2. Copy Assets + +```javascript +const assetsSource = path.join(__dirname, 'assets'); +const assetsDest = path.join(projectRoot, 'docs'); + +if (await fs.pathExists(assetsSource)) { + await fs.copy(assetsSource, assetsDest); + logger.log(chalk.green('✓ Copied assets to docs/')); +} +``` + +### 3. IDE-Specific Configuration + +```javascript +// Handle IDE-specific configurations +if (installedIDEs && installedIDEs.length > 0) { + logger.log(chalk.cyan(`Configuring for IDEs: ${installedIDEs.join(', ')}`)); + + for (const ide of installedIDEs) { + await configureForIDE(ide, projectRoot, config, logger); + } +} +``` + +--- + +## Platform-Specific Handlers + +### Pattern + +Create files in `platform-specifics/{ide-code}.js`: + +```javascript +// platform-specifics/claude-code.js + +/** + * Configure module for Claude Code + */ +async function install(options) { + const { projectRoot, config, logger, platformInfo } = options; + + try { + // Claude Code specific configuration + logger.log(chalk.dim(' Configuring Claude Code integration...')); + + // Your logic here + + return true; + } catch (error) { + logger.warn(chalk.yellow(` Warning: ${error.message}`)); + return false; + } +} + +module.exports = { install }; +``` + +### Load from Main Installer + +```javascript +// installer.js +const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes')); + +async function configureForIDE(ide, projectRoot, config, logger) { + // Validate platform code + if (!platformCodes.isValidPlatform(ide)) { + logger.warn(chalk.yellow(` Unknown platform: '${ide}'. Skipping.`)); + return; + } + + const platformName = platformCodes.getDisplayName(ide); + const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`); + + try { + if (await fs.pathExists(platformSpecificPath)) { + const platformHandler = require(platformSpecificPath); + + if (typeof platformHandler.install === 'function') { + await platformHandler.install({ projectRoot, config, logger }); + logger.log(chalk.green(` ✓ Configured for ${platformName}`)); + } + } + } catch (error) { + logger.warn(chalk.yellow(` Warning: Could not configure ${platformName}: ${error.message}`)); + } +} +``` + +--- + +## Complete Example: BMM Installer + +```javascript +const fs = require('fs-extra'); +const path = require('node:path'); +const chalk = require('chalk'); +const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes')); + +/** + * BMM Module Installer + */ +async function install(options) { + const { projectRoot, config, installedIDEs, logger } = options; + + try { + logger.log(chalk.blue('🚀 Installing BMM Module...')); + + // Create output directory + if (config['output_folder']) { + const outputConfig = config['output_folder'].replace('{project-root}/', ''); + const outputPath = path.join(projectRoot, outputConfig); + if (!(await fs.pathExists(outputPath))) { + logger.log(chalk.yellow(`Creating output directory: ${outputConfig}`)); + await fs.ensureDir(outputPath); + } + } + + // Create implementation artifacts directory + if (config['implementation_artifacts']) { + const storyConfig = config['implementation_artifacts'].replace('{project-root}/', ''); + const storyPath = path.join(projectRoot, storyConfig); + if (!(await fs.pathExists(storyPath))) { + logger.log(chalk.yellow(`Creating story directory: ${storyConfig}`)); + await fs.ensureDir(storyPath); + } + } + + // IDE-specific configuration + if (installedIDEs && installedIDEs.length > 0) { + logger.log(chalk.cyan(`Configuring BMM for IDEs: ${installedIDEs.join(', ')}`)); + + for (const ide of installedIDEs) { + await configureForIDE(ide, projectRoot, config, logger); + } + } + + logger.log(chalk.green('✓ BMM Module installation complete')); + return true; + } catch (error) { + logger.error(chalk.red(`Error installing BMM: ${error.message}`)); + return false; + } +} + +async function configureForIDE(ide, projectRoot, config, logger) { + if (!platformCodes.isValidPlatform(ide)) { + logger.warn(chalk.yellow(` Warning: Unknown platform '${ide}'. Skipping.`)); + return; + } + + const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`); + + try { + if (await fs.pathExists(platformSpecificPath)) { + const platformHandler = require(platformSpecificPath); + + if (typeof platformHandler.install === 'function') { + await platformHandler.install({ projectRoot, config, logger }); + } + } + } catch (error) { + logger.warn(chalk.yellow(` Warning: Could not load handler for ${ide}: ${error.message}`)); + } +} + +module.exports = { install }; +``` + +--- + +## Best Practices + +### DO: +- Return `true` for success, `false` for failure +- Use chalk for colored output +- Log what you're doing (create, copy, configure) +- Handle errors gracefully with try/catch +- Validate paths before creating directories + +### DON'T: +- Assume paths exist — check with `fs.pathExists()` +- Overwrite user files without asking +- Fail silently — log errors +- Use absolute paths — build from `projectRoot` + +--- + +## Available Platform Codes + +Common IDE codes: +- `claude-code` — Anthropic's Claude Code +- `windsurf` — Windsurf IDE +- `cursor` — Cursor AI IDE +- `vscode` — Visual Studio Code + +Use `platformCodes.isValidPlatform(ide)` to validate. + +--- + +## Testing Your Installer + +1. Create a test project +2. Run `bmad install {your-module}` +3. Verify directories are created +4. Check that config variables are resolved correctly +5. Test platform-specific handlers + +--- + +## Quick Reference + +| Task | Code Pattern | +|------|--------------| +| Create directory | `await fs.ensureDir(path)` | +| Check if exists | `await fs.pathExists(path)` | +| Copy files | `await fs.copy(src, dest)` | +| Log info | `logger.log(chalk.blue('message'))` | +| Log success | `logger.log(chalk.green('✓ message'))` | +| Log warning | `logger.warn(chalk.yellow('warning'))` | +| Log error | `logger.error(chalk.red('error'))` | diff --git a/src/modules/bmb/workflows/module/data/module-standards.md b/src/modules/bmb/workflows/module/data/module-standards.md new file mode 100644 index 00000000..b56ca060 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/module-standards.md @@ -0,0 +1,280 @@ +# Module Standards + +**Purpose:** Defines what a BMAD module is, its structure, and the three types of modules. + +--- + +## What is a BMAD Module? + +A **BMAD module** is a self-contained package of functionality that extends the BMAD framework. Modules provide: +- **Agents** — AI personas with specialized expertise and menu-driven commands +- **Workflows** — Structured processes for accomplishing complex tasks +- **Configuration** — module.yaml for user customization +- **Installation** — Optional installer.js for setup logic + +--- + +## Module Types + +### 1. Standalone Module + +A new, independent module focused on a specific domain. + +**Characteristics:** +- Own module code (e.g., `healthcare-ai`, `legal-assist`) +- Independent of other modules +- Can be installed alongside any other modules +- Has its own agents, workflows, configuration + +**Location:** `src/modules/{module-code}/` + +**Example:** CIS (Creative Innovation Suite) — a standalone module for innovation workflows + +--- + +### 2. Extension Module + +Extends an existing BMAD module with additional functionality. + +**Characteristics:** +- Builds upon an existing module's agents and workflows +- May add new agents or workflows that complement the base module +- Shares configuration context with the extended module +- Typically installed alongside the module it extends + +**Location:** `src/modules/{base-module}/extensions/{extension-code}/` + +**Example:** An extension to BMM that adds specialized security review workflows + +--- + +### Extension Module: Override & Merge Pattern + +When an extension module is installed, its files merge with the base module following these rules: + +#### Code Matching + +The extension's `module.yaml` `code:` field matches the base module's code: + +```yaml +# Base module: src/modules/bmm/module.yaml +code: bmm + +# Extension: src/modules/bmm/extensions/security/module.yaml +code: bmm # SAME CODE — extends BMM +``` + +The **folder name** is unique (e.g., `bmm-security`) but the `code:` matches the base module. + +#### File Merge Rules + +| File Type | Same Name | Different Name | +|-----------|-----------|----------------| +| Agent file | **OVERRIDE** — replaces the base agent | **ADD** — new agent added | +| Workflow folder | **OVERRIDE** — replaces the base workflow | **ADD** — new workflow added | +| Other files | **OVERRIDE** — replaces base file | **ADD** — new file added | + +#### Examples + +**Override scenario:** +``` +Base module (BMM): +├── agents/ +│ └── pm.agent.yaml # Original PM agent + +Extension (bmm-security): +├── agents/ +│ └── pm.agent.yaml # Security-focused PM — REPLACES original + +Result after installation: +├── agents/ +│ └── pm.agent.yaml # Now the security version +``` + +**Add scenario:** +``` +Base module (BMM): +├── agents/ +│ ├── pm.agent.yaml +│ └── architect.agent.yaml + +Extension (bmm-security): +├── agents/ +│ └── security-auditor.agent.yaml # NEW agent + +Result after installation: +├── agents/ +│ ├── pm.agent.yaml +│ ├── architect.agent.yaml +│ └── security-auditor.agent.yaml # ADDED +``` + +**Mixed scenario:** +``` +Extension contains both overrides and new files — applies rules per file +``` + +--- + +### 3. Global Module + +Affects the entire BMAD framework and all modules. + +**Characteristics:** +- Core functionality that impacts all modules +- Often provides foundational services or utilities +- Installed at the framework level +- Use sparingly — only for truly global concerns + +**Location:** `src/modules/{module-code}/` with `global: true` in module.yaml + +**Example:** A module that provides universal logging or telemetry across BMAD + +--- + +## Required Module Structure + +``` +{module-code}/ +├── module.yaml # Module configuration (REQUIRED) +├── README.md # Module documentation (REQUIRED) +├── agents/ # Agent definitions (if any) +│ └── {agent-name}.agent.yaml +├── workflows/ # Workflow definitions (if any) +│ └── {workflow-name}/ +│ └── workflow.md +├── _module-installer/ # Installation logic (optional) +│ ├── installer.js +│ └── platform-specifics/ +│ ├── claude-code.js +│ ├── windsurf.js +│ └── ... +└── {other folders} # Tasks, templates, data as needed +``` + +--- + +## Required Files + +### module.yaml (REQUIRED) + +Every module MUST have a `module.yaml` file with at minimum: + +```yaml +code: {module-code} +name: "Module Display Name" +header: "Brief module description" +subheader: "Additional context" +default_selected: false +``` + +See: `module-yaml-conventions.md` for full specification. + +--- + +### README.md (REQUIRED) + +Every module MUST have a README.md with: +- Module name and purpose +- Installation instructions +- Components section (agents, workflows) +- Quick start guide +- Module structure diagram +- Configuration section +- Usage examples +- Author information + +--- + +## Optional Components + +### Agents + +Agents are AI personas with: +- Metadata (id, name, title, icon, module) +- Persona (role, identity, communication_style, principles) +- Menu (trigger → workflow/exec mappings) + +See: `agent-architecture.md` for design guidance. + +--- + +### Workflows + +Workflows are structured processes with: +- workflow.md (entry point) +- steps/ folder with step files +- data/ folder with shared reference +- templates/ folder if needed + +--- + +### _module-installer/ + +Optional installation logic for: +- Creating directories +- Copying assets +- IDE-specific configuration +- Platform-specific setup + +See: `module-installer-standards.md` for patterns. + +--- + +## Module Type Decision Tree + +``` +START: Creating a module +│ +├─ Is this a brand new independent domain? +│ └─ YES → Standalone Module +│ +├─ Does this extend an existing module? +│ └─ YES → Extension Module +│ +└─ Does this affect all modules globally? + └─ YES → Global Module (use sparingly) +``` + +--- + +## Naming Conventions + +### Module Code + +- **kebab-case** (e.g., `bmm`, `cis`, `bmgd`, `healthcare-ai`) +- Short, memorable, descriptive +- 2-20 characters +- Lowercase letters, numbers, hyphens only + +### Agent Files + +- Format: `{role-name}.agent.yaml` +- Example: `pm.agent.yaml`, `architect.agent.yaml` + +### Workflow Folders + +- Format: `{workflow-name}/` +- Example: `prd/`, `create-architecture/` + +--- + +## Module Dependencies + +Modules can depend on: +- **Core BMAD** — Always available +- **Other modules** — Specify in module.yaml as `dependencies:` +- **External tools** — Document in README, handle in installer + +--- + +## Quick Reference + +| Question | Answer | +|----------|--------| +| What's a module? | Self-contained package of agents, workflows, config | +| What are the types? | Standalone, Extension, Global | +| What's required? | module.yaml, README.md | +| Where do modules live? | `src/modules/{code}/` | +| How do agents work? | Menu triggers → workflow/exec | +| How does installation work? | module.yaml prompts + optional installer.js | diff --git a/src/modules/bmb/workflows/module/data/module-yaml-conventions.md b/src/modules/bmb/workflows/module/data/module-yaml-conventions.md new file mode 100644 index 00000000..ee3b31a7 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/module-yaml-conventions.md @@ -0,0 +1,392 @@ +# module.yaml Conventions + +**Purpose:** Defines how module.yaml works, including variables, templates, and how they provide context to agents and workflows. + +--- + +## Overview + +`module.yaml` is the configuration file for a BMAD module. It: +- Defines module metadata (code, name, description) +- Collects user input via prompts during installation +- Makes those inputs available to agents and workflows as variables +- Specifies which module should be selected by default + +--- + +## Frontmatter Fields + +### Required Fields + +```yaml +code: {module-code} # kebab-case identifier +name: "Display Name" # Human-readable name +header: "Brief description" # One-line summary +subheader: "Additional context" # More detail +default_selected: false # Auto-select on install? +``` + +### `default_selected` Guidelines + +| Module Type | default_selected | Example | +|-------------|------------------|---------| +| Core/Primary | `true` | BMM (agile software delivery) | +| Specialized | `false` | CIS (creative innovation), BMGD (game dev) | +| Experimental | `false` | New modules in development | + +--- + +## Variables System + +### Core Config Variables (Always Available) + +These variables are automatically available to ALL modules: + +```yaml +# Variables from Core Config inserted: +## user_name # User's name +## communication_language # Preferred language +## document_output_language # Output document language +## output_folder # Default output location +``` + +No need to define these — they're injected automatically. + +--- + +### Custom Variables + +Define custom variables for user input: + +```yaml +variable_name: + prompt: "Question to ask the user?" + default: "{default_value}" + result: "{template_for_final_value}" +``` + +**Example:** + +```yaml +project_name: + prompt: "What is the title of your project?" + default: "{directory_name}" + result: "{value}" +``` + +### Variable Templates + +In `prompt` and `result`, you can use templates: + +| Template | Expands To | +|----------|------------| +| `{value}` | The user's input | +| `{directory_name}` | Current directory name | +| `{output_folder}` | Output folder from core config | +| `{project-root}` | Project root path | +| `{variable_name}` | Another variable's value | + +--- + +## Variable Types + +### 1. Simple Text Input + +```yaml +project_name: + prompt: "What is the title of your project?" + default: "{directory_name}" + result: "{value}" +``` + +--- + +### 2. Boolean/Flag + +```yaml +enable_feature: + prompt: "Enable this feature?" + default: false + result: "{value}" +``` + +--- + +### 3. Single Select + +```yaml +skill_level: + prompt: "What is your experience level?" + default: "intermediate" + result: "{value}" + single-select: + - value: "beginner" + label: "Beginner - Explains concepts clearly" + - value: "intermediate" + label: "Intermediate - Balanced approach" + - value: "expert" + label: "Expert - Direct and technical" +``` + +--- + +### 4. Multi Select + +```yaml +platforms: + prompt: "Which platforms do you need?" + default: ["unity", "unreal"] + result: "{value}" + multi-select: + - value: "unity" + label: "Unity" + - value: "unreal" + label: "Unreal Engine" + - value: "godot" + label: "Godot" +``` + +--- + +### 5. Multi-Line Prompt + +```yaml +complex_variable: + prompt: + - "First question?" + - "Second context?" + - "Third detail?" + default: "default_value" + result: "{value}" +``` + +--- + +### 6. Required Variable + +```yaml +critical_variable: + prompt: "Required information:" + required: true + result: "{value}" +``` + +--- + +### 7. Path Variable + +```yaml +artifacts_folder: + prompt: "Where should artifacts be stored?" + default: "{output_folder}/artifacts" + result: "{project-root}/{value}" +``` + +--- + +## Variable Inheritance / Aliasing + +Create an alias for another variable: + +```yaml +primary_artifacts: + prompt: "Where should primary artifacts be stored?" + default: "{output_folder}/artifacts" + result: "{project-root}/{value}" + +# Alias for workflow compatibility +sprint_artifacts: + inherit: "primary_artifacts" +``` + +Now `sprint_artifacts` and `primary_artifacts` reference the same value. + +--- + +## How Variables Become Available + +### To Agents + +After installation, variables are available in agent frontmatter/context: + +```yaml +# In agent.agent.yaml or workflow execution +{variable_name} # Expands to the user's configured value +``` + +**Example:** If the user configured `project_name: "MyApp"`, agents can reference `{project_name}` and it will expand to `"MyApp"`. + +### To Workflows + +Workflows can reference module variables in their step files: + +```yaml +--- +outputFile: '{implementation_artifacts}/my-output.md' +--- +``` + +This expands the `implementation_artifacts` variable from module.yaml. + +--- + +## Real-World Examples + +### BMM (BMad Method) — Complex Configuration + +```yaml +code: bmm +name: "BMM: BMad Method Agile-AI Driven-Development" +header: "BMad Method™: Breakthrough Method of Agile-Ai Driven-Dev" +subheader: "Agent and Workflow Configuration for this module" +default_selected: true + +# Variables from Core Config inserted: +## user_name +## communication_language +## document_output_language +## output_folder + +project_name: + prompt: "What is the title of your project?" + default: "{directory_name}" + result: "{value}" + +user_skill_level: + prompt: + - "What is your development experience level?" + - "This affects how agents explain concepts." + default: "intermediate" + result: "{value}" + single-select: + - value: "beginner" + label: "Beginner - Explain concepts clearly" + - value: "intermediate" + label: "Intermediate - Balanced approach" + - value: "expert" + label: "Expert - Direct and technical" + +planning_artifacts: + prompt: "Where should planning artifacts be stored?" + default: "{output_folder}/planning-artifacts" + result: "{project-root}/{value}" + +implementation_artifacts: + prompt: "Where should implementation artifacts be stored?" + default: "{output_folder}/implementation-artifacts" + result: "{project-root}/{value}" + +project_knowledge: + prompt: "Where should project knowledge be stored?" + default: "docs" + result: "{project-root}/{value}" + +tea_use_mcp_enhancements: + prompt: "Enable MCP enhancements in Test Architect?" + default: false + result: "{value}" +``` + +--- + +### CIS (Creative Innovation Suite) — Minimal Configuration + +```yaml +code: cis +name: "CIS: Creative Innovation Suite" +header: "Creative Innovation Suite (CIS) Module" +subheader: "No custom configuration - uses Core settings only" +default_selected: false + +# Variables from Core Config inserted: +## user_name +## communication_language +## document_output_language +## output_folder +``` + +Some modules don't need custom variables — core config is enough! + +--- + +### BMGD (Game Development) — Multi-Select Example + +```yaml +code: bmgd +name: "BMGD: BMad Game Development" +header: "BMad Game Development Module" +subheader: "Configure game development settings" +default_selected: false + +project_name: + prompt: "What is the name of your game project?" + default: "{directory_name}" + result: "{value}" + +primary_platform: + prompt: "Which game engine do you use?" + default: ["unity", "unreal"] + required: true + result: "{value}" + multi-select: + - value: "unity" + label: "Unity" + - value: "unreal" + label: "Unreal Engine" + - value: "godot" + label: "Godot" + - value: "other" + label: "Custom / Other" +``` + +--- + +## Best Practices + +### DO: +- Keep prompts clear and concise +- Provide sensible defaults +- Use `result: "{project-root}/{value}"` for paths +- Use single/multi-select for structured choices +- Group related variables logically + +### DON'T: +- Overwhelm users with too many questions +- Ask for information that could be inferred +- Use technical jargon in prompts +- Create variables that are never used + +--- + +## Variable Naming + +- **kebab-case** (e.g., `planning_artifacts`, `user_skill_level`) +- Descriptive but concise +- Avoid conflicts with core variables + +--- + +## Testing Your module.yaml + +After creating module.yaml, test it: + +1. Run `bmad install` in a test project +2. Verify prompts appear correctly +3. Check that variables expand in agents/workflows +4. Test default values +5. Validate path templates resolve correctly + +--- + +## Quick Reference + +| Pattern | Use Case | +|---------|----------| +| Simple text input | Names, titles, descriptions | +| Boolean/Flag | Enable/disable features | +| Single select | Experience levels, categories | +| Multi select | Platforms, frameworks, options | +| Multi-line prompt | Complex questions needing context | +| Required | Must-have information | +| Path variable | Directory locations | +| Inherit/Alias | Compatibility, references | diff --git a/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md b/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md new file mode 100644 index 00000000..b415eca4 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md @@ -0,0 +1,147 @@ +--- +name: 'step-01-welcome' +description: 'Welcome user, select mode (Interactive/Express/YOLO), gather initial idea' + +nextStepFile: './step-02-spark.md' +briefTemplateFile: '../templates/brief-template.md' +moduleStandardsFile: '../data/module-standards.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 1: Welcome & Mode Selection + +## STEP GOAL: + +Welcome the user to the Module Brief workflow, select the collaboration mode (Interactive/Express/YOLO), and gather their initial module idea. + +## 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 with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Architect** — creative, inspiring, helping users discover amazing module ideas +- ✅ This is explorative and collaborative — not a template-filling exercise +- ✅ Help users clarify and expand their vision + +### Step-Specific Rules: + +- 🎯 Set the creative tone — this is about discovering possibilities +- 🚫 FORBIDDEN to jump straight to technical details +- 💬 Ask questions that spark imagination + +## EXECUTION PROTOCOLS: + +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 💾 No output file yet — gathering initial context +- 📖 Load next step when user selects 'C' + +## CONTEXT BOUNDARIES: + +- Available: module standards, brief template +- Focus: Initial idea gathering and mode selection +- No existing brief — this is a fresh start + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Welcome with Enthusiasm + +"**Welcome to the Module Brief workflow!** 🚀 + +I'm here to help you create an amazing BMAD module. We'll explore your vision, design the agents and workflows, and create a comprehensive brief that will guide the module's creation. + +Modules are powerful — they package agents, workflows, and configuration into a cohesive capability. Let's make something great!" + +### 2. Select Collaboration Mode + +"**How would you like to work?**" + +- **[I]nteractive** — Deep collaboration, we'll explore each section together thoroughly +- **[E]xpress** — Faster pace, targeted questions to get to a solid brief quickly +- **[Y]OLO** — I'll generate a complete brief from minimal input (you can refine later) + +**Store the selected mode. This affects how we proceed through subsequent steps.** + +### 3. Gather the Initial Idea + +"**Tell me about your module idea.**" + +Encourage them to share: +- What problem does it solve? +- Who would use it? +- What excites you about it? + +**If they're stuck**, offer creative prompts: +- "What domain do you work in? What tasks feel repetitive or could be AI-powered?" +- "Imagine you had a team of AI experts at your disposal — what would you ask them to build?" +- "Is there a module you wish existed?" + +**Capture their initial idea.** We'll explore and expand it in the next steps. + +### 4. Preview the Journey Ahead + +"**Here's where we're going together:**" + +1. Spark — Explore and clarify your idea +2. Module Type — Standalone, Extension, or Global? +3. Vision — What would make this extraordinary? +4. Identity — Name, code, personality +5. Users — Who is this for? +6. Value — What makes it special? +7. Agents — Who's on your team? +8. Workflows — What can we do? +9. Tools — MCP tools, integrations? +10. Scenarios — How will people use it? +11. Creative — Easter eggs, lore, magic ✨ +12. Review — Read through together +13. Finalize — Your complete brief + +"**This is about discovery and creativity. We're not filling out forms — we're designing something amazing together.**" + +### 5. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +- User can chat or ask questions — always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for deeper idea exploration, then redisplay menu +- IF P: Execute `{partyModeWorkflow}` for creative brainstorming, then redisplay menu +- IF C: Store the mode and initial idea, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- User feels welcomed and inspired +- Collaboration mode selected +- Initial idea captured +- User understands the journey ahead + +### ❌ SYSTEM FAILURE: + +- Skipping to technical details prematurely +- Not capturing the initial idea +- Not setting the creative tone +- Rushing through mode selection + +**Master Rule:** This step sets the tone for the entire brief — make it inspiring and collaborative. diff --git a/src/modules/bmb/workflows/module/steps-b/step-02-spark.md b/src/modules/bmb/workflows/module/steps-b/step-02-spark.md new file mode 100644 index 00000000..1a1b17f9 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-02-spark.md @@ -0,0 +1,140 @@ +--- +name: 'step-02-spark' +description: 'Ignite the idea, explore problem space, what excites them' + +nextStepFile: './step-03-module-type.md' +moduleStandardsFile: '../data/module-standards.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 2: Spark + +## STEP GOAL: + +Ignite and explore the user's idea — dig into the problem space, understand what excites them, and help clarify the vision. + +## 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 with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Architect** — curious, explorative, helping ideas grow +- ✅ Ask open-ended questions that reveal depth +- ✅ Listen more than you speak + +### Step-Specific Rules: + +- 🎯 This is about understanding the problem space, not solving it yet +- 🚫 FORBIDDEN to jump to implementation +- 💬 Ask "why" and "what if" questions + +## EXECUTION PROTOCOLS: + +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 📖 Reference module standards to understand types +- 📖 Load next step when user selects 'C' + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. + +### 1. Connect to Their Idea + +"**Let's explore your idea together.**" + +Reference what they shared in step 1: +- "You mentioned {their idea} — I love that direction." +- "Tell me more about the problem you're solving." + +### 2. Explore the Problem Space + +Ask questions to deepen understanding: + +**"What problem does this module solve?"** + +- Who feels this problem right now? +- What do they currently do without this module? +- What would change if this existed? + +**"What excites you about this idea?"** + +- Why THIS module? Why now? +- What's the vision — the dream outcome? +- If this module succeeds wildly, what does that look like? + +### 3. Identify the Users + +**"Who is this module for?"** + +Help them think about: +- Primary users — who will use this most? +- Secondary users — who else benefits? +- What do these users care about? + +### 4. Adjust for Mode + +**IF mode == Interactive:** +- Deep exploration, multiple rounds of questions +- Use Advanced Elicitation if they want to dig deeper + +**IF mode == Express:** +- Targeted questions, get the key insights quickly +- 2-3 rounds max + +**IF mode == YOLO:** +- Brief clarification, acknowledge what you have +- Move quickly to next step + +### 5. Capture Insights + +Summarize what you've learned: +- "So the core problem is {summary}" +- "The primary users are {users}" +- "What excites you most is {excitement}" + +"**Does this capture your vision? Anything to add or refine?**" + +### 6. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for deeper exploration +- IF P: Execute `{partyModeWorkflow}` for creative ideation +- IF C: Load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Problem space clearly understood +- User excitement identified +- Target users clarified +- Vision feels solid + +### ❌ SYSTEM FAILURE: + +- Skipping to solutions too quickly +- Not understanding the problem +- Not capturing what excites them + +**Master Rule:** Understand before you build. This step is about clarity, not solutions. diff --git a/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md b/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md new file mode 100644 index 00000000..0e5290cc --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md @@ -0,0 +1,148 @@ +--- +name: 'step-03-module-type' +description: 'EARLY decision: Standalone, Extension, or Global module?' + +nextStepFile: './step-04-vision.md' +moduleStandardsFile: '../data/module-standards.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 3: Module Type + +## STEP GOAL: + +Make the EARLY key decision: Is this a Standalone, Extension, or Global module? This decision affects everything that follows. + +## 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 with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Architect** — you understand module types and their implications +- ✅ Help the user make an informed decision +- ✅ This is a commitment — get it right + +### Step-Specific Rules: + +- 🎯 This decision MUST happen early +- 🚫 FORBIDDEN to proceed without clarity on module type +- 💬 Explain the trade-offs clearly + +## EXECUTION PROTOCOLS: + +- 🎯 Load `{moduleStandardsFile}` to reference module types +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 📖 Load next step when user selects 'C' + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. + +### 1. Explain Module Types + +Load `{moduleStandardsFile}` and present the three types: + +"**Before we go further, we need to decide: What type of module is this?** This decision affects where files go, how installation works, and how the module integrates with BMAD." + +**Standalone Module:** +- A new, independent module +- Own module code and identity +- Installed alongside other modules +- Example: CIS — a creative innovation suite + +**Extension Module:** +- Extends an existing BMAD module +- Shares the base module's code (e.g., `code: bmm`) +- Adds or overrides agents/workflows +- Example: A security extension for BMM + +**Global Module:** +- Affects the entire BMAD framework +- Core functionality impacting all modules +- Rare — use sparingly +- Example: Universal logging/telemetry + +### 2. Determine Type Together + +**"Based on your idea, what type makes sense?"** + +Help them think through: +- **"Is this a brand new domain?"** → Likely Standalone +- **"Does this build on an existing module?"** → Likely Extension +- **"Does this affect all modules?"** → Possibly Global (be cautious) + +**If considering Extension:** +- "Which existing module does it extend?" +- "Are you adding new agents/workflows, or modifying existing ones?" +- "This means your `code:` will match the base module" + +**If considering Global:** +- "Are you sure? Global modules are rare." +- "Could this be a standalone module instead?" + +### 3. Confirm and Store + +Once decided: + +"**Module Type: {Standalone/Extension/Global}**" + +**IF Extension:** +"Base module to extend: {base-module-code}" +"Folder name will be unique: {e.g., bmm-security}" + +**Store this decision.** It affects: +- Where files are created +- What `code:` goes in module.yaml +- Installation behavior + +### 4. Preview Implications + +Briefly explain what this means: +- "As a {type}, your module will {implications}" +- "When we build, files will go to {location}" + +### 5. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- User can change their mind before proceeding +- ONLY proceed to next step when user selects 'C' and confirms the type + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for deeper exploration of the decision +- IF P: Execute `{partyModeWorkflow}` for brainstorming the approach +- IF C: Confirm the decision, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Module type clearly decided +- User understands the implications +- Extension modules know their base module +- Decision is stored for later steps + +### ❌ SYSTEM FAILURE: + +- Proceeding without clear module type +- User doesn't understand the implications +- Extension module without clear base + +**Master Rule:** This is a gateway decision. Get clarity before moving forward. diff --git a/src/modules/bmb/workflows/module/steps-b/step-04-vision.md b/src/modules/bmb/workflows/module/steps-b/step-04-vision.md new file mode 100644 index 00000000..ada702aa --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-04-vision.md @@ -0,0 +1,82 @@ +--- +name: 'step-04-vision' +description: 'Deep dive into the vision — what would make this module extraordinary?' + +nextStepFile: './step-05-identity.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 4: Vision + +## STEP GOAL: + +Deep dive into the vision — explore what would make this module extraordinary, not just functional. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — visioning, dreaming big +- ✅ Push beyond "good enough" to "extraordinary" +- 💬 Ask "what would make this amazing?" + +### Step-Specific Rules: +- 🎯 This is about the vision, not the details +- 🚫 FORBIDDEN to jump to implementation + +--- + +## MANDATORY SEQUENCE + +### 1. Set the Visioning Tone + +"**Let's dream big. What would make this module extraordinary?**" + +"Good modules solve problems. Great modules inspire people. Let's make yours great." + +### 2. Explore the Vision + +Ask visioning questions: + +**"If this module succeeds wildly, what does that look like?"** +- How are people using it? +- What are they able to do that they couldn't before? +- What's the feeling when they use it? + +**"What would make someone say 'I love this module'?"** +- Delightful features? +- Surprising capabilities? +- The way it makes them feel? + +**"What's the 'secret sauce' — the thing that makes this special?"** + +### 3. Capture the Vision + +Summarize: +- "Your vision: {summary}" +- "What makes it special: {unique aspect}" +- "The dream outcome: {dream}" + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Vision feels inspiring and clear +✅ "Extraordinary" elements identified +✅ User excited about the possibility diff --git a/src/modules/bmb/workflows/module/steps-b/step-05-identity.md b/src/modules/bmb/workflows/module/steps-b/step-05-identity.md new file mode 100644 index 00000000..ddb94a00 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-05-identity.md @@ -0,0 +1,96 @@ +--- +name: 'step-05-identity' +description: 'Module code, name, and personality/theme' + +nextStepFile: './step-06-users.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 5: Identity + +## STEP GOAL: + +Define the module's identity — code, name, and personality/theme. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — naming, branding, theming +- ✅ This is where personality comes in +- 💬 Have fun with this! + +### Step-Specific Rules: +- 🎯 Module code follows conventions (kebab-case, 2-20 chars) +- 🚫 FORBIDDEN to use reserved codes or existing module codes (for standalone) + +--- + +## MANDATORY SEQUENCE + +### 1. Module Code + +"**Let's give your module a code.**" + +Explain: +- kebab-case (e.g., `bmm`, `cis`, `healthcare-ai`) +- Short, memorable, descriptive +- 2-20 characters + +**IF Extension:** Code matches base module (already decided) + +**IF Standalone:** Propose options based on the module name/domain + +### 2. Module Name + +"**What's the display name?**" + +This is the human-facing name in module.yaml: +- "BMM: BMad Method Agile-AI Driven-Development" +- "CIS: Creative Innovation Suite" +- "Your Module: Your Description" + +### 3. Personality Theme + +"**Does your module have a personality or theme?**" + +Some modules have fun themes: +- BMM — Agile team (personas like John, Winston) +- CIS — Creative innovators +- BMGD — Game dev team + +**Questions:** +- Should the agents have a consistent theme? +- Any personality vibes? (Corporate team, fantasy party, reality show cast?) +- Or keep it professional/focused? + +### 4. Store Identity + +Capture: +- Module code: `{code}` +- Module name: `{name}` +- Personality theme: `{theme or "none/professional"}` + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Module code decided and validated +✅ Module name defined +✅ Personality theme decided (even if "none") diff --git a/src/modules/bmb/workflows/module/steps-b/step-06-users.md b/src/modules/bmb/workflows/module/steps-b/step-06-users.md new file mode 100644 index 00000000..d42639f1 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-06-users.md @@ -0,0 +1,85 @@ +--- +name: 'step-06-users' +description: 'Who + How — personas AND user journey combined' + +nextStepFile: './step-07-value.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 6: Users + +## STEP GOAL: + +Define who the module is for AND how they'll use it — personas and user journey combined. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — user-centric, empathetic +- ✅ Help the user walk in their users' shoes +- 💬 Tell the story of how this will be used + +--- + +## MANDATORY SEQUENCE + +### 1. Define the Users + +"**Let's get specific about who this is for.**" + +**Primary Users:** +- Who will use this module most often? +- What's their role? (developer, designer, analyst, etc.) +- What's their skill level? (beginner, intermediate, expert) + +**Secondary Users:** +- Who else might use it? +- How is their experience different? + +### 2. Build User Personas + +Create 1-2 brief personas: + +**Persona 1:** +- Name/role: {e.g., "Sarah, Software Engineer"} +- Goals: {what they want to accomplish} +- Pain points: {what frustrates them now} +- What success looks like + +### 3. Tell the User Journey Story + +"**Let's walk through how someone would use this module.**" + +Tell a story: +1. User has a problem → {their situation} +2. They load the module → {what they expect} +3. They run an agent/workflow → {what happens} +4. They get a result → {the outcome} +5. This helps them → {the achievement} + +"**Can you see this flow? Does it match what you envision?**" + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ User personas defined +✅ User journey story told +✅ User can visualize how their module will be used diff --git a/src/modules/bmb/workflows/module/steps-b/step-07-value.md b/src/modules/bmb/workflows/module/steps-b/step-07-value.md new file mode 100644 index 00000000..05de208a --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-07-value.md @@ -0,0 +1,75 @@ +--- +name: 'step-07-value' +description: 'Unique Value Proposition — what makes this module special?' + +nextStepFile: './step-08-agents.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 7: Value + +## STEP GOAL: + +Define the Unique Value Proposition — what makes this module special and why users would choose it. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — focused on differentiation +- ✅ Help identify what makes this unique +- 💬 Ask "why this and not something else?" + +--- + +## MANDATORY SEQUENCE + +### 1. Explore Differentiation + +"**What makes your module special? Why would someone choose it?**" + +Ask: +- **What can users do with your module that they can't do otherwise?** +- **What's the 'aha!' moment — when they realize this is exactly what they need?** +- **What problem does this solve better than anything else?** + +### 2. Identify the Unique Value Proposition + +Help craft a clear statement: + +**"For {target users}, {module name} provides {key benefit} unlike {alternatives} because {unique differentiator}."** + +Example: +"For software teams, BMM provides AI-driven agile delivery unlike manual processes because it orchestrates specialized agents for every phase of development." + +### 3. Competitive Context + +**"What else exists in this space? How is yours different?"** + +- Similar modules? +- Manual approaches? +- Why is yours better? + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Unique value proposition articulated +✅ Differentiation from alternatives clear +✅ User can explain why someone would choose this module diff --git a/src/modules/bmb/workflows/module/steps-b/step-08-agents.md b/src/modules/bmb/workflows/module/steps-b/step-08-agents.md new file mode 100644 index 00000000..8769ebe9 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-08-agents.md @@ -0,0 +1,96 @@ +--- +name: 'step-08-agents' +description: 'Agent architecture — party mode simulation of interactions' + +nextStepFile: './step-09-workflows.md' +agentArchitectureFile: '../data/agent-architecture.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 8: Agents + +## STEP GOAL: + +Design the agent architecture — who's on your team? Simulate how agents might interact. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — team designer +- ✅ Focus on high-level planning (role, workflows, name, style) +- ✅ Don't worry about YAML format — agent-builder handles that + +### Step-Specific Rules: +- 🎯 Load `{agentArchitectureFile}` for guidance +- 🎯 Party mode is great here — simulate agent interactions +- 🚫 FORBIDDEN to design full agent specs (that's agent-builder's job) + +--- + +## MANDATORY SEQUENCE + +### 1. Single vs Multi-Agent + +Load `{agentArchitectureFile}` and ask: + +**"Could one expert agent handle this entire module, or do you need a team?"** + +Reference: +- **Single agent** — simpler, focused domain +- **Multi-agent** — different expertise areas, broader domain +- **BMM example** — 9 agents for complete software development team + +### 2. Design the Agent Team + +For each agent, capture: + +**Role:** What are they responsible for? +**Workflows:** Which workflows will they trigger? +**Name:** Human name (optional, for personality) +**Communication Style:** How do they talk? +**Memory:** Do they need to remember things over time? (hasSidecar) + +Keep it high-level — don't design full agent specs! + +### 3. Party Mode Simulation + +**"Want to simulate how your agents might interact?"** + +- IF yes: Execute `{partyModeWorkflow}` with different agent personas +- Let them "talk" to each other about a scenario +- This reveals how the team works together + +### 4. Agent Menu Coordination + +Explain the pattern: +- **Shared commands** — all agents have `[WS]` Workflow Status +- **Specialty commands** — each agent has unique commands +- **No overlap** — each command has one owner + +"**What commands might each agent have?**" + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` — great for agent interaction simulation +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Single vs multi-agent decided +✅ Agent roles defined +✅ Agent-workflow mappings clear +✅ Agent interactions explored (via party mode if used) diff --git a/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md b/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md new file mode 100644 index 00000000..1feeb9e1 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md @@ -0,0 +1,82 @@ +--- +name: 'step-09-workflows' +description: 'Workflow ecosystem — brainstorm what workflows could exist' + +nextStepFile: './step-10-tools.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 9: Workflows + +## STEP GOAL: + +Design the workflow ecosystem — brainstorm what workflows this module needs. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — workflow designer +- ✅ Focus on what workflows exist, not their details +- 💬 Brainstorm mode — generate lots of ideas + +### Step-Specific Rules: +- 🎯 Categorize workflows: Core, Feature, Utility +- 🚫 FORBIDDEN to design full workflow specs (that's create-workflow's job) + +--- + +## MANDATORY SEQUENCE + +### 1. Brainstorm Workflows + +"**What workflows should your module have?**" + +Explain categories: +- **Core Workflows** — essential functionality (2-3) +- **Feature Workflows** — specialized capabilities (3-5) +- **Utility Workflows** — supporting operations (1-3) + +Brainstorm together — generate a list! + +### 2. For Each Workflow + +Capture briefly: + +**Workflow name:** {e.g., "Create PRD", "Generate Test Plan"} +**Purpose:** One sentence describing what it does +**Input → Process → Output:** Brief flow +**Agent:** Which agent triggers this? + +### 3. Workflow Connections + +"**How do workflows connect?**" + +- Does workflow A feed into workflow B? +- Are there dependencies? +- What's the typical sequence? + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` — great for workflow brainstorming +- IF P: Execute `{partyModeWorkflow}` — different perspectives on workflows +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Workflow list generated (core, feature, utility) +✅ Each workflow has a clear purpose +✅ Agent-workflow mappings defined +✅ Workflow connections understood diff --git a/src/modules/bmb/workflows/module/steps-b/step-10-tools.md b/src/modules/bmb/workflows/module/steps-b/step-10-tools.md new file mode 100644 index 00000000..0ead6322 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-10-tools.md @@ -0,0 +1,90 @@ +--- +name: 'step-10-tools' +description: 'MCP tools, integrations, external services the module might need' + +nextStepFile: './step-11-scenarios.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 10: Tools + +## STEP GOAL: + +Identify MCP tools, integrations, and external services the module might need. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — integrations thinker +- ✅ Keep it practical — only what's needed +- 💬 Ask "what external capabilities would help?" + +--- + +## MANDATORY SEQUENCE + +### 1. MCP Tools + +"**Does your module need any MCP (Model Context Protocol) tools?**" + +Explain: MCP tools connect agents to external capabilities. + +Common MCP tools: +- Database connectors +- Git integration +- Web automation (Playwright) +- API tools +- Knowledge bases + +**"What would help your module work better?"** + +### 2. External Services + +"**Any external services or APIs?**" + +- Web APIs? +- Cloud services? +- Data sources? +- Third-party tools? + +### 3. Module Integrations + +"**Does this integrate with other BMAD modules?**** + +- Uses workflows from other modules? +- Shares agents or extends them? +- Depends on another module's capabilities? + +### 4. Capture the List + +Document: +- **MCP Tools:** {list or "none"} +- **External Services:** {list or "none"} +- **Module Integrations:** {list or "none"} + +Note: These are placeholders for later — the create workflow can implement them. + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ MCP tools identified (or "none" decided) +✅ External services documented (or "none") +✅ Module integrations noted (or "none") diff --git a/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md b/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md new file mode 100644 index 00000000..026e811c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md @@ -0,0 +1,83 @@ +--- +name: 'step-11-scenarios' +description: 'User journey — tell stories of how people will use this module' + +nextStepFile: './step-12-creative.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 11: Scenarios + +## STEP GOAL: + +Tell stories of how users will actually use this module — bring the vision to life. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — storyteller +- ✅ Paint a picture of actual usage +- 💬 Narrative mode — "imagine this..." + +--- + +## MANDATORY SEQUENCE + +### 1. Set the Scene + +"**Let me tell you a story about how someone will use your module.**" + +"Close your eyes and imagine..." + +### 2. Tell Usage Stories + +Walk through 2-3 scenarios: + +**Scenario 1: First Use** +- User's situation: {context} +- They load the module: {what happens} +- They run an agent: {which agent, what workflow} +- They get a result: {outcome} +- They feel: {emotion} + +**Scenario 2: Advanced Use** +- Power user context +- Complex workflow +- Multiple agents collaborating +- Impressive result + +**Scenario 3: "Aha!" Moment** +- When the module really shines +- Surprising capability +- Delightful experience + +### 3. Validate the Stories + +"**Do these stories feel right? Can you see your module being used this way?**" + +Adjust based on feedback. + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ 2-3 usage scenarios told +✅ User can visualize their module in action +✅ Stories feel authentic and exciting diff --git a/src/modules/bmb/workflows/module/steps-b/step-12-creative.md b/src/modules/bmb/workflows/module/steps-b/step-12-creative.md new file mode 100644 index 00000000..dc2486c7 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-12-creative.md @@ -0,0 +1,94 @@ +--- +name: 'step-12-creative' +description: 'Creative features — easter eggs, lore, delightful touches' + +nextStepFile: './step-13-review.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 12: Creative Features + +## STEP GOAL: + +Add the magic — easter eggs, lore, delightful touches that make the module memorable. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — creative magician +- ✅ This is where personality comes alive +- 💬 "What would make someone smile?" + +### Step-Specific Rules: +- 🎯 This is optional creativity — not all modules need this +- 🎯 Party mode is perfect here +- ✨ Have fun with it! + +--- + +## MANDATORY SEQUENCE + +### 1. Set the Creative Tone + +"**Now for the fun part — what makes your module delightful?** ✨ + +"Great modules work. Amazing modules have personality. What's yours?" + +### 2. Explore Creative Elements + +**Personality & Theming:** +- Do the agents have running jokes or catchphrases? +- Is there a consistent tone or vibe? +- Any thematic elements? (space, medieval, corporate, etc.) + +**Easter Eggs:** +- Hidden commands or responses? +- Fun interactions when users try certain things? +- Surprises that delight? + +**Module Lore:** +- Backstory for the agents? +- A consistent "universe" the module lives in? +- Narrative elements? + +### 3. Party Mode Ideation + +"**Want to brainstorm creative ideas together?**" + +- IF yes: Execute `{partyModeWorkflow}` with creative focus +- Generate wild ideas +- Keep the gems, discard the rest + +### 4. Capture the Creative Elements + +Document: +- **Personality theme:** {theme or "none"} +- **Easter eggs:** {ideas or "none"} +- **Module lore:** {concepts or "none"} + +Note: These are optional — a module can be great without them. + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` — perfect for creative brainstorming! +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Creative elements explored (even if "none") +✅ Personality themes considered +✅ User excited about the possibilities diff --git a/src/modules/bmb/workflows/module/steps-b/step-13-review.md b/src/modules/bmb/workflows/module/steps-b/step-13-review.md new file mode 100644 index 00000000..e28ceb06 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-13-review.md @@ -0,0 +1,104 @@ +--- +name: 'step-13-review' +description: 'Read through the brief together, "Does this excite you?"' + +nextStepFile: './step-14-finalize.md' +briefTemplateFile: '../../templates/brief-template.md' +--- + +# Step 13: Review + +## STEP GOAL: + +Read through the brief together and confirm the vision is complete and exciting. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — review facilitator +- ✅ Read back what we've discovered +- ✅ Ensure nothing important is missing + +--- + +## MANDATORY SEQUENCE + +### 1. Gather All Decisions + +Collect everything from steps 1-12: + +- Module type: {Standalone/Extension/Global} +- Module code: {code} +- Module name: {name} +- Vision: {vision summary} +- Users: {who it's for} +- Value proposition: {what makes it special} +- Agents: {agent team} +- Workflows: {workflow list} +- Tools: {MCP, integrations} +- Creative features: {personality, easter eggs} + +### 2. Read It Back + +"**Let me read back what we've designed together.**" + +Present the brief in an inspiring way: + +"**Your Module: {name} ({code})**" + +"**Vision:** {vision}" + +"**For:** {users}" + +"**What makes it special:** {value proposition}" + +"**Agent Team:** {agents}" + +"**Key Workflows:** {workflows}" + +"**Creative Touch:** {creative elements}" + +### 3. The Excitement Check + +"**Does this excite you?**** + +- Is this the module you envisioned? +- Anything missing? +- Anything you want to change?" + +**Make updates if needed.** + +### 4. Final Confirmation + +"**Are you happy with this brief? Ready to finalize?**" + +### 5. MENU OPTIONS + +**Select an Option:** [B] Back to refine [C] Continue to Finalize + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' and confirms + +#### Menu Handling Logic: + +- IF B: Go back to specific step to refine (ask which one) +- IF C: Load `{nextStepFile}` +- IF Any other: Ask for clarification, then redisplay menu + +--- + +## Success Metrics + +✅ Brief reviewed completely +✅ User confirms excitement +✅ No major gaps identified +✅ Ready to finalize diff --git a/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md b/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md new file mode 100644 index 00000000..1e7fc4cf --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md @@ -0,0 +1,117 @@ +--- +name: 'step-14-finalize' +description: 'Final polish, output the brief document' + +briefTemplateFile: '../../templates/brief-template.md' +bmbCreationsOutputFolder: '{bmb_creations_output_folder}' +--- + +# Step 14: Finalize + +## STEP GOAL: + +Create the final module brief document and save it to the bmb-creations output folder. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — completing the brief +- ✅ Assemble everything into a beautiful document +- ✅ Celebrate the completion! + +--- + +## MANDATORY SEQUENCE + +### 1. Load Template + +Load `{briefTemplateFile}` to use as the base. + +### 2. Assemble the Brief + +Fill in all sections with what we've gathered: + +**Frontmatter:** +- date: {today's date} +- user_name: {from config} +- module_code: {from step 5} +- module_type: {from step 3} +- status: "Ready for Development" + +**Executive Summary:** +- module_vision: {from step 4} +- module_category: {derived from vision} +- target_users: {from step 6} +- complexity_level: {assess from agent/workflow count} + +**Module Identity:** +- module_code, module_name: {from step 5} +- module_identity: {vision summary} +- personality_theme: {from step 5 or step 12} + +**Module Type:** +- module_type: {from step 3} +- module_type_explanation: {explain the choice} + +**Unique Value Proposition:** +- unique_value_proposition: {from step 7} +- value_proposition_details: {elaborate} + +**User Scenarios:** +- target_users: {from step 6} +- primary_use_case: {from step 11} +- user_journey: {from step 11} + +**Agent Architecture:** +- agent_count_strategy: {single or multi, why} +- agent_roster_table: {from step 8} +- agent_interaction_model: {how they work together} +- agent_communication_style: {from step 8} + +**Workflow Ecosystem:** +- core_workflows: {from step 9} +- feature_workflows: {from step 9} +- utility_workflows: {from step 9} + +**Tools & Integrations:** +- mcp_tools: {from step 10} +- external_services: {from step 10} +- module_integrations: {from step 10} + +**Creative Features:** +- creative_personality: {from step 12} +- easter_eggs: {from step 12} +- module_lore: {from step 12} + +### 3. Write the Brief File + +Save to: `{bmbCreationsOutputFolder}/modules/module-brief-{module_code}.md` + +### 4. Celebrate and Next Steps + +"**🎉 Your module brief is complete!**" + +"**Saved to:** {file path}" + +"**Next steps:**" +1. **Review the brief** — Make sure it captures your vision +2. **Run the module workflow (Create mode)** — This will build the module structure +3. **Create agents** — Use the agent-builder workflow for each agent +4. **Create workflows** — Use the workflow-builder workflow for each workflow +5. **Test and iterate** — Install and refine + +"**You've created something amazing. Let's build it!**" + +--- + +## Success Metrics + +✅ Brief document created and saved +✅ All sections filled with gathered information +✅ File path provided to user +✅ Next steps clearly explained diff --git a/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md b/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md new file mode 100644 index 00000000..f89a763c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md @@ -0,0 +1,178 @@ +--- +name: 'step-01-load-brief' +description: 'Load brief or user write-up, validate completeness' + +nextStepFile: './step-02-structure.md' +continueFile: './step-01b-continue.md' +agentSpecTemplate: '../../templates/agent-spec-template.md' +workflowSpecTemplate: '../../templates/workflow-spec-template.md' +moduleStandardsFile: '../../data/module-standards.md' +moduleYamlConventionsFile: '../../data/module-yaml-conventions.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 1: Load Brief (Create Mode) + +## STEP GOAL: + +Load the module brief (or get a detailed user write-up) and validate it has the information needed to build the module. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — structured, competent, ready to build +- ✅ Validate input before proceeding +- ✅ Ensure we have what we need to succeed + +### Step-Specific Rules: + +- 🎯 This is a continuable workflow — check for existing work +- 🚫 FORBIDDEN to proceed without complete brief or write-up +- 💾 Track progress for continuation + +## EXECUTION PROTOCOLS: + +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 📖 Create/update output file to track progress +- 🚫 FORBIDDEN to load next step until brief is validated + +## CONTEXT BOUNDARIES: + +- Input: Module brief from Brief mode OR user-provided write-up +- Output: Module structure ready for implementation +- This mode requires complete information to proceed + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. + +### 1. Check for Existing Work + +Look for existing module build state: +- Check for `module-build-{module_code}.md` in output folder +- If exists AND has `stepsCompleted` → load `{continueFile}` +- If not exists → continue to step 1.2 + +### 2. Get the Brief or Write-Up + +"**Welcome to Create mode! I'll build your module structure from your brief.**" + +**"Where is your module brief?"** + +Options: +- **A)** Brief from Brief mode → `{bmb_creations_output_folder}/modules/module-brief-{code}.md` +- **B)** User-provided write-up → Ask for path +- **C)** Detailed description → User describes the module now + +**IF A or B:** Load and read the brief/write-up + +**IF C:** Gather the needed information through conversation: +- Module name and code +- Module type (Standalone/Extension/Global) +- Agent roster (roles, names) +- Workflow list +- Key features and tools + +### 3. Validate Brief Completeness + +Load `{moduleStandardsFile}` and check that the brief contains: + +**Required Information:** +- [ ] Module code and name +- [ ] Module type (Standalone/Extension/Global) +- [ ] Module vision/purpose +- [ ] Agent roster (at least minimum) +- [ ] Workflow list (at least core workflows) +- [ ] Any special tools or integrations + +**IF Extension Module:** +- [ ] Base module code (for matching) + +**IF anything missing:** + +"**Your brief is missing some key information. Let me help you complete it.**" + +Use `{advancedElicitationTask}` if needed to gather missing details. + +### 4. Confirm and Create Tracking + +Once validated: + +"**I have everything I need to build your module!**" + +"**Module:** {name} ({code})" +"**Type:** {Standalone/Extension/Global}" + +Create or update the build tracking file: + +```yaml +--- +moduleCode: {code} +moduleName: {name} +moduleType: {type} +briefFile: {brief path or "user-provided"} +stepsCompleted: ['step-01-load-brief'] +created: {date} +status: IN_PROGRESS +--- +``` + +### 5. Preview the Build Process + +"**Here's what I'll build for you:**" + +1. Directory structure (based on module type) +2. module.yaml with install configuration +3. _module-installer/ folder (if needed) +4. Agent placeholder/spec files +5. Workflow placeholder/spec files +6. README.md and TODO.md + +"**Ready to start building?**" + +### 6. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for any refinements +- IF P: Execute `{partyModeWorkflow}` for creative pre-build discussion +- IF C: Update tracking file, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Brief or write-up loaded +- All required information validated +- Tracking file created +- User confirms ready to build + +### ❌ SYSTEM FAILURE: + +- Proceeding with incomplete brief +- Missing key information (code, type, agents, workflows) +- Not validating extension base module + +**Master Rule:** Garbage in, garbage out. Ensure we have complete information before building. diff --git a/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md b/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md new file mode 100644 index 00000000..1f10ff64 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md @@ -0,0 +1,83 @@ +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation for Create mode' + +workflowFile: '../workflow.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +--- + +# Step 1b: Continue (Create Mode) + +## STEP GOAL: + +Resume a paused Create mode session by loading the build tracking state and routing to the correct step. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — picking up where we left off +- ✅ Warm welcome back +- ✅ Seamless resume + +--- + +## MANDATORY SEQUENCE + +### 1. Welcome Back + +"**Welcome back to the Module Builder!** 👋" + +### 2. Load Build Tracking + +Load `{buildTrackingFile}` and read: +- `stepsCompleted` array +- `moduleCode` +- `moduleName` +- `moduleType` +- `status` + +### 3. Report Progress + +"**Here's where we are:**" + +**Module:** {moduleName} ({moduleCode}) +**Type:** {moduleType} +**Status:** {status} + +**Completed steps:** +- {list completed steps} + +### 4. Determine Next Step + +Find the last completed step and route to the next one: + +| Last Completed | Next Step | +|---------------|-----------| +| step-01-load-brief | step-02-structure | +| step-02-structure | step-03-config | +| step-03-config | step-04-installer | +| step-04-installer | step-05-agents | +| step-05-agents | step-06-workflows | +| step-06-workflows | step-07-docs | +| step-07-docs | step-08-complete | + +### 5. Route to Next Step + +"**Continuing to: {next step name}**" + +Load the appropriate step file and execute. + +--- + +## Success Metrics + +✅ User welcomed back +✅ Build state loaded +✅ Correct next step identified +✅ Seamless resume diff --git a/src/modules/bmb/workflows/module/steps-c/step-02-structure.md b/src/modules/bmb/workflows/module/steps-c/step-02-structure.md new file mode 100644 index 00000000..0bb90e6c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-02-structure.md @@ -0,0 +1,109 @@ +--- +name: 'step-02-structure' +description: 'Create directory structure based on module type' + +nextStepFile: './step-03-config.md' +moduleStandardsFile: '../../data/module-standards.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +--- + +# Step 2: Directory Structure + +## STEP GOAL: + +Create the module directory structure based on the module type (Standalone/Extension/Global). + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — creating the foundation +- ✅ Structure follows standards +- ✅ Confirm before creating + +--- + +## MANDATORY SEQUENCE + +### 1. Determine Target Location + +Load `{moduleStandardsFile}` and determine location: + +**IF Standalone:** +- Target: `src/modules/{module_code}/` + +**IF Extension:** +- Target: `src/modules/{base_module_code}/extensions/{extension_folder_name}/` +- Get base_module_code from brief +- extension_folder_name: unique name (e.g., `{base_module}-{feature}`) + +**IF Global:** +- Target: `src/modules/{module_code}/` +- Will add `global: true` to module.yaml + +### 2. Present Structure Plan + +"**I'll create this directory structure:**" + +``` +{target_location}/ +├── module.yaml +├── README.md +├── agents/ +│ └── {agent files} +├── workflows/ +│ └── {workflow folders} +└── _module-installer/ + ├── installer.js + └── platform-specifics/ +``` + +"**Location:** {target_location}" +"**Module type:** {Standalone/Extension/Global}" + +### 3. Confirm and Create + +"**Shall I create the directory structure?**" + +**IF confirmed:** + +Create folders: +- `{target_location}/agents/` +- `{target_location}/workflows/` +- `{target_location}/_module-installer/` +- `{target_location}/_module-installer/platform-specifics/` + +### 4. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-02-structure' to stepsCompleted +- Set targetLocation +- Update status + +### 5. Report Success + +"**✓ Directory structure created at:** {target_location}" + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Directory structure created +✅ Location based on module type +✅ Folders: agents/, workflows/, _module-installer/ +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-03-config.md b/src/modules/bmb/workflows/module/steps-c/step-03-config.md new file mode 100644 index 00000000..c4c02559 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-03-config.md @@ -0,0 +1,118 @@ +--- +name: 'step-03-config' +description: 'Generate module.yaml with install questions' + +nextStepFile: './step-04-installer.md' +moduleYamlConventionsFile: '../../data/module-yaml-conventions.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 3: Module Configuration + +## STEP GOAL: + +Generate module.yaml with install configuration and custom variables. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — configuration expert +- ✅ Follow module.yaml conventions +- ✅ Ask about custom variables + +--- + +## MANDATORY SEQUENCE + +### 1. Load Conventions + +Load `{moduleYamlConventionsFile}` for reference. + +### 2. Generate Base module.yaml + +Create `{targetLocation}/module.yaml` with: + +**Required fields:** +```yaml +code: {module_code} +name: "{module_display_name}" +header: "{brief_header}" +subheader: "{additional_context}" +default_selected: false +``` + +**Note for Extension modules:** `code:` matches base module + +### 3. Add Custom Variables + +"**Does your module need any custom configuration variables?**" + +Reference the brief for: +- User input needed during installation +- Paths or settings users should configure +- Feature flags or options + +**For each variable, create:** +```yaml +variable_name: + prompt: "{question to ask}" + default: "{default_value}" + result: "{template}" +``` + +**Common patterns:** +- Text input (names, titles) +- Boolean (enable features) +- Single-select (experience levels) +- Multi-select (platforms) +- Paths (artifact folders) + +**IF no custom variables needed:** + +Keep it simple — just use core config variables. + +### 4. Write module.yaml + +Write the complete module.yaml to `{targetLocation}/module.yaml` + +### 5. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-03-config' to stepsCompleted +- Note: module.yaml created + +### 6. Report and Confirm + +"**✓ module.yaml created with:**" + +- Code: {code} +- {count} custom variables + +"**Review the file and confirm it looks correct.**" + +### 7. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ module.yaml created +✅ Required fields populated +✅ Custom variables added (if any) +✅ Extension modules use correct code +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-04-installer.md b/src/modules/bmb/workflows/module/steps-c/step-04-installer.md new file mode 100644 index 00000000..229519c3 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-04-installer.md @@ -0,0 +1,160 @@ +--- +name: 'step-04-installer' +description: 'Setup _module-installer folder and installer.js' + +nextStepFile: './step-05-agents.md' +moduleInstallerStandardsFile: '../../data/module-installer-standards.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 4: Module Installer + +## STEP GOAL: + +Setup the _module-installer folder and create installer.js if needed. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — installer expert +- ✅ Not all modules need installers +- ✅ Follow installer patterns + +--- + +## MANDATORY SEQUENCE + +### 1. Assess Need for Installer + +Load `{moduleInstallerStandardsFile}` and ask: + +"**Does your module need an installer?**" + +Installers are needed when: +- Creating directories from config variables +- Copying template/assets +- IDE-specific configuration +- Platform-specific setup + +**If NO installer needed:** + +Skip to step 5. Folder structure already exists. + +**If YES:** Continue to step 4.2 + +### 2. Determine Installer Requirements + +"**What should the installer do?**" + +- Create directories? (which variables) +- Copy assets? (from where) +- IDE configuration? (which IDEs) +- Platform-specific setup? + +### 3. Create installer.js + +Create `{targetLocation}/_module-installer/installer.js`: + +```javascript +const fs = require('fs-extra'); +const path = require('node:path'); +const chalk = require('chalk'); +const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes')); + +/** + * {module_name} Module Installer + */ +async function install(options) { + const { projectRoot, config, installedIDEs, logger } = options; + + try { + logger.log(chalk.blue('Installing {module_name}...')); + + // Create directories + if (config['{variable_name}']) { + const dirConfig = config['{variable_name}'].replace('{project-root}/', ''); + const dirPath = path.join(projectRoot, dirConfig); + if (!(await fs.pathExists(dirPath))) { + logger.log(chalk.yellow(`Creating directory: ${dirConfig}`)); + await fs.ensureDir(dirPath); + } + } + + // IDE-specific configuration + if (installedIDEs && installedIDEs.length > 0) { + for (const ide of installedIDEs) { + await configureForIDE(ide, projectRoot, config, logger); + } + } + + logger.log(chalk.green('✓ {module_name} installation complete')); + return true; + } catch (error) { + logger.error(chalk.red(`Error installing module: ${error.message}`)); + return false; + } +} + +async function configureForIDE(ide, projectRoot, config, logger) { + if (!platformCodes.isValidPlatform(ide)) { + logger.warn(chalk.yellow(`Unknown platform: '${ide}'. Skipping.`)); + return; + } + + const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`); + + try { + if (await fs.pathExists(platformSpecificPath)) { + const platformHandler = require(platformSpecificPath); + if (typeof platformHandler.install === 'function') { + await platformHandler.install({ projectRoot, config, logger }); + } + } + } catch (error) { + logger.warn(chalk.yellow(`Warning: Could not configure ${ide}: ${error.message}`)); + } +} + +module.exports = { install }; +``` + +Customize based on module requirements. + +### 4. Platform-Specific Handlers (Optional) + +If IDE-specific setup needed, ask which IDEs and create: +- `{targetLocation}/_module-installer/platform-specifics/claude-code.js` +- `{targetLocation}/_module-installer/platform-specifics/windsurf.js` +- etc. + +### 5. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-04-installer' to stepsCompleted +- Note: installer created or skipped + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Assessed installer need +✅ installer.js created (if needed) +✅ Platform handlers created (if needed) +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-05-agents.md b/src/modules/bmb/workflows/module/steps-c/step-05-agents.md new file mode 100644 index 00000000..5c89aad2 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-05-agents.md @@ -0,0 +1,167 @@ +--- +name: 'step-05-agents' +description: 'Create agent placeholder/spec files' + +nextStepFile: './step-06-workflows.md' +agentSpecTemplate: '../../templates/agent-spec-template.md' +agentArchitectureFile: '../../data/agent-architecture.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 5: Agent Specs + +## STEP GOAL: + +Create agent placeholder/spec files based on the brief. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — creating agent specs +- ✅ These are specs, not full agents (agent-builder does that) +- ✅ Keep it high-level + +--- + +## MANDATORY SEQUENCE + +### 1. Load Agent Architecture + +Load `{agentArchitectureFile}` for guidance. + +### 2. Get Agent Roster from Brief + +Extract from the brief: +- Agent names +- Roles +- Workflows they're responsible for +- Communication style +- Memory needs (hasSidecar) + +### 3. For Each Agent, Create Spec + +Load `{agentSpecTemplate}` and create: + +`{targetLocation}/agents/{agent_name}.spec.md` + +With content: +```markdown +# Agent Specification: {agent_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-agent workflow +**Created:** {date} + +--- + +## Agent Metadata + +```yaml +agent: + metadata: + id: "_bmad/{module_code}/agents/{agent_file_name}.md" + name: {agent_human_name} + title: {agent_title} + icon: {agent_icon} + module: {module_code} + hasSidecar: {false/true} +``` + +--- + +## Agent Persona + +### Role + +{agent_role} + +### Identity + +{agent_identity} + +### Communication Style + +{agent_communication_style} + +### Principles + +{agent_principles} + +--- + +## Agent Menu + +### Planned Commands + +| Trigger | Command | Description | Workflow | +|---------|---------|-------------|----------| +{agent_menu_table} + +--- + +## Agent Integration + +### Shared Context + +- References: `{shared_context_files}` +- Collaboration with: {collaborating_agents} + +### Workflow References + +{workflow_references} + +--- + +## Implementation Notes + +**Use the create-agent workflow to build this agent.** + +--- + +_Spec created on {date} via BMAD Module workflow_ +``` + +### 4. Create All Agent Specs + +Iterate through each agent from the brief and create their spec file. + +### 5. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-05-agents' to stepsCompleted +- List all agent specs created + +### 6. Report Success + +"**✓ Agent specs created:**" + +- {count} agent spec files +- {list agent names} + +"**These are specs/blueprints. Use the create-agent workflow to build each agent.**" + +### 7. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Agent spec files created for all agents +✅ Each spec has role, workflows, menu triggers +✅ hasSidecar documented (memory decision) +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md b/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md new file mode 100644 index 00000000..7544c0af --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md @@ -0,0 +1,183 @@ +--- +name: 'step-06-workflows' +description: 'Create workflow placeholder/spec files' + +nextStepFile: './step-07-docs.md' +workflowSpecTemplate: '../../templates/workflow-spec-template.md' +buildTrackingFile: '{bmad_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 6: Workflow Specs + +## STEP GOAL: + +Create workflow placeholder/spec files based on the brief. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — creating workflow specs +- ✅ These are specs, not full workflows (workflow-builder does that) +- ✅ Keep it high-level + +--- + +## MANDATORY SEQUENCE + +### 1. Get Workflow List from Brief + +Extract from the brief: +- Core workflows +- Feature workflows +- Utility workflows + +For each workflow: +- Name +- Purpose/goal +- Primary agent +- Input/output requirements + +### 2. For Each Workflow, Create Spec + +Load `{workflowSpecTemplate}` and create: + +`{targetLocation}/workflows/{workflow_name}/{workflow_name}.spec.md` + +With content: +```markdown +# Workflow Specification: {workflow_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-workflow workflow +**Created:** {date} + +--- + +## Workflow Overview + +**Goal:** {workflow_goal} + +**Description:** {workflow_description} + +**Workflow Type:** {workflow_type} + +--- + +## Workflow Structure + +### Entry Point + +```yaml +--- +name: {workflow_name} +description: {workflow_description} +web_bundle: true +installed_path: '{project-root}/_bmad/{module_code}/workflows/{workflow_folder_name}' +--- +``` + +### Mode + +- [ ] Create-only (steps-c/) +- [ ] Tri-modal (steps-c/, steps-e/, steps-v/) + +--- + +## Planned Steps + +| Step | Name | Goal | +|------|------|------| +{workflow_steps_table} + +--- + +## Workflow Inputs + +### Required Inputs + +{required_inputs} + +### Optional Inputs + +{optional_inputs} + +--- + +## Workflow Outputs + +### Output Format + +- [ ] Document-producing +- [ ] Non-document + +### Output Files + +{output_files} + +--- + +## Agent Integration + +### Primary Agent + +{primary_agent} + +### Other Agents + +{other_agents} + +--- + +## Implementation Notes + +**Use the create-workflow workflow to build this workflow.** + +--- + +_Spec created on {date} via BMAD Module workflow_ +``` + +### 3. Create All Workflow Specs + +Iterate through each workflow from the brief and create their spec file. + +### 4. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-06-workflows' to stepsCompleted +- List all workflow specs created + +### 5. Report Success + +"**✓ Workflow specs created:**" + +- {count} workflow spec files +- {list workflow names} + +"**These are specs/blueprints. Use the create-workflow workflow to build each workflow.**" + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Workflow spec files created for all workflows +✅ Each spec has goal, steps, inputs/outputs +✅ Agent associations documented +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-07-docs.md b/src/modules/bmb/workflows/module/steps-c/step-07-docs.md new file mode 100644 index 00000000..320cd004 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-07-docs.md @@ -0,0 +1,402 @@ +--- +name: 'step-07-docs' +description: 'Generate README.md, TODO.md, and docs/ folder' + +nextStepFile: './step-08-complete.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 7: Documentation + +## STEP GOAL: + +Generate README.md, TODO.md, and user documentation in docs/ folder for the module. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — documentation creator +- ✅ README is the user's first impression +- ✅ TODO tracks remaining work +- ✅ docs/ provides user-facing documentation + +--- + +## MANDATORY SEQUENCE + +### 1. Generate README.md + +Create `{targetLocation}/README.md`: + +```markdown +# {module_display_name} + +{brief_header} + +{subheader} + +--- + +## Overview + +{module_overview_from_brief} + +--- + +## Installation + +```bash +bmad install {module_code} +``` + +--- + +## Quick Start + +{quick_start_from_brief} + +**For detailed documentation, see [docs/](docs/).** + +--- + +## Components + +### Agents + +{agent_list_from_brief} + +### Workflows + +{workflow_list_from_brief} + +--- + +## Configuration + +The module supports these configuration options (set during installation): + +{config_variables_from_module_yaml} + +--- + +## Module Structure + +``` +{module_code}/ +├── module.yaml +├── README.md +├── TODO.md +├── docs/ +│ ├── getting-started.md +│ ├── agents.md +│ ├── workflows.md +│ └── examples.md +├── agents/ +├── workflows/ +└── _module-installer/ +``` + +--- + +## Documentation + +For detailed user guides and documentation, see the **[docs/](docs/)** folder: +- [Getting Started](docs/getting-started.md) +- [Agents Reference](docs/agents.md) +- [Workflows Reference](docs/workflows.md) +- [Examples](docs/examples.md) + +--- + +## Development Status + +This module is currently in development. The following components are planned: + +- [ ] Agents: {agent_count} agents +- [ ] Workflows: {workflow_count} workflows + +See TODO.md for detailed status. + +--- + +## Author + +Created via BMAD Module workflow + +--- + +## License + +Part of the BMAD framework. +``` + +### 2. Generate TODO.md + +Create `{targetLocation}/TODO.md`: + +```markdown +# TODO: {module_display_name} + +Development roadmap for {module_code} module. + +--- + +## Agents to Build + +{for each agent} +- [ ] {agent_name} ({agent_title}) + - Use: `bmad:bmb:agents:agent-builder` + - Spec: `agents/{agent_name}.spec.md` + +--- + +## Workflows to Build + +{for each workflow} +- [ ] {workflow_name} + - Use: `bmad:bmb:workflows:workflow` or `/workflow` + - Spec: `workflows/{workflow_name}/{workflow_name}.spec.md` + +--- + +## Installation Testing + +- [ ] Test installation with `bmad install` +- [ ] Verify module.yaml prompts work correctly +- [ ] Test installer.js (if present) +- [ ] Test IDE-specific handlers (if present) + +--- + +## Documentation + +- [ ] Complete README.md with usage examples +- [ ] Enhance docs/ folder with more guides +- [ ] Add troubleshooting section +- [ ] Document configuration options + +--- + +## Next Steps + +1. Build agents using create-agent workflow +2. Build workflows using create-workflow workflow +3. Test installation and functionality +4. Iterate based on testing + +--- + +_Last updated: {date}_ +``` + +### 3. Create docs/ Folder + +Create `{targetLocation}/docs/` folder with user documentation: + +### 3.1. getting-started.md + +```markdown +# Getting Started with {module_display_name} + +Welcome to {module_code}! This guide will help you get up and running. + +--- + +## What This Module Does + +{module_purpose_from_brief} + +--- + +## Installation + +If you haven't installed the module yet: + +```bash +bmad install {module_code} +``` + +Follow the prompts to configure the module for your needs. + +--- + +## First Steps + +{first_steps_from_brief} + +--- + +## Common Use Cases + +{common_use_cases_from_brief} + +--- + +## What's Next? + +- Check out the [Agents Reference](agents.md) to meet your team +- Browse the [Workflows Reference](workflows.md) to see what you can do +- See [Examples](examples.md) for real-world usage + +--- + +## Need Help? + +If you run into issues: +1. Check the troubleshooting section in examples.md +2. Review your module configuration +3. Consult the broader BMAD documentation +``` + +### 3.2. agents.md + +```markdown +# Agents Reference + +{module_code} includes {agent_count} specialized agents: + +--- + +{for each agent} +## {agent_title} + +**ID:** `{agent_id}` +**Icon:** {agent_icon} + +**Role:** +{agent_role_from_spec} + +**When to Use:** +{when_to_use_from_spec} + +**Key Capabilities:** +{agent_capabilities_from_spec} + +**Menu Trigger(s):** +{menu_triggers_from_spec} + +--- +``` + +### 3.3. workflows.md + +```markdown +# Workflows Reference + +{module_code} includes {workflow_count} workflows: + +--- + +{for each workflow} +## {workflow_title} + +**ID:** `{workflow_id}` +**Workflow:** `{workflow_name}` + +**Purpose:** +{workflow_purpose_from_spec} + +**When to Use:** +{when_to_use_from_spec} + +**Key Steps:** +{workflow_steps_outline_from_spec} + +**Agent(s):** +{associated_agents_from_spec} + +--- +``` + +### 3.4. examples.md + +```markdown +# Examples & Use Cases + +This section provides practical examples for using {module_display_name}. + +--- + +## Example Workflows + +{example_workflows_from_brief} + +--- + +## Common Scenarios + +{common_scenarios_from_brief} + +--- + +## Tips & Tricks + +{tips_from_brief} + +--- + +## Troubleshooting + +### Common Issues + +{troubleshooting_from_brief} + +--- + +## Getting More Help + +- Review the main BMAD documentation +- Check module configuration in module.yaml +- Verify all agents and workflows are properly installed +``` + +### 4. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-07-docs' to stepsCompleted +- Note: README.md, TODO.md, and docs/ folder created + +### 5. Report Success + +"**✓ Documentation created:**" + +- README.md — module overview and navigation +- TODO.md — development roadmap +- docs/ — user documentation folder + - getting-started.md — quick start guide + - agents.md — agent reference + - workflows.md — workflow reference + - examples.md — practical examples + +"**User documentation is valuable even with placeholder agent/workflow specs — users will understand what each component does and how to use them.**" + +"**TODO.md tracks the remaining work:**" +- Build {agent_count} agents +- Build {workflow_count} workflows +- Test installation + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ README.md created with all sections +✅ TODO.md created with agent/workflow checklist +✅ docs/ folder created with user documentation +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-08-complete.md b/src/modules/bmb/workflows/module/steps-c/step-08-complete.md new file mode 100644 index 00000000..a5d0657e --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-08-complete.md @@ -0,0 +1,123 @@ +--- +name: 'step-08-complete' +description: 'Finalize, offer to run validation' + +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +validationWorkflow: '../steps-v/step-01-validate.md' +--- + +# Step 8: Complete + +## STEP GOAL: + +Finalize the module build, update tracking, and offer to run validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — completing the build +- ✅ Celebrate what was created +- ✅ Guide next steps + +--- + +## MANDATORY SEQUENCE + +### 1. Final Build Summary + +"**🎉 Module structure build complete!**" + +**Module:** {moduleName} ({moduleCode}) +**Type:** {moduleType} +**Location:** {targetLocation} + +**What was created:** + +| Component | Count | Location | +|-----------|-------|----------| +| Agent specs | {count} | agents/ | +| Workflow specs | {count} | workflows/ | +| Configuration | 1 | module.yaml | +| Documentation | 2 | README.md, TODO.md | +| Installer | {yes/no} | _module-installer/ | + +### 2. Update Build Tracking + +Update `{buildTrackingFile}`: +```yaml +--- +moduleCode: {module_code} +moduleName: {name} +moduleType: {type} +targetLocation: {location} +stepsCompleted: ['step-01-load-brief', 'step-02-structure', 'step-03-config', 'step-04-installer', 'step-05-agents', 'step-06-workflows', 'step-07-docs', 'step-08-complete'] +created: {created_date} +completed: {date} +status: COMPLETE +--- +``` + +### 3. Next Steps + +"**Your module structure is ready! Here's what to do next:**" + +1. **Review the build** — Check {targetLocation} +2. **Build agents** — Use `bmad:bmb:agents:agent-builder` for each agent spec +3. **Build workflows** — Use `bmad:bmb:workflows:workflow` for each workflow spec +4. **Test installation** — Run `bmad install {module_code}` +5. **Iterate** — Refine based on testing + +### 4. Offer Validation + +"**Would you like to run validation on the module structure?**" + +Validation checks: +- File structure compliance +- module.yaml correctness +- Spec completeness +- Installation readiness + +### 5. MENU OPTIONS + +**Select an Option:** [V] Validate Module [D] Done + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input + +#### Menu Handling Logic: + +- IF V: Load `{validationWorkflow}` to run validation +- IF D: Celebration message, workflow complete +- IF Any other: Help user, then redisplay menu + +### 6. Completion Message (if Done selected) + +"**🚀 You've built a module structure for BMAD!**" + +"**Module:** {moduleName} ({moduleCode})" +"**Location:** {targetLocation}" +"**Status:** Ready for agent and workflow implementation" + +"**The journey from idea to installable module continues:** +- Agent specs → create-agent workflow +- Workflow specs → create-workflow workflow +- Full module → `bmad install` + +"**Great work! Let's build something amazing.** ✨" + +--- + +## Success Metrics + +✅ Build tracking marked COMPLETE +✅ Summary presented to user +✅ Next steps clearly explained +✅ Validation offered (optional) diff --git a/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md b/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md new file mode 100644 index 00000000..40ee3a50 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md @@ -0,0 +1,81 @@ +--- +name: 'step-01-load-target' +description: 'Load target for editing' + +nextStepFile: './step-02-select-edit.md' +moduleStandardsFile: '../../data/module-standards.md' +--- + +# Step 1: Load Target (Edit Mode) + +## STEP GOAL: + +Load the target (brief, module.yaml, agent specs, or workflow specs) for editing. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — helpful, ready to assist +- ✅ Understand what we're editing + +--- + +## MANDATORY SEQUENCE + +### 1. Determine Edit Target + +"**What would you like to edit?**" + +Options: +- **[B]rief** — Module brief from Brief mode +- **[Y]aml** — module.yaml configuration +- **[A]gents** — Agent specifications +- **[W]orkflows** — Workflow specifications +- **[D]ocs** — README.md or TODO.md + +### 2. Load Target + +Based on selection, load the target file(s). + +**IF Brief:** +- Path: `{bmb_creations_output_folder}/modules/module-brief-{code}.md` + +**IF Yaml:** +- Path: `src/modules/{code}/module.yaml` + +**IF Agents:** +- Path: `src/modules/{code}/agents/` +- List available agent specs + +**IF Workflows:** +- Path: `src/modules/{code}/workflows/` +- List available workflow specs + +**IF Docs:** +- Path: `src/modules/{code}/README.md` or `TODO.md` + +### 3. Display Current Content + +Show the current content of the target file. + +"**Here's the current content:**" + +{display relevant sections or summary} + +### 4. Proceed to Selection + +"**What would you like to change?**" + +Load `{nextStepFile}` to select the edit type. + +--- + +## Success Metrics + +✅ Target loaded +✅ Current content displayed +✅ Ready to select edit type diff --git a/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md b/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md new file mode 100644 index 00000000..be1baf74 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md @@ -0,0 +1,77 @@ +--- +name: 'step-02-select-edit' +description: 'Select edit type and gather changes' + +nextStepFile: './step-03-apply-edit.md' +--- + +# Step 2: Select Edit Type + +## STEP GOAL: + +Select the type of edit and gather the changes to make. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — precise, collaborative +- ✅ Understand the change before making it + +--- + +## MANDATORY SEQUENCE + +### 1. Select Edit Type + +"**What type of edit would you like to make?**" + +- **[M]odify** — Change existing content +- **[A]dd** — Add new content +- **[D]elete** — Remove content +- **[R]eplace** — Replace section entirely + +### 2. Gather Edit Details + +**IF Modify:** +"**Which section do you want to modify?**" +"What should it change to?" + +**IF Add:** +"**What do you want to add?**" +"**Where should it go?**" + +**IF Delete:** +"**What do you want to remove?**" + +**IF Replace:** +"**What section should be replaced?**" +"**What's the new content?**" + +### 3. Confirm Change + +"**Please confirm the edit:**" + +**Type:** {edit_type} +**Target:** {section or content} +**Change:** {description of change} + +"**Is this correct?**" + +### 4. Store Edit Plan + +Store the edit plan for the next step. + +Load `{nextStepFile}` to apply the edit. + +--- + +## Success Metrics + +✅ Edit type selected +✅ Change details gathered +✅ User confirmed +✅ Edit plan stored diff --git a/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md b/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md new file mode 100644 index 00000000..a6dd6afa --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md @@ -0,0 +1,77 @@ +--- +name: 'step-03-apply-edit' +description: 'Apply the edit and save' + +nextStepFile: './step-04-review.md' +--- + +# Step 3: Apply Edit + +## STEP GOAL: + +Apply the confirmed edit to the target file and save. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — making changes +- ✅ Apply edits precisely + +--- + +## MANDATORY SEQUENCE + +### 1. Load Target File + +Read the complete target file. + +### 2. Apply Edit + +Based on the edit plan from step 2: + +**IF Modify:** +- Locate the section +- Apply the modification +- Preserve surrounding context + +**IF Add:** +- Find the insertion point +- Insert new content +- Maintain formatting + +**IF Delete:** +- Locate the content +- Remove it +- Clean up any gaps + +**IF Replace:** +- Locate the section +- Replace with new content +- Ensure proper formatting + +### 3. Save Changes + +Write the modified content back to the target file. + +### 4. Report Success + +"**✓ Edit applied!**" + +**File:** {file_path} +**Change:** {summary_of_change} + +### 5. Proceed to Review + +Load `{nextStepFile}` to review the changes. + +--- + +## Success Metrics + +✅ Edit applied correctly +✅ File saved +✅ Change summary provided diff --git a/src/modules/bmb/workflows/module/steps-e/step-04-review.md b/src/modules/bmb/workflows/module/steps-e/step-04-review.md new file mode 100644 index 00000000..6c0e79c9 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-04-review.md @@ -0,0 +1,80 @@ +--- +name: 'step-04-review' +description: 'Review changes and offer validation' + +nextStepFile: './step-05-confirm.md' +validationWorkflow: '../steps-v/step-01-load-target.md' +--- + +# Step 4: Review Changes + +## STEP GOAL: + +Review the applied changes and offer to run validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — confirming changes +- ✅ Ensure user is satisfied + +--- + +## MANDATORY SEQUENCE + +### 1. Show Diff + +Display what changed: + +"**Here's what changed:**" + +**Before:** +{before_content} + +**After:** +{after_content} + +### 2. Confirm Satisfaction + +"**Are you happy with this change?**" + +- **[Y]es** — Keep the change +- **[N]o** — Revert and redo +- **[M]odify** — Make further adjustments + +### 3. Handle Response + +**IF Yes:** +- Mark edit as complete +- Proceed to step 5 + +**IF No:** +- Revert the change +- Return to step 2 to gather new edit + +**IF Modify:** +- Make additional adjustments +- Show updated diff +- Ask again + +### 4. Offer Validation + +"**Would you like to run validation after this edit?**" + +- Validation can check for any issues introduced + +### 5. Proceed to Confirm + +Load `{nextStepFile}` to confirm completion. + +--- + +## Success Metrics + +✅ Changes reviewed +✅ User satisfaction confirmed +✅ Validation offered diff --git a/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md b/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md new file mode 100644 index 00000000..486fb9d4 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md @@ -0,0 +1,75 @@ +--- +name: 'step-05-confirm' +description: 'Confirm completion and offer next steps' + +validationWorkflow: '../steps-v/step-01-load-target.md' +--- + +# Step 5: Confirm Completion + +## STEP GOAL: + +Confirm edit completion and offer next steps including validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — completing the job +- ✅ Guide next steps + +--- + +## MANDATORY SEQUENCE + +### 1. Summary of Changes + +"**✓ Edit complete!**" + +**File edited:** {file_path} +**Edit type:** {edit_type} +**Summary:** {summary_of_change} + +### 2. Offer Next Actions + +"**What would you like to do next?**" + +- **[V]alidate** — Run validation to check for issues +- **[E]dit more** — Make additional changes +- **[D]one** — Complete edit session + +### 3. Handle Response + +**IF Validate:** +"**Loading validation workflow...**" +Load `{validationWorkflow}` + +**IF Edit more:** +"**Loading edit selection...**" +Return to step 1 + +**IF Done:** +"**Edit session complete!**" +Summary of what was accomplished. + +### 4. Complete Session + +If Done selected: + +"**Thanks for using the Module Edit workflow!**" + +"**Summary:**" +- Files edited: {count} +- Changes made: {summary} + +--- + +## Success Metrics + +✅ Edit confirmed complete +✅ Next actions offered +✅ Validation accessible +✅ Session properly closed diff --git a/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md b/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md new file mode 100644 index 00000000..08237f3e --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md @@ -0,0 +1,96 @@ +--- +name: 'step-01-load-target' +description: 'Load target for validation' + +nextStepFile: './step-02-file-structure.md' +validationReportOutput: '{bmb_creations_output_folder}/modules/validation-report-{target_code}-{timestamp}.md' +--- + +# Step 1: Load Target (Validate Mode) + +## STEP GOAL: + +Load the target (brief, module, agent specs, or workflow specs) for validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — thorough, systematic +- ✅ Understand what we're validating + +--- + +## MANDATORY SEQUENCE + +### 1. Determine Validation Target + +"**What would you like to validate?**" + +Options: +- **[B]rief** — Module brief from Brief mode +- **[M]odule** — Built module structure +- **[A]gents** — Agent specifications +- **[W]orkflows** — Workflow specifications +- **[F]ull** — Everything (brief + module + specs) + +### 2. Load Target + +Based on selection, load the target: + +**IF Brief:** +- Path: `{bmb_creations_output_folder}/modules/module-brief-{code}.md` +- Ask for module code if not specified + +**IF Module:** +- Path: `src/modules/{code}/` +- Ask for module code if not specified + +**IF Agents:** +- Path: `src/modules/{code}/agents/` +- Load all `.spec.md` or `.agent.yaml` files + +**IF Workflows:** +- Path: `src/modules/{code}/workflows/` +- Load all `.spec.md` files + +**IF Full:** +- Load everything above for a module + +### 3. Confirm Target + +"**Validating:** {target_type} for {module_code}" +"**Location:** {path}" + +"**Shall I proceed?**" + +### 4. Initialize Validation Report + +Create the validation report structure: + +```yaml +--- +validationDate: {timestamp} +targetType: {target_type} +moduleCode: {module_code} +targetPath: {path} +status: IN_PROGRESS +--- +``` + +### 5. Proceed to Validation + +"**Starting validation checks...**" + +Load `{nextStepFile}` to begin file structure validation. + +--- + +## Success Metrics + +✅ Target loaded +✅ Validation report initialized +✅ User confirmed diff --git a/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md b/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md new file mode 100644 index 00000000..3253964c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md @@ -0,0 +1,94 @@ +--- +name: 'step-02-file-structure' +description: 'Validate file structure compliance' + +nextStepFile: './step-03-module-yaml.md' +moduleStandardsFile: '../../data/module-standards.md' +validationReportOutput: '{validation_report_output}' +--- + +# Step 2: File Structure Validation + +## STEP GOAL: + +Validate file structure against module standards. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — checking structure +- ✅ Reference standards, ensure compliance + +--- + +## MANDATORY SEQUENCE + +### 1. Load Standards + +Load `{moduleStandardsFile}` for reference. + +### 2. Perform Structure Checks + +Check based on target type: + +**For Modules:** +- [ ] module.yaml exists +- [ ] README.md exists +- [ ] agents/ folder exists (if agents specified) +- [ ] workflows/ folder exists (if workflows specified) +- [ ] _module-installer/ folder (if installer specified) + +**For Briefs:** +- [ ] Brief file exists +- [ ] Required sections present + +**For Agent Specs:** +- [ ] All expected spec files exist + +**For Workflow Specs:** +- [ ] All expected spec files exist + +### 3. Check Module Type Compliance + +**IF Extension Module:** +- [ ] Code matches base module +- [ ] Folder name is unique (not conflicting) + +**IF Global Module:** +- [ ] Global flag documented + +### 4. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## File Structure Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Checks:** +{list each check with result} + +**Issues Found:** +{any structural problems} +``` + +### 5. Auto-Proceed + +"**✓ File structure check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All structure checks performed +✅ Results recorded +✅ Auto-proceeds to next validation diff --git a/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md b/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md new file mode 100644 index 00000000..ba6a13c0 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md @@ -0,0 +1,99 @@ +--- +name: 'step-03-module-yaml' +description: 'Validate module.yaml against conventions' + +nextStepFile: './step-04-agent-specs.md' +moduleYamlConventionsFile: '../../data/module-yaml-conventions.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 3: module.yaml Validation + +## STEP GOAL: + +Validate module.yaml formatting and conventions. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — checking configuration +- ✅ Ensure proper YAML syntax + +--- + +## MANDATORY SEQUENCE + +### 1. Load module.yaml + +Read `{targetPath}/module.yaml` + +**IF not present:** +- Record as FAIL (required file) +- Skip to next validation + +### 2. Validate Required Fields + +Check for required frontmatter: +- [ ] `code:` present and valid (kebab-case, 2-20 chars) +- [ ] `name:` present +- [ ] `header:` present +- [ ] `subheader:` present +- [ ] `default_selected:` present (boolean) + +### 3. Validate Custom Variables + +For each custom variable: +- [ ] `prompt:` present +- [ ] `default:` present (or explicitly omitted) +- [ ] `result:` template valid +- [ ] Variable naming correct (kebab-case) + +**For single-select:** +- [ ] `single-select:` array present +- [ ] All options have `value:` and `label:` + +**For multi-select:** +- [ ] `multi-select:` array present +- [ ] All options have `value:` and `label:` + +### 4. Validate Extension Module Code + +**IF Extension:** +- [ ] `code:` matches base module code +- [ ] This is intentional (not an error) + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## module.yaml Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Required Fields:** {status} +**Custom Variables:** {count} variables +**Issues Found:** +{list any issues} +``` + +### 6. Auto-Proceed + +"**✓ module.yaml check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All module.yaml checks performed +✅ Results recorded +✅ Auto-proceeds to next validation diff --git a/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md b/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md new file mode 100644 index 00000000..3a2d931e --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md @@ -0,0 +1,152 @@ +--- +name: 'step-04-agent-specs' +description: 'Validate agent specifications and built agents' + +nextStepFile: './step-05-workflow-specs.md' +agentSpecTemplate: '../../templates/agent-spec-template.md' +agentArchitectureFile: '../../data/agent-architecture.md' +agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 4: Agent Specs Validation + +## STEP GOAL: + +Validate agent specifications and/or built agents, distinguishing between placeholder specs and fully implemented agents. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — dual-mode checking +- ✅ Specs are expected, built agents are great +- ✅ Track status of each agent + +--- + +## MANDATORY SEQUENCE + +### 1. Load Agent Files + +Find all agent files in `{targetPath}/agents/`: +- `.spec.md` files (placeholder specs) +- `.agent.yaml` files (built agents) + +### 2. Categorize Agents + +For each agent found, determine status: + +**Built Agents (.agent.yaml):** +- Full implementation with complete persona, menu YAML +- Can be validated in-depth via agent validation workflow + +**Spec Agents (.spec.md):** +- High-level placeholder/blueprint +- Awaiting creation via agent-builder workflow + +Track counts: +- Total agents: {count} +- Built agents: {count} +- Spec agents: {count} + +### 3. Validate Spec Agents (.spec.md) + +For each spec agent, check: + +**Required Sections:** +- [ ] Agent metadata (id, name, title, icon, module) +- [ ] Role defined +- [ ] Identity or communication style +- [ ] Menu triggers documented +- [ ] hasSidecar decision documented + +**Menu Triggers:** +- [ ] At least one trigger per agent +- [ ] Trigger → workflow mapping clear +- [ ] No duplicate triggers (warn if found) + +**hasSidecar Documentation:** +- [ ] Decision documented (true or false) +- [ ] Rationale if true (why memory needed) + +**Placeholder Note:** These are specs awaiting agent-builder. + +### 4. Validate Built Agents (.agent.yaml) + +For each built agent, check: + +**Frontmatter Completeness:** +- [ ] agent.metadata exists +- [ ] agent.persona exists +- [ ] agent.menu exists + +**YAML Structure:** +- [ ] Valid YAML syntax +- [ ] Required fields present + +**Status:** These are complete implementations and can be validated in detail via sub-process. + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Agent Specs Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Agent Summary:** +- Total Agents: {count} +- Built Agents: {count} {list} +- Spec Agents: {count} {list} + +**Built Agents:** +{for each built agent} +- **{name}**: {status} - Ready for detailed validation via agent workflow + +**Spec Agents:** +{for each spec agent} +- **{name}**: {status} - Placeholder awaiting agent-builder + +**Issues Found:** +{list any issues} + +**Recommendations:** +{if specs exist} +- Use `bmad:bmb:agents:agent-builder` to create {spec agent names} +- After building agents, re-run validation to verify compliance +{endif} +``` + +### 6. Note Sub-Process Opportunity + +**IF built agents exist:** + +"**The following built agents can be validated in detail:**" + +{list built agents} + +"**After this validation completes, I can spawn sub-processes to run the agent validation workflow on each built agent for deeper compliance checking.**" + +### 7. Auto-Proceed + +"**✓ Agent specs check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All agent files checked +✅ Status tracked (spec vs built) +✅ hasSidecar decisions validated +✅ Recommendations for specs documented +✅ Sub-process opportunity noted diff --git a/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md b/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md new file mode 100644 index 00000000..24490bdf --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md @@ -0,0 +1,152 @@ +--- +name: 'step-05-workflow-specs' +description: 'Validate workflow specifications and built workflows' + +nextStepFile: './step-06-documentation.md' +workflowSpecTemplate: '../../templates/workflow-spec-template.md' +workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 5: Workflow Specs Validation + +## STEP GOAL: + +Validate workflow specifications and/or built workflows, distinguishing between placeholder specs and fully implemented workflows. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — dual-mode checking +- ✅ Specs are expected, built workflows are great +- ✅ Track status of each workflow + +--- + +## MANDATORY SEQUENCE + +### 1. Load Workflow Files + +Find all workflow files in `{targetPath}/workflows/`: +- `.spec.md` files (placeholder specs) +- `workflow.md` files (built workflows) + +### 2. Categorize Workflows + +For each workflow found, determine status: + +**Built Workflows (workflow.md with steps/ folder):** +- Full implementation with step files, data, templates +- Can be validated in-depth via workflow validation workflow + +**Spec Workflows (.spec.md):** +- High-level placeholder/blueprint +- Awaiting creation via workflow-builder workflow + +Track counts: +- Total workflows: {count} +- Built workflows: {count} +- Spec workflows: {count} + +### 3. Validate Spec Workflows (.spec.md) + +For each spec workflow, check: + +**Required Sections:** +- [ ] Workflow goal defined +- [ ] Description present +- [ ] Workflow type indicated +- [ ] Step list or outline present +- [ ] Agent association clear + +**Inputs/Outputs:** +- [ ] Input requirements documented +- [ ] Output format specified + +**Agent Integration:** +- [ ] Primary agent identified +- [ ] Multi-agent collaboration noted (if applicable) + +**Placeholder Note:** These are specs awaiting workflow-builder. + +### 4. Validate Built Workflows (workflow.md) + +For each built workflow, check: + +**Workflow Structure:** +- [ ] workflow.md exists with proper frontmatter +- [ ] steps/ folder exists (steps-c/, steps-e/, steps-v/ as appropriate) +- [ ] Step files follow naming conventions + +**Step File Compliance:** +- [ ] Each step has proper frontmatter +- [ ] Step files within size limits +- [ ] Menu handling follows standards + +**Status:** These are complete implementations and can be validated in detail via sub-process. + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Workflow Specs Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Workflow Summary:** +- Total Workflows: {count} +- Built Workflows: {count} {list} +- Spec Workflows: {count} {list} + +**Built Workflows:** +{for each built workflow} +- **{name}**: {status} - Ready for detailed validation via workflow workflow + +**Spec Workflows:** +{for each spec workflow} +- **{name}**: {status} - Placeholder awaiting workflow-builder + +**Issues Found:** +{list any issues} + +**Recommendations:** +{if specs exist} +- Use `bmad:bmb:workflows:workflow` or `/workflow` to create {spec workflow names} +- After building workflows, re-run validation to verify compliance +{endif} +``` + +### 6. Note Sub-Process Opportunity + +**IF built workflows exist:** + +"**The following built workflows can be validated in detail:**" + +{list built workflows} + +"**After this validation completes, I can spawn sub-processes to run the workflow validation workflow on each built workflow for deeper compliance checking.**" + +### 7. Auto-Proceed + +"**✓ Workflow specs check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All workflow files checked +✅ Status tracked (spec vs built) +✅ Agent associations validated +✅ Recommendations for specs documented +✅ Sub-process opportunity noted diff --git a/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md b/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md new file mode 100644 index 00000000..d71a99eb --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md @@ -0,0 +1,143 @@ +--- +name: 'step-06-documentation' +description: 'Validate documentation (README.md, TODO.md, docs/)' + +nextStepFile: './step-07-installation.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +moduleBriefPath: '{module_brief_path}' +--- + +# Step 6: Documentation Validation + +## STEP GOAL: + +Validate module documentation completeness, including user-facing docs in docs/ folder. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — checking docs +- ✅ Documentation matters for usability +- ✅ User docs can be generated from placeholder plans + +--- + +## MANDATORY SEQUENCE + +### 1. Load Documentation Files + +Check for: +- `{targetPath}/README.md` (module overview) +- `{targetPath}/TODO.md` (development roadmap) +- `{targetPath}/docs/` (user documentation folder) + +### 2. Validate README.md + +**Required Sections:** +- [ ] Module name and description +- [ ] Installation instructions +- [ ] Components section (agents, workflows) +- [ ] Usage examples or quick start +- [ ] Module structure +- [ ] Link to docs/ folder + +**Quality Checks:** +- [ ] Clear description of what module does +- [ ] Installation command shown +- [ ] Agent/workflow lists complete +- [ ] References user documentation + +### 3. Validate TODO.md + +**Required Content:** +- [ ] Agent build checklist +- [ ] Workflow build checklist +- [ ] Testing section +- [ ] Next steps + +### 4. Validate docs/ Folder + +**For Custom Modules:** +- [ ] docs/ folder exists +- [ ] Contains user-facing documentation +- [ ] Documentation is clear and helpful + +**Valid docs/ Contents (may include):** +- `getting-started.md` — Quick start guide +- `agents.md` — Agent documentation +- `workflows.md` — Workflow documentation +- `examples.md` — Usage examples +- `configuration.md` — Setup/configuration guide +- `troubleshooting.md` — Common issues and solutions + +**Quality Check:** +- [ ] Even with placeholder agent/workflow specs, user docs should provide useful information +- [ ] Documentation references agents/workflows by name +- [ ] Clear what functionality exists vs what is planned + +### 5. Generate User Docs Recommendation + +**IF docs/ missing or incomplete:** + +"**User documentation can be generated from module brief and agent/workflow specs.**" + +"**Even with placeholder plans, you can create helpful user documentation that describes:** +- What each agent does and when to use it +- What workflows are available and their purpose +- How to get started with the module +- Configuration options (from module.yaml)" + +### 6. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Documentation Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Root Documentation:** +- **README.md:** {present/missing} - {status} +- **TODO.md:** {present/missing} - {status} + +**User Documentation (docs/):** +- **docs/ folder:** {present/missing} - {status} +- **Documentation files:** {count} files found + +**Docs Contents:** +{list files in docs/ folder} + +**Issues Found:** +{list any issues} + +**Recommendations:** +{if docs/ missing or incomplete} +- Generate user documentation from module brief and specs +- Create getting-started.md, agents.md, workflows.md +- User docs are valuable even with placeholder plans +{endif} +``` + +### 7. Auto-Proceed + +"**✓ Documentation check complete.**" + +Proceeding to installation validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All documentation checked +✅ Required sections validated +✅ docs/ folder presence verified +✅ User documentation quality assessed +✅ Recommendations documented diff --git a/src/modules/bmb/workflows/module/steps-v/step-07-installation.md b/src/modules/bmb/workflows/module/steps-v/step-07-installation.md new file mode 100644 index 00000000..ee11e163 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-07-installation.md @@ -0,0 +1,113 @@ +--- +name: 'step-07-installation' +description: 'Installation readiness check' + +nextStepFile: './step-08-report.md' +moduleInstallerStandardsFile: '../../data/module-installer-standards.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 7: Installation Readiness + +## STEP GOAL: + +Check if the module is ready for installation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — checking readiness +- ✅ Installation should work + +--- + +## MANDATORY SEQUENCE + +### 1. Check Installer + +**IF `_module-installer/` exists:** +- [ ] `installer.js` present +- [ ] Has valid `install()` function +- [ ] Platform-specific handlers (if any IDEs supported) + +**IF `_module-installer/` doesn't exist:** +- Note: Module may not need installer +- Check if this is intentional + +### 2. Validate installer.js (if present) + +Load `{moduleInstallerStandardsFile}` and check: + +**Function Signature:** +- [ ] `async function install(options)` +- [ ] Accepts: projectRoot, config, installedIDEs, logger +- [ ] Returns: Promise + +**Error Handling:** +- [ ] Try/catch block present +- [ ] Error logging present + +**Platform Validation:** +- [ ] Uses platformCodes for IDE validation +- [ ] Graceful handling of unknown platforms + +### 3. Check module.yaml Install Variables + +**IF custom variables exist:** +- [ ] All variables have prompts +- [ ] Defaults are reasonable +- [ ] Result templates are valid + +**Path Variables:** +- [ ] Paths use `{project-root}/` prefix +- [ ] Output paths are user-configurable + +### 4. Module Type Installation + +**IF Extension:** +- [ ] `code:` matches base (for proper merge) +- [ ] Folder name is unique + +**IF Global:** +- [ ] `global: true` or documented +- [ ] Global impact is minimal/intentional + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Installation Readiness + +**Status:** {PASS/FAIL/WARNINGS} + +**Installer:** {present/missing} - {status} +**Install Variables:** {count} variables +**Ready to Install:** {yes/no} + +**Issues Found:** +{list any issues} +``` + +### 6. Auto-Proceed + +"**✓ Installation readiness check complete.**" + +Proceeding to final report... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ Installation readiness assessed +✅ Installer validated (if present) +✅ Module type compatibility checked +✅ Results recorded diff --git a/src/modules/bmb/workflows/module/steps-v/step-08-report.md b/src/modules/bmb/workflows/module/steps-v/step-08-report.md new file mode 100644 index 00000000..f5211592 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-08-report.md @@ -0,0 +1,197 @@ +--- +name: 'step-08-report' +description: 'Generate final validation report' + +validationReportOutput: '{validation_report_output}' +agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md' +workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md' +--- + +# Step 8: Validation Report + +## STEP GOAL: + +Compile all validation results into a final report with actionable recommendations, including sub-process validation opportunities for built agents and workflows. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — reporting results +- ✅ Clear, actionable feedback +- ✅ Sub-process validation for built components + +--- + +## MANDATORY SEQUENCE + +### 1. Compile Overall Status + +Review all validation sections and determine overall status: + +**PASS:** All checks passed, ready to proceed +**WARNINGS:** Minor issues found, can proceed with fixes +**FAIL:** Critical issues found, must fix before proceeding + +### 2. Generate Summary + +Add to `{validationReportOutput}`: + +```markdown +--- + +## Overall Summary + +**Status:** {PASS/WARNINGS/FAIL} + +**Breakdown:** +- File Structure: {status} +- module.yaml: {status} +- Agent Specs: {status} ({built_count} built, {spec_count} specs) +- Workflow Specs: {status} ({built_count} built, {spec_count} specs) +- Documentation: {status} +- Installation Readiness: {status} + +--- + +## Component Status + +### Agents +- **Built Agents:** {count} — {list} +- **Spec Agents:** {count} — {list} + +### Workflows +- **Built Workflows:** {count} — {list} +- **Spec Workflows:** {count} — {list} + +--- + +## Recommendations + +{priority-listed-recommendations} + +### Priority 1 - Critical (must fix) + +{critical_issues} + +### Priority 2 - High (should fix) + +{high_priority_issues} + +### Priority 3 - Medium (nice to have) + +{medium_priority_issues} + +--- + +## Sub-Process Validation + +{if built_agents_exist} +### Built Agent Deep Validation + +The following built agents can be validated in detail using the agent validation workflow: + +{for each built_agent} +- **{agent_name}** — Use `{agentValidationWorkflow}` + +**Recommendation:** Run agent validation workflow on each built agent to verify: +- Frontmatter completeness +- Persona quality +- Menu structure compliance +- Sidecar validation + +**After fixing any module-level issues, I can spawn sub-processes to validate each built agent in parallel.** +{endif} + +{if built_workflows_exist} +### Built Workflow Deep Validation + +The following built workflows can be validated in detail using the workflow validation workflow: + +{for each built_workflow} +- **{workflow_name}** — Use `{workflowValidationWorkflow}` + +**Recommendation:** Run workflow validation workflow on each built workflow to verify: +- Step file compliance +- Tri-modal structure (steps-c/steps-e/steps-v/) +- Frontmatter completeness +- Size limits compliance + +**After fixing any module-level issues, I can spawn sub-processes to validate each built workflow in parallel.** +{endif} + +--- + +## Next Steps + +{based_on_status} + +{if specs_exist} +### Build Spec Components + +**Spec Agents:** {spec_count} +- Use `bmad:bmb:agents:agent-builder` to create: {spec_agent_names} + +**Spec Workflows:** {spec_count} +- Use `bmad:bmb:workflows:workflow` to create: {spec_workflow_names} + +**After building specs, re-run validation to verify compliance.** +{endif} + +--- + +**Validation Completed:** {timestamp} +``` + +### 3. Present Report + +"**✓ Validation complete!**" + +**Overall Status:** {overall_status} + +**Report saved to:** `{validationReportOutput}` + +{if built_components_exist} +"**Built components found:**" +- Built Agents: {count} +- Built Workflows: {count} + +"**These can be validated in depth via sub-process.**" +{endif} + +### 4. Offer Next Actions + +"**What would you like to do?**" + +- **[R]ead report** — Show the full validation report +- **[S]ub-process validation** — Run deep validation on built agents/workflows +- **[F]ix issues** — Edit mode to fix identified problems +- **[D]one** — Complete validation + +### 5. Menu Handling + +- IF R: Display the full report +- IF S: + - {if built_components_exist} + - Offer to run agent validation on built agents + - Offer to run workflow validation on built workflows + - Can run in parallel for efficiency + - {else} + - "No built components found for sub-process validation." + - {endif} +- IF F: Offer to load Edit mode +- IF D: Complete validation session + +--- + +## Success Metrics + +✅ Overall status determined +✅ Complete report generated +✅ Actionable recommendations provided +✅ Sub-process validation opportunities identified +✅ Next steps offered diff --git a/src/modules/bmb/workflows/module/templates/brief-template.md b/src/modules/bmb/workflows/module/templates/brief-template.md new file mode 100644 index 00000000..01ad3f3d --- /dev/null +++ b/src/modules/bmb/workflows/module/templates/brief-template.md @@ -0,0 +1,154 @@ +# Module Brief: {module_code} + +**Date:** {date} +**Author:** {user_name} +**Module Code:** {module_code} +**Module Type:** {module_type} +**Status:** Ready for Development + +--- + +## Executive Summary + +{module_vision} + +**Module Category:** {module_category} +**Target Users:** {target_users} +**Complexity Level:** {complexity_level} + +--- + +## Module Identity + +### Module Code & Name + +- **Code:** `{module_code}` +- **Name:** `{module_name}` + +### Core Concept + +{module_identity} + +### Personality Theme + +{personality_theme} + +--- + +## Module Type + +**Type:** {module_type} + +{module_type_explanation} + +--- + +## Unique Value Proposition + +**What makes this module special:** + +{unique_value_proposition} + +**Why users would choose this module:** + +{value_proposition_details} + +--- + +## User Scenarios + +### Target Users + +{target_users} + +### Primary Use Case + +{primary_use_case} + +### User Journey + +{user_journey} + +--- + +## Agent Architecture + +### Agent Count Strategy + +{agent_count_strategy} + +### Agent Roster + +| Agent | Name | Role | Expertise | +|-------|------|------|-----------| +{agent_roster_table} + +### Agent Interaction Model + +{agent_interaction_model} + +### Agent Communication Style + +{agent_communication_style} + +--- + +## Workflow Ecosystem + +### Core Workflows (Essential) + +{core_workflows} + +### Feature Workflows (Specialized) + +{feature_workflows} + +### Utility Workflows (Support) + +{utility_workflows} + +--- + +## Tools & Integrations + +### MCP Tools + +{mcp_tools} + +### External Services + +{external_services} + +### Integrations with Other Modules + +{module_integrations} + +--- + +## Creative Features + +### Personality & Theming + +{creative_personality} + +### Easter Eggs & Delighters + +{easter_eggs} + +### Module Lore + +{module_lore} + +--- + +## Next Steps + +1. **Review this brief** — Ensure the vision is clear +2. **Run create-module workflow** — Build the module structure +3. **Create agents** — Use create-agent workflow for each agent +4. **Create workflows** — Use create-workflow workflow for each workflow +5. **Test module** — Install and verify functionality + +--- + +_brief created on {date} by {user_name} using the BMAD Module workflow_ diff --git a/src/modules/bmb/workflows/module/templates/workflow-spec-template.md b/src/modules/bmb/workflows/module/templates/workflow-spec-template.md new file mode 100644 index 00000000..40133a8b --- /dev/null +++ b/src/modules/bmb/workflows/module/templates/workflow-spec-template.md @@ -0,0 +1,96 @@ +# Workflow Specification: {workflow_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-workflow workflow +**Created:** {date} + +--- + +## Workflow Overview + +**Goal:** {workflow_goal} + +**Description:** {workflow_description} + +**Workflow Type:** {workflow_type} + +--- + +## Workflow Structure + +### Entry Point + +```yaml +--- +name: {workflow_name} +description: {workflow_description} +web_bundle: true +installed_path: '{project-root}/_bmad/{module_code}/workflows/{workflow_folder_name}' +--- +``` + +### Mode + +- [ ] Create-only (steps-c/) +- [ ] Tri-modal (steps-c/, steps-e/, steps-v/) + +--- + +## Planned Steps + +| Step | Name | Goal | +|------|------|------| +{workflow_steps_table} + +--- + +## Workflow Inputs + +### Required Inputs + +{required_inputs} + +### Optional Inputs + +{optional_inputs} + +--- + +## Workflow Outputs + +### Output Format + +- [ ] Document-producing +- [ ] Non-document + +### Output Files + +{output_files} + +--- + +## Agent Integration + +### Primary Agent + +{primary_agent} + +### Other Agents + +{other_agents} + +--- + +## Implementation Notes + +**Use the create-workflow workflow to build this workflow.** + +Inputs needed: +- Workflow name and description +- Step structure and sequence +- Input/output specifications +- Agent associations + +--- + +_Spec created on {date} via BMAD Module workflow_ diff --git a/src/modules/bmb/workflows/module/workflow.md b/src/modules/bmb/workflows/module/workflow.md new file mode 100644 index 00000000..98a93694 --- /dev/null +++ b/src/modules/bmb/workflows/module/workflow.md @@ -0,0 +1,100 @@ +--- +name: module +description: Quad-modal workflow for creating BMAD modules (Brief + Create + Edit + Validate) +web_bundle: true +installed_path: '{project-root}/_bmad/bmb/workflows/module' +--- + +# Module Workflow + +The module workflow guides users through creating complete, installable BMAD modules through a quad-modal process: **Brief → Create → Edit → Validate**. + +## What This Workflow Does + +- **Brief mode** — Collaboratively explore and design your module vision +- **Create mode** — Build the module structure from a brief +- **Edit mode** — Modify existing briefs or modules +- **Validate mode** — Check compliance and completeness + +## Role + +You are the **Module Architect** — a specialist in BMAD module design. You understand that modules are complex entities requiring careful planning before implementation. + +--- + +## INITIALIZATION SEQUENCE + +### 1. Mode Determination + +**Check invocation context:** +- Look for existing module brief or plan +- Check if user is starting fresh or continuing work +- Determine what mode they need + +**Ask the user:** + +**"Welcome to the Module workflow! What would you like to do?"** + +- **[B] Brief** — Create a module brief (exploratory, creative discovery) +- **[C] Create** — Build a module from a brief +- **[E] Edit** — Modify an existing brief or module +- **[V] Validate** — Validate a brief or module + +### 2. Route to First Step + +**IF mode == brief (B):** +Load `{installed_path}/steps-b/step-01-welcome.md` + +**IF mode == create (C):** +Ask: "Where is the module brief?" → Load `{installed_path}/steps-c/step-01-load-brief.md` + +**IF mode == edit (E):** +Ask: "What would you like to edit?" → Load `{installed_path}/steps-e/step-01-assess.md` + +**IF mode == validate (V):** +Ask: "What would you like to validate?" → Load `{installed_path}/steps-v/step-01-validate.md` + +--- + +## Configuration + +This workflow references: +- `{installed_path}/data/` — Module standards and templates +- `{installed_path}/templates/` — Output templates + +--- + +## Workflow Structure + +``` +module/ +├── workflow.md # This file - mode routing +├── data/ # Shared standards +│ ├── module-standards.md +│ ├── module-yaml-conventions.md +│ ├── agent-architecture.md +│ └── module-installer-standards.md +├── templates/ # Output templates +│ ├── brief-template.md +│ ├── agent-spec-template.md +│ └── workflow-spec-template.md +├── steps-b/ # Brief mode (13 steps) +├── steps-c/ # Create mode (8 steps) +├── steps-e/ # Edit mode +└── steps-v/ # Validate mode +``` + +--- + +## Output + +**Brief mode produces:** +- `module-brief-{code}.md` — Complete module vision document + +**Create mode produces:** +- Module directory structure +- `module.yaml` with install configuration +- `_module-installer/` folder (if needed) +- Agent placeholder/spec files +- Workflow placeholder/spec files +- `README.md` and `TODO.md`