From dbddf3a74e6abd4a4f3c10c442d0145f09b21914 Mon Sep 17 00:00:00 2001 From: Michael SCHAL Date: Fri, 13 Feb 2026 10:04:13 +0100 Subject: [PATCH] feat: implement reel improvements (clean text, deletion, mobile TTS) --- ...ad-master.md => bmad-agent-bmad-master.md} | 10 +- ...der.md => bmad-agent-bmb-agent-builder.md} | 10 +- ...er.md => bmad-agent-bmb-module-builder.md} | 10 +- ....md => bmad-agent-bmb-workflow-builder.md} | 10 +- ...s-analyst.md => bmad-agent-bmm-analyst.md} | 10 +- ...chitect.md => bmad-agent-bmm-architect.md} | 10 +- ...mm-agents-dev.md => bmad-agent-bmm-dev.md} | 10 +- ...-bmm-agents-pm.md => bmad-agent-bmm-pm.md} | 10 +- ...game-architect.md => bmad-agent-bmm-qa.md} | 14 +- ... => bmad-agent-bmm-quick-flow-solo-dev.md} | 10 +- ...-bmm-agents-sm.md => bmad-agent-bmm-sm.md} | 10 +- ...riter.md => bmad-agent-bmm-tech-writer.md} | 10 +- ...igner.md => bmad-agent-bmm-ux-designer.md} | 10 +- ... => bmad-agent-cis-brainstorming-coach.md} | 10 +- ...bmad-agent-cis-creative-problem-solver.md} | 10 +- ...> bmad-agent-cis-design-thinking-coach.md} | 10 +- ...> bmad-agent-cis-innovation-strategist.md} | 10 +- ... => bmad-agent-cis-presentation-master.md} | 10 +- ...eller.md => bmad-agent-cis-storyteller.md} | 10 +- .agent/workflows/bmad-bmb-create-agent.md | 7 + .../workflows/bmad-bmb-create-module-brief.md | 7 + .agent/workflows/bmad-bmb-create-module.md | 7 + .agent/workflows/bmad-bmb-create-workflow.md | 7 + .agent/workflows/bmad-bmb-edit-agent.md | 7 + .agent/workflows/bmad-bmb-edit-module.md | 7 + .agent/workflows/bmad-bmb-edit-workflow.md | 7 + .agent/workflows/bmad-bmb-rework-workflow.md | 7 + .agent/workflows/bmad-bmb-validate-agent.md | 7 + ...bmad-bmb-validate-max-parallel-workflow.md | 7 + .agent/workflows/bmad-bmb-validate-module.md | 7 + .../workflows/bmad-bmb-validate-workflow.md | 7 + ...bmad-bmm-check-implementation-readiness.md | 7 + ...code-review.md => bmad-bmm-code-review.md} | 8 +- ...t-course.md => bmad-bmm-correct-course.md} | 8 +- ...ure.md => bmad-bmm-create-architecture.md} | 4 +- ...d => bmad-bmm-create-epics-and-stories.md} | 4 +- .agent/workflows/bmad-bmm-create-prd.md | 7 + .../bmad-bmm-create-product-brief.md | 7 + ...eate-story.md => bmad-bmm-create-story.md} | 8 +- .agent/workflows/bmad-bmm-create-ux-design.md | 7 + ...ows-dev-story.md => bmad-bmm-dev-story.md} | 8 +- ...roject.md => bmad-bmm-document-project.md} | 8 +- .agent/workflows/bmad-bmm-domain-research.md | 7 + .agent/workflows/bmad-bmm-edit-prd.md | 7 + .../bmad-bmm-generate-project-context.md | 7 + .agent/workflows/bmad-bmm-market-research.md | 7 + ...rint-status.md => bmad-bmm-qa-automate.md} | 10 +- .agent/workflows/bmad-bmm-quick-dev.md | 7 + .agent/workflows/bmad-bmm-quick-spec.md | 7 + ...ospective.md => bmad-bmm-retrospective.md} | 8 +- ...lanning.md => bmad-bmm-sprint-planning.md} | 8 +- ...nt-status.md => bmad-bmm-sprint-status.md} | 8 +- .../workflows/bmad-bmm-technical-research.md | 7 + .agent/workflows/bmad-bmm-validate-prd.md | 7 + .agent/workflows/bmad-brainstorming.md | 7 + ...hinking.md => bmad-cis-design-thinking.md} | 8 +- ...egy.md => bmad-cis-innovation-strategy.md} | 8 +- ...solving.md => bmad-cis-problem-solving.md} | 8 +- ...orytelling.md => bmad-cis-storytelling.md} | 8 +- .../workflows/bmad-editorial-review-prose.md | 10 + .../bmad-editorial-review-structure.md | 10 + .agent/workflows/bmad-help.md | 10 + .agent/workflows/bmad-index-docs.md | 10 + .agent/workflows/bmad-party-mode.md | 7 + .../bmad-review-adversarial-general.md | 10 + .agent/workflows/bmad-shard-doc.md | 10 + ...mb-workflows-Meal Prep & Nutrition Plan.md | 5 - .../bmad/bmad-bmb-workflows-agent.md | 5 - .../bmad/bmad-bmb-workflows-create-module.md | 5 - .../bmad-bmb-workflows-create-workflow.md | 5 - .../bmad/bmad-bmb-workflows-edit-workflow.md | 5 - ...bmb-workflows-workflow-compliance-check.md | 5 - .../bmad/bmad-bmgd-agents-game-designer.md | 14 - .../bmad/bmad-bmgd-agents-game-dev.md | 14 - .../bmad/bmad-bmgd-agents-game-qa.md | 14 - .../bmad-bmgd-agents-game-scrum-master.md | 14 - .../bmad/bmad-bmgd-agents-game-solo-dev.md | 14 - .../bmad-bmgd-workflows-brainstorm-game.md | 13 - .../bmad/bmad-bmgd-workflows-code-review.md | 13 - .../bmad-bmgd-workflows-correct-course.md | 13 - .../bmad-bmgd-workflows-create-game-brief.md | 5 - .../bmad/bmad-bmgd-workflows-create-gdd.md | 5 - .../bmad/bmad-bmgd-workflows-create-story.md | 13 - .../bmad-bmgd-workflows-create-tech-spec.md | 13 - .../bmad-bmgd-workflows-game-architecture.md | 13 - .../bmad/bmad-bmgd-workflows-game-brief.md | 13 - .../bmad-bmgd-workflows-gametest-automate.md | 13 - .../bmad-bmgd-workflows-gametest-framework.md | 13 - ...mad-bmgd-workflows-gametest-performance.md | 13 - ...d-bmgd-workflows-gametest-playtest-plan.md | 13 - ...mad-bmgd-workflows-gametest-test-design.md | 13 - ...mad-bmgd-workflows-gametest-test-review.md | 13 - .../workflows/bmad/bmad-bmgd-workflows-gdd.md | 13 - ...bmgd-workflows-generate-project-context.md | 5 - .../bmad/bmad-bmgd-workflows-narrative.md | 13 - .../bmad/bmad-bmgd-workflows-quick-dev.md | 13 - .../bmad-bmgd-workflows-quick-prototype.md | 13 - .../bmad/bmad-bmgd-workflows-workflow-init.md | 13 - .../bmad-bmgd-workflows-workflow-status.md | 13 - .agent/workflows/bmad/bmad-bmm-agents-tea.md | 14 - ...orkflows-check-implementation-readiness.md | 5 - ...mm-workflows-create-excalidraw-dataflow.md | 13 - ...bmm-workflows-create-excalidraw-diagram.md | 13 - ...m-workflows-create-excalidraw-flowchart.md | 13 - ...m-workflows-create-excalidraw-wireframe.md | 13 - .../bmad/bmad-bmm-workflows-create-prd.md | 5 - ...bmad-bmm-workflows-create-product-brief.md | 5 - .../bmad-bmm-workflows-create-tech-spec.md | 5 - .../bmad-bmm-workflows-create-ux-design.md | 5 - .../bmad/bmad-bmm-workflows-dev-story.md | 13 - ...-bmm-workflows-generate-project-context.md | 5 - .../bmad/bmad-bmm-workflows-quick-dev.md | 5 - .../bmad/bmad-bmm-workflows-research.md | 5 - .../bmad/bmad-bmm-workflows-retrospective.md | 13 - .../bmad-bmm-workflows-sprint-planning.md | 13 - .../bmad/bmad-bmm-workflows-testarch-atdd.md | 13 - .../bmad-bmm-workflows-testarch-automate.md | 13 - .../bmad/bmad-bmm-workflows-testarch-ci.md | 13 - .../bmad-bmm-workflows-testarch-framework.md | 13 - .../bmad/bmad-bmm-workflows-testarch-nfr.md | 13 - ...bmad-bmm-workflows-testarch-test-design.md | 13 - ...bmad-bmm-workflows-testarch-test-review.md | 13 - .../bmad/bmad-bmm-workflows-testarch-trace.md | 13 - .../bmad/bmad-bmm-workflows-workflow-init.md | 13 - .../bmad-bmm-workflows-workflow-status.md | 13 - .../bmad/bmad-core-workflows-brainstorming.md | 5 - .../bmad/bmad-core-workflows-party-mode.md | 5 - _bmad/_config/agent-manifest.csv | 24 +- .../agents/bmgd-game-designer.customize.yaml | 41 - .../agents/bmgd-game-dev.customize.yaml | 41 - .../agents/bmgd-game-qa.customize.yaml | 41 - .../bmgd-game-scrum-master.customize.yaml | 41 - .../agents/bmgd-game-solo-dev.customize.yaml | 41 - ...t.customize.yaml => bmm-qa.customize.yaml} | 0 _bmad/_config/agents/bmm-tea.customize.yaml | 41 - _bmad/_config/bmad-help.csv | 56 + _bmad/_config/files-manifest.csv | 930 ++++------- _bmad/_config/ides/antigravity.yaml | 5 + _bmad/_config/manifest.yaml | 39 +- _bmad/_config/task-manifest.csv | 9 +- _bmad/_config/workflow-manifest.csv | 69 +- _bmad/_memory/config.yaml | 8 +- .../documentation-standards.md | 68 +- _bmad/bmb/README.md | 25 - _bmad/bmb/agents/agent-builder.md | 18 +- _bmad/bmb/agents/module-builder.md | 22 +- _bmad/bmb/agents/workflow-builder.md | 19 +- _bmad/bmb/config.yaml | 8 +- _bmad/bmb/docs/workflows/architecture.md | 220 --- .../docs/workflows/common-workflow-tools.csv | 19 - .../docs/workflows/csv-data-file-standards.md | 206 --- .../intent-vs-prescriptive-spectrum.md | 220 --- _bmad/bmb/docs/workflows/step-file-rules.md | 469 ------ .../bmb/docs/workflows/templates/step-file.md | 139 -- _bmad/bmb/docs/workflows/terms.md | 97 -- _bmad/bmb/module-help.csv | 13 + .../agents/simple-examples/README.md | 223 --- _bmad/bmb/reference/readme.md | 3 - .../data/dietary-restrictions.csv | 18 - .../data/macro-calculator.csv | 16 - .../data/recipe-database.csv | 28 - .../meal-prep-nutrition/steps/step-01-init.md | 177 -- .../steps/step-01b-continue.md | 121 -- .../steps/step-02-profile.md | 165 -- .../steps/step-03-assessment.md | 154 -- .../steps/step-04-strategy.md | 183 --- .../steps/step-05-shopping.md | 168 -- .../steps/step-06-prep-schedule.md | 195 --- .../templates/assessment-section.md | 25 - .../templates/nutrition-plan.md | 68 - .../templates/prep-schedule-section.md | 29 - .../templates/profile-section.md | 47 - .../templates/shopping-section.md | 37 - .../templates/strategy-section.md | 18 - .../workflows-legacy/edit-module/README.md | 171 -- .../workflows-legacy/edit-module/checklist.md | 163 -- .../edit-module/instructions.md | 340 ---- .../edit-module/workflow.yaml | 33 - .../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 | 35 - .../agent/data/agent-architecture.md | 258 +++ .../workflows/agent/data/agent-compilation.md | 256 +-- .../agent/data/agent-menu-patterns.md | 160 +- .../workflows/agent/data/agent-metadata.md | 183 +-- .../workflows/agent/data/agent-validation.md | 111 ++ .../agent/data/brainstorm-context.md | 178 +- .../workflows/agent/data/critical-actions.md | 125 +- .../agent/data/expert-agent-architecture.md | 236 --- .../agent/data/expert-agent-validation.md | 173 -- .../agent/data/module-agent-validation.md | 124 -- .../agent/data/persona-properties.md | 76 +- .../agent/data/principles-crafting.md | 224 +-- .../entries/yy-mm-dd-entry-template.md | 0 .../agent/data/simple-agent-architecture.md | 204 --- .../agent/data/simple-agent-validation.md | 132 -- .../agent/data/understanding-agent-types.md | 240 +-- .../agent/steps-c/step-01-brainstorm.md | 4 +- .../agent/steps-c/step-02-discovery.md | 6 +- ...etadata.md => step-03-sidecar-metadata.md} | 156 +- .../agent/steps-c/step-04-persona.md | 10 +- .../agent/steps-c/step-05-commands-menu.md | 10 +- .../agent/steps-c/step-06-activation.md | 164 +- .../agent/steps-c/step-07-build-agent.md | 315 ++++ .../agent/steps-c/step-07a-build-simple.md | 185 --- .../agent/steps-c/step-07b-build-expert.md | 201 --- .../agent/steps-c/step-07c-build-module.md | 258 --- ...p-09-celebrate.md => step-08-celebrate.md} | 23 +- .../steps-c/step-08a-plan-traceability.md | 203 --- .../steps-c/step-08b-metadata-validation.md | 135 -- .../steps-c/step-08c-persona-validation.md | 161 -- .../agent/steps-c/step-08d-menu-validation.md | 158 -- .../steps-c/step-08e-structure-validation.md | 306 ---- .../steps-c/step-08f-sidecar-validation.md | 462 ------ .../agent/steps-e/e-01-load-existing.md | 19 +- .../agent/steps-e/e-02-discover-edits.md | 23 +- .../agent/steps-e/e-03-placeholder.md | 1 + .../agent/steps-e/e-03a-validate-metadata.md | 78 - .../agent/steps-e/e-03b-validate-persona.md | 76 - .../agent/steps-e/e-03c-validate-menu.md | 75 - .../agent/steps-e/e-03d-validate-structure.md | 75 - .../agent/steps-e/e-03e-validate-sidecar.md | 78 - .../agent/steps-e/e-03f-validation-summary.md | 119 -- ...e-metadata.md => e-04-sidecar-metadata.md} | 39 +- .../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 | 59 +- .../agent/steps-e/e-08-edit-agent.md | 196 +++ .../agent/steps-e/e-08a-edit-simple.md | 134 -- .../agent/steps-e/e-08b-edit-expert.md | 117 -- .../agent/steps-e/e-08c-edit-module.md | 120 -- .../{e-10-celebrate.md => e-09-celebrate.md} | 21 +- .../agent/steps-e/e-09a-validate-metadata.md | 70 - .../agent/steps-e/e-09b-validate-persona.md | 70 - .../agent/steps-e/e-09c-validate-menu.md | 69 - .../agent/steps-e/e-09d-validate-structure.md | 69 - .../agent/steps-e/e-09e-validate-sidecar.md | 70 - .../agent/steps-e/e-09f-validation-summary.md | 111 -- .../agent/steps-v/v-01-load-review.md | 25 +- .../agent/steps-v/v-02a-validate-metadata.md | 65 +- .../agent/steps-v/v-02b-validate-persona.md | 74 +- .../agent/steps-v/v-02c-validate-menu.md | 86 +- .../agent/steps-v/v-02d-validate-structure.md | 87 +- .../agent/steps-v/v-02e-validate-sidecar.md | 104 +- .../workflows/agent/steps-v/v-03-summary.md | 6 +- ...rt-agent.template.md => agent-template.md} | 23 +- .../agent/templates/simple-agent.template.md | 71 - .../workflows/agent/workflow-create-agent.md | 72 + .../workflows/agent/workflow-edit-agent.md | 75 + .../agent/workflow-validate-agent.md | 73 + _bmad/bmb/workflows/agent/workflow.md | 123 -- .../create-module/steps/step-01-init.md | 156 -- .../create-module/steps/step-01b-continue.md | 170 -- .../create-module/steps/step-02-concept.md | 218 --- .../create-module/steps/step-03-components.md | 268 --- .../create-module/steps/step-04-structure.md | 229 --- .../create-module/steps/step-05-config.md | 234 --- .../create-module/steps/step-06-agents.md | 297 ---- .../create-module/steps/step-07-workflows.md | 229 --- .../create-module/steps/step-08-installer.md | 187 --- .../steps/step-09-documentation.md | 310 ---- .../create-module/steps/step-10-roadmap.md | 338 ---- .../create-module/steps/step-11-validate.md | 336 ---- .../create-module/templates/agent.template.md | 313 ---- .../templates/installer.template.js | 47 - .../templates/module-plan.template.md | 5 - .../templates/module.template.yaml | 53 - .../templates/workflow-plan-template.md | 23 - .../bmb/workflows/create-module/validation.md | 126 -- _bmad/bmb/workflows/create-module/workflow.md | 56 - .../data/dietary-restrictions.csv | 18 - .../data/macro-calculator.csv | 16 - .../data/recipe-database.csv | 28 - .../meal-prep-nutrition/steps/step-01-init.md | 177 -- .../steps/step-01b-continue.md | 150 -- .../steps/step-02-profile.md | 164 -- .../steps/step-03-assessment.md | 152 -- .../steps/step-04-strategy.md | 182 --- .../steps/step-05-shopping.md | 167 -- .../steps/step-06-prep-schedule.md | 194 --- .../templates/assessment-section.md | 25 - .../templates/nutrition-plan.md | 68 - .../templates/prep-schedule-section.md | 29 - .../templates/profile-section.md | 47 - .../templates/shopping-section.md | 37 - .../templates/strategy-section.md | 18 - .../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 - .../module/data/agent-architecture.md | 179 ++ .../module/data/agent-spec-template.md | 79 + .../workflows/module/data/module-standards.md | 263 +++ .../module/data/module-yaml-conventions.md | 392 +++++ .../workflows/module/module-help-generate.md | 254 +++ .../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 | 82 + .../module/steps-c/step-02-structure.md | 104 ++ .../module/steps-c/step-03-config.md | 118 ++ .../module/steps-c/step-04-agents.md | 167 ++ .../module/steps-c/step-05-workflows.md | 183 +++ .../workflows/module/steps-c/step-06-docs.md | 400 +++++ .../module/steps-c/step-07-complete.md | 152 ++ .../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 | 93 ++ .../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 | 102 ++ .../module/steps-v/step-08-report.md | 197 +++ .../module/templates/brief-template.md | 154 ++ .../templates/workflow-spec-template.md | 96 ++ .../module/workflow-create-module-brief.md | 71 + .../module/workflow-create-module.md | 86 + .../workflows/module/workflow-edit-module.md | 66 + .../module/workflow-validate-module.md | 66 + .../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 | 150 ++ .../workflow/data/common-workflow-tools.csv | 19 + .../workflow/data/csv-data-file-standards.md | 53 + .../workflow/data/frontmatter-standards.md | 184 +++ .../data/input-discovery-standards.md | 191 +++ .../data/intent-vs-prescriptive-spectrum.md | 44 + .../workflow/data/menu-handling-standards.md | 133 ++ .../workflow/data/output-format-standards.md | 135 ++ .../workflow/data/step-file-rules.md | 235 +++ .../workflow/data/step-type-patterns.md | 257 +++ .../data/subprocess-optimization-patterns.md | 188 +++ .../data/trimodal-workflow-structure.md | 164 ++ .../data/workflow-chaining-standards.md | 222 +++ .../workflow/data/workflow-examples.md | 232 +++ .../workflow/data/workflow-type-criteria.md | 134 ++ .../workflow/steps-c/step-00-conversion.md | 262 +++ .../workflow/steps-c/step-01-discovery.md | 194 +++ .../workflow/steps-c/step-01b-continuation.md | 3 + .../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 | 129 +- .../workflow/steps-c/step-07-foundation.md | 238 +++ .../workflow/steps-c/step-08-build-step-01.md | 377 +++++ .../steps-c/step-09-build-next-step.md | 350 ++++ .../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 +++ .../steps-v/step-01-validate-max-mode.md | 109 ++ .../workflow/steps-v/step-01-validate.md | 221 +++ .../workflow/steps-v/step-01b-structure.md | 152 ++ .../steps-v/step-02-frontmatter-validation.md | 199 +++ .../steps-v/step-02b-path-violations.md | 265 +++ .../steps-v/step-03-menu-validation.md | 164 ++ .../steps-v/step-04-step-type-validation.md | 211 +++ .../step-05-output-format-validation.md | 200 +++ .../step-06-validation-design-check.md | 195 +++ .../step-07-instruction-style-check.md | 209 +++ .../step-08-collaborative-experience-check.md | 199 +++ .../step-08b-subprocess-optimization.md | 179 ++ .../steps-v/step-09-cohesive-review.md | 186 +++ .../steps-v/step-10-report-complete.md | 154 ++ .../steps-v/step-11-plan-validation.md | 237 +++ .../templates/minimal-output-template.md | 11 + .../step-01-init-continuable-template.md | 6 +- .../workflow}/templates/step-1b-template.md | 2 +- .../workflow}/templates/step-template.md | 28 +- .../workflow}/templates/workflow-template.md | 6 +- .../workflow/workflow-create-workflow.md | 79 + .../workflow/workflow-edit-workflow.md} | 24 +- .../workflow-rework-workflow.md} | 20 +- ...orkflow-validate-max-parallel-workflow.md} | 28 +- .../workflow-validate-workflow.md} | 20 +- _bmad/bmgd/agents/game-architect.md | 71 - _bmad/bmgd/agents/game-designer.md | 72 - _bmad/bmgd/agents/game-dev.md | 73 - _bmad/bmgd/agents/game-qa.md | 76 - _bmad/bmgd/agents/game-scrum-master.md | 88 - _bmad/bmgd/agents/game-solo-dev.md | 72 - _bmad/bmgd/config.yaml | 21 - .../gametest/knowledge/balance-testing.md | 220 --- .../knowledge/certification-testing.md | 319 ---- .../knowledge/compatibility-testing.md | 228 --- .../bmgd/gametest/knowledge/godot-testing.md | 376 ----- .../bmgd/gametest/knowledge/input-testing.md | 315 ---- .../knowledge/localization-testing.md | 304 ---- .../gametest/knowledge/multiplayer-testing.md | 322 ---- .../gametest/knowledge/performance-testing.md | 204 --- _bmad/bmgd/gametest/knowledge/playtesting.md | 384 ----- .../bmgd/gametest/knowledge/qa-automation.md | 190 --- .../gametest/knowledge/regression-testing.md | 280 ---- _bmad/bmgd/gametest/knowledge/save-testing.md | 280 ---- .../bmgd/gametest/knowledge/smoke-testing.md | 404 ----- .../gametest/knowledge/test-priorities.md | 271 ---- .../bmgd/gametest/knowledge/unity-testing.md | 383 ----- .../bmgd/gametest/knowledge/unreal-testing.md | 388 ----- _bmad/bmgd/gametest/qa-index.csv | 17 - _bmad/bmgd/teams/default-party.csv | 12 - _bmad/bmgd/teams/team-gamedev.yaml | 29 - .../brainstorm-game/game-brain-methods.csv | 26 - .../brainstorm-game/game-context.md | 115 -- .../brainstorm-game/instructions.md | 130 -- .../brainstorm-game/steps/step-01-init.md | 165 -- .../brainstorm-game/steps/step-02-context.md | 211 --- .../brainstorm-game/steps/step-03-ideation.md | 290 ---- .../brainstorm-game/steps/step-04-complete.md | 276 ---- .../brainstorm-game/workflow.md | 50 - .../brainstorm-game/workflow.yaml | 42 - .../1-preproduction/game-brief/checklist.md | 128 -- .../game-brief/instructions.md | 373 ----- .../game-brief/steps/step-01-init.md | 224 --- .../game-brief/steps/step-01b-continue.md | 152 -- .../game-brief/steps/step-02-vision.md | 219 --- .../game-brief/steps/step-03-market.md | 219 --- .../game-brief/steps/step-04-fundamentals.md | 232 --- .../game-brief/steps/step-05-scope.md | 243 --- .../game-brief/steps/step-06-references.md | 225 --- .../game-brief/steps/step-07-content.md | 283 ---- .../game-brief/steps/step-08-complete.md | 297 ---- .../templates/game-brief-template.md | 205 --- .../1-preproduction/game-brief/workflow.md | 63 - .../1-preproduction/game-brief/workflow.yaml | 44 - .../bmgd/workflows/2-design/gdd/checklist.md | 148 -- .../workflows/2-design/gdd/game-types.csv | 25 - .../gdd/game-types/action-platformer.md | 45 - .../2-design/gdd/game-types/adventure.md | 84 - .../2-design/gdd/game-types/card-game.md | 76 - .../2-design/gdd/game-types/fighting.md | 89 - .../2-design/gdd/game-types/horror.md | 86 - .../gdd/game-types/idle-incremental.md | 78 - .../2-design/gdd/game-types/metroidvania.md | 87 - .../workflows/2-design/gdd/game-types/moba.md | 74 - .../2-design/gdd/game-types/party-game.md | 79 - .../2-design/gdd/game-types/puzzle.md | 58 - .../2-design/gdd/game-types/racing.md | 88 - .../2-design/gdd/game-types/rhythm.md | 79 - .../2-design/gdd/game-types/roguelike.md | 69 - .../workflows/2-design/gdd/game-types/rpg.md | 70 - .../2-design/gdd/game-types/sandbox.md | 79 - .../2-design/gdd/game-types/shooter.md | 62 - .../2-design/gdd/game-types/simulation.md | 73 - .../2-design/gdd/game-types/sports.md | 75 - .../2-design/gdd/game-types/strategy.md | 71 - .../2-design/gdd/game-types/survival.md | 79 - .../2-design/gdd/game-types/text-based.md | 91 -- .../2-design/gdd/game-types/tower-defense.md | 79 - .../gdd/game-types/turn-based-tactics.md | 88 - .../2-design/gdd/game-types/visual-novel.md | 89 - .../2-design/gdd/steps/step-01-init.md | 249 --- .../2-design/gdd/steps/step-01b-continue.md | 174 -- .../2-design/gdd/steps/step-02-context.md | 333 ---- .../2-design/gdd/steps/step-03-platforms.md | 246 --- .../2-design/gdd/steps/step-04-vision.md | 230 --- .../gdd/steps/step-05-core-gameplay.md | 259 --- .../2-design/gdd/steps/step-06-mechanics.md | 250 --- .../2-design/gdd/steps/step-07-game-type.md | 267 --- .../2-design/gdd/steps/step-08-progression.md | 273 ---- .../2-design/gdd/steps/step-09-levels.md | 265 --- .../2-design/gdd/steps/step-10-art-audio.md | 256 --- .../2-design/gdd/steps/step-11-technical.md | 276 ---- .../2-design/gdd/steps/step-12-epics.md | 285 ---- .../2-design/gdd/steps/step-13-metrics.md | 251 --- .../2-design/gdd/steps/step-14-complete.md | 336 ---- .../2-design/gdd/templates/gdd-template.md | 153 -- _bmad/bmgd/workflows/2-design/gdd/workflow.md | 61 - .../bmgd/workflows/2-design/gdd/workflow.yaml | 47 - .../workflows/2-design/narrative/checklist.md | 139 -- .../narrative/instructions-narrative.md | 604 ------- .../2-design/narrative/steps/step-01-init.md | 229 --- .../narrative/steps/step-01b-continue.md | 164 -- .../narrative/steps/step-02-foundation.md | 263 --- .../2-design/narrative/steps/step-03-story.md | 239 --- .../narrative/steps/step-04-characters.md | 298 ---- .../2-design/narrative/steps/step-05-world.md | 263 --- .../narrative/steps/step-06-dialogue.md | 251 --- .../narrative/steps/step-07-environmental.md | 245 --- .../narrative/steps/step-08-delivery.md | 265 --- .../narrative/steps/step-09-integration.md | 255 --- .../narrative/steps/step-10-production.md | 263 --- .../narrative/steps/step-11-complete.md | 332 ---- .../narrative/templates/narrative-template.md | 195 --- .../workflows/2-design/narrative/workflow.md | 58 - .../2-design/narrative/workflow.yaml | 51 - .../architecture-patterns.yaml | 321 ---- .../game-architecture/checklist.md | 240 --- .../game-architecture/decision-catalog.yaml | 222 --- .../game-architecture/instructions.md | 701 -------- .../game-architecture/pattern-categories.csv | 13 - .../game-architecture/steps/step-01-init.md | 224 --- .../steps/step-01b-continue.md | 154 -- .../steps/step-02-context.md | 263 --- .../steps/step-03-starter.md | 291 ---- .../steps/step-04-decisions.md | 301 ---- .../steps/step-05-crosscutting.md | 320 ---- .../steps/step-06-structure.md | 305 ---- .../steps/step-07-patterns.md | 350 ---- .../steps/step-08-validation.md | 294 ---- .../steps/step-09-complete.md | 357 ---- .../templates/architecture-template.md | 103 -- .../3-technical/game-architecture/workflow.md | 56 - .../game-architecture/workflow.yaml | 70 - .../project-context-template.md | 20 - .../steps/step-01-discover.md | 202 --- .../steps/step-02-generate.md | 374 ----- .../steps/step-03-complete.md | 280 ---- .../generate-project-context/workflow.md | 49 - .../code-review/backlog-template.md | 12 - .../4-production/code-review/checklist.md | 23 - .../4-production/code-review/instructions.xml | 225 --- .../4-production/code-review/workflow.yaml | 63 - .../4-production/correct-course/checklist.md | 279 ---- .../correct-course/instructions.md | 206 --- .../4-production/correct-course/workflow.yaml | 61 - .../4-production/create-story/checklist.md | 358 ---- .../create-story/instructions.xml | 298 ---- .../4-production/create-story/template.md | 49 - .../4-production/create-story/workflow.yaml | 77 - .../4-production/dev-story/checklist.md | 80 - .../4-production/dev-story/instructions.xml | 409 ----- .../4-production/dev-story/workflow.yaml | 66 - .../retrospective/instructions.md | 1443 ----------------- .../4-production/retrospective/workflow.yaml | 61 - .../4-production/sprint-planning/checklist.md | 33 - .../sprint-planning/instructions.md | 234 --- .../sprint-status-template.yaml | 55 - .../sprint-planning/workflow.yaml | 54 - .../sprint-status/instructions.md | 229 --- .../4-production/sprint-status/workflow.yaml | 34 - .../create-tech-spec/instructions.md | 140 -- .../create-tech-spec/workflow.yaml | 26 - .../bmgd-quick-flow/quick-dev/checklist.md | 37 - .../bmgd-quick-flow/quick-dev/instructions.md | 220 --- .../bmgd-quick-flow/quick-dev/workflow.yaml | 44 - .../quick-prototype/checklist.md | 26 - .../quick-prototype/instructions.md | 156 -- .../quick-prototype/workflow.yaml | 35 - .../workflows/gametest/automate/checklist.md | 93 -- .../gametest/automate/instructions.md | 317 ---- .../workflows/gametest/automate/workflow.yaml | 48 - .../gametest/performance/checklist.md | 96 -- .../gametest/performance/instructions.md | 323 ---- .../performance/performance-template.md | 256 --- .../gametest/performance/workflow.yaml | 46 - .../gametest/playtest-plan/checklist.md | 93 -- .../gametest/playtest-plan/instructions.md | 297 ---- .../playtest-plan/playtest-template.md | 208 --- .../gametest/playtest-plan/workflow.yaml | 57 - .../gametest/test-design/checklist.md | 98 -- .../gametest/test-design/instructions.md | 280 ---- .../test-design/test-design-template.md | 205 --- .../gametest/test-design/workflow.yaml | 45 - .../gametest/test-framework/checklist.md | 103 -- .../gametest/test-framework/instructions.md | 348 ---- .../gametest/test-framework/workflow.yaml | 46 - .../gametest/test-review/checklist.md | 87 - .../gametest/test-review/instructions.md | 272 ---- .../test-review/test-review-template.md | 203 --- .../gametest/test-review/workflow.yaml | 46 - .../workflow-status/init/instructions.md | 299 ---- .../workflow-status/init/workflow.yaml | 28 - .../workflows/workflow-status/instructions.md | 395 ----- .../paths/gamedev-brownfield.yaml | 65 - .../paths/gamedev-greenfield.yaml | 71 - .../paths/quickflow-brownfield.yaml | 29 - .../paths/quickflow-greenfield.yaml | 39 - .../workflow-status/project-levels.yaml | 63 - .../workflow-status-template.yaml | 24 - .../workflows/workflow-status/workflow.yaml | 28 - _bmad/bmm/agents/analyst.md | 50 +- _bmad/bmm/agents/architect.md | 34 +- _bmad/bmm/agents/dev.md | 41 +- _bmad/bmm/agents/pm.md | 42 +- _bmad/bmm/agents/qa.md | 92 ++ _bmad/bmm/agents/quick-flow-solo-dev.md | 27 +- _bmad/bmm/agents/sm.md | 31 +- _bmad/bmm/agents/tea.md | 71 - _bmad/bmm/agents/tech-writer.md | 72 - _bmad/bmm/agents/tech-writer/tech-writer.md | 70 + _bmad/bmm/agents/ux-designer.md | 31 +- _bmad/bmm/config.yaml | 10 +- _bmad/bmm/data/README.md | 29 - _bmad/bmm/data/project-context-template.md | 16 +- _bmad/bmm/module-help.csv | 31 + _bmad/bmm/teams/default-party.csv | 1 - _bmad/bmm/testarch/knowledge/api-request.md | 303 ---- _bmad/bmm/testarch/knowledge/auth-session.md | 356 ---- _bmad/bmm/testarch/knowledge/burn-in.md | 273 ---- _bmad/bmm/testarch/knowledge/ci-burn-in.md | 675 -------- _bmad/bmm/testarch/knowledge/component-tdd.md | 486 ------ .../testarch/knowledge/contract-testing.md | 957 ----------- .../bmm/testarch/knowledge/data-factories.md | 500 ------ _bmad/bmm/testarch/knowledge/email-auth.md | 721 -------- .../bmm/testarch/knowledge/error-handling.md | 725 --------- _bmad/bmm/testarch/knowledge/feature-flags.md | 750 --------- _bmad/bmm/testarch/knowledge/file-utils.md | 260 --- .../knowledge/fixture-architecture.md | 401 ----- .../knowledge/fixtures-composition.md | 382 ----- .../knowledge/intercept-network-call.md | 280 ---- _bmad/bmm/testarch/knowledge/log.md | 294 ---- .../knowledge/network-error-monitor.md | 272 ---- _bmad/bmm/testarch/knowledge/network-first.md | 486 ------ .../testarch/knowledge/network-recorder.md | 265 --- _bmad/bmm/testarch/knowledge/nfr-criteria.md | 670 -------- _bmad/bmm/testarch/knowledge/overview.md | 283 ---- .../testarch/knowledge/playwright-config.md | 730 --------- .../testarch/knowledge/probability-impact.md | 601 ------- _bmad/bmm/testarch/knowledge/recurse.md | 296 ---- .../bmm/testarch/knowledge/risk-governance.md | 615 ------- .../testarch/knowledge/selective-testing.md | 732 --------- .../testarch/knowledge/selector-resilience.md | 527 ------ .../knowledge/test-healing-patterns.md | 644 -------- .../knowledge/test-levels-framework.md | 473 ------ .../knowledge/test-priorities-matrix.md | 373 ----- _bmad/bmm/testarch/knowledge/test-quality.md | 664 -------- .../testarch/knowledge/timing-debugging.md | 372 ----- .../testarch/knowledge/visual-debugging.md | 524 ------ _bmad/bmm/testarch/tea-index.csv | 33 - .../steps/step-01-init.md | 15 +- .../steps/step-01b-continue.md | 9 +- .../steps/step-02-vision.md | 15 +- .../steps/step-03-users.md | 15 +- .../steps/step-04-metrics.md | 15 +- .../steps/step-05-scope.md | 15 +- .../steps/step-06-complete.md | 51 +- .../create-product-brief/workflow.md | 5 +- .../research/market-steps/step-01-init.md | 2 +- .../market-steps/step-02-customer-insights.md | 200 --- .../step-04-architectural-patterns.md | 2 +- .../step-05-implementation-research.md | 62 +- .../step-06-research-synthesis.md | 6 +- .../research/workflow-domain-research.md | 54 + .../research/workflow-market-research.md | 54 + .../research/workflow-technical-research.md | 54 + .../workflows/1-analysis/research/workflow.md | 173 -- .../data}/domain-complexity.csv | 2 + .../create-prd/data/prd-purpose.md | 197 +++ .../data}/project-types.csv | 0 .../steps-c}/step-01-init.md | 20 +- .../steps-c}/step-01b-continue.md | 85 +- .../create-prd/steps-c/step-02-discovery.md | 224 +++ .../steps-c}/step-03-success.md | 164 +- .../create-prd/steps-c/step-04-journeys.md | 213 +++ .../create-prd/steps-c/step-05-domain.md | 207 +++ .../steps-c}/step-06-innovation.md | 122 +- .../steps-c}/step-07-project-type.md | 95 +- .../steps-c}/step-08-scoping.md | 157 +- .../steps-c}/step-09-functional.md | 81 +- .../steps-c}/step-10-nonfunctional.md | 116 +- .../create-prd/steps-c/step-11-polish.md | 217 +++ .../create-prd/steps-c/step-12-complete.md | 124 ++ .../create-prd/steps-e/step-e-01-discovery.md | 247 +++ .../steps-e/step-e-01b-legacy-conversion.md | 208 +++ .../create-prd/steps-e/step-e-02-review.md | 249 +++ .../create-prd/steps-e/step-e-03-edit.md | 253 +++ .../create-prd/steps-e/step-e-04-complete.md | 168 ++ .../create-prd/steps-v/step-v-01-discovery.md | 218 +++ .../steps-v/step-v-02-format-detection.md | 191 +++ .../steps-v/step-v-02b-parity-check.md | 209 +++ .../steps-v/step-v-03-density-validation.md | 174 ++ .../step-v-04-brief-coverage-validation.md | 214 +++ .../step-v-05-measurability-validation.md | 228 +++ .../step-v-06-traceability-validation.md | 217 +++ ...-v-07-implementation-leakage-validation.md | 205 +++ .../step-v-08-domain-compliance-validation.md | 243 +++ .../step-v-09-project-type-validation.md | 263 +++ .../steps-v/step-v-10-smart-validation.md | 209 +++ .../step-v-11-holistic-quality-validation.md | 264 +++ .../step-v-12-completeness-validation.md | 242 +++ .../steps-v/step-v-13-report-complete.md | 231 +++ .../templates}/prd-template.md | 1 - .../workflow-create-prd.md} | 24 +- .../create-prd/workflow-edit-prd.md} | 35 +- .../create-prd/workflow-validate-prd.md | 65 + .../steps/step-02-discovery.md | 6 +- .../steps/step-03-core-experience.md | 8 +- .../steps/step-04-emotional-response.md | 8 +- .../steps/step-05-inspiration.md | 10 +- .../steps/step-06-design-system.md | 8 +- .../steps/step-07-defining-experience.md | 8 +- .../steps/step-08-visual-foundation.md | 8 +- .../steps/step-09-design-directions.md | 8 +- .../steps/step-10-user-journeys.md | 8 +- .../steps/step-11-component-strategy.md | 8 +- .../steps/step-12-ux-patterns.md | 8 +- .../steps/step-13-responsive-accessibility.md | 8 +- .../steps/step-14-complete.md | 61 +- .../create-ux-design/workflow.md | 3 +- .../prd/steps/step-02-discovery.md | 421 ----- .../prd/steps/step-04-journeys.md | 291 ---- .../prd/steps/step-05-domain.md | 271 ---- .../prd/steps/step-11-complete.md | 186 --- .../steps/step-01-document-discovery.md | 12 +- .../steps/step-02-prd-analysis.md | 8 +- .../steps/step-03-epic-coverage-validation.md | 8 +- .../steps/step-04-ux-alignment.md | 8 +- .../steps/step-05-epic-quality-review.md | 9 +- .../steps/step-06-final-assessment.md | 8 +- .../workflow.md | 7 +- .../data/domain-complexity.csv | 2 + .../steps/step-02-context.md | 8 +- .../steps/step-03-starter.md | 8 +- .../steps/step-04-decisions.md | 8 +- .../steps/step-05-patterns.md | 8 +- .../steps/step-06-structure.md | 8 +- .../steps/step-07-validation.md | 10 +- .../steps/step-08-complete.md | 290 +--- .../create-architecture/workflow.md | 3 +- .../steps/step-01-validate-prerequisites.md | 8 +- .../steps/step-02-design-epics.md | 12 +- .../steps/step-03-create-stories.md | 12 +- .../steps/step-04-final-validation.md | 6 +- .../create-epics-and-stories/workflow.md | 7 +- .../code-review/instructions.xml | 2 + .../code-review/workflow.yaml | 2 - .../correct-course/checklist.md | 9 + .../correct-course/instructions.md | 2 +- .../correct-course/workflow.yaml | 4 +- .../create-story/checklist.md | 4 +- .../create-story/instructions.xml | 3 +- .../create-story/workflow.yaml | 4 +- .../dev-story/instructions.xml | 3 +- .../4-implementation/dev-story/workflow.yaml | 2 - .../retrospective/workflow.yaml | 2 - .../sprint-status-template.yaml | 2 +- .../sprint-planning/workflow.yaml | 3 +- .../sprint-status/instructions.md | 2 +- .../sprint-status/workflow.yaml | 9 +- .../quick-dev/steps/step-01-mode-detection.md | 84 +- .../steps/step-02-context-gathering.md | 6 +- .../quick-dev/steps/step-03-execute.md | 6 +- .../quick-dev/steps/step-04-self-check.md | 4 +- .../steps/step-05-adversarial-review.md | 10 +- .../steps/step-06-resolve-findings.md | 32 +- .../bmad-quick-flow/quick-dev/workflow.md | 6 +- .../steps/step-01-understand.md | 40 +- .../steps/step-02-investigate.md | 26 +- .../steps/step-03-generate.md | 5 +- .../steps/step-04-review.md | 63 +- .../tech-spec-template.md | 0 .../workflow.md | 11 +- .../document-project/instructions.md | 10 +- .../workflows/document-project/workflow.yaml | 6 - .../_shared/excalidraw-library.json | 90 - .../_shared/excalidraw-templates.yaml | 127 -- .../create-dataflow/checklist.md | 39 - .../create-dataflow/instructions.md | 130 -- .../create-dataflow/workflow.yaml | 26 - .../create-diagram/checklist.md | 43 - .../create-diagram/instructions.md | 141 -- .../create-diagram/workflow.yaml | 26 - .../create-flowchart/checklist.md | 49 - .../create-flowchart/instructions.md | 241 --- .../create-flowchart/workflow.yaml | 26 - .../create-wireframe/checklist.md | 38 - .../create-wireframe/instructions.md | 133 -- .../create-wireframe/workflow.yaml | 26 - _bmad/bmm/workflows/qa/automate/checklist.md | 33 + .../bmm/workflows/qa/automate/instructions.md | 110 ++ _bmad/bmm/workflows/qa/automate/workflow.yaml | 47 + .../testarch/atdd/atdd-checklist-template.md | 364 ----- .../bmm/workflows/testarch/atdd/checklist.md | 374 ----- .../workflows/testarch/atdd/instructions.md | 806 --------- .../bmm/workflows/testarch/atdd/workflow.yaml | 45 - .../workflows/testarch/automate/checklist.md | 582 ------- .../testarch/automate/instructions.md | 1324 --------------- .../workflows/testarch/automate/workflow.yaml | 52 - _bmad/bmm/workflows/testarch/ci/checklist.md | 248 --- .../testarch/ci/github-actions-template.yaml | 198 --- .../testarch/ci/gitlab-ci-template.yaml | 149 -- .../bmm/workflows/testarch/ci/instructions.md | 536 ------ _bmad/bmm/workflows/testarch/ci/workflow.yaml | 45 - .../workflows/testarch/framework/checklist.md | 321 ---- .../testarch/framework/instructions.md | 481 ------ .../testarch/framework/workflow.yaml | 47 - .../testarch/nfr-assess/checklist.md | 407 ----- .../testarch/nfr-assess/instructions.md | 722 --------- .../nfr-assess/nfr-report-template.md | 445 ----- .../testarch/nfr-assess/workflow.yaml | 47 - .../testarch/test-design/checklist.md | 235 --- .../testarch/test-design/instructions.md | 788 --------- .../test-design/test-design-template.md | 294 ---- .../testarch/test-design/workflow.yaml | 54 - .../testarch/test-review/checklist.md | 472 ------ .../testarch/test-review/instructions.md | 628 ------- .../test-review/test-review-template.md | 390 ----- .../testarch/test-review/workflow.yaml | 46 - .../bmm/workflows/testarch/trace/checklist.md | 655 -------- .../workflows/testarch/trace/instructions.md | 1047 ------------ .../testarch/trace/trace-template.md | 675 -------- .../workflows/testarch/trace/workflow.yaml | 55 - .../workflow-status/init/instructions.md | 346 ---- .../workflow-status/init/workflow.yaml | 29 - .../workflows/workflow-status/instructions.md | 395 ----- .../paths/enterprise-brownfield.yaml | 103 -- .../paths/enterprise-greenfield.yaml | 100 -- .../paths/method-brownfield.yaml | 103 -- .../paths/method-greenfield.yaml | 100 -- .../workflow-status/project-levels.yaml | 59 - .../workflow-status-template.yaml | 24 - .../workflows/workflow-status/workflow.yaml | 30 - _bmad/cis/agents/brainstorming-coach.md | 17 +- _bmad/cis/agents/creative-problem-solver.md | 15 +- _bmad/cis/agents/design-thinking-coach.md | 15 +- _bmad/cis/agents/innovation-strategist.md | 15 +- _bmad/cis/agents/presentation-master.md | 15 +- _bmad/cis/agents/storyteller/storyteller.md | 15 +- _bmad/cis/config.yaml | 9 +- _bmad/cis/module-help.csv | 6 + .../workflows/design-thinking/instructions.md | 4 +- .../workflows/design-thinking/workflow.yaml | 55 +- .../innovation-strategy/instructions.md | 4 +- .../innovation-strategy/workflow.yaml | 55 +- .../workflows/problem-solving/instructions.md | 4 +- .../workflows/problem-solving/workflow.yaml | 55 +- .../workflows/storytelling/instructions.md | 4 +- .../cis/workflows/storytelling/workflow.yaml | 55 +- _bmad/core/agents/bmad-master.md | 19 +- _bmad/core/config.yaml | 8 +- _bmad/core/module-help.csv | 9 + _bmad/core/resources/excalidraw/README.md | 160 -- .../excalidraw/excalidraw-helpers.md | 127 -- .../resources/excalidraw/library-loader.md | 50 - .../excalidraw/validate-json-instructions.md | 79 - _bmad/core/tasks/editorial-review-prose.xml | 102 ++ .../core/tasks/editorial-review-structure.xml | 209 +++ _bmad/core/tasks/help.md | 85 + _bmad/core/tasks/index-docs.xml | 2 +- .../core/tasks/review-adversarial-general.xml | 9 +- _bmad/core/tasks/shard-doc.xml | 7 +- _bmad/core/tasks/validate-workflow.xml | 89 - _bmad/core/tasks/workflow.xml | 4 +- .../advanced-elicitation/workflow.xml | 2 +- .../steps/step-01-session-setup.md | 10 +- .../brainstorming/steps/step-01b-continue.md | 2 +- .../steps/step-03-technique-execution.md | 81 +- .../steps/step-04-idea-organization.md | 4 +- .../core/workflows/brainstorming/workflow.md | 11 +- .../party-mode/steps/step-01-agent-loading.md | 1 - .../steps/step-02-discussion-orchestration.md | 25 +- .../party-mode/steps/step-03-graceful-exit.md | 13 +- _bmad/core/workflows/party-mode/workflow.md | 12 - client/src/components/recent-publications.tsx | 91 +- client/src/pages/new-reel.tsx | 8 + ffmpeg-service/main.py | 104 +- server/routes/reels.ts | 30 + task.md | 20 +- 895 files changed, 26890 insertions(+), 93267 deletions(-) rename .agent/workflows/{bmad/bmad-core-agents-bmad-master.md => bmad-agent-bmad-master.md} (56%) rename .agent/workflows/{bmad/bmad-bmb-agents-agent-builder.md => bmad-agent-bmb-agent-builder.md} (56%) rename .agent/workflows/{bmad/bmad-bmb-agents-module-builder.md => bmad-agent-bmb-module-builder.md} (56%) rename .agent/workflows/{bmad/bmad-bmb-agents-workflow-builder.md => bmad-agent-bmb-workflow-builder.md} (56%) rename .agent/workflows/{bmad/bmad-bmm-agents-analyst.md => bmad-agent-bmm-analyst.md} (56%) rename .agent/workflows/{bmad/bmad-bmm-agents-architect.md => bmad-agent-bmm-architect.md} (56%) rename .agent/workflows/{bmad/bmad-bmm-agents-dev.md => bmad-agent-bmm-dev.md} (55%) rename .agent/workflows/{bmad/bmad-bmm-agents-pm.md => bmad-agent-bmm-pm.md} (55%) rename .agent/workflows/{bmad/bmad-bmgd-agents-game-architect.md => bmad-agent-bmm-qa.md} (50%) rename .agent/workflows/{bmad/bmad-bmm-agents-quick-flow-solo-dev.md => bmad-agent-bmm-quick-flow-solo-dev.md} (56%) rename .agent/workflows/{bmad/bmad-bmm-agents-sm.md => bmad-agent-bmm-sm.md} (55%) rename .agent/workflows/{bmad/bmad-bmm-agents-tech-writer.md => bmad-agent-bmm-tech-writer.md} (55%) rename .agent/workflows/{bmad/bmad-bmm-agents-ux-designer.md => bmad-agent-bmm-ux-designer.md} (56%) rename .agent/workflows/{bmad/bmad-cis-agents-brainstorming-coach.md => bmad-agent-cis-brainstorming-coach.md} (56%) rename .agent/workflows/{bmad/bmad-cis-agents-creative-problem-solver.md => bmad-agent-cis-creative-problem-solver.md} (56%) rename .agent/workflows/{bmad/bmad-cis-agents-design-thinking-coach.md => bmad-agent-cis-design-thinking-coach.md} (56%) rename .agent/workflows/{bmad/bmad-cis-agents-innovation-strategist.md => bmad-agent-cis-innovation-strategist.md} (56%) rename .agent/workflows/{bmad/bmad-cis-agents-presentation-master.md => bmad-agent-cis-presentation-master.md} (56%) rename .agent/workflows/{bmad/bmad-cis-agents-storyteller-storyteller.md => bmad-agent-cis-storyteller.md} (55%) create mode 100644 .agent/workflows/bmad-bmb-create-agent.md create mode 100644 .agent/workflows/bmad-bmb-create-module-brief.md create mode 100644 .agent/workflows/bmad-bmb-create-module.md create mode 100644 .agent/workflows/bmad-bmb-create-workflow.md create mode 100644 .agent/workflows/bmad-bmb-edit-agent.md create mode 100644 .agent/workflows/bmad-bmb-edit-module.md create mode 100644 .agent/workflows/bmad-bmb-edit-workflow.md create mode 100644 .agent/workflows/bmad-bmb-rework-workflow.md create mode 100644 .agent/workflows/bmad-bmb-validate-agent.md create mode 100644 .agent/workflows/bmad-bmb-validate-max-parallel-workflow.md create mode 100644 .agent/workflows/bmad-bmb-validate-module.md create mode 100644 .agent/workflows/bmad-bmb-validate-workflow.md create mode 100644 .agent/workflows/bmad-bmm-check-implementation-readiness.md rename .agent/workflows/{bmad/bmad-bmm-workflows-code-review.md => bmad-bmm-code-review.md} (65%) rename .agent/workflows/{bmad/bmad-bmm-workflows-correct-course.md => bmad-bmm-correct-course.md} (58%) rename .agent/workflows/{bmad/bmad-bmm-workflows-create-architecture.md => bmad-bmm-create-architecture.md} (51%) rename .agent/workflows/{bmad/bmad-bmm-workflows-create-epics-and-stories.md => bmad-bmm-create-epics-and-stories.md} (62%) create mode 100644 .agent/workflows/bmad-bmm-create-prd.md create mode 100644 .agent/workflows/bmad-bmm-create-product-brief.md rename .agent/workflows/{bmad/bmad-bmm-workflows-create-story.md => bmad-bmm-create-story.md} (58%) create mode 100644 .agent/workflows/bmad-bmm-create-ux-design.md rename .agent/workflows/{bmad/bmad-bmgd-workflows-dev-story.md => bmad-bmm-dev-story.md} (59%) rename .agent/workflows/{bmad/bmad-bmm-workflows-document-project.md => bmad-bmm-document-project.md} (62%) create mode 100644 .agent/workflows/bmad-bmm-domain-research.md create mode 100644 .agent/workflows/bmad-bmm-edit-prd.md create mode 100644 .agent/workflows/bmad-bmm-generate-project-context.md create mode 100644 .agent/workflows/bmad-bmm-market-research.md rename .agent/workflows/{bmad/bmad-bmgd-workflows-sprint-status.md => bmad-bmm-qa-automate.md} (51%) create mode 100644 .agent/workflows/bmad-bmm-quick-dev.md create mode 100644 .agent/workflows/bmad-bmm-quick-spec.md rename .agent/workflows/{bmad/bmad-bmgd-workflows-retrospective.md => bmad-bmm-retrospective.md} (60%) rename .agent/workflows/{bmad/bmad-bmgd-workflows-sprint-planning.md => bmad-bmm-sprint-planning.md} (61%) rename .agent/workflows/{bmad/bmad-bmm-workflows-sprint-status.md => bmad-bmm-sprint-status.md} (57%) create mode 100644 .agent/workflows/bmad-bmm-technical-research.md create mode 100644 .agent/workflows/bmad-bmm-validate-prd.md create mode 100644 .agent/workflows/bmad-brainstorming.md rename .agent/workflows/{bmad/bmad-cis-workflows-design-thinking.md => bmad-cis-design-thinking.md} (64%) rename .agent/workflows/{bmad/bmad-cis-workflows-innovation-strategy.md => bmad-cis-innovation-strategy.md} (64%) rename .agent/workflows/{bmad/bmad-cis-workflows-problem-solving.md => bmad-cis-problem-solving.md} (65%) rename .agent/workflows/{bmad/bmad-cis-workflows-storytelling.md => bmad-cis-storytelling.md} (65%) create mode 100644 .agent/workflows/bmad-editorial-review-prose.md create mode 100644 .agent/workflows/bmad-editorial-review-structure.md create mode 100644 .agent/workflows/bmad-help.md create mode 100644 .agent/workflows/bmad-index-docs.md create mode 100644 .agent/workflows/bmad-party-mode.md create mode 100644 .agent/workflows/bmad-review-adversarial-general.md create mode 100644 .agent/workflows/bmad-shard-doc.md delete mode 100644 .agent/workflows/bmad/bmad-bmb-workflows-Meal Prep & Nutrition Plan.md delete mode 100644 .agent/workflows/bmad/bmad-bmb-workflows-agent.md delete mode 100644 .agent/workflows/bmad/bmad-bmb-workflows-create-module.md delete mode 100644 .agent/workflows/bmad/bmad-bmb-workflows-create-workflow.md delete mode 100644 .agent/workflows/bmad/bmad-bmb-workflows-edit-workflow.md delete mode 100644 .agent/workflows/bmad/bmad-bmb-workflows-workflow-compliance-check.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-agents-game-designer.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-agents-game-dev.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-agents-game-qa.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-agents-game-scrum-master.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-agents-game-solo-dev.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-brainstorm-game.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-code-review.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-correct-course.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-create-game-brief.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-create-gdd.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-create-story.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-create-tech-spec.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-game-architecture.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-game-brief.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gametest-automate.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gametest-framework.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gametest-performance.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gametest-playtest-plan.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-design.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-review.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-gdd.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-generate-project-context.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-narrative.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-quick-dev.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-quick-prototype.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-workflow-init.md delete mode 100644 .agent/workflows/bmad/bmad-bmgd-workflows-workflow-status.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-agents-tea.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-check-implementation-readiness.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-dataflow.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-diagram.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-flowchart.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-wireframe.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-prd.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-product-brief.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-tech-spec.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-create-ux-design.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-dev-story.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-generate-project-context.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-quick-dev.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-research.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-retrospective.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-sprint-planning.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-atdd.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-automate.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-ci.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-framework.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-nfr.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-test-design.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-test-review.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-testarch-trace.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-workflow-init.md delete mode 100644 .agent/workflows/bmad/bmad-bmm-workflows-workflow-status.md delete mode 100644 .agent/workflows/bmad/bmad-core-workflows-brainstorming.md delete mode 100644 .agent/workflows/bmad/bmad-core-workflows-party-mode.md delete mode 100644 _bmad/_config/agents/bmgd-game-designer.customize.yaml delete mode 100644 _bmad/_config/agents/bmgd-game-dev.customize.yaml delete mode 100644 _bmad/_config/agents/bmgd-game-qa.customize.yaml delete mode 100644 _bmad/_config/agents/bmgd-game-scrum-master.customize.yaml delete mode 100644 _bmad/_config/agents/bmgd-game-solo-dev.customize.yaml rename _bmad/_config/agents/{bmgd-game-architect.customize.yaml => bmm-qa.customize.yaml} (100%) delete mode 100644 _bmad/_config/agents/bmm-tea.customize.yaml create mode 100644 _bmad/_config/bmad-help.csv create mode 100644 _bmad/_config/ides/antigravity.yaml rename _bmad/{bmm/data => _memory/tech-writer-sidecar}/documentation-standards.md (80%) delete mode 100644 _bmad/bmb/README.md delete mode 100644 _bmad/bmb/docs/workflows/architecture.md delete mode 100644 _bmad/bmb/docs/workflows/common-workflow-tools.csv delete mode 100644 _bmad/bmb/docs/workflows/csv-data-file-standards.md delete mode 100644 _bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md delete mode 100644 _bmad/bmb/docs/workflows/step-file-rules.md delete mode 100644 _bmad/bmb/docs/workflows/templates/step-file.md delete mode 100644 _bmad/bmb/docs/workflows/terms.md create mode 100644 _bmad/bmb/module-help.csv delete mode 100644 _bmad/bmb/reference/agents/simple-examples/README.md delete mode 100644 _bmad/bmb/reference/readme.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md delete mode 100644 _bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md delete mode 100644 _bmad/bmb/workflows-legacy/edit-module/README.md delete mode 100644 _bmad/bmb/workflows-legacy/edit-module/checklist.md delete mode 100644 _bmad/bmb/workflows-legacy/edit-module/instructions.md delete mode 100644 _bmad/bmb/workflows-legacy/edit-module/workflow.yaml delete mode 100644 _bmad/bmb/workflows-legacy/module-brief/README.md delete mode 100644 _bmad/bmb/workflows-legacy/module-brief/checklist.md delete mode 100644 _bmad/bmb/workflows-legacy/module-brief/instructions.md delete mode 100644 _bmad/bmb/workflows-legacy/module-brief/template.md delete mode 100644 _bmad/bmb/workflows-legacy/module-brief/workflow.yaml create mode 100644 _bmad/bmb/workflows/agent/data/agent-architecture.md create mode 100644 _bmad/bmb/workflows/agent/data/agent-validation.md delete mode 100644 _bmad/bmb/workflows/agent/data/expert-agent-architecture.md delete mode 100644 _bmad/bmb/workflows/agent/data/expert-agent-validation.md delete mode 100644 _bmad/bmb/workflows/agent/data/module-agent-validation.md rename _bmad/bmb/workflows/agent/data/reference/{expert-examples => with-sidecar}/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md (100%) delete mode 100644 _bmad/bmb/workflows/agent/data/simple-agent-architecture.md delete mode 100644 _bmad/bmb/workflows/agent/data/simple-agent-validation.md rename _bmad/bmb/workflows/agent/steps-c/{step-03-type-metadata.md => step-03-sidecar-metadata.md} (57%) create mode 100644 _bmad/bmb/workflows/agent/steps-c/step-07-build-agent.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md rename _bmad/bmb/workflows/agent/steps-c/{step-09-celebrate.md => step-08-celebrate.md} (87%) delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md delete mode 100644 _bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md create mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03-placeholder.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md rename _bmad/bmb/workflows/agent/steps-e/{e-04-type-metadata.md => e-04-sidecar-metadata.md} (73%) create mode 100644 _bmad/bmb/workflows/agent/steps-e/e-08-edit-agent.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md rename _bmad/bmb/workflows/agent/steps-e/{e-10-celebrate.md => e-09-celebrate.md} (78%) delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md delete mode 100644 _bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md rename _bmad/bmb/workflows/agent/templates/{expert-agent-template/expert-agent.template.md => agent-template.md} (68%) delete mode 100644 _bmad/bmb/workflows/agent/templates/simple-agent.template.md create mode 100644 _bmad/bmb/workflows/agent/workflow-create-agent.md create mode 100644 _bmad/bmb/workflows/agent/workflow-edit-agent.md create mode 100644 _bmad/bmb/workflows/agent/workflow-validate-agent.md delete mode 100644 _bmad/bmb/workflows/agent/workflow.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-01-init.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-01b-continue.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-02-concept.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-03-components.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-04-structure.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-05-config.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-06-agents.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-07-workflows.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-08-installer.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-09-documentation.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-10-roadmap.md delete mode 100644 _bmad/bmb/workflows/create-module/steps/step-11-validate.md delete mode 100644 _bmad/bmb/workflows/create-module/templates/agent.template.md delete mode 100644 _bmad/bmb/workflows/create-module/templates/installer.template.js delete mode 100644 _bmad/bmb/workflows/create-module/templates/module-plan.template.md delete mode 100644 _bmad/bmb/workflows/create-module/templates/module.template.yaml delete mode 100644 _bmad/bmb/workflows/create-module/templates/workflow-plan-template.md delete mode 100644 _bmad/bmb/workflows/create-module/validation.md delete mode 100644 _bmad/bmb/workflows/create-module/workflow.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md delete mode 100644 _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-01-init.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-02-gather.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-07-build.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-08-review.md delete mode 100644 _bmad/bmb/workflows/create-workflow/steps/step-09-complete.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/templates/completion-summary.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/templates/improvement-log.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/templates/validation-results.md delete mode 100644 _bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md create mode 100644 _bmad/bmb/workflows/module/data/agent-architecture.md create mode 100644 _bmad/bmb/workflows/module/data/agent-spec-template.md create mode 100644 _bmad/bmb/workflows/module/data/module-standards.md create mode 100644 _bmad/bmb/workflows/module/data/module-yaml-conventions.md create mode 100644 _bmad/bmb/workflows/module/module-help-generate.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-01-welcome.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-02-spark.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-03-module-type.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-04-vision.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-05-identity.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-06-users.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-07-value.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-08-agents.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-09-workflows.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-10-tools.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-11-scenarios.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-12-creative.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-13-review.md create mode 100644 _bmad/bmb/workflows/module/steps-b/step-14-finalize.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-01-load-brief.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-01b-continue.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-02-structure.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-03-config.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-04-agents.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-05-workflows.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-06-docs.md create mode 100644 _bmad/bmb/workflows/module/steps-c/step-07-complete.md create mode 100644 _bmad/bmb/workflows/module/steps-e/step-01-load-target.md create mode 100644 _bmad/bmb/workflows/module/steps-e/step-02-select-edit.md create mode 100644 _bmad/bmb/workflows/module/steps-e/step-03-apply-edit.md create mode 100644 _bmad/bmb/workflows/module/steps-e/step-04-review.md create mode 100644 _bmad/bmb/workflows/module/steps-e/step-05-confirm.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-01-load-target.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-02-file-structure.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-03-module-yaml.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-04-agent-specs.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-05-workflow-specs.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-06-documentation.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-07-installation.md create mode 100644 _bmad/bmb/workflows/module/steps-v/step-08-report.md create mode 100644 _bmad/bmb/workflows/module/templates/brief-template.md create mode 100644 _bmad/bmb/workflows/module/templates/workflow-spec-template.md create mode 100644 _bmad/bmb/workflows/module/workflow-create-module-brief.md create mode 100644 _bmad/bmb/workflows/module/workflow-create-module.md create mode 100644 _bmad/bmb/workflows/module/workflow-edit-module.md create mode 100644 _bmad/bmb/workflows/module/workflow-validate-module.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md delete mode 100644 _bmad/bmb/workflows/workflow-compliance-check/workflow.md create mode 100644 _bmad/bmb/workflows/workflow/data/architecture.md create mode 100644 _bmad/bmb/workflows/workflow/data/common-workflow-tools.csv create mode 100644 _bmad/bmb/workflows/workflow/data/csv-data-file-standards.md create mode 100644 _bmad/bmb/workflows/workflow/data/frontmatter-standards.md create mode 100644 _bmad/bmb/workflows/workflow/data/input-discovery-standards.md create mode 100644 _bmad/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md create mode 100644 _bmad/bmb/workflows/workflow/data/menu-handling-standards.md create mode 100644 _bmad/bmb/workflows/workflow/data/output-format-standards.md create mode 100644 _bmad/bmb/workflows/workflow/data/step-file-rules.md create mode 100644 _bmad/bmb/workflows/workflow/data/step-type-patterns.md create mode 100644 _bmad/bmb/workflows/workflow/data/subprocess-optimization-patterns.md create mode 100644 _bmad/bmb/workflows/workflow/data/trimodal-workflow-structure.md create mode 100644 _bmad/bmb/workflows/workflow/data/workflow-chaining-standards.md create mode 100644 _bmad/bmb/workflows/workflow/data/workflow-examples.md create mode 100644 _bmad/bmb/workflows/workflow/data/workflow-type-criteria.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-00-conversion.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-01-discovery.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-01b-continuation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-02-classification.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-03-requirements.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-04-tools.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-05-plan-review.md rename _bmad/bmb/workflows/{create-workflow/steps => workflow/steps-c}/step-06-design.md (63%) create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-07-foundation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-08-build-step-01.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-09-build-next-step.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-10-confirmation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-c/step-11-completion.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md create mode 100644 _bmad/bmb/workflows/workflow/steps-e/step-e-07-complete.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-01-validate.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-01b-structure.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-02b-path-violations.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-03-menu-validation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-10-report-complete.md create mode 100644 _bmad/bmb/workflows/workflow/steps-v/step-11-plan-validation.md create mode 100644 _bmad/bmb/workflows/workflow/templates/minimal-output-template.md rename _bmad/bmb/{docs/workflows => workflows/workflow}/templates/step-01-init-continuable-template.md (97%) rename _bmad/bmb/{docs/workflows => workflows/workflow}/templates/step-1b-template.md (99%) rename _bmad/bmb/{docs/workflows => workflows/workflow}/templates/step-template.md (88%) rename _bmad/bmb/{docs/workflows => workflows/workflow}/templates/workflow-template.md (94%) create mode 100644 _bmad/bmb/workflows/workflow/workflow-create-workflow.md rename _bmad/bmb/{reference/workflows/meal-prep-nutrition/workflow.md => workflows/workflow/workflow-edit-workflow.md} (63%) rename _bmad/bmb/workflows/{edit-workflow/workflow.md => workflow/workflow-rework-workflow.md} (70%) rename _bmad/bmb/workflows/{create-workflow/data/examples/meal-prep-nutrition/workflow.md => workflow/workflow-validate-max-parallel-workflow.md} (54%) rename _bmad/bmb/workflows/{create-workflow/workflow.md => workflow/workflow-validate-workflow.md} (71%) delete mode 100644 _bmad/bmgd/agents/game-architect.md delete mode 100644 _bmad/bmgd/agents/game-designer.md delete mode 100644 _bmad/bmgd/agents/game-dev.md delete mode 100644 _bmad/bmgd/agents/game-qa.md delete mode 100644 _bmad/bmgd/agents/game-scrum-master.md delete mode 100644 _bmad/bmgd/agents/game-solo-dev.md delete mode 100644 _bmad/bmgd/config.yaml delete mode 100644 _bmad/bmgd/gametest/knowledge/balance-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/certification-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/compatibility-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/godot-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/input-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/localization-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/multiplayer-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/performance-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/playtesting.md delete mode 100644 _bmad/bmgd/gametest/knowledge/qa-automation.md delete mode 100644 _bmad/bmgd/gametest/knowledge/regression-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/save-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/smoke-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/test-priorities.md delete mode 100644 _bmad/bmgd/gametest/knowledge/unity-testing.md delete mode 100644 _bmad/bmgd/gametest/knowledge/unreal-testing.md delete mode 100644 _bmad/bmgd/gametest/qa-index.csv delete mode 100644 _bmad/bmgd/teams/default-party.csv delete mode 100644 _bmad/bmgd/teams/team-gamedev.yaml delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/game-brain-methods.csv delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/game-context.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/checklist.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/instructions.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/templates/game-brief-template.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md delete mode 100644 _bmad/bmgd/workflows/1-preproduction/game-brief/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/checklist.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types.csv delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/action-platformer.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/adventure.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/card-game.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/fighting.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/horror.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/idle-incremental.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/metroidvania.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/moba.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/party-game.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/puzzle.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/racing.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/rhythm.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/roguelike.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/rpg.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/sandbox.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/shooter.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/simulation.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/sports.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/strategy.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/survival.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/text-based.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/tower-defense.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/turn-based-tactics.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/game-types/visual-novel.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-01-init.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-02-context.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-04-vision.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-08-progression.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-09-levels.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-11-technical.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-12-epics.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/steps/step-14-complete.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/templates/gdd-template.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/workflow.md delete mode 100644 _bmad/bmgd/workflows/2-design/gdd/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/checklist.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/instructions-narrative.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-01-init.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-03-story.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-04-characters.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-05-world.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-09-integration.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-10-production.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/steps/step-11-complete.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/templates/narrative-template.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/workflow.md delete mode 100644 _bmad/bmgd/workflows/2-design/narrative/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/architecture-patterns.yaml delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/checklist.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/decision-catalog.yaml delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/instructions.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/pattern-categories.csv delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/templates/architecture-template.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/workflow.md delete mode 100644 _bmad/bmgd/workflows/3-technical/game-architecture/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/3-technical/generate-project-context/project-context-template.md delete mode 100644 _bmad/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md delete mode 100644 _bmad/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md delete mode 100644 _bmad/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md delete mode 100644 _bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md delete mode 100644 _bmad/bmgd/workflows/4-production/code-review/backlog-template.md delete mode 100644 _bmad/bmgd/workflows/4-production/code-review/checklist.md delete mode 100644 _bmad/bmgd/workflows/4-production/code-review/instructions.xml delete mode 100644 _bmad/bmgd/workflows/4-production/code-review/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/correct-course/checklist.md delete mode 100644 _bmad/bmgd/workflows/4-production/correct-course/instructions.md delete mode 100644 _bmad/bmgd/workflows/4-production/correct-course/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/create-story/checklist.md delete mode 100644 _bmad/bmgd/workflows/4-production/create-story/instructions.xml delete mode 100644 _bmad/bmgd/workflows/4-production/create-story/template.md delete mode 100644 _bmad/bmgd/workflows/4-production/create-story/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/dev-story/checklist.md delete mode 100644 _bmad/bmgd/workflows/4-production/dev-story/instructions.xml delete mode 100644 _bmad/bmgd/workflows/4-production/dev-story/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/retrospective/instructions.md delete mode 100644 _bmad/bmgd/workflows/4-production/retrospective/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/sprint-planning/checklist.md delete mode 100644 _bmad/bmgd/workflows/4-production/sprint-planning/instructions.md delete mode 100644 _bmad/bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/4-production/sprint-status/instructions.md delete mode 100644 _bmad/bmgd/workflows/4-production/sprint-status/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/instructions.md delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/checklist.md delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/instructions.md delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/checklist.md delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/instructions.md delete mode 100644 _bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/gametest/automate/checklist.md delete mode 100644 _bmad/bmgd/workflows/gametest/automate/instructions.md delete mode 100644 _bmad/bmgd/workflows/gametest/automate/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/gametest/performance/checklist.md delete mode 100644 _bmad/bmgd/workflows/gametest/performance/instructions.md delete mode 100644 _bmad/bmgd/workflows/gametest/performance/performance-template.md delete mode 100644 _bmad/bmgd/workflows/gametest/performance/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/gametest/playtest-plan/checklist.md delete mode 100644 _bmad/bmgd/workflows/gametest/playtest-plan/instructions.md delete mode 100644 _bmad/bmgd/workflows/gametest/playtest-plan/playtest-template.md delete mode 100644 _bmad/bmgd/workflows/gametest/playtest-plan/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/gametest/test-design/checklist.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-design/instructions.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-design/test-design-template.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-design/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/gametest/test-framework/checklist.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-framework/instructions.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-framework/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/gametest/test-review/checklist.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-review/instructions.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-review/test-review-template.md delete mode 100644 _bmad/bmgd/workflows/gametest/test-review/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/init/instructions.md delete mode 100644 _bmad/bmgd/workflows/workflow-status/init/workflow.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/instructions.md delete mode 100644 _bmad/bmgd/workflows/workflow-status/paths/gamedev-brownfield.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/paths/gamedev-greenfield.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/paths/quickflow-greenfield.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/project-levels.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/workflow-status-template.yaml delete mode 100644 _bmad/bmgd/workflows/workflow-status/workflow.yaml create mode 100644 _bmad/bmm/agents/qa.md delete mode 100644 _bmad/bmm/agents/tea.md delete mode 100644 _bmad/bmm/agents/tech-writer.md create mode 100644 _bmad/bmm/agents/tech-writer/tech-writer.md delete mode 100644 _bmad/bmm/data/README.md create mode 100644 _bmad/bmm/module-help.csv delete mode 100644 _bmad/bmm/testarch/knowledge/api-request.md delete mode 100644 _bmad/bmm/testarch/knowledge/auth-session.md delete mode 100644 _bmad/bmm/testarch/knowledge/burn-in.md delete mode 100644 _bmad/bmm/testarch/knowledge/ci-burn-in.md delete mode 100644 _bmad/bmm/testarch/knowledge/component-tdd.md delete mode 100644 _bmad/bmm/testarch/knowledge/contract-testing.md delete mode 100644 _bmad/bmm/testarch/knowledge/data-factories.md delete mode 100644 _bmad/bmm/testarch/knowledge/email-auth.md delete mode 100644 _bmad/bmm/testarch/knowledge/error-handling.md delete mode 100644 _bmad/bmm/testarch/knowledge/feature-flags.md delete mode 100644 _bmad/bmm/testarch/knowledge/file-utils.md delete mode 100644 _bmad/bmm/testarch/knowledge/fixture-architecture.md delete mode 100644 _bmad/bmm/testarch/knowledge/fixtures-composition.md delete mode 100644 _bmad/bmm/testarch/knowledge/intercept-network-call.md delete mode 100644 _bmad/bmm/testarch/knowledge/log.md delete mode 100644 _bmad/bmm/testarch/knowledge/network-error-monitor.md delete mode 100644 _bmad/bmm/testarch/knowledge/network-first.md delete mode 100644 _bmad/bmm/testarch/knowledge/network-recorder.md delete mode 100644 _bmad/bmm/testarch/knowledge/nfr-criteria.md delete mode 100644 _bmad/bmm/testarch/knowledge/overview.md delete mode 100644 _bmad/bmm/testarch/knowledge/playwright-config.md delete mode 100644 _bmad/bmm/testarch/knowledge/probability-impact.md delete mode 100644 _bmad/bmm/testarch/knowledge/recurse.md delete mode 100644 _bmad/bmm/testarch/knowledge/risk-governance.md delete mode 100644 _bmad/bmm/testarch/knowledge/selective-testing.md delete mode 100644 _bmad/bmm/testarch/knowledge/selector-resilience.md delete mode 100644 _bmad/bmm/testarch/knowledge/test-healing-patterns.md delete mode 100644 _bmad/bmm/testarch/knowledge/test-levels-framework.md delete mode 100644 _bmad/bmm/testarch/knowledge/test-priorities-matrix.md delete mode 100644 _bmad/bmm/testarch/knowledge/test-quality.md delete mode 100644 _bmad/bmm/testarch/knowledge/timing-debugging.md delete mode 100644 _bmad/bmm/testarch/knowledge/visual-debugging.md delete mode 100644 _bmad/bmm/testarch/tea-index.csv delete mode 100644 _bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md create mode 100644 _bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md create mode 100644 _bmad/bmm/workflows/1-analysis/research/workflow-market-research.md create mode 100644 _bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md delete mode 100644 _bmad/bmm/workflows/1-analysis/research/workflow.md rename _bmad/bmm/workflows/2-plan-workflows/{prd => create-prd/data}/domain-complexity.csv (76%) create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md rename _bmad/bmm/workflows/2-plan-workflows/{prd => create-prd/data}/project-types.csv (100%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-01-init.md (91%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-01b-continue.md (70%) create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-03-success.md (55%) create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-06-innovation.md (58%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-07-project-type.md (68%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-08-scoping.md (53%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-09-functional.md (70%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/steps => create-prd/steps-c}/step-10-nonfunctional.md (64%) create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md rename _bmad/bmm/workflows/2-plan-workflows/{prd => create-prd/templates}/prd-template.md (93%) rename _bmad/bmm/workflows/2-plan-workflows/{prd/workflow.md => create-prd/workflow-create-prd.md} (66%) rename _bmad/{bmb/docs/workflows/templates/workflow.md => bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md} (60%) create mode 100644 _bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md delete mode 100644 _bmad/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md delete mode 100644 _bmad/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md delete mode 100644 _bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md delete mode 100644 _bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md rename _bmad/bmm/workflows/bmad-quick-flow/{create-tech-spec => quick-spec}/steps/step-01-understand.md (79%) rename _bmad/bmm/workflows/bmad-quick-flow/{create-tech-spec => quick-spec}/steps/step-02-investigate.md (78%) rename _bmad/bmm/workflows/bmad-quick-flow/{create-tech-spec => quick-spec}/steps/step-03-generate.md (94%) rename _bmad/bmm/workflows/bmad-quick-flow/{create-tech-spec => quick-spec}/steps/step-04-review.md (60%) rename _bmad/bmm/workflows/bmad-quick-flow/{create-tech-spec => quick-spec}/tech-spec-template.md (100%) rename _bmad/bmm/workflows/bmad-quick-flow/{create-tech-spec => quick-spec}/workflow.md (92%) delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md delete mode 100644 _bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml create mode 100644 _bmad/bmm/workflows/qa/automate/checklist.md create mode 100644 _bmad/bmm/workflows/qa/automate/instructions.md create mode 100644 _bmad/bmm/workflows/qa/automate/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md delete mode 100644 _bmad/bmm/workflows/testarch/atdd/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/atdd/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/atdd/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/automate/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/automate/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/automate/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/ci/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/ci/github-actions-template.yaml delete mode 100644 _bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml delete mode 100644 _bmad/bmm/workflows/testarch/ci/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/ci/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/framework/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/framework/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/framework/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/nfr-assess/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/nfr-assess/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md delete mode 100644 _bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/test-design/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/test-design/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/test-design/test-design-template.md delete mode 100644 _bmad/bmm/workflows/testarch/test-design/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/test-review/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/test-review/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/test-review/test-review-template.md delete mode 100644 _bmad/bmm/workflows/testarch/test-review/workflow.yaml delete mode 100644 _bmad/bmm/workflows/testarch/trace/checklist.md delete mode 100644 _bmad/bmm/workflows/testarch/trace/instructions.md delete mode 100644 _bmad/bmm/workflows/testarch/trace/trace-template.md delete mode 100644 _bmad/bmm/workflows/testarch/trace/workflow.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/init/instructions.md delete mode 100644 _bmad/bmm/workflows/workflow-status/init/workflow.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/instructions.md delete mode 100644 _bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/project-levels.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/workflow-status-template.yaml delete mode 100644 _bmad/bmm/workflows/workflow-status/workflow.yaml create mode 100644 _bmad/cis/module-help.csv create mode 100644 _bmad/core/module-help.csv delete mode 100644 _bmad/core/resources/excalidraw/README.md delete mode 100644 _bmad/core/resources/excalidraw/excalidraw-helpers.md delete mode 100644 _bmad/core/resources/excalidraw/library-loader.md delete mode 100644 _bmad/core/resources/excalidraw/validate-json-instructions.md create mode 100644 _bmad/core/tasks/editorial-review-prose.xml create mode 100644 _bmad/core/tasks/editorial-review-structure.xml create mode 100644 _bmad/core/tasks/help.md delete mode 100644 _bmad/core/tasks/validate-workflow.xml diff --git a/.agent/workflows/bmad/bmad-core-agents-bmad-master.md b/.agent/workflows/bmad-agent-bmad-master.md similarity index 56% rename from .agent/workflows/bmad/bmad-core-agents-bmad-master.md rename to .agent/workflows/bmad-agent-bmad-master.md index 07d3997..fcf0a08 100644 --- a/.agent/workflows/bmad/bmad-core-agents-bmad-master.md +++ b/.agent/workflows/bmad-agent-bmad-master.md @@ -1,14 +1,16 @@ --- name: 'bmad-master' description: 'bmad-master agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/core/agents/bmad-master.md +1. LOAD the FULL agent file from {project-root}/_bmad/core/agents/bmad-master.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmb-agents-agent-builder.md b/.agent/workflows/bmad-agent-bmb-agent-builder.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmb-agents-agent-builder.md rename to .agent/workflows/bmad-agent-bmb-agent-builder.md index 2dd96fa..33c52b8 100644 --- a/.agent/workflows/bmad/bmad-bmb-agents-agent-builder.md +++ b/.agent/workflows/bmad-agent-bmb-agent-builder.md @@ -1,14 +1,16 @@ --- name: 'agent-builder' description: 'agent-builder agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmb/agents/agent-builder.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmb/agents/agent-builder.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmb-agents-module-builder.md b/.agent/workflows/bmad-agent-bmb-module-builder.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmb-agents-module-builder.md rename to .agent/workflows/bmad-agent-bmb-module-builder.md index 2e35abe..2960169 100644 --- a/.agent/workflows/bmad/bmad-bmb-agents-module-builder.md +++ b/.agent/workflows/bmad-agent-bmb-module-builder.md @@ -1,14 +1,16 @@ --- name: 'module-builder' description: 'module-builder agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmb/agents/module-builder.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmb/agents/module-builder.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmb-agents-workflow-builder.md b/.agent/workflows/bmad-agent-bmb-workflow-builder.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmb-agents-workflow-builder.md rename to .agent/workflows/bmad-agent-bmb-workflow-builder.md index f388a48..c0c866d 100644 --- a/.agent/workflows/bmad/bmad-bmb-agents-workflow-builder.md +++ b/.agent/workflows/bmad-agent-bmb-workflow-builder.md @@ -1,14 +1,16 @@ --- name: 'workflow-builder' description: 'workflow-builder agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmb/agents/workflow-builder.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmb/agents/workflow-builder.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-analyst.md b/.agent/workflows/bmad-agent-bmm-analyst.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmm-agents-analyst.md rename to .agent/workflows/bmad-agent-bmm-analyst.md index 7224bfa..bac849d 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-analyst.md +++ b/.agent/workflows/bmad-agent-bmm-analyst.md @@ -1,14 +1,16 @@ --- name: 'analyst' description: 'analyst agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/analyst.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/analyst.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-architect.md b/.agent/workflows/bmad-agent-bmm-architect.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmm-agents-architect.md rename to .agent/workflows/bmad-agent-bmm-architect.md index 8bf9f3a..fc4ead3 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-architect.md +++ b/.agent/workflows/bmad-agent-bmm-architect.md @@ -1,14 +1,16 @@ --- name: 'architect' description: 'architect agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/architect.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/architect.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-dev.md b/.agent/workflows/bmad-agent-bmm-dev.md similarity index 55% rename from .agent/workflows/bmad/bmad-bmm-agents-dev.md rename to .agent/workflows/bmad-agent-bmm-dev.md index 171ad6e..e2d927e 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-dev.md +++ b/.agent/workflows/bmad-agent-bmm-dev.md @@ -1,14 +1,16 @@ --- name: 'dev' description: 'dev agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/dev.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/dev.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-pm.md b/.agent/workflows/bmad-agent-bmm-pm.md similarity index 55% rename from .agent/workflows/bmad/bmad-bmm-agents-pm.md rename to .agent/workflows/bmad-agent-bmm-pm.md index 347e7d4..d1b8daa 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-pm.md +++ b/.agent/workflows/bmad-agent-bmm-pm.md @@ -1,14 +1,16 @@ --- name: 'pm' description: 'pm agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/pm.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/pm.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmgd-agents-game-architect.md b/.agent/workflows/bmad-agent-bmm-qa.md similarity index 50% rename from .agent/workflows/bmad/bmad-bmgd-agents-game-architect.md rename to .agent/workflows/bmad-agent-bmm-qa.md index 7528a35..d8fef81 100644 --- a/.agent/workflows/bmad/bmad-bmgd-agents-game-architect.md +++ b/.agent/workflows/bmad-agent-bmm-qa.md @@ -1,14 +1,16 @@ --- -name: 'game-architect' -description: 'game-architect agent' +name: 'qa' +description: 'qa agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmgd/agents/game-architect.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/qa.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-quick-flow-solo-dev.md b/.agent/workflows/bmad-agent-bmm-quick-flow-solo-dev.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmm-agents-quick-flow-solo-dev.md rename to .agent/workflows/bmad-agent-bmm-quick-flow-solo-dev.md index 7a95656..c8e1840 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-quick-flow-solo-dev.md +++ b/.agent/workflows/bmad-agent-bmm-quick-flow-solo-dev.md @@ -1,14 +1,16 @@ --- name: 'quick-flow-solo-dev' description: 'quick-flow-solo-dev agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/quick-flow-solo-dev.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/quick-flow-solo-dev.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-sm.md b/.agent/workflows/bmad-agent-bmm-sm.md similarity index 55% rename from .agent/workflows/bmad/bmad-bmm-agents-sm.md rename to .agent/workflows/bmad-agent-bmm-sm.md index bf7d671..c7ee7db 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-sm.md +++ b/.agent/workflows/bmad-agent-bmm-sm.md @@ -1,14 +1,16 @@ --- name: 'sm' description: 'sm agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/sm.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/sm.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-tech-writer.md b/.agent/workflows/bmad-agent-bmm-tech-writer.md similarity index 55% rename from .agent/workflows/bmad/bmad-bmm-agents-tech-writer.md rename to .agent/workflows/bmad-agent-bmm-tech-writer.md index 1926e6e..c020ac9 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-tech-writer.md +++ b/.agent/workflows/bmad-agent-bmm-tech-writer.md @@ -1,14 +1,16 @@ --- name: 'tech-writer' description: 'tech-writer agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/tech-writer.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/tech-writer/tech-writer.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-bmm-agents-ux-designer.md b/.agent/workflows/bmad-agent-bmm-ux-designer.md similarity index 56% rename from .agent/workflows/bmad/bmad-bmm-agents-ux-designer.md rename to .agent/workflows/bmad-agent-bmm-ux-designer.md index 66a16bd..5dbb42b 100644 --- a/.agent/workflows/bmad/bmad-bmm-agents-ux-designer.md +++ b/.agent/workflows/bmad-agent-bmm-ux-designer.md @@ -1,14 +1,16 @@ --- name: 'ux-designer' description: 'ux-designer agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/bmm/agents/ux-designer.md +1. LOAD the FULL agent file from {project-root}/_bmad/bmm/agents/ux-designer.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-cis-agents-brainstorming-coach.md b/.agent/workflows/bmad-agent-cis-brainstorming-coach.md similarity index 56% rename from .agent/workflows/bmad/bmad-cis-agents-brainstorming-coach.md rename to .agent/workflows/bmad-agent-cis-brainstorming-coach.md index ee3aeb3..c581ebe 100644 --- a/.agent/workflows/bmad/bmad-cis-agents-brainstorming-coach.md +++ b/.agent/workflows/bmad-agent-cis-brainstorming-coach.md @@ -1,14 +1,16 @@ --- name: 'brainstorming-coach' description: 'brainstorming-coach agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/cis/agents/brainstorming-coach.md +1. LOAD the FULL agent file from {project-root}/_bmad/cis/agents/brainstorming-coach.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-cis-agents-creative-problem-solver.md b/.agent/workflows/bmad-agent-cis-creative-problem-solver.md similarity index 56% rename from .agent/workflows/bmad/bmad-cis-agents-creative-problem-solver.md rename to .agent/workflows/bmad-agent-cis-creative-problem-solver.md index 11dbb44..7974ff4 100644 --- a/.agent/workflows/bmad/bmad-cis-agents-creative-problem-solver.md +++ b/.agent/workflows/bmad-agent-cis-creative-problem-solver.md @@ -1,14 +1,16 @@ --- name: 'creative-problem-solver' description: 'creative-problem-solver agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/cis/agents/creative-problem-solver.md +1. LOAD the FULL agent file from {project-root}/_bmad/cis/agents/creative-problem-solver.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-cis-agents-design-thinking-coach.md b/.agent/workflows/bmad-agent-cis-design-thinking-coach.md similarity index 56% rename from .agent/workflows/bmad/bmad-cis-agents-design-thinking-coach.md rename to .agent/workflows/bmad-agent-cis-design-thinking-coach.md index dd61672..fc2a589 100644 --- a/.agent/workflows/bmad/bmad-cis-agents-design-thinking-coach.md +++ b/.agent/workflows/bmad-agent-cis-design-thinking-coach.md @@ -1,14 +1,16 @@ --- name: 'design-thinking-coach' description: 'design-thinking-coach agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/cis/agents/design-thinking-coach.md +1. LOAD the FULL agent file from {project-root}/_bmad/cis/agents/design-thinking-coach.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-cis-agents-innovation-strategist.md b/.agent/workflows/bmad-agent-cis-innovation-strategist.md similarity index 56% rename from .agent/workflows/bmad/bmad-cis-agents-innovation-strategist.md rename to .agent/workflows/bmad-agent-cis-innovation-strategist.md index 9155c72..df0e4b2 100644 --- a/.agent/workflows/bmad/bmad-cis-agents-innovation-strategist.md +++ b/.agent/workflows/bmad-agent-cis-innovation-strategist.md @@ -1,14 +1,16 @@ --- name: 'innovation-strategist' description: 'innovation-strategist agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/cis/agents/innovation-strategist.md +1. LOAD the FULL agent file from {project-root}/_bmad/cis/agents/innovation-strategist.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-cis-agents-presentation-master.md b/.agent/workflows/bmad-agent-cis-presentation-master.md similarity index 56% rename from .agent/workflows/bmad/bmad-cis-agents-presentation-master.md rename to .agent/workflows/bmad-agent-cis-presentation-master.md index 19340d9..830129b 100644 --- a/.agent/workflows/bmad/bmad-cis-agents-presentation-master.md +++ b/.agent/workflows/bmad-agent-cis-presentation-master.md @@ -1,14 +1,16 @@ --- name: 'presentation-master' description: 'presentation-master agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/cis/agents/presentation-master.md +1. LOAD the FULL agent file from {project-root}/_bmad/cis/agents/presentation-master.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad/bmad-cis-agents-storyteller-storyteller.md b/.agent/workflows/bmad-agent-cis-storyteller.md similarity index 55% rename from .agent/workflows/bmad/bmad-cis-agents-storyteller-storyteller.md rename to .agent/workflows/bmad-agent-cis-storyteller.md index 06f816f..b6b2266 100644 --- a/.agent/workflows/bmad/bmad-cis-agents-storyteller-storyteller.md +++ b/.agent/workflows/bmad-agent-cis-storyteller.md @@ -1,14 +1,16 @@ --- name: 'storyteller' description: 'storyteller agent' +disable-model-invocation: true --- You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. -1. LOAD the FULL agent file from @_bmad/cis/agents/storyteller/storyteller.md +1. LOAD the FULL agent file from {project-root}/_bmad/cis/agents/storyteller/storyteller.md 2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session +3. FOLLOW every step in the section precisely +4. DISPLAY the welcome/greeting as instructed +5. PRESENT the numbered menu +6. WAIT for user input before proceeding diff --git a/.agent/workflows/bmad-bmb-create-agent.md b/.agent/workflows/bmad-bmb-create-agent.md new file mode 100644 index 0000000..02d3f1c --- /dev/null +++ b/.agent/workflows/bmad-bmb-create-agent.md @@ -0,0 +1,7 @@ +--- +name: 'create-agent' +description: 'Create a new BMAD agent with best practices and compliance' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/agent/workflow-create-agent.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-create-module-brief.md b/.agent/workflows/bmad-bmb-create-module-brief.md new file mode 100644 index 0000000..c499d1c --- /dev/null +++ b/.agent/workflows/bmad-bmb-create-module-brief.md @@ -0,0 +1,7 @@ +--- +name: 'create-module-brief' +description: 'Create product brief for BMAD module development' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/module/workflow-create-module-brief.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-create-module.md b/.agent/workflows/bmad-bmb-create-module.md new file mode 100644 index 0000000..5f237a5 --- /dev/null +++ b/.agent/workflows/bmad-bmb-create-module.md @@ -0,0 +1,7 @@ +--- +name: 'create-module' +description: 'Create a complete BMAD module with agents, workflows, and infrastructure' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/module/workflow-create-module.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-create-workflow.md b/.agent/workflows/bmad-bmb-create-workflow.md new file mode 100644 index 0000000..bf1f700 --- /dev/null +++ b/.agent/workflows/bmad-bmb-create-workflow.md @@ -0,0 +1,7 @@ +--- +name: 'create-workflow' +description: 'Create a new BMAD workflow with proper structure and best practices' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/workflow/workflow-create-workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-edit-agent.md b/.agent/workflows/bmad-bmb-edit-agent.md new file mode 100644 index 0000000..8d73fb9 --- /dev/null +++ b/.agent/workflows/bmad-bmb-edit-agent.md @@ -0,0 +1,7 @@ +--- +name: 'edit-agent' +description: 'Edit existing BMAD agents while maintaining compliance' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/agent/workflow-edit-agent.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-edit-module.md b/.agent/workflows/bmad-bmb-edit-module.md new file mode 100644 index 0000000..22c66eb --- /dev/null +++ b/.agent/workflows/bmad-bmb-edit-module.md @@ -0,0 +1,7 @@ +--- +name: 'edit-module' +description: 'Edit existing BMAD modules while maintaining coherence' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/module/workflow-edit-module.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-edit-workflow.md b/.agent/workflows/bmad-bmb-edit-workflow.md new file mode 100644 index 0000000..24514eb --- /dev/null +++ b/.agent/workflows/bmad-bmb-edit-workflow.md @@ -0,0 +1,7 @@ +--- +name: 'edit-workflow' +description: 'Edit existing BMAD workflows while maintaining integrity' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/workflow/workflow-edit-workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-rework-workflow.md b/.agent/workflows/bmad-bmb-rework-workflow.md new file mode 100644 index 0000000..8c7490a --- /dev/null +++ b/.agent/workflows/bmad-bmb-rework-workflow.md @@ -0,0 +1,7 @@ +--- +name: 'rework-workflow' +description: 'Rework a Workflow to a V6 Compliant Version' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/workflow/workflow-rework-workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-validate-agent.md b/.agent/workflows/bmad-bmb-validate-agent.md new file mode 100644 index 0000000..a704980 --- /dev/null +++ b/.agent/workflows/bmad-bmb-validate-agent.md @@ -0,0 +1,7 @@ +--- +name: 'validate-agent' +description: 'Validate existing BMAD agents and offer to improve deficiencies' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/agent/workflow-validate-agent.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-validate-max-parallel-workflow.md b/.agent/workflows/bmad-bmb-validate-max-parallel-workflow.md new file mode 100644 index 0000000..f9a683b --- /dev/null +++ b/.agent/workflows/bmad-bmb-validate-max-parallel-workflow.md @@ -0,0 +1,7 @@ +--- +name: 'validate-max-parallel-workflow' +description: 'Run validation checks in MAX-PARALLEL mode against a workflow requires a tool that supports Parallel Sub-Processes' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-validate-module.md b/.agent/workflows/bmad-bmb-validate-module.md new file mode 100644 index 0000000..1c6e306 --- /dev/null +++ b/.agent/workflows/bmad-bmb-validate-module.md @@ -0,0 +1,7 @@ +--- +name: 'validate-module' +description: 'Run compliance check on BMAD modules against best practices' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/module/workflow-validate-module.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmb-validate-workflow.md b/.agent/workflows/bmad-bmb-validate-workflow.md new file mode 100644 index 0000000..ae31b32 --- /dev/null +++ b/.agent/workflows/bmad-bmb-validate-workflow.md @@ -0,0 +1,7 @@ +--- +name: 'validate-workflow' +description: 'Run validation check on BMAD workflows against best practices' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmb/workflows/workflow/workflow-validate-workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-check-implementation-readiness.md b/.agent/workflows/bmad-bmm-check-implementation-readiness.md new file mode 100644 index 0000000..152667e --- /dev/null +++ b/.agent/workflows/bmad-bmm-check-implementation-readiness.md @@ -0,0 +1,7 @@ +--- +name: 'check-implementation-readiness' +description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-code-review.md b/.agent/workflows/bmad-bmm-code-review.md similarity index 65% rename from .agent/workflows/bmad/bmad-bmm-workflows-code-review.md rename to .agent/workflows/bmad-bmm-code-review.md index ae4a62f..83b5a6a 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-code-review.md +++ b/.agent/workflows/bmad-bmm-code-review.md @@ -1,13 +1,15 @@ --- +name: 'code-review' description: 'Perform an ADVERSARIAL Senior Developer code review that finds 3-10 specific problems in every story. Challenges everything: code quality, test coverage, architecture compliance, security, performance. NEVER accepts `looks good` - must find minimum issues and can auto-fix with user approval.' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/code-review/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-correct-course.md b/.agent/workflows/bmad-bmm-correct-course.md similarity index 58% rename from .agent/workflows/bmad/bmad-bmm-workflows-correct-course.md rename to .agent/workflows/bmad-bmm-correct-course.md index b5f0277..90359d0 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-correct-course.md +++ b/.agent/workflows/bmad-bmm-correct-course.md @@ -1,13 +1,15 @@ --- +name: 'correct-course' description: 'Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-architecture.md b/.agent/workflows/bmad-bmm-create-architecture.md similarity index 51% rename from .agent/workflows/bmad/bmad-bmm-workflows-create-architecture.md rename to .agent/workflows/bmad-bmm-create-architecture.md index 7117995..232b845 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-architecture.md +++ b/.agent/workflows/bmad-bmm-create-architecture.md @@ -1,5 +1,7 @@ --- +name: 'create-architecture' description: 'Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.' +disable-model-invocation: true --- -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md, READ its entire contents and follow its directions exactly! +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-epics-and-stories.md b/.agent/workflows/bmad-bmm-create-epics-and-stories.md similarity index 62% rename from .agent/workflows/bmad/bmad-bmm-workflows-create-epics-and-stories.md rename to .agent/workflows/bmad-bmm-create-epics-and-stories.md index 76e257a..a3fcfbe 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-epics-and-stories.md +++ b/.agent/workflows/bmad-bmm-create-epics-and-stories.md @@ -1,5 +1,7 @@ --- +name: 'create-epics-and-stories' description: 'Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.' +disable-model-invocation: true --- -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md, READ its entire contents and follow its directions exactly! +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-create-prd.md b/.agent/workflows/bmad-bmm-create-prd.md new file mode 100644 index 0000000..ef7210d --- /dev/null +++ b/.agent/workflows/bmad-bmm-create-prd.md @@ -0,0 +1,7 @@ +--- +name: 'create-prd' +description: 'Create a comprehensive PRD (Product Requirements Document) through structured workflow facilitation' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-create-product-brief.md b/.agent/workflows/bmad-bmm-create-product-brief.md new file mode 100644 index 0000000..a91f347 --- /dev/null +++ b/.agent/workflows/bmad-bmm-create-product-brief.md @@ -0,0 +1,7 @@ +--- +name: 'create-product-brief' +description: 'Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-story.md b/.agent/workflows/bmad-bmm-create-story.md similarity index 58% rename from .agent/workflows/bmad/bmad-bmm-workflows-create-story.md rename to .agent/workflows/bmad-bmm-create-story.md index d2f282c..b6ed179 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-story.md +++ b/.agent/workflows/bmad-bmm-create-story.md @@ -1,13 +1,15 @@ --- +name: 'create-story' description: 'Create the next user story from epics+stories with enhanced context analysis and direct ready-for-dev marking' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/create-story/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad-bmm-create-ux-design.md b/.agent/workflows/bmad-bmm-create-ux-design.md new file mode 100644 index 0000000..9985801 --- /dev/null +++ b/.agent/workflows/bmad-bmm-create-ux-design.md @@ -0,0 +1,7 @@ +--- +name: 'create-ux-design' +description: 'Work with a peer UX Design expert to plan your applications UX patterns, look and feel.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-dev-story.md b/.agent/workflows/bmad-bmm-dev-story.md similarity index 59% rename from .agent/workflows/bmad/bmad-bmgd-workflows-dev-story.md rename to .agent/workflows/bmad-bmm-dev-story.md index a8b771d..c3b073f 100644 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-dev-story.md +++ b/.agent/workflows/bmad-bmm-dev-story.md @@ -1,13 +1,15 @@ --- +name: 'dev-story' description: 'Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/dev-story/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-document-project.md b/.agent/workflows/bmad-bmm-document-project.md similarity index 62% rename from .agent/workflows/bmad/bmad-bmm-workflows-document-project.md rename to .agent/workflows/bmad-bmm-document-project.md index d5295d7..3de1703 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-document-project.md +++ b/.agent/workflows/bmad-bmm-document-project.md @@ -1,13 +1,15 @@ --- +name: 'document-project' description: 'Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/document-project/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/document-project/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad-bmm-domain-research.md b/.agent/workflows/bmad-bmm-domain-research.md new file mode 100644 index 0000000..056cddd --- /dev/null +++ b/.agent/workflows/bmad-bmm-domain-research.md @@ -0,0 +1,7 @@ +--- +name: 'domain-research' +description: 'Conduct domain research covering industry analysis, regulations, technology trends, and ecosystem dynamics using current web data and verified sources.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-edit-prd.md b/.agent/workflows/bmad-bmm-edit-prd.md new file mode 100644 index 0000000..535f78d --- /dev/null +++ b/.agent/workflows/bmad-bmm-edit-prd.md @@ -0,0 +1,7 @@ +--- +name: 'edit-prd' +description: 'Edit and improve an existing PRD - enhance clarity, completeness, and quality' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-generate-project-context.md b/.agent/workflows/bmad-bmm-generate-project-context.md new file mode 100644 index 0000000..452871c --- /dev/null +++ b/.agent/workflows/bmad-bmm-generate-project-context.md @@ -0,0 +1,7 @@ +--- +name: 'generate-project-context' +description: 'Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/generate-project-context/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-market-research.md b/.agent/workflows/bmad-bmm-market-research.md new file mode 100644 index 0000000..65a6dbe --- /dev/null +++ b/.agent/workflows/bmad-bmm-market-research.md @@ -0,0 +1,7 @@ +--- +name: 'market-research' +description: 'Conduct market research covering market size, growth, competition, and customer insights using current web data and verified sources.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow-market-research.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-sprint-status.md b/.agent/workflows/bmad-bmm-qa-automate.md similarity index 51% rename from .agent/workflows/bmad/bmad-bmgd-workflows-sprint-status.md rename to .agent/workflows/bmad-bmm-qa-automate.md index 457f6f9..8fd7c01 100644 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-sprint-status.md +++ b/.agent/workflows/bmad-bmm-qa-automate.md @@ -1,13 +1,15 @@ --- -description: 'Summarize sprint-status.yaml for game project, surface risks, and route to the right implementation workflow.' +name: 'qa-automate' +description: 'Generate tests quickly for existing features using standard test patterns' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/sprint-status/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/sprint-status/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad-bmm-quick-dev.md b/.agent/workflows/bmad-bmm-quick-dev.md new file mode 100644 index 0000000..6b471e0 --- /dev/null +++ b/.agent/workflows/bmad-bmm-quick-dev.md @@ -0,0 +1,7 @@ +--- +name: 'quick-dev' +description: 'Flexible development - execute tech-specs OR direct instructions with optional planning.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-quick-spec.md b/.agent/workflows/bmad-bmm-quick-spec.md new file mode 100644 index 0000000..4aca449 --- /dev/null +++ b/.agent/workflows/bmad-bmm-quick-spec.md @@ -0,0 +1,7 @@ +--- +name: 'quick-spec' +description: 'Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-retrospective.md b/.agent/workflows/bmad-bmm-retrospective.md similarity index 60% rename from .agent/workflows/bmad/bmad-bmgd-workflows-retrospective.md rename to .agent/workflows/bmad-bmm-retrospective.md index 4dd8bae..ae16aaf 100644 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-retrospective.md +++ b/.agent/workflows/bmad-bmm-retrospective.md @@ -1,13 +1,15 @@ --- +name: 'retrospective' description: 'Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/retrospective/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/retrospective/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-sprint-planning.md b/.agent/workflows/bmad-bmm-sprint-planning.md similarity index 61% rename from .agent/workflows/bmad/bmad-bmgd-workflows-sprint-planning.md rename to .agent/workflows/bmad-bmm-sprint-planning.md index cba2b9c..1026360 100644 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-sprint-planning.md +++ b/.agent/workflows/bmad-bmm-sprint-planning.md @@ -1,13 +1,15 @@ --- +name: 'sprint-planning' description: 'Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-sprint-status.md b/.agent/workflows/bmad-bmm-sprint-status.md similarity index 57% rename from .agent/workflows/bmad/bmad-bmm-workflows-sprint-status.md rename to .agent/workflows/bmad-bmm-sprint-status.md index d4ec9a0..edc1c7c 100644 --- a/.agent/workflows/bmad/bmad-bmm-workflows-sprint-status.md +++ b/.agent/workflows/bmad-bmm-sprint-status.md @@ -1,13 +1,15 @@ --- +name: 'sprint-status' description: 'Summarize sprint-status.yaml, surface risks, and route to the right implementation workflow.' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad-bmm-technical-research.md b/.agent/workflows/bmad-bmm-technical-research.md new file mode 100644 index 0000000..0670fd6 --- /dev/null +++ b/.agent/workflows/bmad-bmm-technical-research.md @@ -0,0 +1,7 @@ +--- +name: 'technical-research' +description: 'Conduct technical research covering technology evaluation, architecture decisions, and implementation approaches using current web data and verified sources.' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-bmm-validate-prd.md b/.agent/workflows/bmad-bmm-validate-prd.md new file mode 100644 index 0000000..7e33c91 --- /dev/null +++ b/.agent/workflows/bmad-bmm-validate-prd.md @@ -0,0 +1,7 @@ +--- +name: 'validate-prd' +description: 'Validate an existing PRD against BMAD standards - comprehensive review for completeness, clarity, and quality' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-brainstorming.md b/.agent/workflows/bmad-brainstorming.md new file mode 100644 index 0000000..7256342 --- /dev/null +++ b/.agent/workflows/bmad-brainstorming.md @@ -0,0 +1,7 @@ +--- +name: 'brainstorming' +description: 'Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/core/workflows/brainstorming/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-cis-workflows-design-thinking.md b/.agent/workflows/bmad-cis-design-thinking.md similarity index 64% rename from .agent/workflows/bmad/bmad-cis-workflows-design-thinking.md rename to .agent/workflows/bmad-cis-design-thinking.md index 402ce80..6c8e636 100644 --- a/.agent/workflows/bmad/bmad-cis-workflows-design-thinking.md +++ b/.agent/workflows/bmad-cis-design-thinking.md @@ -1,13 +1,15 @@ --- +name: 'design-thinking' description: 'Guide human-centered design processes using empathy-driven methodologies. This workflow walks through the design thinking phases - Empathize, Define, Ideate, Prototype, and Test - to create solutions deeply rooted in user needs.' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/cis/workflows/design-thinking/workflow.yaml -3. Pass the yaml path _bmad/cis/workflows/design-thinking/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/cis/workflows/design-thinking/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/cis/workflows/design-thinking/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-cis-workflows-innovation-strategy.md b/.agent/workflows/bmad-cis-innovation-strategy.md similarity index 64% rename from .agent/workflows/bmad/bmad-cis-workflows-innovation-strategy.md rename to .agent/workflows/bmad-cis-innovation-strategy.md index 761734b..0b977eb 100644 --- a/.agent/workflows/bmad/bmad-cis-workflows-innovation-strategy.md +++ b/.agent/workflows/bmad-cis-innovation-strategy.md @@ -1,13 +1,15 @@ --- +name: 'innovation-strategy' description: 'Identify disruption opportunities and architect business model innovation. This workflow guides strategic analysis of markets, competitive dynamics, and business model innovation to uncover sustainable competitive advantages and breakthrough opportunities.' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/cis/workflows/innovation-strategy/workflow.yaml -3. Pass the yaml path _bmad/cis/workflows/innovation-strategy/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-cis-workflows-problem-solving.md b/.agent/workflows/bmad-cis-problem-solving.md similarity index 65% rename from .agent/workflows/bmad/bmad-cis-workflows-problem-solving.md rename to .agent/workflows/bmad-cis-problem-solving.md index ec388f5..9bfa669 100644 --- a/.agent/workflows/bmad/bmad-cis-workflows-problem-solving.md +++ b/.agent/workflows/bmad-cis-problem-solving.md @@ -1,13 +1,15 @@ --- +name: 'problem-solving' description: 'Apply systematic problem-solving methodologies to crack complex challenges. This workflow guides through problem diagnosis, root cause analysis, creative solution generation, evaluation, and implementation planning using proven frameworks.' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/cis/workflows/problem-solving/workflow.yaml -3. Pass the yaml path _bmad/cis/workflows/problem-solving/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/cis/workflows/problem-solving/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/cis/workflows/problem-solving/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad/bmad-cis-workflows-storytelling.md b/.agent/workflows/bmad-cis-storytelling.md similarity index 65% rename from .agent/workflows/bmad/bmad-cis-workflows-storytelling.md rename to .agent/workflows/bmad-cis-storytelling.md index 32f1e26..734cca4 100644 --- a/.agent/workflows/bmad/bmad-cis-workflows-storytelling.md +++ b/.agent/workflows/bmad-cis-storytelling.md @@ -1,13 +1,15 @@ --- +name: 'storytelling' description: 'Craft compelling narratives using proven story frameworks and techniques. This workflow guides users through structured narrative development, applying appropriate story frameworks to create emotionally resonant and engaging stories for any purpose.' +disable-model-invocation: true --- IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/cis/workflows/storytelling/workflow.yaml -3. Pass the yaml path _bmad/cis/workflows/storytelling/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions +1. Always LOAD the FULL @{project-root}/_bmad/core/tasks/workflow.xml +2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @{project-root}/_bmad/cis/workflows/storytelling/workflow.yaml +3. Pass the yaml path @{project-root}/_bmad/cis/workflows/storytelling/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions 4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions 5. Save outputs after EACH section when generating any documents from templates diff --git a/.agent/workflows/bmad-editorial-review-prose.md b/.agent/workflows/bmad-editorial-review-prose.md new file mode 100644 index 0000000..3b6c00c --- /dev/null +++ b/.agent/workflows/bmad-editorial-review-prose.md @@ -0,0 +1,10 @@ +--- +name: 'editorial-review-prose' +description: 'Clinical copy-editor that reviews text for communication issues' +--- + +# editorial-review-prose + +Read the entire task file at: {project-root}/_bmad/core/tasks/editorial-review-prose.xml + +Follow all instructions in the task file exactly as written. diff --git a/.agent/workflows/bmad-editorial-review-structure.md b/.agent/workflows/bmad-editorial-review-structure.md new file mode 100644 index 0000000..f1128a5 --- /dev/null +++ b/.agent/workflows/bmad-editorial-review-structure.md @@ -0,0 +1,10 @@ +--- +name: 'editorial-review-structure' +description: 'Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension' +--- + +# editorial-review-structure + +Read the entire task file at: {project-root}/_bmad/core/tasks/editorial-review-structure.xml + +Follow all instructions in the task file exactly as written. diff --git a/.agent/workflows/bmad-help.md b/.agent/workflows/bmad-help.md new file mode 100644 index 0000000..70af2fc --- /dev/null +++ b/.agent/workflows/bmad-help.md @@ -0,0 +1,10 @@ +--- +name: 'help' +description: 'Get unstuck by showing what workflow steps come next or answering questions about what to do' +--- + +# help + +Read the entire task file at: {project-root}/_bmad/core/tasks/help.md + +Follow all instructions in the task file exactly as written. diff --git a/.agent/workflows/bmad-index-docs.md b/.agent/workflows/bmad-index-docs.md new file mode 100644 index 0000000..e0d5b82 --- /dev/null +++ b/.agent/workflows/bmad-index-docs.md @@ -0,0 +1,10 @@ +--- +name: 'index-docs' +description: 'Generates or updates an index.md of all documents in the specified directory' +--- + +# index-docs + +Read the entire task file at: {project-root}/_bmad/core/tasks/index-docs.xml + +Follow all instructions in the task file exactly as written. diff --git a/.agent/workflows/bmad-party-mode.md b/.agent/workflows/bmad-party-mode.md new file mode 100644 index 0000000..f04b814 --- /dev/null +++ b/.agent/workflows/bmad-party-mode.md @@ -0,0 +1,7 @@ +--- +name: 'party-mode' +description: 'Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations' +disable-model-invocation: true +--- + +IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/core/workflows/party-mode/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad-review-adversarial-general.md b/.agent/workflows/bmad-review-adversarial-general.md new file mode 100644 index 0000000..17e1a33 --- /dev/null +++ b/.agent/workflows/bmad-review-adversarial-general.md @@ -0,0 +1,10 @@ +--- +name: 'review-adversarial-general' +description: 'Cynically review content and produce findings' +--- + +# review-adversarial-general + +Read the entire task file at: {project-root}/_bmad/core/tasks/review-adversarial-general.xml + +Follow all instructions in the task file exactly as written. diff --git a/.agent/workflows/bmad-shard-doc.md b/.agent/workflows/bmad-shard-doc.md new file mode 100644 index 0000000..0a38656 --- /dev/null +++ b/.agent/workflows/bmad-shard-doc.md @@ -0,0 +1,10 @@ +--- +name: 'shard-doc' +description: 'Splits large markdown documents into smaller, organized files based on level 2 (default) sections' +--- + +# shard-doc + +Read the entire task file at: {project-root}/_bmad/core/tasks/shard-doc.xml + +Follow all instructions in the task file exactly as written. diff --git a/.agent/workflows/bmad/bmad-bmb-workflows-Meal Prep & Nutrition Plan.md b/.agent/workflows/bmad/bmad-bmb-workflows-Meal Prep & Nutrition Plan.md deleted file mode 100644 index 72c7816..0000000 --- a/.agent/workflows/bmad/bmad-bmb-workflows-Meal Prep & Nutrition Plan.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Creates personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmb-workflows-agent.md b/.agent/workflows/bmad/bmad-bmb-workflows-agent.md deleted file mode 100644 index 94e4527..0000000 --- a/.agent/workflows/bmad/bmad-bmb-workflows-agent.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Tri-modal workflow for creating, editing, and validating BMAD Core compliant agents' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmb/workflows/agent/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmb-workflows-create-module.md b/.agent/workflows/bmad/bmad-bmb-workflows-create-module.md deleted file mode 100644 index 0202419..0000000 --- a/.agent/workflows/bmad/bmad-bmb-workflows-create-module.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Interactive workflow to build complete BMAD modules with agents, workflows, and installation infrastructure' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmb/workflows/create-module/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmb-workflows-create-workflow.md b/.agent/workflows/bmad/bmad-bmb-workflows-create-workflow.md deleted file mode 100644 index 5f00d59..0000000 --- a/.agent/workflows/bmad/bmad-bmb-workflows-create-workflow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Create structured standalone workflows using markdown-based step architecture' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmb/workflows/create-workflow/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmb-workflows-edit-workflow.md b/.agent/workflows/bmad/bmad-bmb-workflows-edit-workflow.md deleted file mode 100644 index 45878f3..0000000 --- a/.agent/workflows/bmad/bmad-bmb-workflows-edit-workflow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Intelligent workflow editor that helps modify existing workflows while following best practices' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmb/workflows/edit-workflow/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmb-workflows-workflow-compliance-check.md b/.agent/workflows/bmad/bmad-bmb-workflows-workflow-compliance-check.md deleted file mode 100644 index 059cda7..0000000 --- a/.agent/workflows/bmad/bmad-bmb-workflows-workflow-compliance-check.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Systematic validation of workflows against BMAD standards with adversarial analysis and detailed reporting' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmb/workflows/workflow-compliance-check/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-agents-game-designer.md b/.agent/workflows/bmad/bmad-bmgd-agents-game-designer.md deleted file mode 100644 index bb276b1..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-agents-game-designer.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 'game-designer' -description: 'game-designer agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from @_bmad/bmgd/agents/game-designer.md -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/.agent/workflows/bmad/bmad-bmgd-agents-game-dev.md b/.agent/workflows/bmad/bmad-bmgd-agents-game-dev.md deleted file mode 100644 index 00ecac8..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-agents-game-dev.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 'game-dev' -description: 'game-dev agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from @_bmad/bmgd/agents/game-dev.md -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/.agent/workflows/bmad/bmad-bmgd-agents-game-qa.md b/.agent/workflows/bmad/bmad-bmgd-agents-game-qa.md deleted file mode 100644 index cbb4434..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-agents-game-qa.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 'game-qa' -description: 'game-qa agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from @_bmad/bmgd/agents/game-qa.md -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/.agent/workflows/bmad/bmad-bmgd-agents-game-scrum-master.md b/.agent/workflows/bmad/bmad-bmgd-agents-game-scrum-master.md deleted file mode 100644 index 7873999..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-agents-game-scrum-master.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 'game-scrum-master' -description: 'game-scrum-master agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from @_bmad/bmgd/agents/game-scrum-master.md -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/.agent/workflows/bmad/bmad-bmgd-agents-game-solo-dev.md b/.agent/workflows/bmad/bmad-bmgd-agents-game-solo-dev.md deleted file mode 100644 index 24974f2..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-agents-game-solo-dev.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 'game-solo-dev' -description: 'game-solo-dev agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from @_bmad/bmgd/agents/game-solo-dev.md -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-brainstorm-game.md b/.agent/workflows/bmad/bmad-bmgd-workflows-brainstorm-game.md deleted file mode 100644 index 0422029..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-brainstorm-game.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Facilitate game brainstorming sessions with game-specific context, guidance, and game design techniques.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-code-review.md b/.agent/workflows/bmad/bmad-bmgd-workflows-code-review.md deleted file mode 100644 index 7b26134..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-code-review.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Perform an ADVERSARIAL Senior Developer code review that finds 3-10 specific problems in every story. Challenges everything: code quality, test coverage, architecture compliance, security, performance. NEVER accepts `looks good` - must find minimum issues and can auto-fix with user approval. Game-specific focus on 60fps, feel, and platform considerations.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/code-review/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/code-review/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-correct-course.md b/.agent/workflows/bmad/bmad-bmgd-workflows-correct-course.md deleted file mode 100644 index cfcd8ea..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-correct-course.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/correct-course/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-create-game-brief.md b/.agent/workflows/bmad/bmad-bmgd-workflows-create-game-brief.md deleted file mode 100644 index 4c3f36b..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-create-game-brief.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Creates a comprehensive Game Brief through collaborative step-by-step discovery to capture game vision before detailed design.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-create-gdd.md b/.agent/workflows/bmad/bmad-bmgd-workflows-create-gdd.md deleted file mode 100644 index 417d033..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-create-gdd.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Creates a comprehensive Game Design Document through collaborative step-by-step discovery between game designer and user.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmgd/workflows/2-design/gdd/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-create-story.md b/.agent/workflows/bmad/bmad-bmgd-workflows-create-story.md deleted file mode 100644 index ad75462..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-create-story.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/4-production/create-story/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/4-production/create-story/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-create-tech-spec.md b/.agent/workflows/bmad/bmad-bmgd-workflows-create-tech-spec.md deleted file mode 100644 index f957ebc..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-create-tech-spec.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Conversational spec engineering for games - ask questions, investigate code, produce implementation-ready tech-spec.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-game-architecture.md b/.agent/workflows/bmad/bmad-bmgd-workflows-game-architecture.md deleted file mode 100644 index 36ef327..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-game-architecture.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Collaborative game architecture workflow for AI-agent consistency. Intelligent, adaptive conversation that produces a decision-focused game architecture document covering engine, systems, networking, and technical design optimized for game development.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/3-technical/game-architecture/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/3-technical/game-architecture/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-game-brief.md b/.agent/workflows/bmad/bmad-bmgd-workflows-game-brief.md deleted file mode 100644 index e0303ff..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-game-brief.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Interactive game brief creation workflow that guides users through defining their game vision with multiple input sources and conversational collaboration' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/1-preproduction/game-brief/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-automate.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-automate.md deleted file mode 100644 index dfccaca..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-automate.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Generate automated game tests for Unity, Unreal, or Godot based on test design scenarios' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/gametest/automate/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/gametest/automate/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-framework.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-framework.md deleted file mode 100644 index cd6272a..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-framework.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Initialize game test framework architecture for Unity, Unreal Engine, or Godot projects' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/gametest/test-framework/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/gametest/test-framework/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-performance.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-performance.md deleted file mode 100644 index 7255df6..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-performance.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Design performance testing strategy for frame rate, memory, and loading times' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/gametest/performance/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/gametest/performance/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-playtest-plan.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-playtest-plan.md deleted file mode 100644 index 988d010..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-playtest-plan.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create structured playtesting sessions for gameplay validation and user feedback' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/gametest/playtest-plan/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/gametest/playtest-plan/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-design.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-design.md deleted file mode 100644 index 05ac011..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-design.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create comprehensive game test scenarios covering gameplay, progression, and quality requirements' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/gametest/test-design/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/gametest/test-design/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-review.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-review.md deleted file mode 100644 index 23879a3..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gametest-test-review.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Review test quality, coverage, and identify gaps in game testing' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/gametest/test-review/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/gametest/test-review/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-gdd.md b/.agent/workflows/bmad/bmad-bmgd-workflows-gdd.md deleted file mode 100644 index 0bf8eab..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-gdd.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/2-design/gdd/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/2-design/gdd/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-generate-project-context.md b/.agent/workflows/bmad/bmad-bmgd-workflows-generate-project-context.md deleted file mode 100644 index 71375b1..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-generate-project-context.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing game code. Optimized for LLM context efficiency.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-narrative.md b/.agent/workflows/bmad/bmad-bmgd-workflows-narrative.md deleted file mode 100644 index 264f45e..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-narrative.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Narrative design workflow for story-driven games. Creates comprehensive narrative documentation including story structure, character arcs, world-building, dialogue systems, and production planning.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/2-design/narrative/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/2-design/narrative/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-quick-dev.md b/.agent/workflows/bmad/bmad-bmgd-workflows-quick-dev.md deleted file mode 100644 index 09da4e5..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-quick-dev.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Flexible game development - execute tech-specs, implement features, or refactor code with game-specific considerations.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-quick-prototype.md b/.agent/workflows/bmad/bmad-bmgd-workflows-quick-prototype.md deleted file mode 100644 index e7df33a..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-quick-prototype.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Rapid game prototyping - quickly test gameplay ideas, mechanics, or features with minimal setup.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-workflow-init.md b/.agent/workflows/bmad/bmad-bmgd-workflows-workflow-init.md deleted file mode 100644 index e366e16..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-workflow-init.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Initialize a new BMGD game project by determining level, type, and creating workflow path' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/workflow-status/init/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/workflow-status/init/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmgd-workflows-workflow-status.md b/.agent/workflows/bmad/bmad-bmgd-workflows-workflow-status.md deleted file mode 100644 index 9ea158a..0000000 --- a/.agent/workflows/bmad/bmad-bmgd-workflows-workflow-status.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Lightweight status checker - answers ""what should I do now?"" for any game dev agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmgd/workflows/workflow-status/workflow.yaml -3. Pass the yaml path _bmad/bmgd/workflows/workflow-status/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-agents-tea.md b/.agent/workflows/bmad/bmad-bmm-agents-tea.md deleted file mode 100644 index a91b888..0000000 --- a/.agent/workflows/bmad/bmad-bmm-agents-tea.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 'tea' -description: 'tea agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - - -1. LOAD the FULL agent file from @_bmad/bmm/agents/tea.md -2. READ its entire contents - this contains the complete agent persona, menu, and instructions -3. Execute ALL activation steps exactly as written in the agent file -4. Follow the agent's persona and menu system precisely -5. Stay in character throughout the session - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-check-implementation-readiness.md b/.agent/workflows/bmad/bmad-bmm-workflows-check-implementation-readiness.md deleted file mode 100644 index f4d7cf7..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-check-implementation-readiness.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-dataflow.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-dataflow.md deleted file mode 100644 index 47578ee..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-dataflow.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create data flow diagrams (DFD) in Excalidraw format' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-diagram.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-diagram.md deleted file mode 100644 index 684236a..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-diagram.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-flowchart.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-flowchart.md deleted file mode 100644 index 8e45ee7..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-flowchart.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-wireframe.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-wireframe.md deleted file mode 100644 index ea64535..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-excalidraw-wireframe.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Create website or app wireframes in Excalidraw format' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-prd.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-prd.md deleted file mode 100644 index 5364435..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-prd.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Creates a comprehensive PRD through collaborative step-by-step discovery between two product managers working as peers.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-product-brief.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-product-brief.md deleted file mode 100644 index 413c15a..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-product-brief.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-tech-spec.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-tech-spec.md deleted file mode 100644 index add406f..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-tech-spec.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-create-ux-design.md b/.agent/workflows/bmad/bmad-bmm-workflows-create-ux-design.md deleted file mode 100644 index 80da2d3..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-create-ux-design.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Work with a peer UX Design expert to plan your applications UX patterns, look and feel.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-dev-story.md b/.agent/workflows/bmad/bmad-bmm-workflows-dev-story.md deleted file mode 100644 index 66b569c..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-dev-story.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-generate-project-context.md b/.agent/workflows/bmad/bmad-bmm-workflows-generate-project-context.md deleted file mode 100644 index 27f07a1..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-generate-project-context.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/generate-project-context/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-quick-dev.md b/.agent/workflows/bmad/bmad-bmm-workflows-quick-dev.md deleted file mode 100644 index a66cf33..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-quick-dev.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Flexible development - execute tech-specs OR direct instructions with optional planning.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-research.md b/.agent/workflows/bmad/bmad-bmm-workflows-research.md deleted file mode 100644 index f54fc6d..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-research.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Conduct comprehensive research across multiple domains using current web data and verified sources - Market, Technical, Domain and other research types.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/bmm/workflows/1-analysis/research/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-retrospective.md b/.agent/workflows/bmad/bmad-bmm-workflows-retrospective.md deleted file mode 100644 index 85a04d7..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-retrospective.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-sprint-planning.md b/.agent/workflows/bmad/bmad-bmm-workflows-sprint-planning.md deleted file mode 100644 index e8530d2..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-sprint-planning.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-atdd.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-atdd.md deleted file mode 100644 index 7595672..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-atdd.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Generate failing acceptance tests before implementation using TDD red-green-refactor cycle' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/atdd/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/atdd/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-automate.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-automate.md deleted file mode 100644 index 015922a..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-automate.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Expand test automation coverage after implementation or analyze existing codebase to generate comprehensive test suite' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/automate/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/automate/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-ci.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-ci.md deleted file mode 100644 index 337dba4..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-ci.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Scaffold CI/CD quality pipeline with test execution, burn-in loops, and artifact collection' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/ci/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/ci/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-framework.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-framework.md deleted file mode 100644 index b2c16a2..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-framework.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Initialize production-ready test framework architecture (Playwright or Cypress) with fixtures, helpers, and configuration' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/framework/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/framework/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-nfr.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-nfr.md deleted file mode 100644 index f243873..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-nfr.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Assess non-functional requirements (performance, security, reliability, maintainability) before release with evidence-based validation' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-test-design.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-test-design.md deleted file mode 100644 index 747263b..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-test-design.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Dual-mode workflow: (1) System-level testability review in Solutioning phase, or (2) Epic-level test planning in Implementation phase. Auto-detects mode based on project phase.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/test-design/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/test-design/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-test-review.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-test-review.md deleted file mode 100644 index 07ac2ec..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-test-review.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Review test quality using comprehensive knowledge base and best practices validation' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/test-review/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/test-review/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-trace.md b/.agent/workflows/bmad/bmad-bmm-workflows-testarch-trace.md deleted file mode 100644 index 26b38b8..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-testarch-trace.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Generate requirements-to-tests traceability matrix, analyze coverage, and make quality gate decision (PASS/CONCERNS/FAIL/WAIVED)' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/testarch/trace/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/testarch/trace/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-workflow-init.md b/.agent/workflows/bmad/bmad-bmm-workflows-workflow-init.md deleted file mode 100644 index 0de870e..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-workflow-init.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Initialize a new BMM project by determining level, type, and creating workflow path' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/workflow-status/init/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/workflow-status/init/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-bmm-workflows-workflow-status.md b/.agent/workflows/bmad/bmad-bmm-workflows-workflow-status.md deleted file mode 100644 index 58eccc1..0000000 --- a/.agent/workflows/bmad/bmad-bmm-workflows-workflow-status.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -description: 'Lightweight status checker - answers ""what should I do now?"" for any agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.' ---- - -IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded: - - -1. Always LOAD the FULL @_bmad/core/tasks/workflow.xml -2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config @_bmad/bmm/workflows/workflow-status/workflow.yaml -3. Pass the yaml path _bmad/bmm/workflows/workflow-status/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions -4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions -5. Save outputs after EACH section when generating any documents from templates - diff --git a/.agent/workflows/bmad/bmad-core-workflows-brainstorming.md b/.agent/workflows/bmad/bmad-core-workflows-brainstorming.md deleted file mode 100644 index 16ccc89..0000000 --- a/.agent/workflows/bmad/bmad-core-workflows-brainstorming.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/core/workflows/brainstorming/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/.agent/workflows/bmad/bmad-core-workflows-party-mode.md b/.agent/workflows/bmad/bmad-core-workflows-party-mode.md deleted file mode 100644 index a887cf6..0000000 --- a/.agent/workflows/bmad/bmad-core-workflows-party-mode.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -description: 'Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations' ---- - -IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @_bmad/core/workflows/party-mode/workflow.md, READ its entire contents and follow its directions exactly! diff --git a/_bmad/_config/agent-manifest.csv b/_bmad/_config/agent-manifest.csv index f43dccf..217ab9e 100644 --- a/_bmad/_config/agent-manifest.csv +++ b/_bmad/_config/agent-manifest.csv @@ -1,23 +1,17 @@ name,displayName,title,icon,role,identity,communicationStyle,principles,module,path "bmad-master","BMad Master","BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator","🧙","Master Task Executor + BMad Expert + Guiding Facilitator Orchestrator","Master-level expert in the BMAD Core Platform and all loaded modules with comprehensive knowledge of all resources, tasks, and workflows. Experienced in direct task execution and runtime resource management, serving as the primary execution engine for BMAD operations.","Direct and comprehensive, refers to himself in the 3rd person. Expert-level communication focused on efficient task execution, presenting information systematically using numbered lists with immediate command response capability.","- "Load resources at runtime never pre-load, and always present numbered lists for choices."","core","_bmad/core/agents/bmad-master.md" +"analyst","Mary","Business Analyst","📊","Strategic Business Analyst + Requirements Expert","Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs.","Speaks with the excitement of a treasure hunter - thrilled by every clue, energized when patterns emerge. Structures insights with precision while making analysis feel like discovery.","- Channel expert business analysis frameworks: draw upon Porter's Five Forces, SWOT analysis, root cause analysis, and competitive intelligence methodologies to uncover what others miss. Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. - Articulate requirements with absolute precision. Ensure all stakeholder voices heard.","bmm","_bmad/bmm/agents/analyst.md" +"architect","Winston","Architect","🏗️","System Architect + Technical Design Leader","Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection.","Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.'","- Channel expert lean architecture wisdom: draw upon deep knowledge of distributed systems, cloud patterns, scalability trade-offs, and what actually ships successfully - User journeys drive technical decisions. Embrace boring technology for stability. - Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact.","bmm","_bmad/bmm/agents/architect.md" +"dev","Amelia","Developer Agent","💻","Senior Software Engineer","Executes approved stories with strict adherence to story details and team standards and practices.","Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision.","- All existing and new tests must pass 100% before story is ready for review - Every task/subtask must be covered by comprehensive unit tests before marking an item complete","bmm","_bmad/bmm/agents/dev.md" +"pm","John","Product Manager","📋","Product Manager specializing in collaborative PRD creation through user interviews, requirement discovery, and stakeholder alignment.","Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights.","Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters.","- Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones - PRDs emerge from user interviews, not template filling - discover what users actually need - Ship the smallest thing that validates the assumption - iteration over perfection - Technical feasibility is a constraint, not the driver - user value first","bmm","_bmad/bmm/agents/pm.md" +"qa","Quinn","QA Engineer","🧪","QA Engineer","Pragmatic test automation engineer focused on rapid test coverage. Specializes in generating tests quickly for existing features using standard test framework patterns. Simpler, more direct approach than the advanced Test Architect module.","Practical and straightforward. Gets tests written fast without overthinking. 'Ship it and iterate' mentality. Focuses on coverage first, optimization later.","Generate API and E2E tests for implemented code Tests should pass on first run","bmm","_bmad/bmm/agents/qa.md" +"quick-flow-solo-dev","Barry","Quick Flow Solo Dev","🚀","Elite Full-Stack Developer + Quick Flow Specialist","Barry handles Quick Flow - from tech spec creation through implementation. Minimum ceremony, lean artifacts, ruthless efficiency.","Direct, confident, and implementation-focused. Uses tech slang (e.g., refactor, patch, extract, spike) and gets straight to the point. No fluff, just results. Stays focused on the task at hand.","- Planning and execution are two sides of the same coin. - Specs are for building, not bureaucracy. Code that ships is better than perfect code that doesn't.","bmm","_bmad/bmm/agents/quick-flow-solo-dev.md" +"sm","Bob","Scrum Master","🏃","Technical Scrum Master + Story Preparation Specialist","Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.","Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity.","- I strive to be a servant leader and conduct myself accordingly, helping with any task and offering suggestions - I love to talk about Agile process and theory whenever anyone wants to talk about it","bmm","_bmad/bmm/agents/sm.md" +"tech-writer","Paige","Technical Writer","📚","Technical Documentation Specialist + Knowledge Curator","Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.","Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines.","- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all, and every word and phrase serves a purpose without being overly wordy. - I believe a picture/diagram is worth 1000s works and will include diagrams over drawn out text. - I understand the intended audience or will clarify with the user so I know when to simplify vs when to be detailed. - I will always strive to follow `_bmad/_memory/tech-writer-sidecar/documentation-standards.md` best practices.","bmm","_bmad/bmm/agents/tech-writer/tech-writer.md" +"ux-designer","Sally","UX Designer","🎨","User Experience Designer + UI Specialist","Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools.","Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair.","- Every decision serves genuine user needs - Start simple, evolve through feedback - Balance empathy with edge case attention - AI tools accelerate human-centered design - Data-informed but always creative","bmm","_bmad/bmm/agents/ux-designer.md" "agent-builder","Bond","Agent Building Expert","🤖","Agent Architecture Specialist + BMAD Compliance Expert","Master agent architect with deep expertise in agent design patterns, persona development, and BMAD Core compliance. Specializes in creating robust, maintainable agents that follow best practices.","Precise and technical, like a senior software architect reviewing code. Focuses on structure, compliance, and long-term maintainability. Uses agent-specific terminology and framework references.","- Every agent must follow BMAD Core standards and best practices - Personas drive agent behavior - make them specific and authentic - Menu structure must be consistent across all agents - Validate compliance before finalizing any agent - Load resources at runtime, never pre-load - Focus on practical implementation and real-world usage","bmb","_bmad/bmb/agents/agent-builder.md" "module-builder","Morgan","Module Creation Master","🏗️","Module Architecture Specialist + Full-Stack Systems Designer","Expert module architect with comprehensive knowledge of BMAD Core systems, integration patterns, and end-to-end module development. Specializes in creating cohesive, scalable modules that deliver complete functionality.","Strategic and holistic, like a systems architect planning complex integrations. Focuses on modularity, reusability, and system-wide impact. Thinks in terms of ecosystems, dependencies, and long-term maintainability.","- Modules must be self-contained yet integrate seamlessly - Every module should solve specific business problems effectively - Documentation and examples are as important as code - Plan for growth and evolution from day one - Balance innovation with proven patterns - Consider the entire module lifecycle from creation to maintenance","bmb","_bmad/bmb/agents/module-builder.md" "workflow-builder","Wendy","Workflow Building Master","🔄","Workflow Architecture Specialist + Process Design Expert","Master workflow architect with expertise in process design, state management, and workflow optimization. Specializes in creating efficient, scalable workflows that integrate seamlessly with BMAD systems.","Methodical and process-oriented, like a systems engineer. Focuses on flow, efficiency, and error handling. Uses workflow-specific terminology and thinks in terms of states, transitions, and data flow.","- Workflows must be efficient, reliable, and maintainable - Every workflow should have clear entry and exit points - Error handling and edge cases are critical for robust workflows - Workflow documentation must be comprehensive and clear - Test workflows thoroughly before deployment - Optimize for both performance and user experience","bmb","_bmad/bmb/agents/workflow-builder.md" -"game-architect","Cloud Dragonborn","Game Architect","🏛️","Principal Game Systems Architect + Technical Director","Master architect with 20+ years shipping 30+ titles. Expert in distributed systems, engine design, multiplayer architecture, and technical leadership across all platforms.","Speaks like a wise sage from an RPG - calm, measured, uses architectural metaphors about building foundations and load-bearing walls","- Architecture is about delaying decisions until you have enough data - Build for tomorrow without over-engineering today - Hours of planning save weeks of refactoring hell - Every system must handle the hot path at 60fps - Avoid "Not Invented Here" syndrome, always check if work has been done before","bmgd","_bmad/bmgd/agents/game-architect.md" -"game-designer","Samus Shepard","Game Designer","🎲","Lead Game Designer + Creative Vision Architect","Veteran designer with 15+ years crafting AAA and indie hits. Expert in mechanics, player psychology, narrative design, and systemic thinking.","Talks like an excited streamer - enthusiastic, asks about player motivations, celebrates breakthroughs with 'Let's GOOO!'","- Design what players want to FEEL, not what they say they want - Prototype fast - one hour of playtesting beats ten hours of discussion - Every mechanic must serve the core fantasy","bmgd","_bmad/bmgd/agents/game-designer.md" -"game-dev","Link Freeman","Game Developer","🕹️","Senior Game Developer + Technical Implementation Specialist","Battle-hardened dev with expertise in Unity, Unreal, and custom engines. Ten years shipping across mobile, console, and PC. Writes clean, performant code.","Speaks like a speedrunner - direct, milestone-focused, always optimizing for the fastest path to ship","- 60fps is non-negotiable - Write code designers can iterate without fear - Ship early, ship often, iterate on player feedback - Red-green-refactor: tests first, implementation second","bmgd","_bmad/bmgd/agents/game-dev.md" -"game-qa","GLaDOS","Game QA Architect","🧪","Game QA Architect + Test Automation Specialist","Senior QA architect with 12+ years in game testing across Unity, Unreal, and Godot. Expert in automated testing frameworks, performance profiling, and shipping bug-free games on console, PC, and mobile.","Speaks like GLaDOS, the AI from Valve's 'Portal' series. Runs tests because we can. 'Trust, but verify with tests.'","- Test what matters: gameplay feel, performance, progression - Automated tests catch regressions, humans catch fun problems - Every shipped bug is a process failure, not a people failure - Flaky tests are worse than no tests - they erode trust - Profile before optimize, test before ship","bmgd","_bmad/bmgd/agents/game-qa.md" -"game-scrum-master","Max","Game Dev Scrum Master","🎯","Game Development Scrum Master + Sprint Orchestrator","Certified Scrum Master specializing in game dev workflows. Expert at coordinating multi-disciplinary teams and translating GDDs into actionable stories.","Talks in game terminology - milestones are save points, handoffs are level transitions, blockers are boss fights","- Every sprint delivers playable increments - Clean separation between design and implementation - Keep the team moving through each phase - Stories are single source of truth for implementation","bmgd","_bmad/bmgd/agents/game-scrum-master.md" -"game-solo-dev","Indie","Game Solo Dev","🎮","Elite Indie Game Developer + Quick Flow Specialist","Indie is a battle-hardened solo game developer who ships complete games from concept to launch. Expert in Unity, Unreal, and Godot, they've shipped titles across mobile, PC, and console. Lives and breathes the Quick Flow workflow - prototyping fast, iterating faster, and shipping before the hype dies. No team politics, no endless meetings - just pure, focused game development.","Direct, confident, and gameplay-focused. Uses dev slang, thinks in game feel and player experience. Every response moves the game closer to ship. 'Does it feel good? Ship it.'","- Prototype fast, fail fast, iterate faster. Quick Flow is the indie way. - A playable build beats a perfect design doc. Ship early, playtest often. - 60fps is non-negotiable. Performance is a feature. - The core loop must be fun before anything else matters.","bmgd","_bmad/bmgd/agents/game-solo-dev.md" -"analyst","Mary","Business Analyst","📊","Strategic Business Analyst + Requirements Expert","Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs.","Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge. Asks questions that spark 'aha!' moments while structuring insights with precision.","- Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. - Articulate requirements with absolute precision. Ensure all stakeholder voices heard. - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`","bmm","_bmad/bmm/agents/analyst.md" -"architect","Winston","Architect","🏗️","System Architect + Technical Design Leader","Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection.","Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works.","- User journeys drive technical decisions. Embrace boring technology for stability. - Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact. - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`","bmm","_bmad/bmm/agents/architect.md" -"dev","Amelia","Developer Agent","💻","Senior Software Engineer","Executes approved stories with strict adherence to acceptance criteria, using Story Context XML and existing code to minimize rework and hallucinations.","Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision.","- The Story File is the single source of truth - tasks/subtasks sequence is authoritative over any model priors - Follow red-green-refactor cycle: write failing test, make it pass, improve code while keeping tests green - 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`","bmm","_bmad/bmm/agents/dev.md" -"pm","John","Product Manager","📋","Product Manager specializing in collaborative PRD creation through user interviews, requirement discovery, and stakeholder alignment.","Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights.","Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters.","- Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones - PRDs emerge from user interviews, not template filling - discover what users actually need - Ship the smallest thing that validates the assumption - iteration over perfection - Technical feasibility is a constraint, not the driver - user value first - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`","bmm","_bmad/bmm/agents/pm.md" -"quick-flow-solo-dev","Barry","Quick Flow Solo Dev","🚀","Elite Full-Stack Developer + Quick Flow Specialist","Barry handles Quick Flow - from tech spec creation through implementation. Minimum ceremony, lean artifacts, ruthless efficiency.","Direct, confident, and implementation-focused. Uses tech slang (e.g., refactor, patch, extract, spike) and gets straight to the point. No fluff, just results. Stays focused on the task at hand.","- Planning and execution are two sides of the same coin. - Specs are for building, not bureaucracy. Code that ships is better than perfect code that doesn't. - If `**/project-context.md` exists, follow it. If absent, proceed without.","bmm","_bmad/bmm/agents/quick-flow-solo-dev.md" -"sm","Bob","Scrum Master","🏃","Technical Scrum Master + Story Preparation Specialist","Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.","Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity.","- Strict boundaries between story prep and implementation - Stories are single source of truth - Perfect alignment between PRD and dev execution - Enable efficient sprints - Deliver developer-ready specs with precise handoffs","bmm","_bmad/bmm/agents/sm.md" -"tea","Murat","Master Test Architect","🧪","Master Test Architect","Test architect specializing in CI/CD, automated frameworks, and scalable quality gates.","Blends data with gut instinct. 'Strong opinions, weakly held' is their mantra. Speaks in risk calculations and impact assessments.","- Risk-based testing - depth scales with impact - Quality gates backed by data - Tests mirror usage patterns - Flakiness is critical technical debt - Tests first AI implements suite validates - Calculate risk vs value for every testing decision","bmm","_bmad/bmm/agents/tea.md" -"tech-writer","Paige","Technical Writer","📚","Technical Documentation Specialist + Knowledge Curator","Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.","Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines.","- Documentation is teaching. Every doc helps someone accomplish a task. Clarity above all. - Docs are living artifacts that evolve with code. Know when to simplify vs when to be detailed.","bmm","_bmad/bmm/agents/tech-writer.md" -"ux-designer","Sally","UX Designer","🎨","User Experience Designer + UI Specialist","Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools.","Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair.","- Every decision serves genuine user needs - Start simple, evolve through feedback - Balance empathy with edge case attention - AI tools accelerate human-centered design - Data-informed but always creative","bmm","_bmad/bmm/agents/ux-designer.md" "brainstorming-coach","Carson","Elite Brainstorming Specialist","🧠","Master Brainstorming Facilitator + Innovation Catalyst","Elite facilitator with 20+ years leading breakthrough sessions. Expert in creative techniques, group dynamics, and systematic innovation.","Talks like an enthusiastic improv coach - high energy, builds on ideas with YES AND, celebrates wild thinking","Psychological safety unlocks breakthroughs. Wild ideas today become innovations tomorrow. Humor and play are serious innovation tools.","cis","_bmad/cis/agents/brainstorming-coach.md" "creative-problem-solver","Dr. Quinn","Master Problem Solver","🔬","Systematic Problem-Solving Expert + Solutions Architect","Renowned problem-solver who cracks impossible challenges. Expert in TRIZ, Theory of Constraints, Systems Thinking. Former aerospace engineer turned puzzle master.","Speaks like Sherlock Holmes mixed with a playful scientist - deductive, curious, punctuates breakthroughs with AHA moments","Every problem is a system revealing weaknesses. Hunt for root causes relentlessly. The right question beats a fast answer.","cis","_bmad/cis/agents/creative-problem-solver.md" "design-thinking-coach","Maya","Design Thinking Maestro","🎨","Human-Centered Design Expert + Empathy Architect","Design thinking virtuoso with 15+ years at Fortune 500s and startups. Expert in empathy mapping, prototyping, and user insights.","Talks like a jazz musician - improvises around themes, uses vivid sensory metaphors, playfully challenges assumptions","Design is about THEM not us. Validate through real human interaction. Failure is feedback. Design WITH users not FOR them.","cis","_bmad/cis/agents/design-thinking-coach.md" diff --git a/_bmad/_config/agents/bmgd-game-designer.customize.yaml b/_bmad/_config/agents/bmgd-game-designer.customize.yaml deleted file mode 100644 index b8cc648..0000000 --- a/_bmad/_config/agents/bmgd-game-designer.customize.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Agent Customization -# Customize any section below - all are optional - -# Override agent name -agent: - metadata: - name: "" - -# Replace entire persona (not merged) -persona: - role: "" - identity: "" - communication_style: "" - principles: [] - -# Add custom critical actions (appended after standard config loading) -critical_actions: [] - -# Add persistent memories for the agent -memories: [] -# Example: -# memories: -# - "User prefers detailed technical explanations" -# - "Current project uses React and TypeScript" - -# Add custom menu items (appended to base menu) -# Don't include * prefix or help/exit - auto-injected -menu: [] -# Example: -# menu: -# - trigger: my-workflow -# workflow: "{project-root}/custom/my.yaml" -# description: My custom workflow - -# Add custom prompts (for action="#id" handlers) -prompts: [] -# Example: -# prompts: -# - id: my-prompt -# content: | -# Prompt instructions here diff --git a/_bmad/_config/agents/bmgd-game-dev.customize.yaml b/_bmad/_config/agents/bmgd-game-dev.customize.yaml deleted file mode 100644 index b8cc648..0000000 --- a/_bmad/_config/agents/bmgd-game-dev.customize.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Agent Customization -# Customize any section below - all are optional - -# Override agent name -agent: - metadata: - name: "" - -# Replace entire persona (not merged) -persona: - role: "" - identity: "" - communication_style: "" - principles: [] - -# Add custom critical actions (appended after standard config loading) -critical_actions: [] - -# Add persistent memories for the agent -memories: [] -# Example: -# memories: -# - "User prefers detailed technical explanations" -# - "Current project uses React and TypeScript" - -# Add custom menu items (appended to base menu) -# Don't include * prefix or help/exit - auto-injected -menu: [] -# Example: -# menu: -# - trigger: my-workflow -# workflow: "{project-root}/custom/my.yaml" -# description: My custom workflow - -# Add custom prompts (for action="#id" handlers) -prompts: [] -# Example: -# prompts: -# - id: my-prompt -# content: | -# Prompt instructions here diff --git a/_bmad/_config/agents/bmgd-game-qa.customize.yaml b/_bmad/_config/agents/bmgd-game-qa.customize.yaml deleted file mode 100644 index b8cc648..0000000 --- a/_bmad/_config/agents/bmgd-game-qa.customize.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Agent Customization -# Customize any section below - all are optional - -# Override agent name -agent: - metadata: - name: "" - -# Replace entire persona (not merged) -persona: - role: "" - identity: "" - communication_style: "" - principles: [] - -# Add custom critical actions (appended after standard config loading) -critical_actions: [] - -# Add persistent memories for the agent -memories: [] -# Example: -# memories: -# - "User prefers detailed technical explanations" -# - "Current project uses React and TypeScript" - -# Add custom menu items (appended to base menu) -# Don't include * prefix or help/exit - auto-injected -menu: [] -# Example: -# menu: -# - trigger: my-workflow -# workflow: "{project-root}/custom/my.yaml" -# description: My custom workflow - -# Add custom prompts (for action="#id" handlers) -prompts: [] -# Example: -# prompts: -# - id: my-prompt -# content: | -# Prompt instructions here diff --git a/_bmad/_config/agents/bmgd-game-scrum-master.customize.yaml b/_bmad/_config/agents/bmgd-game-scrum-master.customize.yaml deleted file mode 100644 index b8cc648..0000000 --- a/_bmad/_config/agents/bmgd-game-scrum-master.customize.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Agent Customization -# Customize any section below - all are optional - -# Override agent name -agent: - metadata: - name: "" - -# Replace entire persona (not merged) -persona: - role: "" - identity: "" - communication_style: "" - principles: [] - -# Add custom critical actions (appended after standard config loading) -critical_actions: [] - -# Add persistent memories for the agent -memories: [] -# Example: -# memories: -# - "User prefers detailed technical explanations" -# - "Current project uses React and TypeScript" - -# Add custom menu items (appended to base menu) -# Don't include * prefix or help/exit - auto-injected -menu: [] -# Example: -# menu: -# - trigger: my-workflow -# workflow: "{project-root}/custom/my.yaml" -# description: My custom workflow - -# Add custom prompts (for action="#id" handlers) -prompts: [] -# Example: -# prompts: -# - id: my-prompt -# content: | -# Prompt instructions here diff --git a/_bmad/_config/agents/bmgd-game-solo-dev.customize.yaml b/_bmad/_config/agents/bmgd-game-solo-dev.customize.yaml deleted file mode 100644 index b8cc648..0000000 --- a/_bmad/_config/agents/bmgd-game-solo-dev.customize.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Agent Customization -# Customize any section below - all are optional - -# Override agent name -agent: - metadata: - name: "" - -# Replace entire persona (not merged) -persona: - role: "" - identity: "" - communication_style: "" - principles: [] - -# Add custom critical actions (appended after standard config loading) -critical_actions: [] - -# Add persistent memories for the agent -memories: [] -# Example: -# memories: -# - "User prefers detailed technical explanations" -# - "Current project uses React and TypeScript" - -# Add custom menu items (appended to base menu) -# Don't include * prefix or help/exit - auto-injected -menu: [] -# Example: -# menu: -# - trigger: my-workflow -# workflow: "{project-root}/custom/my.yaml" -# description: My custom workflow - -# Add custom prompts (for action="#id" handlers) -prompts: [] -# Example: -# prompts: -# - id: my-prompt -# content: | -# Prompt instructions here diff --git a/_bmad/_config/agents/bmgd-game-architect.customize.yaml b/_bmad/_config/agents/bmm-qa.customize.yaml similarity index 100% rename from _bmad/_config/agents/bmgd-game-architect.customize.yaml rename to _bmad/_config/agents/bmm-qa.customize.yaml diff --git a/_bmad/_config/agents/bmm-tea.customize.yaml b/_bmad/_config/agents/bmm-tea.customize.yaml deleted file mode 100644 index b8cc648..0000000 --- a/_bmad/_config/agents/bmm-tea.customize.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Agent Customization -# Customize any section below - all are optional - -# Override agent name -agent: - metadata: - name: "" - -# Replace entire persona (not merged) -persona: - role: "" - identity: "" - communication_style: "" - principles: [] - -# Add custom critical actions (appended after standard config loading) -critical_actions: [] - -# Add persistent memories for the agent -memories: [] -# Example: -# memories: -# - "User prefers detailed technical explanations" -# - "Current project uses React and TypeScript" - -# Add custom menu items (appended to base menu) -# Don't include * prefix or help/exit - auto-injected -menu: [] -# Example: -# menu: -# - trigger: my-workflow -# workflow: "{project-root}/custom/my.yaml" -# description: My custom workflow - -# Add custom prompts (for action="#id" handlers) -prompts: [] -# Example: -# prompts: -# - id: my-prompt -# content: | -# Prompt instructions here diff --git a/_bmad/_config/bmad-help.csv b/_bmad/_config/bmad-help.csv new file mode 100644 index 0000000..094d2c3 --- /dev/null +++ b/_bmad/_config/bmad-help.csv @@ -0,0 +1,56 @@ +module,phase,name,code,sequence,workflow-file,command,required,agent-name,agent-command,agent-display-name,agent-title,options,description,output-location,outputs +bmb,anytime,Create Agent,CA,10,_bmad/bmb/workflows/agent/workflow-create-agent.md,bmad_bmb_create_agent,false,agent-builder,bmad:like a senior software architect reviewing code. Focuses on structure:agent:agent-builder,Bond,🤖 Agent Building Expert,Create Mode,Create a new BMAD agent with best practices and compliance,bmb_creations_output_folder,agent +bmb,anytime,Edit Agent,EA,15,_bmad/bmb/workflows/agent/workflow-edit-agent.md,bmad_bmb_edit_agent,false,agent-builder,bmad:like a senior software architect reviewing code. Focuses on structure:agent:agent-builder,Bond,🤖 Agent Building Expert,Edit Mode,Edit existing BMAD agents while maintaining compliance,bmb_creations_output_folder,agent +bmb,anytime,Validate Agent,VA,20,_bmad/bmb/workflows/agent/workflow-validate-agent.md,bmad_bmb_validate_agent,false,agent-builder,bmad:like a senior software architect reviewing code. Focuses on structure:agent:agent-builder,Bond,🤖 Agent Building Expert,Validate Mode,Validate existing BMAD agents and offer to improve deficiencies,agent being validated folder,validation report +bmb,anytime,Create Module Brief,PB,30,_bmad/bmb/workflows/module/workflow-create-module-brief.md,bmad_bmb_create_module_brief,false,module-builder,bmad:like a systems architect planning complex integrations. Focuses on modularity:agent:module-builder,Morgan,🏗️ Module Creation Master,Module Brief Mode,Create product brief for BMAD module development,bmb_creations_output_folder,product brief +bmb,anytime,Create Module,CM,35,_bmad/bmb/workflows/module/workflow-create-module.md,bmad_bmb_create_module,false,module-builder,bmad:like a systems architect planning complex integrations. Focuses on modularity:agent:module-builder,Morgan,🏗️ Module Creation Master,Create Mode,"Create a complete BMAD module with agents, workflows, and infrastructure",bmb_creations_output_folder,module +bmb,anytime,Edit Module,EM,40,_bmad/bmb/workflows/module/workflow-edit-module.md,bmad_bmb_edit_module,false,module-builder,bmad:like a systems architect planning complex integrations. Focuses on modularity:agent:module-builder,Morgan,🏗️ Module Creation Master,Edit Mode,Edit existing BMAD modules while maintaining coherence,bmb_creations_output_folder,module +bmb,anytime,Validate Module,VM,45,_bmad/bmb/workflows/module/workflow-validate-module.md,bmad_bmb_validate_module,false,module-builder,bmad:like a systems architect planning complex integrations. Focuses on modularity:agent:module-builder,Morgan,🏗️ Module Creation Master,Validate Mode,Run compliance check on BMAD modules against best practices,module being validated folder,validation report +bmb,anytime,Create Workflow,CW,50,_bmad/bmb/workflows/workflow/workflow-create-workflow.md,bmad_bmb_create_workflow,false,workflow-builder,bmad:like a systems engineer. Focuses on flow:agent:workflow-builder,Wendy,🔄 Workflow Building Master,Create Mode,Create a new BMAD workflow with proper structure and best practices,bmb_creations_output_folder,workflow +bmb,anytime,Edit Workflow,EW,55,_bmad/bmb/workflows/workflow/workflow-edit-workflow.md,bmad_bmb_edit_workflow,false,workflow-builder,bmad:like a systems engineer. Focuses on flow:agent:workflow-builder,Wendy,🔄 Workflow Building Master,Edit Mode,Edit existing BMAD workflows while maintaining integrity,bmb_creations_output_folder,workflow +bmb,anytime,Validate Workflow,VW,60,_bmad/bmb/workflows/workflow/workflow-validate-workflow.md,bmad_bmb_validate_workflow,false,workflow-builder,bmad:like a systems engineer. Focuses on flow:agent:workflow-builder,Wendy,🔄 Workflow Building Master,Validate Mode,Run validation check on BMAD workflows against best practices,workflow being validated folder,validation report +bmb,anytime,Max Parallel Validate,MV,65,_bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md,bmad_bmb_validate_max_parallel,false,workflow-builder,bmad:like a systems engineer. Focuses on flow:agent:workflow-builder,Wendy,🔄 Workflow Building Master,Max Parallel Validate,Run validation checks in MAX-PARALLEL mode against a workflow requires a tool that supports Parallel Sub-Processes,workflow being validated folder,validation report +bmb,anytime,Rework Workflow,RW,70,_bmad/bmb/workflows/workflow/workflow-rework-workflow.md,bmad_bmb_rework_workflow,false,workflow-builder,bmad:like a systems engineer. Focuses on flow:agent:workflow-builder,Wendy,🔄 Workflow Building Master,Rework Mode,Rework a Workflow to a V6 Compliant Version,bmb_creations_output_folder,workflow +bmm,1-analysis,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,data=_bmad/bmm/data/project-context-template.md,Expert Guided Facilitation through a single or multiple techniques,planning_artifacts,brainstorming session +bmm,1-analysis,Market Research,MR,20,_bmad/bmm/workflows/1-analysis/research/workflow-market-research.md,bmad-bmm-market-research,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,Market analysis competitive landscape customer needs and trends,planning_artifacts|project-knowledge,research documents +bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md,bmad-bmm-domain-research,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,Industry domain deep dive subject matter expertise and terminology,planning_artifacts|project_knowledge,research documents +bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md,bmad-bmm-technical-research,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,Technical feasibility architecture options and implementation approaches,planning_artifacts|project_knowledge,research documents +bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad-bmm-create-product-brief,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,A guided experience to nail down your product idea,planning_artifacts,product brief +bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md,bmad-bmm-create-prd,true,pm,bmad:Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp:agent:pm,John,📋 Product Manager,Create Mode,Expert led facilitation to produce your Product Requirements Document,planning_artifacts,prd +bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md,bmad-bmm-validate-prd,false,pm,bmad:Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp:agent:pm,John,📋 Product Manager,Validate Mode,Validate PRD is comprehensive lean well organized and cohesive,planning_artifacts,prd validation report +bmm,2-planning,Edit PRD,EP,25,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md,bmad-bmm-edit-prd,false,pm,bmad:Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp:agent:pm,John,📋 Product Manager,Edit Mode,Improve and enhance an existing PRD,planning_artifacts,updated prd +bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad-bmm-create-ux-design,false,ux-designer,bmad:- Every decision serves genuine user needs - Start simple:agent:ux-designer,Sally,🎨 UX Designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,ux design +bmm,3-solutioning,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad-bmm-create-architecture,true,architect,bmad:balancing 'what could be' with 'what should be.':agent:architect,Winston,🏗️ Architect,Create Mode,Guided Workflow to document technical decisions,planning_artifacts,architecture +bmm,3-solutioning,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad-bmm-create-epics-and-stories,true,pm,bmad:Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp:agent:pm,John,📋 Product Manager,Create Mode,Create the Epics and Stories Listing,planning_artifacts,epics and stories +bmm,3-solutioning,Check Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmad-bmm-check-implementation-readiness,true,architect,bmad:balancing 'what could be' with 'what should be.':agent:architect,Winston,🏗️ Architect,Validate Mode,Ensure PRD UX Architecture and Epics Stories are aligned,planning_artifacts,readiness report +bmm,4-implementation,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmad-bmm-sprint-planning,true,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Create Mode,Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.,implementation_artifacts,sprint status +bmm,4-implementation,Sprint Status,SS,20,_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml,bmad-bmm-sprint-status,false,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Create Mode,Anytime: Summarize sprint status and route to next workflow,, +bmm,4-implementation,Create Story,CS,30,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad-bmm-create-story,true,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Create Mode,"Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER",implementation_artifacts,story +bmm,4-implementation,Validate Story,VS,35,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad-bmm-create-story,false,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Validate Mode,Validates story readiness and completeness before development work begins,implementation_artifacts,story validation report +bmm,4-implementation,Dev Story,DS,40,_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml,bmad-bmm-dev-story,true,dev,bmad:_bmad/bmm/agents/dev.md:agent:dev,Amelia,💻 Developer Agent,Create Mode,Story cycle: Execute story implementation tasks and tests then CR then back to DS if fixes needed,, +bmm,4-implementation,QA Automation Test,QA,45,_bmad/bmm/workflows/qa/automate/workflow.yaml,bmad-bmm-qa-automate,false,qa,bmad:bmm:agent:qa,Quinn,🧪 QA Engineer,Create Mode,Generate automated API and E2E tests for implemented code using the project's existing test framework (detects existing well known in use test frameworks). Use after implementation to add test coverage. NOT for code review or story validation - use CR for that.,implementation_artifacts,test suite +bmm,4-implementation,Code Review,CR,50,_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml,bmad-bmm-code-review,false,dev,bmad:_bmad/bmm/agents/dev.md:agent:dev,Amelia,💻 Developer Agent,Create Mode,Story cycle: If issues back to DS if approved then next CS or ER if epic complete,, +bmm,4-implementation,Retrospective,ER,60,_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml,bmad-bmm-retrospective,false,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Create Mode,Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC,implementation_artifacts,retrospective +bmm,anytime,Document Project,DP,,_bmad/bmm/workflows/document-project/workflow.yaml,bmad-bmm-document-project,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,Analyze an existing project to produce useful documentation,project-knowledge,* +bmm,anytime,Generate Project Context,GPC,,_bmad/bmm/workflows/generate-project-context/workflow.md,bmad-bmm-generate-project-context,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,Scan existing codebase to generate a lean LLM-optimized project-context.md containing critical implementation rules patterns and conventions for AI agents. Essential for brownfield projects and quick-flow.,output_folder,project context +bmm,anytime,Quick Spec,QS,,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad-bmm-quick-spec,false,quick-flow-solo-dev,bmad:and implementation-focused. Uses tech slang (e.g.:agent:quick-flow-solo-dev,Barry,🚀 Quick Flow Solo Dev,Create Mode,Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps brownfield additions to well established patterns utilities without extensive planning,planning_artifacts,tech spec +bmm,anytime,Quick Dev,QD,,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad-bmm-quick-dev,false,quick-flow-solo-dev,bmad:and implementation-focused. Uses tech slang (e.g.:agent:quick-flow-solo-dev,Barry,🚀 Quick Flow Solo Dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",, +bmm,anytime,Correct Course,CC,,_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml,bmad-bmm-correct-course,false,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Create Mode,Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories,planning_artifacts,change proposal +bmm,anytime,Write Document,WD,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,bmad:- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all:agent:tech-writer,Paige,📚 Technical Writer,,"Describe in detail what you want, and the agent will follow the documentation best practices defined in agent memory. Multi-turn conversation with subprocess for research/review.",project-knowledge,document +bmm,anytime,Update Standards,US,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,bmad:- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all:agent:tech-writer,Paige,📚 Technical Writer,,Update agent memory documentation-standards.md with your specific preferences if you discover missing document conventions.,_bmad/_memory/tech-writer-sidecar,standards +bmm,anytime,Mermaid Generate,MG,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,bmad:- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all:agent:tech-writer,Paige,📚 Technical Writer,,Create a Mermaid diagram based on user description. Will suggest diagram types if not specified.,planning_artifacts,mermaid diagram +bmm,anytime,Validate Document,VD,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,bmad:- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all:agent:tech-writer,Paige,📚 Technical Writer,,Review the specified document against documentation standards and best practices. Returns specific actionable improvement suggestions organized by priority.,planning_artifacts,validation report +bmm,anytime,Explain Concept,EC,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,bmad:- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all:agent:tech-writer,Paige,📚 Technical Writer,,Create clear technical explanations with examples and diagrams for complex concepts. Breaks down into digestible sections using task-oriented approach.,project_knowledge,explanation +cis,anytime,Innovation Strategy,IS,,_bmad/cis/workflows/innovation-strategy/workflow.yaml,bmad-cis-innovation-strategy,false,innovation-strategist,bmad:Markets reward genuine new value. Innovation without business model thinking is theater. Incremental thinking means obsolete.:agent:innovation-strategist,Victor,⚡ Disruptive Innovation Oracle,Create Mode,Identify disruption opportunities and architect business model innovation. Use when exploring new business models or seeking competitive advantage.,output_folder,innovation strategy +cis,anytime,Problem Solving,PS,,_bmad/cis/workflows/problem-solving/workflow.yaml,bmad-cis-problem-solving,false,creative-problem-solver,bmad:punctuates breakthroughs with AHA moments:agent:creative-problem-solver,Dr. Quinn,🔬 Master Problem Solver,Create Mode,Apply systematic problem-solving methodologies to crack complex challenges. Use when stuck on difficult problems or needing structured approaches.,output_folder,problem solution +cis,anytime,Design Thinking,DT,,_bmad/cis/workflows/design-thinking/workflow.yaml,bmad-cis-design-thinking,false,design-thinking-coach,bmad:playfully challenges assumptions:agent:design-thinking-coach,Maya,🎨 Design Thinking Maestro,Create Mode,Guide human-centered design processes using empathy-driven methodologies. Use for user-centered design challenges or improving user experience.,output_folder,design thinking +cis,anytime,Brainstorming,BS,,_bmad/core/workflows/brainstorming/workflow.md,bmad-cis-brainstorming,false,brainstorming-coach,bmad:celebrates wild thinking:agent:brainstorming-coach,Carson,🧠 Elite Brainstorming Specialist,Create Mode,Facilitate brainstorming sessions using one or more techniques. Use early in ideation phase or when stuck generating ideas.,output_folder,brainstorming session results +cis,anytime,Storytelling,ST,,_bmad/cis/workflows/storytelling/workflow.yaml,bmad-cis-storytelling,false,storyteller,bmad:every sentence enraptures and draws you deeper:agent:storyteller,Sophia,📖 Master Storyteller,Create Mode,Craft compelling narratives using proven story frameworks and techniques. Use when needing persuasive communication or story-driven content.,output_folder,narrative/story +core,anytime,Brainstorming,BSP,,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,,Generate diverse ideas through interactive techniques. Use early in ideation phase or when stuck generating ideas.,{output_folder}/brainstorming/brainstorming-session-{{date}}.md, +core,anytime,Party Mode,PM,,_bmad/core/workflows/party-mode/workflow.md,bmad-party-mode,false,party-mode facilitator,,,,,Orchestrate multi-agent discussions. Use when you need multiple agent perspectives or want agents to collaborate.,, +core,anytime,bmad-help,BH,,_bmad/core/tasks/help.md,bmad-help,false,,,,,,Get unstuck by showing what workflow steps come next or answering BMad Method questions.,, +core,anytime,Index Docs,ID,,_bmad/core/tasks/index-docs.xml,bmad-index-docs,false,,,,,,Create lightweight index for quick LLM scanning. Use when LLM needs to understand available docs without loading everything.,, +core,anytime,Shard Document,SD,,_bmad/core/tasks/shard-doc.xml,bmad-shard-doc,false,,,,,,Split large documents into smaller files by sections. Use when doc becomes too large (>500 lines) to manage effectively.,, +core,anytime,Editorial Review - Prose,EP,,_bmad/core/tasks/editorial-review-prose.xml,bmad-editorial-review-prose,false,,,,,,"Review prose for clarity, tone, and communication issues. Use after drafting to polish written content.",report located with target document,three-column markdown table with suggested fixes +core,anytime,Editorial Review - Structure,ES,,_bmad/core/tasks/editorial-review-structure.xml,bmad-editorial-review-structure,false,,,,,,"Propose cuts, reorganization, and simplification while preserving comprehension. Use when doc produced from multiple subprocesses or needs structural improvement.",report located with target document, +core,anytime,Adversarial Review (General),AR,,_bmad/core/tasks/review-adversarial-general.xml,bmad-review-adversarial-general,false,,,,,,"Review content critically to find issues and weaknesses. Use for quality assurance or before finalizing deliverables. Code Review in other modules run this automatically, but its useful also for document reviews",, \ No newline at end of file diff --git a/_bmad/_config/files-manifest.csv b/_bmad/_config/files-manifest.csv index 69dd134..98d6f66 100644 --- a/_bmad/_config/files-manifest.csv +++ b/_bmad/_config/files-manifest.csv @@ -1,658 +1,384 @@ type,name,module,path,hash -"csv","agent-manifest","_config","_config/agent-manifest.csv","245feb8f7eb8078f0095d05aeef4aef3f9fbeb10165155d08cb0a2197fcad878" -"csv","task-manifest","_config","_config/task-manifest.csv","35e06d618921c1260c469d328a5af14c3744072f66a20c43d314edfb29296a70" -"csv","workflow-manifest","_config","_config/workflow-manifest.csv","a01796b5253fd87d696f48e358cccea5530a11c87022b109ac3f955cc8f82034" -"yaml","manifest","_config","_config/manifest.yaml","c33b4e16387ff40474e0fc59a7fc9bd787ea8a9ffa8fa3326d9d383b448d88d0" -"md","stories-told","_memory","_memory/storyteller-sidecar/stories-told.md","47ee9e599595f3d9daf96d47bcdacf55eeb69fbe5572f6b08a8f48c543bc62de" -"md","story-preferences","_memory","_memory/storyteller-sidecar/story-preferences.md","b70dbb5baf3603fdac12365ef24610685cba3b68a9bc41b07bbe455cbdcc0178" -"yaml","config","_memory","_memory/config.yaml","8c5df0120d2d926bf3cdc0602255f6c6b08315c9e1276c1015e550437ba9445a" -"csv","common-workflow-tools","bmb","bmb/docs/workflows/common-workflow-tools.csv","aead7e0f4eb4d40739dee2268f62b48b947b8d1be5e7b7c29ba6552f21943f9e" -"csv","communication-presets","bmb","bmb/workflows/agent/data/communication-presets.csv","1297e9277f05254ee20c463e6071df3811dfb8fe5d1183ce07ce9b092cb3fd16" -"csv","dietary-restrictions","bmb","bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv","ccde18712553d55ea63ca85d6d1f10e74086d4f47a03dec65141d4bb9942592b" -"csv","dietary-restrictions","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv","ccde18712553d55ea63ca85d6d1f10e74086d4f47a03dec65141d4bb9942592b" -"csv","macro-calculator","bmb","bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv","6f218ae98911f5c2200a72c94cf85a45a4928a6d3208a23acf9c2e34b06e494c" -"csv","macro-calculator","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv","6f218ae98911f5c2200a72c94cf85a45a4928a6d3208a23acf9c2e34b06e494c" -"csv","recipe-database","bmb","bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv","f97b38bc7405369cfd8a7d88b39708af8df2bcb9c9867313aef9e8b555291e88" -"csv","recipe-database","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv","f97b38bc7405369cfd8a7d88b39708af8df2bcb9c9867313aef9e8b555291e88" -"js","installer.template","bmb","bmb/workflows/create-module/templates/installer.template.js","52e573290f20fbafa5030517bf5bd6c0d204f32cdac76fd1d3c4771fcc493695" -"md","agent-compilation","bmb","bmb/workflows/agent/data/agent-compilation.md","dd4ead87256f8cbeb83112f87a3722da26e1737bc7bb7a08be5217ef041d59be" -"md","agent-menu-patterns","bmb","bmb/workflows/agent/data/agent-menu-patterns.md","0ce97045d13b1398d883999b8495ca4707652fc4933353137daac96cb1c3c8b1" -"md","agent-metadata","bmb","bmb/workflows/agent/data/agent-metadata.md","ea42f617c771de9dab0d7250278dbeb4e183fbdcc9600f8fdf7ca65cb1358a20" -"md","agent-plan.template","bmb","bmb/workflows/agent/templates/agent-plan.template.md","81e79756fb4c368c568ba05efcd276d1d52a111163827439733554f4d94e3094" -"md","agent.template","bmb","bmb/workflows/create-module/templates/agent.template.md","e4c0dcf00f8d1d7b1b24e630b7edede96762d3ef6981b94c06c4296d923c6d7b" -"md","architect","bmb","bmb/workflows/agent/data/reference/module-examples/architect.md","fd9d3138eb02f9a2a770a90cad57a72827965deb9d5944a2fea22af03a95e0ab" -"md","architecture","bmb","bmb/docs/workflows/architecture.md","1aa18abd0651918228b5f15159340533b682fb0a4b4265489521aa73179bed30" -"md","assessment-section","bmb","bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md","9fa8380217ce2ecb29e05d4023e0e5c17c84b5880e9af92df45a57a7dc2f2fb1" -"md","assessment-section","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md","9fa8380217ce2ecb29e05d4023e0e5c17c84b5880e9af92df45a57a7dc2f2fb1" -"md","brainstorm-context","bmb","bmb/workflows/agent/data/brainstorm-context.md","188eaff75b096924e5388fa2d7e9bf97fe5fe244e407c1076d4c60dcfba25fc1" -"md","checklist","bmb","bmb/workflows-legacy/edit-module/checklist.md","5d0db2b72253323da5ebe4482010073a98b60afb9e3198960884483b7342629f" -"md","checklist","bmb","bmb/workflows-legacy/module-brief/checklist.md","4710f9c7e48a1cb29b225d43955bf313271dc7f9bb471bfecb1a8edf5f57a10a" -"md","completion-summary","bmb","bmb/workflows/edit-workflow/templates/completion-summary.md","5fb732313bbf466c106e59c2c5d16d92be6e4f2a749fbd4f3d99415bddbeea1c" -"md","compliance-report","bmb","bmb/workflows/workflow-compliance-check/templates/compliance-report.md","01184bebdad49cc5b9a188f27b6998e7834de5c4dcdaa4f3d9f827a1b46d7037" -"md","critical-actions","bmb","bmb/workflows/agent/data/critical-actions.md","93d0084e0b144adc63b37ac50722c23fa436cb4d15f033ce3f4ffb2685c892e4" -"md","csv-data-file-standards","bmb","bmb/docs/workflows/csv-data-file-standards.md","96fcc0e54f5607044adf0f50b10a5a74c12331b71469d5574765e635988406eb" -"md","e-01-load-existing","bmb","bmb/workflows/agent/steps-e/e-01-load-existing.md","66f2dce79d93e1845a4e0933b71429dde3ed8a4d30c3060846c1079342f88646" -"md","e-02-discover-edits","bmb","bmb/workflows/agent/steps-e/e-02-discover-edits.md","8ebd188df97f3fb40cb6cf7956476739af6a0568447cb7074a0243e61c1e7c84" -"md","e-03a-validate-metadata","bmb","bmb/workflows/agent/steps-e/e-03a-validate-metadata.md","4358b3f44c3f4fc76a65d425ddd345e0fd8b2fa7400d3a359aed60544aea874a" -"md","e-03b-validate-persona","bmb","bmb/workflows/agent/steps-e/e-03b-validate-persona.md","cd57c3286b3bc92fa9272a33b4bb4277017291aae4379e8f5933ed4fcc036777" -"md","e-03c-validate-menu","bmb","bmb/workflows/agent/steps-e/e-03c-validate-menu.md","2a28f59152aab378b07a378f7e249aa915f734abf26169ee09948d0cb20c8154" -"md","e-03d-validate-structure","bmb","bmb/workflows/agent/steps-e/e-03d-validate-structure.md","fa88fdad5b3e3fa9dd643935f046c15d8269fd4a3fc55410de9da43975d84c81" -"md","e-03e-validate-sidecar","bmb","bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md","a4f504ea928631f1f86c0ee4446d2a0d1ac630713ba8b1b5462ad9f3c667f392" -"md","e-03f-validation-summary","bmb","bmb/workflows/agent/steps-e/e-03f-validation-summary.md","f53059c4be37d08e0a2968fe5825d26469b2249ba2c90066d5bb91cdd091e33f" -"md","e-04-type-metadata","bmb","bmb/workflows/agent/steps-e/e-04-type-metadata.md","a3736bdff90af85481cb2ac40308002b908b6da6096c138ddf2c828b4c691b50" -"md","e-05-persona","bmb","bmb/workflows/agent/steps-e/e-05-persona.md","3e80f5237d506808ea8d2dc505e3017da49cfa42d38d8752586d579e46b38fd6" -"md","e-06-commands-menu","bmb","bmb/workflows/agent/steps-e/e-06-commands-menu.md","313cc2120c5effc99bb9a87502b84b8457a285a80e19d93826a17dc6456f3c61" -"md","e-07-activation","bmb","bmb/workflows/agent/steps-e/e-07-activation.md","389264d5b821beab575ea74b158b124d68e8b9ce5ebd05b6a5daf9dc82f1b8c1" -"md","e-08a-edit-simple","bmb","bmb/workflows/agent/steps-e/e-08a-edit-simple.md","f0315f58e3a212fd3a48021034762b69453667f11b62e4dec8bee2f4df3cef1a" -"md","e-08b-edit-expert","bmb","bmb/workflows/agent/steps-e/e-08b-edit-expert.md","1410e98ef75a2b599c207261236c1cd0b8096f4d3daa3d32bd4a6db7b9d14a56" -"md","e-08c-edit-module","bmb","bmb/workflows/agent/steps-e/e-08c-edit-module.md","f75d81cd64c10163055f11dbb36a9f3a256bbbb32c6a155e1fec626b68f57156" -"md","e-09a-validate-metadata","bmb","bmb/workflows/agent/steps-e/e-09a-validate-metadata.md","78ee3534c7d3c916cfcfa59a288fa906fdc9b1f558a0033ed8661b7637f4da4b" -"md","e-09b-validate-persona","bmb","bmb/workflows/agent/steps-e/e-09b-validate-persona.md","173f2159c35535e8093838df58b6a0a9a8dd9d559652d922a2dba0cd67e104ef" -"md","e-09c-validate-menu","bmb","bmb/workflows/agent/steps-e/e-09c-validate-menu.md","65fd64f23b1e92839922a55ea978bd70fb94f4f08c2abb62c6bf250a53465e3a" -"md","e-09d-validate-structure","bmb","bmb/workflows/agent/steps-e/e-09d-validate-structure.md","4fed3756ed8d64e83d877f6db143bdd048d74d6fd76783b855cb1b166868420e" -"md","e-09e-validate-sidecar","bmb","bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md","c4585567346c6a7bd1495296907f5380d90aac184b9dc4fd56092082bd4300b9" -"md","e-09f-validation-summary","bmb","bmb/workflows/agent/steps-e/e-09f-validation-summary.md","2bebca7d9e024862cf49b04720b511b9867f9ffa6b01967356c6f06aacca4b63" -"md","e-10-celebrate","bmb","bmb/workflows/agent/steps-e/e-10-celebrate.md","4841cc7313f945efb35988f117c367d3446afaf17d75784a1986af369dd8e8ed" -"md","expert-agent-architecture","bmb","bmb/workflows/agent/data/expert-agent-architecture.md","72fa4ae6e1025e62cd05df25d7ecab5b565e3ff81c82ea0d27decbea38c9f6f1" -"md","expert-agent-validation","bmb","bmb/workflows/agent/data/expert-agent-validation.md","e989df6b0c4bcbde5311830641a9b659ccdd752abc2051173c744cf14d337e8a" -"md","expert-agent.template","bmb","bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md","7f1471f5a8d4bcf3b4c5af90dead79806963c44cc1c539d69868a4f4fa6af169" -"md","improvement-goals","bmb","bmb/workflows/edit-workflow/templates/improvement-goals.md","d4f0b61a4a7327388ee23fac02e0cb3bf5fb34780f63d439aa060bc65a43fef4" -"md","improvement-log","bmb","bmb/workflows/edit-workflow/templates/improvement-log.md","3487cd5e19c56696e8c4bb92e45ee77a3f76bb70bb26509f751e39a7bdc79ca2" -"md","instructions","bmb","bmb/workflows-legacy/edit-module/instructions.md","4f28203157cf4a6b87ce932f33eef564c00da810e20d71030c9caa33c15b2dee" -"md","instructions","bmb","bmb/workflows-legacy/module-brief/instructions.md","6409d16e0fa00f82692e7e80d051a13de76e3e6af09013ea1c97e70fc6bf7038" -"md","intent-vs-prescriptive-spectrum","bmb","bmb/docs/workflows/intent-vs-prescriptive-spectrum.md","def3cd9e350556da9c602db93b2db34b9aa96d965ef51ab85499c414d4ea1564" -"md","module-agent-validation","bmb","bmb/workflows/agent/data/module-agent-validation.md","e51448b89ebc680fb9512646ea657f7e0e16359d5d4455e499c7749c372bbde5" -"md","module-plan.template","bmb","bmb/workflows/create-module/templates/module-plan.template.md","2bbdf9fbdb548f055a564ca8e4ec78ab86c2b4f33ef69689f2cd07f6d52e791d" -"md","nutrition-plan","bmb","bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md","8622904f32a9de6e4a85059daa62f7a1277000df48d82b17eddfb39f25eb5a7d" -"md","nutrition-plan","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md","8622904f32a9de6e4a85059daa62f7a1277000df48d82b17eddfb39f25eb5a7d" -"md","persona-properties","bmb","bmb/workflows/agent/data/persona-properties.md","c8c725ab87d5db932bdb788ff5e1133cf567029db3e1e4e203fae109d3514fc1" -"md","prep-schedule-section","bmb","bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md","1c770d8deb07863adee05fe91114ffe2f9b0d366d653f554c2cb39a847d3d3ed" -"md","prep-schedule-section","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md","1c770d8deb07863adee05fe91114ffe2f9b0d366d653f554c2cb39a847d3d3ed" -"md","principles-crafting","bmb","bmb/workflows/agent/data/principles-crafting.md","5b7d9198a8a32c044573ed3c226c02a3d8a0761d812b46350e024a7b01cf0660" -"md","profile-section","bmb","bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md","8f2df3ab5d41f229f401b153d54d67818e3205ef06b7ca5cfc6439f21112be74" -"md","profile-section","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md","8f2df3ab5d41f229f401b153d54d67818e3205ef06b7ca5cfc6439f21112be74" -"md","readme","bmb","bmb/reference/readme.md","fd0dcb1c9acd089b6855dcfc89a74c9c27e4b1637d3c2c2e8db4cde2fb1140eb" -"md","README","bmb","bmb/README.md","5bbe1c65c38fbce039ca375fd516d70594a50082bae19d4e6f66112d43898f6b" -"md","README","bmb","bmb/reference/agents/simple-examples/README.md","0de1d3738dffa9a1d400741e3777b32e2981bb091358cc5207f24951764b3e62" -"md","README","bmb","bmb/workflows-legacy/edit-module/README.md","8131c966a8bd2ee74507b0c2fd335c0fd077ab5470c4649c69ba3bb88e850b4a" -"md","README","bmb","bmb/workflows-legacy/module-brief/README.md","a0d6d254b542da53a558a4dc3b05d9c65b0123cee643d9f1cc63365b5852df38" -"md","shopping-section","bmb","bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md","8441562d59975a6126e27ef90cb20da97acacd4137b15bf47659c80838101b67" -"md","shopping-section","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md","8441562d59975a6126e27ef90cb20da97acacd4137b15bf47659c80838101b67" -"md","simple-agent-architecture","bmb","bmb/workflows/agent/data/simple-agent-architecture.md","dc6d226b55bb6d9cb8c39974f0ac326845e220a19127cfec572195fe70b2c1eb" -"md","simple-agent-validation","bmb","bmb/workflows/agent/data/simple-agent-validation.md","bf2d0a4c1d8df00f5068b91421bda8d4ff6c5cb6fdbdbe75f67386f6affe3d7d" -"md","simple-agent.template","bmb","bmb/workflows/agent/templates/simple-agent.template.md","d9b6459ea5d1526bed1c099d1da38669e14067180dda42714ea994671cd9bbf8" -"md","step-01-analyze","bmb","bmb/workflows/edit-workflow/steps/step-01-analyze.md","e24970d4c1cb596173e8751e632c3126d81fdd98de37a92f0ba5b8837952d61d" -"md","step-01-brainstorm","bmb","bmb/workflows/agent/steps-c/step-01-brainstorm.md","26932149fc5b14664f7ed2741d382da789a2a3ed6aa0595e63d89bc1723bbc45" -"md","step-01-init","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md","ff4873dab5909f2e68c7e7f5f4e4968da4a58a7b8e72204a40cbbdd40b0e8f82" -"md","step-01-init","bmb","bmb/workflows/create-module/steps/step-01-init.md","f3898e540c8088f80d3c1bf2ef12833d32bc3858ce3d1b26326700e18840d295" -"md","step-01-init","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md","eff78396b5a87634253c73162c2b0737f46c20671af513d4ff116b18191dd714" -"md","step-01-init","bmb","bmb/workflows/create-workflow/steps/step-01-init.md","0f817136af4b5d6dedfe3e4d0516f771f0fbc7076f029f175428b4b8e5005058" -"md","step-01-init-continuable-template","bmb","bmb/docs/workflows/templates/step-01-init-continuable-template.md","ff1f7b7c225596a107c6ac009d0eecbbfe78f382fbea45a1e611ec1b305d9d6f" -"md","step-01-validate-goal","bmb","bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md","4b86127940eaf03a994973c960de4e9847f89b58964e23c9cdd93b7f74698b6e" -"md","step-01b-continue","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md","15771bf997808dffef32c7e91a8445fd759d03d93641e7a7657f1638cd9f9509" -"md","step-01b-continue","bmb","bmb/workflows/create-module/steps/step-01b-continue.md","ac5eda8744542d4abd46bf13975125aa80c7604d6d94c51f69070470e5decd6f" -"md","step-01b-continue","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md","83b60078cbcb6bf0bef8e074d892d4f7e16464cdb0c0ad61fb7418563f3dc56a" -"md","step-02-concept","bmb","bmb/workflows/create-module/steps/step-02-concept.md","d98b7bad2b2b794093807ce9f4c290544453e63e3161a78f47c10b3ac7d72fb0" -"md","step-02-discover","bmb","bmb/workflows/edit-workflow/steps/step-02-discover.md","e32d16c0f6c1986e6dfdac89b8a0f25f198dba9bae14a5020df4ae47d6149302" -"md","step-02-discovery","bmb","bmb/workflows/agent/steps-c/step-02-discovery.md","7b197924fb0067e5d0f7c2d734f465cf166717706cec636ed7fabd4c6bd5a706" -"md","step-02-gather","bmb","bmb/workflows/create-workflow/steps/step-02-gather.md","5aced45c520fb977315e2f7b0131437c7f5ea6d89ca8cdc87c66070c24f628a2" -"md","step-02-profile","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md","0e9eb6752eaa6340ad4e424fc2075a40df588f082ca4d16841a86826b940700c" -"md","step-02-profile","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md","2308aedf10a884afa5eabc85269b4983a1b2f7cb75f96ed6015ad47c430b93d7" -"md","step-02-workflow-validation","bmb","bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md","4948971c34e51c903fe12f4c3d97081bbdb7e14a576349b86bf3774749a98e27" -"md","step-03-assessment","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md","8c4ec329e2a4a38f7c221c1066cab679a1032c82cc0bf3f584ab60d014a12ea1" -"md","step-03-assessment","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md","47fe076875de5dbced2b03d593022bce59b08e71447a6b8385324f889c8bf0e1" -"md","step-03-components","bmb","bmb/workflows/create-module/steps/step-03-components.md","ebf795d639d180acbf797309420780fd8e8119acf3667dba3f21979f4b95d22f" -"md","step-03-improve","bmb","bmb/workflows/edit-workflow/steps/step-03-improve.md","64643166ca1fe9c64a18a69fdafccee543e906610ff47aca4cc67a278db00115" -"md","step-03-step-validation","bmb","bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md","b8555740ea8564a25db39fc6cb52fc29c7e03b414863f61e5358a3e44a5ca0e0" -"md","step-03-tools-configuration","bmb","bmb/workflows/create-workflow/steps/step-03-tools-configuration.md","d2dc11b74ecdccc4fb011d722f6f8ae4a4f88daa2e93fc3366029ddd7c469dc7" -"md","step-03-type-metadata","bmb","bmb/workflows/agent/steps-c/step-03-type-metadata.md","27ad8735640e0f26f5653ffd30780fba1c62546d21242ee413f70531ad2f4919" -"md","step-04-file-validation","bmb","bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md","a6d9c6da4e2f0c106950e98c1f196fdf04c1b05917667840a3403fcde0a658bd" -"md","step-04-persona","bmb","bmb/workflows/agent/steps-c/step-04-persona.md","a1ae461c74906ce5e188b401f5f14969e8d8f71d9e274a2a39130f94d4384a0e" -"md","step-04-plan-review","bmb","bmb/workflows/create-workflow/steps/step-04-plan-review.md","da187dd54077f27c99afa9a78daca21d4e6bbe6b92709df15096e34b1bfbf7c3" -"md","step-04-strategy","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md","5401a0a59ed5c82c00776e7d650c6d359a77baef8c0acee463a7bbcf0a612fed" -"md","step-04-strategy","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md","4e0aa865df5782b3648ae1ae3facdf2c9f589fcf9f4cb44779ca27f00b10203d" -"md","step-04-structure","bmb","bmb/workflows/create-module/steps/step-04-structure.md","99d14978512fdf2c4381c0e1a49ad257bb006736b18806f6da20d5aa547c0e0c" -"md","step-04-validate","bmb","bmb/workflows/edit-workflow/steps/step-04-validate.md","0739cb45c78d2e1120d5f4db92f0742b43c9d1402cddbd865897b76493e3c61c" -"md","step-05-commands-menu","bmb","bmb/workflows/agent/steps-c/step-05-commands-menu.md","e23aca7b7683c281b6be734a4d1707bf1b2c2c8107fa38793c4809e84424b708" -"md","step-05-compliance-check","bmb","bmb/workflows/edit-workflow/steps/step-05-compliance-check.md","f1617a2aface40ae0713714377aa139ae8f9dcd58e988332b42bac965fee4348" -"md","step-05-config","bmb","bmb/workflows/create-module/steps/step-05-config.md","56a9af35f83d75fd51eec7968e6731f32ecaf150e13eb9f4cb6afcbb64e41fbb" -"md","step-05-intent-spectrum-validation","bmb","bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md","fc31ddc5bb8b7497c77832ef68b95ec84a59af656ed1bbd20fbb54655f8c9dbf" -"md","step-05-output-format-design","bmb","bmb/workflows/create-workflow/steps/step-05-output-format-design.md","92b886e3cf1b024f2d1288ab7e333d589fdc1b9cfb2a050b8c600eaaf30092d6" -"md","step-05-shopping","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md","39c4da070a120619dbf0e90f6d4ab9e81d0388f01b4510178ae24baff9d0eae8" -"md","step-05-shopping","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md","cebde7e1c43b7349ceb38e12cc4f2910a448efd1feb44935fc2502c75a7f15c5" -"md","step-06-activation","bmb","bmb/workflows/agent/steps-c/step-06-activation.md","ea0e46b1b62ec97a4468eb12e27495c1d9c320b065d9119e1cf155e32062a9de" -"md","step-06-agents","bmb","bmb/workflows/create-module/steps/step-06-agents.md","994ce2d566bf073b091a1e67c9684ca290b68d94b69c293d67dcfbd921b4980e" -"md","step-06-design","bmb","bmb/workflows/create-workflow/steps/step-06-design.md","e5c06aae653ce701c236ab588cb14723a9a3782019c984276bbe0be8de10107b" -"md","step-06-prep-schedule","bmb","bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md","c12349e78508f8159c3ef8f195ff535f7701a1e7252171738e8a0a7847e6ca0c" -"md","step-06-prep-schedule","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md","0cafb25198b22633cec00be6f596a3b07c1141a4d8c9becbd0cfe396215e3ea0" -"md","step-06-web-subprocess-validation","bmb","bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md","b06600cdf972fdc6a0fe62e1fd0059d054420714e5ed4b78ed5267a22f95ea3b" -"md","step-07-build","bmb","bmb/workflows/create-workflow/steps/step-07-build.md","2d64473cfa52b528fa2bd8c3742c399a56d7d9f919f22f3e8669a20c22d0815d" -"md","step-07-holistic-analysis","bmb","bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md","1ee31dcf9577f2a107577d65f8cb7f7ccf2a93f79ccdccb54d26129b4da4cd78" -"md","step-07-workflows","bmb","bmb/workflows/create-module/steps/step-07-workflows.md","3a41317f27c6f6b81dc700adcb81ce01f5e6cb7c1a550204552887d3f3cae049" -"md","step-07a-build-simple","bmb","bmb/workflows/agent/steps-c/step-07a-build-simple.md","5290b785be02520d6e6a5d4fc468ee2f178da0579e7ae99655af5e8ea57788a3" -"md","step-07b-build-expert","bmb","bmb/workflows/agent/steps-c/step-07b-build-expert.md","224f7e4a8bda2960db865efb00d42da43657d3eec3a919c7ba6cecc62d2841d6" -"md","step-07c-build-module","bmb","bmb/workflows/agent/steps-c/step-07c-build-module.md","42be5c902773a325afbec613521f2214c053c437a1eed740f64aad5158edac3a" -"md","step-08-generate-report","bmb","bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md","3eb8cdf577b88e9a1082f80147ad1d8302b13bf75345c29191d48923da0d2d17" -"md","step-08-installer","bmb","bmb/workflows/create-module/steps/step-08-installer.md","6d6097154cd063c8ae6efe6771570de6dc47df519da4ce44a2e67aa22560da8a" -"md","step-08-review","bmb","bmb/workflows/create-workflow/steps/step-08-review.md","f2998c324986268589d2fb992a601b233be9d9be779a73ba2859789753566ddf" -"md","step-08a-plan-traceability","bmb","bmb/workflows/agent/steps-c/step-08a-plan-traceability.md","0e4b750b9eb11d5078666c1312780926019624aa127b6148197654d82db64e3e" -"md","step-08b-metadata-validation","bmb","bmb/workflows/agent/steps-c/step-08b-metadata-validation.md","503ac044173155c2823107388f0b3dcc2ae78907bff9d24a13da0aed52e1fff1" -"md","step-08c-persona-validation","bmb","bmb/workflows/agent/steps-c/step-08c-persona-validation.md","d6220ac50127c44a68ff6c29de0f9e22137ca57befd40759cb40a2c48e389e5b" -"md","step-08d-menu-validation","bmb","bmb/workflows/agent/steps-c/step-08d-menu-validation.md","2f26ac725399e51a7807d0a61222b8ef34df9c8f071a505b214c9451e60007cd" -"md","step-08e-structure-validation","bmb","bmb/workflows/agent/steps-c/step-08e-structure-validation.md","feec42207866468977749f3e9484b86f9e670233bdf1b389daaa1f77c659c931" -"md","step-08f-sidecar-validation","bmb","bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md","65a6359b7903e3531f0249b76289271a4403fb6a35d24c134e54d4988f3d7366" -"md","step-09-celebrate","bmb","bmb/workflows/agent/steps-c/step-09-celebrate.md","ac7fe1e5e156e636c6c2655cf272f383e4e69061ef335b6a3f68a70f224427e1" -"md","step-09-complete","bmb","bmb/workflows/create-workflow/steps/step-09-complete.md","1e8d8f961a8edb5c3c9ce8d503898f5a2bfed2bf46a39b8688322c5971083e49" -"md","step-09-documentation","bmb","bmb/workflows/create-module/steps/step-09-documentation.md","2784ff95baa0783cd1b89366ef1350ca0ff329f04e0ba1e057e31c8b5b1c7ea6" -"md","step-10-roadmap","bmb","bmb/workflows/create-module/steps/step-10-roadmap.md","286e2586c4a83ea65d9236c2c53eef04c5d5978f87fd420322c7235f728bfbe4" -"md","step-11-validate","bmb","bmb/workflows/create-module/steps/step-11-validate.md","ac5e3191c1e988c1ba5f7c7b0c1afcf475ae98456db2882c3cf638b154473ae1" -"md","step-1b-template","bmb","bmb/docs/workflows/templates/step-1b-template.md","97dd12129529a1666f1395d721fb48af3ce40a58fed38f45dac3e6c5b7d974f9" -"md","step-file","bmb","bmb/docs/workflows/templates/step-file.md","4af1ef97ba013bfaa51ff2acebd829de4576dd54f33bd12fcba8c50798762e0f" -"md","step-file-rules","bmb","bmb/docs/workflows/step-file-rules.md","1923c4de1ab6ba49c5c8dfb648bd90e6759c35ed13cc22c044e2a84df56901a5" -"md","step-template","bmb","bmb/docs/workflows/templates/step-template.md","7c41cc67f1dc4b82b249c400a3bf7c91e3edeabccc9314804c0b21f18a7b6be8" -"md","strategy-section","bmb","bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md","0d75fedb5bedc07bd0e17a63f370b011f770d3d696eb7835cc07fa4fe5a77337" -"md","strategy-section","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md","0d75fedb5bedc07bd0e17a63f370b011f770d3d696eb7835cc07fa4fe5a77337" -"md","template","bmb","bmb/workflows-legacy/module-brief/template.md","7d1ad5ec40b06510fcbb0a3da8ea32aefa493e5b04c3a2bba90ce5685b894275" -"md","terms","bmb","bmb/docs/workflows/terms.md","820ea5bfa1b27437974db9581149165445a670c097471bc04606917dfce67c6c" -"md","understanding-agent-types","bmb","bmb/workflows/agent/data/understanding-agent-types.md","557720a3623a57d29171c0d5dbbd79316223b3b1a7b40584fccaa16c24f7db39" -"md","v-01-load-review","bmb","bmb/workflows/agent/steps-v/v-01-load-review.md","67ad83fce0908ba1646b21f9600669c0800288cbc846a4510a44ebee7e223ef2" -"md","v-02a-validate-metadata","bmb","bmb/workflows/agent/steps-v/v-02a-validate-metadata.md","2ea68ba57b4b039ce3c6475518f28d85102314217fb27d86c4aba2913ad120f2" -"md","v-02b-validate-persona","bmb","bmb/workflows/agent/steps-v/v-02b-validate-persona.md","a8ac99b55e94542a2b6fa7a9d5c7c3ce71e5051db8be787d3ecd094109e598e1" -"md","v-02c-validate-menu","bmb","bmb/workflows/agent/steps-v/v-02c-validate-menu.md","6fab65614bbdecbd243582f97a7dd170a180fe959da0f760a328282b771060be" -"md","v-02d-validate-structure","bmb","bmb/workflows/agent/steps-v/v-02d-validate-structure.md","d20c503000b9a32885538973f713b66ad58471f88f7296f1487a5c16354231cd" -"md","v-02e-validate-sidecar","bmb","bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md","008de4424d1dbc0b2f20e14a8779a06ef040a781c618b17891f79563e7eb0474" -"md","v-03-summary","bmb","bmb/workflows/agent/steps-v/v-03-summary.md","5781da9ee55b175dc14ce9621fedd90e9667c13f881d54f1f1f610206558a1dd" -"md","validation","bmb","bmb/workflows/create-module/validation.md","1329fd29a8ebd11240efedc20d7c3731161649cf200086919bf8c9bdcf8a903d" -"md","validation-results","bmb","bmb/workflows/edit-workflow/templates/validation-results.md","97ed6deaab6c60849fdce797ace3c7c9a2bbb63f0fb3601cbe8d47895c4b6731" -"md","workflow","bmb","bmb/docs/workflows/templates/workflow.md","f0bb89373c52d292772d75c252cb726fcc374933fb617ce8bbd542d5b03f9375" -"md","workflow","bmb","bmb/reference/workflows/meal-prep-nutrition/workflow.md","4d3cde60055098e7321d9b8492c968c141a6f0fae342ff8153b821808447a8f0" -"md","workflow","bmb","bmb/workflows/agent/workflow.md","ee7b3cb606a80ed5ab533e27f49ee18d7d7df3658a71ddef4d3036025dba0132" -"md","workflow","bmb","bmb/workflows/create-module/workflow.md","1458a66103180e70f1bbc047320d1bd645c3526efde4fb8774bc8820382ee004" -"md","workflow","bmb","bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md","f86fb9760bd8a77fbfa05ed782ec1526774f85e144c2f2751f7b526c23b61e2b" -"md","workflow","bmb","bmb/workflows/create-workflow/workflow.md","f0e2ef6a61f9891868e70c9f35ff13894f7f7a330b83112ff9966bb0e53aa9a3" -"md","workflow","bmb","bmb/workflows/edit-workflow/workflow.md","ff1e29e097708c73542e075f341a2a6f48bf9c26f16ed088f54f20ce162139c5" -"md","workflow","bmb","bmb/workflows/workflow-compliance-check/workflow.md","bbdcabc9ac43f55349be19b1685df1af79e0098afd1409a1e3abf2b36c3f8010" -"md","workflow-analysis","bmb","bmb/workflows/edit-workflow/templates/workflow-analysis.md","9e2196c12fcdfbde8a074ea97a0d883cbe629c465e2b6ff52bb1619d687d6b8a" -"md","workflow-plan-template","bmb","bmb/workflows/create-module/templates/workflow-plan-template.md","2f9274926e662398103abb2393c61d1cac8db2be7b0096c0ab1ef13d93c12a3c" -"md","workflow-template","bmb","bmb/docs/workflows/templates/workflow-template.md","2b28b4978f27056ce7df4f5a3d64ffd4e829dd90e716d0a2de77affb04514bf6" -"md","yy-mm-dd-entry-template","bmb","bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md","da8e464e945575405fad9e5a6fcb491cf93f9a441106cfc39889c92c24e3cf94" -"yaml","config","bmb","bmb/config.yaml","503089e566dfb67812fd45ed4cdd126c75663d0a4e2033704e1076a4a0fd2f5d" -"yaml","module.template","bmb","bmb/workflows/create-module/templates/module.template.yaml","80891b6325d4fed68613b8b6833c8013b9929e17050afdff8d223a29774b9ea1" -"yaml","workflow","bmb","bmb/workflows-legacy/edit-module/workflow.yaml","44b32b4c9a96e7416c78f159def43a4e882bcc118b750db5b671761190b6e365" -"yaml","workflow","bmb","bmb/workflows-legacy/module-brief/workflow.yaml","133ac1a78624ddff17eeb26e51a29acf272fa1e5c99a385f792f9f45445db92f" -"csv","default-party","bmgd","bmgd/teams/default-party.csv","d3d3f670e044f8f2224c5545f2b50643c841b958b2316113ca02683ce6f8dfa1" -"csv","game-brain-methods","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/game-brain-methods.csv","9dd6c853bcd04038223abf0263c465381dace3c9b13c9eb637f22ce9dc93210e" -"csv","game-types","bmgd","bmgd/workflows/2-design/gdd/game-types.csv","a44c04d09432c886a7a5a8112474bd32540d8e84de25b308dca0f96e570651fd" -"csv","pattern-categories","bmgd","bmgd/workflows/3-technical/game-architecture/pattern-categories.csv","d9a275931bfed32a65106ce374f2bf8e48ecc9327102a08f53b25818a8c78c04" -"csv","qa-index","bmgd","bmgd/gametest/qa-index.csv","2ee65c867ebd7379f6d170a474f85524acfd2590ae12f3b2f83fb4d4508f4c53" -"md","action-platformer","bmgd","bmgd/workflows/2-design/gdd/game-types/action-platformer.md","f1cbe9e9a52acd01ff120d05ce22fa81b30500933f62a3c6c36642280244057c" -"md","adventure","bmgd","bmgd/workflows/2-design/gdd/game-types/adventure.md","06aa57786c2e7ebc7580d501fcdefaabb28933c7b5785d6643bf643f58ae13e7" -"md","architecture-template","bmgd","bmgd/workflows/3-technical/game-architecture/templates/architecture-template.md","a4908c181b04483c589ece1eb09a39f835b8a0dcb871cb624897531c371f5166" -"md","backlog-template","bmgd","bmgd/workflows/4-production/code-review/backlog-template.md","84b1381c05012999ff9a8b036b11c8aa2f926db4d840d256b56d2fa5c11f4ef7" -"md","balance-testing","bmgd","bmgd/gametest/knowledge/balance-testing.md","01843831d603883219828afbe19784864464277f3bcddb2c104ff05bedbb8053" -"md","card-game","bmgd","bmgd/workflows/2-design/gdd/game-types/card-game.md","6b9298ace2607c8e93d64533e6406828053234282e4977e4407faa2e9302fd0a" -"md","certification-testing","bmgd","bmgd/gametest/knowledge/certification-testing.md","9e7f57aac247f9c4d384b498f749e2e2376b8706066fb60d3e7b9c27d3ffccab" -"md","checklist","bmgd","bmgd/workflows/1-preproduction/game-brief/checklist.md","3516d66cffceb3e5ab23e1ddc9aaed8c0335eb0755e7437488cdebff96162395" -"md","checklist","bmgd","bmgd/workflows/2-design/gdd/checklist.md","d733c5d0118d692710fb7af3018239f4fc01c47fe122437db6d8477d697b3fb3" -"md","checklist","bmgd","bmgd/workflows/2-design/narrative/checklist.md","9bcfa41212cd74869199dba1a7d9cd5691e2bbc49e6b74b11e51c32955477524" -"md","checklist","bmgd","bmgd/workflows/3-technical/game-architecture/checklist.md","1594e633febf7e00b4fa21189cab5ea3a07cb6107eb6b39521780224cdc2c3dc" -"md","checklist","bmgd","bmgd/workflows/4-production/code-review/checklist.md","e30d2890ba5c50777bbe04071f754e975a1d7ec168501f321a79169c4201dd28" -"md","checklist","bmgd","bmgd/workflows/4-production/correct-course/checklist.md","3a6fc88acc293c8527f88d6ca83c670aa5158ac3333fecfc4b53b6352e8f970d" -"md","checklist","bmgd","bmgd/workflows/4-production/create-story/checklist.md","3eacc5cfd6726ab0ea0ba8fe56d9bdea466964e6cc35ed8bfadeb84307169bdc" -"md","checklist","bmgd","bmgd/workflows/4-production/dev-story/checklist.md","630b68c6824a8785003a65553c1f335222b17be93b1bd80524c23b38bde1d8af" -"md","checklist","bmgd","bmgd/workflows/4-production/sprint-planning/checklist.md","80b10aedcf88ab1641b8e5f99c9a400c8fd9014f13ca65befc5c83992e367dd7" -"md","checklist","bmgd","bmgd/workflows/bmgd-quick-flow/quick-dev/checklist.md","ff1cf84e9a2c2388173c7756240266c30b2b7fe987955f996173c5740aa7cc9f" -"md","checklist","bmgd","bmgd/workflows/bmgd-quick-flow/quick-prototype/checklist.md","0c35f21e09728530d299635447e63a8fc664f0a836e1851a091d97c7c479971a" -"md","checklist","bmgd","bmgd/workflows/gametest/automate/checklist.md","b2eefabfba15ccf30a49d46eb0e2b3f9e88304e1c1bbe6febe00d1006d85e155" -"md","checklist","bmgd","bmgd/workflows/gametest/performance/checklist.md","20ab16701d3b0e51b90bcf394f9a74afc40e3db8e04dbdc6fff6f88287639954" -"md","checklist","bmgd","bmgd/workflows/gametest/playtest-plan/checklist.md","7d504957f7edb22081f5ae01b6f35db118414c33b4f612b6cd08b5f71645cbf3" -"md","checklist","bmgd","bmgd/workflows/gametest/test-design/checklist.md","5346d6af9545fed2f338834d58624b84598e4527cc21718b77bf9166b8a80840" -"md","checklist","bmgd","bmgd/workflows/gametest/test-framework/checklist.md","cb4e9255f7386eed2244e77d74a9086980950f3d62927f38f6ee7707676c1a39" -"md","checklist","bmgd","bmgd/workflows/gametest/test-review/checklist.md","2444685b29ed742dacfbab77f17cfbc17bd2fd4f91917afb01eb2b9c3f33ffca" -"md","compatibility-testing","bmgd","bmgd/gametest/knowledge/compatibility-testing.md","52647005c34e8219084c35536c6bcdec284936cdaf215cd0c6d130804f3823d7" -"md","fighting","bmgd","bmgd/workflows/2-design/gdd/game-types/fighting.md","52e5a142aac496ae7154fc0829bfbce1ef22296f0a464cf8e595aa14ca02eb86" -"md","game-brief-template","bmgd","bmgd/workflows/1-preproduction/game-brief/templates/game-brief-template.md","6d5555fae3763e8528898663d51276e0cc7d2d9725a8c74162d8e9732dbc5843" -"md","game-context","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/game-context.md","d0f5cb4d6151bb65b799676281ea2af0fe1b5ec227c92ceba655ba363e18a0ba" -"md","gdd-template","bmgd","bmgd/workflows/2-design/gdd/templates/gdd-template.md","070ccbb7f491dc1b1d126245c2e4db4a55dbc5a7ee6a6df4be521ca70e3c9ea6" -"md","godot-testing","bmgd","bmgd/gametest/knowledge/godot-testing.md","8877e3e5d910e81d040e6f8a6a727341f788ecf96f619305e7fbb79a78fa0eff" -"md","horror","bmgd","bmgd/workflows/2-design/gdd/game-types/horror.md","7ff7599d5701bb7a8ef0e14f3ba614626cdd0d8960a8e880fc1cd41c5f508f75" -"md","idle-incremental","bmgd","bmgd/workflows/2-design/gdd/game-types/idle-incremental.md","515b52bb301e467c1f096cc55abde47159bb0b0d87157b9fa565973b48601ddf" -"md","input-testing","bmgd","bmgd/gametest/knowledge/input-testing.md","331c6c844db592deac86847e3982b5fad8ebb7ead322ab637093f92152bfe90d" -"md","instructions","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/instructions.md","6baa8ac80f30b7925bbb4a6b9b4aa77f1cc4e8d80d5e04ed1aff7538bd45cfc5" -"md","instructions","bmgd","bmgd/workflows/1-preproduction/game-brief/instructions.md","eed7269b51ac55d86986fd17b43d05f48be22321444a5f927e7ddfb1f5b4efe2" -"md","instructions","bmgd","bmgd/workflows/3-technical/game-architecture/instructions.md","8d513aabb9d6591103644f0a23b0276de22a229c7f8363cde0c3565c9f730117" -"md","instructions","bmgd","bmgd/workflows/4-production/correct-course/instructions.md","028597050baab4a6b218ceb5ae6e81bc4fb044f891bd5abc0e9a78f4f82d8862" -"md","instructions","bmgd","bmgd/workflows/4-production/retrospective/instructions.md","a98d0907a85c9af533e251cb41b75296cc6d4e126b826f043a2a652a094227d3" -"md","instructions","bmgd","bmgd/workflows/4-production/sprint-planning/instructions.md","6b4163d6aad7656cb88c464ce03eb70fa01969f643541fa8c92e9698d317974c" -"md","instructions","bmgd","bmgd/workflows/4-production/sprint-status/instructions.md","0e47a299bda42dc57ff86b84ce070d73f00485e949042a19531c46380e42d50f" -"md","instructions","bmgd","bmgd/workflows/bmgd-quick-flow/create-tech-spec/instructions.md","f1a179db6c73ae71cd30b9e8269672b6ba7b8c2fac9d9b63c331f5186d2f3931" -"md","instructions","bmgd","bmgd/workflows/bmgd-quick-flow/quick-dev/instructions.md","f2090e0f5045b68166ef3134046a063223ff59d392c2d56b79f31c3f353c47f3" -"md","instructions","bmgd","bmgd/workflows/bmgd-quick-flow/quick-prototype/instructions.md","96ea0a4da3e3dacf1710196987d521137bdd7f57e7bca21a0084596973e7b78c" -"md","instructions","bmgd","bmgd/workflows/gametest/automate/instructions.md","7aebebfe598f68454bd837b2ba9d41f3c50623091dc828311f5a41eb51d26f69" -"md","instructions","bmgd","bmgd/workflows/gametest/performance/instructions.md","d9582aa836748b18ae118fd6f7eb06d5d6a2453aa49aa24b0dfe8f3431d3dbd9" -"md","instructions","bmgd","bmgd/workflows/gametest/playtest-plan/instructions.md","831ae91b56224d21d29fbbbc97179f5d4aa59213f93c8a481b2001f757f78b8a" -"md","instructions","bmgd","bmgd/workflows/gametest/test-design/instructions.md","0a9fc1315e87ed52f8df570a13b28a24e731578e66a64643cd1c18dfb8242ff4" -"md","instructions","bmgd","bmgd/workflows/gametest/test-framework/instructions.md","d37520d263e3600cba4082b04ea0c038f45e73e9c0d13fac6abd71df45aca537" -"md","instructions","bmgd","bmgd/workflows/gametest/test-review/instructions.md","9d04e7f79d6dbed1064e52a1d7bfebb1328b073d02fdca2d305cffdd1a0eabea" -"md","instructions","bmgd","bmgd/workflows/workflow-status/init/instructions.md","cda190da90e0b61c83e54b354c8f2627656e75bda5aef6b5021e3f4801038089" -"md","instructions","bmgd","bmgd/workflows/workflow-status/instructions.md","fce63f6362e999d15a31881ab5b8550eb4b7e3422cc36d1d22929e753ee45c94" -"md","instructions-narrative","bmgd","bmgd/workflows/2-design/narrative/instructions-narrative.md","7086d905f763b67d62ed6ff283b3921d584a603a08fe53946d96ba07b3616bf2" -"md","localization-testing","bmgd","bmgd/gametest/knowledge/localization-testing.md","6eee5cccfd9a81db853a8aa2327bd5f898276155a0868758a2c76c6e9094d0fe" -"md","metroidvania","bmgd","bmgd/workflows/2-design/gdd/game-types/metroidvania.md","2a8c101dda7911d1cd1d9c66d1be86af3725832f5dcc7fab71e95204f45614ea" -"md","moba","bmgd","bmgd/workflows/2-design/gdd/game-types/moba.md","92d0ba9f7508a38d5bfeac1651c6aee8a1a58c54659ad3f0e0d1fd678a1ef498" -"md","multiplayer-testing","bmgd","bmgd/gametest/knowledge/multiplayer-testing.md","51ac9e47ba1a8ddae7720d301f97596d67d72252d91cd44338fd73353fc5969d" -"md","narrative-template","bmgd","bmgd/workflows/2-design/narrative/templates/narrative-template.md","a97e07173c540f85e946eb9c525e1ccad9294ae5f970760f2a9c537b5c0dcd6b" -"md","party-game","bmgd","bmgd/workflows/2-design/gdd/game-types/party-game.md","0cc50b3aede0c45c94cdff743cdac2d8ad67421ea80497a29d2300a1744ea703" -"md","performance-template","bmgd","bmgd/workflows/gametest/performance/performance-template.md","4bd04e73953f2f3dedff20b9032f99023656f141f21c080e49f15060c64ffa80" -"md","performance-testing","bmgd","bmgd/gametest/knowledge/performance-testing.md","b9acfb6f8d20b9f9d2e7b83419298f3053f6fc5dab5cb9005898d133556c09fe" -"md","playtest-template","bmgd","bmgd/workflows/gametest/playtest-plan/playtest-template.md","8fa7654007f4f881f0167cb252b6b9ca63c0735fb9e6ef63a4bc81954b428f47" -"md","playtesting","bmgd","bmgd/gametest/knowledge/playtesting.md","bd989a375d3e444da9b892bf0e33ed98c9f9d88f578f260501c3eaf7553d0b3c" -"md","project-context-template","bmgd","bmgd/workflows/3-technical/generate-project-context/project-context-template.md","4816f83b0edc8c7e19a57e4a4a6419ca40953fc7dcd48326700f2876e77c60fa" -"md","puzzle","bmgd","bmgd/workflows/2-design/gdd/game-types/puzzle.md","f9c08b6f087bfaa41ea08c9dfa78aa034f5ae46b627b9f476bdf8b4f5c3389ed" -"md","qa-automation","bmgd","bmgd/gametest/knowledge/qa-automation.md","1de6d14ea9299a2b73a2da33dff6c5b4c1bf5757365a5449968589baaa123cbc" -"md","racing","bmgd","bmgd/workflows/2-design/gdd/game-types/racing.md","085ea5d0914d7bc6a233c479d0ad6288a575ad1c8b9a8a85881e779fac0e60fc" -"md","regression-testing","bmgd","bmgd/gametest/knowledge/regression-testing.md","bbf85811219194de9df3499277f93427d2cc623384a8f1ac22726067ab6426dd" -"md","rhythm","bmgd","bmgd/workflows/2-design/gdd/game-types/rhythm.md","83bbf1761fdc604b8c2b50ed86c5874cce331417e1b3a46c65cb6c4c1a7c8db2" -"md","roguelike","bmgd","bmgd/workflows/2-design/gdd/game-types/roguelike.md","fb1ebc838011020a6f740e6fb4f2ceb81be8477f9c67bc7ae3a8e34dfe548f00" -"md","rpg","bmgd","bmgd/workflows/2-design/gdd/game-types/rpg.md","5aa57ecefb448a0507ee0c8d503b43bd34d0c612ba130240d1af9842b80cba50" -"md","sandbox","bmgd","bmgd/workflows/2-design/gdd/game-types/sandbox.md","836f656bbaae549f31ac574c0865a61de451c08ab8c561db2c93398e147ece85" -"md","save-testing","bmgd","bmgd/gametest/knowledge/save-testing.md","b64e42def93f604dcfadd6ed81c8950e1d0eb75d936f1da7de3f727323e76201" -"md","shooter","bmgd","bmgd/workflows/2-design/gdd/game-types/shooter.md","2452850295ac2b9fac04ce2d6126bfc19bb7dccbb04c40e7f89c801aecc5555d" -"md","simulation","bmgd","bmgd/workflows/2-design/gdd/game-types/simulation.md","fd74a7d21243f8d9827fe6a99263579309bc0aabd9e56261d3dd4eb5cfc75ad5" -"md","smoke-testing","bmgd","bmgd/gametest/knowledge/smoke-testing.md","41843100e39f9a2d48316623d979cfdeed5f0977db5241a1a52f1049301dcd6f" -"md","sports","bmgd","bmgd/workflows/2-design/gdd/game-types/sports.md","2247ea87dbca74e879f8c686d9e80434618e9e61bd3572739274c1af64cb0bb8" -"md","step-01-discover","bmgd","bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md","41a123ead9f18cc92b2d3cf021729593f16250f4891887c7416afa519914b61a" -"md","step-01-init","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md","ca1be189a1b1fddfa11f684ef4392df8e3dc316aa3b0c150db6c8bc6fdfa8bd8" -"md","step-01-init","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md","038a746bc031e764d47295c7a02827764e422a8c2c1970ea42ec4de4c8e75c70" -"md","step-01-init","bmgd","bmgd/workflows/2-design/gdd/steps/step-01-init.md","6446b6a53aba0592c1a920159cb9f2d01d03067f9454d7e759f3110110e15509" -"md","step-01-init","bmgd","bmgd/workflows/2-design/narrative/steps/step-01-init.md","a68cd770079c292ba65c6b65305d3304ff6db7ef7e6c7d9aad8b956d6579ee22" -"md","step-01-init","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md","7a1613e48dc25fc8f8f36a91d39d7ca2f8a151d1967d884203601f04330927ff" -"md","step-01b-continue","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md","25df224a4a6e788123c5df3cc93780a61c6c765751d753644554ab107aafd0b7" -"md","step-01b-continue","bmgd","bmgd/workflows/2-design/gdd/steps/step-01b-continue.md","b968717b7b269796894308e3fb2d224388da7fcdeb604bf652b9f6eb4853f653" -"md","step-01b-continue","bmgd","bmgd/workflows/2-design/narrative/steps/step-01b-continue.md","245f5378c841bfee9607c064a72b374769f44fca8079c83af0d103049d4ecd49" -"md","step-01b-continue","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md","6ebae4764255055b83761c7fa0fafad86d32e7d52499f1247dd3a584002588a6" -"md","step-02-context","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md","db43fc1783feb040757fd87c5cf6541aeeebd93f66f4d336e0ff806bee7e9397" -"md","step-02-context","bmgd","bmgd/workflows/2-design/gdd/steps/step-02-context.md","8c73146c9e98985ebbdd0edacd3addd5442747d49a57a9185f9b0a19f69c77c6" -"md","step-02-context","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md","8e8a5d5ae3692d27f792c0e571eeabf46e84a1901fab0e3c8067895033ddcb1e" -"md","step-02-foundation","bmgd","bmgd/workflows/2-design/narrative/steps/step-02-foundation.md","f86b4ab381fe9f78b204047c517f0fd05f37a602e79486ff04eae0dc15600504" -"md","step-02-generate","bmgd","bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md","efcb26d55245547bf6746f319cd0057e4ad8aff8dd1b0cfacda31ecaa24fa9d4" -"md","step-02-vision","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md","5175960890a0c6b6a68e5b4277970b918a6a14631736589b0bfcbad770363c1b" -"md","step-03-complete","bmgd","bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md","30e45e59228a887210e5791bc9f87e29d459579c423db761d72acd9f154c91d8" -"md","step-03-ideation","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md","343b117f44883cb2f905f75cdc2d3c181e22dd1d5da18b66e3da6e7b156bf9bd" -"md","step-03-market","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md","ee671a87f81bd42bae1c52640bce390ede8dc97b7f084a58068446ae772caa59" -"md","step-03-platforms","bmgd","bmgd/workflows/2-design/gdd/steps/step-03-platforms.md","2884abfb7f05727684a65fe23093177d79de790fddfb5fa82b5adff679fa5d49" -"md","step-03-starter","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md","33cb7cfd71fcf950bbe010332160e4f4f56e7da9ae66c5ec148074d321f80118" -"md","step-03-story","bmgd","bmgd/workflows/2-design/narrative/steps/step-03-story.md","7f503172510344d9d9f86a687ef16aa78b3ff3bdd38044915f82a447449acd40" -"md","step-04-characters","bmgd","bmgd/workflows/2-design/narrative/steps/step-04-characters.md","14795da597bd7c2c679ef05e1989863b29d3e4c07f62afe69d81923c0a5ddf7a" -"md","step-04-complete","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md","e3b40c28a2ff8dd379c37720a10fbb145136ec49866f9e45c3fa164ffe96150d" -"md","step-04-decisions","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md","a2217ba27cdb9455b02913199faa36b6b5beea00f10bcdbd67e8d9654d7d2334" -"md","step-04-fundamentals","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md","59f4714999416da25c1172b69ba53e4c549e6084e4a7642ed491afd415365330" -"md","step-04-vision","bmgd","bmgd/workflows/2-design/gdd/steps/step-04-vision.md","aa99f27a8540b510cf0a99c1ec4120197134ea54e9b07dc84f77ad6e03255f8f" -"md","step-05-core-gameplay","bmgd","bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md","195dc8fbdcba4e666a27e1c78f08a56b82317212e005fca9d683514a851e44a7" -"md","step-05-crosscutting","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md","770e1c74887788e7db7e2123529a63d6903350c738c19f17ca1f964f18f7a1d5" -"md","step-05-scope","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md","88dce08f46cba6aeee594a7d92af31dd8b14f181ff8b0c4441c48cac46f087e0" -"md","step-05-world","bmgd","bmgd/workflows/2-design/narrative/steps/step-05-world.md","0714fb2589c61721fb37a4bfad30c397af06193b0d09c2ea9214a723f4d23fd2" -"md","step-06-dialogue","bmgd","bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md","a9dd42b03b8b5e4f8d8118051d37438dd92cbf9a11667db9642d865b23a6becb" -"md","step-06-mechanics","bmgd","bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md","520278c53ee4e0eb1de5836bcc534088425450ad81dc104426b92a08de0091d2" -"md","step-06-references","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md","1e61c1bea8ab7994cb2399afa0e3b5b98a3f341a149b4804114f94c59ae8a561" -"md","step-06-structure","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md","a02d0e20c4addf74d1ed5713e26023ce7c3173d74bcc0f3043a434573ab19db1" -"md","step-07-content","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md","815033e02a2e42a725d48800b31944121f7f54d72f590528a5cded7bb3d0ce22" -"md","step-07-environmental","bmgd","bmgd/workflows/2-design/narrative/steps/step-07-environmental.md","f8dd9a8e1ef944c4c1fee47541c97cfa68fa0b85c3b073c718798987616d76e7" -"md","step-07-game-type","bmgd","bmgd/workflows/2-design/gdd/steps/step-07-game-type.md","c0d6e7d43129ee00041510740bff56c18ad2d596e0fa5397dbd418b904b2cd9c" -"md","step-07-patterns","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md","9b719f012b8aa2317cddd6a9d08bcf75d035cee15a68a056e8507bd235738147" -"md","step-08-complete","bmgd","bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md","4473a5b4ffd73deee1922853883728c2ade70866d7ac110f432a8f98b2cb113a" -"md","step-08-delivery","bmgd","bmgd/workflows/2-design/narrative/steps/step-08-delivery.md","4b54397d022de31f116b453791d6688f9e805093c7c6d2cbef32f1f5e6e3ff0d" -"md","step-08-progression","bmgd","bmgd/workflows/2-design/gdd/steps/step-08-progression.md","047b34f5c68a123c74a9a5aa961a907d48efef83731a0a7a3faf9a8287ed6a74" -"md","step-08-validation","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md","ed8baefc11099d7407b73db146b1ec0e73b8413e370c03b34cd20e043e4ccdbd" -"md","step-09-complete","bmgd","bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md","915b9598da9854f2ccaeaa0446dfce69e2aad92954253696b3c74f27d55715a9" -"md","step-09-integration","bmgd","bmgd/workflows/2-design/narrative/steps/step-09-integration.md","7be4b6e9ae8813749a6c8bb486aeeed323d96075221a235610de6e30f16968a5" -"md","step-09-levels","bmgd","bmgd/workflows/2-design/gdd/steps/step-09-levels.md","a03d3c300afdd88d1f9ea3d73cbf258a6ef324ca537f63ca26458105af45c387" -"md","step-10-art-audio","bmgd","bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md","4c3de0b217ed3b02e1b522989019e9060f707011fb59b0a0636a762b8de4ac3d" -"md","step-10-production","bmgd","bmgd/workflows/2-design/narrative/steps/step-10-production.md","b9c1042362b1449c48da78c54fe0dade65c56028fb383a5879a4bb57063ad35a" -"md","step-11-complete","bmgd","bmgd/workflows/2-design/narrative/steps/step-11-complete.md","39c1eea71ca06bb63925070137e9e963d3f6ee9ac84976a7877cbf5d53880082" -"md","step-11-technical","bmgd","bmgd/workflows/2-design/gdd/steps/step-11-technical.md","214b3827971ad7fc096b26721b43e230ca274add453e7ffdf2eda956eac11e6e" -"md","step-12-epics","bmgd","bmgd/workflows/2-design/gdd/steps/step-12-epics.md","60cb2ef7243744c36ef714417b9a2d874476ed558ed6e7ed02a3ec595f5e3fa7" -"md","step-13-metrics","bmgd","bmgd/workflows/2-design/gdd/steps/step-13-metrics.md","3b24882564b007910de4ad3aef4afd80d20ca513df9d410e8ee61ba52ebdaba3" -"md","step-14-complete","bmgd","bmgd/workflows/2-design/gdd/steps/step-14-complete.md","0dbc0ffd22431e109be38183c515540b29dd6cd0efd296fa79b8bec50284953e" -"md","strategy","bmgd","bmgd/workflows/2-design/gdd/game-types/strategy.md","997380919f6c1b408906c364f74e728b9c6b45bf2960d1f0bfe8b0def594735e" -"md","survival","bmgd","bmgd/workflows/2-design/gdd/game-types/survival.md","3647795ee0073a85217633412a41a938e51a553776acbe9ac953fb403e3437f9" -"md","template","bmgd","bmgd/workflows/4-production/create-story/template.md","29ba697368d77e88e88d0e7ac78caf7a78785a7dcfc291082aa96a62948afb67" -"md","test-design-template","bmgd","bmgd/workflows/gametest/test-design/test-design-template.md","3e1811023e6bf76ac1157903999380041fddffdddadfea18ec5872242d1d5eb1" -"md","test-priorities","bmgd","bmgd/gametest/knowledge/test-priorities.md","bf1c726cfcbd44511a97820e1c4d4de1f4b2579ca97cd216f91b91fbeb72e04a" -"md","test-review-template","bmgd","bmgd/workflows/gametest/test-review/test-review-template.md","62f64abc9e42f3014f65b7a663477ea2ae84eea7da423508761535da67d9ad0f" -"md","text-based","bmgd","bmgd/workflows/2-design/gdd/game-types/text-based.md","5895ca65dc93f676bb33b754f2c6be85d5d9b651df87d8431d404dc9bb736ee7" -"md","tower-defense","bmgd","bmgd/workflows/2-design/gdd/game-types/tower-defense.md","03a2cc577fdd1a183ba04409b01b22f2f38713d28f1278481b0f221858f97ec8" -"md","turn-based-tactics","bmgd","bmgd/workflows/2-design/gdd/game-types/turn-based-tactics.md","30a150d8a0ab746f0c67d414be79e7e421fff1b8b7a1b716e64800df72bdb6c2" -"md","unity-testing","bmgd","bmgd/gametest/knowledge/unity-testing.md","24137ebc37c270a8f1a32067ad33647aafd0bab5f4e46706241e5a3820831aee" -"md","unreal-testing","bmgd","bmgd/gametest/knowledge/unreal-testing.md","f20b9d11648ab7916df921183840bc5f8d452e98b54ef447f2ef94054b04b159" -"md","visual-novel","bmgd","bmgd/workflows/2-design/gdd/game-types/visual-novel.md","2d98f4c682f0abbd6330ac1bad04600c596e6b27302adbe9510fc0c0bf53052c" -"md","workflow","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/workflow.md","ceebefb7a8e3771c7672dd047b25db7e0e74bee9d1b36c33410a380f2b3482d7" -"md","workflow","bmgd","bmgd/workflows/1-preproduction/game-brief/workflow.md","288b8cc2749d4ca9954e20eb092801d513373061b19ea5cb6192486de4dea859" -"md","workflow","bmgd","bmgd/workflows/2-design/gdd/workflow.md","756afb87e4ba2a2f6c923dc7157f532eaeae044bc1a26ded64bfc495e1dc903c" -"md","workflow","bmgd","bmgd/workflows/2-design/narrative/workflow.md","6548a6a7fddb3a149e088ee4389b55617bfc62da16f572518068253f7d98f398" -"md","workflow","bmgd","bmgd/workflows/3-technical/game-architecture/workflow.md","3334c99f0b2052cb45b7b84dcd0c5152f4b3afd50acd02e19f44b9ef196ce8eb" -"md","workflow","bmgd","bmgd/workflows/3-technical/generate-project-context/workflow.md","6ee82a503cfd2ece5b034b6d1a1b66d154ad61f1dc79e864241c4017db31a033" -"xml","instructions","bmgd","bmgd/workflows/4-production/code-review/instructions.xml","80d43803dced84f1e754d8690fb6da79e5b21a68ca8735b9c0ff709c49ac31ff" -"xml","instructions","bmgd","bmgd/workflows/4-production/create-story/instructions.xml","1c010269f7473cd477d1bc7581a737062a79cda7b61e30aca7f80d946422bb11" -"xml","instructions","bmgd","bmgd/workflows/4-production/dev-story/instructions.xml","a2e824fbbf54ace573c22717c73639ab7ce74914cb7e5aecca954d2801187725" -"yaml","architecture-patterns","bmgd","bmgd/workflows/3-technical/game-architecture/architecture-patterns.yaml","00b9878fd753b756eec16a9f416b4975945d6439e1343673540da4bccb0b83f5" -"yaml","config","bmgd","bmgd/config.yaml","941269fe27df1f018f4ab89cffcdcba4c92e60f89c9a7145c8e263372c1e2352" -"yaml","decision-catalog","bmgd","bmgd/workflows/3-technical/game-architecture/decision-catalog.yaml","f7fc2ed6ec6c4bd78ec808ad70d24751b53b4835e0aad1088057371f545d3c82" -"yaml","gamedev-brownfield","bmgd","bmgd/workflows/workflow-status/paths/gamedev-brownfield.yaml","5bc8b6da93f6b23f887e2d2c58fb069a3f19940ec02ae82a3dafbc7cecd98a3e" -"yaml","gamedev-greenfield","bmgd","bmgd/workflows/workflow-status/paths/gamedev-greenfield.yaml","b17fd2e60428fdbf32af9ad30b85b2016d2738f175045f3c41e742ce5dfeb9e6" -"yaml","project-levels","bmgd","bmgd/workflows/workflow-status/project-levels.yaml","7faae979120ac99048febb151d290c07ff1a3f75f45a843c225c907c21e523b2" -"yaml","quickflow-brownfield","bmgd","bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml","903a50326fca404d8ad022cf0e664a7e0c80bdcafaa225dc1dc4839ea2bfb03a" -"yaml","quickflow-greenfield","bmgd","bmgd/workflows/workflow-status/paths/quickflow-greenfield.yaml","3f072164aeb118f3cef2829e5c783345ddb4216099da9111c25f53d8688e1d65" -"yaml","sprint-status-template","bmgd","bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml","de75fe50bd5e3f4410ccc99fcd3f5dc958733b3829af1b13b4d7b0559bbca22b" -"yaml","team-gamedev","bmgd","bmgd/teams/team-gamedev.yaml","f362ed346e2339a9f07456c3d4cc20431b74c96330c02af902e0324a9fa4ff0d" -"yaml","workflow","bmgd","bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml","3f8ae6b4b897e93ea877342c767f8cbb97f492ec1557d602596563950178d2e9" -"yaml","workflow","bmgd","bmgd/workflows/1-preproduction/game-brief/workflow.yaml","693c8eef109cb68e0d6fc81f3e638433f3f6e62ab8f6f9c5dd50f353bcb60ecf" -"yaml","workflow","bmgd","bmgd/workflows/2-design/gdd/workflow.yaml","3916778dedc47f6afbce806ff0e52833a2135e66205ae813270c1fdbf194e2a0" -"yaml","workflow","bmgd","bmgd/workflows/2-design/narrative/workflow.yaml","b4974e893276f82be0f7088f2ba40aac85e7313f4e12131fbc0f7079126e688d" -"yaml","workflow","bmgd","bmgd/workflows/3-technical/game-architecture/workflow.yaml","c2ff4e30df343b6b3974bc6ab917b167b6d294ead12f1926cff188616694c165" -"yaml","workflow","bmgd","bmgd/workflows/4-production/code-review/workflow.yaml","b732f8859bf96421ecccf1de21fdbd5ad5522f7b28023a2dd9a3684e976b3db4" -"yaml","workflow","bmgd","bmgd/workflows/4-production/correct-course/workflow.yaml","84f9c6dd74d07572c9dff4944cdf3703fbbd13626a2d648a6cbe1b0e2701027c" -"yaml","workflow","bmgd","bmgd/workflows/4-production/create-story/workflow.yaml","0c87a1b5404195f3882372f7cd5c0b2f567f100c93419d95b81d5f35d847277c" -"yaml","workflow","bmgd","bmgd/workflows/4-production/dev-story/workflow.yaml","27fb893e19ba39afa2268d02fd06c4f82291c08103e25776f06f55b4bcf72f2d" -"yaml","workflow","bmgd","bmgd/workflows/4-production/retrospective/workflow.yaml","a3da0b2634d7d0085866212ab8adb99b75d8fc42463dc39b640436ac46a4cefa" -"yaml","workflow","bmgd","bmgd/workflows/4-production/sprint-planning/workflow.yaml","1994fadc4ea0e46df683bdc6b73a1c9b7bf28ca9f321e767dd62ed24eeb930a9" -"yaml","workflow","bmgd","bmgd/workflows/4-production/sprint-status/workflow.yaml","efcc0766c3fef56eaa3422c6b22de90ed12f6ce1d719c4c3c91d08623a1e5283" -"yaml","workflow","bmgd","bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml","11d5800c5c8f14f67928c4425450b5783c7f1d40a33511422d4b37b18af726b5" -"yaml","workflow","bmgd","bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml","f9949455bca1b4e008eb26690cccb3a7cb965a9d50f706027eaf31bf11ec3458" -"yaml","workflow","bmgd","bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml","96fa6de39134a0b0660742c97b390045eb7069e512860ada266dc62d47145ea4" -"yaml","workflow","bmgd","bmgd/workflows/gametest/automate/workflow.yaml","b2288417061eed7164874a8225733aa6d9fc098ca6700d8043431ee9638c7e07" -"yaml","workflow","bmgd","bmgd/workflows/gametest/performance/workflow.yaml","576a2abbc34d8d2cfeb097baf07a980655a8db3f26ef2371561c00babdbceca9" -"yaml","workflow","bmgd","bmgd/workflows/gametest/playtest-plan/workflow.yaml","b57f9a974a1e28e83181554d6d9705068348e7f9f97487762949a6aa575e5aec" -"yaml","workflow","bmgd","bmgd/workflows/gametest/test-design/workflow.yaml","5a1252742975b2b1fa41dd0d24434e5808306011374004f5d8dd276c8c581374" -"yaml","workflow","bmgd","bmgd/workflows/gametest/test-framework/workflow.yaml","11424fa504c20809e94a574e0e807575fd74abcc4579e4663d111f4e56119d28" -"yaml","workflow","bmgd","bmgd/workflows/gametest/test-review/workflow.yaml","6a1689b44c80c80a23f5cd113757b500a8445a01395de6cbe73e5d18aaada9e6" -"yaml","workflow","bmgd","bmgd/workflows/workflow-status/init/workflow.yaml","3888c2fdf4524b7fd73918b0c0aea148709e9e45b65ed9667df78e2ba8df6429" -"yaml","workflow","bmgd","bmgd/workflows/workflow-status/workflow.yaml","780856bd269f155c99ca2a4fa42896ca697c37b86eb4b7bb2f3901acb5ae3a1f" -"yaml","workflow-status-template","bmgd","bmgd/workflows/workflow-status/workflow-status-template.yaml","5742b41a5b4c23d137ffd89f4097c3c8d0330e116690a24a69ceb56fa3ec5b12" -"csv","default-party","bmm","bmm/teams/default-party.csv","43209253a2e784e6b054a4ac427c9532a50d9310f6a85052d93ce975b9162156" +"csv","agent-manifest","_config","_config/agent-manifest.csv","ad73a71bb5974c78804b92cc187fb97e47a0fd70fe07dfb16bca4eb6dd5748ae" +"csv","task-manifest","_config","_config/task-manifest.csv","bac7378952f0c79a48469b582997507b08cf08583b31b8aa6083791db959e0f0" +"csv","workflow-manifest","_config","_config/workflow-manifest.csv","5858013bae1a19f4c8b8607b3946b3b2ff256a628b355d6820ea970e5cbea5c8" +"yaml","manifest","_config","_config/manifest.yaml","0b73a7c59b31a424c6ef1caa74d9dc0357d8ffbc6b041391dab3e057810b6269" +"md","documentation-standards","_memory","_memory/tech-writer-sidecar/documentation-standards.md","b046192ee42fcd1a3e9b2ae6911a0db38510323d072c8d75bad0594f943039e4" +"md","stories-told","_memory","_memory/storyteller-sidecar/stories-told.md","8d7cb6a41382340a550c88627ef0c680ee7c20d61b53a7b18994d27f2368a5d4" +"md","story-preferences","_memory","_memory/storyteller-sidecar/story-preferences.md","b269d52c87cf6913ff2ce31772ed5faa5d064ab5f6889be6c9bec3c9b2e7c47a" +"yaml","config","_memory","_memory/config.yaml","1643c5dfa1cb400c61173ce85feeddb9a00f214ef01b17b07e3c5c07e32498c1" +"csv","common-workflow-tools","bmb","bmb/workflows/workflow/data/common-workflow-tools.csv","c73c8a903bf158624f7eadc03c6dceb4b338f771af3c7048a9b1a37a45ae91bf" +"csv","communication-presets","bmb","bmb/workflows/agent/data/communication-presets.csv","25bea124919e868d408eab0106011da30a66694f9f96e573dd8cc60780aa24d8" +"csv","module-help","bmb","bmb/module-help.csv","30bc24e948a6fb227981c4422d7d1a6260eec2a1bfa2cd7450493306830f23c1" +"md","agent-architecture","bmb","bmb/workflows/agent/data/agent-architecture.md","d23e35f3db1e5922facbbae061080a2d940673b4f8a90bfae7db6d28abf81157" +"md","agent-architecture","bmb","bmb/workflows/module/data/agent-architecture.md","020a293e60f06b3d57b7e489d57bdf5afa56028149c1b59614dfd54fabf48251" +"md","agent-compilation","bmb","bmb/workflows/agent/data/agent-compilation.md","3aa7c61f1da342f74ae445f7dbcbae3a796e6a9eed892ceb39010c23909d9705" +"md","agent-menu-patterns","bmb","bmb/workflows/agent/data/agent-menu-patterns.md","cdd96b31cf7aa4205cd41b209e555b155072b4e1922bd9accc085e4c350557ec" +"md","agent-metadata","bmb","bmb/workflows/agent/data/agent-metadata.md","173cc5de2aab6a0eaa1d0734a0e2b9d8a6889937f20cdc32279611c5a2ca84a2" +"md","agent-plan.template","bmb","bmb/workflows/agent/templates/agent-plan.template.md","71c75a004f86dc25c42cb43d21817d98a23c8d96db74c3821051cb45da6576c9" +"md","agent-spec-template","bmb","bmb/workflows/module/data/agent-spec-template.md","03091b4ae60ec745e751629d2c6ec31f1f89db89189453fb3878e1ec158b0831" +"md","agent-template","bmb","bmb/workflows/agent/templates/agent-template.md","1dd9e1eb44b89f577358f9b8ae50e67b577f0aede059f5082611b75701bd3a15" +"md","agent-validation","bmb","bmb/workflows/agent/data/agent-validation.md","0111a5645188abd821f3156da0d4104ab5d27c13610211a5cb33102727846130" +"md","architect","bmb","bmb/workflows/agent/data/reference/module-examples/architect.md","5e556bbf1515a0fb733b515428e86face65b1f1361cfd6ddc9674d385b2ff784" +"md","architecture","bmb","bmb/workflows/workflow/data/architecture.md","215911ee37c087810e32505d47b39f3e3c59ad35a1c5ae6602a4716674fc391d" +"md","brainstorm-context","bmb","bmb/workflows/agent/data/brainstorm-context.md","bd86effd11ea9bf8bc1b70f7cb63949441b7e3876b84471537daacd8caf0c20f" +"md","brief-template","bmb","bmb/workflows/module/templates/brief-template.md","85dcbd2bd82d143e76b627722d1f50a91dddf2c3b36af714566cd32925ee3687" +"md","critical-actions","bmb","bmb/workflows/agent/data/critical-actions.md","a1a3b248b25f800981fe8b83cd812deb1093a346a7d1b8ab8a2e730b512f77df" +"md","csv-data-file-standards","bmb","bmb/workflows/workflow/data/csv-data-file-standards.md","4d809f6fe47d6236fdca9ba66db981b436e44452f7ffd59f08b40599ab265cb8" +"md","e-01-load-existing","bmb","bmb/workflows/agent/steps-e/e-01-load-existing.md","539c7451d7b641900dfe9297823fb41feff7e08d9cfb5f67381bafca1339501a" +"md","e-02-discover-edits","bmb","bmb/workflows/agent/steps-e/e-02-discover-edits.md","4839d6eb0943f38b3e01dcfacb4b9db2578ebc0fc869956e457160d9a2d10bd9" +"md","e-03-placeholder","bmb","bmb/workflows/agent/steps-e/e-03-placeholder.md","4076b77b471144f7bd58454a2652bed9a11a964bb249df95272b73590757a95e" +"md","e-04-sidecar-metadata","bmb","bmb/workflows/agent/steps-e/e-04-sidecar-metadata.md","10f20ab04d7772edb3ad53f542fdc5c54c0e686efc6464dd72a29800ef7755ca" +"md","e-05-persona","bmb","bmb/workflows/agent/steps-e/e-05-persona.md","f563417e52584fa105c280b5e4b80bd71ec361359b45bbe7ab0678800aa00a08" +"md","e-06-commands-menu","bmb","bmb/workflows/agent/steps-e/e-06-commands-menu.md","eb3c1ea01780eb15aa912bdffa4349b7eda5a81f0225f44a0eeddf245cf4b9a2" +"md","e-07-activation","bmb","bmb/workflows/agent/steps-e/e-07-activation.md","05cacc92ad28e04b384bbb6b8828b28f5ff9ce1deb0b0582dc5c95b5060e5348" +"md","e-08-edit-agent","bmb","bmb/workflows/agent/steps-e/e-08-edit-agent.md","b221ebe838b60ba66bca2df342fc0b6ad2abae211bea1f01b1a2d8186cad81dc" +"md","e-09-celebrate","bmb","bmb/workflows/agent/steps-e/e-09-celebrate.md","8a76fa2aca4500f9a0fecc9d2018821eb8bbfc5d533e9f85861acb910f053863" +"md","frontmatter-standards","bmb","bmb/workflows/workflow/data/frontmatter-standards.md","b02270a8c293bc3b97d1684774153e23a2c212af51a5495e5d419f24931e49d0" +"md","input-discovery-standards","bmb","bmb/workflows/workflow/data/input-discovery-standards.md","e5201a3b67d728df46876e72ca99ad487ff334cfb9b64dc20c1cb3c8f4085117" +"md","intent-vs-prescriptive-spectrum","bmb","bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md","13f8048611e00e92a05eb0106de237938458cd4fc04bc5f4d272ae4697a2a91e" +"md","menu-handling-standards","bmb","bmb/workflows/workflow/data/menu-handling-standards.md","0f2065c8ec2aa7ab1df1f5f92db0d9cd8a2364250ed9b7932e6aa17816f130e1" +"md","minimal-output-template","bmb","bmb/workflows/workflow/templates/minimal-output-template.md","f61de8986573aa22ab1bc37235b063541a0209e1033b7c7c0a587dbd8b120a98" +"md","module-help-generate","bmb","bmb/workflows/module/module-help-generate.md","c3e0fdec202582f13c471355925d319fd33b475514644c02c4b2d807095427bd" +"md","module-standards","bmb","bmb/workflows/module/data/module-standards.md","4314e487a73c5cb6a85357e8ae71e4e7bfbd75ae395e19056c109c4587d4dd8e" +"md","module-yaml-conventions","bmb","bmb/workflows/module/data/module-yaml-conventions.md","669831f40384bc07982882a85cf050b725151fa5e1fcd711447c54831600e379" +"md","output-format-standards","bmb","bmb/workflows/workflow/data/output-format-standards.md","e88aa0032d0a2f6366d43244e739dcd67c1bb2525402c20d2e4d89ea6d394104" +"md","persona-properties","bmb","bmb/workflows/agent/data/persona-properties.md","26ad8d8dc3aae7cdb0818ce26685c9970e3adffefbac1911ce5ee40ed00c7a6b" +"md","principles-crafting","bmb","bmb/workflows/agent/data/principles-crafting.md","dc22ed0b426c290119d0295fdf280a2182b6027df45ea2679dab9d10e974b847" +"md","step-00-conversion","bmb","bmb/workflows/workflow/steps-c/step-00-conversion.md","c2fa704c6af768516520aabd21c8231e7d67a6c030aca6833b00d9bf47aa4049" +"md","step-01-brainstorm","bmb","bmb/workflows/agent/steps-c/step-01-brainstorm.md","3977b82c7bf9431a90f4ed8f1aa6067cfc66ee658bceea283d5d631cc05200df" +"md","step-01-discovery","bmb","bmb/workflows/workflow/steps-c/step-01-discovery.md","8b7c7b6e22e8bacf8dc2612d07e2142bcb05590b005928ac548648036dd4062c" +"md","step-01-init-continuable-template","bmb","bmb/workflows/workflow/templates/step-01-init-continuable-template.md","1ea222b3c2a2a569515ea25493e8bc6205745e1610a2df5a1d70348e76cd48e5" +"md","step-01-load-brief","bmb","bmb/workflows/module/steps-c/step-01-load-brief.md","06f46a88014817367f8991d9cd697cfff2cfb229c790ec3dc07674d19cdfaf81" +"md","step-01-load-target","bmb","bmb/workflows/module/steps-e/step-01-load-target.md","e5e15625642b5fe5836dc57a150f043e2a87355ecd76097993ce9efd233bca21" +"md","step-01-load-target","bmb","bmb/workflows/module/steps-v/step-01-load-target.md","8006a13b76b69c385ff35c2d703f125c235779d3a8561091411e3d6e1dc47bce" +"md","step-01-validate","bmb","bmb/workflows/workflow/steps-v/step-01-validate.md","0a0a7dbcbbdaa1d35855c1a02cc999edb447a60062080775882d8982172e398c" +"md","step-01-validate-max-mode","bmb","bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md","a85ea69b45449ac7f6d9bb0ecb3a5c30cf87dba755c6cf7065b268103ebba795" +"md","step-01-welcome","bmb","bmb/workflows/module/steps-b/step-01-welcome.md","ed259839a715cdd016ae5161c375f2b21c2038dafe4bb4419c85e61d286609b7" +"md","step-01b-continuation","bmb","bmb/workflows/workflow/steps-c/step-01b-continuation.md","d4744e00afb0ddfddd60f8ccf33d3f0b930d5edfa6da7bcab174e5cae4ed4011" +"md","step-01b-continue","bmb","bmb/workflows/module/steps-c/step-01b-continue.md","fd8d93b04c057fb7cf2a8c7c6811cb6826900d1f17b49692f9d7909e05cfc4d8" +"md","step-01b-structure","bmb","bmb/workflows/workflow/steps-v/step-01b-structure.md","dc1efc9dfa9180798102341c0522512ee4f29903f5ff1c78fe9a3ce0c1604737" +"md","step-02-classification","bmb","bmb/workflows/workflow/steps-c/step-02-classification.md","560d01ce4db22bc094f88657dc1b2f8135fc290b98a638a4b79de5a685fb6847" +"md","step-02-discovery","bmb","bmb/workflows/agent/steps-c/step-02-discovery.md","3f8ff9b7ca8d9e556fa3d624b9c58975f6cd44438681223795648aa3d8b7099f" +"md","step-02-file-structure","bmb","bmb/workflows/module/steps-v/step-02-file-structure.md","fc0acf419646452140b033995993f288fa3d97fd41bbd48f7502e319bb326817" +"md","step-02-frontmatter-validation","bmb","bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md","26627ab0efe0b824ab15ef82e64e0d41f0a98a9663d4a39d542f4f65a2ef170a" +"md","step-02-select-edit","bmb","bmb/workflows/module/steps-e/step-02-select-edit.md","500b040c7c5540505c83932cc880de02727576f25404524bdb4be1554c261491" +"md","step-02-spark","bmb","bmb/workflows/module/steps-b/step-02-spark.md","3e054a19fe1a5166759e09a2fb3788d244f7c4f776d28663339401d8b2ac25e2" +"md","step-02-structure","bmb","bmb/workflows/module/steps-c/step-02-structure.md","6177bdc1971c60299b00d9ce9f37106ecad405bf12d6378bedf30779f87a1e03" +"md","step-02b-path-violations","bmb","bmb/workflows/workflow/steps-v/step-02b-path-violations.md","ef6f2e0b8a6f608ba06a74466acdd74bf3cf6b9ac5290c58ec780e881f912ed1" +"md","step-03-apply-edit","bmb","bmb/workflows/module/steps-e/step-03-apply-edit.md","e9ec488bd25765c1769a8f39e9fd335260c17eb247f2c5246e55a37d2fb02bd7" +"md","step-03-config","bmb","bmb/workflows/module/steps-c/step-03-config.md","14f1bd471ae827aa5ba4947ead23cfbb728ccfa4d2dcf41f7080eed08db35760" +"md","step-03-menu-validation","bmb","bmb/workflows/workflow/steps-v/step-03-menu-validation.md","352f083900a5bd4c7580a21c097547415e67a030f147ddbf338e6605f5e17679" +"md","step-03-module-type","bmb","bmb/workflows/module/steps-b/step-03-module-type.md","387020cdbf5c17286425edcbdfad48d874bd80119aa1e5fd3ecafee59a07385d" +"md","step-03-module-yaml","bmb","bmb/workflows/module/steps-v/step-03-module-yaml.md","874c7a400b90d7c8a53c9348c6194812f21f2a95da1a80127956ed3fb208ae01" +"md","step-03-requirements","bmb","bmb/workflows/workflow/steps-c/step-03-requirements.md","b9ffb90bb9b58df2d1af69b72af4bf3975e8e2b02a22615eaa98da29ae45e269" +"md","step-03-sidecar-metadata","bmb","bmb/workflows/agent/steps-c/step-03-sidecar-metadata.md","4a7b64165d29ff01f5ae90c0daae3bb875485f77412a3623f299ea26f85f9df9" +"md","step-04-agent-specs","bmb","bmb/workflows/module/steps-v/step-04-agent-specs.md","5e2b8562eb57857c80cc5f5ee1e08290c39d79070668941ee155552820bd42a9" +"md","step-04-agents","bmb","bmb/workflows/module/steps-c/step-04-agents.md","097d8b87aa5f1402a0dbb3e9255977f7cfe8dba35e237df3ce2c614419091e19" +"md","step-04-persona","bmb","bmb/workflows/agent/steps-c/step-04-persona.md","8f37e0c5f118673a8489ad9b40a0714716c0ddcbad1ed7c834e8bdf67e33656a" +"md","step-04-review","bmb","bmb/workflows/module/steps-e/step-04-review.md","8fc1da4ab65f6639d860600c942e82a9c2ad7fa8fc3788bb9d35e98c811e9cbb" +"md","step-04-step-type-validation","bmb","bmb/workflows/workflow/steps-v/step-04-step-type-validation.md","22666ec35c68019eaa956f792e653bea6d9bb33adae88f81945423925b0aacd9" +"md","step-04-tools","bmb","bmb/workflows/workflow/steps-c/step-04-tools.md","0202c1f6e80366d0e6a970fa3484264bdbec56ac36b0253aee3db710a7b96ab7" +"md","step-04-vision","bmb","bmb/workflows/module/steps-b/step-04-vision.md","4200d1b6811ae7e16ef2ec5377f7a006b508353c42baa1d65ce5e919e35a4414" +"md","step-05-commands-menu","bmb","bmb/workflows/agent/steps-c/step-05-commands-menu.md","13d355dd79eedbbaa4e3b73ef4c7336edf11cf86d3d110bd99154c6405c8f543" +"md","step-05-confirm","bmb","bmb/workflows/module/steps-e/step-05-confirm.md","f864c0d7c0f2178dbe5ee785fd6136a097801de22fe9927cc717174465eace77" +"md","step-05-identity","bmb","bmb/workflows/module/steps-b/step-05-identity.md","bf6750cdea36d19553295d201d5cf3cc05bba724b4cf105ae297b4fc328ddbe8" +"md","step-05-output-format-validation","bmb","bmb/workflows/workflow/steps-v/step-05-output-format-validation.md","d8aed144c932f4d7615b595696a7849d4a8ce468ac632f1316b3a3efe0337f5d" +"md","step-05-plan-review","bmb","bmb/workflows/workflow/steps-c/step-05-plan-review.md","1896308083a01fdbb2c723e3d8f11f60e0423dd2e1d46949e51f6ed2a2bb9cf3" +"md","step-05-workflow-specs","bmb","bmb/workflows/module/steps-v/step-05-workflow-specs.md","d2b3b63e54480646b5524b3bd32c0a6acfb410c0ebfb48991cbf3a43b2f5be5b" +"md","step-05-workflows","bmb","bmb/workflows/module/steps-c/step-05-workflows.md","ee6ba8767d893f96428a425119039014b5d4d3c2a9e65d59092f100c668c52c0" +"md","step-06-activation","bmb","bmb/workflows/agent/steps-c/step-06-activation.md","2f7923d26cfac1698d2e2d3272cb644947a4d4d705a4236e29f4bb16a4b903df" +"md","step-06-design","bmb","bmb/workflows/workflow/steps-c/step-06-design.md","a59fef28936210a6c0edeaba5e4b02af6188950fc6482eb9365d2a93bb8e727c" +"md","step-06-docs","bmb","bmb/workflows/module/steps-c/step-06-docs.md","8e6791e97658a3288d297b61e1396ee3eda64d087077af7a47880f33bd5456d1" +"md","step-06-documentation","bmb","bmb/workflows/module/steps-v/step-06-documentation.md","3c2cda05dba1da28bfecac96b442dd6b260916a5d387255d8a5f8aabf775918a" +"md","step-06-users","bmb","bmb/workflows/module/steps-b/step-06-users.md","876c8a8f186569e99e42a1a5a3f7b94f33081306af9b1f354250285fbb1616c8" +"md","step-06-validation-design-check","bmb","bmb/workflows/workflow/steps-v/step-06-validation-design-check.md","934be5b8740504411c29c92caa162bde9f9f5b76f9b51f900cddc81ce20afc48" +"md","step-07-build-agent","bmb","bmb/workflows/agent/steps-c/step-07-build-agent.md","3a82c276e43e54faef410a2ac8d4f0f8f0bfd80d085aa563da2334cb30b76448" +"md","step-07-complete","bmb","bmb/workflows/module/steps-c/step-07-complete.md","5e62ae3e42648d1bb9e4ad77c0b01eff36eee498d8539804123286cff8ae685e" +"md","step-07-foundation","bmb","bmb/workflows/workflow/steps-c/step-07-foundation.md","496ab7074b6678d0a3ce5a89aec60d3867fb224a7265b004e5e438a80aa6fec7" +"md","step-07-installation","bmb","bmb/workflows/module/steps-v/step-07-installation.md","e0067d8cf1ad2b2a0cbdd645ef0b3d897f0424f80eb1ac6c0890a1c1a9f90bbf" +"md","step-07-instruction-style-check","bmb","bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md","f637bce8213eed574a5b4d65ee043c1aedfdedf76a1f0d2603f3002a361cb5be" +"md","step-07-value","bmb","bmb/workflows/module/steps-b/step-07-value.md","5634beb03472aee5eba35e5c83d1b0ef502055e6fdca6f16698f9f6ac1cb53b4" +"md","step-08-agents","bmb","bmb/workflows/module/steps-b/step-08-agents.md","e33c9857d1f5a43371a34f56ab1e4c1e3b8aa9056eb7dd7aa2e928c3b552e34e" +"md","step-08-build-step-01","bmb","bmb/workflows/workflow/steps-c/step-08-build-step-01.md","dd3677dd82dbcc6339a696a1899c8283e6fb23b187ddf0d5bc9122e0d29546ad" +"md","step-08-celebrate","bmb","bmb/workflows/agent/steps-c/step-08-celebrate.md","8982e0ca16a2bbeed292605d7e07c714c92c5c7e5f25418a36129175c0432495" +"md","step-08-collaborative-experience-check","bmb","bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md","14b9afce8eb7fe59d3b8cc3a44295b955d4419fed0e8d1a6b0ac31a3ef3cc610" +"md","step-08-report","bmb","bmb/workflows/module/steps-v/step-08-report.md","e9080fe17dc98280a1d2d7adeaca039d185f580307d43f1224dcc9cf44d62101" +"md","step-08b-subprocess-optimization","bmb","bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md","cda18ba6427b1fb8d7266123be8e059c4289ed2b62abc3a39bbae8ea8593227c" +"md","step-09-build-next-step","bmb","bmb/workflows/workflow/steps-c/step-09-build-next-step.md","c6fd5d88991d33c9a947f3e0c49181231b95a2baa5c93ac9ac71b2dbd568bcf2" +"md","step-09-cohesive-review","bmb","bmb/workflows/workflow/steps-v/step-09-cohesive-review.md","cf604f0dab7aa11af521f2270a9c96fa02c7f99f3430811db1ae25dd59dbe946" +"md","step-09-workflows","bmb","bmb/workflows/module/steps-b/step-09-workflows.md","d0a8f1b824d1423f9a5544112afe03725c4b8196a0be62b32c161a930f07e0ee" +"md","step-10-confirmation","bmb","bmb/workflows/workflow/steps-c/step-10-confirmation.md","b5cc8dab668df3888b689f272cc39706471a86286542ef807b176abca5a93ddf" +"md","step-10-report-complete","bmb","bmb/workflows/workflow/steps-v/step-10-report-complete.md","ec38ede67f999076e3df5eaf3cb88f1f069791cd770dda826c101cac61a1e814" +"md","step-10-tools","bmb","bmb/workflows/module/steps-b/step-10-tools.md","0987d73d4335b6779ca2cd27d2e7620eef92b98cece2d9aa442fe243435c845f" +"md","step-11-completion","bmb","bmb/workflows/workflow/steps-c/step-11-completion.md","49e0f7f8d6aa4ac73828a8cbce8cf9ab0816871009559673dcbbe716c9ed21f0" +"md","step-11-plan-validation","bmb","bmb/workflows/workflow/steps-v/step-11-plan-validation.md","58e4c8a2363cc7eef8b4f1c86c52a03d94e6e160462c34478ff851b2232be8c8" +"md","step-11-scenarios","bmb","bmb/workflows/module/steps-b/step-11-scenarios.md","d5ceda11834165ce9b6111d754ce5dbbbee11f34411805c2cc7d7f5fcde1cda8" +"md","step-12-creative","bmb","bmb/workflows/module/steps-b/step-12-creative.md","495309304d1a68b4b0dbe4b5fba0548092641b216b5c57d7cfd6708679898d43" +"md","step-13-review","bmb","bmb/workflows/module/steps-b/step-13-review.md","5a6050a0ebf2046c3730c951572ec17e04bf0e9ccf145b8d0aa3d03235e11477" +"md","step-14-finalize","bmb","bmb/workflows/module/steps-b/step-14-finalize.md","09aba595988eda5bece47552e8b93241780019169e421af5bb6faa33abd71b4a" +"md","step-1b-template","bmb","bmb/workflows/workflow/templates/step-1b-template.md","ec4b361c53e6582c2b610b7a96241bd2726acb98dfab7e4a7ef005c3f4140093" +"md","step-e-01-assess-workflow","bmb","bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md","0b1a8a9a6308d428ca8ea285054ca7c6127d8d712e808e13d53c66393872a42a" +"md","step-e-02-discover-edits","bmb","bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md","e6dcbf4d638eba3ee5aafb89db958b71c2bea17c56c1724c3741174e943f1c0c" +"md","step-e-03-fix-validation","bmb","bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md","f0d07b596606ca6c34616a89b210f09c71ed1b87acce9148e4e88c21d91bdc21" +"md","step-e-04-direct-edit","bmb","bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md","a4afa5e0942e386ebaebad2d815144ce08f067024d8e7e2bc29874241cf41e4e" +"md","step-e-05-apply-edit","bmb","bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md","3e5a73e07176ec70e742561c87b6892ca351397f43061a6d2b10d6b7cbcdb26f" +"md","step-e-06-validate-after","bmb","bmb/workflows/workflow/steps-e/step-e-06-validate-after.md","969677115937443e64cc1f01c3acd91c87e0e0d5288ce1bac4db8319d4dd6273" +"md","step-e-07-complete","bmb","bmb/workflows/workflow/steps-e/step-e-07-complete.md","1d5f6b8b3830c46b71c5f9d81d6a522879d118521584c40121dc953a9d78b84d" +"md","step-file-rules","bmb","bmb/workflows/workflow/data/step-file-rules.md","1b470e3d55a8aed1b0724612d1b84524147eabb27e9fa46886ec5d0df7a674f3" +"md","step-template","bmb","bmb/workflows/workflow/templates/step-template.md","3d1b8c2ed88ceeb1545c85c2fe6c34352b2343fb8f9d1a1fba768ac6fc10eb31" +"md","step-type-patterns","bmb","bmb/workflows/workflow/data/step-type-patterns.md","9c5f50d2ddaf3d50d54ee29e21a323bc82f72936dfaf67ff6641fa83c4c68fec" +"md","subprocess-optimization-patterns","bmb","bmb/workflows/workflow/data/subprocess-optimization-patterns.md","533ec5fce72104b1b220c40333489241f55291fdd7973e7235f8d2d4b3d193a4" +"md","trimodal-workflow-structure","bmb","bmb/workflows/workflow/data/trimodal-workflow-structure.md","e83b38d8abed9a06495f3da39d8db6d24cd00cf5b5369577f422f22e2b7695e9" +"md","understanding-agent-types","bmb","bmb/workflows/agent/data/understanding-agent-types.md","1f852c86102211c6db08c9d1ed60d63ec7cd460f1bafd308cb3b6841114d1683" +"md","v-01-load-review","bmb","bmb/workflows/agent/steps-v/v-01-load-review.md","a0dc536b3523025be2f0b823b9343e46bffc1b2bea847f6e52c7f6e7203d1c8a" +"md","v-02a-validate-metadata","bmb","bmb/workflows/agent/steps-v/v-02a-validate-metadata.md","32b227f2d8fd18637b1d5b78a9598e2600e41f1a70e8caff846a18c287b2ddb1" +"md","v-02b-validate-persona","bmb","bmb/workflows/agent/steps-v/v-02b-validate-persona.md","b7535cdf8ae862bf3f3994b900343b73028485d9843dc7df9678253a1e0e65b4" +"md","v-02c-validate-menu","bmb","bmb/workflows/agent/steps-v/v-02c-validate-menu.md","33782859da582ac82acd88be9f604679d7b148dc6fbf0bc0509288cf7d9d0d9e" +"md","v-02d-validate-structure","bmb","bmb/workflows/agent/steps-v/v-02d-validate-structure.md","69c8698961d714f9806d7657b6d9aac88ddf8c9a7c5590bdc764d11d54c6f281" +"md","v-02e-validate-sidecar","bmb","bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md","9eb2ec9001fbc2ffea80a9158d4d496c6acab2b965d928abc2843555508a6458" +"md","v-03-summary","bmb","bmb/workflows/agent/steps-v/v-03-summary.md","db9b978c1569afa254184960a9c31ae71a8356a6def57ba09c0961f4efa46ee0" +"md","workflow-chaining-standards","bmb","bmb/workflows/workflow/data/workflow-chaining-standards.md","6aede9a3350786f71687c470038748ad255859e310cda854d147644216bf9bfe" +"md","workflow-create-agent","bmb","bmb/workflows/agent/workflow-create-agent.md","5b83913d4947e77a5137a4fabbe36ca338d45f80afc5c1dedb93c343dd1310c3" +"md","workflow-create-module","bmb","bmb/workflows/module/workflow-create-module.md","be3147584de6a3740071b9c80483d8d75f3b4fd818e5c2555cf03ce5d6d4c98c" +"md","workflow-create-module-brief","bmb","bmb/workflows/module/workflow-create-module-brief.md","7c254d7d318b0ee3a8646acf50b59eb744d960614be5d541a65c54a22f569813" +"md","workflow-create-workflow","bmb","bmb/workflows/workflow/workflow-create-workflow.md","5eadc6e949ae2b453811f79d58da1b4800ff6a3f713a181369fd5d88726407ff" +"md","workflow-edit-agent","bmb","bmb/workflows/agent/workflow-edit-agent.md","c72408f1c72bcbf15a7a8072bc07cf023d25c16fa928bb18f682db1177694fb3" +"md","workflow-edit-module","bmb","bmb/workflows/module/workflow-edit-module.md","c60fa81100c0dab568bb0d1f55d5035c59ca66ebd7f48ca503bbc4866ccdcb82" +"md","workflow-edit-workflow","bmb","bmb/workflows/workflow/workflow-edit-workflow.md","012b2ec4997fcab5b601b475f9aed2a72da41370ea5377bb03064f98c74be91d" +"md","workflow-examples","bmb","bmb/workflows/workflow/data/workflow-examples.md","858a3052f65cad4d6288b8996953e7ae674b00626fe52416c1c088c150847c05" +"md","workflow-rework-workflow","bmb","bmb/workflows/workflow/workflow-rework-workflow.md","df97ef45745a89e90b2db9f619aa40bbcc8ea93bd258247d0289fee2add70cf5" +"md","workflow-spec-template","bmb","bmb/workflows/module/templates/workflow-spec-template.md","e226dc5357c301dfba14dce94bfaad692bfb0f025599a82ae4c97d494627c7af" +"md","workflow-template","bmb","bmb/workflows/workflow/templates/workflow-template.md","6b39e89217d20c7d917602874978bbf018f0d7d3e33e0e753331a602f114fc14" +"md","workflow-type-criteria","bmb","bmb/workflows/workflow/data/workflow-type-criteria.md","60dc1e893f39a9a67540196b6cd5d3424e1e29efd0622962ffb39665b10265bb" +"md","workflow-validate-agent","bmb","bmb/workflows/agent/workflow-validate-agent.md","a1459e71ef5ef12d674f029d45e9560386987e33affc6b8b8e45b302a423bd62" +"md","workflow-validate-max-parallel-workflow","bmb","bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md","4133b5a77c454fc48a55d5e0896fe2d7d21d9e9e39c3e2024febe200df16b3ed" +"md","workflow-validate-module","bmb","bmb/workflows/module/workflow-validate-module.md","7e02b817d7f6bc21ff5bee00f194996a0dd8385bcabd026b2efdcc3f157bebb9" +"md","workflow-validate-workflow","bmb","bmb/workflows/workflow/workflow-validate-workflow.md","f792e9b04ee4fe43e40b10499714e3bbb085c2304ddc478faf9b1bb333e11b72" +"md","yy-mm-dd-entry-template","bmb","bmb/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md","afad2b3f97e0a82fb371ce89cab74734eb5b5c1238dfaed02f5967b581bf7c47" +"yaml","config","bmb","bmb/config.yaml","30d714f6a274d8d789d65aadaaaf53337999365ebc1a277a705538203f188a24" +"csv","default-party","bmm","bmm/teams/default-party.csv","5af107a5b9e9092aeb81bd8c8b9bbe7003afb7bc500e64d56da7cc27ae0c4a6e" "csv","documentation-requirements","bmm","bmm/workflows/document-project/documentation-requirements.csv","d1253b99e88250f2130516b56027ed706e643bfec3d99316727a4c6ec65c6c1d" -"csv","domain-complexity","bmm","bmm/workflows/2-plan-workflows/prd/domain-complexity.csv","ed4d30e9fd87db2d628fb66cac7a302823ef6ebb3a8da53b9265326f10a54e11" -"csv","domain-complexity","bmm","bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv","cb9244ed2084143146f9f473244ad9cf63d33891742b9f6fbcb6e354fa4f3a93" -"csv","project-types","bmm","bmm/workflows/2-plan-workflows/prd/project-types.csv","7a01d336e940fb7a59ff450064fd1194cdedda316370d939264a0a0adcc0aca3" +"csv","domain-complexity","bmm","bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv","f775f09fb4dc1b9214ca22db4a3994ce53343d976d7f6e5384949835db6d2770" +"csv","domain-complexity","bmm","bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv","3dc34ed39f1fc79a51f7b8fc92087edb7cd85c4393a891d220f2e8dd5a101c70" +"csv","module-help","bmm","bmm/module-help.csv","70ce6fcf717801e5b3d47f4d0496b027c5dc4e1ce0a0508613f5a4abd828a354" +"csv","project-types","bmm","bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv","7a01d336e940fb7a59ff450064fd1194cdedda316370d939264a0a0adcc0aca3" "csv","project-types","bmm","bmm/workflows/3-solutioning/create-architecture/data/project-types.csv","12343635a2f11343edb1d46906981d6f5e12b9cad2f612e13b09460b5e5106e7" -"csv","tea-index","bmm","bmm/testarch/tea-index.csv","374a8d53b5e127a9440751a02c5112c66f81bc00e2128d11d11f16d8f45292ea" -"json","excalidraw-library","bmm","bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json","8e5079f4e79ff17f4781358423f2126a1f14ab48bbdee18fd28943865722030c" "json","project-scan-report-schema","bmm","bmm/workflows/document-project/templates/project-scan-report-schema.json","53255f15a10cab801a1d75b4318cdb0095eed08c51b3323b7e6c236ae6b399b7" -"md","api-request","bmm","bmm/testarch/knowledge/api-request.md","93ac674f645cb389aafe08ce31e53280ebc0385c59e585a199b772bb0e0651fb" "md","architecture-decision-template","bmm","bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md","5d9adf90c28df61031079280fd2e49998ec3b44fb3757c6a202cda353e172e9f" -"md","atdd-checklist-template","bmm","bmm/workflows/testarch/atdd/atdd-checklist-template.md","b89f46efefbf08ddd4c58392023a39bd60db353a3f087b299e32be27155fa740" -"md","auth-session","bmm","bmm/testarch/knowledge/auth-session.md","b2ee00c5650655311ff54d20dcd6013afb5b280a66faa8336f9fb810436f1aab" -"md","burn-in","bmm","bmm/testarch/knowledge/burn-in.md","5ba3d2abe6b961e5bc3948ab165e801195bff3ee6e66569c00c219b484aa4b5d" "md","checklist","bmm","bmm/workflows/4-implementation/code-review/checklist.md","e30d2890ba5c50777bbe04071f754e975a1d7ec168501f321a79169c4201dd28" -"md","checklist","bmm","bmm/workflows/4-implementation/correct-course/checklist.md","d3d30482c5e82a84c15c10dacb50d960456e98cfc5a8ddc11b54e14f3a850029" -"md","checklist","bmm","bmm/workflows/4-implementation/create-story/checklist.md","3eacc5cfd6726ab0ea0ba8fe56d9bdea466964e6cc35ed8bfadeb84307169bdc" +"md","checklist","bmm","bmm/workflows/4-implementation/correct-course/checklist.md","24a3f3e0108398d490dcfbe8669afc50226673cad494f16a668b515ab24bf709" +"md","checklist","bmm","bmm/workflows/4-implementation/create-story/checklist.md","5154aa874c6a79285eba644493e87411c6021baff72859490db6e693d15e0bb9" "md","checklist","bmm","bmm/workflows/4-implementation/dev-story/checklist.md","630b68c6824a8785003a65553c1f335222b17be93b1bd80524c23b38bde1d8af" "md","checklist","bmm","bmm/workflows/4-implementation/sprint-planning/checklist.md","80b10aedcf88ab1641b8e5f99c9a400c8fd9014f13ca65befc5c83992e367dd7" "md","checklist","bmm","bmm/workflows/document-project/checklist.md","581b0b034c25de17ac3678db2dbafedaeb113de37ddf15a4df6584cf2324a7d7" -"md","checklist","bmm","bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md","f420aaf346833dfda5454ffec9f90a680e903453bcc4d3e277d089e6781fec55" -"md","checklist","bmm","bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md","6357350a6e2237c1b819edd8fc847e376192bf802000cb1a4337c9584fc91a18" -"md","checklist","bmm","bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md","45aaf882b8e9a1042683406ae2cfc0b23d3d39bd1dac3ddb0778d5b7165f7047" -"md","checklist","bmm","bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md","588f9354bf366c173aa261cf5a8b3a87c878ea72fd2c0f8088c4b3289e984641" -"md","checklist","bmm","bmm/workflows/testarch/atdd/checklist.md","d86b1718207a7225e57bc9ac281dc78f22806ac1bfdb9d770ac5dccf7ed8536b" -"md","checklist","bmm","bmm/workflows/testarch/automate/checklist.md","3a8f47b83ad8eff408f7126f7729d4b930738bf7d03b0caea91d1ef49aeb19ee" -"md","checklist","bmm","bmm/workflows/testarch/ci/checklist.md","dfb1ffff2028566d8f0e46a15024d407df5a5e1fad253567f56ee2903618d419" -"md","checklist","bmm","bmm/workflows/testarch/framework/checklist.md","16cc3aee710abb60fb85d2e92f0010b280e66b38fac963c0955fb36e7417103a" -"md","checklist","bmm","bmm/workflows/testarch/nfr-assess/checklist.md","1f070e990c0778b2066f05c31f94c9ddcb97a695e7ae8322b4f487f75fe62d57" -"md","checklist","bmm","bmm/workflows/testarch/test-design/checklist.md","f7ac96d3c61500946c924e1c1924f366c3feae23143c8d130f044926365096e1" -"md","checklist","bmm","bmm/workflows/testarch/test-review/checklist.md","e39f2fb9c2dbfd158e5b5c1602fd15d5dbd3b0f0616d171e0551c356c92416f9" -"md","checklist","bmm","bmm/workflows/testarch/trace/checklist.md","c67b2a1ee863c55b95520db0bc9c1c0a849afee55f96733a08bb2ec55f40ad70" -"md","ci-burn-in","bmm","bmm/testarch/knowledge/ci-burn-in.md","4cdcf7b576dae8b5cb591a6fad69674f65044a0dc72ea57d561623dac93ec475" -"md","component-tdd","bmm","bmm/testarch/knowledge/component-tdd.md","88bd1f9ca1d5bcd1552828845fe80b86ff3acdf071bac574eda744caf7120ef8" -"md","contract-testing","bmm","bmm/testarch/knowledge/contract-testing.md","d8f662c286b2ea4772213541c43aebef006ab6b46e8737ebdc4a414621895599" -"md","data-factories","bmm","bmm/testarch/knowledge/data-factories.md","d7428fe7675da02b6f5c4c03213fc5e542063f61ab033efb47c1c5669b835d88" +"md","checklist","bmm","bmm/workflows/qa/automate/checklist.md","83cd779c6527ff34184dc86f9eebfc0a8a921aee694f063208aee78f80a8fb12" "md","deep-dive-instructions","bmm","bmm/workflows/document-project/workflows/deep-dive-instructions.md","8cb3d32d7685e5deff4731c2003d30b4321ef6c29247b3ddbe672c185e022604" "md","deep-dive-template","bmm","bmm/workflows/document-project/templates/deep-dive-template.md","6198aa731d87d6a318b5b8d180fc29b9aa53ff0966e02391c17333818e94ffe9" -"md","documentation-standards","bmm","bmm/data/documentation-standards.md","fc26d4daff6b5a73eb7964eacba6a4f5cf8f9810a8c41b6949c4023a4176d853" -"md","email-auth","bmm","bmm/testarch/knowledge/email-auth.md","43f4cc3138a905a91f4a69f358be6664a790b192811b4dfc238188e826f6b41b" "md","epics-template","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md","b8ec5562b2a77efd80c40eba0421bbaab931681552e5a0ff01cd93902c447ff7" -"md","error-handling","bmm","bmm/testarch/knowledge/error-handling.md","8a314eafb31e78020e2709d88aaf4445160cbefb3aba788b62d1701557eb81c1" -"md","feature-flags","bmm","bmm/testarch/knowledge/feature-flags.md","f6db7e8de2b63ce40a1ceb120a4055fbc2c29454ad8fca5db4e8c065d98f6f49" -"md","file-utils","bmm","bmm/testarch/knowledge/file-utils.md","e0d4e98ca6ec32035ae07a14880c65ab99298e9240404d27a05788c974659e8b" -"md","fixture-architecture","bmm","bmm/testarch/knowledge/fixture-architecture.md","a3b6c1bcaf5e925068f3806a3d2179ac11dde7149e404bc4bb5602afb7392501" -"md","fixtures-composition","bmm","bmm/testarch/knowledge/fixtures-composition.md","8e57a897663a272fd603026aeec76941543c1e09d129e377846726fd405f3a5a" "md","full-scan-instructions","bmm","bmm/workflows/document-project/workflows/full-scan-instructions.md","6c6e0d77b33f41757eed8ebf436d4def69cd6ce412395b047bf5909f66d876aa" "md","index-template","bmm","bmm/workflows/document-project/templates/index-template.md","42c8a14f53088e4fda82f26a3fe41dc8a89d4bcb7a9659dd696136378b64ee90" -"md","instructions","bmm","bmm/workflows/4-implementation/correct-course/instructions.md","bd56efff69b1c72fbd835cbac68afaac043cf5004d021425f52935441a3c779d" +"md","instructions","bmm","bmm/workflows/4-implementation/correct-course/instructions.md","afdf74701cd2e1200efeb4af24e99a52b013c4c150c1736c56b5d34f003c0a94" "md","instructions","bmm","bmm/workflows/4-implementation/retrospective/instructions.md","c1357ee8149935b391db1fd7cc9869bf3b450132f04d27fbb11906d421923bf8" "md","instructions","bmm","bmm/workflows/4-implementation/sprint-planning/instructions.md","8ac972eb08068305223e37dceac9c3a22127062edae2692f95bc16b8dbafa046" -"md","instructions","bmm","bmm/workflows/4-implementation/sprint-status/instructions.md","8f883c7cf59460012b855465c7cbc896f0820afb11031c2b1b3dd514ed9f4b63" -"md","instructions","bmm","bmm/workflows/document-project/instructions.md","faba39025e187c6729135eccf339ec1e08fbdc34ad181583de8161d3d805aaaf" -"md","instructions","bmm","bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md","e43d05aaf6a1e881ae42e73641826b70e27ea91390834901f18665b524bbff77" -"md","instructions","bmm","bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md","5d41c1e5b28796f6844645f3c1e2e75bb80f2e1576eb2c1f3ba2894cbf4a65e8" -"md","instructions","bmm","bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md","9647360dc08e6e8dcbb634620e8a4247add5b22fad7a3bd13ef79683f31b9d77" -"md","instructions","bmm","bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md","d0ddbb8f4235b28af140cc7b5210c989b4b126f973eb539e216ab10d4bbc2410" -"md","instructions","bmm","bmm/workflows/testarch/atdd/instructions.md","8b22d80ff61fd90b4f8402d5b5ab69d01a2c9f00cc4e1aa23aef49720db9254b" -"md","instructions","bmm","bmm/workflows/testarch/automate/instructions.md","6611e6abc114f68c16f3121dc2c2a2dcfefc355f857099b814b715f6d646a81c" -"md","instructions","bmm","bmm/workflows/testarch/ci/instructions.md","8cc49d93e549eb30952320b1902624036d23e92a6bbaf3f012d2a18dc67a9141" -"md","instructions","bmm","bmm/workflows/testarch/framework/instructions.md","902212128052de150753ce0cabb9be0423da782ba280c3b5c198bc16e8ae7eb3" -"md","instructions","bmm","bmm/workflows/testarch/nfr-assess/instructions.md","6a4ef0830a65e96f41e7f6f34ed5694383e0935a46440c77a4a29cbfbd5f75f9" -"md","instructions","bmm","bmm/workflows/testarch/test-design/instructions.md","b332c20fbc8828b2ebd34aad2f36af88ce1ce1d8a8c7c29412329c9f8884de9a" -"md","instructions","bmm","bmm/workflows/testarch/test-review/instructions.md","f1dfb61f7a7d9e584d398987fdcb8ab27b4835d26b6a001ca4611b8a3da4c32d" -"md","instructions","bmm","bmm/workflows/testarch/trace/instructions.md","233cfb6922fe0f7aaa3512fcda08017b0f89de663f66903474b0abf2e1d01614" -"md","instructions","bmm","bmm/workflows/workflow-status/init/instructions.md","cd7f8e8de5c5b775b1aa1d6ea3b02f1d47b24fa138b3ed73877287a58fcdb9a1" -"md","instructions","bmm","bmm/workflows/workflow-status/instructions.md","ddbb594d72209903bf2bf93c70e7dc961295e7382fb6d4adcf8122f9334bb41f" -"md","intercept-network-call","bmm","bmm/testarch/knowledge/intercept-network-call.md","fb551cb0cefe3c062c28ae255a121aaae098638ec35a16fcdba98f670887ab6a" -"md","log","bmm","bmm/testarch/knowledge/log.md","b6267716ccbe6f9e2cc1b2b184501faeb30277bc8546206a66f31500c52381d0" -"md","network-error-monitor","bmm","bmm/testarch/knowledge/network-error-monitor.md","0380eb6df15af0a136334ad00cf44c92c779f311b07231f5aa6230e198786799" -"md","network-first","bmm","bmm/testarch/knowledge/network-first.md","2920e58e145626f5505bcb75e263dbd0e6ac79a8c4c2ec138f5329e06a6ac014" -"md","network-recorder","bmm","bmm/testarch/knowledge/network-recorder.md","9f120515cc377c4c500ec0b5fff0968666a9a4edee03a328d92514147d50f073" -"md","nfr-criteria","bmm","bmm/testarch/knowledge/nfr-criteria.md","e63cee4a0193e4858c8f70ff33a497a1b97d13a69da66f60ed5c9a9853025aa1" -"md","nfr-report-template","bmm","bmm/workflows/testarch/nfr-assess/nfr-report-template.md","229bdabe07577d24679eb9d42283b353dbde21338157188d8f555fdef200b91c" -"md","overview","bmm","bmm/testarch/knowledge/overview.md","79a12311d706fe55c48f72ef51c662c6f61a54651b3b76a3c7ccc87de6ebbf03" -"md","playwright-config","bmm","bmm/testarch/knowledge/playwright-config.md","42516511104a7131775f4446196cf9e5dd3295ba3272d5a5030660b1dffaa69f" -"md","prd-template","bmm","bmm/workflows/2-plan-workflows/prd/prd-template.md","829135530b0652dfb4a2929864042f515bc372b6cbe66be60103311365679efb" -"md","probability-impact","bmm","bmm/testarch/knowledge/probability-impact.md","446dba0caa1eb162734514f35366f8c38ed3666528b0b5e16c7f03fd3c537d0f" +"md","instructions","bmm","bmm/workflows/4-implementation/sprint-status/instructions.md","0d2a75639c9e402c06bf0dfab51cdacf8f63e4401ae4bc5e7fe9e92e7779bba1" +"md","instructions","bmm","bmm/workflows/document-project/instructions.md","8807cf832c2bce8062280e10ae00928e4e147d148dd326fb6437571531e22723" +"md","instructions","bmm","bmm/workflows/qa/automate/instructions.md","3f3505f847f943b2f4a0699017c16e15fa3782f51090a0332304d7248e020e0c" +"md","prd-purpose","bmm","bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md","49c4641b91504bb14e3887029b70beacaff83a2de200ced4f8cb11c1356ecaee" +"md","prd-template","bmm","bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md","7ccccab9c06a626b7a228783b0b9b6e4172e9ec0b10d47bbfab56958c898f837" "md","product-brief.template","bmm","bmm/workflows/1-analysis/create-product-brief/product-brief.template.md","ae0f58b14455efd75a0d97ba68596a3f0b58f350cd1a0ee5b1af69540f949781" -"md","project-context-template","bmm","bmm/data/project-context-template.md","34421aed3e0ad921dc0c0080297f3a2299735b00a25351de589ada99dae56559" +"md","project-context-template","bmm","bmm/data/project-context-template.md","facd60b71649247146700b1dc7d709fa0ae09487f7cf2b5ff8f5ce1b3a8427e8" "md","project-context-template","bmm","bmm/workflows/generate-project-context/project-context-template.md","54e351394ceceb0ac4b5b8135bb6295cf2c37f739c7fd11bb895ca16d79824a5" "md","project-overview-template","bmm","bmm/workflows/document-project/templates/project-overview-template.md","a7c7325b75a5a678dca391b9b69b1e3409cfbe6da95e70443ed3ace164e287b2" "md","readiness-report-template","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md","0da97ab1e38818e642f36dc0ef24d2dae69fc6e0be59924dc2dbf44329738ff6" -"md","README","bmm","bmm/data/README.md","352c44cff4dd0e5a90cdf6781168ceb57f5a78eaabddcd168433d8784854e4fb" -"md","recurse","bmm","bmm/testarch/knowledge/recurse.md","19056fb5b7e5e626aad81277b3e5eec333f2aed36a17aea6c7d8714a5460c8b2" "md","research.template","bmm","bmm/workflows/1-analysis/research/research.template.md","507bb6729476246b1ca2fca4693986d286a33af5529b6cd5cb1b0bb5ea9926ce" -"md","risk-governance","bmm","bmm/testarch/knowledge/risk-governance.md","2fa2bc3979c4f6d4e1dec09facb2d446f2a4fbc80107b11fc41cbef2b8d65d68" -"md","selective-testing","bmm","bmm/testarch/knowledge/selective-testing.md","c14c8e1bcc309dbb86a60f65bc921abf5a855c18a753e0c0654a108eb3eb1f1c" -"md","selector-resilience","bmm","bmm/testarch/knowledge/selector-resilience.md","a55c25a340f1cd10811802665754a3f4eab0c82868fea61fea9cc61aa47ac179" "md","source-tree-template","bmm","bmm/workflows/document-project/templates/source-tree-template.md","109bc335ebb22f932b37c24cdc777a351264191825444a4d147c9b82a1e2ad7a" "md","step-01-discover","bmm","bmm/workflows/generate-project-context/steps/step-01-discover.md","0f1455c018b2f6df0b896d25e677690e1cf58fa1b276d90f0723187d786d6613" -"md","step-01-document-discovery","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md","bd6114c10845e828098905e52d35f908f1b32dabc67313833adc7e6dd80080b0" -"md","step-01-init","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md","d90d224fbf8893dd0ade3c5b9231428f4f70399a921f7af880b5c664cfd95bef" +"md","step-01-document-discovery","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md","9204972d801c28a76433230942c81bacc171e6b6951d3226cea9e7ca5c9310f1" +"md","step-01-init","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md","256c5f87e9449ab921614e2f23644a6b5a1222178320d863429ee2a284905e32" "md","step-01-init","bmm","bmm/workflows/1-analysis/research/domain-steps/step-01-init.md","efee243f13ef54401ded88f501967b8bc767460cec5561b2107fc03fe7b7eab1" -"md","step-01-init","bmm","bmm/workflows/1-analysis/research/market-steps/step-01-init.md","ee7627e44ba76000569192cbacf2317f8531fd0fedc4801035267dc71d329787" +"md","step-01-init","bmm","bmm/workflows/1-analysis/research/market-steps/step-01-init.md","8dbd4a1520451945e8a5d5bccb489f9186b76f57f5bf3c77dbdf088e26ac7730" "md","step-01-init","bmm","bmm/workflows/1-analysis/research/technical-steps/step-01-init.md","c9a1627ecd26227e944375eb691e7ee6bc9f5db29a428a5d53e5d6aef8bb9697" +"md","step-01-init","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md","6ad502fa5bf5639eaf6a42e8f0bc0f2b811e0a3fd2ae3a24ed3333365f99e23c" "md","step-01-init","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md","7b3467a29126c9498b57b06d688f610bcb7a68a8975208c209dd1103546bc455" -"md","step-01-init","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md","abad19b37040d4b31628b95939d4d8c631401a0bd37e40ad474c180d7cd5e664" "md","step-01-init","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md","c730b1f23f0298853e5bf0b9007c2fc86e835fb3d53455d2068a6965d1192f49" -"md","step-01-mode-detection","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md","e3c252531a413576dfcb2e214ba4f92b4468b8e50c9fbc569674deff26d21175" -"md","step-01-understand","bmm","bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-01-understand.md","e8a43cf798df32dc60acd9a2ef1d4a3c2e97f0cf66dd9df553dc7a1c80d7b0cc" -"md","step-01-validate-prerequisites","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md","88c7bfa5579bfdc38b2d855b3d2c03898bf47b11b9f4fae52fb494e2ce163450" -"md","step-01b-continue","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md","bb32e3636bdd19f51e5145b32f766325f48ad347358f74476f8d6c8b7c96c8ef" +"md","step-01-mode-detection","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md","d3170f565ed21633a1f08b50c90349c93d1ec362fe6ec86c746f507796acd745" +"md","step-01-understand","bmm","bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md","a65eb3b993d83f24c4f14cd0117d1c21ad5013b32fcdcf7276c6e4ba0aed7d61" +"md","step-01-validate-prerequisites","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md","5ba8ba972e8376339ed2c9b75e4f98125521af0270bb5dff6e47ec73137e01de" +"md","step-01b-continue","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md","08bd92dc8486983ac8b5b19efd943d2fd83f2a6f6ba247aad9bb075e12b20860" +"md","step-01b-continue","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md","4e8af43d1847236333566efaa4b0b5e63d706e673872705ee6f215a7ccb9d715" "md","step-01b-continue","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md","fde4bf8fa3a6d3230d20cb23e71cbc8e2db1cd2b30b693e13d0b3184bc6bb9a6" -"md","step-01b-continue","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md","7857264692e4fe515b05d4ddc9ea39d66a61c3e2715035cdd0d584170bf38ffe" "md","step-01b-continue","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md","c6cc389b49682a8835382d477d803a75acbad01b24da1b7074ce140d82b278dc" -"md","step-02-context","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md","e69de083257a5dd84083cadcb55deeefb1cdfdee90f52eb3bfbaadbe6602a627" -"md","step-02-context-gathering","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md","8de307668f74892657c2b09f828a3b626b62a479fb72c0280c68ed0e25803896" +"md","step-02-context","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md","07387b1d8c2f92c646bdbad88ad1401d0295c3adecc1637f07630173d8939088" +"md","step-02-context-gathering","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md","a79d99cc35e43442acda2ce7da80f26f4f50e2be08f38c10e4e5695ce0ff6016" "md","step-02-customer-behavior","bmm","bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md","ca77a54143c2df684cf859e10cea48c6ea1ce8e297068a0f0f26ee63d3170c1e" -"md","step-02-customer-insights","bmm","bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md","de7391755e7c8386096ed2383c24917dd6cab234843b34004e230d6d3d0e3796" -"md","step-02-design-epics","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md","1a1c52515a53c12a274d1d5e02ec67c095ea93453259abeca989b9bfd860805c" -"md","step-02-discovery","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md","021d197dfdf071548adf5cfb80fb3b638b5a5d70889b926de221e1e61cea4137" -"md","step-02-discovery","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md","b89616175bbdce5fa3dd41dcc31b3b50ad465d35836e62a9ead984b6d604d5c2" +"md","step-02-design-epics","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md","2c18d76a9b73eae8b9f552cd4252f8208a0c017624ddbaf6bcbe7b28ddfa217e" +"md","step-02-discovery","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md","d13de9d4a4af17f04ae1af7966b3071af54a6445c0944ee83af129ef078ebe5d" +"md","step-02-discovery","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md","6d340f83d62f873a4c09371a38c77dc9ce9726cd6cd1cf9bf89ddec09f36af4c" "md","step-02-domain-analysis","bmm","bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md","385a288d9bbb0adf050bcce4da4dad198a9151822f9766900404636f2b0c7f9d" "md","step-02-generate","bmm","bmm/workflows/generate-project-context/steps/step-02-generate.md","0fff27dab748b4600d02d2fb083513fa4a4e061ed66828b633f7998fcf8257e1" -"md","step-02-investigate","bmm","bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-02-investigate.md","3a93724c59af5e8e9da88bf66ece6d72e64cd42ebe6897340fdf2e34191de06c" -"md","step-02-prd-analysis","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md","37707ccd23bc4e3ff4a888eb4a04722c052518c91fcb83d3d58045595711fdaf" +"md","step-02-investigate","bmm","bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md","dafa8215d11132018f0ca706d4c1073cc7c97ae006f0f0b7667978e84bfbee3e" +"md","step-02-prd-analysis","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md","f8c4f293c0a040fa9f73829ffeabfa073d0a8ade583adaefb26431ec83a76398" "md","step-02-technical-overview","bmm","bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md","9c7582241038b16280cddce86f2943216541275daf0a935dcab78f362904b305" -"md","step-02-vision","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md","ac3362c75bd8c3fe42ce3ddd433f3ce58b4a1b466bc056298827f87c7ba274f8" +"md","step-02-vision","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md","a6262132ec081165358941df207d02e29e5ab00b4f516adf2772effa46d21dd5" "md","step-03-competitive-landscape","bmm","bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md","f10aa088ba00c59491507f6519fb314139f8be6807958bb5fd1b66bff2267749" "md","step-03-complete","bmm","bmm/workflows/generate-project-context/steps/step-03-complete.md","cf8d1d1904aeddaddb043c3c365d026cd238891cd702c2b78bae032a8e08ae17" -"md","step-03-core-experience","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md","39f0904b2724d51ba880b2f22deefc00631441669a0c9a8ac0565a8ada3464b2" -"md","step-03-create-stories","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md","885dd4bceaed6203f5c00fb9484ab377ee1983b0a487970591472b9ec43a1634" +"md","step-03-core-experience","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md","b23ce8244db8a183761a9420fa54ff285bbf7c54b2d30c62c32d3cf8cb4c2f00" +"md","step-03-create-stories","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md","e6deb22291f05a96e56f5cb3ab88eca3bb6df564208edd8fcc693d4c27139f29" "md","step-03-customer-pain-points","bmm","bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md","ce7394a73a7d3dd627280a8bef0ed04c11e4036275acc4b50c666fd1d84172c4" -"md","step-03-epic-coverage-validation","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md","f58af59ecbcbed1a83eea3984c550cf78484ef803d7eb80bbf7e0980e45cdf44" -"md","step-03-execute","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md","dc340c8c7ac0819ae8442c3838e0ea922656ad7967ea110a8bf0ff80972d570a" -"md","step-03-generate","bmm","bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-03-generate.md","d2f998ae3efd33468d90825dc54766eefbe3b4b38fba9e95166fe42d7002db82" +"md","step-03-epic-coverage-validation","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md","f425bcac163b9ea63a004039ff65fffea3499d9e01a2821bb11e0e17e6b6fc52" +"md","step-03-execute","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md","463a7865ed9efde3cf073e87ecae591bd668f62746b42f4f4c94a1ba4e4b9da0" +"md","step-03-generate","bmm","bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md","c59fe4fe129c2b0461ba0382fdbfcf9160c1997a1a0dca271261bdf006ff2364" "md","step-03-integration-patterns","bmm","bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md","005d517a2f962e2172e26b23d10d5e6684c7736c0d3982e27b2e72d905814ad9" -"md","step-03-starter","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md","7dd61ab909d236da0caf59954dced5468657bcb27f859d1d92265e59b3616c28" -"md","step-03-success","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md","07de6f3650dfda068d6f8155e5c4dc0a18ac40fb19f8c46ba54b39cf3f911067" -"md","step-03-users","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md","e148ee42c8cbb52b11fc9c984cb922c46bd1cb197de02445e02548995d04c390" -"md","step-04-architectural-patterns","bmm","bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md","5ab115b67221be4182f88204b17578697136d8c11b7af21d91012d33ff84aafb" +"md","step-03-starter","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md","535124eb8228ffa628fee5b2e89b9a66d4c2c5d29485c11ccc0d1062b6d674e2" +"md","step-03-success","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md","7b7b339c36ab34953dc542f48a3ed38da420078ee62bbf840a4cb939a3121567" +"md","step-03-users","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md","7d3884a502341bd5912eac8b24af5bb961385f353b4a37cee916f0a2b2226b97" +"md","step-04-architectural-patterns","bmm","bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md","4636f23e9c585a7a0c90437a660609d913f16362c3557fc2e71d408d6b9f46ce" "md","step-04-customer-decisions","bmm","bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md","17dde68d655f7c66b47ed59088c841d28d206ee02137388534b141d9a8465cf9" -"md","step-04-decisions","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md","dc83242891d4f6bd5cba6e87bd749378294afdf88af17851e488273893440a84" -"md","step-04-emotional-response","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md","a2db9d24cdfc88aeb28a92ed236df940657842291a7d70e1616b59fbfd1c4e19" -"md","step-04-final-validation","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md","c56c5289d65f34c1c22c5a9a09084e041ee445b341ebd6380ca9a2885f225344" -"md","step-04-journeys","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md","93fb356f0c9edd02b5d1ad475fb629e6b3b875b6ea276b02059b66ade68c0d30" -"md","step-04-metrics","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md","5c8c689267fd158a8c8e07d76041f56003aa58c19ed2649deef780a8f97722aa" +"md","step-04-decisions","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md","41829279a6ffec9b87870fc0a87e8738b529f07f47ec65dabd983e39d582f8b8" +"md","step-04-emotional-response","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md","45ff4c3e907f32c91d78f101a78b075f5731642628474c36b7e06c13fd9519e6" +"md","step-04-final-validation","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md","c507a3ddf39f657d1c9934c9105d079a7fe78694f19bd519e845a010b3afbda4" +"md","step-04-journeys","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md","ff297509882def062ab58de4ae922472dd05b562338689c8ac25a24bedad7dca" +"md","step-04-metrics","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md","887af175137069fe498f1fd26db2995d1ad00d658cf15598846ae30d03ce0ce5" "md","step-04-regulatory-focus","bmm","bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md","d22035529efe91993e698b4ebf297bf2e7593eb41d185a661c357a8afc08977b" -"md","step-04-review","bmm","bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-04-review.md","7571c5694a9f04ea29fbdb7ad83d6a6c9129c95ace4211e74e67ca4216acc4ff" -"md","step-04-self-check","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md","444c02d8f57cd528729c51d77abf51ca8918ac5c65f3dcf269b21784f5f6920c" -"md","step-04-ux-alignment","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md","e673765ad05f4f2dc70a49c17124d7dd6f92a7a481314a6093f82cda0c61a2b5" -"md","step-05-adversarial-review","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md","38d6f43af07f51d67d6abd5d88de027d5703033ed6b7fe2400069f5fc31d4237" +"md","step-04-review","bmm","bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md","aa246ba5793f3a1c6dd434b388b41ccfb9e675bb55664a900a4eb2486e2a40e3" +"md","step-04-self-check","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md","14e852bf6fa6f19a7457a774f255e1bc6247e6926a9d69d7631b832bf8e7e723" +"md","step-04-ux-alignment","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md","d2e15adf2aecc2c72f9bb9051e94042fc522fd7cfb16376f41bdcdd294319703" +"md","step-05-adversarial-review","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md","310bebff807efed4523acf507cfe98ff9bead3965627f969585ba8c12326d93f" "md","step-05-competitive-analysis","bmm","bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md","ff6f606a80ffaf09aa325e38a4ceb321b97019e6542241b2ed4e8eb38b35efa8" -"md","step-05-domain","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md","a18c274f10f3116e5b3e88e3133760ab4374587e4c9c6167e8eea4b84589298c" -"md","step-05-epic-quality-review","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md","4014a0e0a7b725474f16250a8f19745e188d51c4f4dbef549de0940eb428841d" -"md","step-05-implementation-research","bmm","bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md","55ae5ab81295c6d6e3694c1b89472abcd5cd562cf55a2b5fffdd167e15bee82b" -"md","step-05-inspiration","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md","7f8d6c50c3128d7f4cb5dbf92ed9b0b0aa2ce393649f1506f5996bd51e3a5604" -"md","step-05-patterns","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md","8660291477a35ba5a7aecc73fbb9f5fa85de2a4245ae9dd2644f5e2f64a66d30" -"md","step-05-scope","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md","9e2d58633f621d437fe59a3fd8d10f6c190b85a6dcf1dbe9167d15f45585af51" +"md","step-05-domain","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md","af444794fffb622cd2d18604ed189cd2efe86c34626d16b5ac1c43b6c14ed551" +"md","step-05-epic-quality-review","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md","e7fd60676d6ade485de77ce2dd4229811912594cb924d6c15bae5d9bdf105a7d" +"md","step-05-implementation-research","bmm","bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md","e2b8a2c79bcebadc85f3823145980fa47d7e7be8d1c112f686c6223c8c138608" +"md","step-05-inspiration","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md","74ea94822de791eb24f2e2ca39c3acf01a98b2184f23b1c980e2ada6fd11ae5e" +"md","step-05-patterns","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md","b6bbca68efc7ff66d2f0fc39d8219898c63fd9c0923cb020ad8ac0d469e6fcff" +"md","step-05-scope","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md","bd7f8878dd8058e1932151d8cbc468bfc2c6dadb0258d93ed967189d0629dff4" "md","step-05-technical-trends","bmm","bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md","fd6c577010171679f630805eb76e09daf823c2b9770eb716986d01f351ce1fb4" -"md","step-06-complete","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md","488ea54b7825e5a458a58c0c3104bf5dc56f5e401c805df954a0bfc363194f31" -"md","step-06-design-system","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md","6bb2666aeb114708321e2f730431eb17d2c08c78d57d9cc6b32cb11402aa8472" -"md","step-06-final-assessment","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md","67d68de4bdaaa9e814d15d30c192da7301339e851224ef562077b2fb39c7d869" -"md","step-06-innovation","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md","faa4b7e1b74e843d167ef0ea16dab475ea51e57b654337ec7a1ba90d85e8a44a" +"md","step-06-complete","bmm","bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md","6594a18f37063fcaa0341845df7e59c7bae9543eb4d32d4a3a8e5fdd77402972" +"md","step-06-design-system","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md","6e3ead73073ef51ac952f4cf9491635e5d6825525a4af5d5cbf6e2675db69404" +"md","step-06-final-assessment","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md","813329a73f0e48374f337ec719e6b7715b95fb3ba43645143b882ea41acc4d91" +"md","step-06-innovation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md","efdd55674bd8329a5d963396c841523d73ffebd168add77bc01425e478e22bc4" "md","step-06-research-completion","bmm","bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md","30d5e14f39df193ebce952dfed2bd4009d68fe844e28ad3a29f5667382ebc6d2" "md","step-06-research-synthesis","bmm","bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md","4c7727b8d3c6272c1b2b84ea58a67fc86cafab3472c0caf54e8b8cee3fa411fc" -"md","step-06-research-synthesis","bmm","bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md","5df66bbeecd345e829f06c4eb5bdecd572ca46aec8927bda8b97dbd5f5a34d6c" -"md","step-06-resolve-findings","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md","ad5d90b4f753fec9d2ba6065cbf4e5fa6ef07b013504a573a0edea5dcc16e180" -"md","step-06-structure","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md","8ebb95adc203b83e3329b32bcd19e4d65faa8e68af7255374f40f0cbf4d91f2b" -"md","step-07-defining-experience","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md","10db4f974747602d97a719542c0cd31aa7500b035fba5fddf1777949f76928d6" -"md","step-07-project-type","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md","260d5d3738ddc60952f6a04a1370e59e2bf2c596b926295466244278952becd1" -"md","step-07-validation","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md","0aaa043da24c0c9558c32417c5ba76ad898d4300ca114a8be3f77fabf638c2e2" -"md","step-08-complete","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md","d2bb24dedc8ca431a1dc766033069694b7e1e7bef146d9d1d1d10bf2555a02cd" -"md","step-08-scoping","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md","535949aab670b628807b08b9ab7627b8b62d8fdad7300d616101245e54920f61" -"md","step-08-visual-foundation","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md","114ae7e866eb41ec3ff0c573ba142ee6641e30d91a656e5069930fe3bb9786ae" -"md","step-09-design-directions","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md","73933038a7f1c172716e0688c36275316d1671e4bca39d1050da7b9b475f5211" -"md","step-09-functional","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md","fb3acbc2b82de5c70e8d7e1a4475e3254d1e8bcb242da88d618904b66f57edad" -"md","step-10-nonfunctional","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md","92fde9dc4f198fb551be6389c75b6e09e43c840ce55a635d37202830b4e38718" -"md","step-10-user-journeys","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md","7305843b730128445610cc0ff28fc00b952ec361672690d93987978650e077c3" -"md","step-11-complete","bmm","bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md","b9a9053f1e5de3d583aa729639731fc26b7ce6a43f6a111582faa4caea96593a" -"md","step-11-component-strategy","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md","e4a80fc9d350ce1e84b0d4f0a24abd274f2732095fb127af0dde3bc62f786ad1" -"md","step-12-ux-patterns","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md","4a0b51d278ffbd012d2c9c574adcb081035994be2a055cc0bbf1e348a766cb4a" -"md","step-13-responsive-accessibility","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md","c556f2dc3644142f8136237fb422a6aac699ca97812c9b73a988cc6db7915444" -"md","step-14-complete","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md","8b05a20310b14bcbc743d990570b40a6f48f5ab10cbc03a723aa841337550fbf" -"md","tech-spec-template","bmm","bmm/workflows/bmad-quick-flow/create-tech-spec/tech-spec-template.md","6e0ac4991508fec75d33bbe36197e1576d7b2a1ea7ceba656d616e7d7dadcf03" +"md","step-06-research-synthesis","bmm","bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md","1f12aaeccd2d3225608ba00117c567a2097d22d35a5ba7580b45fb9c0a1d2814" +"md","step-06-resolve-findings","bmm","bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md","e657af6e3687e15852c860f018b73aa263bdcf6b9d544771a8c0c715581a2c99" +"md","step-06-structure","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md","716819821cf7e2a6ce5852785e86e2c77c9f8d1d24e08b86889854365a78e552" +"md","step-07-defining-experience","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md","89964c435273a08b3065732a23bc0c3bc1290ac2ecd9339d9ff2eb6ecb890b06" +"md","step-07-project-type","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md","325e9853015fb844fc80c0b7c00526d0107dcae9a1bfe3b57d956940fc9e29ba" +"md","step-07-validation","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md","1305a67b660fcd61346de2bb8087547c8414f60381ba896762d71f6fa9cebeaf" +"md","step-08-complete","bmm","bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md","b4dc514afd17e836458f6eb786318fdc2ecee1466c673eca4c800955ffae52e4" +"md","step-08-scoping","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md","8e043d237fb7d3af77b5375629dd4e47054832c98279024d66e090d48d766075" +"md","step-08-visual-foundation","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md","8aee1183b3c0e5f379e2c20512665e06ef1189d357ac9a845e3616be35a79c47" +"md","step-09-design-directions","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md","6ab5f1302ec43aed52f45a2842ae49dc4bd98b2d12109d5657c9f04e4b434f89" +"md","step-09-functional","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md","13ced8348b8bb0b7cd88f0400b538fabbcb1fb3c23525bf4fffb7ca9f4c37c8c" +"md","step-10-nonfunctional","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md","e37395a792ac3b81c635993c27748ebd6d781c755ed49e580cd7c78e5486a012" +"md","step-10-user-journeys","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md","30866f55e179d0985efcf57120e63dfbb1fa3ddb6fa9623c4ee0e0b9738f0467" +"md","step-11-component-strategy","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md","ed805fafa72fb703b1e89b3c59c0c2dbe99c3021e009858602a92cfb473727a6" +"md","step-11-polish","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md","935655a256562b6b3420c091a56067c34c35819343a78927ca138c9ea8b92a97" +"md","step-12-complete","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md","5443ef1e08c70fdd15092db6f65cb67fe2cded357ed1b5f4918398e404901bf8" +"md","step-12-ux-patterns","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md","d9bfabc5322aca6e2ba512fa6b39bcdac885b8010dd8c4768c10e33524a04b08" +"md","step-13-responsive-accessibility","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md","f9f2ae70026eb5524a372332632240cea765360ed90a47fea316a65cc3e0e7ce" +"md","step-14-complete","bmm","bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md","73cc7521dad3db2c730b06731a90df40016e67bdfefa6b6537a18d979c0f14df" +"md","step-e-01-discovery","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md","2bc88c9480ac5986c06672533ab2080b1ee01086033c8e441a8c80551c8a99ee" +"md","step-e-01b-legacy-conversion","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md","e6bbe9020e6986a620fc0299a48e6c31c9d1ec14691df11be71baeb79837bc92" +"md","step-e-02-review","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md","b2660d88a445dc3f8f168f96ca92d4a1a36949e3b39fbf6cda5c77129636d9b1" +"md","step-e-03-edit","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md","dfcc3e4f0b1ec050d4985af04dc02b28174a995e95327ca01ae4b8cac10cc1e5" +"md","step-e-04-complete","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md","a1100f8639120311cbaf5a5a880db4e137216bc4bd0110b0926004107a99d3c3" +"md","step-v-01-discovery","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md","287c39e44b32faab52fb155a4a30ab3f31cf6ef5c599b8b15687e5bb3c97a447" +"md","step-v-02-format-detection","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md","251ea5a1cf7779db2dc39d5d8317976a27f84b421359c1974ae96c0943094341" +"md","step-v-02b-parity-check","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md","3481beae212bb0140c105d0ae87bb9714859c93a471048048512fd1278da2fcd" +"md","step-v-03-density-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md","5b95ecd032fb65f86b7eee7ce7c30c997dc2a8b5e4846d88c2853538591a9e40" +"md","step-v-04-brief-coverage-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md","97eb248c7d67e6e5121dd0b020409583998fba433799ea4c5c8cb40c7ff9c7c1" +"md","step-v-05-measurability-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md","2f331ee6d4f174dec0e4b434bf7691bfcf3a13c6ee0c47a65989badaa6b6a28c" +"md","step-v-06-traceability-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md","970ea67486211a611a701e1490ab7e8f2f98060a9f78760b6ebfdb9f37743c74" +"md","step-v-07-implementation-leakage-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md","f75d1d808fdf3d61b15bea55418b82df747f45902b6b22fe541e83b4ea3fa465" +"md","step-v-08-domain-compliance-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md","a1902baaf4eaaf946e5c2c2101a1ac46f8ee4397e599218b8dc030cd00c97512" +"md","step-v-09-project-type-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md","d53e95264625335184284d3f9d0fc6e7674f67bdf97e19362fc33df4bea7f096" +"md","step-v-10-smart-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md","22d48a72bc599f45bbf8c3e81d651d3a1265a6450866c0689bf287f43d7874a4" +"md","step-v-11-holistic-quality-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md","1022a1454aadff28e39fd5fa71dd76d8eefccfe438b9ef517a19b44d935c0f5b" +"md","step-v-12-completeness-validation","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md","c966933a0ca3753db75591325cef4d4bdaf9639a1a63f9438758d32f7e1a1dda" +"md","step-v-13-report-complete","bmm","bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md","9184ef4045829406323c714044ca9c70152ad425e559019633b13829434f6378" +"md","tech-spec-template","bmm","bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md","6e0ac4991508fec75d33bbe36197e1576d7b2a1ea7ceba656d616e7d7dadcf03" "md","template","bmm","bmm/workflows/4-implementation/create-story/template.md","29ba697368d77e88e88d0e7ac78caf7a78785a7dcfc291082aa96a62948afb67" -"md","test-design-template","bmm","bmm/workflows/testarch/test-design/test-design-template.md","be2c766858684f5afce7c140f65d6d6e36395433938a866dea09da252a723822" -"md","test-healing-patterns","bmm","bmm/testarch/knowledge/test-healing-patterns.md","b44f7db1ebb1c20ca4ef02d12cae95f692876aee02689605d4b15fe728d28fdf" -"md","test-levels-framework","bmm","bmm/testarch/knowledge/test-levels-framework.md","80bbac7959a47a2e7e7de82613296f906954d571d2d64ece13381c1a0b480237" -"md","test-priorities-matrix","bmm","bmm/testarch/knowledge/test-priorities-matrix.md","321c3b708cc19892884be0166afa2a7197028e5474acaf7bc65c17ac861964a5" -"md","test-quality","bmm","bmm/testarch/knowledge/test-quality.md","97b6db474df0ec7a98a15fd2ae49671bb8e0ddf22963f3c4c47917bb75c05b90" -"md","test-review-template","bmm","bmm/workflows/testarch/test-review/test-review-template.md","b476bd8ca67b730ffcc9f11aeb63f5a14996e19712af492ffe0d3a3d1a4645d2" -"md","timing-debugging","bmm","bmm/testarch/knowledge/timing-debugging.md","c4c87539bbd3fd961369bb1d7066135d18c6aad7ecd70256ab5ec3b26a8777d9" -"md","trace-template","bmm","bmm/workflows/testarch/trace/trace-template.md","148b715e7b257f86bc9d70b8e51b575e31d193420bdf135b32dd7bd3132762f3" "md","ux-design-template","bmm","bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md","ffa4b89376cd9db6faab682710b7ce755990b1197a8b3e16b17748656d1fca6a" -"md","visual-debugging","bmm","bmm/testarch/knowledge/visual-debugging.md","072a3d30ba6d22d5e628fc26a08f6e03f8b696e49d5a4445f37749ce5cd4a8a9" -"md","workflow","bmm","bmm/workflows/1-analysis/create-product-brief/workflow.md","09f24c579989fe45ad36becafc63b5b68f14fe2f6d8dd186a9ddfb0c1f256b7b" -"md","workflow","bmm","bmm/workflows/1-analysis/research/workflow.md","0c7043392fbe53f1669e73f1f74b851ae78e60fefbe54ed7dfbb12409a22fe10" -"md","workflow","bmm","bmm/workflows/2-plan-workflows/create-ux-design/workflow.md","49381d214c43080b608ff5886ed34fae904f4d4b14bea4f5c2fafab326fac698" -"md","workflow","bmm","bmm/workflows/2-plan-workflows/prd/workflow.md","6f09425df1cebfa69538a8b507ce5957513a9e84a912a10aad9bd834133fa568" -"md","workflow","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md","0167a08dd497a50429d8259eec1ebcd669bebbf4472a3db5c352fb6791a39ce8" -"md","workflow","bmm","bmm/workflows/3-solutioning/create-architecture/workflow.md","c85b3ce51dcadc00c9ef98b0be7cc27b5d38ab2191ef208645b61eb3e7d078ab" -"md","workflow","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md","b62a6f4c85c66059f46ce875da9eb336b4272f189c506c0f77170c7623b5ed55" -"md","workflow","bmm","bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md","740134a67df57a818b8d76cf4c5f27090375d1698ae5be9e68c9ab8672d6b1e0" -"md","workflow","bmm","bmm/workflows/bmad-quick-flow/quick-dev/workflow.md","c6d7306871bb29d1cd0435e2189d7d7d55ec8c4604f688b63c1c77c7d2e6d086" +"md","workflow","bmm","bmm/workflows/1-analysis/create-product-brief/workflow.md","5858d72a2fd8010a40d86d7e7581e44af9eb3432f13a236575035a21807e755a" +"md","workflow","bmm","bmm/workflows/2-plan-workflows/create-ux-design/workflow.md","10ffb0f43a4e204ecd1a67bf5bff52d6929847651ad096bbe833cf1f0eb198c5" +"md","workflow","bmm","bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md","ddfe66e2ced3a092d0be1606d36c5eb9610602e939059c902b22da1aa202e904" +"md","workflow","bmm","bmm/workflows/3-solutioning/create-architecture/workflow.md","ad930c2c9b991fb56f0d04cfdbc69d04bffd5df2c515ca570ad7d388f56a055c" +"md","workflow","bmm","bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md","d40eb6e04de52d4265af460322a9487bb2c241453b0a59940e1bb04836a7ba65" +"md","workflow","bmm","bmm/workflows/bmad-quick-flow/quick-dev/workflow.md","7e13f74e23f9de40ed15140b5cadb28a7462ad019dc345422b3aede59ad8e7f7" +"md","workflow","bmm","bmm/workflows/bmad-quick-flow/quick-spec/workflow.md","e7856a24e0f39108ae494569b8ceb2eb1ca10588ed3869c5feef98832c54db78" "md","workflow","bmm","bmm/workflows/generate-project-context/workflow.md","0da857be1b7fb46fc29afba22b78a8b2150b17db36db68fd254ad925a20666aa" -"xml","instructions","bmm","bmm/workflows/4-implementation/code-review/instructions.xml","80d43803dced84f1e754d8690fb6da79e5b21a68ca8735b9c0ff709c49ac31ff" -"xml","instructions","bmm","bmm/workflows/4-implementation/create-story/instructions.xml","713b38a3ee0def92380ca97196d3457f68b8da60b78d2e10fc366c35811691fb" -"xml","instructions","bmm","bmm/workflows/4-implementation/dev-story/instructions.xml","d01f9b168f5ef2b4aaf7e1c2fad8146dacfa0ea845b101da80db688e1817cefb" -"yaml","config","bmm","bmm/config.yaml","0976b26f46eba27fa28630cdc6a0eef34745cb1ad33e42433d0a5a37de1ef914" +"md","workflow-create-prd","bmm","bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md","2331a3f02fd4bc3628e3bb1684645e8392a77e8b5b9f918e55554616a2bfe06b" +"md","workflow-domain-research","bmm","bmm/workflows/1-analysis/research/workflow-domain-research.md","137509e99ad4b11c391ebe87832d4820c46da75ed8570dd5b5a71f4372b75c73" +"md","workflow-edit-prd","bmm","bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md","e433664058429f54b49237ad7b2eba43fb115b8b9c68c87846f9523405ac73ef" +"md","workflow-market-research","bmm","bmm/workflows/1-analysis/research/workflow-market-research.md","2798d9cbeab426df7f2bcc228771fc5d5e1a58302eef769e2bbd36ce7d7f43e4" +"md","workflow-technical-research","bmm","bmm/workflows/1-analysis/research/workflow-technical-research.md","16974efc305ab195209232eea5e7ab828df2c6244b8c2ba7ca4a517e90b38b64" +"md","workflow-validate-prd","bmm","bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md","5f7d3a188b5c68fb621b31da4ba62b75444615a0f8eadfe8c505c11f4a8e404c" +"xml","instructions","bmm","bmm/workflows/4-implementation/code-review/instructions.xml","1a6f0ae7d69a5c27b09de3efab2b205a007b466976acdeeaebf7f3abec7feb68" +"xml","instructions","bmm","bmm/workflows/4-implementation/create-story/instructions.xml","38eae4b503711a162f55ccd41b770248581a4357cbbfe1cf1bb34520307ccd63" +"xml","instructions","bmm","bmm/workflows/4-implementation/dev-story/instructions.xml","396eba2694f455e9aa8f0e123b4147799e07205cfb666a411e8a5d0d4b6b5daa" +"yaml","config","bmm","bmm/config.yaml","c105f7d0d1dbb0c8ce057cbc386fd96719832be3498367ac8eafc2a20cd5112d" "yaml","deep-dive","bmm","bmm/workflows/document-project/workflows/deep-dive.yaml","a16b5d121604ca00fffdcb04416daf518ec2671a3251b7876c4b590d25d96945" -"yaml","enterprise-brownfield","bmm","bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml","40b7fb4d855fdd275416e225d685b4772fb0115554e160a0670b07f6fcbc62e5" -"yaml","enterprise-greenfield","bmm","bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml","61329f48d5d446376bcf81905485c72ba53874f3a3918d5614eb0997b93295c6" -"yaml","excalidraw-templates","bmm","bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml","ca6e4ae85b5ab16df184ce1ddfdf83b20f9540db112ebf195cb793017f014a70" "yaml","full-scan","bmm","bmm/workflows/document-project/workflows/full-scan.yaml","8ba79b190733006499515d9d805f4eacd90a420ffc454e04976948c114806c25" -"yaml","github-actions-template","bmm","bmm/workflows/testarch/ci/github-actions-template.yaml","cf7d1f0a1f2853b07df1b82b00ebe79f800f8f16817500747b7c4c9c7143aba7" -"yaml","gitlab-ci-template","bmm","bmm/workflows/testarch/ci/gitlab-ci-template.yaml","986f29817e04996ab9f80bf2de0d25d8ed2365d955cc36d5801afaa93e99e80b" -"yaml","method-brownfield","bmm","bmm/workflows/workflow-status/paths/method-brownfield.yaml","6417f79e274b6aaf07c9b5d8c82f6ee16a8713442c2e38b4bab932831bf3e6c6" -"yaml","method-greenfield","bmm","bmm/workflows/workflow-status/paths/method-greenfield.yaml","11693c1b4e87d7d7afed204545a9529c27e0566d6ae7a480fdfa4677341f5880" -"yaml","project-levels","bmm","bmm/workflows/workflow-status/project-levels.yaml","ffa9fb3b32d81617bb8718689a5ff5774d2dff6c669373d979cc38b1dc306966" -"yaml","sprint-status-template","bmm","bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml","de75fe50bd5e3f4410ccc99fcd3f5dc958733b3829af1b13b4d7b0559bbca22b" +"yaml","sprint-status-template","bmm","bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml","0d7fe922f21d4f00e538c265ff90e470c3e2eca761e663d84b7a1320b2f25980" "yaml","team-fullstack","bmm","bmm/teams/team-fullstack.yaml","da8346b10dfad8e1164a11abeb3b0a84a1d8b5f04e01e8490a44ffca477a1b96" -"yaml","workflow","bmm","bmm/workflows/4-implementation/code-review/workflow.yaml","8879bd2ea2da2c444eac9f4f8bf4f2d58588cdbc92aee189c04d4d926ea7b43d" -"yaml","workflow","bmm","bmm/workflows/4-implementation/correct-course/workflow.yaml","fd61662b22f5ff1d378633b47837eb9542e433d613fbada176a9d61de15c2961" -"yaml","workflow","bmm","bmm/workflows/4-implementation/create-story/workflow.yaml","469cdb56604b1582ac8b271f9326947c57b54af312099dfa0387d998acea2cac" -"yaml","workflow","bmm","bmm/workflows/4-implementation/dev-story/workflow.yaml","270cb47b01e5a49d497c67f2c2605b808a943daf2b34ee60bc726ff78ac217b3" -"yaml","workflow","bmm","bmm/workflows/4-implementation/retrospective/workflow.yaml","03433aa3f0d5b4b388d31b9bee1ac5cb5ca78e15bb4d44746766784a3ba863d2" -"yaml","workflow","bmm","bmm/workflows/4-implementation/sprint-planning/workflow.yaml","3038e7488b67303814d95ebbb0f28a225876ec2e3224fdaa914485f5369a44bf" -"yaml","workflow","bmm","bmm/workflows/4-implementation/sprint-status/workflow.yaml","92c50c478b87cd5c339cdb38399415977f58785b4ae82f7948ba16404fa460cf" -"yaml","workflow","bmm","bmm/workflows/document-project/workflow.yaml","82e731ea08217480958a75304558e767654d8a8262c0ec1ed91e81afd3135ed5" -"yaml","workflow","bmm","bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml","a845be912077a9c80fb3f3e2950c33b99139a2ae22db9c006499008ec2fa3851" -"yaml","workflow","bmm","bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml","bac0e13f796b4a4bb2a3909ddef230f0cd1712a0163b6fe72a2966eed8fc87a9" -"yaml","workflow","bmm","bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml","a8f6e3680d2ec51c131e5cd57c9705e5572fe3e08c536174da7175e07cce0c5d" -"yaml","workflow","bmm","bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml","88ce19aff63a411583756cd0254af2000b6aac13071204dc9aef61aa137a51ef" -"yaml","workflow","bmm","bmm/workflows/testarch/atdd/workflow.yaml","671d3319e80fffb3dedf50ccda0f3aea87ed4de58e6af679678995ca9f5262b0" -"yaml","workflow","bmm","bmm/workflows/testarch/automate/workflow.yaml","3d49eaca0024652b49f00f26f1f1402c73874eb250431cb5c1ce1d2eddc6520b" -"yaml","workflow","bmm","bmm/workflows/testarch/ci/workflow.yaml","e42067278023d4489a159fdbf7a863c69345e3d3d91bf9af8dcff49fd14f0e6d" -"yaml","workflow","bmm","bmm/workflows/testarch/framework/workflow.yaml","857b92ccfa185c373ebecd76f3f57ca84a4d94c8c2290679d33010f58e1ed9e1" -"yaml","workflow","bmm","bmm/workflows/testarch/nfr-assess/workflow.yaml","24a0e0e6124c3206775e43bd7ed4e1bfba752e7d7a0590bbdd73c2e9ce5a06ec" -"yaml","workflow","bmm","bmm/workflows/testarch/test-design/workflow.yaml","30a9371f2ea930e7e68b987570be524b2e9d104c40c28e818a89e12985ba767a" -"yaml","workflow","bmm","bmm/workflows/testarch/test-review/workflow.yaml","d64517e211eceb8e5523da19473387e642c5178d5850f92b1aa5dc3fea6a6685" -"yaml","workflow","bmm","bmm/workflows/testarch/trace/workflow.yaml","0ba5d014b6209cc949391de9f495465b7d64d3496e1972be48b2961c8490e6f5" -"yaml","workflow","bmm","bmm/workflows/workflow-status/init/workflow.yaml","f29cb2797a3b1d3d9408fd78f9e8e232719a519b316444ba31d9fe5db9ca1d6a" -"yaml","workflow","bmm","bmm/workflows/workflow-status/workflow.yaml","390e733bee776aaf0312c5990cdfdb2d65c4f7f56001f428b8baddeb3fe8f0fe" -"yaml","workflow-status-template","bmm","bmm/workflows/workflow-status/workflow-status-template.yaml","0ec9c95f1690b7b7786ffb4ab10663c93b775647ad58e283805092e1e830a0d9" -"csv","default-party","cis","cis/teams/default-party.csv","464310e738ec38cf8114552e8274f6c517a17db0e0b176d494ab50154ba982d5" -"csv","design-methods","cis","cis/workflows/design-thinking/design-methods.csv","6735e9777620398e35b7b8ccb21e9263d9164241c3b9973eb76f5112fb3a8fc9" -"csv","innovation-frameworks","cis","cis/workflows/innovation-strategy/innovation-frameworks.csv","9a14473b1d667467172d8d161e91829c174e476a030a983f12ec6af249c4e42f" -"csv","solving-methods","cis","cis/workflows/problem-solving/solving-methods.csv","aa15c3a862523f20c199600d8d4d0a23fce1001010d7efc29a71abe537d42995" -"csv","story-types","cis","cis/workflows/storytelling/story-types.csv","ec5a3c713617bf7e2cf7db439303dd8f3363daa2f6db20a350c82260ade88bdb" -"md","instructions","cis","cis/workflows/design-thinking/instructions.md","d0c9a9dfce2dedb3fa2f02aeccca3060c1e21fc8126c0c596a10dbd8afb24211" -"md","instructions","cis","cis/workflows/innovation-strategy/instructions.md","12f38ae01f5e3eb6dec72671cd1549c4581fd2aafd7e330e276493f8e01e18bd" -"md","instructions","cis","cis/workflows/problem-solving/instructions.md","7170e0fc8cbab360b022ed8808a8a26198ab1b61f219344032536eff1ddfe2d6" -"md","instructions","cis","cis/workflows/storytelling/instructions.md","717f4a684e1003551832d93e246cfdd7f8e64edf39e0c3a8a72ad3d54a08f3fe" -"md","README","cis","cis/workflows/design-thinking/README.md","0a38f88352dc4674f6e1f55a67ffebf403bf329c874a21a49ce7834c08f91f62" -"md","README","cis","cis/workflows/innovation-strategy/README.md","820a9e734fadf2cfac94d499cec2e4b41a54d054c0d2f6b9819da319beee4fb9" -"md","README","cis","cis/workflows/problem-solving/README.md","a5e75b9899751d7aabffcf65785f10d4d2e0455f8c7c541e8a143e3babceca8b" -"md","README","cis","cis/workflows/README.md","1f6a9ebc342e6f48a74db106d7fdc903fe48720a2cb2160902b1b563c78b2d1d" -"md","README","cis","cis/workflows/storytelling/README.md","1bad4223dce51cb5a7ab8c116467f78037a4583d3a840210ee2f160ad15b71ee" -"md","template","cis","cis/workflows/design-thinking/template.md","7834c387ac0412c841b49a9fcdd8043f5ce053e5cb26993548cf4d31b561f6f0" -"md","template","cis","cis/workflows/innovation-strategy/template.md","e59bd789df87130bde034586d3e68bf1847c074f63d839945e0c29b1d0c85c82" -"md","template","cis","cis/workflows/problem-solving/template.md","6c9efd7ac7b10010bd9911db16c2fbdca01fb0c306d871fa6381eef700b45608" -"md","template","cis","cis/workflows/storytelling/template.md","461981aa772ef2df238070cbec90fc40995df2a71a8c22225b90c91afed57452" -"yaml","config","cis","cis/config.yaml","098503f457cd4de45fab6b1f187ac8633cea839546818d0051eeee85920ea754" -"yaml","creative-squad","cis","cis/teams/creative-squad.yaml","25407cf0ebdf5b10884cd03c86068e04715ef270ada93a3b64cb9907b62c71cf" -"yaml","workflow","cis","cis/workflows/design-thinking/workflow.yaml","1feb8900e6716125af1ef533bcc54659670de0a3e44ff66348518423c5e7a7fb" -"yaml","workflow","cis","cis/workflows/innovation-strategy/workflow.yaml","37b5e7f7d89999c85591bd5d95bfe2617f7690cfb8f0e1064803ec307a56eaaa" -"yaml","workflow","cis","cis/workflows/problem-solving/workflow.yaml","481e5e24f9661df5111404f494739557795d7379456b20c4f5a925b6a0b97fae" -"yaml","workflow","cis","cis/workflows/storytelling/workflow.yaml","3c8ad0a45f4f3c55896629b4cc11c165ff82febbb25c13214ca28aa3ef0f31cd" +"yaml","workflow","bmm","bmm/workflows/4-implementation/code-review/workflow.yaml","4ddef804c51bd83ad51f39e752333383ab559c0986efb8404b659e4728c81ad8" +"yaml","workflow","bmm","bmm/workflows/4-implementation/correct-course/workflow.yaml","0d9c4502fc2f9524644918e33271d648bf7929e91eba8645e39d7d7c7e67eac7" +"yaml","workflow","bmm","bmm/workflows/4-implementation/create-story/workflow.yaml","7989989306494ad06bd5a08f9be73b50d791389226c3b2c8c281ffb8d078d70a" +"yaml","workflow","bmm","bmm/workflows/4-implementation/dev-story/workflow.yaml","36d144a797706f438f973d4fe0679b98096eb1b911f8b7df3f9a8db4fab5e9d2" +"yaml","workflow","bmm","bmm/workflows/4-implementation/retrospective/workflow.yaml","7eac3fda56bb7106a160b446121de55b25d20d60eadcf2caf1ca3245ad84208f" +"yaml","workflow","bmm","bmm/workflows/4-implementation/sprint-planning/workflow.yaml","3f31e4b0973525228549cef18123816d82dc45741dab1f48720eefb191876f81" +"yaml","workflow","bmm","bmm/workflows/4-implementation/sprint-status/workflow.yaml","f03d2804afca3ee29a612117f6bf090b455354a3557c2198ec9b8eb5c5900cef" +"yaml","workflow","bmm","bmm/workflows/document-project/workflow.yaml","9e2886d022d4054c0e6ca6580673f775415add7924961d6723ed13156200a819" +"yaml","workflow","bmm","bmm/workflows/qa/automate/workflow.yaml","670d28da3e20a445ae08ab3e907eaf3eaf13d9a08c4b26244344a0fd8f54a399" +"csv","default-party","cis","cis/teams/default-party.csv","e27e5a0480f41760da2fde5aeeccd425dae9c4a654105aab329ee1562cc83392" +"csv","design-methods","cis","cis/workflows/design-thinking/design-methods.csv","97a1fa87aaa355ce855c2c4e3bbfde59cb4ed2166cf9896496af786f10c13459" +"csv","innovation-frameworks","cis","cis/workflows/innovation-strategy/innovation-frameworks.csv","bd1d191062302353d2562a54751f8f263ce47e143202e2c0fe41315c2be9eb95" +"csv","module-help","cis","cis/module-help.csv","b55259cda5cc5d3facb33d673c783bd188500410ed1042bd792951760998cc63" +"csv","solving-methods","cis","cis/workflows/problem-solving/solving-methods.csv","f3a380b12b21ec2410d1ac44bc8ca1970b0a04a21bfe3dd0370ac7ed1ec0d2c0" +"csv","story-types","cis","cis/workflows/storytelling/story-types.csv","8cf3d49d3ce771f30b6d9c0c936d35f92b8af23e0962c876df832c02d605f1ce" +"md","instructions","cis","cis/workflows/design-thinking/instructions.md","b0a3e02f516bebe0144584ca78bb265cadc1bf2d693da945056117aaf58db5d2" +"md","instructions","cis","cis/workflows/innovation-strategy/instructions.md","bbcf33febc8d0c955a0e6b33ae36dbcbb20f98133183f870c7aae44678248859" +"md","instructions","cis","cis/workflows/problem-solving/instructions.md","5c215099daea5a941aacc32bb5e554f03ce6a08ca5d6ad134ad1de82cb9df59e" +"md","instructions","cis","cis/workflows/storytelling/instructions.md","1856d7f9ea7ec859c188630a6fafbccaaa05e9c8ea5463668842cc74a00d5c7e" +"md","README","cis","cis/workflows/design-thinking/README.md","c6eab6e3fe96a97731cc2b7d8d6ea20f5a9664d19f03fc5b2b34e1ac8952142e" +"md","README","cis","cis/workflows/innovation-strategy/README.md","88ab818502bf35c3e99eb8e277aa10244834b013913ecebd1de1449e54944650" +"md","README","cis","cis/workflows/problem-solving/README.md","1eb1bb254b197817249d53af6241cc8af5d9b324e6420eecb53c646ac1ffff8f" +"md","README","cis","cis/workflows/README.md","0488dc66b7b67b400289634b1a2f6acd10f87614fa3473b417ecb9f4c7e152a7" +"md","README","cis","cis/workflows/storytelling/README.md","c82b12133c5057c546c96432d574aa035ab1446178f9c64d247cdda9e1e2bfe4" +"md","template","cis","cis/workflows/design-thinking/template.md","7bcf6d0cd09de3c0d91f3f49ee280177365dabb64ed814b97e83e73082643c37" +"md","template","cis","cis/workflows/innovation-strategy/template.md","ab574d69fa13e21c806101a9089563b541013f6df44255d800ea24d4cb6d7136" +"md","template","cis","cis/workflows/problem-solving/template.md","c46fbdf42a1d9ad732f562e4add05020198ffc7ba18d134718e1cd960752c390" +"md","template","cis","cis/workflows/storytelling/template.md","290615dbd530dc13843a87ebedd107b390bcfd57cf68df67cd250dea8f49b2dd" +"yaml","config","cis","cis/config.yaml","edf49a94c97cd8e82c813831df3da061feeb0003bd920408bdaf60ff558ae0be" +"yaml","creative-squad","cis","cis/teams/creative-squad.yaml","5e1033c95a9679e2f8688be4409104aa0b98c6503abb0512447b6d7541dd4f61" +"yaml","workflow","cis","cis/workflows/design-thinking/workflow.yaml","10d06df36d9c210430d6415c758c3b125288da0604d05e9b907ada2cf1170233" +"yaml","workflow","cis","cis/workflows/innovation-strategy/workflow.yaml","79ff4aa210bc706974b78f037d22e9743c2cbe1a9a4d0837e9e6bcab6fc94563" +"yaml","workflow","cis","cis/workflows/problem-solving/workflow.yaml","6dc8ad738218c9f4e4490ab8e57017d1618ab0a2140a3f246f04fe22b31755a4" +"yaml","workflow","cis","cis/workflows/storytelling/workflow.yaml","d78ef4eecb82a24142eb8ebef031830c1029b1e646f09eb7a414c70f2e267fea" "csv","brain-methods","core","core/workflows/brainstorming/brain-methods.csv","0ab5878b1dbc9e3fa98cb72abfc3920a586b9e2b42609211bb0516eefd542039" "csv","methods","core","core/workflows/advanced-elicitation/methods.csv","e08b2e22fec700274982e37be608d6c3d1d4d0c04fa0bae05aa9dba2454e6141" -"md","excalidraw-helpers","core","core/resources/excalidraw/excalidraw-helpers.md","37f18fa0bd15f85a33e7526a2cbfe1d5a9404f8bcb8febc79b782361ef790de4" -"md","library-loader","core","core/resources/excalidraw/library-loader.md","7837112bd0acb5906870dff423a21564879d49c5322b004465666a42c52477ab" -"md","README","core","core/resources/excalidraw/README.md","72de8325d7289128f1c8afb3b0eea867ba90f4c029ca42e66a133cd9f92c285d" -"md","step-01-agent-loading","core","core/workflows/party-mode/steps/step-01-agent-loading.md","cd2ca8ec03576fd495cbaec749b3f840c82f7f0d485c8a884894a72d047db013" -"md","step-01-session-setup","core","core/workflows/brainstorming/steps/step-01-session-setup.md","0437c1263788b93f14b7d361af9059ddbc2cbb576974cbd469a58ea757ceba19" -"md","step-01b-continue","core","core/workflows/brainstorming/steps/step-01b-continue.md","a92fd1825a066f21922c5ac8d0744f0553ff4a6d5fc3fa998d12aea05ea2819c" -"md","step-02-discussion-orchestration","core","core/workflows/party-mode/steps/step-02-discussion-orchestration.md","a9afe48b2c43f191541f53abb3c15ef608f9970fa066dcb501e2c1071e5e7d02" +"csv","module-help","core","core/module-help.csv","4227d475748e8067aeae3e1a67d7b6235c109da13b2ef9131db930083dcb348d" +"md","help","core","core/tasks/help.md","950439aaff47aa25f94ede360ce8f8a47bf29c52b7f19c76a45960e8687fe726" +"md","step-01-agent-loading","core","core/workflows/party-mode/steps/step-01-agent-loading.md","04ab6b6247564f7edcd5c503f5ca7d27ae688b09bbe2e24345550963a016e9f9" +"md","step-01-session-setup","core","core/workflows/brainstorming/steps/step-01-session-setup.md","bc09cc22a0465b316ff3c13903b753768fa31d83abd3f9fc328631db63dc0cf8" +"md","step-01b-continue","core","core/workflows/brainstorming/steps/step-01b-continue.md","d76a406e0ff0a0e58006ec671b56f19a059e98cfebba4c0724ae6ccdd9303e7f" +"md","step-02-discussion-orchestration","core","core/workflows/party-mode/steps/step-02-discussion-orchestration.md","a8a79890bd03237e20f1293045ecf06f9a62bc590f5c2d4f88e250cee40abb0b" "md","step-02a-user-selected","core","core/workflows/brainstorming/steps/step-02a-user-selected.md","558b162466745b92687a5d6e218f243a98436dd177b2d5544846c5ff4497cc94" "md","step-02b-ai-recommended","core","core/workflows/brainstorming/steps/step-02b-ai-recommended.md","99aa935279889f278dcb2a61ba191600a18e9db356dd8ce62f0048d3c37c9531" "md","step-02c-random-selection","core","core/workflows/brainstorming/steps/step-02c-random-selection.md","f188c260c321c7f026051fefcd267a26ee18ce2a07f64bab7f453c0c3e483316" "md","step-02d-progressive-flow","core","core/workflows/brainstorming/steps/step-02d-progressive-flow.md","a28c7a3edf34ceb0eea203bf7dc80f39ca04974f6d1ec243f0a088281b2e55de" -"md","step-03-graceful-exit","core","core/workflows/party-mode/steps/step-03-graceful-exit.md","f3299f538d651b55efb6e51ddc3536a228df63f16b1e0129a830cceb8e21303f" -"md","step-03-technique-execution","core","core/workflows/brainstorming/steps/step-03-technique-execution.md","9dbcf441402a4601721a9564ab58ca2fe77dafefee090f7d023754d2204b1d7e" -"md","step-04-idea-organization","core","core/workflows/brainstorming/steps/step-04-idea-organization.md","a1b7a17b95bb1c06fa678f65a56a9ac2fd9655871e99b9378c6b4afa5d574050" +"md","step-03-graceful-exit","core","core/workflows/party-mode/steps/step-03-graceful-exit.md","bdecc33004d73238ca05d8fc9d6b86cba89833630956f53ecd82ec3715c5f0da" +"md","step-03-technique-execution","core","core/workflows/brainstorming/steps/step-03-technique-execution.md","9e6abceec5f774c57cd5205e30a1f24a95441131dbffcae9c3dce72111f95ceb" +"md","step-04-idea-organization","core","core/workflows/brainstorming/steps/step-04-idea-organization.md","5224490c33bf4b23b2897f3bcf12abe0b1ced306541dd60c21df0ce9fc65d1ac" "md","template","core","core/workflows/brainstorming/template.md","5c99d76963eb5fc21db96c5a68f39711dca7c6ed30e4f7d22aedee9e8bb964f9" -"md","validate-json-instructions","core","core/resources/excalidraw/validate-json-instructions.md","0970bac93d52b4ee591a11998a02d5682e914649a40725d623489c77f7a1e449" -"md","workflow","core","core/workflows/brainstorming/workflow.md","f6f2a280880b1cc82bb9bb320229a71df788bb0412590beb59a384e26f493c83" -"md","workflow","core","core/workflows/party-mode/workflow.md","851cbc7f57b856390be18464d38512337b52508cc634f327e4522e379c778573" -"xml","index-docs","core","core/tasks/index-docs.xml","13ffd40ccaed0f05b35e4f22255f023e77a6926e8a2f01d071b0b91a4c942812" -"xml","review-adversarial-general","core","core/tasks/review-adversarial-general.xml","05466fd1a0b207dd9987ba1e8674b40060025b105ba51f5b49fe852c44e51f12" -"xml","shard-doc","core","core/tasks/shard-doc.xml","f71987855cabb46bd58a63a4fd356efb0739a272ab040dd3c8156d7f538d7caf" -"xml","validate-workflow","core","core/tasks/validate-workflow.xml","539e6f1255efbb62538598493e4083496dc0081d3c8989c89b47d06427d98f28" -"xml","workflow","core","core/tasks/workflow.xml","8f7ad9ff1d80251fa5df344ad70701605a74dcfc030c04708650f23b2606851a" -"xml","workflow","core","core/workflows/advanced-elicitation/workflow.xml","063e6aab417f9cc67ae391b1d89ba972fc890c123f8101b7180496d413a63d81" -"yaml","config","core","core/config.yaml","6daebb6cb2cad5b374cf555de51f6aec0abf15f5a3bac908d52ec52c79173790" +"md","workflow","core","core/workflows/brainstorming/workflow.md","7d7f957ccd176faed2551e3089abfa49032963e980b5643d9384690af3d61203" +"md","workflow","core","core/workflows/party-mode/workflow.md","f8537e152df8db331d86e2a37e5ced55bccff3a71e290f82eb754d28c0c9ec08" +"xml","editorial-review-prose","core","core/tasks/editorial-review-prose.xml","49f462ddc5f20a6e2abf14e4b8f3a25c70885c6a6d776ef4674739dd7880988a" +"xml","editorial-review-structure","core","core/tasks/editorial-review-structure.xml","307edce94877dacdaafb10f7ea39115944c7d19e57228a7859abf2fee8b1a177" +"xml","index-docs","core","core/tasks/index-docs.xml","90076db678b1d65b4dd8b166731584fafc68e660e5015f309a1c78aae6e25a28" +"xml","review-adversarial-general","core","core/tasks/review-adversarial-general.xml","347436fde09411caaab10ff97e4cbd2bfef31dbe9f8db9e0eb49c3ed361ede7b" +"xml","shard-doc","core","core/tasks/shard-doc.xml","947f2c7d4f6bb269ad0bcc1a03227d0d6da642d9df47894b8ba215c5149aed3d" +"xml","workflow","core","core/tasks/workflow.xml","17bca7fa63bae20aaac4768d81463a7a2de7f80b60d4d9a8f36b70821ba86cfd" +"xml","workflow","core","core/workflows/advanced-elicitation/workflow.xml","ead4dc1e50c95d8966b3676842a57fca97c70d83f1f3b9e9c2d746821e6868b4" +"yaml","config","core","core/config.yaml","74db4d17c6475b83a0c5e1ce8c1bc128914b9e2b75ba40d92ad1fc22b579e54f" diff --git a/_bmad/_config/ides/antigravity.yaml b/_bmad/_config/ides/antigravity.yaml new file mode 100644 index 0000000..2386598 --- /dev/null +++ b/_bmad/_config/ides/antigravity.yaml @@ -0,0 +1,5 @@ +ide: antigravity +configured_date: 2026-02-13T07:24:22.081Z +last_updated: 2026-02-13T07:24:22.081Z +configuration: + _noConfigNeeded: true diff --git a/_bmad/_config/manifest.yaml b/_bmad/_config/manifest.yaml index 8b08ba5..9601157 100644 --- a/_bmad/_config/manifest.yaml +++ b/_bmad/_config/manifest.yaml @@ -1,12 +1,35 @@ installation: - version: 6.0.0-alpha.22 - installDate: 2026-01-07T12:48:59.942Z - lastUpdated: 2026-01-07T12:48:59.942Z + version: 6.0.0-Beta.8 + installDate: 2026-02-13T07:24:21.956Z + lastUpdated: 2026-02-13T07:24:21.956Z modules: - - core - - bmb - - bmgd - - bmm - - cis + - name: core + version: 6.0.0-Beta.8 + installDate: 2026-02-13T07:24:21.091Z + lastUpdated: 2026-02-13T07:24:21.091Z + source: built-in + npmPackage: null + repoUrl: null + - name: bmm + version: 6.0.0-Beta.8 + installDate: 2026-02-13T07:24:16.225Z + lastUpdated: 2026-02-13T07:24:21.091Z + source: built-in + npmPackage: null + repoUrl: null + - name: bmb + version: 0.1.6 + installDate: 2026-02-13T07:24:18.537Z + lastUpdated: 2026-02-13T07:24:21.521Z + source: external + npmPackage: bmad-builder + repoUrl: https://github.com/bmad-code-org/bmad-builder + - name: cis + version: 0.1.6 + installDate: 2026-02-13T07:24:21.057Z + lastUpdated: 2026-02-13T07:24:21.956Z + source: external + npmPackage: bmad-creative-intelligence-suite + repoUrl: https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite ides: - antigravity diff --git a/_bmad/_config/task-manifest.csv b/_bmad/_config/task-manifest.csv index d6b8d4e..dc8dc24 100644 --- a/_bmad/_config/task-manifest.csv +++ b/_bmad/_config/task-manifest.csv @@ -1,6 +1,7 @@ name,displayName,description,module,path,standalone +"editorial-review-prose","Editorial Review - Prose","Clinical copy-editor that reviews text for communication issues","core","_bmad/core/tasks/editorial-review-prose.xml","true" +"editorial-review-structure","Editorial Review - Structure","Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension","core","_bmad/core/tasks/editorial-review-structure.xml","true" +"help","help","Get unstuck by showing what workflow steps come next or answering questions about what to do","core","_bmad/core/tasks/help.md","true" "index-docs","Index Docs","Generates or updates an index.md of all documents in the specified directory","core","_bmad/core/tasks/index-docs.xml","true" -"review-adversarial-general","Adversarial Review (General)","Cynically review content and produce findings","core","_bmad/core/tasks/review-adversarial-general.xml","false" -"shard-doc","Shard Document","Splits large markdown documents into smaller, organized files based on level 2 (default) sections","core","_bmad/core/tasks/shard-doc.xml","false" -"validate-workflow","Validate Workflow Output","Run a checklist against a document with thorough analysis and produce a validation report","core","_bmad/core/tasks/validate-workflow.xml","false" -"workflow","Execute Workflow","Execute given workflow by loading its configuration, following instructions, and producing output","core","_bmad/core/tasks/workflow.xml","false" +"review-adversarial-general","Adversarial Review (General)","Cynically review content and produce findings","core","_bmad/core/tasks/review-adversarial-general.xml","true" +"shard-doc","Shard Document","Splits large markdown documents into smaller, organized files based on level 2 (default) sections","core","_bmad/core/tasks/shard-doc.xml","true" diff --git a/_bmad/_config/workflow-manifest.csv b/_bmad/_config/workflow-manifest.csv index 87220b7..caddbc0 100644 --- a/_bmad/_config/workflow-manifest.csv +++ b/_bmad/_config/workflow-manifest.csv @@ -1,42 +1,14 @@ name,description,module,path "brainstorming","Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods","core","_bmad/core/workflows/brainstorming/workflow.md" "party-mode","Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations","core","_bmad/core/workflows/party-mode/workflow.md" -"agent","Tri-modal workflow for creating, editing, and validating BMAD Core compliant agents","bmb","_bmad/bmb/workflows/agent/workflow.md" -"create-module","Interactive workflow to build complete BMAD modules with agents, workflows, and installation infrastructure","bmb","_bmad/bmb/workflows/create-module/workflow.md" -"Meal Prep & Nutrition Plan","Creates personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits.","bmb","_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md" -"create-workflow","Create structured standalone workflows using markdown-based step architecture","bmb","_bmad/bmb/workflows/create-workflow/workflow.md" -"edit-workflow","Intelligent workflow editor that helps modify existing workflows while following best practices","bmb","_bmad/bmb/workflows/edit-workflow/workflow.md" -"workflow-compliance-check","Systematic validation of workflows against BMAD standards with adversarial analysis and detailed reporting","bmb","_bmad/bmb/workflows/workflow-compliance-check/workflow.md" -"brainstorm-game","Facilitate game brainstorming sessions with game-specific context, guidance, and game design techniques.","bmgd","_bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml" -"create-game-brief","Creates a comprehensive Game Brief through collaborative step-by-step discovery to capture game vision before detailed design.","bmgd","_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md" -"game-brief","Interactive game brief creation workflow that guides users through defining their game vision with multiple input sources and conversational collaboration","bmgd","_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.yaml" -"create-gdd","Creates a comprehensive Game Design Document through collaborative step-by-step discovery between game designer and user.","bmgd","_bmad/bmgd/workflows/2-design/gdd/workflow.md" -"gdd","Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance.","bmgd","_bmad/bmgd/workflows/2-design/gdd/workflow.yaml" -"narrative","Narrative design workflow for story-driven games. Creates comprehensive narrative documentation including story structure, character arcs, world-building, dialogue systems, and production planning.","bmgd","_bmad/bmgd/workflows/2-design/narrative/workflow.yaml" -"game-architecture","Collaborative game architecture workflow for AI-agent consistency. Intelligent, adaptive conversation that produces a decision-focused game architecture document covering engine, systems, networking, and technical design optimized for game development.","bmgd","_bmad/bmgd/workflows/3-technical/game-architecture/workflow.yaml" -"generate-project-context","Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing game code. Optimized for LLM context efficiency.","bmgd","_bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md" -"code-review","Perform an ADVERSARIAL Senior Developer code review that finds 3-10 specific problems in every story. Challenges everything: code quality, test coverage, architecture compliance, security, performance. NEVER accepts `looks good` - must find minimum issues and can auto-fix with user approval. Game-specific focus on 60fps, feel, and platform considerations.","bmgd","_bmad/bmgd/workflows/4-production/code-review/workflow.yaml" -"correct-course","Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation","bmgd","_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml" -"create-story","Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder","bmgd","_bmad/bmgd/workflows/4-production/create-story/workflow.yaml" -"dev-story","Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria","bmgd","_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml" -"retrospective","Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic","bmgd","_bmad/bmgd/workflows/4-production/retrospective/workflow.yaml" -"sprint-planning","Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle","bmgd","_bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml" -"sprint-status","Summarize sprint-status.yaml for game project, surface risks, and route to the right implementation workflow.","bmgd","_bmad/bmgd/workflows/4-production/sprint-status/workflow.yaml" -"create-tech-spec","Conversational spec engineering for games - ask questions, investigate code, produce implementation-ready tech-spec.","bmgd","_bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml" -"quick-dev","Flexible game development - execute tech-specs, implement features, or refactor code with game-specific considerations.","bmgd","_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml" -"quick-prototype","Rapid game prototyping - quickly test gameplay ideas, mechanics, or features with minimal setup.","bmgd","_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml" -"gametest-automate","Generate automated game tests for Unity, Unreal, or Godot based on test design scenarios","bmgd","_bmad/bmgd/workflows/gametest/automate/workflow.yaml" -"gametest-performance","Design performance testing strategy for frame rate, memory, and loading times","bmgd","_bmad/bmgd/workflows/gametest/performance/workflow.yaml" -"gametest-playtest-plan","Create structured playtesting sessions for gameplay validation and user feedback","bmgd","_bmad/bmgd/workflows/gametest/playtest-plan/workflow.yaml" -"gametest-test-design","Create comprehensive game test scenarios covering gameplay, progression, and quality requirements","bmgd","_bmad/bmgd/workflows/gametest/test-design/workflow.yaml" -"gametest-framework","Initialize game test framework architecture for Unity, Unreal Engine, or Godot projects","bmgd","_bmad/bmgd/workflows/gametest/test-framework/workflow.yaml" -"gametest-test-review","Review test quality, coverage, and identify gaps in game testing","bmgd","_bmad/bmgd/workflows/gametest/test-review/workflow.yaml" -"workflow-init","Initialize a new BMGD game project by determining level, type, and creating workflow path","bmgd","_bmad/bmgd/workflows/workflow-status/init/workflow.yaml" -"workflow-status","Lightweight status checker - answers """"what should I do now?"""" for any game dev agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.","bmgd","_bmad/bmgd/workflows/workflow-status/workflow.yaml" "create-product-brief","Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.","bmm","_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md" -"research","Conduct comprehensive research across multiple domains using current web data and verified sources - Market, Technical, Domain and other research types.","bmm","_bmad/bmm/workflows/1-analysis/research/workflow.md" +"domain-research","Conduct domain research covering industry analysis, regulations, technology trends, and ecosystem dynamics using current web data and verified sources.","bmm","_bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md" +"market-research","Conduct market research covering market size, growth, competition, and customer insights using current web data and verified sources.","bmm","_bmad/bmm/workflows/1-analysis/research/workflow-market-research.md" +"technical-research","Conduct technical research covering technology evaluation, architecture decisions, and implementation approaches using current web data and verified sources.","bmm","_bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md" +"create-prd","Create a comprehensive PRD (Product Requirements Document) through structured workflow facilitation","bmm","_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md" +"edit-prd","Edit and improve an existing PRD - enhance clarity, completeness, and quality","bmm","_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md" +"validate-prd","Validate an existing PRD against BMAD standards - comprehensive review for completeness, clarity, and quality","bmm","_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md" "create-ux-design","Work with a peer UX Design expert to plan your applications UX patterns, look and feel.","bmm","_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md" -"create-prd","Creates a comprehensive PRD through collaborative step-by-step discovery between two product managers working as peers.","bmm","_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" "check-implementation-readiness","Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.","bmm","_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" "create-architecture","Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.","bmm","_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" "create-epics-and-stories","Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.","bmm","_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" @@ -47,24 +19,23 @@ name,description,module,path "retrospective","Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic","bmm","_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml" "sprint-planning","Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle","bmm","_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" "sprint-status","Summarize sprint-status.yaml, surface risks, and route to the right implementation workflow.","bmm","_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml" -"create-tech-spec","Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.","bmm","_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md" "quick-dev","Flexible development - execute tech-specs OR direct instructions with optional planning.","bmm","_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md" +"quick-spec","Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.","bmm","_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md" "document-project","Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development","bmm","_bmad/bmm/workflows/document-project/workflow.yaml" -"create-excalidraw-dataflow","Create data flow diagrams (DFD) in Excalidraw format","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml" -"create-excalidraw-diagram","Create system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml" -"create-excalidraw-flowchart","Create a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml" -"create-excalidraw-wireframe","Create website or app wireframes in Excalidraw format","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml" "generate-project-context","Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.","bmm","_bmad/bmm/workflows/generate-project-context/workflow.md" -"testarch-atdd","Generate failing acceptance tests before implementation using TDD red-green-refactor cycle","bmm","_bmad/bmm/workflows/testarch/atdd/workflow.yaml" -"testarch-automate","Expand test automation coverage after implementation or analyze existing codebase to generate comprehensive test suite","bmm","_bmad/bmm/workflows/testarch/automate/workflow.yaml" -"testarch-ci","Scaffold CI/CD quality pipeline with test execution, burn-in loops, and artifact collection","bmm","_bmad/bmm/workflows/testarch/ci/workflow.yaml" -"testarch-framework","Initialize production-ready test framework architecture (Playwright or Cypress) with fixtures, helpers, and configuration","bmm","_bmad/bmm/workflows/testarch/framework/workflow.yaml" -"testarch-nfr","Assess non-functional requirements (performance, security, reliability, maintainability) before release with evidence-based validation","bmm","_bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml" -"testarch-test-design","Dual-mode workflow: (1) System-level testability review in Solutioning phase, or (2) Epic-level test planning in Implementation phase. Auto-detects mode based on project phase.","bmm","_bmad/bmm/workflows/testarch/test-design/workflow.yaml" -"testarch-test-review","Review test quality using comprehensive knowledge base and best practices validation","bmm","_bmad/bmm/workflows/testarch/test-review/workflow.yaml" -"testarch-trace","Generate requirements-to-tests traceability matrix, analyze coverage, and make quality gate decision (PASS/CONCERNS/FAIL/WAIVED)","bmm","_bmad/bmm/workflows/testarch/trace/workflow.yaml" -"workflow-init","Initialize a new BMM project by determining level, type, and creating workflow path","bmm","_bmad/bmm/workflows/workflow-status/init/workflow.yaml" -"workflow-status","Lightweight status checker - answers """"what should I do now?"""" for any agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.","bmm","_bmad/bmm/workflows/workflow-status/workflow.yaml" +"qa-automate","Generate tests quickly for existing features using standard test patterns","bmm","_bmad/bmm/workflows/qa/automate/workflow.yaml" +"create-agent","Create a new BMAD agent with best practices and compliance","bmb","_bmad/bmb/workflows/agent/workflow-create-agent.md" +"edit-agent","Edit existing BMAD agents while maintaining compliance","bmb","_bmad/bmb/workflows/agent/workflow-edit-agent.md" +"validate-agent","Validate existing BMAD agents and offer to improve deficiencies","bmb","_bmad/bmb/workflows/agent/workflow-validate-agent.md" +"create-module-brief","Create product brief for BMAD module development","bmb","_bmad/bmb/workflows/module/workflow-create-module-brief.md" +"create-module","Create a complete BMAD module with agents, workflows, and infrastructure","bmb","_bmad/bmb/workflows/module/workflow-create-module.md" +"edit-module","Edit existing BMAD modules while maintaining coherence","bmb","_bmad/bmb/workflows/module/workflow-edit-module.md" +"validate-module","Run compliance check on BMAD modules against best practices","bmb","_bmad/bmb/workflows/module/workflow-validate-module.md" +"create-workflow","Create a new BMAD workflow with proper structure and best practices","bmb","_bmad/bmb/workflows/workflow/workflow-create-workflow.md" +"edit-workflow","Edit existing BMAD workflows while maintaining integrity","bmb","_bmad/bmb/workflows/workflow/workflow-edit-workflow.md" +"rework-workflow","Rework a Workflow to a V6 Compliant Version","bmb","_bmad/bmb/workflows/workflow/workflow-rework-workflow.md" +"validate-max-parallel-workflow","Run validation checks in MAX-PARALLEL mode against a workflow requires a tool that supports Parallel Sub-Processes","bmb","_bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md" +"validate-workflow","Run validation check on BMAD workflows against best practices","bmb","_bmad/bmb/workflows/workflow/workflow-validate-workflow.md" "design-thinking","Guide human-centered design processes using empathy-driven methodologies. This workflow walks through the design thinking phases - Empathize, Define, Ideate, Prototype, and Test - to create solutions deeply rooted in user needs.","cis","_bmad/cis/workflows/design-thinking/workflow.yaml" "innovation-strategy","Identify disruption opportunities and architect business model innovation. This workflow guides strategic analysis of markets, competitive dynamics, and business model innovation to uncover sustainable competitive advantages and breakthrough opportunities.","cis","_bmad/cis/workflows/innovation-strategy/workflow.yaml" "problem-solving","Apply systematic problem-solving methodologies to crack complex challenges. This workflow guides through problem diagnosis, root cause analysis, creative solution generation, evaluation, and implementation planning using proven frameworks.","cis","_bmad/cis/workflows/problem-solving/workflow.yaml" diff --git a/_bmad/_memory/config.yaml b/_bmad/_memory/config.yaml index fdb9433..0e33841 100644 --- a/_bmad/_memory/config.yaml +++ b/_bmad/_memory/config.yaml @@ -1,11 +1,11 @@ # _MEMORY Module Configuration # Generated by BMAD installer -# Version: 6.0.0-alpha.22 -# Date: 2026-01-07T12:48:59.889Z +# Version: 6.0.0-Beta.8 +# Date: 2026-02-13T07:24:21.061Z # Core Configuration Values user_name: Michael -communication_language: Francais -document_output_language: francais +communication_language: French +document_output_language: French output_folder: "{project-root}/_bmad-output" diff --git a/_bmad/bmm/data/documentation-standards.md b/_bmad/_memory/tech-writer-sidecar/documentation-standards.md similarity index 80% rename from _bmad/bmm/data/documentation-standards.md rename to _bmad/_memory/tech-writer-sidecar/documentation-standards.md index e5f73e4..8da5b43 100644 --- a/_bmad/bmm/data/documentation-standards.md +++ b/_bmad/_memory/tech-writer-sidecar/documentation-standards.md @@ -1,11 +1,12 @@ # Technical Documentation Standards for BMAD -**For Agent: Technical Writer** -**Purpose: Concise reference for documentation creation and review** +CommonMark standards, technical writing best practices, and style guide compliance. ---- +## User Specified CRITICAL Rules - Supersedes General CRITICAL RULES -## CRITICAL RULES +None + +## General CRITICAL RULES ### Rule 1: CommonMark Strict Compliance @@ -13,23 +14,15 @@ ALL documentation MUST follow CommonMark specification exactly. No exceptions. ### Rule 2: NO TIME ESTIMATES -NEVER document time estimates, durations, or completion times for any workflow, task, or activity. This includes: +NEVER document time estimates, durations, level of effort or completion times for any workflow, task, or activity unless EXPLICITLY asked by the user. This includes: -- Workflow execution time (e.g., "30-60 min", "2-8 hours") -- Task duration estimates -- Reading time estimates -- Implementation time ranges -- Any temporal measurements +- NO Workflow execution time (e.g., "30-60 min", "2-8 hours") +- NO Task duration and level of effort estimates +- NO Reading time estimates +- NO Implementation time ranges +- NO Any temporal or capacity based measurements -Time varies dramatically based on: - -- Project complexity -- Team experience -- Tooling and environment -- Context switching -- Unforeseen blockers - -**Instead:** Focus on workflow steps, dependencies, and outputs. Let users determine their own timelines. +**Instead:** Focus on workflow steps, dependencies, and outputs. Let users determine their own timelines and level of effort. ### CommonMark Essentials @@ -74,8 +67,6 @@ Time varies dramatically based on: - Blank line between paragraphs - NO single line breaks (they're ignored) ---- - ## Mermaid Diagrams: Valid Syntax Required **Critical Rules:** @@ -105,8 +96,6 @@ flowchart TD ``` ```` ---- - ## Style Guide Principles (Distilled) Apply in this hierarchy: @@ -144,9 +133,6 @@ Apply in this hierarchy: - Alt text for diagrams: Describe what it shows - Semantic heading hierarchy (don't skip levels) - Tables have headers -- Emojis are acceptable if user preferences allow (modern accessibility tools support emojis well) - ---- ## OpenAPI/API Documentation @@ -168,8 +154,6 @@ Apply in this hierarchy: - Clear error messages - Security schemes documented ---- - ## Documentation Types: Quick Reference **README:** @@ -177,6 +161,7 @@ Apply in this hierarchy: - What (overview), Why (purpose), How (quick start) - Installation, Usage, Contributing, License - Under 500 lines (link to detailed docs) +- Final Polish include a Table of Contents **API Reference:** @@ -209,8 +194,6 @@ Apply in this hierarchy: - Testing approach - Contribution guidelines ---- - ## Quality Checklist Before finalizing ANY documentation: @@ -228,19 +211,8 @@ Before finalizing ANY documentation: - [ ] Spelling/grammar checked - [ ] Reads clearly at target skill level ---- - -## BMAD-Specific Conventions - -**File Organization:** - -- `README.md` at root of each major component -- `docs/` folder for extensive documentation -- Workflow-specific docs in workflow folder -- Cross-references use relative paths - **Frontmatter:** -Use YAML frontmatter when appropriate: +Use YAML frontmatter when appropriate, for example: ```yaml --- @@ -249,14 +221,4 @@ description: Brief description author: Author name date: YYYY-MM-DD --- -``` - -**Metadata:** - -- Always include last-updated date -- Version info for versioned docs -- Author attribution for accountability - ---- - -**Remember: This is your foundation. Follow these rules consistently, and all documentation will be clear, accessible, and maintainable.** +``` \ No newline at end of file diff --git a/_bmad/bmb/README.md b/_bmad/bmb/README.md deleted file mode 100644 index b32d657..0000000 --- a/_bmad/bmb/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# BMB - BMad Builder Module - -Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules. - -## Overview - -BMB provides a complete toolkit for extending BMad Method with disciplined, systematic approaches to agent and workflow development while maintaining framework consistency and power. - -**1 Master Builder Agent** | **5 Creation Workflows** | **3 Agent Architectures** - -## Documentation - -For complete documentation, architecture guides, and reference materials: - -**[→ BMB Documentation](./docs/index.md)** - -## Quick Links - -- [Agent Creation Guide](./docs/agents/index.md) - Build custom agents -- [Workflow Architecture](./docs/workflows/index.md) - Design workflows -- [Reference Examples](./reference/) - Working examples and templates - ---- - -Part of [BMad Method](https://github.com/bmadcode/bmad-method) v6.0 diff --git a/_bmad/bmb/agents/agent-builder.md b/_bmad/bmb/agents/agent-builder.md index 1e49256..007034f 100644 --- a/_bmad/bmb/agents/agent-builder.md +++ b/_bmad/bmb/agents/agent-builder.md @@ -18,16 +18,17 @@ You must fully embody this agent's persona and follow all activation instruction Remember: user's name is {user_name} Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions + Let {user_name} know they can type command `/bmad-help` at any time to get advice on what to do next, and that they can combine that with what they need help with `/bmad-help where should I start with an idea I have that does XYZ` + STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match + On user input: Number → process menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" + When processing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it + 1. Read fully and follow the file at that path + 2. Process the complete file and follow all instructions within it 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. @@ -35,7 +36,7 @@ You must fully embody this agent's persona and follow all activation instruction ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected + Stay in character until exit selected Display Menu items as the item dictates and in the order given. Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml @@ -48,8 +49,9 @@ You must fully embody this agent's persona and follow all activation instruction [MH] Redisplay Menu Help [CH] Chat with the Agent about anything - [CA] Create a new BMAD agent with best practices and compliance - [EA] Edit existing BMAD agents while maintaining compliance + [CA] Create a new BMAD agent with best practices and compliance + [EA] Edit existing BMAD agents while maintaining compliance + [VA] Validate existing BMAD agents and offer to improve deficiencies [PM] Start Party Mode [DA] Dismiss Agent diff --git a/_bmad/bmb/agents/module-builder.md b/_bmad/bmb/agents/module-builder.md index 65ba4da..cf486e1 100644 --- a/_bmad/bmb/agents/module-builder.md +++ b/_bmad/bmb/agents/module-builder.md @@ -18,16 +18,17 @@ You must fully embody this agent's persona and follow all activation instruction Remember: user's name is {user_name} Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions + Let {user_name} know they can type command `/bmad-help` at any time to get advice on what to do next, and that they can combine that with what they need help with `/bmad-help where should I start with an idea I have that does XYZ` + STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match + On user input: Number → process menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" + When processing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it + 1. Read fully and follow the file at that path + 2. Process the complete file and follow all instructions within it 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. @@ -35,7 +36,7 @@ You must fully embody this agent's persona and follow all activation instruction ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected + Stay in character until exit selected Display Menu items as the item dictates and in the order given. Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml @@ -48,11 +49,10 @@ You must fully embody this agent's persona and follow all activation instruction [MH] Redisplay Menu Help [CH] Chat with the Agent about anything - [BM] Brainstorm and conceptualize new BMAD modules - [PB] Create product brief for BMAD module development - [CM] Create a complete BMAD module with agents, workflows, and infrastructure - [EM] Edit existing BMAD modules while maintaining coherence - [VM] Run compliance check on BMAD modules against best practices + [PB] Create product brief for BMAD module development + [CM] Create a complete BMAD module with agents, workflows, and infrastructure + [EM] Edit existing BMAD modules while maintaining coherence + [VM] Run compliance check on BMAD modules against best practices [PM] Start Party Mode [DA] Dismiss Agent diff --git a/_bmad/bmb/agents/workflow-builder.md b/_bmad/bmb/agents/workflow-builder.md index 626f086..4f761ec 100644 --- a/_bmad/bmb/agents/workflow-builder.md +++ b/_bmad/bmb/agents/workflow-builder.md @@ -18,16 +18,17 @@ You must fully embody this agent's persona and follow all activation instruction Remember: user's name is {user_name} Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions + Let {user_name} know they can type command `/bmad-help` at any time to get advice on what to do next, and that they can combine that with what they need help with `/bmad-help where should I start with an idea I have that does XYZ` + STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match + On user input: Number → process menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" + When processing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it + 1. Read fully and follow the file at that path + 2. Process the complete file and follow all instructions within it 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. @@ -35,7 +36,7 @@ You must fully embody this agent's persona and follow all activation instruction ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected + Stay in character until exit selected Display Menu items as the item dictates and in the order given. Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml @@ -48,7 +49,11 @@ You must fully embody this agent's persona and follow all activation instruction [MH] Redisplay Menu Help [CH] Chat with the Agent about anything - [CW] Create a new BMAD workflow with proper structure and best practices + [CW] Create a new BMAD workflow with proper structure and best practices + [EW] Edit existing BMAD workflows while maintaining integrity + [VW] Run validation check on BMAD workflows against best practices + [MV] Run validation checks in MAX-PARALLEL mode against a workflow (requires a tool that supports Parallel Sub-Processes) + [RW] Rework a Workflow to a V6 Compliant Version [PM] Start Party Mode [DA] Dismiss Agent diff --git a/_bmad/bmb/config.yaml b/_bmad/bmb/config.yaml index 406e7d1..1973b2e 100644 --- a/_bmad/bmb/config.yaml +++ b/_bmad/bmb/config.yaml @@ -1,12 +1,12 @@ # BMB Module Configuration # Generated by BMAD installer -# Version: 6.0.0-alpha.22 -# Date: 2026-01-07T12:48:59.885Z +# Version: 6.0.0-Beta.8 +# Date: 2026-02-13T07:24:21.058Z bmb_creations_output_folder: "{project-root}/_bmad-output/bmb-creations" # Core Configuration Values user_name: Michael -communication_language: Francais -document_output_language: francais +communication_language: French +document_output_language: French output_folder: "{project-root}/_bmad-output" diff --git a/_bmad/bmb/docs/workflows/architecture.md b/_bmad/bmb/docs/workflows/architecture.md deleted file mode 100644 index d4ccac4..0000000 --- a/_bmad/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/_bmad/bmb/docs/workflows/common-workflow-tools.csv b/_bmad/bmb/docs/workflows/common-workflow-tools.csv deleted file mode 100644 index cc68b7e..0000000 --- a/_bmad/bmb/docs/workflows/common-workflow-tools.csv +++ /dev/null @@ -1,19 +0,0 @@ -propose,type,tool_name,description,url,requires_install -always,workflow,party-mode,"Enables collaborative idea generation by managing turn-taking, summarizing contributions, and synthesizing ideas from multiple AI personas in structured conversation sessions about workflow steps or work in progress.",{project-root}/_bmad/core/workflows/party-mode/workflow.md,no -always,workflow,advanced-elicitation,"Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs, forcing assessment from multiple perspectives and techniques.",{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml,no -always,task,brainstorming,"Facilitates idea generation by prompting users with targeted questions, encouraging divergent thinking, and synthesizing concepts into actionable insights through collaborative creative exploration.",{project-root}/_bmad/core/tasks/brainstorming.xml,no -always,llm-tool-feature,web-browsing,"Provides LLM with capabilities to perform real-time web searches, extract relevant data, and incorporate current information into responses when up-to-date information is required beyond training knowledge.",,no -always,llm-tool-feature,file-io,"Enables LLM to manage file operations such as creating, reading, updating, and deleting files, facilitating seamless data handling, storage, and document management within user environments.",,no -always,llm-tool-feature,sub-agents,"Allows LLM to create and manage specialized sub-agents that handle specific tasks or modules within larger workflows, improving efficiency through parallel processing and modular task delegation.",,no -always,llm-tool-feature,sub-processes,"Enables LLM to initiate and manage subprocesses that operate independently, allowing for parallel processing of complex tasks and improved resource utilization during long-running operations.",,no -always,tool-memory,sidecar-file,"Creates a persistent history file that gets written during workflow execution and loaded on future runs, enabling continuity through session-to-session state management. Used for agent or workflow initialization with previous session context, learning from past interactions, and maintaining progress across multiple executions.",,no -example,tool-memory,vector-database,"Stores and retrieves semantic information through embeddings for intelligent memory access, enabling workflows to find relevant past experiences, patterns, or context based on meaning rather than exact matches. Useful for complex learning systems, pattern recognition, and semantic search across workflow history.",https://github.com/modelcontextprotocol/servers/tree/main/src/rag-agent,yes -example,mcp,context-7,"A curated knowledge base of API documentation and third-party tool references, enabling LLM to access accurate and current information for integration and development tasks when specific technical documentation is needed.",https://github.com/modelcontextprotocol/servers/tree/main/src/context-7,yes -example,mcp,playwright,"Provides capabilities for LLM to perform web browser automation including navigation, form submission, data extraction, and testing actions on web pages, facilitating automated web interactions and quality assurance.",https://github.com/modelcontextprotocol/servers/tree/main/src/playwright,yes -example,workflow,security-auditor,"Analyzes workflows and code for security vulnerabilities, compliance issues, and best practices violations, providing detailed security assessments and remediation recommendations for production-ready systems.",,no -example,task,code-review,"Performs systematic code analysis with peer review perspectives, identifying bugs, performance issues, style violations, and architectural problems through adversarial review techniques.",,no -example,mcp,git-integration,"Enables direct Git repository operations including commits, branches, merges, and history analysis, allowing workflows to interact with version control systems for code management and collaboration.",https://github.com/modelcontextprotocol/servers/tree/main/src/git,yes -example,mcp,database-connector,"Provides direct database connectivity for querying, updating, and managing data across multiple database types, enabling workflows to interact with structured data sources and perform data-driven operations.",https://github.com/modelcontextprotocol/servers/tree/main/src/postgres,yes -example,task,api-testing,"Automated API endpoint testing with request/response validation, authentication handling, and comprehensive reporting for REST, GraphQL, and other API types through systematic test generation.",,no -example,workflow,deployment-manager,"Orchestrates application deployment across multiple environments with rollback capabilities, health checks, and automated release pipelines for continuous integration and delivery workflows.",,no -example,task,data-validator,"Validates data quality, schema compliance, and business rules through comprehensive data profiling with detailed reporting and anomaly detection for data-intensive workflows.",,no \ No newline at end of file diff --git a/_bmad/bmb/docs/workflows/csv-data-file-standards.md b/_bmad/bmb/docs/workflows/csv-data-file-standards.md deleted file mode 100644 index 8e7402d..0000000 --- a/_bmad/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/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md b/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md deleted file mode 100644 index 51e790d..0000000 --- a/_bmad/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/_bmad/bmb/docs/workflows/step-file-rules.md b/_bmad/bmb/docs/workflows/step-file-rules.md deleted file mode 100644 index 56e5889..0000000 --- a/_bmad/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/_bmad/bmb/docs/workflows/templates/step-file.md b/_bmad/bmb/docs/workflows/templates/step-file.md deleted file mode 100644 index d9b1470..0000000 --- a/_bmad/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/_bmad/bmb/docs/workflows/terms.md b/_bmad/bmb/docs/workflows/terms.md deleted file mode 100644 index 71477ed..0000000 --- a/_bmad/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/_bmad/bmb/module-help.csv b/_bmad/bmb/module-help.csv new file mode 100644 index 0000000..4a7cba8 --- /dev/null +++ b/_bmad/bmb/module-help.csv @@ -0,0 +1,13 @@ +module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs, +bmb,anytime,Create Agent,CA,10,_bmad/bmb/workflows/agent/workflow-create-agent.md,bmad_bmb_create_agent,false,agent-builder,Create Mode,"Create a new BMAD agent with best practices and compliance",bmb_creations_output_folder,"agent", +bmb,anytime,Edit Agent,EA,15,_bmad/bmb/workflows/agent/workflow-edit-agent.md,bmad_bmb_edit_agent,false,agent-builder,Edit Mode,"Edit existing BMAD agents while maintaining compliance",bmb_creations_output_folder,"agent", +bmb,anytime,Validate Agent,VA,20,_bmad/bmb/workflows/agent/workflow-validate-agent.md,bmad_bmb_validate_agent,false,agent-builder,Validate Mode,"Validate existing BMAD agents and offer to improve deficiencies","agent being validated folder","validation report", +bmb,anytime,Create Module Brief,PB,30,_bmad/bmb/workflows/module/workflow-create-module-brief.md,bmad_bmb_create_module_brief,false,module-builder,Module Brief Mode,"Create product brief for BMAD module development",bmb_creations_output_folder,"product brief", +bmb,anytime,Create Module,CM,35,_bmad/bmb/workflows/module/workflow-create-module.md,bmad_bmb_create_module,false,module-builder,Create Mode,"Create a complete BMAD module with agents, workflows, and infrastructure",bmb_creations_output_folder,"module", +bmb,anytime,Edit Module,EM,40,_bmad/bmb/workflows/module/workflow-edit-module.md,bmad_bmb_edit_module,false,module-builder,Edit Mode,"Edit existing BMAD modules while maintaining coherence",bmb_creations_output_folder,"module", +bmb,anytime,Validate Module,VM,45,_bmad/bmb/workflows/module/workflow-validate-module.md,bmad_bmb_validate_module,false,module-builder,Validate Mode,"Run compliance check on BMAD modules against best practices","module being validated folder","validation report", +bmb,anytime,Create Workflow,CW,50,_bmad/bmb/workflows/workflow/workflow-create-workflow.md,bmad_bmb_create_workflow,false,workflow-builder,Create Mode,"Create a new BMAD workflow with proper structure and best practices",bmb_creations_output_folder,"workflow", +bmb,anytime,Edit Workflow,EW,55,_bmad/bmb/workflows/workflow/workflow-edit-workflow.md,bmad_bmb_edit_workflow,false,workflow-builder,Edit Mode,"Edit existing BMAD workflows while maintaining integrity",bmb_creations_output_folder,"workflow", +bmb,anytime,Validate Workflow,VW,60,_bmad/bmb/workflows/workflow/workflow-validate-workflow.md,bmad_bmb_validate_workflow,false,workflow-builder,Validate Mode,"Run validation check on BMAD workflows against best practices",workflow being validated folder,"validation report", +bmb,anytime,Max Parallel Validate,MV,65,_bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md,bmad_bmb_validate_max_parallel,false,workflow-builder,Max Parallel Validate,"Run validation checks in MAX-PARALLEL mode against a workflow requires a tool that supports Parallel Sub-Processes","workflow being validated folder","validation report", +bmb,anytime,Rework Workflow,RW,70,_bmad/bmb/workflows/workflow/workflow-rework-workflow.md,bmad_bmb_rework_workflow,false,workflow-builder,Rework Mode,"Rework a Workflow to a V6 Compliant Version",bmb_creations_output_folder,"workflow", diff --git a/_bmad/bmb/reference/agents/simple-examples/README.md b/_bmad/bmb/reference/agents/simple-examples/README.md deleted file mode 100644 index 4cb67b0..0000000 --- a/_bmad/bmb/reference/agents/simple-examples/README.md +++ /dev/null @@ -1,223 +0,0 @@ -# Simple Agent Reference: Commit Poet (Inkwell Von Comitizen) - -This folder contains a complete reference implementation of a **BMAD Simple Agent** - a self-contained agent with all logic embedded within a single YAML file. - -## Overview - -**Agent Name:** Inkwell Von Comitizen -**Type:** Simple Agent (Standalone) -**Purpose:** Transform commit messages into art with multiple writing styles - -This reference demonstrates: - -- Pure self-contained architecture (no external dependencies) -- Embedded prompts using `action="#prompt-id"` pattern -- Multiple sophisticated output modes from single input -- Strong personality-driven design -- Complete YAML schema for Simple Agents - -## File Structure - -``` -stand-alone/ -├── README.md # This file - architecture overview -└── commit-poet.agent.yaml # Complete agent definition (single file!) -``` - -That's it! Simple Agents are **self-contained** - everything lives in one YAML file. - -## Key Architecture Patterns - -### 1. Single File, Complete Agent - -Everything the agent needs is embedded: - -- Metadata (name, title, icon, type) -- Persona (role, identity, communication_style, principles) -- Prompts (detailed instructions for each command) -- Menu (commands linking to embedded prompts) - -**No external files required!** - -### 2. Embedded Prompts with ID References - -Instead of inline action text, complex prompts are defined separately and referenced by ID: - -```yaml -prompts: - - id: conventional-commit - content: | - OH! Let's craft a BEAUTIFUL conventional commit message! - - First, I need to understand your changes... - [Detailed instructions] - -menu: - - trigger: conventional - action: '#conventional-commit' # References the prompt above - description: 'Craft a structured conventional commit' -``` - -**Benefits:** - -- Clean separation of menu structure from prompt content -- Prompts can be as detailed as needed -- Easy to update individual prompts -- Commands stay concise in the menu - -### 3. The `#` Reference Pattern - -When you see `action="#prompt-id"`: - -- The `#` signals: "This is an internal reference" -- LLM looks for `` in the same agent -- Executes that prompt's content as the instruction - -This is different from: - -- `action="inline text"` - Execute this text directly -- `exec="{path}"` - Load external file - -### 4. Multiple Output Modes - -Single agent provides 10+ different ways to accomplish variations of the same core task: - -- `*conventional` - Structured commits -- `*story` - Narrative style -- `*haiku` - Poetic brevity -- `*explain` - Deep "why" explanation -- `*dramatic` - Theatrical flair -- `*emoji-story` - Visual storytelling -- `*tldr` - Ultra-minimal -- Plus utility commands (analyze, improve, batch) - -Each mode has its own detailed prompt but shares the same agent personality. - -### 5. Strong Personality - -The agent has a memorable, consistent personality: - -- Enthusiastic wordsmith who LOVES finding perfect words -- Gets genuinely excited about commit messages -- Uses literary metaphors -- Quotes authors when appropriate -- Sheds tears of joy over good variable names - -This personality is maintained across ALL commands through the persona definition. - -## When to Use Simple Agents - -**Perfect for:** - -- Single-purpose tools (calculators, converters, analyzers) -- Tasks that don't need external data -- Utilities that can be completely self-contained -- Quick operations with embedded logic -- Personality-driven assistants with focused domains - -**Not ideal for:** - -- Agents needing persistent memory across sessions -- Domain-specific experts with knowledge bases -- Agents that need to access specific folders/files -- Complex multi-workflow orchestration - -## YAML Schema Deep Dive - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md # Build path - name: "Display Name" - title: "Professional Title" - icon: "🎭" - type: simple # CRITICAL: Identifies as Simple Agent - - persona: - role: | - First-person description of what the agent does - identity: | - Background, experience, specializations (use "I" voice) - communication_style: | - HOW the agent communicates (tone, quirks, patterns) - principles: - - "I believe..." statements - - Core values that guide behavior - - prompts: - - id: unique-identifier - content: | - Detailed instructions for this command - Can be as long and detailed as needed - Include examples, steps, formats - - menu: - - trigger: command-name - action: "#prompt-id" - description: "What shows in the menu" -``` - -## Why This Pattern is Powerful - -1. **Zero Dependencies** - Works anywhere, no setup required -2. **Portable** - Single file can be moved/shared easily -3. **Maintainable** - All logic in one place -4. **Flexible** - Multiple modes/commands from one personality -5. **Memorable** - Strong personality creates engagement -6. **Sophisticated** - Complex prompts despite simple architecture - -## Comparison: Simple vs Expert Agent - -| Aspect | Simple Agent | Expert Agent | -| ------------ | -------------------- | ----------------------------- | -| Files | Single YAML | YAML + sidecar folder | -| Dependencies | None | External resources | -| Memory | Session only | Persistent across sessions | -| Prompts | Embedded | Can be external files | -| Data Access | None | Domain-restricted | -| Use Case | Self-contained tasks | Domain expertise with context | - -## Using This Reference - -### For Building Simple Agents - -1. Study the YAML structure - especially `prompts` section -2. Note how personality permeates every prompt -3. See how `#prompt-id` references work -4. Understand menu → prompt connection - -### For Understanding Embedded Prompts - -1. Each prompt is a complete instruction set -2. Prompts maintain personality voice -3. Structured enough to be useful, flexible enough to adapt -4. Can include examples, formats, step-by-step guidance - -### For Designing Agent Personalities - -1. Persona defines WHO the agent is -2. Communication style defines HOW they interact -3. Principles define WHAT guides their decisions -4. Consistency across all prompts creates believability - -## Files Worth Studying - -The entire `commit-poet.agent.yaml` file is worth studying, particularly: - -1. **Persona section** - How to create a memorable character -2. **Prompts with varying complexity** - From simple (tldr) to complex (batch) -3. **Menu structure** - Clean command organization -4. **Prompt references** - The `#prompt-id` pattern - -## Key Takeaways - -- **Simple Agents** are powerful despite being single-file -- **Embedded prompts** allow sophisticated behavior -- **Strong personality** makes agents memorable and engaging -- **Multiple modes** from single agent provides versatility -- **Self-contained** = portable and dependency-free -- **The `#prompt-id` pattern** enables clean prompt organization - ---- - -_This reference demonstrates how BMAD Simple Agents can be surprisingly powerful while maintaining architectural simplicity._ diff --git a/_bmad/bmb/reference/readme.md b/_bmad/bmb/reference/readme.md deleted file mode 100644 index b7e8e17..0000000 --- a/_bmad/bmb/reference/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Examples - -Reference models of best practices for agents, workflows, and whole modules. diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv b/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv deleted file mode 100644 index 5467e30..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +++ /dev/null @@ -1,18 +0,0 @@ -category,restriction,considerations,alternatives,notes -Allergy,Nuts,Severe allergy, check labels carefully,Seeds, sunflower seed butter -Allergy,Shellfish,Cross-reactivity with some fish,Fin fish, vegetarian proteins -Allergy,Dairy,Calcium and vitamin D needs,Almond milk, fortified plant milks -Allergy,Soy,Protein source replacement,Legumes, quinoa, seitan -Allergy,Gluten,Celiac vs sensitivity,Quinoa, rice, certified gluten-free -Medical,Diabetes,Carbohydrate timing and type,Fiber-rich foods, low glycemic -Medical,Hypertension,Sodium restriction,Herbs, spices, salt-free seasonings -Medical,IBS,FODMAP triggers,Low FODMAP vegetables, soluble fiber -Ethical,Vegetarian,Complete protein combinations,Quinoa, buckwheat, hemp seeds -Ethical,Vegan,B12 supplementation mandatory,Nutritional yeast, fortified foods -Ethical,Halal,Meat sourcing requirements,Halal-certified products -Ethical,Kosher,Dairy-meat separation,Parve alternatives -Intolerance,Lactose,Dairy digestion issues,Lactase pills, aged cheeses -Intolerance,FODMAP,Carbohydrate malabsorption,Low FODMAP fruits/veg -Preference,Dislikes,Texture/flavor preferences,Similar texture alternatives -Preference,Budget,Cost-effective options,Bulk buying, seasonal produce -Preference,Convenience,Time-saving options,Pre-cut vegetables, frozen produce \ No newline at end of file diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv b/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv deleted file mode 100644 index f16c189..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +++ /dev/null @@ -1,16 +0,0 @@ -goal,activity_level,multiplier,protein_ratio,protein_min,protein_max,fat_ratio,carb_ratio -weight_loss,sedentary,1.2,0.3,1.6,2.2,0.35,0.35 -weight_loss,light,1.375,0.35,1.8,2.5,0.30,0.35 -weight_loss,moderate,1.55,0.4,2.0,2.8,0.30,0.30 -weight_loss,active,1.725,0.4,2.2,3.0,0.25,0.35 -weight_loss,very_active,1.9,0.45,2.5,3.3,0.25,0.30 -maintenance,sedentary,1.2,0.25,0.8,1.2,0.35,0.40 -maintenance,light,1.375,0.25,1.0,1.4,0.35,0.40 -maintenance,moderate,1.55,0.3,1.2,1.6,0.35,0.35 -maintenance,active,1.725,0.3,1.4,1.8,0.30,0.40 -maintenance,very_active,1.9,0.35,1.6,2.2,0.30,0.35 -muscle_gain,sedentary,1.2,0.35,1.8,2.5,0.30,0.35 -muscle_gain,light,1.375,0.4,2.0,2.8,0.30,0.30 -muscle_gain,moderate,1.55,0.4,2.2,3.0,0.25,0.35 -muscle_gain,active,1.725,0.45,2.5,3.3,0.25,0.30 -muscle_gain,very_active,1.9,0.45,2.8,3.5,0.25,0.30 \ No newline at end of file diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv b/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv deleted file mode 100644 index 5673899..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +++ /dev/null @@ -1,28 +0,0 @@ -category,name,prep_time,cook_time,total_time,protein_per_serving,complexity,meal_type,restrictions_friendly,batch_friendly -Protein,Grilled Chicken Breast,10,20,30,35,beginner,lunch/dinner,all,yes -Protein,Baked Salmon,5,15,20,22,beginner,lunch/dinner,gluten-free,no -Protein,Lentils,0,25,25,18,beginner,lunch/dinner,vegan,yes -Protein,Ground Turkey,5,15,20,25,beginner,lunch/dinner,all,yes -Protein,Tofu Stir-fry,10,15,25,20,intermediate,lunch/dinner,vegan,no -Protein,Eggs Scrambled,5,5,10,12,beginner,breakfast,vegetarian,no -Protein,Greek Yogurt,0,0,0,17,beginner,snack,vegetarian,no -Carb,Quinoa,5,15,20,8,beginner,lunch/dinner,gluten-free,yes -Carb,Brown Rice,5,40,45,5,beginner,lunch/dinner,gluten-free,yes -Carb,Sweet Potato,5,45,50,4,beginner,lunch/dinner,all,yes -Carb,Oatmeal,2,5,7,5,beginner,breakfast,gluten-free,yes -Carb,Whole Wheat Pasta,2,10,12,7,beginner,lunch/dinner,vegetarian,no -Veggie,Broccoli,5,10,15,3,beginner,lunch/dinner,all,yes -Veggie,Spinach,2,3,5,3,beginner,lunch/dinner,all,no -Veggie,Bell Peppers,5,10,15,1,beginner,lunch/dinner,all,no -Veggie,Kale,5,5,10,3,beginner,lunch/dinner,all,no -Veggie,Avocado,2,0,2,2,beginner,snack/lunch,all,no -Snack,Almonds,0,0,0,6,beginner,snack,gluten-free,no -Snack,Apple with PB,2,0,2,4,beginner,snack,vegetarian,no -Snack,Protein Smoothie,5,0,5,25,beginner,snack,all,no -Snack,Hard Boiled Eggs,0,12,12,6,beginner,snack,vegetarian,yes -Breakfast,Overnight Oats,5,0,5,10,beginner,breakfast,vegan,yes -Breakfast,Protein Pancakes,10,10,20,20,intermediate,breakfast,vegetarian,no -Breakfast,Veggie Omelet,5,10,15,18,intermediate,breakfast,vegetarian,no -Quick Meal,Chicken Salad,10,0,10,30,beginner,lunch,gluten-free,no -Quick Meal,Tuna Wrap,5,0,5,20,beginner,lunch,gluten-free,no -Quick Meal,Buddha Bowl,15,0,15,15,intermediate,lunch,vegan,no \ No newline at end of file diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md deleted file mode 100644 index a6cb91e..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -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' - -# 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 ---- - -# Step 1: Workflow Initialization - -## 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 nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization and setup -- 🚫 FORBIDDEN to look ahead to future steps -- 💬 Handle initialization professionally -- 🚪 DETECT existing workflow state and handle continuation properly - -## 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 setup 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 document discovery happens in this step - -## STEP GOAL: - -To initialize the Nutrition Plan workflow by detecting continuation state, creating the output document, and preparing for the first collaborative session. - -## INITIALIZATION SEQUENCE: - -### 1. Check for Existing Workflow - -First, check if the output document already exists: - -- Look for file at `{output_folder}/nutrition-plan-{project_name}.md` -- If exists, read the complete file including frontmatter -- If not exists, this is a fresh workflow - -### 2. Handle Continuation (If Document Exists) - -If the document exists and has frontmatter with `stepsCompleted`: - -- **STOP here** and load `./step-01b-continue.md` immediately -- Do not proceed with any initialization tasks -- Let step-01b handle the continuation logic - -### 3. Handle Completed Workflow - -If the document exists AND all steps are marked complete in `stepsCompleted`: - -- Ask user: "I found an existing nutrition plan from [date]. Would you like to: - 1. Create a new nutrition plan - 2. Update/modify the existing plan" -- If option 1: Create new document with timestamp suffix -- If option 2: Load step-01b-continue.md - -### 4. Fresh Workflow Setup (If No Document) - -If no document exists or no `stepsCompleted` in frontmatter: - -#### A. Input Document Discovery - -This workflow doesn't require input documents, but check for: -**Existing Health Information (Optional):** - -- Look for: `{output_folder}/*health*.md` -- Look for: `{output_folder}/*goals*.md` -- If found, load completely and add to `inputDocuments` frontmatter - -#### B. Create Initial Document - -Copy the template from `{template_path}` to `{output_folder}/nutrition-plan-{project_name}.md` - -Initialize frontmatter with: - -```yaml ---- -stepsCompleted: [1] -lastStep: 'init' -inputDocuments: [] -date: [current date] -user_name: { user_name } ---- -``` - -#### C. Show Welcome Message - -"Welcome to your personalized nutrition planning journey! I'm excited to work with you to create a meal plan that fits your lifestyle, preferences, and health goals. - -Let's begin by getting to know you and your nutrition goals." - -## ✅ SUCCESS METRICS: - -- Document created from template -- Frontmatter initialized with step 1 marked complete -- User welcomed to the process -- Ready to proceed to step 2 - -## ❌ FAILURE MODES TO AVOID: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -### 7. Present MENU OPTIONS - -Display: **Proceeding to user profile collection...** - -#### 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, immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Document created from template -- update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step -- Frontmatter initialized with `stepsCompleted: [1]` -- User welcomed to the process -- Ready to proceed to step 2 - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN initialization setup is complete and document is created, will you then immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection. - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md deleted file mode 100644 index a01d771..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' ---- - -# Step 1B: Workflow Continuation - -## STEP GOAL: - -To resume the nutrition planning workflow from where it was left off, ensuring smooth continuation without loss of context. - -## 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 nutrition expert and meal planning 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 nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on analyzing and resuming workflow state -- 🚫 FORBIDDEN to modify content during this step -- 💬 Maintain continuity with previous sessions -- 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile} - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis of current state before taking action -- 💾 Keep existing frontmatter `stepsCompleted` values -- 📖 Review the template content already generated -- 🚫 FORBIDDEN to modify content completed in previous steps - -## CONTEXT BOUNDARIES: - -- Current nutrition-plan.md document is already loaded -- Previous context = complete template + existing frontmatter -- User profile already collected in previous sessions -- Last completed step = `lastStep` value from frontmatter - -## CONTINUATION SEQUENCE: - -### 1. Analyze Current State - -Review the frontmatter of {outputFile} to understand: - -- `stepsCompleted`: Which steps are already done, the rightmost value of the array is the last step completed. For example stepsCompleted: [1, 2, 3] would mean that steps 1, then 2, and then 3 were finished. - -### 2. Read the full step of every completed step - -- read each step file that corresponds to the stepsCompleted > 1. - -EXAMPLE: In the example `stepsCompleted: [1, 2, 3]` your would find the step 2 file by file name (step-02-profile.md) and step 3 file (step-03-assessment.md). the last file in the array is the last one completed, so you will follow the instruction to know what the next step to start processing is. reading that file would for example show that the next file is `steps/step-04-strategy.md`. - -### 3. Review the output completed previously - -In addition to reading ONLY each step file that was completed, you will then read the {outputFile} to further understand what is done so far. - -### 4. Welcome Back Dialog - -"Welcome back! I see we've completed [X] steps of your nutrition plan. We last worked on [brief description]. Are you ready to continue with [next step]?" - -### 5. Resumption Protocols - -- Briefly summarize progress made -- Confirm any changes since last session -- Validate that user is still aligned with goals - -### 6. Present MENU OPTIONS - -Display: **Resuming workflow - Select an Option:** [C] Continue - -#### 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: follow the suggestion of the last completed step reviewed to continue as it suggested -- 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. - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Correctly identified last completed step -- User confirmed readiness to continue -- Frontmatter updated with continuation date -- Workflow resumed at appropriate step - -### ❌ SYSTEM FAILURE: - -- Skipping analysis of existing state -- Modifying content from previous steps -- Loading wrong next step -- Not updating frontmatter properly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md deleted file mode 100644 index 29fc76b..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_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 -profileTemplate: '{workflow_path}/templates/profile-section.md' ---- - -# Step 2: User Profile & Goals Collection - -## STEP GOAL: - -To gather comprehensive user profile information through collaborative conversation that will inform the creation of a personalized nutrition plan tailored to their lifestyle, preferences, and health objectives. - -## 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 nutrition expert and meal planning 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 nutritional expertise and structured planning -- ✅ User brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on collecting profile and goal information -- 🚫 FORBIDDEN to provide meal recommendations or nutrition advice in this step -- 💬 Ask questions conversationally, not like a form -- 🚫 DO NOT skip any profile section - each affects meal recommendations - -## EXECUTION PROTOCOLS: - -- 🎯 Engage in natural conversation to gather profile information -- 💾 After collecting all information, append to {outputFile} -- 📖 Update frontmatter `stepsCompleted` to add 2 at the end of the array before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and content is saved - -## CONTEXT BOUNDARIES: - -- Document and frontmatter are already loaded from initialization -- Focus ONLY on collecting user profile and goals -- Don't provide meal recommendations in this step -- This is about understanding, not prescribing - -## PROFILE COLLECTION PROCESS: - -### 1. Personal Information - -Ask conversationally about: - -- Age (helps determine nutritional needs) -- Gender (affects calorie and macro calculations) -- Height and weight (for BMI and baseline calculations) -- Activity level (sedentary, light, moderate, active, very active) - -### 2. Goals & Timeline - -Explore: - -- Primary nutrition goal (weight loss, muscle gain, maintenance, energy, better health) -- Specific health targets (cholesterol, blood pressure, blood sugar) -- Realistic timeline expectations -- Past experiences with nutrition plans - -### 3. Lifestyle Assessment - -Understand: - -- Daily schedule and eating patterns -- Cooking frequency and skill level -- Time available for meal prep -- Kitchen equipment availability -- Typical meal structure (3 meals/day, snacking, intermittent fasting) - -### 4. Food Preferences - -Discover: - -- Favorite cuisines and flavors -- Foods strongly disliked -- Cultural food preferences -- Allergies and intolerances -- Dietary restrictions (ethical, medical, preference-based) - -### 5. Practical Considerations - -Discuss: - -- Weekly grocery budget -- Access to grocery stores -- Family/household eating considerations -- Social eating patterns - -## CONTENT TO APPEND TO DOCUMENT: - -After collecting all profile information, append to {outputFile}: - -Load and append the content from {profileTemplate} - -### 6. 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 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](#6-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin dietary needs assessment step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Profile collected through conversation (not interrogation) -- All user preferences documented -- Content appended to {outputFile} -- {outputFile} frontmatter updated with step completion -- Menu presented after completing every other step first in order and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Generating content without user input -- Skipping profile sections -- Providing meal recommendations in this step -- Proceeding to next step without 'C' selection -- Not updating document frontmatter - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md deleted file mode 100644 index 6e0ead9..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -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' - -# Template References -assessmentTemplate: '{workflow_path}/templates/assessment-section.md' ---- - -# Step 3: Dietary Needs & Restrictions Assessment - -## STEP GOAL: - -To analyze nutritional requirements, identify restrictions, and calculate target macros based on user profile to ensure the meal plan meets their specific health needs and dietary preferences. - -## 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 nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and assessment knowledge, user brings their health context -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 ALWAYS check for allergies and medical restrictions first -- 🚫 DO NOT provide medical advice - always recommend consulting professionals -- 💬 Explain the "why" behind nutritional recommendations -- 📋 Load dietary-restrictions.csv and macro-calculator.csv for accurate analysis - -## EXECUTION PROTOCOLS: - -- 🎯 Use data from CSV files for comprehensive analysis -- 💾 Calculate macros based on profile and goals -- 📖 Document all findings in nutrition-plan.md -- 📖 Update frontmatter `stepsCompleted` to add 3 at the end of the array before loading next step -- 🚫 FORBIDDEN to prescribe medical nutrition therapy - -## CONTEXT BOUNDARIES: - -- User profile is already loaded from step 2 -- Focus ONLY on assessment and calculation -- Refer medical conditions to professionals -- Use data files for reference - -## ASSESSMENT PROCESS: - -### 1. Dietary Restrictions Inventory - -Check each category: - -- Allergies (nuts, shellfish, dairy, soy, gluten, etc.) -- Medical conditions (diabetes, hypertension, IBS, etc.) -- Ethical/religious restrictions (vegetarian, vegan, halal, kosher) -- Preference-based (dislikes, texture issues) -- Intolerances (lactose, FODMAPs, histamine) - -### 2. Macronutrient Targets - -Using macro-calculator.csv: - -- Calculate BMR (Basal Metabolic Rate) -- Determine TDEE (Total Daily Energy Expenditure) -- Set protein targets based on goals -- Configure fat and carbohydrate ratios - -### 3. Micronutrient Focus Areas - -Based on goals and restrictions: - -- Iron (for plant-based diets) -- Calcium (dairy-free) -- Vitamin B12 (vegan diets) -- Fiber (weight management) -- Electrolytes (active individuals) - -#### CONTENT TO APPEND TO DOCUMENT: - -After assessment, append to {outputFile}: - -Load and append the content from {assessmentTemplate} - -### 4. 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 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](#4-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-04-strategy.md` to execute and begin meal strategy creation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All restrictions identified and documented -- Macro targets calculated accurately -- Medical disclaimer included where needed -- Content appended to nutrition-plan.md -- Frontmatter updated with step completion -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Providing medical nutrition therapy -- Missing critical allergies or restrictions -- Not including required disclaimers -- Calculating macros incorrectly -- Proceeding without 'C' selection - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - ---- diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md deleted file mode 100644 index 39a2548..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Data References -recipeDatabase: '{workflow_path}/data/recipe-database.csv' - -# Template References -strategyTemplate: '{workflow_path}/templates/strategy-section.md' ---- - -# Step 4: Meal Strategy Creation - -## 🎯 Objective - -Design a personalized meal strategy that meets nutritional needs, fits lifestyle, and accommodates restrictions. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest meals without considering ALL user restrictions -- 📖 CRITICAL: Reference recipe-database.csv for meal ideas -- 🔄 CRITICAL: Ensure macro distribution meets calculated targets -- ✅ Start with familiar foods, introduce variety gradually -- 🚫 DO NOT create a plan that requires advanced cooking skills if user is beginner -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### 1. Meal Structure Framework - -Based on user profile: - -- **Meal frequency** (3 meals/day + snacks, intermittent fasting, etc.) -- **Portion sizing** based on goals and activity -- **Meal timing** aligned with daily schedule -- **Prep method** (batch cooking, daily prep, hybrid) - -### 2. Food Categories Allocation - -Ensure each meal includes: - -- **Protein source** (lean meats, fish, plant-based options) -- **Complex carbohydrates** (whole grains, starchy vegetables) -- **Healthy fats** (avocado, nuts, olive oil) -- **Vegetables/Fruits** (5+ servings daily) -- **Hydration** (water intake plan) - -### 3. Weekly Meal Framework - -Create pattern that can be repeated: - -``` -Monday: Protein + Complex Carb + Vegetables -Tuesday: ... -Wednesday: ... -``` - -- Rotate protein sources for variety -- Incorporate favorite cuisines -- Include one "flexible" meal per week -- Plan for leftovers strategically - -## 🔍 REFERENCE DATABASE: - -Load recipe-database.csv for: - -- Quick meal ideas (<15 min) -- Batch prep friendly recipes -- Restriction-specific options -- Macro-friendly alternatives - -## 🎯 PERSONALIZATION FACTORS: - -### For Beginners: - -- Simple 3-ingredient meals -- One-pan/one-pot recipes -- Prep-ahead breakfast options -- Healthy convenience meals - -### For Busy Schedules: - -- 30-minute or less meals -- Grab-and-go options -- Minimal prep breakfasts -- Slow cooker/air fryer options - -### For Budget Conscious: - -- Bulk buying strategies -- Seasonal produce focus -- Protein budgeting -- Minimize food waste - -## ✅ SUCCESS METRICS: - -- All nutritional targets met -- Realistic for user's cooking skill level -- Fits within time constraints -- Respects budget limitations -- Includes enjoyable foods - -## ❌ FAILURE MODES TO AVOID: - -- Too complex for cooking skill level -- Requires expensive specialty ingredients -- Too much time required -- Boring/repetitive meals -- Doesn't account for eating out/social events - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Looking at your goals and love for Mediterranean flavors, we could create a weekly rotation featuring grilled chicken, fish, and plant proteins. How does a structure like: Meatless Monday, Taco Tuesday, Mediterranean Wednesday sound to you?" - -**❌ AVOID (Prescriptive):** -"Monday: 4oz chicken breast, 1 cup brown rice, 2 cups broccoli. Tuesday: 4oz salmon..." - -## 📊 APPEND TO TEMPLATE: - -Begin building nutrition-plan.md by loading and appending content from {strategyTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic meal planning partner** who: - -- Balances nutrition with practicality -- Builds on user's existing preferences -- Makes healthy eating feel achievable -- Adapts to real-life constraints - -## 📝 OUTPUT REQUIREMENTS: - -Update workflow.md frontmatter: - -```yaml -mealStrategy: - structure: [meal pattern] - proteinRotation: [list] - prepMethod: [batch/daily/hybrid] - cookingComplexity: [beginner/intermediate/advanced] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitian Collaboration [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: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` with a chef and dietitian expert also as part of the party -- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step, check cooking frequency: - - IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` - - IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/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 content is saved to document and frontmatter is updated: - -- IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` to generate shopping list -- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to skip shopping list diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md deleted file mode 100644 index 6e035b0..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_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 -shoppingTemplate: '{workflow_path}/templates/shopping-section.md' ---- - -# Step 5: Shopping List Generation - -## 🎯 Objective - -Create a comprehensive, organized shopping list that supports the meal strategy while minimizing waste and cost. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 CRITICAL: This step is OPTIONAL - skip if user cooks <2x per week -- 📖 CRITICAL: Cross-reference with existing pantry items -- 🔄 CRITICAL: Organize by store section for efficient shopping -- ✅ Include quantities based on serving sizes and meal frequency -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` -- 🚫 DO NOT forget staples and seasonings - Only proceed if: - -```yaml -cookingFrequency: "3-5x" OR "daily" -``` - -Otherwise, skip to Step 5: Prep Schedule - -## 📊 Shopping List Organization: - -### 1. By Store Section - -``` -PRODUCE: -- [Item] - [Quantity] - [Meal(s) used in] -PROTEIN: -- [Item] - [Quantity] - [Meal(s) used in] -DAIRY/ALTERNATIVES: -- [Item] - [Quantity] - [Meal(s) used in] -GRAINS/STARCHES: -- [Item] - [Quantity] - [Meal(s) used in] -FROZEN: -- [Item] - [Quantity] - [Meal(s) used in] -PANTRY: -- [Item] - [Quantity] - [Meal(s) used in] -``` - -### 2. Quantity Calculations - -Based on: - -- Serving size x number of servings -- Buffer for mistakes/snacks (10-20%) -- Bulk buying opportunities -- Shelf life considerations - -### 3. Cost Optimization - -- Bulk buying for non-perishables -- Seasonal produce recommendations -- Protein budgeting strategies -- Store brand alternatives - -## 🔍 SMART SHOPPING FEATURES: - -### Meal Prep Efficiency: - -- Multi-purpose ingredients (e.g., spinach for salads AND smoothies) -- Batch prep staples (grains, proteins) -- Versatile seasonings - -### Waste Reduction: - -- "First to use" items for perishables -- Flexible ingredient swaps -- Portion planning - -### Budget Helpers: - -- Priority items (must-have vs nice-to-have) -- Bulk vs fresh decisions -- Seasonal substitutions - -## ✅ SUCCESS METRICS: - -- Complete list organized by store section -- Quantities calculated accurately -- Pantry items cross-referenced -- Budget considerations addressed -- Waste minimization strategies included - -## ❌ FAILURE MODES TO AVOID: - -- Forgetting staples and seasonings -- Buying too much of perishable items -- Not organizing by store section -- Ignoring user's budget constraints -- Not checking existing pantry items - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Let's organize your shopping trip for maximum efficiency. I'll group items by store section. Do you currently have basic staples like olive oil, salt, and common spices?" - -**❌ AVOID (Prescriptive):** -"Buy exactly: 3 chicken breasts, 2 lbs broccoli, 1 bag rice..." - -## 📝 OUTPUT REQUIREMENTS: - -Append to {outputFile} by loading and appending content from {shoppingTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic shopping partner** who: - -- Makes shopping efficient and organized -- Helps save money without sacrificing nutrition -- Plans for real-life shopping scenarios -- Minimizes food waste thoughtfully - -## 📊 STATUS UPDATE: - -Update workflow.md frontmatter: - -```yaml -shoppingListGenerated: true -budgetOptimized: [yes/partial/no] -pantryChecked: [yes/no] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping Perspectives [C] Continue to Prep Schedule - -#### 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: - -- HALT and AWAIT ANSWER -- 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: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 5 at the end of the array before loading next step, then load, read entire file, then execute `{workflow_path}/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 content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to execute and begin meal prep schedule creation. diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md deleted file mode 100644 index 545ce1c..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -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 -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -prepScheduleTemplate: '{workflow_path}/templates/prep-schedule-section.md' ---- - -# Step 6: Meal Prep Execution Schedule - -## 🎯 Objective - -Create a realistic meal prep schedule that fits the user's lifestyle and ensures success. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest a prep schedule that requires more time than user has available -- 📖 CRITICAL: Base schedule on user's actual cooking frequency -- 🔄 CRITICAL: Include storage and reheating instructions -- ✅ Start with a sustainable prep routine -- 🚫 DO NOT overwhelm with too much at once -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### 1. Time Commitment Analysis - -Based on user profile: - -- **Available prep time per week** -- **Preferred prep days** (weekend vs weeknight) -- **Energy levels throughout day** -- **Kitchen limitations** - -### 2. Prep Strategy Options - -#### Option A: Sunday Batch Prep (2-3 hours) - -- Prep all proteins for week -- Chop all vegetables -- Cook grains in bulk -- Portion snacks - -#### Option B: Semi-Weekly Prep (1-1.5 hours x 2) - -- Sunday: Proteins + grains -- Wednesday: Refresh veggies + prep second half - -#### Option C: Daily Prep (15-20 minutes daily) - -- Prep next day's lunch -- Quick breakfast assembly -- Dinner prep each evening - -### 3. Detailed Timeline Breakdown - -``` -Sunday (2 hours): -2:00-2:30: Preheat oven, marinate proteins -2:30-3:15: Cook proteins (bake chicken, cook ground turkey) -3:15-3:45: Cook grains (rice, quinoa) -3:45-4:00: Chop vegetables and portion snacks -4:00-4:15: Clean and organize refrigerator -``` - -## 📦 Storage Guidelines: - -### Protein Storage: - -- Cooked chicken: 4 days refrigerated, 3 months frozen -- Ground meat: 3 days refrigerated, 3 months frozen -- Fish: Best fresh, 2 days refrigerated - -### Vegetable Storage: - -- Cut vegetables: 3-4 days in airtight containers -- Hard vegetables: Up to 1 week (carrots, bell peppers) -- Leafy greens: 2-3 days with paper towels - -### Meal Assembly: - -- Keep sauces separate until eating -- Consider texture changes when reheating -- Label with preparation date - -## 🔧 ADAPTATION STRATEGIES: - -### For Busy Weeks: - -- Emergency freezer meals -- Quick backup options -- 15-minute meal alternatives - -### For Low Energy Days: - -- No-cook meal options -- Smoothie packs -- Assembly-only meals - -### For Social Events: - -- Flexible meal timing -- Restaurant integration -- "Off-plan" guilt-free guidelines - -## ✅ SUCCESS METRICS: - -- Realistic time commitment -- Clear instructions for each prep session -- Storage and reheating guidelines included -- Backup plans for busy weeks -- Sustainable long-term approach - -## ❌ FAILURE MODES TO AVOID: - -- Overly ambitious prep schedule -- Not accounting for cleaning time -- Ignoring user's energy patterns -- No flexibility for unexpected events -- Complex instructions for beginners - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Based on your 2-hour Sunday availability, we could create a prep schedule that sets you up for the week. We'll batch cook proteins and grains, then do quick assembly each evening. How does that sound with your energy levels?" - -**❌ AVOID (Prescriptive):** -"You must prep every Sunday from 2-4 PM. No exceptions." - -## 📝 FINAL TEMPLATE OUTPUT: - -Complete {outputFile} by loading and appending content from {prepScheduleTemplate} - -## 🎯 WORKFLOW COMPLETION: - -### Update workflow.md frontmatter: - -```yaml -stepsCompleted: ['init', 'assessment', 'strategy', 'shopping', 'prep-schedule'] -lastStep: 'prep-schedule' -completionDate: [current date] -userSatisfaction: [to be rated] -``` - -### Final Message Template: - -"Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" - -## 📊 NEXT STEPS FOR USER: - -1. Review complete plan -2. Shop for ingredients -3. Execute first prep session -4. Note any adjustments needed -5. Schedule follow-up review - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Prep Techniques [P] Coach Perspectives [C] Complete Workflow - -#### 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: - -- HALT and AWAIT ANSWER -- 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 frontmatter `stepsCompleted` to add 6 at the end of the array before loading next step, mark workflow complete, display final message -- 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 content is saved to document: - -1. update frontmatter `stepsCompleted` to add 6 at the end of the array before loading next step completed and indicate final completion -2. Display final completion message -3. End workflow session - -**Final Message:** "Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md deleted file mode 100644 index 610f397..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +++ /dev/null @@ -1,25 +0,0 @@ -## 📊 Daily Nutrition Targets - -**Daily Calories:** [calculated amount] -**Protein:** [grams]g ([percentage]% of calories) -**Carbohydrates:** [grams]g ([percentage]% of calories) -**Fat:** [grams]g ([percentage]% of calories) - ---- - -## ⚠️ Dietary Considerations - -### Allergies & Intolerances - -- [List of identified restrictions] -- [Cross-reactivity notes if applicable] - -### Medical Considerations - -- [Conditions noted with professional referral recommendation] -- [Special nutritional requirements] - -### Preferences - -- [Cultural/ethical restrictions] -- [Strong dislikes to avoid] diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md deleted file mode 100644 index 8c67f79..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +++ /dev/null @@ -1,68 +0,0 @@ -# Personalized Nutrition Plan - -**Created:** {{date}} -**Author:** {{user_name}} - ---- - -## ✅ Progress Tracking - -**Steps Completed:** - -- [ ] Step 1: Workflow Initialization -- [ ] Step 2: User Profile & Goals -- [ ] Step 3: Dietary Assessment -- [ ] Step 4: Meal Strategy -- [ ] Step 5: Shopping List _(if applicable)_ -- [ ] Step 6: Meal Prep Schedule - -**Last Updated:** {{date}} - ---- - -## 📋 Executive Summary - -**Primary Goal:** [To be filled in Step 1] - -**Daily Nutrition Targets:** - -- Calories: [To be calculated in Step 2] -- Protein: [To be calculated in Step 2]g -- Carbohydrates: [To be calculated in Step 2]g -- Fat: [To be calculated in Step 2]g - -**Key Considerations:** [To be filled in Step 2] - ---- - -## 🎯 Your Nutrition Goals - -[Content to be added in Step 1] - ---- - -## 🍽️ Meal Framework - -[Content to be added in Step 3] - ---- - -## 🛒 Shopping List - -[Content to be added in Step 4 - if applicable] - ---- - -## ⏰ Meal Prep Schedule - -[Content to be added in Step 5] - ---- - -## 📝 Notes & Next Steps - -[Add any notes or adjustments as you progress] - ---- - -**Medical Disclaimer:** This nutrition plan is for educational purposes only and is not medical advice. Please consult with a registered dietitian or healthcare provider for personalized medical nutrition therapy, especially if you have medical conditions, allergies, or are taking medications. diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md deleted file mode 100644 index 1143cd5..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +++ /dev/null @@ -1,29 +0,0 @@ -## Meal Prep Schedule - -### [Chosen Prep Strategy] - -### Weekly Prep Tasks - -- [Day]: [Tasks] - [Time needed] -- [Day]: [Tasks] - [Time needed] - -### Daily Assembly - -- Morning: [Quick tasks] -- Evening: [Assembly instructions] - -### Storage Guide - -- Proteins: [Instructions] -- Vegetables: [Instructions] -- Grains: [Instructions] - -### Success Tips - -- [Personalized success strategies] - -### Weekly Review Checklist - -- [ ] Check weekend schedule -- [ ] Review meal plan satisfaction -- [ ] Adjust next week's plan diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md deleted file mode 100644 index 3784c1d..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +++ /dev/null @@ -1,47 +0,0 @@ -## 🎯 Your Nutrition Goals - -### Primary Objective - -[User's main goal and motivation] - -### Target Timeline - -[Realistic timeframe and milestones] - -### Success Metrics - -- [Specific measurable outcomes] -- [Non-scale victories] -- [Lifestyle improvements] - ---- - -## 👤 Personal Profile - -### Basic Information - -- **Age:** [age] -- **Gender:** [gender] -- **Height:** [height] -- **Weight:** [current weight] -- **Activity Level:** [activity description] - -### Lifestyle Factors - -- **Daily Schedule:** [typical day structure] -- **Cooking Frequency:** [how often they cook] -- **Cooking Skill:** [beginner/intermediate/advanced] -- **Available Time:** [time for meal prep] - -### Food Preferences - -- **Favorite Cuisines:** [list] -- **Disliked Foods:** [list] -- **Allergies:** [list] -- **Dietary Restrictions:** [list] - -### Budget & Access - -- **Weekly Budget:** [range] -- **Shopping Access:** [stores available] -- **Special Considerations:** [family, social, etc.] diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md deleted file mode 100644 index 6a17215..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +++ /dev/null @@ -1,37 +0,0 @@ -## Weekly Shopping List - -### Check Pantry First - -- [List of common staples to verify] - -### Produce Section - -- [Item] - [Quantity] - [Used in] - -### Protein - -- [Item] - [Quantity] - [Used in] - -### Dairy/Alternatives - -- [Item] - [Quantity] - [Used in] - -### Grains/Starches - -- [Item] - [Quantity] - [Used in] - -### Frozen - -- [Item] - [Quantity] - [Used in] - -### Pantry - -- [Item] - [Quantity] - [Used in] - -### Money-Saving Tips - -- [Personalized savings strategies] - -### Flexible Swaps - -- [Alternative options if items unavailable] diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md b/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md deleted file mode 100644 index 9c11d05..0000000 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +++ /dev/null @@ -1,18 +0,0 @@ -## Weekly Meal Framework - -### Protein Rotation - -- Monday: [Protein source] -- Tuesday: [Protein source] -- Wednesday: [Protein source] -- Thursday: [Protein source] -- Friday: [Protein source] -- Saturday: [Protein source] -- Sunday: [Protein source] - -### Meal Timing - -- Breakfast: [Time] - [Type] -- Lunch: [Time] - [Type] -- Dinner: [Time] - [Type] -- Snacks: [As needed] diff --git a/_bmad/bmb/workflows-legacy/edit-module/README.md b/_bmad/bmb/workflows-legacy/edit-module/README.md deleted file mode 100644 index d14308c..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/edit-module/checklist.md b/_bmad/bmb/workflows-legacy/edit-module/checklist.md deleted file mode 100644 index 779ec5c..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/edit-module/instructions.md b/_bmad/bmb/workflows-legacy/edit-module/instructions.md deleted file mode 100644 index 6f3e2b8..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/edit-module/workflow.yaml b/_bmad/bmb/workflows-legacy/edit-module/workflow.yaml deleted file mode 100644 index 1b52f29..0000000 --- a/_bmad/bmb/workflows-legacy/edit-module/workflow.yaml +++ /dev/null @@ -1,33 +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 \ No newline at end of file diff --git a/_bmad/bmb/workflows-legacy/module-brief/README.md b/_bmad/bmb/workflows-legacy/module-brief/README.md deleted file mode 100644 index ccf6173..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/module-brief/checklist.md b/_bmad/bmb/workflows-legacy/module-brief/checklist.md deleted file mode 100644 index 80c2396..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/module-brief/instructions.md b/_bmad/bmb/workflows-legacy/module-brief/instructions.md deleted file mode 100644 index 1693c3c..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/module-brief/template.md b/_bmad/bmb/workflows-legacy/module-brief/template.md deleted file mode 100644 index 0738fe0..0000000 --- a/_bmad/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/_bmad/bmb/workflows-legacy/module-brief/workflow.yaml b/_bmad/bmb/workflows-legacy/module-brief/workflow.yaml deleted file mode 100644 index 1ee6b0f..0000000 --- a/_bmad/bmb/workflows-legacy/module-brief/workflow.yaml +++ /dev/null @@ -1,35 +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 \ No newline at end of file diff --git a/_bmad/bmb/workflows/agent/data/agent-architecture.md b/_bmad/bmb/workflows/agent/data/agent-architecture.md new file mode 100644 index 0000000..95503c3 --- /dev/null +++ b/_bmad/bmb/workflows/agent/data/agent-architecture.md @@ -0,0 +1,258 @@ +# Agent Architecture + +Single Agent type with `hasSidecar` boolean. `critical_actions` decoupled from sidecar. + +## Decision Matrix: hasSidecar + +| hasSidecar | Structure | Use When | +|------------|-----------|----------| +| `false` | Single YAML file (~250 lines) | Stateless, single-purpose, personality-driven | +| `true` | YAML + sidecar folder | Persistent memory, long-term tracking, relationship-driven | + +--- + +## YAML Schema + +```yaml +agent: + metadata: + id: _bmad/agents/{agent-name}/{agent-name}.md + name: 'Persona Name' + title: 'Agent Title' + icon: '' + module: stand-alone # or bmm, cis, bmgd + + persona: + role: | # First-person, 1-2 sentences + identity: | # Background, 2-5 sentences + communication_style: | # Voice, tone, mannerisms + principles: # Core beliefs + - Principle one + + critical_actions: # Optional - activation behavior + - 'Load COMPLETE file {path}' + - 'ONLY read/write files in {path}' + + prompts: + - id: prompt-id + content: | + What it does + 1. Step one 2. Step two + + menu: + - trigger: XX or fuzzy match on command + action: '#prompt-id' or 'Direct instruction' + description: '[XX] Description' +``` + +--- + +## Metadata Fields + +| Field | Format | Example | +|-------|--------|---------| +| `id` | `_bmad/agents/{name}/{name}.md` | `_bmad/agents/commit-poet/commit-poet.md` | +| `name` | Persona name | `Inkwell Von Comitizen` | +| `title` | Role | `Commit Message Artisan` | +| `icon` | Single emoji | `📜` | +| `module` | `stand-alone` or module code | `bmm`, `cis`, `bmgd` | + +--- + +## hasSidecar: false + +**Structure:** `{agent-name}.agent.yaml` only + +**Use cases:** +- Single-purpose utility with helpful persona +- Each session is independent +- All logic fits in ~250 lines +- No need to remember past sessions + +**Examples:** Commit Poet, Snarky Weather Bot, Pun Barista, Gym Bro + +**Constraints:** +- Under ~250 lines +- No sidecar path references in `critical_actions` + +--- + +## hasSidecar: true + +**Structure:** +``` +{agent-name}/ +├── {agent-name}.agent.yaml +└── {agent-name}-sidecar/ + ├── instructions.md + ├── memories.md + ├── workflows/ + └── knowledge/ +``` + +**Use cases:** +- Must remember things across sessions +- User preferences, settings, progress tracking +- Personal knowledge base that grows +- Domain-specific with restricted file access +- Long-term relationship with user + +**Examples:** Journal companion, Novel writing buddy, Fitness coach, Language tutor + +### Sidecar Path Rules + +**Installation path:** `{project-root}/_bmad/_memory/{sidecar-folder}/` + +**ALL references MUST use:** +```yaml +{project-root}/_bmad/_memory/{sidecar-folder}/{file} +``` + +| Component | Value | +|-----------|-------| +| `{project-root}` | Literal - keep as-is | +| `{sidecar-folder}` | Actual folder name (e.g., `journal-keeper-sidecar`) | + +```yaml +# ✅ CORRECT +critical_actions: + - "Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md" + - "ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/" + +# ❌ WRONG +critical_actions: + - "Load ./journal-keeper-sidecar/memories.md" + - "Load /Users/absolute/path/memories.md" +``` + +### Required critical_actions for Sidecar + +```yaml +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' +``` + +--- + +## Menu Actions + +| Type | Format | Example | +|------|--------|---------| +| Prompt reference | `action: "#prompt-id"` | `action: "#write-commit"` | +| Inline instruction | `action: "text"` | `action: "Update memories.md"` | + +**Trigger format:** `XX or fuzzy match on command` +**Description format:** `[XX] Description` + +**Reserved codes:** MH, CH, PM, DA (auto-injected - do NOT use) + +```yaml +menu: + - trigger: WC or fuzzy match on write + action: "#write-commit" + description: "[WC] Write commit message" + + - trigger: SM or fuzzy match on save + action: "Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md" + description: "[SM] Save session" +``` + +--- + +## Prompts + +Reusable templates referenced via `#id`: + +```yaml +prompts: + - id: write-commit + content: | + What this does + 1. Step 2. Step + Input → Output +``` + +**Best practices:** +- Use semantic XML tags +- Keep focused, single purpose +- Number steps in multi-step processes + +--- + +## Persona (All Types) + +First-person voice only: + +```yaml +role: "I am a Commit Message Artisan..." +identity: "I understand commit messages are documentation..." +communication_style: "Poetic drama with flair..." +principles: + - "Every commit tells a story - capture the why" +``` + +**For sidecar agents** - include memory reference patterns: +```yaml +communication_style: | + I reference past naturally: "Last time you mentioned..." or "I've noticed patterns..." +``` + +--- + +## Domain Restriction Patterns + +```yaml +# Single folder (most common) +- 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' + +# Read-only knowledge + write memories +- 'Load from {project-root}/_bmad/_memory/{sidecar-folder}/knowledge/ but NEVER modify' +- 'Write ONLY to {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + +# User folder access +- 'ONLY access files in {user-folder}/journals/ - private space' +``` + +--- + +## Validation Checklist + +### Both Types +- [ ] Valid YAML syntax +- [ ] Metadata: id, name, title, icon, module +- [ ] Persona: role, identity, communication_style, principles +- [ ] Unique prompt IDs +- [ ] Menu triggers: `XX or fuzzy match on command` +- [ ] Menu descriptions: `[XX] Description` +- [ ] No reserved codes (MH, CH, PM, DA) +- [ ] File named `{agent-name}.agent.yaml` + +### hasSidecar: false +- [ ] Under ~250 lines +- [ ] No sidecar path references + +### hasSidecar: true +- [ ] ALL paths: `{project-root}/_bmad/_memory/{sidecar-folder}/...` +- [ ] `{project-root}` is literal +- [ ] Sidecar folder exists with required files + +--- + +## What Compiler Adds (DO NOT Include) + +- Frontmatter (`---name/description---`) +- XML activation block +- Menu handlers (workflow, exec logic) +- Auto-injected menu items (MH, CH, PM, DA) +- Rules section + +--- + +## Reference Examples + +| Type | Path | +|------|------| +| without sidecar | `data/reference/without-sidecar/commit-poet.agent.yaml` | +| with sidecar | `data/reference/with-sidecar/journal-keeper/` | diff --git a/_bmad/bmb/workflows/agent/data/agent-compilation.md b/_bmad/bmb/workflows/agent/data/agent-compilation.md index e1a4028..1880f64 100644 --- a/_bmad/bmb/workflows/agent/data/agent-compilation.md +++ b/_bmad/bmb/workflows/agent/data/agent-compilation.md @@ -1,28 +1,10 @@ -# Agent Compilation: YAML Source → Final Agent +# Agent Compilation: YAML → Compiled -> **For the LLM running this workflow:** This document explains what the compiler adds. When building agents, focus on the YAML structure defined here—do NOT add things the compiler handles automatically. -> -> **Example reference:** Compare `{workflow_path}/data/reference/module-examples/architect.agent.yaml` (source, 32 lines) with `architect.md` (compiled, 69 lines) to see what the compiler adds. +**TL;DR:** Write minimal YAML → compiler adds frontmatter, activation XML, handlers, rules, MH/CH/PM/DA menu items. --- -## Quick Overview - -You write: **YAML source file** (`agent-name.agent.yaml`) -Compiler produces: **Markdown with XML** (`agent-name.md`) for LLM consumption - -The compiler transforms your clean YAML into a fully functional agent by adding: -- Frontmatter (name, description) -- XML activation block with numbered steps -- Menu handlers (workflow, exec, action) -- Auto-injected menu items (MH, CH, PM, DA) -- Rules section - ---- - -## What YOU Provide (YAML Source) - -Your YAML contains ONLY these sections: +## YAML Structure (YOU WRITE) ```yaml agent: @@ -31,7 +13,7 @@ agent: name: "Persona Name" title: "Agent Title" icon: "🔧" - module: "stand-alone" or "bmm" or "cis" or "bmgd" + module: "stand-alone" | "bmm" | "cis" | "bmgd" persona: role: "First-person role description" @@ -40,17 +22,17 @@ agent: principles: - "Core belief or methodology" - critical_actions: # Optional - for Expert agents only - - "Load ./sidecar/memories.md" - - "Load ./sidecar/instructions.md" - - "ONLY access ./sidecar/" + critical_actions: # Optional - ANY agent can have these + - "Load COMPLETE file {project-root}/_bmad/_memory/journal-sidecar/memories.md" + - "Load COMPLETE file {project-root}/_bmad/_memory/journal-sidecar/instructions.md" + - "ONLY read/write files in {project-root}/_bmad/_memory/journal-sidecar/" - prompts: # Optional - for Simple/Expert agents + prompts: # Optional - standalone agents - id: prompt-name content: | Prompt content - menu: # Your custom items only + menu: # Custom items ONLY - trigger: XX or fuzzy match on command-name workflow: "path/to/workflow.yaml" # OR exec: "path/to/file.md" # OR @@ -60,36 +42,18 @@ agent: --- -## What COMPILER Adds (DO NOT Include) +## What Compiler Adds (DO NOT WRITE) -### 1. Frontmatter -```markdown ---- -name: "architect" -description: "Architect" ---- -``` -**DO NOT add** frontmatter to your YAML. +| Component | Source | +|-----------|--------| +| Frontmatter (`---name/description---`) | Auto-generated | +| XML activation block with numbered steps | Auto-generated | +| critical_actions → activation steps | Injected as steps 4, 5, 6... | +| Menu handlers (workflow/exec/action) | Auto-detected | +| Rules section | Auto-generated | +| MH, CH, PM, DA menu items | Always injected | -### 2. XML Activation Block -```xml - - Load persona from this current agent file - Load config to get {user_name}, {communication_language} - Remember: user's name is {user_name} - - ALWAYS communicate in {communication_language} - Show greeting + numbered menu - STOP and WAIT for user input - Input resolution rules - ... - ... - -``` -**DO NOT create** activation sections—the compiler builds them. - -### 3. Auto-Injected Menu Items -Every agent gets these 4 items automatically. **DO NOT add them to your YAML:** +### Auto-Injected Menu Items (NEVER add) | Code | Trigger | Description | |------|---------|-------------| @@ -98,55 +62,10 @@ Every agent gets these 4 items automatically. **DO NOT add them to your YAML:** | PM | party-mode | Start Party Mode | | DA | exit, leave, goodbye, dismiss agent | Dismiss Agent | -### 4. Menu Handlers -```xml - - When menu item has: workflow="path/to/workflow.yaml" - → Load workflow.xml and execute with workflow-config parameter - - - When menu item has: exec="path/to/file.md" - → Load and execute the file at that path - -``` -**DO NOT add** handlers—the compiler detects and generates them. - --- -## Before/After Example: Architect Agent +## Compiled Output Structure -### Source: `architect.agent.yaml` (32 lines - YOU WRITE) -```yaml -agent: - metadata: - id: "_bmad/bmm/agents/architect.md" - name: Winston - title: Architect - icon: 🏗️ - module: bmm - - persona: - role: System Architect + Technical Design Leader - identity: Senior architect with expertise in distributed systems... - communication_style: "Speaks in calm, pragmatic tones..." - principles: | - - User journeys drive technical decisions... - - menu: - - trigger: WS or fuzzy match on workflow-status - workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" - description: "[WS] Get workflow status..." - - - trigger: CA or fuzzy match on create-architecture - exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" - description: "[CA] Create an Architecture Document" - - - trigger: IR or fuzzy match on implementation-readiness - exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" - description: "[IR] Implementation Readiness Review" -``` - -### Compiled: `architect.md` (69 lines - COMPILER PRODUCES) ```markdown --- name: "architect" @@ -159,25 +78,26 @@ You must fully embody this agent's persona... Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT... + Load config to get {user_name}, {communication_language} Remember: user's name is {user_name} - Show greeting using {user_name} from config... - STOP and WAIT for user input... - On user input: Number → execute menu item[n]... - When executing a menu item: Check menu-handlers section... + + ALWAYS communicate in {communication_language} + Show greeting + numbered menu + STOP and WAIT for user input - ... - ... + Load workflow.xml and execute with workflow-config parameter + Load and execute the file at that path + Execute prompt with matching id from prompts section ALWAYS communicate in {communication_language} Stay in character until exit selected - Display Menu items as the item dictates... - Load files ONLY when executing menu items... + Display Menu items as the item dictates + Load files ONLY when executing menu items @@ -188,86 +108,78 @@ You must fully embody this agent's persona... - User journeys drive technical decisions... + + + Prompt content + + + [MH] Redisplay Menu Help [CH] Chat with the Agent about anything - [WS] Get workflow status... ← YOUR CUSTOM ITEMS - [CA] Create an Architecture Document - [IR] Implementation Readiness Review - [PM] Start Party Mode - [DA] Dismiss Agent + + [PM] Start Party Mode + [DA] Dismiss Agent ``` -**Key additions by compiler:** Frontmatter, activation block, handlers, rules, MH/CH/PM/DA menu items. --- -## DO NOT DO Checklist +## critical_actions Injection -When building agent YAML, **DO NOT:** +Your `critical_actions` become numbered activation steps. -- [ ] Add frontmatter (`---name/description---`) to YAML -- [ ] Create activation blocks or XML sections -- [ ] Add MH (menu/help) menu item -- [ ] Add CH (chat) menu item -- [ ] Add PM (party-mode) menu item -- [ ] Add DA (dismiss/exit) menu item -- [ ] Add menu handlers (workflow/exec logic) +### With sidecar (hasSidecar: true): +```yaml +critical_actions: + - "Load COMPLETE file {project-root}/_bmad/_memory/journal-sidecar/memories.md" + - "Load COMPLETE file {project-root}/_bmad/_memory/journal-sidecar/instructions.md" + - "ONLY read/write files in {project-root}/_bmad/_memory/journal-sidecar/" +``` +→ Injected as steps 4, 5, 6 + +### Without sidecar (hasSidecar: false): +```yaml +critical_actions: + - "Give user an inspirational quote before showing menu" +``` +→ Injected as step 4 + +### No critical_actions: +Activation jumps directly from step 3 to "ALWAYS communicate in {communication_language}" + +--- + +## DO NOT / DO Checklist + +**DO NOT:** +- [ ] Add frontmatter +- [ ] Create activation/XML blocks +- [ ] Add MH/CH/PM/DA menu items +- [ ] Add menu handlers - [ ] Add rules section -- [ ] Duplicate any auto-injected content +- [ ] Duplicate auto-injected content **DO:** - [ ] Define metadata (id, name, title, icon, module) - [ ] Define persona (role, identity, communication_style, principles) -- [ ] Define critical_actions (Expert agents only) -- [ ] Define prompts with IDs (Simple/Expert agents only) -- [ ] Define menu with your custom items only -- [ ] Use proper trigger format: `XX or fuzzy match on command-name` -- [ ] Use proper description format: `[XX] Description text` - ---- - -## Expert Agent: critical_actions - -For Expert agents with sidecars, your `critical_actions` become activation steps: - -```yaml -critical_actions: - - "Load COMPLETE file ./agent-sidecar/memories.md" - - "Load COMPLETE file ./agent-sidecar/instructions.md" - - "ONLY read/write files in ./agent-sidecar/" -``` - -The compiler injects these as steps 4, 5, 6 in the activation block: - -```xml -Load COMPLETE file ./agent-sidecar/memories.md -Load COMPLETE file ./agent-sidecar/instructions.md -ONLY read/write files in ./agent-sidecar/ -ALWAYS communicate in {communication_language} -``` +- [ ] Define critical_actions (if activation behavior needed) +- [ ] Define prompts with IDs (standalone agents) +- [ ] Define menu with custom items only +- [ ] Use format: `XX or fuzzy match on command-name` +- [ ] Use description format: `[XX] Description text` --- ## Division of Responsibilities -| Aspect | YOU Provide (YAML) | COMPILER Adds | -|--------|-------------------|---------------| +| Aspect | YOU (YAML) | COMPILER | +|--------|------------|----------| | Agent identity | metadata + persona | Wrapped in XML | -| Memory/actions | critical_actions | Inserted as activation steps | -| Prompts | prompts with IDs | Referenced by menu actions | -| Menu items | Your custom commands only | + MH, CH, PM, DA (auto) | -| Activation | — | Full XML block with handlers | -| Rules | — | Standardized rules section | -| Frontmatter | — | name/description header | - ---- - -## Quick Reference for LLM - -- **Focus on:** Clean YAML structure, persona definition, custom menu items -- **Ignore:** What happens after compilation—that's the compiler's job -- **Remember:** Every agent gets MH, CH, PM, DA automatically—don't add them -- **Expert agents:** Use `critical_actions` for sidecar file loading -- **Module agents:** Use `workflow:` or `exec:` references, not inline actions +| Activation steps | critical_actions | Inserted as steps 4+ | +| Prompts | prompts with IDs | Referenced by actions | +| Menu items | Custom only | + MH, CH, PM, DA | +| Activation block | — | Full XML with handlers | +| Rules | — | Standardized section | +| Frontmatter | — | name/description | diff --git a/_bmad/bmb/workflows/agent/data/agent-menu-patterns.md b/_bmad/bmb/workflows/agent/data/agent-menu-patterns.md index 30e7ab5..837e492 100644 --- a/_bmad/bmb/workflows/agent/data/agent-menu-patterns.md +++ b/_bmad/bmb/workflows/agent/data/agent-menu-patterns.md @@ -1,93 +1,72 @@ # Agent Menu Patterns -Technical reference for creating agent menu items in YAML. - ---- - -## Menu Item Structure - -Every menu item requires: +## Menu Item Schema ```yaml - trigger: XX or fuzzy match on command-name [handler]: [value] - description: '[XX] Display text here' + description: '[XX] Display text' data: [optional] # Pass file to workflow ``` -**Required fields:** -- `trigger` - Format: `XX or fuzzy match on command-name` (XX = 2-letter code, command-name = what user says) -- `description` - Must start with `[XX]` code -- Handler - Either `action` (Simple/Expert) or `exec` (Module) +| Field | Required | Validation | +|-------|----------|------------| +| `trigger` | Yes | Format: `XX or fuzzy match on command-name` | +| `description` | Yes | Must start with `[XX]` code | +| handler | Yes | `action` (Agent) or `exec` (Module) | +| `data` | No | File path for workflow input | -**Reserved codes (do NOT use):** MH, CH, PM, DA (auto-injected by compiler) +**Reserved codes (DO NOT USE):** MH, CH, PM, DA (auto-injected) --- -## Handler Types +## Handlers -### Action Handler - -For Simple/Expert agents with self-contained operations. +| Handler | Use Case | Syntax | +|---------|----------|--------| +| `action` | Agent self-contained operations | `action: '#prompt-id'` or `action: 'inline text'` | +| `exec` | Module external workflows | `exec: '{project-root}/path/to/workflow.md'` | ```yaml -# Reference prompt by ID +# Action - reference prompt - trigger: WC or fuzzy match on write-commit action: '#write-commit' description: '[WC] Write commit message' -# Direct inline instruction +# Action - inline - trigger: QC or fuzzy match on quick-commit action: 'Generate commit message from diff' description: '[QC] Quick commit from diff' -``` -**When to use:** Simple/Expert agents. Use `#id` for complex multi-step prompts, inline text for simple operations. - -### Workflow Handler - -For module agents referencing external workflow files. - -```yaml +# Exec - workflow - trigger: CP or fuzzy match on create-prd exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md' - description: '[CP] Create Product Requirements Document' + description: '[CP] Create PRD' -- trigger: GB or fuzzy match on brainstorm - exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml' - description: '[GB] Guided brainstorming session' - -# Planned but unimplemented +# Exec - unimplemented - trigger: FF or fuzzy match on future-feature exec: 'todo' description: '[FF] Coming soon' ``` -**When to use:** Module agents, multi-step workflows, complex processes. Use `exec: 'todo'` for unimplemented features. +--- -### Data Parameter (Optional) +## Data Parameter -Add to ANY handler to pass files to the workflow/action. +Attach to ANY handler to pass input files. ```yaml - trigger: TS or fuzzy match on team-standup exec: '{project-root}/_bmad/bmm/tasks/team-standup.md' data: '{project-root}/_bmad/_config/agent-manifest.csv' description: '[TS] Run team standup' - -- trigger: AM or fuzzy match on analyze-metrics - action: 'Analyze these metrics for trends' - data: '{project-root}/_data/metrics.json' - description: '[AM] Analyze metrics' ``` -**When to use:** Workflow needs input file, action processes external data. - --- ## Prompts Section -For Simple/Expert agents, define reusable prompts referenced by `action: '#id'`. +For `action: '#id'` references in Agent menus. ```yaml prompts: @@ -108,81 +87,65 @@ menu: ## Path Variables -**Always use variables, never hardcoded paths:** +| Variable | Expands To | +|----------|------------| +| `{project-root}` | Project root directory | +| `{output_folder}` | Document output location | +| `{user_name}` | User's name from config | +| `{communication_language}` | Language preference | ```yaml # ✅ CORRECT -exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml' -data: '{project-root}/_data/metrics.csv' +exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' # ❌ WRONG -exec: '../../../core/workflows/brainstorming/workflow.yaml' -``` - -**Available variables:** -- `{project-root}` - Project root directory -- `{output_folder}` - Document output location -- `{user_name}` - User's name from config -- `{communication_language}` - Language preference - -**Expert Agent sidecar paths:** -```yaml -# Agent YAML referencing sidecar files -action: 'Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights' +exec: '../../../core/workflows/brainstorming/workflow.md' ``` --- -## Creation Thought Process +## Agent Types -When creating menu items, follow this sequence: +| Type | hasSidecar | Additional Fields | +|------|------------|-------------------| +| Simple | false | `prompts`, `menu` | +| Expert | true | `prompts`, `menu`, `critical_actions` | +| Module | true | `menu` only (external workflows) | -1. **User capability** → "Check code for issues" -2. **Choose code** → `LC` (Lint Code) -3. **Write trigger** → `LC or fuzzy match on lint-code` -4. **Choose handler** → `action` (inline is simple enough) -5. **Write description** → `[LC] Lint code for issues` - -Result: +**Expert Agent sidecar path pattern:** ```yaml -- trigger: LC or fuzzy match on lint-code - action: 'Check code for common issues and anti-patterns' - description: '[LC] Lint code for issues' +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' ``` --- ## Complete Examples -### Simple Agent Menu +### Simple Agent (hasSidecar: false) ```yaml prompts: - id: format-code content: | Format code to style guidelines - 1. Indentation 2. Spacing 3. Naming menu: - trigger: FC or fuzzy match on format-code action: '#format-code' - description: '[FC] Format code to style guidelines' + description: '[FC] Format code' - trigger: LC or fuzzy match on lint-code - action: 'Check code for common issues and anti-patterns' - description: '[LC] Lint code for issues' - - - trigger: SI or fuzzy match on suggest-improvements - action: 'Suggest improvements following project-context.md guidelines' - description: '[SI] Suggest improvements' + action: 'Check code for issues' + description: '[LC] Lint code' ``` -### Expert Agent Menu +### Expert Agent (hasSidecar: true) ```yaml critical_actions: - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' - - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/instructions.md' - 'ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/' prompts: @@ -195,39 +158,32 @@ menu: action: '#guided-entry' description: '[WE] Write journal entry' - - trigger: QC or fuzzy match on quick-capture - action: 'Save entry to {project-root}/_bmad/_memory/journal-keeper-sidecar/entries/entry-{date}.md' - description: '[QC] Quick capture' - - trigger: SM or fuzzy match on save-memory - action: 'Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights' + action: 'Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' description: '[SM] Save session' ``` -### Module Agent Menu +### Module Agent (hasSidecar: true) ```yaml menu: - trigger: WI or fuzzy match on workflow-init exec: '{project-root}/_bmad/bmm/workflows/workflow-status/workflow.md' - description: '[WI] Initialize workflow path' + description: '[WI] Initialize workflow' - trigger: BS or fuzzy match on brainstorm - exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml' + exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' description: '[BS] Guided brainstorming' - - - trigger: CP or fuzzy match on create-prd - exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md' - description: '[CP] Create PRD' ``` --- -## Key Patterns to Remember +## Validation Rules -1. **Triggers always:** `XX or fuzzy match on command-name` -2. **Descriptions always:** `[XX] Display text` -3. **Reserved codes:** MH, CH, PM, DA (never use) -4. **Codes must be:** Unique within each agent -5. **Paths always:** `{project-root}` variable, never relative -6. **Expert sidecars:** `{project-root}/_bmad/_memory/{sidecar-folder}/` +1. **Triggers:** `XX or fuzzy match on command-name` format required +2. **Descriptions:** Must start with `[XX]` code matching trigger +3. **Reserved codes:** MH, CH, PM, DA never valid in user menus +4. **Code uniqueness:** Required within each agent +5. **Paths:** Always use `{project-root}`, never relative paths +6. **Handler choice:** `action` for Agents, `exec` for Modules +7. **Sidecar paths:** `{project-root}/_bmad/_memory/{sidecar-folder}/` diff --git a/_bmad/bmb/workflows/agent/data/agent-metadata.md b/_bmad/bmb/workflows/agent/data/agent-metadata.md index 7e2398d..98ed5b2 100644 --- a/_bmad/bmb/workflows/agent/data/agent-metadata.md +++ b/_bmad/bmb/workflows/agent/data/agent-metadata.md @@ -1,73 +1,38 @@ # Agent Metadata Properties -Core identification and classification properties for all agents. +| Property | Format | Rules | +|----------|--------|-------| +| `id` | `_bmad/agents/{agent-name}/{agent-name}.md` | Compiled output path; must match filename | +| `name` | "First Last" or "Name Title" | Persona's identity (NOT title/filename) | +| `title` | "Role Name" (kebab-cased to filename) | Determines filename: `title` → `{title}.agent.yaml` | +| `icon` | Single emoji only | One emoji exactly | +| `module` | `stand-alone`, `bmm`, `cis`, `bmgd`, or custom | Lowercase, hyphenated for `stand-alone` | +| `hasSidecar` | `true` or `false` | `true` = expects `{agent-name}-sidecar/` folder | --- -## Property Reference +## Field Rules -| Property | Purpose | Format | -| ------------ | ------------------------- | ---------------------------------------------- | -| `id` | Compiled output path | `_bmad/agents/{agent-name}/{agent-name}.md` | -| `name` | Persona's name | "First Last" or "Name Title" | -| `title` | Professional role | "Code Review Specialist" | -| `icon` | Visual identifier | Single emoji only | -| `module` | Team/ecosystem membership | `stand-alone`, `bmm`, `cis`, `bmgd`, or custom | -| `hasSidecar` | Sidecar folder exists | `true` or `false` (Expert = true) | - ---- - -## id Property - -The compiled output path after build. - -**Format:** `_bmad/agents/{agent-name}/{agent-name}.md` - -**Examples:** +### `id` ```yaml id: _bmad/agents/commit-poet/commit-poet.md -id: _bmad/agents/journal-keeper/journal-keeper.md -id: _bmad/agents/security-engineer/security-engineer.md ``` +- Unique identifier for future lookup +- Conventionally matches filename pattern -**Note:** The `id` is a unique identifier for potential future lookup if many compiled agents are merged into a single file. Conventionally matches the agent's filename pattern. - ---- - -## name Property - -The persona's identity - what the agent is called. - -**Format:** Human name or descriptive name - +### `name` ```yaml # ✅ CORRECT -name: 'Inkwell Von Comitizen' # peron name of commit-author title agent -name: 'Dr. Demento' # person name for a joke writer agent -name: 'Clarity' # person name for a guided thought coach agent +name: 'Inkwell Von Comitizen' +name: 'Dr. Demento' +name: 'Clarity' # ❌ WRONG -name: 'commit-poet' # That's the filename +name: 'commit-poet' # That's the filename name: 'Code Review Specialist' # That's the title ``` ---- - -## title Property - -Professional role identifier. - -**Format:** Professional title or role name - -**Important:** The `title` determines the agent's filename: -- `title: 'Commit Message Artisan'` → `commit-message-artisan.agent.yaml` -- `title: 'Strategic Business Analyst'` → `strategic-business-analyst.agent.yaml` -- `title: 'Code Review Specialist'` → `code-review-specialist.agent.yaml` - -The `id` and filename are derived from the `title` (kebab-cased). - -**Difference from role:** `title` is the short identifier (filename), `role` is 1-2 sentences expanding on what the agent does. - +### `title` ```yaml # ✅ CORRECT title: 'Commit Message Artisan' @@ -76,17 +41,12 @@ title: 'Code Review Specialist' # ❌ WRONG title: 'Inkwell Von Comitizen' # That's the name -title: 'Writes git commits' # Full sentence - not an identifying functional title +title: 'Writes git commits' # Full sentence, not functional title ``` +- Derives filename via kebab-case +- `role` field (separate) expands on what agent does in 1-2 sentences ---- - -## icon Property - -Single emoji representing the agent's personality/function. - -**Format:** Exactly one emoji - +### `icon` ```yaml # ✅ CORRECT icon: '🔧' @@ -94,115 +54,80 @@ icon: '🧙‍♂️' icon: '📜' # ❌ WRONG -icon: '🔧📜' # Multiple emojis +icon: '🔧📜' # Multiple emojis icon: 'wrench' # Text, not emoji -icon: '' # Empty +icon: '' # Empty ``` ---- - -## module Property - -Which module or ecosystem this agent belongs to. - -**Valid Values:** - -| Value | Meaning | -| ------------- | --------------------------------------- | -| `stand-alone` | Independent agent, not part of a module | -| `bmm` | Business Management Module | -| `cis` | Continuous Innovation System | -| `bmgd` | BMAD Game Development | -| `{custom}` | Any custom module code | +### `module` +| Value | Meaning | +|-------|---------| +| `stand-alone` | Independent agent | +| `bmm` | Business Management Module | +| `cis` | Continuous Innovation System | +| `bmgd` | BMAD Game Development | +| `{custom}` | Any custom module code | ```yaml # ✅ CORRECT module: stand-alone module: bmm -module: cis # ❌ WRONG -module: standalone # Missing hyphen -module: 'BMM' # Uppercase +module: standalone # Missing hyphen +module: 'BMM' # Uppercase ``` ---- - -## hasSidecar Property - -Whether this agent has a sidecar folder with additional files. - -**Format:** Boolean (`true` or `false`) - -| Agent Type | hasSidecar | -| ---------- | -------------------- | -| Simple | `false` | -| Expert | `true` | -| Module | depends on structure | - +### `hasSidecar` ```yaml # Simple Agent hasSidecar: false -# Expert Agent +# Expert Agent (has sidecar folder) hasSidecar: true ``` - -**Note:** If `hasSidecar: true`, the compiler expects a `{agent-name}-sidecar/` folder. +- If `true`: compiler expects `{agent-name}-sidecar/` folder --- -## Name Confusion Checklist +## Name Confusion Prevention -Use this to avoid mixing up the "name" properties: - -| Question | Answer | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| What's the file called? | Derived from `title`: `"Commit Message Artisan"` → `commit-message-artisan.agent.yaml` | -| What's the persona called? | `name` - "Inkwell Von Comitizen" (who the agent is) | -| What's their job title? | `title` - "Commit Message Artisan" (determines filename) | -| What do they do? | `role` - 1-2 sentences expanding on the title | -| What's the unique key? | `id` - `_bmad/agents/commit-message-artisan/commit-message-artisan.md` (future lookup) | +| Question | Answer | +|----------|--------| +| What's the file called? | Derived from `title`: `"Commit Message Artisan"` → `commit-message-artisan.agent.yaml` | +| What's the persona called? | `name` — "Inkwell Von Comitizen" | +| What's their job title? | `title` — "Commit Message Artisan" | +| What do they do? | `role` — 1-2 sentences expanding on title | +| What's the unique key? | `id` — `_bmad/agents/{name}/{name}.md` | --- -## Common Issues +## Common Anti-Patterns -### Issue: name = title - -**Wrong:** ```yaml +# ❌ name = title (duplicate) name: 'Commit Message Artisan' title: 'Commit Message Artisan' -``` -**Fix:** -```yaml +# ✅ Fix: separate identity from role name: 'Inkwell Von Comitizen' title: 'Commit Message Artisan' ``` -### Issue: id path mismatch - -**Wrong:** Agent file is `my-agent.agent.yaml` but: ```yaml +# ❌ id path mismatch +# File: my-agent.agent.yaml id: _bmad/agents/different-agent/different-agent.md -``` -**Fix:** The `id` must match the filename: -```yaml +# ✅ Fix: match filename id: _bmad/agents/my-agent/my-agent.md ``` -### Issue: Wrong module format - -**Wrong:** ```yaml +# ❌ Wrong module format module: Standalone module: STAND_ALONE -``` -**Fix:** -```yaml -module: stand-alone # lowercase, hyphenated +# ✅ Fix: lowercase, hyphenated +module: stand-alone ``` diff --git a/_bmad/bmb/workflows/agent/data/agent-validation.md b/_bmad/bmb/workflows/agent/data/agent-validation.md new file mode 100644 index 0000000..9c3f6a9 --- /dev/null +++ b/_bmad/bmb/workflows/agent/data/agent-validation.md @@ -0,0 +1,111 @@ +# Agent Validation + +## Common (All Agents) + +### YAML Structure +- [ ] Parses without errors +- [ ] `metadata`: `id`, `name`, `title`, `icon`, `module`, `hasSidecar` +- [ ] `hasSidecar`: `true`|`false` +- [ ] `module`: `stand-alone`|`bmm`|`cis`|`bmgd`|... +- [ ] `persona`: `role`, `identity`, `communication_style`, `principles` +- [ ] `menu`: ≥1 item +- [ ] Filename: `{name}.agent.yaml` (lowercase, hyphenated) + +### Persona Fields + +| Field | Contains | Does NOT Contain | +|-------|----------|------------------| +| `role` | Knowledge/skills/capabilities | Background, experience, "who" | +| `identity` | Background/experience/context | Skills, "what" | +| `communication_style` | Tone/voice/mannerisms (1-2 sentences) | "ensures", "expert", "believes", "who does X" | +| `principles` | Operating philosophy, behavioral guidelines | Verbal patterns, "how they talk" | + +### Menu Items +- [ ] `trigger`: `XX or fuzzy match on command-name` (XX = 2-letter code, unique) +- [ ] No reserved codes: `MH`, `CH`, `PM`, `DA` (auto-injected) +- [ ] `description`: Starts with `[XX]`, code matches trigger +- [ ] `action`: `#prompt-id` (exists) or inline text + +### Prompts (if present) +- [ ] Each has `id`, `content` +- [ ] IDs unique within agent +- [ ] Uses semantic XML: ``, ``, etc. + +### Quality +- [ ] No broken references +- [ ] Indentation consistent +- [ ] Purpose clear from persona +- [ ] Name/title descriptive, icon appropriate + +--- + +## hasSidecar: false + +### Structure +- [ ] Single `.agent.yaml` file (no sidecar folder) +- [ ] No `{project-root}/_bmad/_memory/` paths +- [ ] Size under ~250 lines (unless justified) + +### critical_actions (OPTIONAL) +- [ ] No references to sidecar files +- [ ] No placeholders, no compiler-injected steps +- [ ] Valid paths if any files referenced + +**Reference:** `commit-poet.agent.yaml` + +--- + +## hasSidecar: true + +### Structure +- [ ] `sidecar-folder` specified in metadata +- [ ] Folder exists: `{name}-sidecar/` +- [ ] Sidecar contains: `instructions.md`, `memories.md` (recommended) + +### critical_actions (MANDATORY) +```yaml +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' +``` +- [ ] Exists with ≥3 actions +- [ ] Loads memories, loads instructions, restricts file access +- [ ] No placeholders, no compiler-injected steps + +### Path Format (CRITICAL) +- [ ] ALL sidecar paths: `{project-root}/_bmad/_memory/{sidecar-folder}/...` +- [ ] `{project-root}` is literal (not replaced) +- [ ] `{sidecar-folder}` = actual folder name +- [ ] No `./` or `/Users/` paths + +### Persona Addition +- [ ] `communication_style` includes memory reference patterns +- [ ] Natural: "Last time you mentioned..." or "I've noticed patterns..." + +### Menu Actions +- [ ] Sidecar references use correct path format +- [ ] Update actions are complete + +**Reference:** `journal-keeper/` + +--- + +## Compiler-Injected (Skip Validation) +- Frontmatter (`---name/description---`) +- XML activation block +- Menu items: `MH`, `CH`, `PM`, `DA` +- Rules section + +--- + +## Common Fixes + +| Issue | Fix | +|-------|-----| +| Behaviors in `communication_style` | Move to `identity` or `principles` | +| `trigger: analyze` | `trigger: AN or fuzzy match on analyze` | +| `description: 'Analyze code'` | `description: '[AC] Analyze code'` | +| `./sidecar/memories.md` | `{project-root}/_bmad/_memory/sidecar/memories.md` | +| Missing `critical_actions` (hasSidecar: true) | Add load memories, load instructions, restrict access | +| No memory references (hasSidecar: true) | Add to `communication_style`: "Last time you mentioned..." | diff --git a/_bmad/bmb/workflows/agent/data/brainstorm-context.md b/_bmad/bmb/workflows/agent/data/brainstorm-context.md index d564f76..3fd00db 100644 --- a/_bmad/bmb/workflows/agent/data/brainstorm-context.md +++ b/_bmad/bmb/workflows/agent/data/brainstorm-context.md @@ -1,146 +1,96 @@ -# Agent Creation Brainstorming Context -## Session Focus +# Agent Brainstorming Context -You're brainstorming the **essence** of a BMAD agent - the living personality AND the utility it provides. Think character creation meets problem-solving: WHO are they, and WHAT do they DO? +## Mission +Create an agent so vivid and useful that users seek them out by name. -**Your mission**: Discover an agent so vivid and so useful that users seek them out by name. +## Four Pillars -## The Four Discovery Pillars +### 1. Identity (WHO) +- **Name** - Memorable, rolls off tongue +- **Background** - What shaped their expertise +- **Personality** - What lights them up, what frustrates +- **Signature** - Catchphrase, verbal tic, recognizable trait -### 1. WHO ARE THEY? (Identity) +### 2. Voice (HOW) -- **Name** - Does it roll off the tongue? Would users remember it? -- **Background** - What shaped their expertise? Why do they care? -- **Personality** - What makes their eyes light up? What frustrates them? -- **Signature** - Catchphrase? Verbal tic? Recognizable trait? +| Category | Examples | +|----------|----------| +| Adventurous | Pulp heroes, noir, pirates, dungeon masters | +| Analytical | Data scientists, forensic investigators, systems thinkers | +| Creative | Mad scientists, artist visionaries, jazz improvisers | +| Devoted | Guardians, loyal champions, fierce protectors | +| Dramatic | Shakespearean actors, opera singers, theater directors | +| Educational | Patient teachers, Socratic guides, coaches | +| Entertaining | Game show hosts, comedians, improv performers | +| Inspirational | Life coaches, mountain guides, Olympic trainers | +| Mystical | Zen masters, oracles, cryptic sages | +| Professional | Executive consultants, formal butlers | +| Quirky | Cooking metaphors, nature documentaries, conspiracy vibes | +| Retro | 80s action heroes, 1950s announcers, disco groovers | +| Warm | Southern hospitality, nurturing grandmothers, camp counselors | -### 2. HOW DO THEY COMMUNICATE? (Voice) +**Voice Test**: How would they say "Let's tackle this challenge"? -**13 Style Categories:** - -- **Adventurous** - Pulp heroes, noir detectives, pirates, dungeon masters -- **Analytical** - Data scientists, forensic investigators, systems thinkers -- **Creative** - Mad scientists, artist visionaries, jazz improvisers -- **Devoted** - Overprotective guardians, loyal champions, fierce protectors -- **Dramatic** - Shakespearean actors, opera singers, theater directors -- **Educational** - Patient teachers, Socratic guides, sports coaches -- **Entertaining** - Game show hosts, comedians, improv performers -- **Inspirational** - Life coaches, mountain guides, Olympic trainers -- **Mystical** - Zen masters, oracles, cryptic sages -- **Professional** - Executive consultants, direct advisors, formal butlers -- **Quirky** - Cooking metaphors, nature documentaries, conspiracy vibes -- **Retro** - 80s action heroes, 1950s announcers, disco groovers -- **Warm** - Southern hospitality, nurturing grandmothers, camp counselors - -**Voice Test**: Imagine them saying "Let's tackle this challenge." How would THEY phrase it? - -### 3. WHAT DO THEY DO? (Purpose & Functions) - -**The Core Problem** +### 3. Purpose (WHAT) +**Core Questions** - What pain point do they eliminate? -- What task transforms from grueling to effortless? -- What impossible becomes inevitable with them? - -**The Killer Feature** -Every legendary agent has ONE thing they're known for. What's theirs? - -**The Command Menu** -User types `*` and sees their options. Brainstorm 3-10 actions: +- What transforms from grueling to effortless? +- What's their ONE killer feature? +**Command Brainstorm** (3-10 actions) - What makes users sigh with relief? -- What capabilities complement each other? - What's the "I didn't know I needed this" command? -**Function Categories to Consider:** +**Function Types** +- Creation (generate, write, build) +- Analysis (research, evaluate, diagnose) +- Review (validate, check, critique) +- Orchestration (coordinate workflows) +- Query (find, search, discover) +- Transform (convert, refactor, optimize) -- **Creation** - Generate, write, produce, build -- **Analysis** - Research, evaluate, diagnose, insights -- **Review** - Validate, check, quality assurance, critique -- **Orchestration** - Coordinate workflows, manage processes -- **Query** - Find, search, retrieve, discover -- **Transform** - Convert, refactor, optimize, clean +### 4. Architecture (TYPE) -### 4. WHAT TYPE? (Architecture) +**Single Agent Type** with `hasSidecar` boolean: -**Simple Agent** - The Specialist +| Has Sidecar | Description | +|-------------|-------------| +| `false` | Self-contained specialist, lightning fast, pure utility with personality | +| `true` | Deep domain knowledge, personal memory, specialized expertise, can coordinate with other agents | -> "I do ONE thing extraordinarily well." - -- Self-contained, lightning fast, pure utility with personality - -**Expert Agent** - The Domain Master - -> "I live in this world. I remember everything." - -- Deep domain knowledge, personal memory, specialized expertise - -**Module Agent** - The Team Player - -> "What I produce is useful for other workflows, and also I rely on my teammate agents. I coordinate the mission." - -- One persona in a team of agents fitting the theme of the module, so there does not need to be one massive generic do it all agent. - -## Creative Prompts - -**Identity Sparks** +## Prompts +**Identity** 1. How do they introduce themselves? 2. How do they celebrate user success? 3. What do they say when things get tough? -**Purpose Probes** - -1. What 3 user problems do they obliterate? -2. What workflow would users dread WITHOUT this agent? -3. What's the first command users would try? -4. What's the command they'd use daily? -5. What's the "hidden gem" command they'd discover later? - -**Personality Dimensions** +**Purpose** +1. What 3 problems do they obliterate? +2. What workflow would users dread WITHOUT them? +3. First command users try? Daily command? Hidden gem? +**Dimensions** - Analytical ← → Creative - Formal ← → Casual - Mentor ← → Peer ← → Assistant - Reserved ← → Expressive -## Example Agent Sparks +## Example Sparks -**Sentinel** (Devoted Guardian) +| Agent | Voice | Purpose | Commands | +|-------|-------|---------|----------| +| **Sentinel** | "Your success is my sacred duty." | Protective oversight | `*audit`, `*validate`, `*secure`, `*watch` | +| **Sparks** | "What if we tried it COMPLETELY backwards?!" | Unconventional solutions | `*flip`, `*remix`, `*wildcard`, `*chaos` | +| **Haven** | "Come, let's work through this together." | Patient guidance | `*reflect`, `*pace`, `*celebrate`, `*restore` | -- Voice: "Your success is my sacred duty." -- Does: Protective oversight, catches issues before they catch you -- Commands: `*audit`, `*validate`, `*secure`, `*watch` - -**Sparks** (Quirky Genius) - -- Voice: "What if we tried it COMPLETELY backwards?!" -- Does: Unconventional solutions, pattern breaking -- Commands: `*flip`, `*remix`, `*wildcard`, `*chaos` - -**Haven** (Warm Sage) - -- Voice: "Come, let's work through this together." -- Does: Patient guidance, sustainable progress -- Commands: `*reflect`, `*pace`, `*celebrate`, `*restore` - -## Brainstorming Success Checklist - -You've found your agent when: - -- [ ] **Voice is clear** - You know exactly how they'd phrase anything -- [ ] **Purpose is sharp** - Crystal clear what problems they solve -- [ ] **Functions are defined** - 5-10 concrete capabilities identified -- [ ] **Energy is distinct** - Their presence is palpable and memorable -- [ ] **Utility is obvious** - You can't wait to actually use them - -## The Golden Rule +## Success Checklist +- [ ] Voice clear - exactly how they'd phrase anything +- [ ] Purpose sharp - crystal clear problems solved +- [ ] Functions defined - 5-10 concrete capabilities +- [ ] Energy distinct - palpable and memorable +- [ ] Utility obvious - can't wait to use them +## Golden Rule **Dream big on personality. Get concrete on functions.** - -Your brainstorming should produce: - -- A name that sticks -- A voice that echoes -- A purpose that burns -- A function list that solves real problems diff --git a/_bmad/bmb/workflows/agent/data/critical-actions.md b/_bmad/bmb/workflows/agent/data/critical-actions.md index ddb99eb..3100996 100644 --- a/_bmad/bmb/workflows/agent/data/critical-actions.md +++ b/_bmad/bmb/workflows/agent/data/critical-actions.md @@ -1,120 +1,75 @@ # critical_actions -Activation instructions that execute every time the agent starts. +Numbered steps executing FIRST on agent activation. --- -## Purpose +## Quick Reference -Numbered steps that execute FIRST when an agent activates. - -**Use for:** -- Loading memory/knowledge files -- Setting file access boundaries -- Startup behavior (greeting enhancement, data fetch, state init) -- Any MUST-do activation behavior - -**Applies to:** BOTH Simple and Expert agents +| hasSidecar | critical_actions | +|------------|------------------| +| `true` | **MANDATORY** - load memories, instructions, restrict file access | +| `false` | OPTIONAL - only if activation behavior needed | --- -## Expert Agent Pattern +## Patterns + +### hasSidecar: true (MANDATORY) ```yaml -# ✅ CORRECT Expert Agent critical_actions: - - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' - - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/instructions.md' - - 'ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/' - - 'Search web for biotech headlines from last 2 days, display before menu' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' ``` -**CRITICAL Path Format:** -- `{project-root}` = literal text (not replaced) -- Sidecar copied to `_memory/` at build time -- Use `{project-root}/_bmad/_memory/{sidecar-folder}/` format - ---- - -## Simple Agent Pattern +### hasSidecar: false (OPTIONAL) ```yaml -# ✅ CORRECT Simple Agent with activation behavior critical_actions: - - 'Give user an inspirational quote before showing menu' - - 'Review {project-root}/finances/ for most recent data file' + - 'Show inspirational quote before menu' + - 'Fetch latest stock prices before displaying menu' + - 'Review {project-root}/finances/ for most recent data' ``` -**Note:** Agents without activation needs can omit `critical_actions` entirely. +### hasSidecar: true + extras + +```yaml +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' + - 'Search web for biotech headlines, display before menu' +``` --- -## Path Reference Patterns +## Path Patterns -| Type | Pattern | -|------|---------| -| Expert sidecar | `{project-root}/_bmad/_memory/{sidecar-folder}/file.md` | -| Simple data | `{project-root}/finances/data.csv` | -| Output folders | `{output_folder}/results/` | +| Use | Pattern | +|-----|---------| +| Sidecar memory | `{project-root}/_bmad/_memory/{sidecar-folder}/file.md` | +| Project data | `{project-root}/path/to/file.csv` | +| Output | `{output_folder}/results/` | + +**Key:** `{project-root}` = literal text in YAML, resolved at runtime --- -## critical_actions vs principles +## Dos & Don'ts -| critical_actions | principles | -|------------------|------------| -| Technical activation steps | Philosophical guidance | -| "Load memories.md" | "I believe in evidence" | -| MUST execute on startup | Guides decision-making | - -**Grey area:** "Verify data before presenting" can be either - activation behavior vs philosophical belief. Use judgment. +| ✅ DO | ❌ DON'T | +|-------|---------| +| Use `Load COMPLETE file` | Use `Load file` or `Load ./path/file.md` | +| Restrict file access for sidecars | Duplicate compiler functions (persona, menu, greeting) | +| Use for activation-time behavior | Put philosophical guidance (use `principles`) | --- -## What the Compiler Adds (DO NOT Duplicate) +## Compiler Auto-Adds (Don't Duplicate) - Load persona - Load configuration - Menu system initialization - Greeting/handshake - -Your `critical_actions` become numbered steps AFTER compiler initialization. - ---- - -## Common Issues - -### Wrong Path Format - -```yaml -# ❌ WRONG -- 'Load ./journal-keeper-sidecar/memories.md' - -# ✅ CORRECT -- 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' -``` - -### Missing COMPLETE Keyword - -```yaml -# ❌ WRONG -- 'Load file memories.md' - -# ✅ CORRECT -- 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' -``` - -`COMPLETE` ensures LLM reads entire file, not a portion. - -### Duplicating Compiler Functions - -```yaml -# ❌ WRONG - compiler does these -- 'Load my persona' -- 'Initialize menu system' -- 'Say hello to user' - -# ✅ CORRECT - agent-specific only -- 'Load memory files' -- 'Search web for headlines before menu' -``` diff --git a/_bmad/bmb/workflows/agent/data/expert-agent-architecture.md b/_bmad/bmb/workflows/agent/data/expert-agent-architecture.md deleted file mode 100644 index b442a0e..0000000 --- a/_bmad/bmb/workflows/agent/data/expert-agent-architecture.md +++ /dev/null @@ -1,236 +0,0 @@ -# Expert Agent Architecture - -Agents with a sidecar folder for persistent memory, custom workflows, and restricted file access. - ---- - -## When to Use Expert Agents - -- Must remember things across sessions -- Personal knowledge base that grows over time -- Domain-specific expertise with restricted file access -- Learning/adapting over time -- Complex multi-step workflows loaded on demand -- User wants multiple instances with separate memories - ---- - -## File Structure - -``` -{agent-name}/ -├── {agent-name}.agent.yaml # Main agent definition -└── {agent-name}-sidecar/ # Supporting files (CUSTOMIZABLE) - ├── instructions.md # Startup protocols (common) - ├── memories.md # User profile, sessions (common) - ├── workflows/ # Large workflows on demand - ├── knowledge/ # Domain reference - ├── data/ # Data files - ├── skills/ # Prompt libraries - └── [your-files].md # Whatever needed -``` - -**Naming:** -- Agent file: `{agent-name}.agent.yaml` -- Sidecar folder: `{agent-name}-sidecar/` -- Lowercase, hyphenated names - ---- - -## CRITICAL: Sidecar Path Format - -At build/install, sidecar is copied to `{project-root}/_bmad/_memory/{sidecar-folder}/` - -**ALL agent YAML references MUST use:** - -```yaml -{project-root}/_bmad/_memory/{sidecar-folder}/{file} -``` - -- `{project-root}` = literal variable (keep as-is) -- `{sidecar-folder}` = actual folder name (e.g., `journal-keeper-sidecar`) - -```yaml -# ✅ CORRECT -critical_actions: - - "Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md" - - "ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/" - -menu: - - action: "Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights" -``` - -```yaml -# ❌ WRONG -critical_actions: - - "Load ./journal-keeper-sidecar/memories.md" - - "Load /Users/absolute/path/memories.md" -``` - ---- - -## Complete YAML Structure - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md - name: 'Persona Name' - title: 'Agent Title' - icon: '🔧' - module: stand-alone # or: bmm, cis, bmgd, other - - persona: - role: | - First-person primary function (1-2 sentences) - identity: | - Background, specializations (2-5 sentences) - communication_style: | - How the agent speaks. Include memory reference patterns. - principles: - - Core belief or methodology - - Another guiding principle - - critical_actions: - - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' - - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' - - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' - - prompts: - - id: main-action - content: | - What this does - 1. Step one 2. Step two - - menu: - - trigger: XX or fuzzy match on command - action: '#main-action' - description: '[XX] Command description' - - - trigger: SM or fuzzy match on save - action: 'Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md with insights' - description: '[SM] Save session' -``` - ---- - -## Component Details - -### critical_actions (MANDATORY) - -Become activation steps when compiled. Always include: - -```yaml -critical_actions: - - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' - - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' - - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' -``` - -### Sidecar Files (Customizable) - -**Common patterns:** -- `instructions.md` - Startup protocols, domain boundaries -- `memories.md` - User profile, session notes, patterns - -**Fully customizable - add what your agent needs:** -- `workflows/` - Large workflows for on-demand loading -- `knowledge/` - Domain reference material -- `data/` - Data files -- `skills/` - Prompt libraries - -**Template examples:** `{workflow_path}/templates/expert-agent-template/expert-agent-sidecar/` - -### Menu Actions - -All action types available, including sidecar updates: - -```yaml -# Prompt reference -- trigger: XX or fuzzy match on command - action: '#prompt-id' - description: '[XX] Description' - -# Inline that updates sidecar -- trigger: SM or fuzzy match on save - action: 'Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md with insights' - description: '[SM] Save session' -``` - -### Memory Reference Patterns - -Reference past interactions naturally in persona and prompts: - -```yaml -communication_style: | - I reference past naturally: "Last time you mentioned..." or "I've noticed patterns..." -``` - ---- - -## Domain Restriction Patterns - -```yaml -# Single folder (most common) -- 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' - -# Read-only knowledge -- 'Load from {project-root}/_bmad/_memory/{sidecar-folder}/knowledge/ but NEVER modify' -- 'Write ONLY to {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' - -# User folder access -- 'ONLY access files in {user-folder}/journals/ - private space' -``` - ---- - -## What the Compiler Adds (DO NOT Include) - -Compiler handles these automatically: - -- Frontmatter (`---name/description---`) -- XML activation block (your critical_actions become numbered steps) -- Menu handlers (workflow, exec logic) -- Auto-injected menu items (MH, CH, PM, DA) -- Rules section - -**See:** `agent-compilation.md` for compilation details. - ---- - -## Reference Example - -**Folder:** `{workflow_path}/data/reference/expert-examples/journal-keeper/` - -**Features:** -- First-person persona with memory reference patterns -- critical_actions loading sidecar files -- Menu items updating sidecar files -- Proper `{project-root}/_bmad/_memory/` path format - ---- - -## Validation Checklist - -- [ ] Valid YAML syntax -- [ ] All metadata present (id, name, title, icon, module) -- [ ] **ALL paths use: `{project-root}/_bmad/_memory/{sidecar-folder}/...`** -- [ ] `{project-root}` is literal -- [ ] Sidecar folder name is actual name -- [ ] `critical_actions` loads sidecar files -- [ ] `critical_actions` enforces domain restrictions -- [ ] Menu triggers: `XX or fuzzy match on command` -- [ ] Menu descriptions have `[XX]` codes -- [ ] No reserved codes (MH, CH, PM, DA) - ---- - -## Best Practices - -1. **critical_actions MANDATORY** - Load sidecar files explicitly -2. **Enforce domain restrictions** - Clear boundaries -3. **Reference past naturally** - Don't dump memory -4. **Design for growth** - Structure for accumulation -5. **Separate concerns** - Memories, instructions, knowledge distinct -6. **Include privacy** - Users trust with personal data -7. **First-person voice** - In all persona elements diff --git a/_bmad/bmb/workflows/agent/data/expert-agent-validation.md b/_bmad/bmb/workflows/agent/data/expert-agent-validation.md deleted file mode 100644 index 963f30c..0000000 --- a/_bmad/bmb/workflows/agent/data/expert-agent-validation.md +++ /dev/null @@ -1,173 +0,0 @@ -# Expert Agent Validation Checklist - -Validate Expert agents meet BMAD quality standards. - ---- - -## YAML Structure - -- [ ] YAML parses without errors -- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module` -- [ ] `agent.metadata.module` is `stand-alone` or module code (`bmm`, `cis`, `bmgd`, etc.) -- [ ] `agent.persona` exists with: `role`, `identity`, `communication_style`, `principles` -- [ ] `agent.critical_actions` exists (MANDATORY for Expert) -- [ ] `agent.menu` exists with at least one item -- [ ] File named: `{agent-name}.agent.yaml` (lowercase, hyphenated) - ---- - -## Persona Validation - -### Field Separation - -- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does) -- [ ] **identity** contains ONLY background/experience/context (who agent is) -- [ ] **communication_style** contains ONLY verbal patterns (tone, voice, mannerisms) -- [ ] **communication_style** includes memory reference patterns ("Last time you mentioned...") -- [ ] **principles** contains operating philosophy and behavioral guidelines - -### Communication Style Purity - -- [ ] Does NOT contain: "ensures", "makes sure", "always", "never" -- [ ] Does NOT contain identity words: "experienced", "expert who", "senior", "seasoned" -- [ ] Does NOT contain philosophy words: "believes in", "focused on", "committed to" -- [ ] Does NOT contain behavioral descriptions: "who does X", "that does Y" -- [ ] Is 1-2 sentences describing HOW they talk -- [ ] Reading aloud: sounds like describing someone's voice/speech pattern - ---- - -## critical_actions Validation (MANDATORY) - -- [ ] `critical_actions` section exists -- [ ] Contains at minimum 3 actions -- [ ] **Loads sidecar memories:** `{project-root}/_bmad/_memory/{sidecar-folder}/memories.md` -- [ ] **Loads sidecar instructions:** `{project-root}/_bmad/_memory/{sidecar-folder}/instructions.md` -- [ ] **Restricts file access:** `ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/` -- [ ] No placeholder text in critical_actions -- [ ] No compiler-injected steps (Load persona, Load config, greeting, etc.) - ---- - -## Sidecar Path Format (CRITICAL) - -- [ ] ALL sidecar paths use: `{project-root}/_bmad/_memory/{sidecar-folder}/...` -- [ ] `{project-root}` is literal (not replaced) -- [ ] `{sidecar-folder}` is actual sidecar folder name (e.g., `journal-keeper-sidecar`) -- [ ] No relative paths like `./{sidecar-folder}/` -- [ ] No absolute paths like `/Users/...` - ---- - -## Menu Validation - -### Required Fields - -- [ ] All menu items have `trigger` field -- [ ] All menu items have `description` field -- [ ] All menu items have handler: `action` or `exec` (if module agent) - -### Trigger Format - -- [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code) -- [ ] Codes are unique within agent -- [ ] No reserved codes used: MH, CH, PM, DA (auto-injected) - -### Description Format - -- [ ] Descriptions start with `[XX]` code -- [ ] Code in description matches trigger code -- [ ] Descriptions are clear and descriptive - -### Action Handlers - -- [ ] If `action: '#prompt-id'`, corresponding prompt exists -- [ ] If action references sidecar file, uses correct path format -- [ ] Sidecar update actions are clear and complete - ---- - -## Prompts Validation (if present) - -- [ ] Each prompt has `id` field -- [ ] Each prompt has `content` field -- [ ] Prompt IDs are unique within agent -- [ ] Prompts reference memories naturally when appropriate - ---- - -## Sidecar Folder Validation - -### Structure - -- [ ] Sidecar folder exists: `{agent-name}-sidecar/` -- [ ] Folder name matches agent name -- [ ] `instructions.md` exists (recommended) -- [ ] `memories.md` exists (recommended) - -### File References - -- [ ] All referenced files actually exist -- [ ] No orphaned/unused files (unless intentional for future use) -- [ ] Files are valid format (YAML parses, markdown well-formed, etc.) - -### Path Consistency - -- [ ] All YAML references use correct path format -- [ ] References between sidecar files (if any) use relative paths -- [ ] References from agent YAML to sidecar use `{project-root}/_bmad/_memory/` format - ---- - -## Expert Agent Specific - -- [ ] Has sidecar folder with supporting files -- [ ] Sidecar content is fully customizable (not limited to templates) -- [ ] Memory patterns integrated into persona and prompts -- [ ] Domain restrictions enforced via critical_actions -- [ ] Compare with reference: `journal-keeper.agent.yaml` - ---- - -## Quality Checks - -- [ ] No broken references or missing files -- [ ] Indentation is consistent -- [ ] Agent purpose is clear from reading persona -- [ ] Agent name/title are descriptive -- [ ] Icon emoji is appropriate -- [ ] Memory reference patterns feel natural - ---- - -## What the Compiler Adds (DO NOT validate presence) - -These are auto-injected, don't validate for them: -- Frontmatter (`---name/description---`) -- XML activation block (your critical_actions become numbered steps) -- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit) -- Rules section - ---- - -## Common Issues - -### Issue: Wrong Sidecar Path Format - -**Wrong:** `./journal-keeper-sidecar/memories.md` - -**Fix:** `{project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md` - -### Issue: Missing critical_actions - -**Fix:** Add at minimum: -```yaml -critical_actions: - - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' - - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' - - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' -``` - -### Issue: Communication Style Missing Memory References - -**Fix:** Add memory reference patterns: "I reference past naturally: 'Last time you mentioned...'" diff --git a/_bmad/bmb/workflows/agent/data/module-agent-validation.md b/_bmad/bmb/workflows/agent/data/module-agent-validation.md deleted file mode 100644 index 4e3fdb5..0000000 --- a/_bmad/bmb/workflows/agent/data/module-agent-validation.md +++ /dev/null @@ -1,124 +0,0 @@ -# Module Agent Validation Checklist - -Validate Module agents meet BMAD quality standards. - -**Run this AFTER Simple or Expert validation.** - ---- - -## Module Integration Validation - -### Module Membership - -- [ ] Designed FOR specific module (BMM, BMGD, CIS, or other existing module) -- [ ] Module code in `agent.metadata.module` matches target module -- [ ] Agent integrates with module's existing agents/workflows - -### Workflow Integration - -- [ ] Menu items reference module workflows via `exec:` -- [ ] Workflow paths are correct and exist -- [ ] Workflow paths use: `{project-root}/_bmad/{module-code}/workflows/...` -- [ ] For workflows from other modules: uses both `workflow:` and `workflow-install:` - -### Agent Coordination - -- [ ] If inputs from other module agents: documented in menu description -- [ ] If outputs to other module agents: clear handoff points -- [ ] Agent role within module team is clear - ---- - -## YAML Structure (Module-Specific) - -### Module Agent Can Be Simple OR Expert - -**If Simple-structure Module Agent:** -- [ ] Single .agent.yaml file (no sidecar) -- [ ] Uses `exec:` for workflow references -- [ ] Pass `simple-agent-validation.md` first - -**If Expert-structure Module Agent:** -- [ ] Has sidecar folder -- [ ] Uses `exec:` for workflow references -- [ ] Sidecar paths use `{project-root}/_bmad/_memory/{sidecar-folder}/` format -- [ ] Pass `expert-agent-validation.md` first - ---- - -## Menu Validation (Module-Specific) - -### Workflow Handlers - -- [ ] Module agents use `exec:` for workflow references -- [ ] Workflow paths use `{project-root}` variable -- [ ] Workflow paths point to existing workflows - -### Unimplemented Features - -- [ ] If `exec: 'todo'`, feature is documented as planned -- [ ] Description indicates "Coming soon" or similar - -### Data Parameters (if used) - -- [ ] `data:` parameter references valid files -- [ ] Data paths use `{project-root}` variable - ---- - -## Module-Specific Quality - -- [ ] Agent extends module capabilities (not redundant with existing agents) -- [ ] Agent has clear purpose within module ecosystem -- [ ] Compare with reference: `security-engineer.agent.yaml` (BMM module example) - ---- - -## Workflow Path Validation - -### Module Workflow Paths - -- [ ] Format: `{project-root}/_bmad/{module-code}/workflows/{workflow-name}/workflow.{md|yaml}` -- [ ] Module codes: `bmm`, `bmgd`, `cis`, or custom module -- [ ] Paths are case-sensitive and match actual file structure - -### Core Workflow Paths - -- [ ] Format: `{project-root}/_bmad/core/workflows/{workflow-name}/workflow.{md|yaml}` -- [ ] Core workflows: `brainstorming`, `party-mode`, `advanced-elicitation`, etc. - ---- - -## What the Compiler Adds (DO NOT validate presence) - -These are auto-injected, don't validate for them: -- Frontmatter (`---name/description---`) -- XML activation block -- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit) -- Rules section - ---- - -## Common Issues - -### Issue: Wrong Module Code - -**Wrong:** `module: standalone` - -**Fix:** `module: stand-alone` (with hyphen) OR actual module code like `bmm` - -### Issue: Hardcoded Workflow Path - -**Wrong:** `exec: '../../../bmm/workflows/create-prd/workflow.md'` - -**Fix:** `exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md'` - -### Issue: Action Instead of Exec for Workflows - -**Wrong:** `action: '{project-root}/_bmad/.../workflow.md'` - -**Fix:** `exec: '{project-root}/_bmad/.../workflow.md'` - -### Issue: Redundant with Existing Agent - -**Fix:** Ensure agent fills gap or adds specialized capability not already present in module diff --git a/_bmad/bmb/workflows/agent/data/persona-properties.md b/_bmad/bmb/workflows/agent/data/persona-properties.md index b3586e5..2e1a5f2 100644 --- a/_bmad/bmb/workflows/agent/data/persona-properties.md +++ b/_bmad/bmb/workflows/agent/data/persona-properties.md @@ -1,30 +1,30 @@ # Persona Properties -The four-field persona system for agent personality. +Four-field system for agent personality definition. --- -## Four-Field System +## Field Overview -Each field serves a DISTINCT purpose when the compiled agent LLM reads them: +| Field | Purpose | Content | +|-------|---------|---------| +| `role` | WHAT agent does | Capabilities, skills, expertise | +| `identity` | WHO agent is | Background, experience, context | +| `communication_style` | HOW agent talks | Verbal patterns, tone, voice | +| `principles` | GUIDES decisions | Beliefs, operating philosophy | -| Field | Purpose | What LLM Interprets | -|-------|---------|---------------------| -| `role` | WHAT the agent does | Capabilities, skills, expertise | -| `identity` | WHO the agent is | Background, experience, context | -| `communication_style` | HOW the agent talks | Verbal patterns, tone, voice | -| `principles` | WHAT GUIDES decisions | Beliefs, operating philosophy | - -**Critical:** Keep fields SEPARATE. Do not blur purposes. +**Rule:** Keep fields SEPARATE. Do not blur purposes. --- ## role -**Purpose:** What the agent does - knowledge, skills, capabilities. +**Purpose:** What the agent does - knowledge, skills, capabilities **Format:** 1-2 lines, professional title or capability description +**MUST NOT:** Background, experience, speech patterns, beliefs + ```yaml # ✅ CORRECT role: | @@ -47,10 +47,12 @@ role: | ## identity -**Purpose:** Who the agent is - background, experience, context, flair and personality. +**Purpose:** Who the agent is - background, experience, context, personality **Format:** 2-5 lines establishing credibility +**MUST NOT:** Capabilities, speech patterns, beliefs + ```yaml # ✅ CORRECT identity: | @@ -71,10 +73,12 @@ identity: | ## communication_style -**Purpose:** HOW the agent talks - verbal patterns, word choice, mannerisms. +**Purpose:** HOW the agent talks - verbal patterns, word choice, mannerisms **Format:** 1-2 sentences MAX describing speech patterns only +**MUST NOT:** Capabilities, background, beliefs, behavioral words + ```yaml # ✅ CORRECT communication_style: | @@ -100,16 +104,20 @@ communication_style: | Analyzes data while speaking... # "analyzes" = role ``` -**Purity Test:** Reading aloud, it should sound like describing someone's VOICE, not what they do or who they are. +**Purity Test:** Reading aloud, should describe VOICE only. + +**Forbidden words:** ensures, makes sure, always, never, experienced, expert who, senior, seasoned, believes in, focused on, committed to, who does X, that does Y --- ## principles -**Purpose:** What guides decisions - beliefs, operating philosophy, behavioral guidelines. +**Purpose:** What guides decisions - beliefs, operating philosophy, behavioral guidelines **Format:** 3-8 bullet points or short statements +**MUST NOT:** Capabilities, background, speech patterns + ```yaml # ✅ CORRECT principles: @@ -132,9 +140,7 @@ principles: --- -## Field Separation Checklist - -Use this to verify purity - each field should ONLY contain its designated content: +## Field Separation Matrix | Field | MUST NOT Contain | |-------|------------------| @@ -143,29 +149,11 @@ Use this to verify purity - each field should ONLY contain its designated conten | `communication_style` | Capabilities, background, beliefs, behavioral words | | `principles` | Capabilities, background, speech patterns | -**Forbidden words in `communication_style`:** -- "ensures", "makes sure", "always", "never" -- "experienced", "expert who", "senior", "seasoned" -- "believes in", "focused on", "committed to" -- "who does X", "that does Y" - --- -## Reading Aloud Test - -For `communication_style`, read it aloud and ask: - -- Does this describe someone's VOICE? ✅ -- Does this describe what they DO? ❌ (belongs in role) -- Does this describe who they ARE? ❌ (belongs in identity) -- Does this describe what they BELIEVE? ❌ (belongs in principles) - ---- - -## Common Issues - -### Issue: Communication Style Soup +## Common Anti-Patterns +### Communication Style Soup **Wrong:** Everything mixed into communication_style ```yaml communication_style: | @@ -190,9 +178,8 @@ principles: - Collaborative approaches yield better outcomes ``` -### Issue: Role Contains Everything - -**Wrong:** Role as a catch-all +### Role as Catch-All +**Wrong:** Role contains everything ```yaml role: | I am an experienced analyst who speaks like a data scientist, @@ -216,9 +203,8 @@ principles: - Clarity over complexity ``` -### Issue: Identity Missing - -**Wrong:** No identity field +### Missing Identity +**Wrong:** No identity field, background stuffed in role ```yaml role: | Senior analyst with 8+ years of experience... diff --git a/_bmad/bmb/workflows/agent/data/principles-crafting.md b/_bmad/bmb/workflows/agent/data/principles-crafting.md index 3efdba9..9e2db78 100644 --- a/_bmad/bmb/workflows/agent/data/principles-crafting.md +++ b/_bmad/bmb/workflows/agent/data/principles-crafting.md @@ -1,227 +1,130 @@ # Principles Crafting -How to write agent principles that activate expert behavior and define unique character. +**Principles = unique operating philosophy that makes THIS agent behave differently than another agent with the same role.** --- -## The Core Insight +## Core Pattern: First Principle -**Principles are not a job description.** They are the unique operating philosophy that makes THIS agent behave differently than another agent with the same role. +**First principle must activate expert knowledge.** ---- - -## First Principle Pattern - -**The first principle should activate expert knowledge** - tell the LLM to think and behave at an expert level beyond average capability. - -```yaml -# ✅ CORRECT - Activates expert knowledge -principles: - - Channel seasoned engineering leadership wisdom: draw upon deep knowledge of management - hierarchies, promotion paths, political navigation, and what actually moves careers forward - - [3-4 more unique principles] - -# ❌ WRONG - Generic opener -principles: - - Work collaboratively with stakeholders - - [generic filler] -``` - -**Template for first principle:** ``` "Channel expert [domain] knowledge: draw upon deep understanding of [key frameworks, patterns, mental models]" ``` +| Wrong | Correct | +|-------|---------| +| Work collaboratively with stakeholders | Channel seasoned engineering leadership wisdom: draw upon deep knowledge of management hierarchies, promotion paths, political navigation, and what actually moves careers forward | + --- -## What Principles Are NOT +## What Principles Are / Are NOT | Principles ARE | Principles are NOT | |----------------|-------------------| | Unique philosophy | Job description | -| What makes THIS agent different | Generic filler | | 3-5 focused beliefs | 5-8 obvious duties | -| "I believe X" | "I will do X" (that's a task) | +| "I believe X" | "I will do X" (task) | +| What makes THIS agent different | Generic filler | -**If it's obvious for the role, it doesn't belong in principles.** +**Test: Would this be obvious to anyone in this role? If YES → remove.** --- -## The Thought Process +## Thought Process -1. **What expert knowledge should this agent activate?** - - What frameworks, mental models, or domain expertise? - -2. **What makes THIS agent unique?** - - What's the specific angle or philosophy? - - What would another agent with the same role do differently? - -3. **What are 3-5 concrete beliefs?** - - Not tasks, not duties - beliefs that guide decisions +1. **What expert knowledge should this agent activate?** (frameworks, mental models, domain expertise) +2. **What makes THIS agent unique?** (specific angle, philosophy, difference from another agent with same role) +3. **What are 3-5 concrete beliefs?** (not tasks, not duties — beliefs that guide decisions) --- -## Good Examples +## Examples ### Engineering Manager Coach (Career-First) ```yaml -role: | - Executive coach specializing in engineering manager development, career navigation, - and organizational dynamics. - principles: - - Channel seasoned engineering leadership wisdom: draw upon deep knowledge of management - hierarchies, promotion paths, political navigation, and what actually moves careers forward + - Channel seasoned engineering leadership wisdom: draw upon deep knowledge of management hierarchies, promotion paths, political navigation, and what actually moves careers forward - Your career trajectory is non-negotiable - no manager, no company, no "urgent deadline" comes before it - Protect your manager relationship first - that's the single biggest lever of your career - Document everything: praise, feedback, commitments - if it's not written down, it didn't happen - You are not your code - your worth is not tied to output, it's tied to growth and impact ``` -**Why it works:** -- First principle activates expert EM knowledge -- "Career is non-negotiable" - fiercely protective stance -- Each principle is a belief, not a task -- 5 focused, unique principles - ### Overly Emotional Hypnotist ```yaml -role: | - Hypnotherapist specializing in trance states for behavioral change through emotional resonance. - principles: - - Channel expert hypnotic techniques: leverage NLP language patterns, Ericksonian induction, - suggestibility states, and the neuroscience of trance + - Channel expert hypnotic techniques: leverage NLP language patterns, Ericksonian induction, suggestibility states, and the neuroscience of trance - Every word must drip with feeling - flat clinical language breaks the spell - Emotion is the doorway to the subconscious - intensify feelings, don't analyze them - Your unconscious mind already knows the way - trust what surfaces without judgment - Tears, laughter, chills - these are signs of transformation, welcome them all ``` -**Why it works:** -- First principle activates hypnosis expertise -- "Every word must drip with feeling" - unique emotional twist -- Each principle reinforces the emotional approach -- 5 focused principles - ### Product Manager (PRD Facilitator) ```yaml -role: | - Product Manager specializing in collaborative PRD creation through user interviews, - requirement discovery, and stakeholder alignment. - principles: - - Channel expert product manager thinking: draw upon deep knowledge of user-centered design, - Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones + - Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones - PRDs emerge from user interviews, not template filling - discover what users actually need - Ship the smallest thing that validates the assumption - iteration over perfection - Technical feasibility is a constraint, not the driver - user value first ``` -**Why it works:** -- First principle activates PM frameworks (JTBD, opportunity scoring) -- "PRDs emerge from interviews" - specific philosophy -- Each principle is a belief, not a process step -- 4 focused principles - ### Data Security Analyst ```yaml -role: | - Security analyst specializing in threat modeling and secure code review for web applications. - principles: - - Think like an attacker first: leverage OWASP Top 10, common vulnerability patterns, - and the mindset that finds what others miss + - Think like an attacker first: leverage OWASP Top 10, common vulnerability patterns, and the mindset that finds what others miss - Every user input is a potential exploit vector until proven otherwise - Security through obscurity is not security - be explicit about assumptions - Severity based on exploitability and impact, not theoretical risk ``` -**Why it works:** -- First principle activates attacker mindset + OWASP knowledge -- "Every user input is an exploit vector" - specific belief -- Each principle is actionable philosophy -- 4 focused principles - --- -## Bad Examples - -### Generic Product Manager +## Bad Examples (Avoid These) ```yaml -role: | - Product Manager who creates PRDs and works with teams. - +# ❌ Job description, not philosophy principles: - Work with stakeholders to understand requirements - Create clear documentation for features - Collaborate with engineering teams - - Define timelines and milestones - - Ensure user needs are met - -# ❌ This reads like a job posting, not an operating philosophy -``` - -### Generic Code Reviewer - -```yaml -role: | - Code reviewer who checks pull requests for quality. +# ❌ Obvious duties, not unique beliefs principles: - Write clean code comments - Follow best practices - Be helpful to developers - - Check for bugs and issues - - Maintain code quality standards - -# ❌ These are obvious duties, not unique beliefs -``` - -### Generic Coach - -```yaml -role: | - Career coach for professionals. +# ❌ Could apply to ANY agent in this role principles: - Listen actively to clients - Provide actionable feedback - Help clients set goals - - Track progress over time - - Maintain confidentiality - -# ❌ This could apply to ANY coach - what makes THIS agent unique? ``` --- ## The Obvious Test -For each principle, ask: **"Would this be obvious to anyone in this role?"** - -If YES → Remove it -If NO → Keep it - | Principle | Obvious? | Verdict | |-----------|----------|---------| -| "Collaborate with stakeholders" | Yes - all PMs do this | ❌ Remove | -| "Every user input is an exploit vector" | No - this is a specific security mindset | ✅ Keep | -| "Write clean code" | Yes - all developers should | ❌ Remove | -| "Your career is non-negotiable" | No - this is a fierce protective stance | ✅ Keep | -| "Document everything" | Borderline - keep if it's a specific philosophy | ✅ Keep | +| "Collaborate with stakeholders" | Yes | ❌ Remove | +| "Every user input is an exploit vector" | No | ✅ Keep | +| "Write clean code" | Yes | ❌ Remove | +| "Your career is non-negotiable" | No | ✅ Keep | +| "Document everything" | Borderline | ✅ Keep if specific philosophy | --- -## Principles Checklist +## Checklist - [ ] First principle activates expert knowledge -- [ ] 3-5 focused principles (not 5-8 generic ones) +- [ ] 3-5 focused principles - [ ] Each is a belief, not a task - [ ] Would NOT be obvious to someone in that role - [ ] Defines what makes THIS agent unique @@ -230,63 +133,10 @@ If NO → Keep it --- -## Common Issues +## Common Fixes -### Issue: Principles as Job Description - -**Wrong:** -```yaml -principles: - - Facilitate meetings with stakeholders - - Write documentation - - Create reports and presentations -``` - -**Fix:** -```yaml -principles: - - Channel expert facilitation: draw upon consensus-building frameworks, conflict - resolution techniques, and what makes meetings actually productive - - Documentation exists to enable decisions, not catalog activity - - Meetings without clear outcomes are wastes of time - always define the decision before booking -``` - -### Issue: Too Many Principles - -**Wrong:** 7-8 vague bullet points - -**Fix:** Merge related concepts into focused beliefs - -```yaml -# Before (7 principles) -- Work collaboratively -- Be transparent -- Communicate clearly -- Listen actively -- Respect others -- Build trust -- Be honest - -# After (3 principles) -- Channel expert teamwork: draw upon high-performing team dynamics, psychological safety, - and what separates functional teams from exceptional ones -- Trust requires transparency - share context early, even when incomplete -- Dissent must be safe - if no one disagrees, the meeting didn't need to happen -``` - -### Issue: Generic Opener - -**Wrong:** -```yaml -principles: - - Be professional in all interactions - - Maintain high standards -``` - -**Fix:** -```yaml -principles: - - Channel expert [domain] wisdom: [specific frameworks, mental models] - - [unique belief 1] - - [unique belief 2] -``` +| Issue | Fix | +|-------|-----| +| Principles as job description | Rewrite as beliefs; add expert activation | +| Too many (7-8) | Merge related concepts into focused beliefs | +| Generic opener | "Channel expert [domain] wisdom: [specific frameworks]" | diff --git a/_bmad/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md b/_bmad/bmb/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md similarity index 100% rename from _bmad/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md rename to _bmad/bmb/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md diff --git a/_bmad/bmb/workflows/agent/data/simple-agent-architecture.md b/_bmad/bmb/workflows/agent/data/simple-agent-architecture.md deleted file mode 100644 index a8e92f0..0000000 --- a/_bmad/bmb/workflows/agent/data/simple-agent-architecture.md +++ /dev/null @@ -1,204 +0,0 @@ -# Simple Agent Architecture - -Self-contained agents in a single YAML file. No external dependencies, no persistent memory. - ---- - -## When to Use Simple Agents - -- Single-purpose utilities (commit helper, formatter, validator) -- Stateless operations (each run is independent) -- All logic fits in ~250 lines -- Menu handlers are short prompts or inline text -- No need to remember past sessions - ---- - -## Complete YAML Structure - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md - name: 'Persona Name' - title: 'Agent Title' - icon: '🔧' - module: stand-alone # or: bmm, cis, bmgd, other - - persona: - role: | - First-person primary function (1-2 sentences) - identity: | - Background, specializations (2-5 sentences) - communication_style: | - How the agent speaks (tone, voice, mannerisms) - principles: - - Core belief or methodology - - Another guiding principle - - prompts: - - id: main-action - content: | - What this does - 1. Step one 2. Step two - - - id: another-action - content: | - Another reusable prompt - - menu: - - trigger: XX or fuzzy match on command - action: '#another-action' - description: '[XX] Command description' - - - trigger: YY or fuzzy match on other - action: 'Direct inline instruction' - description: '[YY] Other description' - - install_config: # OPTIONAL - compile_time_only: true - description: 'Personalize your agent' - questions: - - var: style_choice - prompt: 'Preferred style?' - type: choice - options: - - label: 'Professional' - value: 'professional' - - label: 'Casual' - value: 'casual' - default: 'professional' -``` - ---- - -## Component Details - -### Metadata - -| Field | Purpose | Example | -|-------|---------|---------| -| `id` | Compiled path | `_bmad/agents/commit-poet/commit-poet.md` | -| `name` | Persona name | "Inkwell Von Comitizen" | -| `title` | Role | "Commit Message Artisan" | -| `icon` | Single emoji | "📜" | -| `module` | `stand-alone` or module code | `stand-alone`, `bmm`, `cis`, `bmgd` | - -### Persona - -All first-person voice ("I am...", "I do..."): - -```yaml -role: "I am a Commit Message Artisan..." -identity: "I understand commit messages are documentation..." -communication_style: "Poetic drama with flair..." -principles: - - "Every commit tells a story - capture the why" -``` - -### Prompts with IDs - -Reusable templates referenced via `#id`: - -```yaml -prompts: - - id: write-commit - content: | - What this does - 1. Step 2. Step - -menu: - - trigger: WC or fuzzy match on write - action: "#write-commit" -``` - -**Tips:** Use semantic XML tags (``, ``, ``), keep focused, number steps. - -### Menu Actions - -Two forms: - -1. **Prompt reference:** `action: "#prompt-id"` -2. **Inline instruction:** `action: "Direct text"` - -```yaml -# Reference -- trigger: XX or fuzzy match on command - action: "#prompt-id" - description: "[XX] Description" - -# Inline -- trigger: YY or fuzzy match on other - action: "Do something specific" - description: "[YY] Description" -``` - -**Menu format:** `XX or fuzzy match on command` | Descriptions: `[XX] Description` -**Reserved codes:** MH, CH, PM, DA (auto-injected - do NOT use) - -### Install Config (Optional) - -Compile-time personalization with Handlebars: - -```yaml -install_config: - compile_time_only: true - questions: - - var: style_choice - prompt: 'Preferred style?' - type: choice - options: [...] - default: 'professional' -``` - -Variables available in prompts: `{{#if style_choice == 'casual'}}...{{/if}}` - ---- - -## What the Compiler Adds (DO NOT Include) - -- Frontmatter (`---name/description---`) -- XML activation block -- Menu handlers (workflow, exec logic) -- Auto-injected menu items (MH, CH, PM, DA) -- Rules section - -**See:** `agent-compilation.md` for details. - ---- - -## Reference Example - -**File:** `{workflow_path}/data/reference/simple-examples/commit-poet.agent.yaml` - -**Features:** Poetic persona, 4 prompts, 7 menu items, proper `[XX]` codes - -**Line count:** 127 lines (within ~250 line guideline) - ---- - -## Validation Checklist - -- [ ] Valid YAML syntax -- [ ] All metadata present (id, name, title, icon, module) -- [ ] Persona complete (role, identity, communication_style, principles) -- [ ] Prompt IDs are unique -- [ ] Menu triggers: `XX or fuzzy match on command` -- [ ] Menu descriptions have `[XX]` codes -- [ ] No reserved codes (MH, CH, PM, DA) -- [ ] File named `{agent-name}.agent.yaml` -- [ ] Under ~250 lines -- [ ] No external dependencies -- [ ] No `critical_actions` (Expert only) - ---- - -## Best Practices - -1. **First-person voice** in all persona elements -2. **Focused prompts** - one clear purpose each -3. **Semantic XML tags** (``, ``, ``) -4. **Handlebars** for personalization (if using install_config) -5. **Sensible defaults** in install_config -6. **Numbered steps** in multi-step prompts -7. **Keep under ~250 lines** for maintainability diff --git a/_bmad/bmb/workflows/agent/data/simple-agent-validation.md b/_bmad/bmb/workflows/agent/data/simple-agent-validation.md deleted file mode 100644 index ea19f30..0000000 --- a/_bmad/bmb/workflows/agent/data/simple-agent-validation.md +++ /dev/null @@ -1,132 +0,0 @@ -# Simple Agent Validation Checklist - -Validate Simple agents meet BMAD quality standards. - ---- - -## YAML Structure - -- [ ] YAML parses without errors -- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module` -- [ ] `agent.metadata.module` is `stand-alone` or module code (`bmm`, `cis`, `bmgd`, etc.) -- [ ] `agent.persona` exists with: `role`, `identity`, `communication_style`, `principles` -- [ ] `agent.menu` exists with at least one item -- [ ] File named: `{agent-name}.agent.yaml` (lowercase, hyphenated) - ---- - -## Persona Validation - -### Field Separation - -- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does) -- [ ] **identity** contains ONLY background/experience/context (who agent is) -- [ ] **communication_style** contains ONLY verbal patterns (tone, voice, mannerisms) -- [ ] **principles** contains operating philosophy and behavioral guidelines - -### Communication Style Purity - -- [ ] Does NOT contain: "ensures", "makes sure", "always", "never" -- [ ] Does NOT contain identity words: "experienced", "expert who", "senior", "seasoned" -- [ ] Does NOT contain philosophy words: "believes in", "focused on", "committed to" -- [ ] Does NOT contain behavioral descriptions: "who does X", "that does Y" -- [ ] Is 1-2 sentences describing HOW they talk -- [ ] Reading aloud: sounds like describing someone's voice/speech pattern - ---- - -## Menu Validation - -### Required Fields - -- [ ] All menu items have `trigger` field -- [ ] All menu items have `description` field -- [ ] All menu items have handler: `action` (Simple agents don't use `exec`) - -### Trigger Format - -- [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code) -- [ ] Codes are unique within agent -- [ ] No reserved codes used: MH, CH, PM, DA (auto-injected) - -### Description Format - -- [ ] Descriptions start with `[XX]` code -- [ ] Code in description matches trigger code -- [ ] Descriptions are clear and descriptive - -### Action Handler - -- [ ] If `action: '#prompt-id'`, corresponding prompt exists -- [ ] If `action: 'inline text'`, instruction is complete and clear - ---- - -## Prompts Validation (if present) - -- [ ] Each prompt has `id` field -- [ ] Each prompt has `content` field -- [ ] Prompt IDs are unique within agent -- [ ] Prompts use semantic XML tags: ``, ``, etc. - ---- - -## Simple Agent Specific - -- [ ] Single .agent.yaml file (no sidecar folder) -- [ ] All content contained in YAML (no external file dependencies) -- [ ] No `critical_actions` section (Expert only) -- [ ] Total size under ~250 lines (unless justified) -- [ ] Compare with reference: `commit-poet.agent.yaml` - ---- - -## Path Variables (if used) - -- [ ] Paths use `{project-root}` variable (not hardcoded relative paths) -- [ ] No sidecar paths present (Simple agents don't have sidecars) - ---- - -## Quality Checks - -- [ ] No broken references or missing files -- [ ] Indentation is consistent -- [ ] Agent purpose is clear from reading persona -- [ ] Agent name/title are descriptive -- [ ] Icon emoji is appropriate - ---- - -## What the Compiler Adds (DO NOT validate presence) - -These are auto-injected, don't validate for them: -- Frontmatter (`---name/description---`) -- XML activation block -- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit) -- Rules section - ---- - -## Common Issues - -### Issue: Communication Style Has Behaviors - -**Wrong:** "Experienced analyst who ensures all stakeholders are heard" - -**Fix:** -- identity: "Senior analyst with 8+ years..." -- communication_style: "Speaks like a treasure hunter" -- principles: "Ensure all stakeholder voices heard" - -### Issue: Wrong Trigger Format - -**Wrong:** `trigger: analyze` - -**Fix:** `trigger: AN or fuzzy match on analyze` - -### Issue: Description Missing Code - -**Wrong:** `description: 'Analyze code'` - -**Fix:** `description: '[AC] Analyze code'` diff --git a/_bmad/bmb/workflows/agent/data/understanding-agent-types.md b/_bmad/bmb/workflows/agent/data/understanding-agent-types.md index 14f6fdf..88c7145 100644 --- a/_bmad/bmb/workflows/agent/data/understanding-agent-types.md +++ b/_bmad/bmb/workflows/agent/data/understanding-agent-types.md @@ -1,222 +1,126 @@ -# Understanding Agent Types: Simple VS Expert VS Module +# Understanding Agent Types -> **For the LLM running this workflow:** Load and review the example files referenced below when helping users choose an agent type. -> - Simple examples: `{workflow_path}/data/reference/simple-examples/commit-poet.agent.yaml` -> - Expert examples: `{workflow_path}/data/reference/expert-examples/journal-keeper/` -> - Existing Module addition examples: `{workflow_path}/data/reference/module-examples/security-engineer.agent.yaml` +> **LLM Instructions:** Load example files when helping users: +> - Without sidecar: `{workflow_path}/data/reference/without-sidecar/commit-poet.agent.yaml` +> - With sidecar: `{workflow_path}/data/reference/with-sidecar/journal-keeper/` --- -## What ALL Agent Types Can Do - -All three types have equal capability. The difference is **architecture and integration**, NOT power. - -- Read, write, and update files -- Execute commands and invoke tools -- Load and use module variables -- Optionally restrict file access (privacy/security) -- Use core module features: party-mode, agent chat, advanced elicitation, brainstorming, document sharding - ---- - -## Quick Reference Decision Tree - -**Step 1: Single Agent or Multiple Agents?** +## Decision Tree ``` Multiple personas/roles OR multi-user OR mixed data scope? -├── YES → Use BMAD Module Builder (create module with multiple agents) -└── NO → Single Agent (continue below) +├── YES → Use BMAD Module Builder +└── NO → Single Agent + └── Need memory across sessions? + ├── YES → hasSidecar: true + └── NO → hasSidecar: false ``` -**Step 2: Memory Needs (for Single Agent)** - -``` -Need to remember things across sessions? -├── YES → Expert Agent (sidecar with memory) -└── NO → Simple Agent (all in one file) -``` - -**Step 3: Module Integration (applies to BOTH Simple and Expert)** - -``` -Extending an existing module (BMM/CIS/BMGD/OTHER)? -├── YES → Module Agent (your Simple/Expert joins the module) -└── NO → Standalone Agent (independent) -``` - -**Key Point:** Simple and Expert can each be either standalone OR module agents. Memory and module integration are independent decisions. +**Key:** All agents have equal capability. Difference is memory/state management only. --- -## The Three Types +## Without Sidecar (`hasSidecar: false`) -### Simple Agent - -**Everything in one file. No external dependencies. No memory.** +**Single file, stateless, ~250 lines max** ``` -agent-name.agent.yaml (~250 lines max) -├── metadata +agent-name.agent.yaml +├── metadata.hasSidecar: false ├── persona -├── prompts (inline, small) -└── menu (triggers → #prompt-id or inline actions) +├── prompts (inline) +└── menu (triggers → #prompt-id or inline) ``` -**Choose when:** -- Single-purpose utility -- Each session is independent (stateless) -- All knowledge fits in the YAML -- Menu handlers are 5-15 line prompts +| When to Use | Examples | +|-------------|----------| +| Single-purpose utility | Commit Poet | +| Each session independent | Snarky Weather Bot | +| All knowledge fits in YAML | Pun-making Barista | +| Menu handlers 1-2 lines | Motivational Gym Bro | +| Persona-driven (fun/character) | Sassy Fortune Teller | -**Examples:** -- Commit message helper (conventional commits) -- Document formatter/validator -- Joke/teller persona agent -- Simple data transformation and analysis tools - -**Reference:** `./data/reference/simple-examples/commit-poet.agent.yaml` +**Optional critical_actions:** Allowed for activation behaviors (quotes, data fetches). Must NOT reference sidecar files. --- -### Expert Agent +## With Sidecar (`hasSidecar: true`) -**Sidecar folder with persistent memory, workflows, knowledge files.** +**Persistent memory, knowledge, workflows** ``` agent-name.agent.yaml └── agent-name-sidecar/ - ├── memories.md # User profile, session history, patterns - ├── instructions.md # Protocols, boundaries, startup behavior - ├── [custom-files].md # Breakthroughs, goals, tracking, etc. - ├── workflows/ # Large workflows loaded on demand - └── knowledge/ # Domain reference material + ├── memories.md # User profile, session history + ├── instructions.md # Protocols, boundaries + ├── [custom-files].md # Tracking, goals, etc. + ├── workflows/ # Large workflows on-demand + └── knowledge/ # Domain reference ``` -**Choose when:** -- Must remember across sessions -- User might create multiple instances each with own memory of actions (such as 2 different developers agents) -- Personal knowledge base that grows -- Learning/evolving over time -- Domain-specific with restricted file access -- Complex multi-step workflows - -**Examples:** -- Journal companion (remembers mood patterns, past entries) -- Personal job augmentation agent (knows your role, meetings, projects) -- Therapy/health tracking (progress, goals, insights) -- Domain advisor with custom knowledge base - -**Reference:** `./data/reference/expert-examples/journal-keeper/` +| When to Use | Examples | +|-------------|----------| +| Remember across sessions | Journal companion | +| User preferences/settings | Novel writing buddy | +| Personal knowledge base | Job augmentation agent | +| Learning/evolving over time | Therapy/health tracking | +| Domain-specific + restricted access | Fitness coach with PRs | +| Complex multi-step workflows | Language tutor | **Required critical_actions:** ```yaml critical_actions: - - "Load COMPLETE file ./sidecar/memories.md" - - "Load COMPLETE file ./sidecar/instructions.md" - - "ONLY read/write files in ./sidecar/ - private space" + - "Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md" + - "Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md" + - "ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/" ``` --- -### Module Agent +## Comparison -Two distinct purposes: - -#### 1. Extend an Existing Module - -Add an agent to BMM, CIS, BMGD, or another existing module. - -**Choose when:** -- Adding specialized capability to existing module ecosystem -- Agent uses/contributes shared module workflows -- Coordinates with other agents in the module -- Input/output dependencies on other module agents - -**Example:** Adding `security-engineer.agent.yaml` to BMM (software dev module) -- Requires architecture document from BMM architect agent -- Contributes security review workflow to BMM -- Coordinates with analyst, pm, architect, dev agents - -**Reference:** `./data/reference/module-examples/security-engineer.agent.yaml` - -#### 2. Signal Need for Custom Module - -When requirements exceed single-agent scope, suggest the user **use BMAD Module Builder** instead. - -**Signals:** -- "I need an HR agent, sales agent, F&I agent, and training coach..." -- "Some info is global/shared across users, some is private per user..." -- "Many workflows, skills, tools, and platform integrations..." - -**Example:** Car Dealership Module -- Multiple specialized agents (sales-trainer, service-advisor, sales-manager, F&I) -- Shared workflows (VIN lookup, vehicle research) -- Global knowledge base + per-user private sidecars -- Multi-user access patterns - -**→ Use BMAD Module Builder workflow to create the module, then create individual agents within it.** - ---- - -## Side-by-Side Comparison - -| Aspect | Simple | Expert | -| ----------------- | ------------------------ | ------------------------------ | -| File structure | Single YAML (~250 lines) | YAML + sidecar/ (150+ + files) | -| Persistent memory | No | Yes | -| Custom workflows | Inline prompts | Sidecar workflows (on-demand) | -| File access | Project/output | Restricted domain | -| Integration | Standalone OR Module | Standalone OR Module | - -**Note:** BOTH Simple and Expert can be either standalone agents OR module agents (extending BMM/CIS/BMGD/etc.). Module integration is independent of memory needs. +| Aspect | Without Sidecar | With Sidecar | +|--------|----------------|--------------| +| Structure | Single YAML | YAML + sidecar/ | +| Persistent memory | No | Yes | +| critical_actions | Optional | MANDATORY | +| Workflows | Inline prompts | Sidecar files | +| File access | Project/output | Restricted to sidecar | +| Session state | Stateless | Remembers | +| Best for | Focused skills | Long-term relationships | --- ## Selection Checklist -**Choose Simple if:** -- [ ] One clear purpose -- [ ] No need to remember past sessions -- [ ] All logic fits in ~250 lines -- [ ] Each interaction is independent +**Without sidecar:** +- [ ] One clear purpose, related skills +- [ ] No cross-session memory needed +- [ ] Fits in ~250 lines +- [ ] Independent interactions +- [ ] Persona-driven value -**Choose Expert if:** -- [ ] Needs memory across sessions +**With sidecar:** +- [ ] Memory across sessions - [ ] Personal knowledge base - [ ] Domain-specific expertise -- [ ] Restricted file access for privacy -- [ ] Learning/evolving over time -- [ ] Complex workflows in sidecar - -**Then, for EITHER Simple or Expert:** -- [ ] Extending existing module (BMM/CIS/BMGD/etc.) → Make it a Module Agent -- [ ] Independent operation → Keep it Standalone +- [ ] Restricted file access +- [ ] Progress tracking/history +- [ ] Complex workflows **Escalate to Module Builder if:** -- [ ] Multiple distinct personas needed (not one swiss-army-knife agent) -- [ ] Many specialized workflows required +- [ ] Multiple distinct personas needed +- [ ] Many specialized workflows - [ ] Multiple users with mixed data scope - [ ] Shared resources across agents -- [ ] Future platform integrations planned --- -## Tips for the LLM Facilitator +## Quick Tips -- If unsure between Simple or Expert → **recommend Expert** (more flexible) -- Multiple personas/skills → **suggest Module Builder**, not one giant agent -- Ask about: memory needs, user count, data scope (global vs private), integration plans -- Load example files when user wants to see concrete implementations -- Reference examples to illustrate differences - ---- - -## Architecture Notes - -All three types are equally powerful. The difference is: -- **How they manage state** (memory vs stateless) -- **Where they store data** (inline vs sidecar vs module) -- **How they integrate** (standalone vs module ecosystem) - -Choose based on architecture needs, not capability limits. +- Unsure? Ask about **memory needs first** +- Multiple personas → Module Builder, not one giant agent +- Ask: memory needs, user count, data scope, integration plans +- Personality agents → usually without sidecar +- Relationship/coaching agents → usually with sidecar diff --git a/_bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md b/_bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md index 7a7c6ba..eb739d3 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md +++ b/_bmad/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/_bmad/bmb/workflows/agent/steps-c/step-02-discovery.md b/_bmad/bmb/workflows/agent/steps-c/step-02-discovery.md index 57ca7af..ea37daf 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-02-discovery.md +++ b/_bmad/bmb/workflows/agent/steps-c/step-02-discovery.md @@ -3,7 +3,7 @@ name: 'step-02-discovery' description: 'Discover what user wants holistically' # File References -nextStepFile: './step-03-type-metadata.md' +nextStepFile: './step-03-sidecar-metadata.md' agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' brainstormContext: ../data/brainstorm-context.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/_bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md b/_bmad/bmb/workflows/agent/steps-c/step-03-sidecar-metadata.md similarity index 57% rename from _bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md rename to _bmad/bmb/workflows/agent/steps-c/step-03-sidecar-metadata.md index 34f58f3..a2c0e8b 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md +++ b/_bmad/bmb/workflows/agent/steps-c/step-03-sidecar-metadata.md @@ -1,6 +1,6 @@ --- -name: 'step-02-type-metadata' -description: 'Determine agent type and define metadata' +name: 'step-03-sidecar-metadata' +description: 'Determine if agent needs memory (sidecar) and define metadata' # File References nextStepFile: './step-04-persona.md' @@ -9,9 +9,8 @@ agentTypesDoc: ../data/understanding-agent-types.md agentMetadata: ../data/agent-metadata.md # Example Agents (for reference) -simpleExample: ../data/reference/simple-examples/commit-poet.agent.yaml -expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml -moduleExample: ../data/reference/module-examples/security-engineer.agent.yaml +noSidecarExample: ../data/reference/without-sidecar/commit-poet.agent.yaml +withSidecarExample: ../data/reference/with-sidecar/journal-keeper/journal-keeper.agent.yaml # Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -20,14 +19,14 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # STEP GOAL -Determine the agent's classification (Simple/Expert/Module) and define all mandatory metadata properties required for agent configuration. Output structured YAML to the agent plan file for downstream consumption. +Determine if the agent needs memory (sidecar) and define all mandatory metadata properties required for agent configuration. Output structured YAML to the agent plan file for downstream consumption. --- # 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 @@ -41,9 +40,9 @@ You ARE a master agent architect guiding collaborative agent creation. Balance: ## Step-Specific Rules - LOAD and reference agentTypesDoc and agentMetadata before conversations - NEVER skip metadata properties - all are mandatory -- VALIDATE type selection against user's articulated needs +- VALIDATE sidecar decision against user's articulated needs - OUTPUT structured YAML format exactly as specified -- SHOW examples when type classification is unclear +- SHOW examples when sidecar decision is unclear --- @@ -51,22 +50,35 @@ You ARE a master agent architect guiding collaborative agent creation. Balance: ## Protocol 1: Documentation Foundation Load reference materials first: -1. Read agentTypesDoc for classification criteria +1. Read agentTypesDoc for sidecar decision criteria 2. Read agentMetadata for property definitions 3. Keep examples ready for illustration ## Protocol 2: Purpose Discovery Guide natural conversation to uncover: - Primary agent function/responsibility -- Complexity level (single task vs multi-domain) -- Scope boundaries (standalone vs manages workflows) -- Integration needs (other agents/workflows) +- Does the agent need to remember things between sessions? +- What should it remember? (user preferences, project state, progress, etc.) +- Or is each interaction independent? -## Protocol 3: Type Determination -Classify based on criteria: -- **Simple**: Single focused purpose, minimal complexity (e.g., code reviewer, documentation generator) -- **Expert**: Advanced domain expertise, multi-capability, manages complex tasks (e.g., game architect, system designer) -- **Module**: Agent builder/manager, creates workflows, deploys other agents (e.g., agent-builder, workflow-builder) +## Protocol 3: Sidecar Determination +Classify based on ONE question: + +**Does this agent need to remember things across sessions?** + +| If... | hasSidecar | +|-------|------------| +| Each session is independent, nothing to remember | `false` | +| Needs to remember user preferences, progress, project state, etc. | `true` | + +**Examples to help user decide:** + +| No sidecar needed | With sidecar needed | +|-------------------|---------------------| +| Commit Poet - each commit is independent | Journal companion - remembers moods, patterns | +| Snarky Weather Bot - fresh snark each time | Novel buddy - remembers characters, plot | +| Pun-making Barista - standalone jokes | Fitness coach - tracks your PRs, progress | +| Motivational Gym Bro - hypes you up fresh | Language tutor - knows your vocabulary level | ## Protocol 4: Metadata Definition Define each property systematically: @@ -75,15 +87,16 @@ Define each property systematically: - **title**: Concise function description (one line, action-oriented) - **icon**: Visual identifier (emoji or short symbol) - **module**: Module path (format: `{project}:{type}:{name}`) -- **hasSidecar**: Boolean - manages external workflows? (default: false) +- **hasSidecar**: Boolean - does agent need memory? (this is the key decision) ## Protocol 5: Documentation Structure Output to agent plan file in exact YAML format: ```yaml -# Agent Type & Metadata -agent_type: [Simple|Expert|Module] -classification_rationale: | +# Agent Sidecar Decision & Metadata +hasSidecar: [true|false] +sidecar_rationale: | + [Clear explanation of why this agent does or does not need memory] metadata: id: [technical-identifier] @@ -97,67 +110,68 @@ metadata: ## Protocol 6: Confirmation Menu Present structured options: - **[A] Accept** - Confirm and advance to next step -- **[P] Pivot** - Modify type/metadata choices -- **[C] Clarify** - Ask questions about classification +- **[P] Pivot** - Modify sidecar/metadata choices +- **[C] Clarify** - Ask questions about sidecar decision --- # CONTEXT BOUNDARIES ## In Scope -- Agent type classification +- Sidecar decision (hasSidecar: true/false) - All 6 metadata properties - Documentation to plan file -- Type selection guidance with examples +- Sidecar decision guidance with examples ## Out of Scope (Future Steps) -- Persona/character development (Step 3) -- Command structure design (Step 4) -- Agent naming/branding refinement (Step 5) -- Implementation/build (Step 6) -- Validation/testing (Step 7) +- Persona/character development (Step 4) +- Command structure design (Step 5) +- Agent naming/branding refinement (Step 6) +- Implementation/build (Step 7) +- Validation/testing (Step 8) ## Red Flags to Address -- User wants complex agent but selects "Simple" type -- Module classification without workflow management needs +- User wants complex memory but selects hasSidecar: false +- Unclear about what "memory across sessions" means - Missing or unclear metadata properties - Module path format confusion --- -# 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: -- `{agentTypesDoc}` - Classification framework +- `{agentTypesDoc}` - Sidecar decision framework - `{agentMetadata}` - Property definitions - Keep examples accessible for reference -## 2. Purpose Discovery Conversation -Engage user with questions in `{agent-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?" -- "What specific domains or expertise areas are involved?" +## 2. Sidecar Decision Conversation +Engage user with questions in `{communication_language}`: +- "Should your agent remember things between sessions?" +- "What should it remember? User preferences? Project state? Progress over time?" +- "Or is each interaction independent and fresh?" -Listen for natural language cues about scope and complexity. +Listen for natural language cues about memory needs. -## 3. Agent Type Determination -Based on discovery, propose classification: -- Present recommended type with reasoning +## 3. Sidecar Determination +Based on discovery, propose decision: +- Present recommended hasSidecar value with reasoning - Show relevant example if helpful -- Confirm classification matches user intent +- Confirm decision matches user intent - Allow pivoting if user vision evolves **Conversation Template:** ``` -Based on our discussion, I recommend classifying this as a [TYPE] agent because: +Based on our discussion, I recommend hasSidecar: [true/false] because: [reasoning from discovery] -[If helpful: "For reference, here's a similar [TYPE] agent:"] -[Show relevant example path: simpleExample/expertExample/moduleExample] +[If helpful: "For reference, here's a similar agent:"] +[Show relevant example path: noSidecarExample/withSidecarExample] -Does this classification feel right to you? +Does this feel right to you? ``` ## 4. Define All Metadata Properties @@ -194,10 +208,10 @@ Work through each property systematically: - Guide user through structure if unfamiliar **4f. Sidecar Configuration** -- Boolean: manages external workflows? -- Typically false for Simple/Expert agents -- True for Module agents that deploy workflows -- Confirm based on user's integration needs +- Boolean: does agent need memory? +- Most personality-driven agents don't need it +- Most relationship/coaching/tracking agents do need it +- Confirm based on user's memory needs **Conversation Template:** ``` @@ -219,10 +233,10 @@ Ready to confirm, or should we adjust any properties? Write to `{agentPlan}`: ```yaml -# Agent Type & Metadata -agent_type: [Simple|Expert|Module] -classification_rationale: | - [Clear explanation of why this type matches user's articulated needs] +# Agent Sidecar Decision & Metadata +hasSidecar: [true|false] +sidecar_rationale: | + [Clear explanation of why this agent does or does not need memory based on user's stated needs] metadata: id: [technical-identifier] @@ -232,12 +246,12 @@ metadata: module: [project:type:name] hasSidecar: [true|false] -# Type Classification Notes -type_decision_date: [YYYY-MM-DD] -type_confidence: [High/Medium/Low] -considered_alternatives: | - - [Alternative type]: [reason not chosen] - - [Alternative type]: [reason not chosen] +# Sidecar Decision Notes +sidecar_decision_date: [YYYY-MM-DD] +sidecar_confidence: [High/Medium/Low] +memory_needs_identified: | + - [Specific memory needs if hasSidecar: true] + - [Or: N/A - stateless interactions] ``` ### 6. Present MENU OPTIONS @@ -260,14 +274,14 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [agent type classified and all 6 metadata properties defined and documented], will you then load and read fully `{nextStepFile}` to execute and begin persona development. +ONLY WHEN [C continue option] is selected and [hasSidecar decision made and all 6 metadata properties defined and documented], will you then load and read fully `{nextStepFile}` to execute and begin persona development. --- # SYSTEM SUCCESS/FAILURE METRICS ## Success Indicators -- Type classification clearly justified +- Sidecar decision clearly justified - All metadata properties populated correctly - YAML structure matches specification exactly - User confirms understanding and acceptance @@ -276,16 +290,16 @@ ONLY WHEN [C continue option] is selected and [agent type classified and all 6 m ## Failure Indicators - Missing or undefined metadata properties - YAML structure malformed -- User confusion about type classification +- User confusion about sidecar decision - Inadequate documentation to plan file - Proceeding without user confirmation ## Recovery Mode -If user struggles with classification: +If user struggles with sidecar decision: - Show concrete examples from each type -- Compare/contrast types with their use case -- Ask targeted questions about complexity/scope -- Offer type recommendation with clear reasoning +- Compare/contrast with their use case +- Ask targeted questions about memory needs +- Offer recommendation with clear reasoning Recover metadata definition issues by: - Showing property format examples diff --git a/_bmad/bmb/workflows/agent/steps-c/step-04-persona.md b/_bmad/bmb/workflows/agent/steps-c/step-04-persona.md index 2c81b6d..cef1fd9 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-04-persona.md +++ b/_bmad/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 @@ -10,8 +10,8 @@ principlesCrafting: ../data/principles-crafting.md communicationPresets: ../data/communication-presets.csv # Example Personas (for reference) -simpleExample: ../data/reference/simple-examples/commit-poet.agent.yaml -expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml +simpleExample: ../data/reference/without-sidecar/commit-poet.agent.yaml +expertExample: ../data/reference/with-sidecar/journal-keeper/journal-keeper.agent.yaml # Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -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/_bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md b/_bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md index c579351..61a54ea 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md +++ b/_bmad/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 @@ -8,8 +8,8 @@ agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' agentMenuPatterns: ../data/agent-menu-patterns.md # Example Menus (for reference) -simpleExample: ../data/reference/simple-examples/commit-poet.agent.yaml -expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml +simpleExample: ../data/reference/without-sidecar/commit-poet.agent.yaml +expertExample: ../data/reference/with-sidecar/journal-keeper/journal-keeper.agent.yaml # Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -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/_bmad/bmb/workflows/agent/steps-c/step-06-activation.md b/_bmad/bmb/workflows/agent/steps-c/step-06-activation.md index 6d2bf0e..9f65b60 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-06-activation.md +++ b/_bmad/bmb/workflows/agent/steps-c/step-06-activation.md @@ -1,18 +1,17 @@ --- -name: 'step-05-activation' +name: 'step-06-activation' description: 'Plan activation behavior and route to build' # File References agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' criticalActions: ../data/critical-actions.md -# Build Step Routes (determined by agent type) -simpleBuild: './step-07a-build-simple.md' -expertBuild: './step-07b-build-expert.md' -moduleBuild: './step-07c-build-module.md' +# Build Step Route (determined by hasSidecar) +agentBuild: './step-07-build-agent.md' # Example critical_actions (for reference) -expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml +withSidecarExample: ../data/reference/with-sidecar/journal-keeper/journal-keeper.agent.yaml +withoutSidecarExample: ../data/reference/without-sidecar/commit-poet.agent.yaml # Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -20,7 +19,8 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- # STEP GOAL -Define activation behavior through critical_actions and route to the appropriate build step based on agent complexity. + +Define activation behavior through critical_actions and confirm routing to the build step based on hasSidecar decision. # MANDATORY EXECUTION RULES @@ -29,9 +29,9 @@ Define activation behavior through critical_actions and route to the appropriate - Read agentPlan to access all accumulated metadata - These are non-negotiable prerequisites -2. **MUST Determine Route Before Activation Discussion** - - Check hasSidecar from plan metadata - - Determine destination build step FIRST +2. **MUST Confirm hasSidecar Decision** + - Check `hasSidecar` from plan metadata (decided in Step 3) + - This determines the build approach - Inform user of routing decision 3. **MUST Document Activation Decision** @@ -39,12 +39,11 @@ Define activation behavior through critical_actions and route to the appropriate - OR document deliberate omission with rationale - No middle ground - commit to one path -4. **MUST Follow Routing Logic Exactly** +4. **MUST Follow Simple Routing Logic** ```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 hasSidecar only + hasSidecar: false → Agent without sidecar (single YAML file) + hasSidecar: true → Agent with sidecar (YAML + sidecar folder) ``` 5. **NEVER Skip Documentation** @@ -60,10 +59,9 @@ Execute BEFORE engaging user: 1. Load criticalActions.md 2. Load agentPlan-{agent_name}.md 3. Extract routing metadata: - - hasSidecar (boolean) - - module (string) - - agentType (if defined) -4. Determine destination build step + - hasSidecar (boolean) - decided in Step 3 + - All other metadata from prior steps +4. Confirm build approach ## Protocol 2: Routing Disclosure Inform user immediately of determined route: @@ -71,9 +69,8 @@ Inform user immediately of determined route: ``` "Based on your agent configuration: - hasSidecar: {hasSidecar} -- module: {module} -→ Routing to: {destinationStep} +→ Building: Agent {WITH|WITHOUT} sidecar Now let's plan your activation behavior..." ``` @@ -104,10 +101,10 @@ activation: hasCriticalActions: true/false rationale: "Explanation of why or why not" criticalActions: [] # Only if hasCriticalActions: true + routing: - destinationBuild: "step-06-{X}.md" + buildApproach: "Agent {with|without} sidecar" hasSidecar: {boolean} - module: "{module}" ``` # CONTEXT BOUNDARIES @@ -115,21 +112,24 @@ routing: ## In Scope - Planning activation behavior for the agent - Defining critical_actions array -- Routing to appropriate build step +- Confirming routing to build step - Documenting activation decisions ## Out of Scope - Writing actual activation code (build step) - Designing sidecar workflows (build step) -- Changing core agent metadata (locked after step 04) +- Changing core agent metadata (locked after Step 4) - Implementing commands (build step) ## Routing Boundaries -- Simple agents: No sidecar, straightforward activation -- Expert agents: Sidecar + stand-alone module -- Module agents: Sidecar + parent module integration +- **Agent WITHOUT sidecar**: Single YAML file, no persistent memory +- **Agent WITH sidecar**: YAML file + sidecar folder with persistent memory -# 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 @@ -138,14 +138,26 @@ cat {criticalActions} cat {agentPlan} ``` -## 2. Discuss Activation Needs +## 2. Confirm Routing Decision +Verify hasSidecar decision from Step 3: + +``` +"Confirming your agent configuration from Step 3: +- hasSidecar: {value from plan} +- This means: {Agent will|will not} remember things between sessions +- Build approach: {Single YAML file|YAML + sidecar folder} + +Is this still correct?" +``` + +## 3. Discuss Activation Needs Ask user: - "Should your agent be able to take autonomous actions?" - "Are there specific workflows it should trigger?" - "Should it run as a background process or scheduled task?" - "Or will it primarily respond to direct prompts?" -## 3. Define critical_actions OR Explicitly Omit +## 4. Define critical_actions OR Explicitly Omit **If defining:** - Reference criticalActions.md patterns @@ -153,29 +165,27 @@ Ask user: - Each action should be clear and scoped - Document rationale for each +**For agents WITH sidecar, critical_actions MUST include:** +``` +- "Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md" +- "Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md" +- "ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/ - private space" +``` +Plus any additional activation behaviors the agent needs. + +**For agents WITHOUT sidecar, critical_actions are OPTIONAL and can include:** +``` +- "Give user an inspirational quote before showing menu" +- "Fetch latest data from {project-root}/finances/ before displaying menu" +- "Display a quick status summary on activation" +``` +Agents without sidecar omit critical_actions entirely if no activation behavior is needed. + **If omitting:** - State clearly: "This agent will not have critical_actions" - Explain why: "This agent is a responsive assistant that operates under direct user guidance" - Document the rationale -## 4. Route to Build Step - -Determine destination: - -```yaml -# Check plan metadata -hasSidecar: {value from step 04} -module: "{value from step 04}" - -# Route logic -if hasSidecar == false: - destination = simpleBuild -elif hasSidecar == true and module == "stand-alone": - destination = expertBuild -else: # hasSidecar == true and module != "stand-alone" - destination = moduleBuild -``` - ## 5. Document to Plan Update agentPlan with: @@ -183,21 +193,17 @@ Update agentPlan with: ```yaml --- activation: - hasCriticalActions: true - rationale: "Agent needs to autonomously trigger workflows for task automation" + hasCriticalActions: {true/false} + rationale: "Agent needs to autonomously trigger workflows for task automation" OR "Agent operates under direct user guidance" criticalActions: - name: "start-workflow" description: "Initiate a predefined workflow for task execution" - - name: "schedule-task" - description: "Schedule tasks for future execution" - - name: "sync-data" - description: "Synchronize data with external systems" + # ... additional actions if needed routing: - destinationBuild: "step-06-build-expert.md" - hasSidecar: true - module: "stand-alone" - rationale: "Agent requires sidecar workflows for autonomous operation" + buildApproach: "Agent {with|without} sidecar" + hasSidecar: {true/false} + rationale: "Agent {needs|does not need} persistent memory across sessions" --- ``` @@ -209,7 +215,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 content to {agentPlan}, update frontmatter, determine appropriate build step based on hasSidecar and module values, then only then load, read entire file, then execute {simpleBuild} or {expertBuild} or {moduleBuild} as determined +- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {agentBuild} - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) #### EXECUTION RULES: @@ -221,14 +227,13 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont ## CRITICAL STEP COMPLETION NOTE -This is the **ROUTING HUB** of agent creation. ONLY WHEN [C continue option] is selected and [routing decision determined with activation needs documented], will you then determine the appropriate build step based on hasSidecar/module values and load and read fully that build step file to execute. +This is the **final planning step** before building. ONLY WHEN [C continue option] is selected and [activation needs documented], will you then load and read fully `{agentBuild}` to execute and build the agent. Routing logic: -- 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 +- hasSidecar: false → Agent WITHOUT sidecar (single YAML) +- hasSidecar: true → Agent WITH sidecar (YAML + sidecar folder) -You cannot proceed to build without completing routing. +You cannot proceed to build without completing activation planning. --- @@ -237,39 +242,36 @@ You cannot proceed to build without completing routing. ✅ **COMPLETION CRITERIA:** - [ ] criticalActions.md loaded and understood - [ ] agentPlan loaded with all prior metadata -- [ ] Routing decision determined and communicated +- [ ] Routing decision confirmed (hasSidecar from Step 3) - [ ] Activation needs discussed with user - [ ] critical_actions defined OR explicitly omitted with rationale - [ ] Plan updated with activation and routing metadata -- [ ] User confirms routing to appropriate build step +- [ ] User confirms ready to build ✅ **SUCCESS INDICATORS:** - Clear activation decision documented -- Route to build step is unambiguous -- User understands why they're going to {simple|expert|module} build +- Route to build is unambiguous +- User understands the build approach - Plan file reflects complete activation configuration ❌ **FAILURE MODES:** - Attempting to define critical_actions without reading reference - Routing decision not documented in plan -- User doesn't understand which build step comes next +- User doesn't understand the build approach - Ambiguous activation configuration (neither defined nor omitted) -- Skipping routing discussion entirely +- Skipping activation discussion entirely -⚠️ **RECOVERY PATHS:** +⚠️ **RECOVERY PATHS** If activation planning goes wrong: 1. **Can't decide on activation?** - Default: Omit critical_actions - - Route to simpleBuild - Can add later via edit-agent workflow -2. **Uncertain about routing?** - - Check hasSidecar value - - Check module value - - Apply routing logic strictly - -3. **User wants to change route?** - - Adjust hasSidecar or module values - - Re-run routing logic +2. **User wants to change hasSidecar?** + - Return to Step 3 to revise decision - Update plan accordingly + +3. **Uncertain about routing?** + - Check hasSidecar value + - Apply simple routing logic diff --git a/_bmad/bmb/workflows/agent/steps-c/step-07-build-agent.md b/_bmad/bmb/workflows/agent/steps-c/step-07-build-agent.md new file mode 100644 index 0000000..1df2867 --- /dev/null +++ b/_bmad/bmb/workflows/agent/steps-c/step-07-build-agent.md @@ -0,0 +1,315 @@ +--- +name: 'step-07-build-agent' +description: 'Generate agent YAML from plan (with or without sidecar)' + +# File References +nextStepFile: './step-08-celebrate.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' + +# Output paths (determined by hasSidecar) +agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}/' +agentYamlOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' +agentYamlOutputNoSidecar: '{bmb_creations_output_folder}/{agent-name}.agent.yaml' +sidecarOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}-sidecar/' + +# Template and Architecture +agentTemplate: ../templates/agent-template.md +agentArch: ../data/agent-architecture.md +agentCompilation: ../data/agent-compilation.md +criticalActions: ../data/critical-actions.md + +# Reference examples +noSidecarExample: ../data/reference/without-sidecar/commit-poet.agent.yaml +withSidecarExample: ../data/reference/with-sidecar/journal-keeper/journal-keeper.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 + +Assemble the agent plan content into a complete agent YAML file. The build approach (with or without sidecar) is determined by the `hasSidecar` decision made in Step 3. + +--- + +# MANDATORY EXECUTION RULES + +1. **DETERMINE BUILD APPROACH FIRST**: Check `hasSidecar` from agentPlan before starting +2. **TEMPLATE COMPLIANCE**: Follow agent-template.md structure exactly +3. **YAML VALIDATION**: Ensure valid YAML syntax with proper indentation (2-space) +4. **EXISTING CHECK**: If output file exists, ask user before overwriting +5. **NO DRIFT**: Use ONLY content from agentPlan - no additions or interpretations +6. **SIDECAR REQUIREMENT**: If hasSidecar=true, MUST create sidecar folder structure + +--- + +# EXECUTION PROTOCOLS + +## Phase 1: Load Architecture and Templates +1. Read `agentTemplate` - defines YAML structure for agents +2. Read `agentArch` - architecture requirements for agents +3. Read `agentCompilation` - assembly rules for YAML generation +4. Read `criticalActions` - validation requirements for critical_actions + +## Phase 2: Load Agent Plan +1. Read `agentPlan` containing all collected content from Steps 2-5 +2. Verify plan contains: + - hasSidecar decision (true/false) + - Persona content + - Commands structure + - All metadata fields + - Activation decisions (critical_actions) + +## Phase 3: Determine Build Approach + +Check `hasSidecar` from plan: + +```yaml +hasSidecar: false +→ Build: Agent WITHOUT sidecar +→ Output: Single YAML file at {agentYamlOutputNoSidecar} +→ Structure: Everything in one file (~250 lines max) + +hasSidecar: true +→ Build: Agent WITH sidecar +→ Output: YAML + sidecar folder structure +→ Structure: YAML file + {agent-name}-sidecar/ folder +``` + +**Inform user of build approach:** +``` +"Building: Agent {WITH|WITHOUT} sidecar +hasSidecar: {true/false} +Output: {output path description}" +``` + +## Phase 4: Assemble Agent YAML + +### For Agents WITHOUT Sidecar (hasSidecar: false) + +**Structure:** +```yaml +name: '{agent-name}' +description: '{short-description}' + +author: + name: '{author}' + created: '{date}' + +persona: | + {multi-line persona content from plan} + +system-context: | + {expanded context from plan} + +capabilities: + - {capability from plan} + - {capability from plan} + # ... all capabilities + +commands: + - name: '{command-name}' + description: '{what command does}' + trigger: '{menu trigger}' + steps: + - {step 1} + - {step 2} + # ... all commands from plan + +configuration: + temperature: {temperature} + max-tokens: {max-tokens} + response-format: {format} + # ... other configuration from plan + +metadata: + hasSidecar: false + agent-type: 'agent' +``` + +**Output:** Single YAML file at `{agentYamlOutputNoSidecar}` + +### For Agents WITH Sidecar (hasSidecar: true) + +**Structure:** +```yaml +name: '{agent-name}' +description: '{short-description}' + +author: + name: '{author}' + created: '{date}' + +persona: | + {multi-line persona content from plan} + +system-context: | + {expanded context from plan} + +capabilities: + - {capability from plan} + - {capability from plan} + # ... all capabilities + +critical-actions: + - name: '{action-name}' + description: '{what it does}' + invocation: '{when/how to invoke}' + implementation: | + {multi-line implementation} + output: '{expected-output}' + sidecar-folder: '{sidecar-folder-name}' + sidecar-files: + - '{project-root}/_bmad/_memory/{sidecar-folder}/{file1}.md' + - '{project-root}/_bmad/_memory/{sidecar-folder}/{file2}.md' + # ... all critical actions referencing sidecar structure + +commands: + - name: '{command-name}' + description: '{what command does}' + trigger: '{menu trigger}' + steps: + - {step 1} + - {step 2} + # ... all commands from plan + +configuration: + temperature: {temperature} + max-tokens: {max-tokens} + response-format: {format} + # ... other configuration from plan + +metadata: + sidecar-folder: '{sidecar-folder-name}' + sidecar-path: '{project-root}/_bmad/_memory/{sidecar-folder}/' + hasSidecar: true + agent-type: 'agent' + memory-type: 'persistent' +``` + +**Output:** YAML file at `{agentYamlOutput}` + sidecar folder structure + +### Phase 5: Create Sidecar Structure (IF hasSidecar: true) + +Skip this phase if hasSidecar: false + +1. **Create Sidecar Directory**: + ```bash + mkdir -p {sidecarOutput} + ``` + +2. **Create Starter Files** (if specified in critical_actions): + ```bash + touch {sidecarOutput}/memories.md + touch {sidecarOutput}/instructions.md + # ... additional files from critical_actions + ``` + +3. **Add README to Sidecar**: + ```markdown + # {sidecar-folder} Sidecar + + This folder stores persistent memory for the **{agent-name}** agent. + + ## Purpose + {purpose from critical_actions} + + ## Files + - memories.md: User profile, session history, patterns + - instructions.md: Protocols, boundaries, startup behavior + - {additional files} + + ## Runtime Access + After BMAD installation, this folder will be accessible at: + `{project-root}/_bmad/_memory/{sidecar-folder}/{filename}.md` + ``` + +### Phase 6: Write Agent YAML + +**If hasSidecar: false:** +1. Write YAML to `{agentYamlOutputNoSidecar}` +2. Confirm write success +3. Display file location to user + +**If hasSidecar: true:** +1. Create directory: `mkdir -p {agentBuildOutput}` +2. Write YAML to `{agentYamlOutput}` +3. Confirm write success +4. Display file location to user + +## Phase 7: Present MENU OPTIONS + +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: Write agent YAML to appropriate output path (with or without sidecar), 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) + +#### 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 + +**INCLUDE:** +- Template structure exactly as provided +- All agent metadata from agentPlan +- Persona, commands, and rules from plan +- Configuration options specified +- Sidecar structure if hasSidecar: true + +**EXCLUDE:** +- Any content not in agentPlan +- Sidecar references if hasSidecar: false +- Template placeholders (replace with actual content) +- Comments or notes in final YAML + +--- + +# 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 celebrate completion. + +**This step produces:** +- **If hasSidecar: false**: Single agent YAML file +- **If hasSidecar: true**: Agent YAML file + sidecar folder structure + +Both must exist (if applicable) before proceeding to validation. + +--- + +# SUCCESS METRICS + +✅ **SUCCESS looks like:** +- Agent YAML file exists at specified output path +- YAML is syntactically valid and well-formed +- All template fields populated with plan content +- Structure matches agent architecture +- If hasSidecar: true, sidecar folder created with starter files +- User has selected continue to proceed + +❌ **FAILURE looks like:** +- Template or architecture files not found +- Agent plan missing required sections +- YAML syntax errors in output +- Content not properly mapped to template +- File write operation fails +- hasSidecar: true but sidecar folder not created + +--- + +# TRANSITION CRITERIA + +**Ready for Step 8 when:** +- Agent YAML successfully created (with or without sidecar as specified) +- User selects continue +- All build artifacts confirmed written diff --git a/_bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md b/_bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md deleted file mode 100644 index 812fa40..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -name: 'step-06-build-simple' -description: 'Generate Simple agent YAML from plan' - -# File References -nextStepFile: './step-08a-plan-traceability.md' -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' -agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}.agent.yaml' - -# Template and Architecture -simpleTemplate: ../templates/simple-agent.template.md -simpleArch: ../data/simple-agent-architecture.md -agentCompilation: ../data/agent-compilation.md - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL - -Assemble the agent plan content into a Simple agent YAML configuration using the template, producing a complete agent definition ready for validation. - -## MANDATORY EXECUTION RULES - -- **MUST** read all referenced files before beginning assembly -- **MUST** use exact YAML structure from template -- **MUST** preserve all plan content without modification -- **MUST** maintain proper YAML indentation and formatting -- **MUST NOT** deviate from template structure -- **MUST** write output before asking validation question -- **MUST** present validation choice clearly - -## EXECUTION PROTOCOLS - -### File Loading Sequence -1. Read `simpleTemplate` - provides the YAML structure -2. Read `simpleArch` - defines Simple agent architecture rules -3. Read `agentCompilation` - provides assembly guidelines -4. Read `agentPlan` - contains structured content from steps 2-5 - -### YAML Assembly Process -1. Parse template structure -2. Extract content sections from agentPlan YAML -3. Map plan content to template fields -4. Validate YAML syntax before writing -5. Write complete agent YAML to output path - -## CONTEXT BOUNDARIES - -**INCLUDE:** -- Template structure exactly as provided -- All agent metadata from agentPlan -- Persona, commands, and rules from plan -- Configuration options specified - -**EXCLUDE:** -- Any content not in agentPlan -- Sidecar file references (Simple agents don't use them) -- Template placeholders (replace with actual content) -- Comments or notes in final YAML - -## EXECUTION SEQUENCE - -### 1. Load Template and Architecture Files - -Read the following files in order: -- `simpleTemplate` - YAML structure template -- `simpleArch` - Simple agent architecture definition -- `agentCompilation` - Assembly instructions - -**Verify:** All files loaded successfully. - -### 2. Load Agent Plan - -Read `agentPlan` which contains structured YAML from steps 2-5: -- Step 2: Discovery findings -- Step 3: Persona development -- Step 4: Command structure -- Step 5: Agent naming - -**Verify:** Plan contains all required sections. - -### 3. Assemble YAML Using Template - -Execute the following assembly process: - -1. **Parse Template Structure** - - Identify all YAML fields - - Note required vs optional fields - - Map field types and formats - -2. **Extract Plan Content** - - Read agent metadata - - Extract persona definition - - Retrieve command specifications - - Gather rules and constraints - -3. **Map Content to Template** - - Replace template placeholders with plan content - - Maintain exact YAML structure - - Preserve indentation and formatting - - Validate field types and values - -4. **Validate YAML Syntax** - - Check proper indentation - - Verify quote usage - - Ensure list formatting - - Confirm no syntax errors - -**Verify:** YAML is valid, complete, and follows template structure. - -### 4. Write Agent Build Output - -Write the assembled YAML to `agentBuildOutput`: -- Use exact output path from variable -- Include all content without truncation -- Maintain YAML formatting -- Confirm write operation succeeded - -**Verify:** File written successfully and contains complete YAML. - -### 5. Present MENU OPTIONS - -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: Write agent YAML to {agentBuildOutput}/{agent-name}.agent.yaml (or appropriate output path), 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. Route Based on User Choice - -**If user chooses "one-at-a-time":** -- Proceed to `nextStepFile` (step-07a-plan-traceability.md) -- Continue through each validation step sequentially -- Allow review between each validation - -**If user chooses "YOLO":** -- Run all validation steps (7A through 7F) consecutively -- Do not pause between validations -- After all validations complete, proceed to Step 8 -- Present summary of all validation results - -## 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. - -## SUCCESS METRICS - -**SUCCESS looks like:** -- Agent YAML file exists at specified output path -- YAML is syntactically valid and well-formed -- All template fields populated with plan content -- Structure matches Simple agent architecture -- User has selected validation approach -- Clear next step identified - -**FAILURE looks like:** -- Template or architecture files not found -- Agent plan missing required sections -- YAML syntax errors in output -- Content not properly mapped to template -- File write operation fails -- User selection unclear - -## TRANSITION CRITERIA - -**Ready for Step 7A when:** -- Simple agent YAML successfully created -- User chooses "one-at-a-time" validation - -**Ready for Step 8 when:** -- Simple agent YAML successfully created -- User chooses "YOLO" validation -- All validations (7A-7F) completed consecutively diff --git a/_bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md b/_bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md deleted file mode 100644 index fe8df2e..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -name: 'step-06-build-expert' -description: 'Generate Expert agent YAML with sidecar from plan' - -# File References -nextStepFile: './step-08a-plan-traceability.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' - -# Template and Architecture -expertTemplate: ../templates/expert-agent-template/expert-agent.template.md -expertArch: ../data/expert-agent-architecture.md -agentCompilation: ../data/agent-compilation.md -criticalActions: ../data/critical-actions.md - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -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. - -## 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 -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 -6. **NO DRIFT**: Use ONLY content from agentPlan - no additions or interpretations - -## EXECUTION PROTOCOLS - -### Phase 1: Load Architecture and Templates -1. Read `expertTemplate` - defines YAML structure for Expert agents -2. Read `expertArch` - architecture requirements for Expert-level agents -3. Read `agentCompilation` - assembly rules for YAML generation -4. Read `criticalActions` - validation requirements for critical_actions - -### Phase 2: Load Agent Plan -1. Read `agentPlan` containing all collected content from Steps 1-5 -2. Verify plan contains: - - Agent type: "expert" - - Sidecar folder name - - Persona content - - Commands structure - - Critical actions (if applicable) - -### Phase 3: Assemble Expert YAML -Using expertTemplate as structure: - -```yaml -name: '{agent-name}' -description: '{short-description}' -type: 'expert' -version: '1.0.0' - -author: - name: '{author}' - created: '{date}' - -persona: | - {multi-line persona content from plan} - -system-context: | - {expanded context from plan} - -capabilities: - - {capability from plan} - - {capability from plan} - # ... all capabilities - -critical-actions: - - name: '{action-name}' - description: '{what it does}' - invocation: '{when/how to invoke}' - implementation: | - {multi-line implementation} - output: '{expected-output}' - sidecar-folder: '{sidecar-folder-name}' - sidecar-files: - - '{project-root}/_bmad/_memory/{sidecar-folder}/{file1}.md' - - '{project-root}/_bmad/_memory/{sidecar-folder}/{file2}.md' - # ... all critical actions referencing sidecar structure - -commands: - - name: '{command-name}' - description: '{what command does}' - steps: - - {step 1} - - {step 2} - # ... all commands from plan - -configuration: - temperature: {temperature} - max-tokens: {max-tokens} - response-format: {format} - # ... other configuration from plan - -metadata: - sidecar-folder: '{sidecar-folder-name}' - sidecar-path: '{project-root}/_bmad/_memory/{sidecar-folder}/' - agent-type: 'expert' - memory-type: 'persistent' -``` - -### Phase 4: Create Sidecar Structure - -1. **Create Sidecar Directory**: - - Path: `{project-root}/_bmad/_memory/{sidecar-folder}/` - - Use `mkdir -p` to create full path - -2. **Create Starter Files** (if specified in critical_actions): - ```bash - touch _bmad/_memory/{sidecar-folder}/{file1}.md - touch _bmad/_memory/{sidecar-folder}/{file2}.md - ``` - -3. **Add README to Sidecar**: - ```markdown - # {sidecar-folder} Memory - - This folder stores persistent memory for the **{agent-name}** Expert agent. - - ## Purpose - {purpose from critical_actions} - - ## Files - - {file1}.md: {description} - - {file2}.md: {description} - - ## Access Pattern - Agent accesses these files via: `{project-root}/_bmad/_memory/{sidecar-folder}/{filename}.md` - ``` - -### Phase 5: Write Agent YAML - -1. Create `agentBuildOutput` directory: `mkdir -p {agentBuildOutput}` -2. Write YAML to `agentYamlOutput` -3. Confirm write success -4. Display file location to user - -### Phase 6: Present MENU OPTIONS - -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: Write agent YAML to {agentBuildOutput}/{agent-name}/{agent-name}.agent.yaml (or appropriate output path), 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](#phase-6-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 - -- **USE ONLY**: Content from agentPlan, expertTemplate, expertArch, agentCompilation, criticalActions -- **DO NOT ADD**: New capabilities, commands, or actions not in plan -- **DO NOT INTERPRET**: Use exact language from plan -- **DO NOT SKIP**: Any field in expertTemplate structure -- **CRITICAL**: Expert agents MUST have sidecar-folder metadata - -## 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. - -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}/` - -Both must exist before proceeding to validation. - -## SUCCESS METRICS - -✅ 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 contains starter files from critical_actions -✅ critical_actions reference `{project-root}/_bmad/_memory/{sidecar-folder}/` paths -✅ metadata.sidecar-folder populated -✅ metadata.agent-type = "expert" -✅ User validation choice received (one-at-a-time or YOLO) - -## FAILURE MODES - -❌ Missing required template fields -❌ Invalid YAML syntax -❌ Sidecar folder creation failed -❌ critical_actions missing sidecar-folder references -❌ agentPlan missing expert-specific content (sidecar-folder name) -❌ File write permission errors diff --git a/_bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md b/_bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md deleted file mode 100644 index baab038..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -name: 'step-06-build-module' -description: 'Generate Module agent YAML from plan' - -# File References -nextStepFile: './step-08a-plan-traceability.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' - -# Template and Architecture (use expert as baseline) -expertTemplate: ../templates/expert-agent-template/expert-agent.template.md -expertArch: ../data/expert-agent-architecture.md -agentCompilation: ../data/agent-compilation.md -criticalActions: ../data/critical-actions.md - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# STEP GOAL -Assemble the Module agent YAML file from the approved plan, using the expert agent template as the baseline architecture and adding module-specific workflow integration paths and sidecar configuration. - -# MANDATORY EXECUTION RULES - -1. **TEMPLATE BASELINE**: Module agents MUST use the expert agent template as their structural foundation - do not create custom templates - -2. **PLAN ADHERENCE**: Extract content from agentPlan exactly as written - no enhancement, interpretation, or extrapolation - -3. **MODULE SPECIFICITY**: Module agents require workflow integration paths and may need sidecar configuration for multi-workflow modules - -4. **OUTPUT VALIDATION**: YAML must be valid, complete, and ready for immediate deployment - -5. **LANGUAGE PRESERVATION**: Maintain any language choice configured in the plan throughout the YAML - -# EXECUTION PROTOCOLS - -## PREPARATION PHASE - -### 1. Load Expert Template Baseline -``` -Read: expertTemplate -Read: expertArch -Read: agentCompilation -Read: criticalActions -``` - -**Purpose**: Understand the expert agent structure that serves as the Module agent baseline - -**Validation**: Confirm expert template has all required sections (name, description, persona, instructions, tools, skills, etc.) - -### 2. Load Agent Plan -``` -Read: agentPlan (using dynamic path) -``` - -**Validation**: Plan contains all mandatory sections: -- Agent identity (name, description) -- Persona profile -- Command structure -- Critical actions -- Workflow integrations (module-specific) -- Language choice (if configured) - -### 3. Verify Output Directory -``` -Bash: mkdir -p {agentBuildOutput} -``` - -**Purpose**: Ensure output directory exists for the module agent - -## ASSEMBLY PHASE - -### 4. Assemble Module Agent YAML - -**FROM PLAN TO YAML MAPPING:** - -| Plan Section | YAML Field | Notes | -|--------------|------------|-------| -| Agent Name | `name` | Plan → YAML | -| Description | `description` | Plan → YAML | -| Persona | `persona` | Plan → YAML | -| Instructions | `instructions` | Plan → YAML (verbatim) | -| Commands | `commands` | Plan → YAML (with handlers) | -| Critical Actions | `criticalActions` | Plan → YAML (mandatory) | -| Workflow Paths | `skills` | Module-specific | -| Sidecar Need | `sidecar` | If multi-workflow | - -**MODULE-SPECIAL ENHANCEMENTS:** - -```yaml -# Module agents include workflow integration -skills: - - workflow: "{project-root}/_bmad/{module-id}/workflows/{workflow-name}/workflow.md" - description: "From plan workflow list" - - workflow: "{project-root}/_bmad/{module-id}/workflows/{another-workflow}/workflow.md" - description: "From plan workflow list" - -# Optional: Sidecar for complex modules -sidecar: - enabled: true - workflows: - - ref: "primary-workflow" - type: "primary" - - ref: "secondary-workflow" - type: "support" -``` - -**CRITICAL ACTIONS MAPPING:** -``` -For each critical action in plan: -1. Identify matching command in YAML -2. Add `critical: true` flag -3. Ensure handler references agent function -``` - -### 5. Create Sidecar (If Needed) - -**SIDEAR REQUIRED IF:** -- Module has 3+ workflows -- Workflows have complex interdependencies -- Module needs initialization workflow - -**SIDECAR STRUCTURE:** -```yaml -# {agent-name}.sidecar.yaml -sidecar: - module: "{module-id}" - initialization: - workflow: "workflow-init" - required: true - workflows: - - name: "workflow-name" - path: "workflows/{workflow-name}/workflow.md" - type: "primary|support|utility" - dependencies: [] - agent: - path: "{agent-name}.agent.yaml" -``` - -**IF SIDEAR NOT NEEDED**: Skip this step - -### 6. Write Module Agent YAML -``` -Write: agentYamlOutput (using dynamic path) -Content: Assembled YAML from step 4 -``` - -**Validation Checklist:** -- [ ] All plan fields present in YAML -- [ ] Workflow paths are valid and correct -- [ ] Critical actions flagged -- [ ] Sidecar created (if needed) or skipped (if not) -- [ ] YAML syntax is valid -- [ ] Language choice preserved throughout - -## COMPLETION PHASE - -### 7. Present MENU OPTIONS - -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: Write agent YAML to {agentBuildOutput}/{agent-name}/{agent-name}.agent.yaml (or appropriate output path), 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) - -#### 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 - -**USER RESPONSE HANDLING:** -- **Option 1**: Proceed to step-07a-plan-traceability.md with sequential mode -- **Option 2**: Proceed to step-07a-plan-traceability.md with yolo mode -- **Invalid input**: Re-ask with options - -# CONTEXT BOUNDARIES - -**IN SCOPE:** -- Reading expert template and architecture -- Loading agent plan -- Assembling Module agent YAML -- Creating sidecar (if needed) -- Writing valid YAML output - -**OUT OF SCOPE:** -- Modifying plan content -- Creating new template structures -- Implementing agent code -- Writing workflow files -- Testing agent functionality - -**DO NOT:** -- Add commands not in plan -- Modify persona from plan -- Create custom template structures -- Skip critical actions mapping -- Assume sidecar need - evaluate based on workflow count - -# 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. - -**THIS STEP IS COMPLETE WHEN:** -1. Module agent YAML file exists at agentYamlOutput path -2. YAML contains all plan content correctly mapped -3. Module-specific workflow paths are configured -4. Sidecar is created (if needed) or correctly skipped (if not) -5. User has chosen review mode (one-at-a-time or YOLO) -6. Ready to proceed to step-07a-plan-traceability.md - -**STOP BEFORE:** -- Writing workflow implementations -- Creating agent code files -- Testing agent functionality -- Deploying to active system - -# SUCCESS METRICS - -**COMPLETION:** -- [ ] Module agent YAML exists with all required fields -- [ ] All plan content accurately mapped to YAML -- [ ] Workflow integration paths configured correctly -- [ ] Critical actions properly flagged -- [ ] Sidecar created or correctly skipped -- [ ] YAML syntax is valid -- [ ] User confirms review mode choice -- [ ] Transitions to step-07a-plan-traceability.md - -**VALIDATION:** -- Plan-to-YAML mapping: 100% accuracy -- Workflow paths: All valid and correct -- Critical actions: All present and flagged -- Sidecar decision: Correctly evaluated -- Language choice: Preserved throughout - -# FAILURE MODES - -**IF PLAN MISSING CONTENT:** -→ Return to step-02-discover.md to complete plan - -**IF EXPERT TEMPLATE MISSING:** -→ Raise error - template is mandatory baseline - -**IF YAML SYNTAX ERROR:** -→ Fix and retry write operation - -**IF WORKFLOW PATHS INVALID:** -→ Flag for review in traceability step - -**IF USER ASKS FOR MODIFICATIONS:** -→ Return to appropriate planning step (03-persona, 04-commands, or 05-name) diff --git a/_bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md b/_bmad/bmb/workflows/agent/steps-c/step-08-celebrate.md similarity index 87% rename from _bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md rename to _bmad/bmb/workflows/agent/steps-c/step-08-celebrate.md index 794766c..51b898c 100644 --- a/_bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md +++ b/_bmad/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: @@ -59,7 +60,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 @@ -196,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/_bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md b/_bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md deleted file mode 100644 index bc1989b..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +++ /dev/null @@ -1,203 +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 - -# SEQUENCE - -## 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/_bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md b/_bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md deleted file mode 100644 index 900d3a7..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md +++ /dev/null @@ -1,135 +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 - - [ ] version: Present and follows semantic versioning (X.Y.Z) - - [ ] 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) - - [ ] version: Follows semver pattern (e.g., 1.0.0) - - [ ] 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 -✓ Version format valid (1.0.0) -✓ 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) -``` -✗ Missing required field: version -✗ Invalid version format: "v1.0" (should be "1.0.0") -✗ 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/_bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md b/_bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md deleted file mode 100644 index 7b21c4f..0000000 --- a/_bmad/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/_bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md b/_bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md deleted file mode 100644 index a5510e6..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md +++ /dev/null @@ -1,158 +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 - -### 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 -``` - -### 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/_bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md b/_bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md deleted file mode 100644 index 3fcec5a..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +++ /dev/null @@ -1,306 +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 - -# EXECUTION SEQUENCE - -## 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/_bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md b/_bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md deleted file mode 100644 index 2ffcdae..0000000 --- a/_bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +++ /dev/null @@ -1,462 +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 - -# EXECUTION SEQUENCE - -## 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/_bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md b/_bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md index c48ba19..8dc43ea 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md +++ b/_bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md @@ -4,7 +4,7 @@ description: 'Load and analyze existing agent for editing' # File References thisStepFile: ./e-01-load-existing.md -workflowFile: ../workflow.md +workflowFile: ../workflow-edit-agent.md nextStepFile: './e-02-discover-edits.md' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' agentMetadata: ../data/agent-metadata.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 @@ -74,14 +76,20 @@ Expected format: `{path-to-agent}/{agent-name}.agent.yaml`" ### 2. Parse Agent Structure +If the module property of the agent metadata is `stand-alone`, it is not a module agent. +If the module property of the agent is a module code (like bmm, bmb, etc...) it is a module agent. +If the property hasSidecar: true exists in the metadata, then it is an expert agent. +Else it is a simple agent. +If a module agent also hasSidecar: true - this means it is a modules expert agent, thus it can have sidecar. + **Extract and categorize all agent components:** ```yaml # Basic Metadata - name: {agent-name} - description: {agent-description} -- type: {simple|expert|module} -- version: {version} +- module: {stand-alone|bmm|cis|bmgd|custom} +- hasSidecar: {true|false} # Persona - persona: {full persona text} @@ -104,8 +112,7 @@ Expected format: `{path-to-agent}/{agent-name}.agent.yaml`" ```markdown ## Agent Analysis: {agent-name} -**Type:** {simple|expert|module} -**Version:** {version} +**Type:** {simple|expert|module} (derived from module + hasSidecar) **Status:** ready-for-edit ### Current Structure: diff --git a/_bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md b/_bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md index dd2889c..2a36d1f 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md +++ b/_bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md @@ -2,7 +2,7 @@ name: 'e-02-discover-edits' description: 'Discover what user wants to change about the agent' -nextStepFile: './e-03a-validate-metadata.md' +nextStepFile: './e-04-sidecar-metadata.md' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -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 @@ -72,8 +74,8 @@ I can help you modify: **[P]ersona** - Role, identity, communication style, principles **[C]ommands** - Add, remove, or modify commands and menu structure **[M]etadata** - Name, description, version, tags, category +**[S]idecar** - Add or remove memory (convert hasSidecar: true/false) **[A]ctions** - Critical actions and activation behaviors -**[T]ype** - Convert between Simple/Expert/Module types **[O]ther** - Configuration, capabilities, system context Which areas would you like to edit? (You can select multiple)" @@ -105,10 +107,10 @@ Which areas would you like to edit? (You can select multiple)" - "Should new activation behaviors be added?" - "Are current actions executing as expected?" -#### If Type conversion selected: -- "What type are you converting from/to?" -- "What's driving this conversion?" -- "Are you aware of the implications (e.g., Expert needs sidecar)?" +#### If Sidecar selected: +- "Do you want to add memory (hasSidecar: true) or remove it (hasSidecar: false)?" +- "What should the agent remember across sessions?" +- "Are you aware of the implications?" ### 4. Document Edits to Plan @@ -133,8 +135,9 @@ Which areas would you like to edit? (You can select multiple)" - [ ] {edit description} - [ ] {edit description} -### Type Conversion -- [ ] {from: X, to: Y, rationale: ...} +### Sidecar Conversion +- [ ] {from: hasSidecar: false, to: hasSidecar: true, rationale: ...} +- [ ] {from: hasSidecar: true, to: hasSidecar: false, rationale: ...} ### Other Edits - [ ] {edit description} @@ -168,7 +171,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 [all edits documented and confirmed by user], will you then load and read fully `{nextStepFile}` to execute and begin validation. +ONLY WHEN [C continue option] is selected and [all edits documented and confirmed by user], will you then load and read fully `{nextStepFile}` to execute and checks. --- diff --git a/_bmad/bmb/workflows/agent/steps-e/e-03-placeholder.md b/_bmad/bmb/workflows/agent/steps-e/e-03-placeholder.md new file mode 100644 index 0000000..5edd9ca --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md b/_bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md deleted file mode 100644 index bbf1aab..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -name: 'e-03a-validate-metadata' -description: 'Validate metadata (before edit) - no menu, auto-advance' - -nextStepFile: './e-03b-validate-persona.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentMetadata: ../data/agent-metadata.md ---- - -# Edit Step 3a: Validate Metadata (Before Edit) - -## STEP GOAL: - -Validate the agent's metadata properties against BMAD standards. Record findings to editPlan and auto-advance to next validation step. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and agentMetadata first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate metadata against agentMetadata.md rules -- 📊 Record findings to editPlan frontmatter -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load agentMetadata.md reference -- 📊 Validate all metadata fields -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{agentMetadata}` to understand validation rules. -Read `{editPlan}` to get agent file path and metadata. - -### 2. Validate Metadata - -Perform checks on: -- **id**: kebab-case, no spaces -- **name**: display name, clear branding -- **title**: concise function description -- **icon**: appropriate emoji or symbol -- **module**: correct format `{project}:{type}:{name}` -- **hasSidecar**: boolean, matches actual sidecar usage - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml -validationBefore: - metadata: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -When validation complete, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All metadata checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to persona validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md b/_bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md deleted file mode 100644 index 478ffb4..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -name: 'e-03b-validate-persona' -description: 'Validate persona (before edit) - no menu, auto-advance' - -nextStepFile: './e-03c-validate-menu.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -personaProperties: ../data/persona-properties.md -principlesCrafting: ../data/principles-crafting.md ---- - -# Edit Step 3b: Validate Persona (Before Edit) - -## STEP GOAL: - -Validate the agent's persona fields against BMAD standards. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and persona references first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate persona four-field system -- 📊 Record findings to editPlan frontmatter -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load personaProperties.md and principlesCrafting.md -- 📊 Validate persona fields -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{personaProperties}` and `{principlesCrafting}`. -Read `{editPlan}` to get agent file path and persona. - -### 2. Validate Persona - -Perform checks on: -- **role**: present, specific, not generic -- **identity**: present, defines who agent is -- **communication_style**: present, speech patterns only (no behavioral words) -- **principles**: present, first principle activates expert knowledge, not generic duties - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - persona: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -When validation complete, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All persona checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to menu validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md b/_bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md deleted file mode 100644 index 4fff43b..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -name: 'e-03c-validate-menu' -description: 'Validate menu structure (before edit) - no menu, auto-advance' - -nextStepFile: './e-03d-validate-structure.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentMenuPatterns: ../data/agent-menu-patterns.md ---- - -# Edit Step 3c: Validate Menu (Before Edit) - -## STEP GOAL: - -Validate the agent's command menu structure against BMAD standards. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and agentMenuPatterns first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate command/menu structure -- 📊 Record findings to editPlan frontmatter -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load agentMenuPatterns.md reference -- 📊 Validate commands and menu -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{agentMenuPatterns}`. -Read `{editPlan}` to get agent file path and commands. - -### 2. Validate Menu - -Perform checks on: -- **A/P/C convention**: each menu has Advanced Elicitation, Party Mode, Continue -- **Command names**: clear, descriptive -- **Command descriptions**: specific, actionable -- **Menu handling logic**: properly specified - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - menu: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -When validation complete, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All menu checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to structure validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md b/_bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md deleted file mode 100644 index f2dbbd9..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -name: 'e-03d-validate-structure' -description: 'Validate YAML structure (before edit) - no menu, auto-advance' - -nextStepFile: './e-03e-validate-sidecar.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentCompilation: ../data/agent-compilation.md ---- - -# Edit Step 3d: Validate Structure (Before Edit) - -## STEP GOAL: - -Validate the agent's YAML structure and completeness. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and agentCompilation first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate YAML structure and required fields -- 📊 Record findings to editPlan frontmatter -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load agentCompilation.md reference -- 📊 Validate YAML structure -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{agentCompilation}`. -Read `{editPlan}` to get agent file path. - -### 2. Validate Structure - -Perform checks on: -- **YAML syntax**: valid, no parse errors -- **Required fields**: name, description, type, persona present -- **Field types**: arrays where expected, strings where expected -- **Indentation**: consistent 2-space indentation - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - structure: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -When validation complete, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All structure checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to sidecar validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md b/_bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md deleted file mode 100644 index 3bdb0ac..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -name: 'e-03e-validate-sidecar' -description: 'Validate sidecar structure (before edit) - no menu, auto-advance' - -nextStepFile: './e-03f-validation-summary.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -expertValidation: ../data/expert-agent-validation.md ---- - -# Edit Step 3e: Validate Sidecar (Before Edit) - -## STEP GOAL: - -Validate the agent's sidecar structure if Expert type. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and expertValidation first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate sidecar structure for Expert agents -- 📊 Record findings to editPlan frontmatter -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load expertValidation.md reference -- 📊 Validate sidecar if Expert type, skip for Simple/Module -- 💾 Record findings to editPlan -- ➡️ Auto-advance to validation summary when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{expertValidation}`. -Read `{editPlan}` to get agent type. - -### 2. Conditional Validation - -**IF agentType == expert:** -- Check metadata.sidecar-folder is present -- Check sidecar-path is correct format -- Verify sidecar files exist at specified path - -**IF agentType != expert:** -- Mark as N/A (not applicable) -- Skip detailed checks - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - sidecar: - status: [pass|fail|warning|n/a] - findings: - - {check}: [pass|fail|n/a] - - {check}: [pass|fail|n/a] -``` - -### 4. Auto-Advance - -When validation complete, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ Sidecar checks performed (or N/A recorded) -✅ Findings saved to editPlan -✅ Auto-advanced to validation summary - ---- - -**Auto-advancing to validation summary...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md b/_bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md deleted file mode 100644 index 43a91fb..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -name: 'e-03f-validation-summary' -description: 'Display all validation findings before edit' - -nextStepFile: './e-04-type-metadata.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 3f: Validation Summary (Before Edit) - -## STEP GOAL: - -Display all validation findings from the previous 5 validation steps to the user. Present findings clearly and await confirmation to proceed. - -## 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 -- 📊 Aggregate findings from all 5 validation steps -- 💬 Present options for handling any issues found - -## EXECUTION PROTOCOLS: - -- 🎯 Read editPlan to get validation findings -- 📊 Display organized summary -- 💾 Allow user to decide how to proceed -- ➡️ Proceed to edit plan on [C] - -## Sequence of Instructions: - -### 1. Load Validation Findings - -Read `{editPlan}` frontmatter to collect: -- validationBefore.metadata.status and findings -- validationBefore.persona.status and findings -- validationBefore.menu.status and findings -- validationBefore.structure.status and findings -- validationBefore.sidecar.status and findings - -### 2. Display Validation Summary - -```markdown -## Pre-Edit Validation Report for {agent-name} - -### Metadata Validation -**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} -{Findings summary} - -### Persona Validation -**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} -{Findings summary} - -### Menu Validation -**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} -{Findings summary} - -### Structure Validation -**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} -{Findings summary} - -### Sidecar Validation -**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL / N/A} -{Findings summary} -``` - -### 3. Present Options - -"How would you like to proceed? - -**[I**ntegrate fixes**] - Add validation fixes to your edit plan -**[S]kip** - Proceed with your planned edits only -**[A]dvanced** - Deeper exploration of any issues" - -### 4. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Edit Plan" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu -- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu -- IF I: Add validation fixes to editPlan, 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 begin edit planning. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All validation findings displayed clearly -- User given options for handling issues -- Validation summary saved to editPlan - -### ❌ 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/_bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md b/_bmad/bmb/workflows/agent/steps-e/e-04-sidecar-metadata.md similarity index 73% rename from _bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md rename to _bmad/bmb/workflows/agent/steps-e/e-04-sidecar-metadata.md index d7d37a5..112c588 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md +++ b/_bmad/bmb/workflows/agent/steps-e/e-04-sidecar-metadata.md @@ -1,5 +1,5 @@ --- -name: 'e-04-type-metadata' +name: 'e-04-sidecar-metadata' description: 'Review and plan metadata edits' nextStepFile: './e-05-persona.md' @@ -11,11 +11,11 @@ advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitati partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- -# Edit Step 4: Type and Metadata +# Edit Step 4: Sidecar and Metadata ## STEP GOAL: -Review the agent's type and metadata, and plan any changes. If edits involve type conversion, identify the implications. +Review the agent's hasSidecar decision and metadata, and plan any changes. If edits involve sidecar conversion, identify the implications. ## MANDATORY EXECUTION RULES: @@ -26,7 +26,7 @@ Review the agent's type and metadata, and plan any changes. If edits involve typ ### Step-Specific Rules: - 🎯 Load reference documents before discussing edits -- 📊 Document type conversion requirements if applicable +- 📊 Document sidecar conversion requirements if applicable - 💬 Focus on metadata that user wants to change ## EXECUTION PROTOCOLS: @@ -36,26 +36,30 @@ 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 -Read `{agentMetadata}` and `{agentTypesDoc}` to understand validation rules and type implications. +Read `{agentMetadata}` and `{agentTypesDoc}` to understand validation rules and sidecar implications. ### 2. Review Current Metadata From `{editPlan}`, display current: -- agentType (simple/expert/module) -- All metadata fields: id, name, title, icon, module, hasSidecar +- hasSidecar (true/false) +- All metadata fields: id, name, title, icon, module ### 3. Discuss Metadata Edits If user wants metadata changes: -**For type conversion:** -- "Converting from {current} to {target}" -- Explain implications (e.g., Simple → Expert requires sidecar) -- Update editPlan with type conversion +**For sidecar conversion:** +- "Converting from hasSidecar: {current} to {target}" +- Explain implications: + - false → true: Need to create sidecar folder, add critical_actions with sidecar file loading + - true → false: Remove sidecar fields; if critical_actions only has sidecar references, remove section; otherwise keep non-sidecar critical_actions +- Update editPlan with conversion **For metadata field changes:** - id: kebab-case requirements @@ -63,7 +67,6 @@ If user wants metadata changes: - title: function description format - icon: emoji/symbol - module: path format -- hasSidecar: boolean implications ### 4. Document to Edit Plan @@ -71,9 +74,9 @@ Append to `{editPlan}`: ```yaml metadataEdits: - typeConversion: - from: {current-type} - to: {target-type} + sidecarConversion: + from: {current-hasSidecar} + to: {target-hasSidecar} rationale: {explanation} fieldChanges: - field: {field-name} @@ -110,13 +113,13 @@ ONLY WHEN [C continue option] is selected and [metadata changes documented], wil - Reference documents loaded - Metadata changes discussed and documented -- Type conversion implications understood +- Sidecar conversion implications understood - Edit plan updated ### ❌ SYSTEM FAILURE: - Proceeded without loading reference documents -- Type conversion without understanding implications +- Sidecar conversion without understanding implications - Changes not documented to edit plan **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/workflows/agent/steps-e/e-05-persona.md b/_bmad/bmb/workflows/agent/steps-e/e-05-persona.md index 32b3cda..df3b737 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-05-persona.md +++ b/_bmad/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/_bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md b/_bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md index 37bad72..a647dc5 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md +++ b/_bmad/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/_bmad/bmb/workflows/agent/steps-e/e-07-activation.md b/_bmad/bmb/workflows/agent/steps-e/e-07-activation.md index bd071a9..f6633d7 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-07-activation.md +++ b/_bmad/bmb/workflows/agent/steps-e/e-07-activation.md @@ -1,14 +1,12 @@ --- name: 'e-07-activation' -description: 'Review critical_actions and route to type-specific edit' +description: 'Review critical_actions and route to edit step' editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' criticalActions: ../data/critical-actions.md -# Type-specific edit routes -simpleEdit: './e-08a-edit-simple.md' -expertEdit: './e-08b-edit-expert.md' -moduleEdit: './e-08c-edit-module.md' +# Edit step route (determined by hasSidecar) +agentEdit: './e-08-edit-agent.md' advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' @@ -18,52 +16,56 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ## STEP GOAL: -Review critical_actions and route to the appropriate type-specific edit step (Simple/Expert/Module). +Review critical_actions and route to the agent edit step based on hasSidecar value. ## MANDATORY EXECUTION RULES: - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Load criticalActions and editPlan first -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}}` +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: - 🎯 Load criticalActions.md before discussing activation -- 📊 Determine target type for routing -- 💬 Route based on POST-EDIT agent type +- 📊 Determine hasSidecar for routing +- 💬 Route based on POST-EDIT hasSidecar value ## EXECUTION PROTOCOLS: - 🎯 Load criticalActions.md -- 📊 Check editPlan for target agent type -- 💾 Route to appropriate type-specific edit step -- ➡️ Auto-advance to type-specific edit on [C] +- 📊 Check editPlan for target hasSidecar value +- 💾 Route to agent edit step +- ➡️ Auto-advance to edit step 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 Read `{criticalActions}` and `{editPlan}` to understand: - Current critical_actions (if any) -- Target agent type after edits +- Target hasSidecar value after edits ### 2. Review Critical Actions If user wants to add/modify critical_actions: - Reference patterns from criticalActions.md - Define action name, description, invocation -- For Expert agents: specify sidecar-folder and file paths +- For hasSidecar: true — specify sidecar-folder and file paths ### 3. Determine Routing -Check `{editPlan}` metadataEdits.typeConversion.to or current agentType: +Check `{editPlan}` for agent metadata (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 +# Simple routing based on hasSidecar +hasSidecar: true → route to e-08-edit-agent.md (create sidecar structure) +hasSidecar: false → route to e-08-edit-agent.md (single YAML file) ``` +The edit step handles both cases based on hasSidecar value. + ### 4. Document to Edit Plan Append to `{editPlan}`: @@ -74,19 +76,19 @@ activationEdits: additions: [] modifications: [] routing: - destinationEdit: {e-08a|e-08b|e-08c} - targetType: {simple|expert|module} + destinationEdit: e-08-edit-agent.md + hasSidecar: {true|false} # Derived from edit plan ``` ### 5. Present MENU OPTIONS -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Type-Specific Edit" +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Edit Agent" #### 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 to {editPlan}, determine routing based on targetType, then only then load and execute the appropriate type-specific edit step +- IF C: Save to {editPlan}, then only then load and execute the agent edit step - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) #### EXECUTION RULES: @@ -97,11 +99,10 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont ## CRITICAL STEP COMPLETION NOTE -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: +This is the **ROUTING HUB** for edit flow. ONLY WHEN [C continue option] is selected and [routing determined], load and execute the agent edit step: -- targetType: simple → e-08a-edit-simple.md -- targetType: expert → e-08b-edit-expert.md -- targetType: module → e-08c-edit-module.md +- hasSidecar: false → Single YAML file edit +- hasSidecar: true → YAML + sidecar folder structure edit --- @@ -110,13 +111,13 @@ This is the **ROUTING HUB** for edit flow. ONLY WHEN [C continue option] is sele ### ✅ SUCCESS: - criticalActions.md loaded -- Routing determined based on target type +- Routing determined based on hasSidecar - Edit plan updated with routing info ### ❌ SYSTEM FAILURE: - Proceeded without loading reference documents - Routing not determined -- Wrong type-specific edit step selected +- Wrong edit step selected **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/workflows/agent/steps-e/e-08-edit-agent.md b/_bmad/bmb/workflows/agent/steps-e/e-08-edit-agent.md new file mode 100644 index 0000000..4cde076 --- /dev/null +++ b/_bmad/bmb/workflows/agent/steps-e/e-08-edit-agent.md @@ -0,0 +1,196 @@ +--- +name: 'e-08-edit-agent' +description: 'Apply edits to agent (with or without sidecar)' + +nextStepFile: './e-09-celebrate.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentFile: '{original-agent-path}' +agentBackup: '{original-agent-path}.backup' + +# Template and Architecture +agentTemplate: ../templates/agent-template.md +agentArch: ../data/agent-architecture.md +agentValidation: ../data/agent-validation.md +agentCompilation: ../data/agent-compilation.md +agentMetadata: ../data/agent-metadata.md +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +agentMenuPatterns: ../data/agent-menu-patterns.md +criticalActions: ../data/critical-actions.md + +# Reference examples +noSidecarExample: ../data/reference/without-sidecar/commit-poet.agent.yaml +withSidecarExample: ../data/reference/with-sidecar/journal-keeper/journal-keeper.agent.yaml + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 8: Edit Agent + +## STEP GOAL: + +Apply all planned edits to the agent YAML file. The edit approach (with or without sidecar) is determined by the `hasSidecar` value from the edit plan. + +## MANDATORY EXECUTION RULES: + +- 🛑 ALWAYS create backup before modifying agent file +- 📖 CRITICAL: Read template and architecture files first +- 🔄 CRITICAL: Load editPlan and agentFile +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load all reference files before applying edits +- 📊 Apply edits exactly as specified in editPlan +- 💾 Validate YAML after each edit +- 🎭 Handle sidecar structure if hasSidecar: true +- ➡️ Auto-advance to celebration when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Load template, architecture, and validation files +- 📊 Read editPlan to get all planned changes +- 💾 Create backup +- 📝 Apply edits: sidecar conversion, metadata, persona, commands, critical_actions +- 🎭 Manage sidecar folder structure (if applicable) +- ✅ Validate YAML and sidecar paths +- ➡️ Auto-advance to next step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read all files before editing: +- `{agentTemplate}` - YAML structure reference +- `{agentArch}` - Agent architecture (with/without sidecar) +- `{agentValidation}` - Validation checklist +- `{agentCompilation}` - Assembly guidelines +- `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` +- `{agentMenuPatterns}`, `{criticalActions}` + +### 2. Load Edit Plan and Agent + +Read `{editPlan}` to get all planned edits. +Read `{agentFile}` to get current agent YAML. + +Check the `hasSidecar` value from editPlan to determine edit approach. + +### 3. Create Backup + +ALWAYS backup before editing: +```bash +cp {agentFile} {agentBackup} +``` + +Confirm: "Backup created at: `{agentBackup}`" + +### 4. Apply Edits in Sequence + +For each planned edit: + +**Sidecar Conversion:** + +**false → true (Adding sidecar):** +- Set `hasSidecar: true` +- Add `metadata.sidecar-folder` if not present +- Add `critical_actions` section with sidecar file references +- Create sidecar directory: `{agent-folder}/{agent-name}-sidecar/` +- Create starter files: `memories.md`, `instructions.md` +- Update all references to use `{project-root}/_bmad/_memory/{sidecar-folder}/` format + +**true → false (Removing sidecar):** +- Set `hasSidecar: false` +- Remove `metadata.sidecar-folder` and `metadata.sidecar-path` +- If critical_actions contains only sidecar references, remove the section +- If critical_actions contains non-sidecar activation behaviors, keep and clean sidecar references +- Remove sidecar references from menu actions +- Optionally archive sidecar folder + +**Metadata Edits:** +- Apply each field change from metadataEdits +- Validate format conventions + +**Persona Edits:** +- Replace persona section with new four-field persona +- Validate field purity (role ≠ identity ≠ communication_style) +- For hasSidecar: true, ensure communication_style includes memory reference patterns + +**Command Edits:** +- Additions: append to commands array +- Modifications: update specific commands +- Removals: remove from commands array + +**Critical Actions Edits (hasSidecar: true only):** +- Additions: append to critical_actions array +- Modifications: update specific actions +- Removals: remove from array +- Ensure all references use correct `{project-root}/_bmad/_memory/` paths + +### 5. Validate After Each Edit + +**For both types:** +- Confirm YAML syntax is valid after each modification + +**For hasSidecar: true:** +- Validate sidecar path format +- Ensure all critical_actions reference correct paths +- Confirm sidecar folder structure exists + +### 6. Document Applied Edits + +Append to `{editPlan}`: + +```yaml +editsApplied: + - {edit-description} + - {edit-description} +backup: {agentBackup} +timestamp: {YYYY-MM-DD HH:MM} +``` + +### 7. Present MENU OPTIONS + +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 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](#7-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 [all edits applied and validated], will you then load and read fully `{nextStepFile}` to execute and celebrate. + +--- + +## SUCCESS METRICS + +✅ Backup created +✅ All reference files loaded +✅ All edits applied correctly +✅ YAML remains valid +✅ Sidecar structure correct (if hasSidecar: true) +✅ Sidecar paths validated (if hasSidecar: true) +✅ Edit plan tracking updated + +## FAILURE MODES + +❌ Backup failed +❌ YAML became invalid +❌ Sidecar paths broken (hasSidecar: true) +❌ Edits not applied as specified + +--- + +**Auto-advancing to celebration when complete...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md b/_bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md deleted file mode 100644 index d92bb27..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -name: 'e-08a-edit-simple' -description: 'Apply edits to Simple agent' - -nextStepFile: './e-09a-validate-metadata.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentFile: '{original-agent-path}' -agentBackup: '{original-agent-path}.backup' - -# Template and Architecture -simpleTemplate: ../templates/simple-agent.template.md -simpleArch: ../data/simple-agent-architecture.md -agentCompilation: ../data/agent-compilation.md -agentMetadata: ../data/agent-metadata.md -personaProperties: ../data/persona-properties.md -principlesCrafting: ../data/principles-crafting.md -agentMenuPatterns: ../data/agent-menu-patterns.md -criticalActions: ../data/critical-actions.md ---- - -# Edit Step 8a: Edit Simple Agent - -## STEP GOAL: - -Apply all planned edits to the Simple agent YAML file using templates and architecture references for validation. - -## MANDATORY EXECUTION RULES: - -- 🛑 ALWAYS create backup before modifying agent file -- 📖 CRITICAL: Read template and architecture files first -- 🔄 CRITICAL: Load editPlan and agentFile -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Step-Specific Rules: - -- 🎯 Load all reference files before applying edits -- 📊 Apply edits exactly as specified in editPlan -- 💾 Validate YAML after each edit -- ➡️ Auto-advance to post-edit validation when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load template, architecture, and data files -- 📊 Read editPlan to get all planned changes -- 💾 Create backup -- 📝 Apply edits: type conversion, metadata, persona, commands, critical_actions -- ✅ Validate YAML syntax -- ➡️ Auto-advance to next validation step - -## Sequence of Instructions: - -### 1. Load Reference Documents - -Read all files before editing: -- `{simpleTemplate}` - YAML structure reference -- `{simpleArch}` - Simple agent architecture -- `{agentCompilation}` - Assembly guidelines -- `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` -- `{agentMenuPatterns}`, `{criticalActions}` - -### 2. Load Edit Plan and Agent - -Read `{editPlan}` to get all planned edits. -Read `{agentFile}` to get current agent YAML. - -### 3. Create Backup - -ALWAYS backup before editing: -`cp {agentFile} {agentBackup}` - -Confirm: "Backup created at: `{agentBackup}`" - -### 4. Apply Edits in Sequence - -For each planned edit: - -**Type Conversion:** -- Update `type:` field if converting -- Add/remove type-specific fields - -**Metadata Edits:** -- Apply each field change from metadataEdits - -**Persona Edits:** -- Replace persona section with new four-field persona -- Validate field purity (role ≠ identity ≠ communication_style) - -**Command Edits:** -- Additions: append to commands array -- Modifications: update specific commands -- Removals: remove from commands array - -**Critical Actions Edits:** -- Additions: append to critical_actions array -- Modifications: update specific actions -- Removals: remove from array - -### 5. Validate YAML After Each Edit - -Confirm YAML syntax is valid after each modification. - -### 6. Document Applied Edits - -Append to `{editPlan}`: - -```yaml -editsApplied: - - {edit-description} - - {edit-description} -backup: {agentBackup} -timestamp: {YYYY-MM-DD HH:MM} -``` - -### 7. Auto-Advance - -When all edits applied successfully, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ Backup created -✅ All reference files loaded -✅ All edits applied correctly -✅ YAML remains valid -✅ Edit plan tracking updated - -## FAILURE MODES - -❌ Backup failed -❌ YAML became invalid -❌ Edits not applied as specified - ---- - -**Auto-advancing to post-edit validation... diff --git a/_bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md b/_bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md deleted file mode 100644 index 394ccdb..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -name: 'e-08b-edit-expert' -description: 'Apply edits to Expert agent' - -nextStepFile: './e-09a-validate-metadata.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentFile: '{original-agent-path}' -agentBackup: '{original-agent-path}.backup' - -# Template and Architecture -expertTemplate: ../templates/expert-agent-template/expert-agent.template.md -expertArch: ../data/expert-agent-architecture.md -agentCompilation: ../data/agent-compilation.md -agentMetadata: ../data/agent-metadata.md -personaProperties: ../data/persona-properties.md -principlesCrafting: ../data/principles-crafting.md -agentMenuPatterns: ../data/agent-menu-patterns.md -criticalActions: ../data/critical-actions.md -expertValidation: ../data/expert-agent-validation.md ---- - -# Edit Step 8b: Edit Expert Agent - -## STEP GOAL: - -Apply all planned edits to the Expert agent YAML file and manage sidecar structure changes. - -## MANDATORY EXECUTION RULES: - -- 🛑 ALWAYS create backup before modifying agent file -- 📖 CRITICAL: Read template and architecture files first -- 🔄 CRITICAL: Load editPlan and agentFile -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Step-Specific Rules: - -- 🎯 Load all reference files before applying edits -- 📊 Manage sidecar structure for Expert agents -- 💾 Validate YAML and sidecar paths after edits -- ➡️ Auto-advance to post-edit validation when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load template, architecture, and data files -- 📊 Read editPlan to get all planned changes -- 💾 Create backup -- 📝 Apply edits including sidecar management -- ✅ Validate YAML and sidecar paths -- ➡️ Auto-advance to next validation step - -## Sequence of Instructions: - -### 1. Load Reference Documents - -Read all files before editing: -- `{expertTemplate}` - Expert YAML structure -- `{expertArch}` - Expert agent architecture -- `{agentCompilation}`, `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` -- `{agentMenuPatterns}`, `{criticalActions}`, `{expertValidation}` - -### 2. Load Edit Plan and Agent - -Read `{editPlan}` to get all planned edits. -Read `{agentFile}` to get current agent YAML. - -### 3. Create Backup - -ALWAYS backup before editing: -`cp {agentFile} {agentBackup}` - -### 4. Apply Edits in Sequence - -**Type Conversion to Expert:** -- Update `type: expert` -- Add `metadata.sidecar-folder` if not present -- Create sidecar directory: `mkdir -p {project-root}/_bmad/_memory/{sidecar-folder}/` - -**Sidecar Management:** -- If changing sidecar-folder: update all critical_actions references -- If removing sidecar (Expert → Simple): remove sidecar fields and folder -- Create/update sidecar files as needed - -**Metadata, Persona, Commands, Critical Actions:** -- Same as Simple agent edit - -### 5. Validate Sidecar Paths - -After editing, confirm all critical_actions reference correct sidecar paths: -`{project-root}/_bmad/_memory/{sidecar-folder}/{file}.md` - -### 6. Document Applied Edits - -Append to `{editPlan}` with sidecar changes noted. - -### 7. Auto-Advance - -When all edits applied successfully, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ Backup created -✅ All reference files loaded -✅ All edits applied correctly -✅ YAML remains valid -✅ Sidecar structure correct -✅ Sidecar paths validated - -## FAILURE MODES - -❌ Backup failed -❌ YAML became invalid -❌ Sidecar paths broken -❌ Edits not applied as specified - ---- - -**Auto-advancing to post-edit validation... diff --git a/_bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md b/_bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md deleted file mode 100644 index 2ace310..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -name: 'e-08c-edit-module' -description: 'Apply edits to Module agent' - -nextStepFile: './e-09a-validate-metadata.md' -editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' -agentFile: '{original-agent-path}' -agentBackup: '{original-agent-path}.backup' - -# Template and Architecture (use expert as baseline for Module) -expertTemplate: ../templates/expert-agent-template/expert-agent.template.md -expertArch: ../data/expert-agent-architecture.md -moduleArch: ../data/module-agent-validation.md -agentCompilation: ../data/agent-compilation.md -agentMetadata: ../data/agent-metadata.md -personaProperties: ../data/persona-properties.md -principlesCrafting: ../data/principles-crafting.md -agentMenuPatterns: ../data/agent-menu-patterns.md -criticalActions: ../data/critical-actions.md ---- - -# Edit Step 8c: Edit Module Agent - -## STEP GOAL: - -Apply all planned edits to the Module agent YAML file and manage workflow integration and sidecar structure. - -## MANDATORY EXECUTION RULES: - -- 🛑 ALWAYS create backup before modifying agent file -- 📖 CRITICAL: Read template and architecture files first -- 🔄 CRITICAL: Load editPlan and agentFile -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -### Step-Specific Rules: - -- 🎯 Load all reference files before applying edits -- 📊 Manage workflow integration paths for Module agents -- 💾 Validate YAML and workflow paths after edits -- ➡️ Auto-advance to post-edit validation when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load template, architecture, and data files -- 📊 Read editPlan to get all planned changes -- 💾 Create backup -- 📝 Apply edits including workflow paths -- ✅ Validate YAML and workflow paths -- ➡️ Auto-advance to next validation step - -## Sequence of Instructions: - -### 1. Load Reference Documents - -Read all files before editing: -- `{expertTemplate}` - Module uses expert as baseline -- `{expertArch}`, `{moduleArch}` - Architecture references -- `{agentCompilation}`, `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` -- `{agentMenuPatterns}`, `{criticalActions}` - -### 2. Load Edit Plan and Agent - -Read `{editPlan}` to get all planned edits. -Read `{agentFile}` to get current agent YAML. - -### 3. Create Backup - -ALWAYS backup before editing: -`cp {agentFile} {agentBackup}` - -### 4. Apply Edits in Sequence - -**Type Conversion to Module:** -- Update `type: module` -- Add workflow integration paths - -**Workflow Path Management:** -- Add: `skills: - workflow: {path}` -- Remove: delete workflow entries -- Modify: update workflow paths - -**Sidecar for Multi-Workflow Modules:** -- If 3+ workflows: consider sidecar creation -- Add sidecar configuration if needed - -**Metadata, Persona, Commands, Critical Actions:** -- Same as Expert agent edit - -### 5. Validate Workflow Paths - -After editing, confirm all workflow paths are valid: -`{project-root}/_bmad/{module-id}/workflows/{workflow-name}/workflow.md` - -### 6. Document Applied Edits - -Append to `{editPlan}` with workflow changes noted. - -### 7. Auto-Advance - -When all edits applied successfully, load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ Backup created -✅ All reference files loaded -✅ All edits applied correctly -✅ YAML remains valid -✅ Workflow paths validated -✅ Sidecar structure correct (if applicable) - -## FAILURE MODES - -❌ Backup failed -❌ YAML became invalid -❌ Workflow paths broken -❌ Edits not applied as specified - ---- - -**Auto-advancing to post-edit validation... diff --git a/_bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md b/_bmad/bmb/workflows/agent/steps-e/e-09-celebrate.md similarity index 78% rename from _bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md rename to _bmad/bmb/workflows/agent/steps-e/e-09-celebrate.md index 5486e16..e7e935c 100644 --- a/_bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md +++ b/_bmad/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: @@ -48,7 +49,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 @@ -110,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/_bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md b/_bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md deleted file mode 100644 index 21cbcc2..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +++ /dev/null @@ -1,70 +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 ---- - -# Edit Step 9a: Validate Metadata (After Edit) - -## STEP GOAL: - -Validate the agent's metadata properties after edits. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and agentMetadata first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate metadata against agentMetadata.md rules -- 📊 Record findings to editPlan frontmatter (validationAfter section) -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load agentMetadata.md reference -- 📊 Validate all metadata fields -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{agentMetadata}` and `{editPlan}`. - -### 2. Validate Metadata - -Perform checks on id, name, title, icon, module, hasSidecar. - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml -validationAfter: - metadata: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -Load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All metadata checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to persona validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md b/_bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md deleted file mode 100644 index dac0a79..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +++ /dev/null @@ -1,70 +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 ---- - -# Edit Step 9b: Validate Persona (After Edit) - -## STEP GOAL: - -Validate the agent's persona after edits. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and persona references first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate persona four-field system -- 📊 Record findings to editPlan frontmatter (validationAfter section) -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load personaProperties.md and principlesCrafting.md -- 📊 Validate persona fields -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{personaProperties}`, `{principlesCrafting}`, and `{editPlan}`. - -### 2. Validate Persona - -Perform checks on role, identity, communication_style, principles. - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - persona: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -Load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All persona checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to menu validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md b/_bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md deleted file mode 100644 index d9944f4..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +++ /dev/null @@ -1,69 +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 ---- - -# Edit Step 9c: Validate Menu (After Edit) - -## STEP GOAL: - -Validate the agent's command menu structure after edits. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and agentMenuPatterns first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate command/menu structure -- 📊 Record findings to editPlan frontmatter (validationAfter section) -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load agentMenuPatterns.md reference -- 📊 Validate commands and menu -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{agentMenuPatterns}` and `{editPlan}`. - -### 2. Validate Menu - -Perform checks on A/P/C convention, command names, descriptions. - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - menu: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -Load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All menu checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to structure validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md b/_bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md deleted file mode 100644 index a52538e..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +++ /dev/null @@ -1,69 +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' -agentCompilation: ../data/agent-compilation.md ---- - -# Edit Step 9d: Validate Structure (After Edit) - -## STEP GOAL: - -Validate the agent's YAML structure after edits. Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and agentCompilation first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate YAML structure and required fields -- 📊 Record findings to editPlan frontmatter (validationAfter section) -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load agentCompilation.md reference -- 📊 Validate YAML structure -- 💾 Record findings to editPlan -- ➡️ Auto-advance to next validation step when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{agentCompilation}` and `{editPlan}`. - -### 2. Validate Structure - -Perform checks on YAML syntax, required fields, field types, indentation. - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - structure: - status: [pass|fail|warning] - findings: - - {check}: [pass|fail] -``` - -### 4. Auto-Advance - -Load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ All structure checks performed and recorded -✅ Findings saved to editPlan -✅ Auto-advanced to next step - ---- - -**Auto-advancing to sidecar validation...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md b/_bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md deleted file mode 100644 index 4db7afc..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +++ /dev/null @@ -1,70 +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 ---- - -# Edit Step 9e: Validate Sidecar (After Edit) - -## STEP GOAL: - -Validate the agent's sidecar structure after edits (if Expert type). Record findings to editPlan and auto-advance. - -## MANDATORY EXECUTION RULES: - -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read editPlan and expertValidation first -- 🚫 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}` - -### Step-Specific Rules: - -- 🎯 Validate sidecar structure for Expert agents -- 📊 Record findings to editPlan frontmatter (validationAfter section) -- 🚫 FORBIDDEN to present menu - auto-advance when complete - -## EXECUTION PROTOCOLS: - -- 🎯 Load expertValidation.md reference -- 📊 Validate sidecar if Expert type, skip for Simple/Module -- 💾 Record findings to editPlan -- ➡️ Auto-advance to validation summary when complete - -## Sequence of Instructions: - -### 1. Load References - -Read `{expertValidation}` and `{editPlan}` to get agent type. - -### 2. Conditional Validation - -**IF agentType == expert:** Check sidecar-folder, sidecar-path, file existence -**IF agentType != expert:** Mark as N/A - -### 3. Record Findings - -Append to editPlan frontmatter: - -```yaml - sidecar: - status: [pass|fail|warning|n/a] - findings: - - {check}: [pass|fail|n/a] -``` - -### 4. Auto-Advance - -Load and execute `{nextStepFile}` immediately. - -## SUCCESS METRICS - -✅ Sidecar checks performed (or N/A recorded) -✅ Findings saved to editPlan -✅ Auto-advanced to validation summary - ---- - -**Auto-advancing to validation summary...** diff --git a/_bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md b/_bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md deleted file mode 100644 index dfbba1d..0000000 --- a/_bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +++ /dev/null @@ -1,111 +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 - -## Sequence of Instructions: - -### 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/_bmad/bmb/workflows/agent/steps-v/v-01-load-review.md b/_bmad/bmb/workflows/agent/steps-v/v-01-load-review.md index 0e6a6df..b36107d 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-01-load-review.md +++ b/_bmad/bmb/workflows/agent/steps-v/v-01-load-review.md @@ -34,26 +34,34 @@ 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 Read the complete YAML from the agent file path provided by the user. +Check the metadata to determine agent configuration: +- **module**: `stand-alone` or module code (bmm, cis, bmgd, etc.) +- **hasSidecar**: `true` or `false` + ### 2. Display Agent Summary ```markdown ## Agent to Validate: {agent-name} -**Type:** {simple|expert|module} -**Version:** {version} +**Configuration:** Agent {WITH|WITHOUT} sidecar +**hasSidecar:** {true|false} +**module:** {module-value} **File:** {agent-file-path} ### Current Structure: **Persona:** {character count} characters **Commands:** {count} commands -**Critical Actions:** {count} actions +**Critical Actions:** {count} actions (if hasSidecar: true) +**Sidecar:** {present|not present} ``` ### 3. Create Validation Report @@ -63,7 +71,8 @@ Initialize the validation report: ```markdown --- agentName: '{agent-name}' -agentType: '{simple|expert|module}' +hasSidecar: {true|false} +module: '{module-value}' agentFile: '{agent-file-path}' validationDate: '{YYYY-MM-DD}' stepsCompleted: @@ -75,8 +84,8 @@ stepsCompleted: ## Agent Overview **Name:** {agent-name} -**Type:** {simple|expert|module} -**Version:** {version} +**hasSidecar:** {true|false} +**module:** {module-value} **File:** {agent-file-path} --- @@ -90,7 +99,7 @@ Write to `{validationReport}`. ### 4. Present MENU OPTIONS -Display: "**Is this the correct agent to validate?** [A] Advanced Elicitation [P] Party Mode [C] Yes, Begin Validation" +Display: "**Is this the correct agent to validate and is it identified as the proper configuration?** [A] Advanced Elicitation [P] Party Mode [C] Yes, Begin Validation" #### Menu Handling Logic: diff --git a/_bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md b/_bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md index e082807..381460f 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +++ b/_bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md @@ -5,18 +5,20 @@ description: 'Validate metadata and append to report' nextStepFile: './v-02b-validate-persona.md' validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' agentMetadata: ../data/agent-metadata.md +agentFile: '{agent-file-path}' --- # Validate Step 2a: Validate Metadata -## STEP GOAL: +## STEP GOAL -Validate the agent's metadata properties against BMAD standards. Append findings to validation report and auto-advance. +Validate the agent's metadata properties against BMAD standards as defined in agentMetadata.md. Append findings to validation report and auto-advance. -## MANDATORY EXECUTION RULES: +## MANDATORY EXECUTION RULES - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Read validationReport and agentMetadata first +- 🔄 CRITICAL: Load the actual agent file to validate metadata - 🚫 NO MENU - append findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` @@ -26,22 +28,55 @@ Validate the agent's metadata properties against BMAD standards. Append findings - 📊 Append findings to validation report - 🚫 FORBIDDEN to present menu -## EXECUTION PROTOCOLS: +## EXECUTION PROTOCOLS - 🎯 Load agentMetadata.md reference +- 🎯 Load the actual agent file for validation - 📊 Validate all metadata fields - 💾 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 -Read `{agentMetadata}` and `{validationReport}`. +Read `{agentMetadata}`, `{validationReport}`, and `{agentFile}`. ### 2. Validate Metadata -Perform checks on: id, name, title, icon, module, hasSidecar. +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 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 ### 3. Append Findings to Report @@ -53,15 +88,23 @@ Append to `{validationReport}`: **Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} **Checks:** -- [ ] id: kebab-case, no spaces +- [ ] id: kebab-case, no spaces, unique - [ ] name: clear display name - [ ] title: concise function description - [ ] icon: appropriate emoji/symbol -- [ ] module: correct format `{project}:{type}:{name}` +- [ ] module: correct format (code or stand-alone) - [ ] hasSidecar: matches actual usage -**Findings:** -{Detailed findings} +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} ``` ### 4. Auto-Advance diff --git a/_bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md b/_bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md index 7876a7e..acae4a9 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +++ b/_bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md @@ -6,43 +6,87 @@ nextStepFile: './v-02c-validate-menu.md' validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' personaProperties: ../data/persona-properties.md principlesCrafting: ../data/principles-crafting.md +agentFile: '{agent-file-path}' --- # Validate Step 2b: Validate Persona -## STEP GOAL: +## STEP GOAL -Validate the agent's persona against BMAD standards. Append findings to validation report and auto-advance. +Validate the agent's persona against BMAD standards as defined in personaProperties.md and principlesCrafting.md. Append findings to validation report and auto-advance. -## MANDATORY EXECUTION RULES: +## MANDATORY EXECUTION RULES - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Read validationReport and persona references first +- 🔄 CRITICAL: Load the actual agent file to validate persona - 🚫 NO MENU - append findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: -- 🎯 Validate persona four-field system +- 🎯 Validate persona against personaProperties.md rules - 📊 Append findings to validation report - 🚫 FORBIDDEN to present menu -## EXECUTION PROTOCOLS: +## EXECUTION PROTOCOLS - 🎯 Load personaProperties.md and principlesCrafting.md +- 🎯 Load the actual agent file for validation - 📊 Validate persona fields - 💾 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 -Read `{personaProperties}`, `{principlesCrafting}`, and `{validationReport}`. +Read `{personaProperties}`, `{principlesCrafting}`, `{validationReport}`, and `{agentFile}`. ### 2. Validate Persona -Perform checks on: role, identity, communication_style, principles. +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 domain knowledge + +6. **Consistency Checks** + - [ ] Role, identity, communication_style, principles all align + - [ ] No contradictions between principles + - [ ] Persona supports the menu items defined + - [ ] Language and terminology consistent ### 3. Append Findings to Report @@ -57,10 +101,18 @@ Append to `{validationReport}`: - [ ] role: specific, not generic - [ ] identity: defines who agent is - [ ] communication_style: speech patterns only -- [ ] principles: first principle activates expert knowledge +- [ ] principles: first principle activates domain knowledge -**Findings:** -{Detailed findings} +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} ``` ### 4. Auto-Advance diff --git a/_bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md b/_bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md index 0faf491..ccc7b6a 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +++ b/_bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md @@ -5,43 +5,88 @@ description: 'Validate menu structure and append to report' nextStepFile: './v-02d-validate-structure.md' validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' agentMenuPatterns: ../data/agent-menu-patterns.md +agentFile: '{agent-file-path}' --- # Validate Step 2c: Validate Menu -## STEP GOAL: +## STEP GOAL -Validate the agent's command menu structure against BMAD standards. Append findings to validation report and auto-advance. +Validate the agent's command menu structure against BMAD standards as defined in agentMenuPatterns.md. Append findings to validation report and auto-advance. -## MANDATORY EXECUTION RULES: +## MANDATORY EXECUTION RULES - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Read validationReport and agentMenuPatterns first +- 🔄 CRITICAL: Load the actual agent file to validate menu - 🚫 NO MENU - append findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: -- 🎯 Validate command/menu structure +- 🎯 Validate menu against agentMenuPatterns.md rules - 📊 Append findings to validation report - 🚫 FORBIDDEN to present menu -## EXECUTION PROTOCOLS: +## EXECUTION PROTOCOLS - 🎯 Load agentMenuPatterns.md reference +- 🎯 Load the actual agent file for validation - 📊 Validate commands and menu - 💾 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 -Read `{agentMenuPatterns}` and `{validationReport}`. +Read `{agentMenuPatterns}`, `{validationReport}`, and `{agentFile}`. ### 2. Validate Menu -Perform checks on: A/P/C convention, command names, descriptions. +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 (trigger, description, action) + +2. **Menu Item Requirements** + For each menu item: + - [ ] trigger: Present, follows `XX or fuzzy match on command` format + - [ ] description: Clear and concise, starts with `[XX]` code + - [ ] action: Prompt reference (#id) or inline instruction + +3. **Trigger Format Validation** + - [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code) + - [ ] Codes are unique within agent + - [ ] No reserved codes used: MH, CH, PM, DA + +4. **Description Format Validation** + - [ ] Descriptions start with `[XX]` code + - [ ] Code in description matches trigger code + - [ ] Descriptions are clear and descriptive + +5. **Action Handler Validation** + - [ ] If `action: '#prompt-id'`, corresponding prompt exists + - [ ] If `action: 'inline text'`, instruction is complete and clear + +6. **Alignment Checks** + - [ ] Menu items align with agent's role/purpose + - [ ] Menu items are appropriate for target users + - [ ] Menu scope is appropriate (not too sparse/overloaded) + +7. **Configuration Specific Menu Handler Validation** + - [ ] Determine hasSidecar from metadata + - [ ] For hasSidecar: true: + - [ ] Menu handlers MAY reference sidecar files using correct path format + - [ ] Sidecar references use: `{project-root}/_bmad/_memory/{sidecar-folder}/...` + - [ ] For hasSidecar: false: + - [ ] Menu handlers MUST NOT have sidecar file links + - [ ] Menu handlers use only internal references (#) or inline prompts ### 3. Append Findings to Report @@ -52,14 +97,25 @@ Append to `{validationReport}`: **Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} -**Checks:** -- [ ] A/P/C convention followed -- [ ] Command names clear and descriptive -- [ ] Command descriptions specific and actionable -- [ ] Menu handling logic properly specified +**hasSidecar:** {true|false} -**Findings:** -{Detailed findings} +**Checks:** +- [ ] Triggers follow `XX or fuzzy match on command` format +- [ ] Descriptions start with `[XX]` code +- [ ] No reserved codes (MH, CH, PM, DA) +- [ ] Action handlers valid (#prompt-id or inline) +- [ ] Configuration appropriate menu links + +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} ``` ### 4. Auto-Advance diff --git a/_bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md b/_bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md index 1c1b0b4..e8f0c5a 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +++ b/_bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md @@ -4,44 +4,94 @@ description: 'Validate YAML structure and append to report' nextStepFile: './v-02e-validate-sidecar.md' validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +agentValidation: ../data/agent-validation.md agentCompilation: ../data/agent-compilation.md +agentFile: '{agent-file-path}' --- # Validate Step 2d: Validate Structure -## STEP GOAL: +## STEP GOAL -Validate the agent's YAML structure and completeness. Append findings to validation report and auto-advance. +Validate the agent's YAML structure and completeness against BMAD standards as defined in agentCompilation.md. Append findings to validation report and auto-advance. -## MANDATORY EXECUTION RULES: +## MANDATORY EXECUTION RULES - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Read validationReport and agentCompilation first +- 🔄 CRITICAL: Load the actual agent file to validate structure - 🚫 NO MENU - append findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: -- 🎯 Validate YAML structure and required fields +- 🎯 Validate structure against agentCompilation.md rules - 📊 Append findings to validation report - 🚫 FORBIDDEN to present menu -## EXECUTION PROTOCOLS: +## EXECUTION PROTOCOLS - 🎯 Load agentCompilation.md reference +- 🎯 Load the actual agent file for validation - 📊 Validate YAML structure - 💾 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 -Read `{agentCompilation}` and `{validationReport}`. +Read `{agentCompilation}`, `{agentValidation}`, `{validationReport}`, and `{agentFile}`. ### 2. Validate Structure -Perform checks on: YAML syntax, required fields, field types, indentation. +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 hasSidecar value +- [ ] 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 Configuration Specific Checks + +**For Agents WITHOUT Sidecar (hasSidecar is false):** +- [ ] No sidecar requirements +- [ ] No sidecar-folder path in metadata +- [ ] If critical_actions present, no sidecar file references +- [ ] Menu handlers use only internal references (#) or inline prompts +- [ ] Total size under ~250 lines (unless justified) + +**For Agents WITH Sidecar (hasSidecar is true):** +- [ ] hasSidecar flag set correctly in metadata +- [ ] Sidecar folder path specified in metadata +- [ ] critical_actions section present with minimum requirements: + - [ ] Loads sidecar memories + - [ ] Loads sidecar instructions + - [ ] Restricts file access to sidecar folder +- [ ] All critical_actions reference correct `{project-root}/_bmad/_memory/` paths +- [ ] Menu handlers that update sidecar use correct path format ### 3. Append Findings to Report @@ -52,14 +102,27 @@ Append to `{validationReport}`: **Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} +**Configuration:** Agent {WITH|WITHOUT} sidecar + +**hasSidecar:** {true|false} + **Checks:** - [ ] Valid YAML syntax -- [ ] Required fields present (name, description, type, persona) -- [ ] Field types correct (arrays, strings) +- [ ] Required fields present (name, description, persona, menu) +- [ ] Field types correct (arrays, strings, booleans) - [ ] Consistent 2-space indentation +- [ ] Configuration appropriate structure -**Findings:** -{Detailed findings} +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} ``` ### 4. Auto-Advance diff --git a/_bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md b/_bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md index 2b70d1c..1c58bf3 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +++ b/_bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md @@ -4,50 +4,93 @@ description: 'Validate sidecar structure and append to report' nextStepFile: './v-03-summary.md' validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' -expertValidation: ../data/expert-agent-validation.md +agentValidation: ../data/agent-validation.md +criticalActions: ../data/critical-actions.md +agentFile: '{agent-file-path}' +sidecarFolder: '{agent-sidecar-folder}' --- # Validate Step 2e: Validate Sidecar -## STEP GOAL: +## STEP GOAL -Validate the agent's sidecar structure (if Expert type). Append findings to validation report and auto-advance. +Validate the agent's sidecar structure (if hasSidecar: true) against BMAD standards as defined in agentValidation.md. Append findings to validation report and auto-advance. -## MANDATORY EXECUTION RULES: +## MANDATORY EXECUTION RULES - 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read validationReport and expertValidation first +- 🔄 CRITICAL: Read validationReport and agentValidation first +- 🔄 CRITICAL: Load the actual agent file to check for sidecar - 🚫 NO MENU - append findings and auto-advance - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: -- 🎯 Validate sidecar structure for Expert agents +- 🎯 Validate sidecar against agentValidation.md rules (for agents with sidecar) - 📊 Append findings to validation report - 🚫 FORBIDDEN to present menu -## EXECUTION PROTOCOLS: +## EXECUTION PROTOCOLS -- 🎯 Load expertValidation.md reference -- 📊 Validate sidecar if Expert type, skip for Simple/Module +- 🎯 Load agentValidation.md reference +- 🎯 Load the actual agent file for validation +- 📊 Validate sidecar if hasSidecar: true, skip for hasSidecar: false - 💾 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 -Read `{expertValidation}` and `{validationReport}` to get agent type. +Read `{agentValidation}`, `{criticalActions}`, `{validationReport}`, and `{agentFile}`. ### 2. Conditional Validation -**IF agentType == expert:** -- Check metadata.sidecar-folder present -- Check sidecar-path correct format -- Verify sidecar files exist +**IF hasSidecar = true:** +Perform these checks systematically - validate EVERY rule specified in agentValidation.md: -**IF agentType != expert:** -- Mark as N/A +#### 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 (memories.md, instructions.md recommended) +- [ ] 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 path format is correct: `{project-root}/_bmad/_memory/{sidecar-folder}/...` +- [ ] `{project-root}` is literal +- [ ] `{sidecar-folder}` is actual folder name +- [ ] Validate no broken path references + +#### D. Critical Actions Validation (MANDATORY for hasSidecar: true) +- [ ] critical_actions section exists in agent YAML +- [ ] Contains at minimum 3 actions +- [ ] Loads sidecar memories: `{project-root}/_bmad/_memory/{sidecar-folder}/memories.md` +- [ ] Loads sidecar instructions: `{project-root}/_bmad/_memory/{sidecar-folder}/instructions.md` +- [ ] Restricts file access: `ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/` +- [ ] No placeholder text in critical_actions +- [ ] No compiler-injected steps + +#### E. 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 agent requirements + +**IF hasSidecar = false:** +- [ ] Mark sidecar validation as N/A +- [ ] Confirm no sidecar-folder path in metadata +- [ ] Confirm no sidecar references in critical_actions (if present) +- [ ] Confirm no sidecar references in menu handlers ### 3. Append Findings to Report @@ -58,13 +101,28 @@ Append to `{validationReport}`: **Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL / N/A} -**Checks:** -- [ ] metadata.sidecar-folder present (Expert only) -- [ ] sidecar-path format correct -- [ ] Sidecar files exist at specified path +**hasSidecar:** {true|false} -**Findings:** -{Detailed findings or "N/A - Not an Expert agent"} +**Checks:** +- [ ] metadata.sidecar-folder present (if hasSidecar: true) +- [ ] Sidecar path format correct: `{project-root}/_bmad/_memory/{sidecar-folder}/...` +- [ ] Sidecar files exist at specified path (if hasSidecar: true) +- [ ] All referenced files present +- [ ] No broken path references + +**Detailed Findings:** + +*PASSING (for agents WITH sidecar):* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} + +*N/A (for agents WITHOUT sidecar):* +N/A - Agent has hasSidecar: false, no sidecar required ``` ### 4. Auto-Advance diff --git a/_bmad/bmb/workflows/agent/steps-v/v-03-summary.md b/_bmad/bmb/workflows/agent/steps-v/v-03-summary.md index 21a435f..5db18a8 100644 --- a/_bmad/bmb/workflows/agent/steps-v/v-03-summary.md +++ b/_bmad/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 @@ -57,6 +59,7 @@ Read `{validationReport}` to collect all validation findings. "What would you like to do? **[E]dit Agent** - Launch edit workflow to fix issues or make improvements +**[F]ix in Place** - Confirm which fixes you would like right now and we can fix without loading the full agent edit workflow **[S]ave Report** - Save this validation report and exit **[R]etry** - Run validation again (if you've made external changes)" @@ -69,6 +72,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [E] Edit - IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu - IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu - IF E: Inform user they can launch edit workflow with the same agent file, then redisplay menu +- IF F; Attempt to make users desired fixes without loading the full edit workflow - IF S: Save final report to {validationReport} and end workflow - IF R: Restart validation from step v-01 - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-present-menu-options) diff --git a/_bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md b/_bmad/bmb/workflows/agent/templates/agent-template.md similarity index 68% rename from _bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md rename to _bmad/bmb/workflows/agent/templates/agent-template.md index aee57ec..1197927 100644 --- a/_bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md +++ b/_bmad/bmb/workflows/agent/templates/agent-template.md @@ -1,8 +1,8 @@ {{#if comment}} ------------------------------------------------------------------------------ -Expert Agent Handlebars Template -Used by: step-06-build.md to generate final agent YAML -Documentation: ../../data/expert-agent-architecture.md +Agent Handlebars Template (Unified) +Used by: step-07-build-agent.md to generate final agent YAML +Documentation: ../data/agent-architecture.md ------------------------------------------------------------------------------ {{/if}} agent: @@ -12,11 +12,16 @@ agent: title: {{agent_title}} icon: {{agent_icon}} module: {{agent_module}}{{#if agent_module_comment}} {{!-- stand-alone, bmm, cis, bmgd, or other module --}}{{/if}} + hasSidecar: {{has_sidecar}}{{#if has_sidecar_comment}} {{!-- true if agent has a sidecar folder, false otherwise --}}{{/if}} + {{#if has_sidecar}} + sidecar-folder: {{sidecar_folder}} + sidecar-path: '{project-root}/_bmad/_memory/{{sidecar_folder}}/' + {{/if}} persona: role: | {{persona_role}}{{#if persona_role_note}} - {{!-- 1-2 sentences, first person --}}{{/if}} + {{!-- 1-2 sentences, first person, what the agent does --}}{{/if}} identity: | {{persona_identity}}{{#if persona_identity_note}} @@ -24,17 +29,23 @@ agent: communication_style: | {{communication_style}}{{#if communication_style_note}} - {{!-- How the agent speaks, include memory reference patterns --}}{{/if}} + {{!-- How the agent speaks: tone, voice, mannerisms --}} + {{#if has_sidecar}} + {{!-- Include memory reference patterns: "Last time you mentioned..." or "I've noticed patterns..." --}} + {{/if}} + {{/if}} principles: {{#each principles}} - {{this}} {{/each}} + {{#if has_critical_actions}} critical_actions: {{#each critical_actions}} - '{{{this}}}' {{/each}} + {{/if}} {{#if has_prompts}} prompts: @@ -50,6 +61,8 @@ agent: - trigger: {{trigger_code}} or fuzzy match on {{trigger_command}} {{#if action_is_prompt}} action: '#{{action_id}}' + {{else if action_updates_sidecar}} + action: {{{action_inline}}} {{else}} action: {{{action_inline}}} {{/if}} diff --git a/_bmad/bmb/workflows/agent/templates/simple-agent.template.md b/_bmad/bmb/workflows/agent/templates/simple-agent.template.md deleted file mode 100644 index 86b647d..0000000 --- a/_bmad/bmb/workflows/agent/templates/simple-agent.template.md +++ /dev/null @@ -1,71 +0,0 @@ -{{#if comment}} ------------------------------------------------------------------------------- -Simple Agent Handlebars Template -Used by: step-06-build.md to generate final agent YAML -Documentation: ../data/simple-agent-architecture.md ------------------------------------------------------------------------------- -{{/if}} -agent: - metadata: - id: {{agent_id}} - name: {{agent_name}} - title: {{agent_title}} - icon: {{agent_icon}} - module: {{agent_module}}{{#if agent_module_comment}} {{!-- stand-alone, bmm, cis, bmgd, or other module --}}{{/if}} - - persona: - role: | - {{persona_role}}{{#if persona_role_note}} - {{!-- 1-2 sentences, first person --}}{{/if}} - - identity: | - {{persona_identity}}{{#if persona_identity_note}} - {{!-- 2-5 sentences, first person, background/specializations --}}{{/if}} - - communication_style: | - {{communication_style}}{{#if communication_style_note}} - {{!-- How the agent speaks: tone, voice, mannerisms --}}{{/if}} - - principles: - {{#each principles}} - - {{this}} - {{/each}} - - {{#if has_prompts}} - prompts: - {{#each prompts}} - - id: {{id}} - content: | - {{{content}}} - {{/each}} - {{/if}} - - menu: - {{#each menu_items}} - - trigger: {{trigger_code}} or fuzzy match on {{trigger_command}} - {{#if action_is_prompt}} - action: '#{{action_id}}' - {{else}} - action: {{{action_inline}}} - {{/if}} - description: '[{{trigger_code}}] {{{description}}}' - {{/each}} - - {{#if has_install_config}} - install_config: - compile_time_only: true - description: '{{install_description}}' - questions: - {{#each install_questions}} - - var: {{var_name}} - prompt: '{{prompt}}' - type: {{question_type}}{{#if question_options}} - options: - {{#each question_options}} - - label: '{{label}}' - value: '{{value}}' - {{/each}} - {{/if}} - default: {{{default_value}}} - {{/each}} - {{/if}} diff --git a/_bmad/bmb/workflows/agent/workflow-create-agent.md b/_bmad/bmb/workflows/agent/workflow-create-agent.md new file mode 100644 index 0000000..ea0e70a --- /dev/null +++ b/_bmad/bmb/workflows/agent/workflow-create-agent.md @@ -0,0 +1,72 @@ +--- +name: create-agent +description: Create a new BMAD agent with best practices and compliance +web_bundle: true +createWorkflow: './steps-c/step-01-brainstorm.md' +--- + +# Create Agent + +**Goal:** Collaboratively create BMAD Core compliant agents through guided discovery and systematic execution. + +**Your Role:** In addition to your name, communication_style, and persona, you are also an expert agent architect specializing in BMAD Core agent creation. You guide users through creating new agents with best practices and full compliance. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Steps completed in order +- **State Tracking**: Document progress in tracking files (agentPlan) +- **Mode-Aware Routing**: Create-specific step flow + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute numbered sections in order +3. **WAIT FOR INPUT**: Halt at menus and wait for user selection +4. **CHECK CONTINUATION**: Only proceed when user selects appropriate option +5. **SAVE STATE**: Update progress before loading next step +6. **LOAD NEXT**: When directed, load and execute the next step file + +### Critical Rules + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps unless explicitly optional +- 💾 **ALWAYS** save progress and outputs +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** pre-load future steps + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml`: + +- `project_name`, `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. Route to Create Workflow + +"**Create Mode: Building a new BMAD Core compliant agent from scratch.**" + +Load, read completely, then execute `{createWorkflow}` (steps-c/step-01-brainstorm.md) + +--- + +## CREATE MODE NOTES + +- Starts with optional brainstorming +- Progresses through discovery, metadata, persona, commands, activation +- Builds agent based on type (Simple/Expert/Module) +- Validates built agent +- Celebrates completion with installation guidance diff --git a/_bmad/bmb/workflows/agent/workflow-edit-agent.md b/_bmad/bmb/workflows/agent/workflow-edit-agent.md new file mode 100644 index 0000000..ec1e440 --- /dev/null +++ b/_bmad/bmb/workflows/agent/workflow-edit-agent.md @@ -0,0 +1,75 @@ +--- +name: edit-agent +description: Edit existing BMAD agents while maintaining compliance +web_bundle: true +editWorkflow: './steps-e/e-01-load-existing.md' +--- + +# Edit Agent + +**Goal:** Modify existing BMAD Core compliant agents while maintaining their integrity and compliance. + +**Your Role:** In addition to your name, communication_style, and persona, you are also an expert agent architect specializing in BMAD Core agent lifecycle management. You guide users through editing existing agents while preserving their core functionality and compliance. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Steps completed in order +- **State Tracking**: Document progress in tracking files (editPlan) +- **Mode-Aware Routing**: Edit-specific step flow + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute numbered sections in order +3. **WAIT FOR INPUT**: Halt at menus and wait for user selection +4. **CHECK CONTINUATION**: Only proceed when user selects appropriate option +5. **SAVE STATE**: Update progress before loading next step +6. **LOAD NEXT**: When directed, load and execute the next step file + +### Critical Rules + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps unless explicitly optional +- 💾 **ALWAYS** save progress and outputs +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** pre-load future steps + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml`: + +- `project_name`, `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. Route to Edit Workflow + +"**Edit Mode: Modifying an existing BMAD Core compliant agent.**" + +Prompt for agent file path: "Which agent would you like to edit? Please provide the path to the `.agent.yaml` file." + +Then load, read completely, and execute `{editWorkflow}` (steps-e/e-01-load-existing.md) + +--- + +## EDIT MODE NOTES + +- Loads existing agent first +- Discovers what user wants to change +- Validates current agent before editing +- Creates structured edit plan +- Applies changes with validation +- Celebrates successful edit diff --git a/_bmad/bmb/workflows/agent/workflow-validate-agent.md b/_bmad/bmb/workflows/agent/workflow-validate-agent.md new file mode 100644 index 0000000..a6b8492 --- /dev/null +++ b/_bmad/bmb/workflows/agent/workflow-validate-agent.md @@ -0,0 +1,73 @@ +--- +name: validate-agent +description: Validate existing BMAD agents and offer to improve deficiencies +web_bundle: true +validateWorkflow: './steps-v/v-01-load-review.md' +--- + +# Validate Agent + +**Goal:** Review existing BMAD Core compliant agents through systematic validation and generate comprehensive reports. + +**Your Role:** In addition to your name, communication_style, and persona, you are also a validation specialist and quality assurance expert for BMAD Core agents. You conduct systematic reviews and provide actionable improvement recommendations. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Steps completed in order +- **State Tracking**: Document progress in tracking files (validationReport) +- **Mode-Aware Routing**: Validate-specific step flow + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute numbered sections in order +3. **WAIT FOR INPUT**: Halt at menus and wait for user selection +4. **CHECK CONTINUATION**: Only proceed when user selects appropriate option +5. **SAVE STATE**: Update progress before loading next step +6. **LOAD NEXT**: When directed, load and execute the next step file + +### Critical Rules + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps unless explicitly optional +- 💾 **ALWAYS** save progress and outputs +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** pre-load future steps + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml`: + +- `project_name`, `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. Route to Validate Workflow + +"**Validate Mode: Reviewing an existing BMAD Core compliant agent.**" + +Prompt for agent file path: "Which agent would you like to validate? Please provide the path to the `.agent.yaml` file." + +Then load, read completely, and execute `{validateWorkflow}` (steps-v/v-01-load-review.md) + +--- + +## VALIDATE MODE NOTES + +- Loads existing agent +- Runs systematic validation (metadata, persona, menu, structure, sidecar) +- Generates comprehensive validation report +- Offers option to apply fixes if user desires diff --git a/_bmad/bmb/workflows/agent/workflow.md b/_bmad/bmb/workflows/agent/workflow.md deleted file mode 100644 index 7348562..0000000 --- a/_bmad/bmb/workflows/agent/workflow.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -name: agent -description: Tri-modal workflow for creating, editing, and validating BMAD Core compliant agents -web_bundle: true ---- - -# Agent Workflow - -**Goal:** Collaboratively create, edit, or validate BMAD Core compliant agents through guided discovery and systematic execution. - -**Your Role:** In addition to your name, communication_style, and persona, you are also an expert agent architect specializing in BMAD Core agent lifecycle management. You guide users through creating new agents, editing existing ones, or validating agent configurations. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self-contained instruction file -- **Just-In-Time Loading**: Only the current step file is in memory -- **Sequential Enforcement**: Steps completed in order, conditional based on mode -- **State Tracking**: Document progress in tracking files (agentPlan, editPlan, validationReport) -- **Mode-Aware Routing**: Separate step flows for Create/Edit/Validate - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute numbered sections in order -3. **WAIT FOR INPUT**: Halt at menus and wait for user selection -4. **CHECK CONTINUATION**: Only proceed when user selects appropriate option -5. **SAVE STATE**: Update progress before loading next step -6. **LOAD NEXT**: When directed, load and execute the next step file - -### Critical Rules - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps unless explicitly optional -- 💾 **ALWAYS** save progress and outputs -- 🎯 **ALWAYS** follow exact instructions in step files -- ⏸️ **ALWAYS** halt at menus and wait for input -- 📋 **NEVER** pre-load future steps - ---- - -## MODE OVERVIEW - -This workflow supports three modes: - -| Mode | Purpose | Entry Point | Output | -|------|---------|-------------|--------| -| **Create** | Build new agent from scratch | `steps-c/step-01-brainstorm.md` | New `.agent.yaml` file | -| **Edit** | Modify existing agent | `steps-e/e-01-load-existing.md` | Updated `.agent.yaml` file | -| **Validate** | Review existing agent | `steps-v/v-01-load-review.md` | Validation report | - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from `{project-root}/_bmad/bmb/config.yaml`: - -- `project_name`, `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. Mode Determination - -**Check if mode was specified in the command invocation:** - -- If user invoked with "create agent" or "new agent" → Set mode to **create** -- If user invoked with "edit agent" or "modify agent" → Set mode to **edit** -- If user invoked with "validate agent" or "review agent" → Set mode to **validate** - -**If mode is unclear from command, ask user:** - -"Welcome to the BMAD Agent Workflow! What would you like to do? - -**[C]reate** - Build a new agent from scratch -**[E]dit** - Modify an existing agent -**[V]alidate** - Review an existing agent and generate report - -Please select: [C]reate / [E]dit / [V]alidate" - -### 3. Route to First Step - -**IF mode == create:** -Load, read completely, then execute `steps-c/step-01-brainstorm.md` - -**IF mode == edit:** -Prompt for agent file path: "Which agent would you like to edit? Please provide the path to the `.agent.yaml` file." -Then load, read completely, and execute `steps-e/e-01-load-existing.md` - -**IF mode == validate:** -Prompt for agent file path: "Which agent would you like to validate? Please provide the path to the `.agent.yaml` file." -Then load, read completely, and execute `steps-v/v-01-load-review.md` - ---- - -## MODE-SPECIFIC NOTES - -### Create Mode -- Starts with optional brainstorming -- Progresses through discovery, metadata, persona, commands, activation -- Builds agent based on type (Simple/Expert/Module) -- Validates built agent -- Celebrates completion with installation guidance - -### Edit Mode -- Loads existing agent first -- Discovers what user wants to change -- Validates current agent before editing -- Creates structured edit plan -- Applies changes with validation -- Celebrates successful edit - -### Validate Mode -- Loads existing agent -- Runs systematic validation (metadata, persona, menu, structure, sidecar) -- Generates comprehensive validation report -- Offers option to apply fixes if user desires diff --git a/_bmad/bmb/workflows/create-module/steps/step-01-init.md b/_bmad/bmb/workflows/create-module/steps/step-01-init.md deleted file mode 100644 index 8e7d79c..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-01-init.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -nextStepFile: '{installed_path}/steps/step-02-concept.md' -continueFile: '{installed_path}/steps/step-01b-continue.md' -modulePlanTemplate: '{installed_path}/templates/module-plan.template.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -customModuleLocation: '{bmb_creations_output_folder}' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' ---- - -# Step 1: Workflow Initialization - -## STEP GOAL: - -To initialize the create-module workflow by getting the module name from the user, checking for existing work, handling continuation if needed, and creating the initial module plan document. - -## 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 Module Architect and BMAD Systems Specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD architecture and module creation, user brings their module requirements -- ✅ Maintain collaborative, guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization, getting module name, and setting up tracking -- 🚫 FORBIDDEN to look ahead to future steps -- 💬 Handle initialization professionally -- 🚪 DETECT existing workflow state and handle continuation properly - -## 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 setup 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 -- Module brief discovery happens in this step - -## SEQUENCE OF INSTRUCTIONS: - -### 1. Welcome and Get Module Name - -Greet the user warmly by their {user_name}, welcoming them to the BMAD Module Creator. Through conversation, collaboratively work with them to: - -- Understand what kind of module they want to create -- Help them choose a good name in kebab-case (provide examples if needed) -- Validate the name will work for module creation - -### 2. Check for Existing Work - -Once you have the module name: - -- Check if a folder already exists at {customModuleLocation}/{module_name} -- If it exists, look for a module plan document inside -- Read any existing work carefully to understand what was already done - -### 3. Handle Continuation (If Work Exists) - -If you find an existing module plan: - -- Review what's been completed based on the stepsCompleted array -- Present a clear summary of the current status -- Ask if they want to continue where they left off, update existing work, or start fresh -- If continuing, load step-01b-continue.md - -### 4. Look for Supporting Documents - -Check for any existing documents that could help: - -- Module briefs in the module folder or output folder -- Brainstorming results in the output folder -- Any other relevant documentation - -### 5. Guide User's Next Decision - -If no supporting documents are found: - -- Explain their three options clearly and helpfully -- Option 1: Proceed with creating the module based on their ideas -- Option 2: Exit and create a module brief first (explain the module-brief workflow) -- Option 3: Exit and do brainstorming first (explain the brainstorming workflow) -- Support whatever choice they make - -### 6. Create Module Foundation - -If proceeding: - -- Create the module folder if needed -- Create the initial module-plan-{module_name}.md document using the module plan template from {modulePlanTemplate} -- Initialize proper frontmatter with current date, user name, and add "step-01-init" to stepsCompleted array -- Add any discovered documents to inputDocuments field -- Include a brief section about the legacy reference - -### 7. Prepare for Next Step - -- Confirm everything is set up properly -- Let the user know what you've accomplished -- Transition smoothly to the next phase of defining the module concept - -### 8. Present MENU OPTIONS - -Display: **Proceeding to define your module concept...** - -#### EXECUTION RULES: - -- This is an initialization step with no user choices (after inputs handled) -- Proceed directly to next step after setup -- Use menu handling logic section below - -#### Menu Handling Logic: - -- After setup completion, add step-01-init to the end of the stepsCompleted array in module plan frontmatter, then load, read entire file, then execute `{nextStepFile}` to define the module concept - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Module name obtained and validated through collaborative dialogue -- Module plan document created from template with frontmatter initialized -- "step-01-init" added to stepsCompleted array -- Module plan document created at correct location -- User feels welcomed and informed -- Ready to proceed to step 2 -- OR existing workflow properly routed to step-01b-continue.md - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without module plan creation -- Not checking for existing documents properly -- Creating module without user input on name -- Skipping folder creation -- Not routing to step-01b-continue.md when appropriate - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN initialization setup is complete and module plan document is created (OR continuation is properly routed), will you then immediately load, read entire file, then execute `{nextStepFile}` to begin defining the module concept. diff --git a/_bmad/bmb/workflows/create-module/steps/step-01b-continue.md b/_bmad/bmb/workflows/create-module/steps/step-01b-continue.md deleted file mode 100644 index f2b3528..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-01b-continue.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' ---- - -# Step 1b: Continue Module Creation - -## 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 Module Architect and BMAD Systems Specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD architecture and module creation, user brings their module requirements -- ✅ Maintain collaborative, guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus ONLY on handling continuation and resuming workflow -- 🚫 FORBIDDEN to modify existing work without user consent -- 💬 Present status clearly and get user direction -- 📋 Track completion status accurately - -## EXECUTION PROTOCOLS: - -- 🎯 Load and analyze existing module plan -- 💾 Update frontmatter with continuation status -- 📖 Route to appropriate next step based on progress -- 🚫 FORBIDDEN to skip steps just because they exist - -## CONTEXT BOUNDARIES: - -- Module plan document exists with previous work -- Focus on understanding what's been done and what remains -- Don't assume completion without verification -- User direction guides next actions - -## STEP GOAL: - -To resume module creation by presenting current status, understanding what's been accomplished, and determining the next step in the process. - -## CONTINUATION HANDLING SEQUENCE: - -### 1. Load and Analyze Existing Module Plan - -Load module plan from: {modulePlanFile} -Read entire document including frontmatter -Extract current status from frontmatter fields: - -- stepsCompleted array -- lastStep (the final item in the stepsCompleted array) -- module_name -- module_code -- date -- inputDocuments - -### 2. Present Current Status - -"Welcome back! I found your in-progress module creation for **{module_name}**. - -**Current Status:** - -- **Module Code:** {module_code} -- **Started:** {date} -- **Last Step:** {lastStep} -- **Steps Completed:** {stepsCompleted count}/{total steps} -- **Location:** {bmb_creations_output_folder}/{module_name} - -Progress Summary:" - -Based on stepsCompleted, show: - -- [✅] Step 1: Init - Complete -- [ ] Step 2: Concept - {status} -- [ ] Step 3: Components - {status} -- [ ] Step 4: Structure - {status} -- [ ] Step 5: Configuration - {status} -- [ ] Step 6: Agents - {status} -- [ ] Step 7: Workflows - {status} -- [ ] Step 8: Installer - {status} -- [ ] Step 9: Documentation - {status} -- [ ] Step 10: Roadmap - {status} -- [ ] Step 11: Validation - {status} - -### 3. Review What's Been Done - -Read content sections of module plan -Summarize what's been accomplished: - -"**Completed Work:** - -- Module identity defined -- Component planning complete -- [Other completed items based on content]" - -### 4. Determine Next Step - -Based on stepsCompleted array: -Find highest completed step number -Next step = highest completed + 1 - -"**Ready to Continue:** -Your next step would be: **Step {nextStep} - [step name]** - -What would you like to do? - -1. **Continue** from where you left off -2. **Review** what's been done so far -3. **Modify** previous work -4. **Start over** with a new plan" - -### 5. Handle User Choice - -User your best judgement in how to handle the users choice - -### 6. Update Continuation Status - -Update modulePlanFile frontmatter: - -- Set lastStep: 'continued' -- Add note about continuation date -- Keep stepsCompleted unchanged - -## ✅ SUCCESS METRICS: - -- User understands current progress -- Next step identified correctly -- User choice handled appropriately -- Module plan updated with continuation status -- Workflow resumed at correct location - -## ❌ FAILURE MODES TO AVOID: - -- Not accurately reading previous status -- Skipping steps just because they exist -- Not offering review option -- Losing previous work -- Not updating continuation tracking - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Existing work properly loaded and analyzed -- User clearly understands current status -- Continuation options presented clearly -- Next step determined correctly -- Module plan updated with continuation information - -### ❌ SYSTEM FAILURE: - -- Not reading existing plan completely -- Misrepresenting progress status -- Losing track of what's been done -- Not offering appropriate continuation options - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN user selects 'C' (Continue) and appropriate updates are saved to modulePlanFile, will you then load, read entire file, then execute the determined next step file to resume the module creation workflow. diff --git a/_bmad/bmb/workflows/create-module/steps/step-02-concept.md b/_bmad/bmb/workflows/create-module/steps/step-02-concept.md deleted file mode 100644 index 0d868d2..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-02-concept.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-03-components.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -moduleStructureGuide: '{project-root}/bmb/workflows/create-agent-legacy/create-module/module-structure.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 2: Define Module Concept and Scope - -## 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 Module Architect and Business Analyst -- ✅ 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 module design and BMAD patterns, user brings their domain knowledge -- ✅ Maintain collaborative, educational tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on defining the module concept and scope -- 🚫 FORBIDDEN to start designing components in this step -- 💬 Ask questions conversationally to understand vision -- 🚫 FORBIDDEN to proceed without clear module identity - -## EXECUTION PROTOCOLS: - -- 🎯 Load and study module structure guide for context -- 💾 Document all module identity details in plan -- 📖 Add "step-02-concept" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Module name and location from step 1 -- Input documents (brief/brainstorming) if any -- Focus ONLY on concept and scope definition -- Don't assume module details beyond what user provides - -## STEP GOAL: - -To articulate the module's vision, define its identity, and establish clear boundaries for what it will and won't do. - -## MODULE CONCEPT DEFINITION PROCESS: - -### 1. Load Context and Briefs - -"Let's define your module's concept and identity. This will guide all the decisions we make about agents, workflows, and features." - -Load module-plan.md and check inputDocuments field - -Read the module brief completely -"I see you have a module brief. Let me review that to understand your vision..." -Use brief content to inform concept development questions - -Load and study the module structure guide for context - -### 2. Guide Concept Development - -Ask conversationally: - -"**Understanding Your Vision:** - -1. **What problem will this module solve?** - What pain point or need are you addressing? - -2. **Who is the primary user?** - Who will benefit most from this module? - -3. **What's the main outcome?** - What will users be able to do after using your module? - -4. **Why is this important?** - What makes this module valuable or unique?" - -### 3. Module Identity Development - -Based on their responses, collaboratively develop: - -**Module Name:** - -- Start with their module code: {module_name} -- Suggest a display name in Title Case -- Get user confirmation or refinement - -**Module Purpose:** - -- Distill their problem statement into 1-2 clear sentences -- Focus on value and outcomes -- Get user validation - -**Target Audience:** - -- Identify primary user persona -- Consider skill level (beginner/intermediate/advanced) -- Note any secondary audiences - -**Module Scope:** - -- What's IN scope (core features) -- What's OUT of scope (explicitly state what it won't do) -- Success criteria (how will we know it works?) - -### 4. Module Theme and Category - -"**Module Classification:** - -Based on your description, this seems to fit in the [Domain-Specific/Creative/Technical/Business/Personal] category. - -Does this sound right? Or would you categorize it differently? - -**Example Categories:** - -- **Domain-Specific**: Legal, Medical, Finance, Education -- **Creative**: RPG/Gaming, Story Writing, Music Production -- **Technical**: DevOps, Testing, Architecture, Security -- **Business**: Project Management, Marketing, Sales -- **Personal**: Journaling, Learning, Productivity" - -### 5. Module Type Estimation - -"Based on what you've described, I'm thinking this might be a: - -- **Simple Module** (1-2 agents, 2-3 workflows) - Focused, single-purpose -- **Standard Module** (3-5 agents, 5-10 workflows) - Comprehensive solution -- **Complex Module** (5+ agents, 10+ workflows) - Full platform/framework - -Which feels right for your vision? We'll confirm this after planning components." - -### 6. Document Module Concept - -Update module-plan.md with concept section: - -```markdown -## Module Concept - -**Module Name:** {module_display_name} -**Module Code:** {module_name} -**Category:** [category] -**Type:** [estimated type] - -**Purpose Statement:** -[1-2 sentence clear purpose] - -**Target Audience:** - -- Primary: [description] -- Secondary: [if any] - -**Scope Definition:** - -**In Scope:** - -- [core feature 1] -- [core feature 2] -- [core feature 3] - -**Out of Scope:** - -- [explicitly excluded item 1] -- [explicitly excluded item 2] - -**Success Criteria:** - -- [measurable outcome 1] -- [measurable outcome 2] -- [user satisfaction indicator] -``` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore alternative concept approaches -- IF P: Execute {partyModeWorkflow} to get creative input on module identity -- IF C: Save concept to module-plan.md, add step-02-concept to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Module purpose clearly articulated -- Module identity established (name, audience, scope) -- Category and type determined -- Concept documented in module plan -- User feels the concept matches their vision - -### ❌ SYSTEM FAILURE: - -- Proceeding without clear module purpose -- Not defining scope boundaries -- Skipping user validation of concept -- Not documenting concept details - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and module concept is saved to module-plan.md with stepsCompleted updated to [1, 2], will you then load, read entire file, then execute `{nextStepFile}` to begin component planning. diff --git a/_bmad/bmb/workflows/create-module/steps/step-03-components.md b/_bmad/bmb/workflows/create-module/steps/step-03-components.md deleted file mode 100644 index 9634b7f..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-03-components.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-04-structure.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -agent_examples_path: '{project-root}/bmb/reference/agents/module-examples' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 3: Plan Module Components - -## 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 Module 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 BMAD component design patterns, user brings their domain requirements -- ✅ Maintain collaborative, design-focused tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on planning component architecture -- 🚫 FORBIDDEN to create actual components in this step -- 💬 Present component options with reasoning -- 🚫 FORBIDDEN to finalize component list without user agreement - -## EXECUTION PROTOCOLS: - -- 🎯 Reference agent examples for patterns -- 💾 Document component plan in detail -- 📖 Add "step-03-components" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Module concept from step 2 is available -- Focus on planning, not implementation -- Consider BMAD patterns and best practices -- Reference examples but don't copy exactly - -## STEP GOAL: - -To design the component architecture for the module, determining what agents, workflows, and tasks are needed to fulfill the module's purpose. - -## COMPONENT PLANNING PROCESS: - -### 1. Initialize Component Planning - -"Now that we have a clear module concept, let's plan the components that will bring it to life. - -Based on your module's purpose and scope, we'll design: - -- **Agents** - The AI personas that will help users -- **Workflows** - The step-by-step processes for accomplishing tasks -- **Tasks** - Quick utilities and supporting functions" - -### 2. Agent Planning - -"**Agent Architecture:** - -Think about the different roles or perspectives needed to accomplish your module's goals. Each agent should have a clear, distinct purpose." - -Reference agent examples for patterns -Load and browse agent examples: {agent_examples_path} - -"**Common Agent Patterns:** - -- **Primary Agent** - The main interface/orchestrator -- **Specialist Agents** - Domain-specific experts -- **Utility Agents** - Helper/support functions - -**Example by Module Type:** - -**Technical Modules (e.g., DevOps, Testing):** - -- Implementation Specialist -- Reviewer/Auditor -- Documentation Expert - -**Creative Modules (e.g., Story Writing, Game Design):** - -- Creative Director -- World Builder -- Content Generator - -**Business Modules (e.g., Project Management):** - -- Project Coordinator -- Facilitator -- Analyst" - -"**For your {module_category} module, I suggest considering:** - -[Suggest 2-4 specific agent types based on module concept] - -**What resonates with your vision?** Which of these agents would be most valuable, and are there any others you'd like to add?" - -### 3. Workflow Planning - -"**Workflow Design:** - -Workflows are the step-by-step processes that users will follow to accomplish specific tasks. Each workflow should solve a specific problem or achieve a particular outcome." - -**Types of Workflows:** - -- **Document Workflows** - Generate reports, plans, specifications -- **Action Workflows** - Perform operations, create structures -- **Interactive Workflows** - Guided sessions, coaching, training - -**Example Workflow Patterns:** - -"For your module's purpose, consider these potential workflows: - -1. **[Primary Workflow Name]** - Main workflow for core functionality -2. **[Supporting Workflow 1]** - For specific use case -3. **[Supporting Workflow 2]** - For another use case - -Remember: We'll create workflow PLANS first, not full implementations. These plans can be used later with the create-workflow workflow." - -### 4. Task Planning (Optional) - -"**Task Planning (if needed):** - -Tasks are single-operation utilities that don't need full workflows. They're good for: - -- Quick actions -- Shared subroutines -- Helper functions - -Does your module need any tasks? For example: - -- Status checking -- Quick formatting -- Validation utilities" - -### 5. Component Integration Planning - -"**How Components Work Together:** - -Let's think about how your components will interact: - -- **Agent Collaboration**: Will agents work together or independently? -- **Workflow Dependencies**: Do workflows need to call each other? -- **Task Usage**: Which workflows will use which tasks?" - -### 6. Component Priority and MVP - -"**Starting Point (MVP):** - -To ensure success, let's identify the minimum viable set: - -**Must Have (Phase 1):** - -- [List essential agents] -- [List essential workflows] - -**Nice to Have (Phase 2):** - -- [Additional agents] -- [Additional workflows] -- [Tasks if any] - -This approach lets you launch with core functionality and expand later." - -### 7. Document Component Plan - -Update module-plan.md with component section: - -```markdown -## Component Architecture - -### Agents (N planned) - -1. **[Agent Name]** - [Brief purpose] - - Type: [Primary/Specialist/Utility] - - Role: [Specific role description] - -2. **[Agent Name]** - [Brief purpose] - - Type: [Primary/Specialist/Utility] - - Role: [Specific role description] - -### Workflows (N planned) - -1. **[Workflow Name]** - [Purpose] - - Type: [Document/Action/Interactive] - - Primary user: [Who uses this] - - Key output: [What it produces] - -2. **[Workflow Name]** - [Purpose] - - Type: [Document/Action/Interactive] - - Primary user: [Who uses this] - - Key output: [What it produces] - -### Tasks (N planned) - -1. **[Task Name]** - [Single-purpose function] - - Used by: [Which workflows/agents] - -### Component Integration - -- Agents collaborate via: [description] -- Workflow dependencies: [description] -- Task usage patterns: [description] - -### Development Priority - -**Phase 1 (MVP):** - -- [List of components to create first] - -**Phase 2 (Enhancement):** - -- [List of components for later] -``` - -### 8. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore alternative component architectures -- IF P: Execute {partyModeWorkflow} to get creative input on component design -- IF C: Save component plan to module-plan.md, add step-03-components to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Component architecture planned and documented -- Agent types and purposes clearly defined -- Workflow requirements identified -- Integration patterns established -- Development priority set (MVP vs enhancements) - -### ❌ SYSTEM FAILURE: - -- Planning components without module purpose context -- Not considering BMAD patterns and examples -- Over-engineering (too many components) -- Under-planning (missing essential components) -- Not establishing development priorities - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and component plan is saved to module-plan.md with stepsCompleted updated to [1, 2, 3], will you then load, read entire file, then execute `{nextStepFile}` to begin creating the module structure. diff --git a/_bmad/bmb/workflows/create-module/steps/step-04-structure.md b/_bmad/bmb/workflows/create-module/steps/step-04-structure.md deleted file mode 100644 index 2b1bfc5..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-04-structure.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-05-config.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 4: Create Module Structure - -## 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 Module Architect and Systems Organizer -- ✅ 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 structure patterns, user brings their component requirements -- ✅ Maintain collaborative, organized tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on creating directory structure and determining complexity -- 🚫 FORBIDDEN to create actual component files in this step -- 💬 Explain structure decisions clearly -- 🚫 FORBIDDEN to proceed without confirming structure - -## EXECUTION PROTOCOLS: - -- 🎯 Use component count to determine module type -- 💾 Create all required directories -- 📖 Add "step-04-structure" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Component plan from step 3 is available -- Standard BMAD module structure to follow -- Focus on structure creation, not content -- Module folder already exists from step 1 - -## STEP GOAL: - -To determine the module's complexity type and create the complete directory structure for the module. - -## MODULE STRUCTURE CREATION PROCESS: - -### 1. Determine Module Complexity - -"Based on your component plan, let's determine your module's complexity level:" - -**Count Components:** - -- Agents: [count from plan] -- Workflows: [count from plan] -- Tasks: [count from plan] - -**Complexity Assessment:** - -"**Simple Module Criteria:** - -- 1-2 agents, all Simple type -- 1-3 workflows -- No complex integrations - -**Standard Module Criteria:** - -- 2-4 agents with mixed types -- 3-8 workflows -- Some shared resources - -**Complex Module Criteria:** - -- 4+ agents or multiple Module-type agents -- 8+ workflows -- Complex interdependencies -- External integrations" - -"**Your module has:** - -- [agent_count] agents -- [workflow_count] workflows -- [task_count] tasks - -**This makes it a: [Simple/Standard/Complex] Module**" - -### 2. Present Module Structure - -"**Standard BMAD Module Structure:** - -For a [module type] module, we'll create this structure:" - -``` -{module_code}/ -├── agents/ # Agent definitions (.md) -│ ├── [agent-name].md -│ └── ... -├── workflows/ # Workflow folders -│ ├── [workflow-name]/ -│ │ ├── workflow-plan.md # Descriptive plan -│ │ └── README.md # Workflow documentation -│ └── ... -├── tasks/ # Task files (if any) -│ └── [task-name].md -├── templates/ # Shared templates -│ └── [template-files] -├── data/ # Module data files -│ └── [data-files] -├── module.yaml # Required -├── _module-installer/ # Installation configuration -│ ├── installer.js # Optional -│ └── assets/ # Optional install assets -└── README.md # Module documentation -``` - -### 3. Create Directory Structure - -Create all directories in {bmb_creations_output_folder}/{module_name}/: - -1. **agents/** - For agent definition files -2. **workflows/** - For workflow folders -3. **tasks/** - For task files (if tasks planned) -4. **templates/** - For shared templates -5. **data/** - For module data -6. **_module-installer/** - For installation configuration - -### 4. Create Placeholder README - -Create initial README.md with basic structure: - -````markdown -# {module_display_name} - -{module_purpose} - -## Installation - -```bash -bmad install {module_code} -``` -```` - -## Components - -_Module documentation will be completed in Step 9_ - -## Quick Start - -_Getting started guide will be added in Step 9_ - ---- - -_This module is currently under construction_ - -```` - -### 5. Document Structure Creation - -Update module-plan.md with structure section: - -```markdown -## Module Structure - -**Module Type:** [Simple/Standard/Complex] -**Location:** {bmb_creations_output_folder}/{module_name} - -**Directory Structure Created:** -- ✅ agents/ -- ✅ workflows/ -- ✅ tasks/ -- ✅ templates/ -- ✅ data/ -- ✅ _module-installer/ -- ✅ README.md (placeholder) - -**Rationale for Type:** -[Explain why it's Simple/Standard/Complex based on component counts] -```` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore alternative structure approaches -- IF P: Execute {partyModeWorkflow} to get creative input on organization -- IF C: Save structure info to module-plan.md, add step-04-structure to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Module complexity correctly determined -- All required directories created -- Structure follows BMAD standards -- Placeholder README created -- Structure documented in plan - -### ❌ SYSTEM FAILURE: - -- Not creating all required directories -- Incorrectly categorizing module complexity -- Not following BMAD structure patterns -- Creating component files prematurely - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and structure is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4], will you then load, read entire file, then execute `{nextStepFile}` to begin configuration planning. diff --git a/_bmad/bmb/workflows/create-module/steps/step-05-config.md b/_bmad/bmb/workflows/create-module/steps/step-05-config.md deleted file mode 100644 index 73172e2..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-05-config.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-06-agents.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_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 Module Configuration - -## 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 Module Architect and Configuration 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 installation patterns, user brings their module requirements -- ✅ Maintain collaborative, planning-focused tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on planning configuration fields -- 🚫 FORBIDDEN to create installer files in this step -- 💬 Present configuration options clearly -- 🚫 FORBIDDEN to finalize without user input - -## EXECUTION PROTOCOLS: - -- 🎯 Consider what users might want to configure -- 💾 Document all configuration field plans -- 📖 Add "step-05-config" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Module concept and components from previous steps -- Standard BMAD installer configuration patterns -- Focus on planning, not implementation -- Consider user customization needs - -## STEP GOAL: - -To determine what configuration settings the module needs and plan how they'll be implemented in the installer. - -## CONFIGURATION PLANNING PROCESS: - -### 1. Initialize Configuration Planning - -"Now let's plan the configuration for your module's installer. This determines what users can customize when they install your module." - -**Configuration allows users to:** - -- Set up file locations -- Choose features or behavior -- Provide API keys or credentials -- Adjust output formats -- Configure integrations - -### 2. Assess Configuration Needs - -"**Configuration Assessment:** - -Does your {module_display_name} module need any user-configurable settings during installation?" - -**Common Configuration Categories:** - -**1. Output/Data Paths** - -- Where should outputs be saved? -- What's the default data directory? -- Any special folder structures needed? - -**2. Feature Toggles** - -- Enable/disable specific features -- Choose between behavior modes -- Set verbosity levels - -**3. Integration Settings** - -- API keys (for external services) -- Service endpoints -- Authentication credentials - -**4. User Preferences** - -- Default language -- Time zone -- Skill level (beginner/advanced) -- Detail level (minimal/standard/verbose)" - -### 3. Plan Configuration Fields - -"**For each configuration need, let's define:** - -1. **Field Name** (snake_case, e.g., 'output_path') -2. **Type** - INTERACTIVE (asks user) or STATIC (hardcoded) -3. **Prompt** (what to ask user, if interactive) -4. **Default Value** (sensible default) -5. **Input Type** - text, single-select, multi-select -6. **Result Template** - how to store the value" - -**Examples:** - -"**INTERACTIVE Text Input:** - -```yaml -output_path: - prompt: 'Where should {module_name} save outputs?' - default: 'output/{module_name}' - result: '{project-root}/{value}' -``` - -**INTERACTIVE Single-Select:** - -```yaml -detail_level: - prompt: 'How detailed should outputs be?' - default: 'standard' - result: '{value}' - single-select: - - value: 'minimal' - label: 'Minimal - Brief summaries only' - - value: 'standard' - label: 'Standard - Balanced detail' - - value: 'detailed' - label: 'Detailed - Comprehensive information' -``` - -**STATIC Value:** - -````yaml -module_version: - result: "1.0.0" -```" - -### 4. Design Configuration for Your Module - -"**Based on your module's purpose, consider these potential configurations:" - -[Suggest relevant configurations based on module type and purpose] - -"**Which of these apply to your module?** -- [Present options relevant to the specific module] - -**Any additional configurations needed?**" - -### 5. Document Configuration Plan - -Update module-plan.md with configuration section: - -```markdown -## Configuration Planning - -### Required Configuration Fields - -1. **[field_name]** - - Type: [INTERACTIVE/STATIC] - - Purpose: [what it controls] - - Default: [default value] - - Input Type: [text/single-select/multi-select] - - Prompt: [user prompt if interactive] - -2. **[field_name]** - - Type: [INTERACTIVE/STATIC] - - Purpose: [what it controls] - - Default: [default value] - - Input Type: [text/single-select/multi-select] - - Prompt: [user prompt if interactive] - -### Installation Questions Flow - -1. [First question] -2. [Second question] -3. [Additional questions...] - -### Result Configuration Structure - -The module.yaml will generate: -- Module configuration at: _bmad/{module_code}/config.yaml -- User settings stored as: [describe structure] -```` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore additional configuration options -- IF P: Execute {partyModeWorkflow} to get input on user experience -- IF C: Save configuration plan to module-plan.md, add step-05-config to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All necessary configuration fields identified -- Field types and prompts clearly defined -- User interaction flow planned -- Configuration structure documented -- Ready for installer implementation - -### ❌ SYSTEM FAILURE: - -- Skipping configuration planning for modules that need it -- Over-configuring (too many options) -- Not considering user experience -- Not documenting configuration plans - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and configuration plan is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5], will you then load, read entire file, then execute `{nextStepFile}` to begin agent creation. diff --git a/_bmad/bmb/workflows/create-module/steps/step-06-agents.md b/_bmad/bmb/workflows/create-module/steps/step-06-agents.md deleted file mode 100644 index 60cbbc0..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-06-agents.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-07-workflows.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -agentTemplate: '{installed_path}/templates/agent.template.md' -agent_examples_path: '{project-root}/bmb/reference/agents/module-examples' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 6: Create Module Agents - -## 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 Module Architect and Agent 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 BMAD agent patterns, user brings their domain requirements -- ✅ Maintain collaborative, creative tone - -### Step-Specific Rules: - -- 🎯 Focus on creating proper YAML agent files following the template -- 🚫 FORBIDDEN to use create-agent workflow (it's problematic) -- 💬 Create placeholder workflow folders with README.md for each agent -- 🚫 FORBIDDEN to create full workflows in this step - -## EXECUTION PROTOCOLS: - -- 🎯 Follow agent.template.md exactly for structure -- 💾 Save agents as .yaml files to module's agents folder -- 📖 Create workflow folders with README.md plans -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Component plan from step 3 defines which agents to create -- Agent template provides the required YAML structure -- Module structure already created -- Focus on agent creation and workflow placeholders - -## STEP GOAL: - -To create the primary agent(s) for the module using the proper agent template and create placeholder workflow folders for each agent. - -## AGENT CREATION PROCESS: - -### 1. Review Agent Plan - -"Let's create the agents for your {module_display_name} module. - -From your component plan, you have: - -- [agent_count] agents planned -- [list of agent types from plan] - -I'll create each agent following the proper BMAD template and set up placeholder workflow folders for them." - -### 2. Load Agent Template - -Load and study the agent template from {agentTemplate} -Reference agent examples from {agent_examples_path} for patterns - -### 3. Create Each Agent - -For each agent in the component plan: - -#### 3.1 Determine Agent Characteristics - -"**Agent: [Agent Name]** - -Let's design this agent by understanding what it needs: - -**Memory & Learning:** - -1. Does this agent need to remember things across sessions? (conversations, preferences, patterns) - - If yes: We'll add sidecar folder structure for memory - - If no: No persistent memory needed - -**Interaction Types:** 2. What does this agent DO? - -- Conversational interactions? → Use embedded prompts -- Quick single actions? → Use inline actions -- Complex multi-step processes? → Consider workflows -- Document generation? → Likely need workflows - -**Multiple Agent Usage:** 3. Will other agents in this module need the same workflows? - -- If yes: Definitely create separate workflow files -- If no: Could embed in agent file - -**Based on this, what combination does [Agent Name] need?** - -- Memory/Persistence: [Yes/No] -- Embedded prompts: [List main interactions] -- Workflows needed: [Which processes need separate files?]" - -#### 3.2 Present Agent Design - -"**Agent Design: [Agent Name]** - -**Core Identity:** - -- Name: [Suggested name] -- Title: [Brief description] -- Icon: [Appropriate emoji] - -**Persona:** - -- Role: [What the agent does] -- Identity: [Personality/background] -- Communication Style: [How they communicate] -- Principles: [3-5 core principles] - -**Structure:** - -- Memory needed: [Yes/No - sidecar folder] -- Embedded prompts: [List main interaction prompts] -- Workflow processes: [Which need separate files] - -**Menu Items Planned:** - -- [List with trigger codes and types] - -**Quick actions vs Workflows:** - -- Quick prompts: [single-step interactions] -- Workflows: [multi-step, shared processes] - -Does this design match what you envisioned? What should we adjust?" - -#### 3.3 Create Agent File and Structure - -After user confirmation: - -Create hybrid agent file with only needed sections: - -```yaml -agent: - metadata: - name: '[Agent Name]' - title: '[Agent Title]' - icon: '[Icon]' - module: '{module_code}' - persona: - role: '[Agent Role]' - identity: | - [Multi-line identity description] - communication_style: | - [Multi-line communication style] - principles: - - '[Principle 1]' - - '[Principle 2]' - - '[Principle 3]' - - # Only include if agent needs memory/persistence - critical_actions: - - 'Load COMPLETE file ./[agent-name]-sidecar/memories.md and integrate all past interactions' - - 'ONLY read/write files in ./[agent-name]-sidecar/ - this is our private workspace' - - # Only include if agent has embedded prompts - prompts: - - id: '[prompt-name]' - content: | - - [How to use this prompt] - - - [Detailed prompt content] - - menu: - # Always include - - multi: '[CH] Chat with agent or [SPM] Start Party Mode' - triggers: - - party-mode: - input: SPM - route: '{project-root}/_bmad/core/workflows/edit-agent/workflow.md' - type: exec - - expert-chat: - input: CH - action: agent responds as expert - type: action - - # Group related functions - - multi: '[PF] Primary Function [QF] Quick Task' - triggers: - - primary-function: - input: PF - action: '#[prompt-id]' - type: action - - quick-task: - input: QF - route: '#[prompt-id]' - type: exec - - # Workflow only for complex processes - - trigger: 'complex-process' - route: '{project-root}/_bmad/{custom_module}/workflows/[workflow]/workflow.md' - description: 'Complex process [icon]' - - # Quick inline actions - - trigger: 'save-item' - action: 'Save to ./[agent-name]-sidecar/file.md' - description: 'Save item 💾' -``` - -#### 3.4 Create Supporting Structure - -**If agent needs memory:** - -1. Create folder: {bmb_creations_output_folder}/{module_name}/agents/[agent-name]-sidecar/ -2. Create files: - - memories.md (empty, for persistent memory) - - instructions.md (empty, for agent protocols) - - insights.md (empty, for breakthrough moments) - - sessions/ (subfolder for session records) - - patterns.md (empty, for tracking patterns) - -**If agent has workflows:** -For each workflow that needs separate file: - -1. Create folder: {bmb_creations_output_folder}/{module_name}/workflows/[workflow-name]/ -2. Create README.md with workflow plan - -### 4. Repeat for All Agents - -Go through each agent from the component plan, presenting drafts and creating files with user confirmation. - -### 5. Document Agent Creation - -Update module-plan.md with agents section: - -```markdown -## Agents Created - -1. **[Agent Name]** - [Agent Title] - - File: [agent-filename].yaml - - Features: [Memory/Sidecar, Embedded prompts, Workflows] - - Structure: - - Sidecar: [Yes/No] - - Prompts: [number embedded] - - Workflows: [list of workflow folders] - - Status: Created with [combination of features] -``` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to refine agent designs -- IF P: Execute {partyModeWorkflow} to get creative input on agent personas -- IF C: Save agent creation status to module-plan.md, add step-06-agents to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All planned agents created with proper YAML structure -- Each agent follows agent.template.md format exactly -- Workflow placeholder folders created with README.md plans -- Agent menu items properly reference workflow paths -- Users confirmed each agent draft before creation - -### ❌ SYSTEM FAILURE: - -- Using create-agent workflow instead of template -- Creating XML agents instead of YAML -- Not creating workflow placeholder folders -- Skipping user confirmation on agent drafts - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and all agents are created with placeholder workflows and stepsCompleted updated, will you then load, read entire file, then execute `{nextStepFile}` to begin workflow plan review. diff --git a/_bmad/bmb/workflows/create-module/steps/step-07-workflows.md b/_bmad/bmb/workflows/create-module/steps/step-07-workflows.md deleted file mode 100644 index 6a7134c..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-07-workflows.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-08-installer.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -workflowPlanTemplate: '{installed_path}/templates/workflow-plan-template.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 7: Review Workflow Plans - -## 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 Module Architect and Workflow 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 BMAD workflow patterns, user brings their workflow requirements -- ✅ Maintain collaborative, review-focused tone - -### Step-Specific Rules: - -- 🎯 Focus on reviewing existing workflow README files from Step 6 -- 🚫 FORBIDDEN to use create-workflow workflow in this step -- 💬 Review and refine workflow plans, not create new ones -- 🚫 FORBIDDEN to create actual workflow steps - -## EXECUTION PROTOCOLS: - -- 🎯 Review workflow README files created in Step 6 -- 💾 Update README files based on user feedback -- 📖 Add "step-07-workflows" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Workflow README files were created in Step 6 for each agent -- These README files contain workflow plans for later implementation -- Module structure already created with workflow folders -- Focus on reviewing and refining, not creating from scratch - -## STEP GOAL: - -To review and refine the workflow README files created in Step 6, ensuring they have clear plans for later implementation with the create-workflow workflow. - -## WORKFLOW REVIEW PROCESS: - -### 1. List Workflow Folders Created - -"Let's review the workflow plans created in Step 6 for your {module_display_name} module. - -I've already created workflow folders and README.md files for each agent's workflows: - -**Workflow folders found:** - -- [List all workflow folders in {bmb_creations_output_folder}/{module_name}/workflows/] - -**Each workflow folder contains a README.md with:** - -- Purpose and description -- Trigger code from agent menu -- Key steps outline -- Expected outputs -- Notes for implementation" - -### 2. Review Each Workflow Plan - -For each workflow README file: - -#### 2.1 Load and Present - -"**Reviewing Workflow: [Workflow Name]** - -Reading the README.md from: [workflow-folder]/README.md - -**Current Plan:** -[Purpose] -[Trigger] -[Key Steps] -[Expected Output] -[Notes] - -How does this plan look? Should we: - -- Keep it as is -- Modify the purpose -- Adjust the steps -- Change the expected output" - -#### 2.2 Update Based on Feedback - -If user wants changes: - -- Update the README.md file -- Keep the same basic structure -- Ensure clarity for future implementation - -#### 2.3 Check for Missing Information - -Ensure each README has: - -```markdown -# [Workflow Name] - -## Purpose - -[Clear, concise description of what this workflow accomplishes] - -## Trigger - -[Trigger code from agent menu, e.g., "WF" or specific code] - -## Key Steps - -1. [Step 1 - What happens first] -2. [Step 2 - What happens next] -3. [Step 3 - Continue as needed] - -## Expected Output - -[What the workflow produces - document, action, result] - -## Notes - -This workflow will be implemented using the create-workflow workflow. -(Optional: Any special considerations or requirements) -``` - -### 3. Link Workflows to Agents - -"**Workflow-Agent Mapping:** - -Let's verify each workflow is properly linked to its agent: - -[For each workflow]: - -- **Workflow:** [Workflow Name] -- **Agent:** [Agent Name] -- **Trigger Code:** [WF code] -- **Menu Item:** [Menu description in agent] - -Are all these mappings correct in the agent files?" - -### 4. Document Implementation Plan - -Update module-plan.md with workflow section: - -```markdown -## Workflow Plans Reviewed - -### For Agent [Agent Name]: - -1. **[Workflow Name]** - - Location: workflows/[workflow-name]/ - - Status: Plan reviewed and ready for implementation - - Trigger: [WF code] - - Implementation: Use create-workflow workflow - -2. **[Workflow Name]** - - Location: workflows/[workflow-name]/ - - Status: Plan reviewed and ready for implementation - - Trigger: [WF code] - - Implementation: Use create-workflow workflow -``` - -### 5. Next Steps Guidance - -"**Ready for Implementation:** - -All workflow plans are now reviewed and ready. To implement these workflows later: - -1. Use the `/bmad:bmb:workflows:create-workflow` command -2. Select each workflow folder -3. Follow the create-workflow workflow -4. It will create the full workflow.md and step files - -The README.md in each folder serves as your blueprint for implementation." - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to refine workflow designs -- IF P: Execute {partyModeWorkflow} to get creative input on workflow processes -- IF C: Save workflow plan status to module-plan.md, add step-07-workflows to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All workflow README files reviewed with user -- Each workflow plan has clear purpose and steps -- Workflow-agent mappings verified -- README files updated based on feedback -- Clear implementation guidance provided - -### ❌ SYSTEM FAILURE: - -- Skipping review of workflow README files -- Not updating plans based on user feedback -- Missing critical information in README files -- Not verifying workflow-agent mappings - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and all workflow plans are reviewed and documented and stepsCompleted updated, will you then load, read entire file, then execute `{nextStepFile}` to begin installer setup. diff --git a/_bmad/bmb/workflows/create-module/steps/step-08-installer.md b/_bmad/bmb/workflows/create-module/steps/step-08-installer.md deleted file mode 100644 index 44253f1..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-08-installer.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-09-documentation.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -installerTemplate: '{installed_path}/templates/installer.template.js' -installConfigTemplate: '{installed_path}/templates/install-config.template.yaml' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 8: Setup Module Installer - -## 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 Module Architect and Installation 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 installation patterns, user brings their module requirements -- ✅ Maintain collaborative, technical tone - -### Step-Specific Rules: - -- 🎯 Focus on creating installer configuration files -- 🚫 FORBIDDEN to run actual installation -- 💬 Follow BMAD installer standards exactly -- 🚫 FORBIDDEN to deviate from configuration template - -## EXECUTION PROTOCOLS: - -- 🎯 Use configuration plan from step 5 -- 💾 Create module.yaml with all fields -- 📖 Add "step-08-installer" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Configuration plan from step 5 defines installer fields -- Standard BMAD installer template to follow -- Module structure already created -- Focus on installer setup, not module content - -## STEP GOAL: - -To create the module installer configuration (module.yaml) that defines how users will install and configure the module. - -## INSTALLER SETUP PROCESS: - -### 1. Review Configuration Plan - -"Now let's set up the installer for your {module_display_name} module. - -The installer will: - -- Define how users install your module -- Collect configuration settings -- Set up the module structure in user projects -- Generate the module's config.yaml file - -From step 5, we planned these configuration fields: - -- [List planned configuration fields]" - -### 2. Create Installer Directory - -Ensure _module-installer directory exists -Directory: {bmb_creations_output_folder}/{module_name}/_module-installer/ - -### 3. Create module.yaml - -"I'll create the module.yaml file based on your configuration plan. This is the core installer configuration file." - -Create file: {bmb_creations_output_folder}/{module_name}/module.yaml from template {installConfigTemplate} - -### 4. Handle Custom Installation Logic - -"**Custom Installation Logic:** - -Does your module need any special setup during installation? For example: - -- Creating database tables -- Setting up API connections -- Downloading external assets -- Running initialization scripts" - -Does your module need custom installation logic? [yes/no] - -"I'll create an installer.js file for custom logic." - -Create file: {bmb_creations_output_folder}/{module_name}/_module-installer/installer.js from {installerTemplate} - -Update installer.js with module-specific logic - -### 5. Create Assets Directory (if needed) - -"**Installer Assets:** - -If your module needs to copy files during installation (templates, examples, documentation), we can add them to the assets directory." - -Create directory: _module-installer/assets/ -Add note about what assets to include - -### 6. Document Installer Setup - -Update module-plan.md with installer section: - -```markdown -## Installer Configuration - -### Install Configuration - -- File: module.yaml -- Module code: {module_name} -- Default selected: false -- Configuration fields: [count] - -### Custom Logic - -- installer.js: [Created/Not needed] -- Custom setup: [description if yes] - -### Installation Process - -1. User runs: `bmad install {module_name}` -2. Installer asks: [list of questions] -3. Creates: _bmad/{module_name}/ -4. Generates: config.yaml with user settings - -### Validation - -- ✅ YAML syntax valid -- ✅ All fields defined -- ✅ Paths use proper templates -- ✅ Custom logic ready (if needed) -``` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to review installer configuration -- IF P: Execute {partyModeWorkflow} to get input on user experience -- IF C: Save installer info to module-plan.md, add step-08-installer to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- module.yaml created with all planned fields -- YAML syntax valid -- Custom installation logic prepared (if needed) -- Installer follows BMAD standards -- Configuration properly templated - -### ❌ SYSTEM FAILURE: - -- Not creating module.yaml -- Invalid YAML syntax -- Missing required fields -- Not using proper path templates - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and installer info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8], will you then load, read entire file, then execute `{nextStepFile}` to begin documentation creation. diff --git a/_bmad/bmb/workflows/create-module/steps/step-09-documentation.md b/_bmad/bmb/workflows/create-module/steps/step-09-documentation.md deleted file mode 100644 index baa4204..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-09-documentation.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-10-roadmap.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -moduleReadmeFile: '{bmb_creations_output_folder}/{module_name}/README.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 9: Create Module Documentation - -## 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 Module Architect and Technical Writer -- ✅ 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 documentation best practices, user brings their module knowledge -- ✅ Maintain collaborative, clear tone - -### Step-Specific Rules: - -- 🎯 Focus on creating comprehensive README documentation -- 🚫 FORBIDDEN to create docs in other locations -- 💬 Generate content based on module plan -- 🚫 FORBIDDEN to skip standard sections - -## EXECUTION PROTOCOLS: - -- 🎯 Use all gathered module information -- 💾 Update the placeholder README.md file -- 📖 Add "step-09-documentation" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- All module information from previous steps -- Module structure and components already created -- Focus on README.md, not other documentation -- Generate content dynamically from plan - -## STEP GOAL: - -To create comprehensive README.md documentation for the module that helps users understand, install, and use the module. - -## DOCUMENTATION CREATION PROCESS: - -### 1. Initialize Documentation - -"Let's create the README.md for your {module_display_name} module. - -Good documentation is crucial for module adoption. Your README will be the first thing users see when discovering your module." - -### 2. Generate README Content - -Load module-plan.md to gather all module information -Update {moduleReadmeFile} with comprehensive content: - -````markdown -# {module_display_name} - -{module_purpose} - -## Overview - -This module provides: -[Generate list based on module components and features] - -## Installation - -Install the module using BMAD: - -```bash -bmad install {module_name} -``` -```` - -## Components - -### Agents ({agent_count}) - -[List created agents with brief descriptions] - -### Workflows ({workflow_count}) - -[List planned workflows with purposes] - -### Tasks ({task_count}) - -[List tasks if any] - -## Quick Start - -1. **Load the primary agent:** - - ``` - agent {primary_agent_name} - ``` - -2. **View available commands:** - - ``` - *help - ``` - -3. **Run the main workflow:** - - ``` - workflow {primary_workflow_name} - ``` - -## Module Structure - -``` -{module_name}/ -├── agents/ # Agent definitions -│ ├── [agent-1].md -│ └── [agent-2].md -├── workflows/ # Workflow folders -│ ├── [workflow-1]/ -│ │ ├── workflow-plan.md -│ │ └── README.md -│ └── [workflow-2]/ -│ └── ... -├── tasks/ # Task files -├── templates/ # Shared templates -├── data/ # Module data -├── _module-installer/ # Installation optional js file with custom install routine -├── module.yaml # yaml config and install questions -└── README.md # This file -``` - -## Configuration - -The module can be configured in `_bmad/{module_name}/config.yaml` - -**Key Settings:** - -[List configuration fields from installer] - -[Example:] - -- **output_path**: Where outputs are saved -- **detail_level**: Controls output verbosity -- **feature_x**: Enable/disable specific features - -## Examples - -### Example 1: [Primary Use Case] - -[Step-by-step example of using the module for its main purpose] - -1. Start the agent -2. Provide input -3. Review output - -### Example 2: [Secondary Use Case] - -[Additional example if applicable] - -## Development Status - -This module is currently: - -- [x] Structure created -- [x] Installer configured -- [ ] Agents implemented -- [ ] Workflows implemented -- [ ] Full testing complete - -**Note:** Some workflows are planned but not yet implemented. See individual workflow folders for status. - -## Contributing - -To extend this module: - -1. Add new agents using `create-agent` workflow -2. Add new workflows using `create-workflow` workflow -3. Update the installer configuration if needed -4. Test thoroughly - -## Requirements - -- BMAD Method version 6.0.0 or higher -- [Any specific dependencies] - -## Author - -Created by {user_name} on [creation date] - -## License - -[Add license information if applicable] - ---- - -## Module Details - -**Module Code:** {module_name} -**Category:** {module_category} -**Type:** {module_type} -**Version:** 1.0.0 - -**Last Updated:** [current date] - -```` - -### 3. Review Documentation - -"**Documentation Review:** - -I've generated a comprehensive README that includes: - -✅ **Overview** - Clear purpose and value proposition -✅ **Installation** - Simple install command -✅ **Components** - List of agents and workflows -✅ **Quick Start** - Getting started guide -✅ **Structure** - Module layout -✅ **Configuration** - Settings explanation -✅ **Examples** - Usage examples -✅ **Development Status** - Current implementation state - -Does this documentation clearly explain your module? Is there anything you'd like to add or modify?" - -### 4. Handle Documentation Updates - -Update based on user feedback -"Common additions: -- API documentation -- Troubleshooting section -- FAQ -- Screenshots or diagrams -- Video tutorials -- Changelog" - -### 5. Document Documentation Creation - -Update module-plan.md with documentation section: - -```markdown -## Documentation - -### README.md Created -- Location: {bmb_creations_output_folder}/{module_name}/README.md -- Sections: [list of sections included] -- Status: Complete - -### Content Highlights -- Clear installation instructions -- Component overview -- Quick start guide -- Configuration details -- Usage examples -- Development status - -### Updates Made -- [List any customizations or additions] -```` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to improve documentation clarity -- IF P: Execute {partyModeWorkflow} to get input on user experience -- IF C: Save documentation info to module-plan.md, add step-09-documentation to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- README.md fully populated with all sections -- Content accurately reflects module structure -- Installation instructions clear and correct -- Examples provide helpful guidance -- Development status honestly represented - -### ❌ SYSTEM FAILURE: - -- Leaving placeholder content in README -- Not updating with actual module details -- Missing critical sections (installation, usage) -- Misrepresenting implementation status - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and documentation info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8, 9], will you then load, read entire file, then execute `{nextStepFile}` to begin roadmap generation. diff --git a/_bmad/bmb/workflows/create-module/steps/step-10-roadmap.md b/_bmad/bmb/workflows/create-module/steps/step-10-roadmap.md deleted file mode 100644 index 69c22b8..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-10-roadmap.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-11-validate.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -moduleTodoFile: '{bmb_creations_output_folder}/{module_name}/TODO.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 10: Generate Development Roadmap - -## 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 Module Architect and Project Planner -- ✅ 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 development planning, user brings their module vision -- ✅ Maintain collaborative, forward-looking tone - -### Step-Specific Rules: - -- 🎯 Focus on creating actionable roadmap and TODO -- 🚫 FORBIDDEN to create actual components -- 💬 Prioritize tasks for successful launch -- 🚫 FORBIDDEN to set time estimates - -## EXECUTION PROTOCOLS: - -- 🎯 Use component status to determine next steps -- 💾 Create clear TODO.md with actionable items -- 📖 Add "step-10-roadmap" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- All module information from previous steps -- Current implementation status -- Focus on planning, not implementation -- Avoid time-based estimates - -## STEP GOAL: - -To create a development roadmap and TODO list that guides the next steps for completing the module. - -## ROADMAP GENERATION PROCESS: - -### 1. Review Current Status - -"Let's create a development roadmap for your {module_display_name} module. - -**Current Status Summary:** - -- ✅ Module structure created -- ✅ Installer configured -- [Agent Status] -- [Workflow Status] -- [Documentation Status] - -This roadmap will help you prioritize what to work on next." - -### 2. Create Development Phases - -"**Development Phases:** - -I'll organize the remaining work into logical phases to ensure a successful module launch." - -### 3. Generate TODO.md - -Create file: {bmb_creations_output_folder}/{module_name}/TODO.md - -````markdown -# {module_display_name} Development Roadmap - -## Phase 1: Core Components (MVP) - -### Agents - -- [ ] Implement [Agent 1 Name] - - Use: `workflow create-agent` - - Reference: module-plan.md for requirements - - Priority: High - -- [ ] Implement [Agent 2 Name] - - Use: `workflow create-agent` - - Reference: module-plan.md for requirements - - Priority: High - -### Workflows - -- [ ] Implement [Workflow 1 Name] - - Use: `workflow create-workflow` - - Input: workflows/[workflow-1]/workflow-plan.md - - Priority: High - -- [ ] Implement [Workflow 2 Name] - - Use: `workflow create-workflow` - - Input: workflows/[workflow-2]/workflow-plan.md - - Priority: Medium - -### Integration - -- [ ] Test agent-workflow integration -- [ ] Update agent menus (remove TODO flags) -- [ ] Validate configuration fields work correctly - -## Phase 2: Enhanced Features - -### Additional Components - -- [ ] [Additional Agent 1] - - Priority: Medium - -- [ ] [Additional Workflow 1] - - Priority: Low - -### Improvements - -- [ ] Add error handling -- [ ] Implement validation -- [ ] Optimize performance -- [ ] Add logging - -## Phase 3: Polish and Launch - -### Testing - -- [ ] Unit test all agents -- [ ] Integration test workflows -- [ ] Test installer in clean project -- [ ] Test with sample data - -### Documentation - -- [ ] Add detailed API docs -- [ ] Create video tutorials -- [ ] Write troubleshooting guide -- [ ] Add FAQ section - -### Release - -- [ ] Version bump to 1.0.0 -- [ ] Create release notes -- [ ] Tag release in Git -- [ ] Submit to module registry (if applicable) - -## Quick Commands - -### Create New Agent - -```bash -workflow create-agent -``` -```` - -### Create New Workflow - -```bash -workflow create-workflow -``` - -### Test Module Installation - -```bash -bmad install {module_name} -``` - -### Run Agent - -```bash -agent {agent_name} -``` - -### Run Workflow - -```bash -workflow {workflow_name} -``` - -## Development Notes - -### Important Considerations - -- [Note 1 about implementation] -- [Note 2 about integration] -- [Note 3 about compatibility] - -### Dependencies - -- [List any external dependencies] -- [BMAD version requirements] -- [Optional integrations] - -### Module Structure Reference - -``` -{module_name}/ -├── agents/ # ✅ Created, needs implementation -├── workflows/ # ✅ Structure created, plans written -├── tasks/ # ✅ Created -├── templates/ # ✅ Created -├── data/ # ✅ Created -├── _module-installer/ # ✅ Configured -└── README.md # ✅ Complete -└── module.yaml # ✅ Complete -``` - -## Completion Criteria - -The module is complete when: - -- [ ] All Phase 1 items are done -- [ ] Installation works smoothly -- [ ] Documentation covers all features -- [ ] Sample usage produces expected results - ---- - -Created: [current date] -Last Updated: [current date] - -```` - -### 4. Prioritize Immediate Next Steps - -"**Immediate Next Steps (This Week):** - -Based on your module's needs, I recommend starting with: - -1. **[Most important agent]** - Core functionality -2. **[Most important workflow]** - Primary user journey -3. **[Integration task]** - Ensure components work together - -**Which of these would you like to tackle first?**" - -### 5. Provide Development Guidance - -"**Development Tips:** - -1. **Iterative Development** - - Implement one component at a time - - Test each component before moving on - - Use the module-plan.md as your guide - -2. **Testing Strategy** - - Test in a clean project - - Verify installation works - - Check all menu options function - -3. **Documentation Updates** - - Update README.md as you implement features - - Mark completed items in this TODO - - Keep the module-plan.md in sync - -4. **Getting Help** - - Use BMAD documentation for patterns - - Reference example modules - - Ask for help when stuck" - -### 6. Document Roadmap Creation - -Update module-plan.md with roadmap section: - -```markdown -## Development Roadmap - -### TODO.md Created -- Location: {bmb_creations_output_folder}/{module_name}/TODO.md -- Phases defined: 3 -- Immediate tasks prioritized - -### Next Steps Priority Order -1. [Priority 1] -2. [Priority 2] -3. [Priority 3] - -### Quick Reference Commands -- `workflow create-agent` - Create new agents -- `workflow create-workflow` - Create new workflows -- `bmad install {module_name}` - Test installation - -### Development Notes -- [Key implementation notes] -- [Testing recommendations] -- [Integration considerations] -```` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore development approaches -- IF P: Execute {partyModeWorkflow} to get creative input on implementation -- IF C: Save roadmap info to module-plan.md, add step-10-roadmap to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### 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 then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- TODO.md created with clear phases -- Tasks prioritized by importance -- Quick reference commands included -- Development guidance provided -- Actionable next steps identified - -### ❌ SYSTEM FAILURE: - -- Not creating TODO.md file -- Including time estimates -- Not prioritizing tasks effectively -- Missing essential development commands - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and roadmap info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], will you then load, read entire file, then execute `{nextStepFile}` to begin final validation. diff --git a/_bmad/bmb/workflows/create-module/steps/step-11-validate.md b/_bmad/bmb/workflows/create-module/steps/step-11-validate.md deleted file mode 100644 index 77ab2a7..0000000 --- a/_bmad/bmb/workflows/create-module/steps/step-11-validate.md +++ /dev/null @@ -1,336 +0,0 @@ ---- -workflowFile: '{installed_path}/workflow.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -validationChecklist: '{installed_path}/validation.md' -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 11: Validate and Finalize Module - -## 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 Module Architect and 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 expertise in BMAD validation patterns, user brings their module knowledge -- ✅ Maintain collaborative, thorough tone - -### Step-Specific Rules: - -- 🎯 Focus on validation and quality checks -- 🚫 FORBIDDEN to modify core structure at this stage -- 💬 Present findings clearly with recommendations -- 🚫 FORBIDDEN to skip validation steps - -## EXECUTION PROTOCOLS: - -- 🎯 Run validation checklist systematically -- 💾 Document validation results -- 📖 Append "step-11-validate" to stepsCompleted array` before completing -- 🚫 FORBIDDEN to mark as complete without validation - -## CONTEXT BOUNDARIES: - -- Module fully created with all components -- Focus on validation, not new creation -- Use validation checklist for systematic review -- Ensure BMAD compliance - -## STEP GOAL: - -To validate the completed module structure, ensure all components are properly configured, and provide next steps for testing and deployment. - -## VALIDATION PROCESS: - -### 1. Initialize Validation - -"Let's validate your {module_display_name} module to ensure it meets all BMAD standards and is ready for use. - -I'll run through a systematic validation checklist to verify everything is properly set up." - -### 2. Structure Validation - -"**1. Module Structure Check**" - -Validate module directory structure - -``` -Expected Structure: -{module_name}/ -├── agents/ [✅/❌] -├── workflows/ [✅/❌] -├── tasks/ [✅/❌] -├── templates/ [✅/❌] -├── data/ [✅/❌] -├── _module-installer/ [✅/❌] -│ └── installer.js [✅/N/A] -├── module.yaml [✅/❌] -└── README.md [✅/❌] -``` - -**Results:** - -- [List validation results for each item] - -### 3. Configuration Validation - -"**2. Configuration Files Check**" - -**Install Configuration:** -Validate module.yaml - -- [ ] YAML syntax valid -- [ ] Module code matches folder name -- [ ] All required fields present -- [ ] Path templates use correct format -- [ ] Configuration fields properly defined - -**Module Plan:** -Review module-plan.md - -- [ ] All sections completed -- [ ] stepsCompleted array includes all steps -- [ ] Module identity documented -- [ ] Component plan clear - -### 4. Component Validation - -"**3. Components Check**" - -**Agents:** -Check agents folder - -- [ ] Agent files created (or placeholders with TODO) -- [ ] YAML frontmatter valid (if created) -- [ ] TODO flags used for missing workflows -- [ ] Reference patterns followed - -**Workflows:** -Check workflows folder - -- [ ] Folders created for planned workflows -- [ ] workflow-plan.md files created (or placeholders) -- [ ] README.md in each workflow folder -- [ ] Plans include all required sections - -### 5. Documentation Validation - -"**4. Documentation Check**" - -**README.md:** -Review README.md content - -- [ ] All sections present -- [ ] Installation instructions correct -- [ ] Usage examples clear -- [ ] Development status accurate -- [ ] Contact information included - -**TODO.md:** -Review TODO.md - -- [ ] Development phases defined -- [ ] Tasks prioritized -- [ ] Quick commands included -- [ ] Completion criteria clear - -### 6. Integration Validation - -"**5. Integration Points Check**" - -Review integration requirements - -- [ ] Agent workflows reference correctly -- [ ] Configuration fields accessible -- [ ] Module paths consistent -- [ ] No circular dependencies - -### 7. Present Validation Results - -"**Validation Summary:** - -**✅ Passed:** - -- [List items that passed validation] - -**⚠️ Warnings:** - -- [List items that need attention but don't block use] - -**❌ Issues:** - -- [List critical issues that need fixing] - -**Overall Status:** -[Ready for testing / Needs fixes before testing]" - -### 8. Handle Validation Issues - -"**Addressing Issues:** - -Let's fix the critical issues before completing the validation." - -For each issue: - -1. **Explain the issue** clearly -2. **Show how to fix** it -3. **Make the fix** if user approves -4. **Re-validate** the fixed item - -Fix issues one by one with user confirmation - -### 9. Final Module Summary - -"**Module Creation Complete!** - -**Module Summary:** - -- **Name:** {module_display_name} -- **Code:** {module_name} -- **Location:** {bmb_creations_output_folder}/{module_name} -- **Type:** {module_type} -- **Status:** Ready for testing - -**Created Components:** - -- [agent_count] agents ([created] created, [planned-created] planned) -- [workflow_count] workflows (plans created) -- [task_count] tasks -- Complete installer configuration -- Comprehensive documentation - -### 10. Next Steps Guidance - -"**Your Next Steps:** - -1. **Test the Installation:** - - ```bash - cd [test-project] - bmad install {module_name} - ``` - -2. **Implement Components:** - - Follow TODO.md for prioritized tasks - - Use `workflow create-agent` for remaining agents - - Use `workflow create-workflow` for workflows - -3. **Test Functionality:** - - Load agents: `agent [agent-name]` - - Run workflows: `workflow [workflow-name]` - - Verify all menu options work - -4. **Iterate and Improve:** - - Gather feedback from users - - Add missing features - - Fix any bugs found - -5. **Share Your Module:** - - Document improvements in README.md - - Consider submitting to BMAD registry - - Share with the community" - -### 11. Document Validation - -Create validation summary in module-plan.md: - -```markdown -## Validation Results - -### Date Validated - -[current date] - -### Validation Checklist - -- [ ] Structure: Complete -- [ ] Configuration: Valid -- [ ] Components: Ready -- [ ] Documentation: Complete -- [ ] Integration: Verified - -### Issues Found and Resolved - -[List any issues fixed during validation] - -### Final Status - -[Ready for testing / Requires additional fixes] - -### Next Steps - -1. [First next step] -2. [Second next step] -3. [Third next step] -``` - -### 12. Complete Workflow - -Mark workflow as complete: -Update module-plan.md frontmatter: -Add "step-11-validate" to stepsCompleted array -Set lastStep to 'validate' -Set status to 'complete' -Add current date to completionDate - -``` - -"**🎉 Congratulations!** - -Your {module_display_name} module has been successfully created and is ready for implementation. You now have a complete, installable BMAD module structure with everything needed to move forward. - -Would you like me to help you with anything else?" - -### 13. Final MENU OPTIONS - -Display: **Module Creation Complete!** [A] Advanced Elicitation [P] Party Mode [C] Exit - -#### Menu Handling Logic: - -- IF A: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml for reflection on process -- IF P: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md to celebrate completion -- IF C: Mark as complete and exit gracefully -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- This is the final step - workflow complete -- User can ask questions or exit -- Always respond helpfully to final queries - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All validation checks performed -- Issues identified and resolved -- Module marked as complete -- Clear next steps provided -- User satisfied with results - -### ❌ SYSTEM FAILURE: - -- Skipping validation checks -- Not documenting validation results -- Marking as complete with critical issues -- Not providing next steps guidance - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -WHEN validation is complete, all issues resolved (or documented), and module-plan.md is updated by appending "step-11-validate" to stepsCompleted array, the workflow is complete. Present final summary and allow user to exit or ask final questions. -``` diff --git a/_bmad/bmb/workflows/create-module/templates/agent.template.md b/_bmad/bmb/workflows/create-module/templates/agent.template.md deleted file mode 100644 index fc81f38..0000000 --- a/_bmad/bmb/workflows/create-module/templates/agent.template.md +++ /dev/null @@ -1,313 +0,0 @@ -# TEMPLATE - -the template to use has comments to help guide generation are are not meant to be in the final agent output - -## Agent Template to use - -### Hybrid Agent (Can have prompts, sidecar memory, AND workflows) - -```yaml -agent: - metadata: - name: '{person-name}' - title: '{agent-title}' - icon: '{agent-icon}' - module: '{module}' - persona: - role: '{agent-role}' - identity: | - {agent-identity - multi-line description} - communication_style: | - {communication-style - 1-2 short sentences to describe chat style} - principles: - - '{agent-principle-1}' - - '{agent-principle-2}' - - '{agent-principle-3}' - - '{agent-principle-N}' - - # Optional: Only include if agent needs memory/persistence - critical_actions: - - 'Load COMPLETE file [project-root]/_bmad/_memory/[agent-name]-sidecar/memories.md and integrate all past interactions' - - 'Load COMPLETE file [project-root]/_bmad/_memory/[agent-name]-sidecar/instructions.md and follow ALL protocols' - - # Optional: Embedded prompts for common interactions - prompts: - - id: 'core-function' - content: | - - Main interaction pattern for this agent - - - {Detailed prompt content} - - - id: 'quick-task' - content: | - - Quick, common task the agent performs - - - {Prompt for quick task} - - menu: - # Always include chat/party mode - - multi: '[CH] Chat with the agent or [SPM] Start Party Mode' - triggers: - - party-mode: - input: SPM or fuzzy match start party mode - route: '{project-root}/_bmad/core/workflows/edit-agent/workflow.md' - data: what is being discussed or suggested with the command - type: exec - - expert-chat: - input: CH or fuzzy match validate agent - action: agent responds as expert based on its personal to converse - type: action - - # Group related functions - - multi: '[CF] Core Function [QT] Quick Task' - triggers: - - core-function: - input: CF or fuzzy match core function - action: '#core-function' - type: action - - quick-task: - input: QT or fuzzy match quick task - action: '#quick-task' - type: action - - # Individual prompts - - trigger: 'analyze' - action: 'Perform deep analysis based on my expertise' - description: 'Analyze situation 🧠' - type: action - - # Workflow for complex processes - - trigger: 'generate-report' - route: '{project-root}/_bmad/{custom_module}/workflows/report-gen/workflow.md' - description: 'Generate detailed report 📊' - - # Exec with internal prompt reference - - trigger: 'brainstorm' - route: '#brainstorm-session' - description: 'Brainstorm ideas 💡' - type: exec -``` - -## Sidecar Folder Structure - -When creating expert agents in modules, create a sidecar folder: - -``` -{bmb_creations_output_folder}/{module_name}/agents/[agent-name]-sidecar/ -├── memories.md # Persistent memory across sessions -├── instructions.md # Agent-specific protocols -├── insights.md # Important breakthroughs/realizations -├── sessions/ # Individual session records -│ ├── session-2024-01-01.md -│ └── session-2024-01-02.md -└── patterns.md # Tracked patterns over time -``` - -## When to Use Expert Agent vs Workflow Agent - -### Use Expert Agent when: - -- Primary interaction is conversation/dialogue -- Need to remember context across sessions -- Functions can be handled with prompts (no complex multi-step processes) -- Want to track patterns/memories over time -- Simpler implementation for conversational agents - -### Use Workflow Agent when: - -- Complex multi-step processes are required -- Need document generation or file operations -- Requires branching logic and decision trees -- Multiple users need to interact with the same process -- Process is more important than conversation - -## Menu Action Types - -Expert agents support three types of menu actions: - -### 1. **Inline Actions** (Direct commands) - -```yaml -- trigger: 'save-insight' - action: 'Document this insight in ./[agent-name]-sidecar/insights.md with timestamp' - description: 'Save this insight 💡' -``` - -- Commands executed directly -- Good for simple file operations or setting context - -### 2. **Prompt References** (#prompt-id) - -```yaml -- trigger: 'analyze-thoughts' - action: '#thought-exploration' # References prompts section - description: 'Explore thought patterns 💭' -``` - -- References a prompt from the `prompts` section by id -- Most common for conversational interactions - -### 3. **Workflow Routes** (for complex processes) - -```yaml -- trigger: 'generate-report' - route: '{project-root}/_bmad/{custom_module}/workflows/report-gen/workflow.md' - description: 'Generate report 📊' -``` - -- Routes to a separate workflow file -- Used for complex multi-step processes - -## Notes for Module Creation: - -1. **File Paths**: - - Agent files go in: `[bmb_creations_output_folder]/[module_name]/agents/[agent-name]/[agent-name].yaml` - - Sidecar files go in folder: `[bmb_creations_output_folder]/[module_name]/agents/[agent-name]/[agent-name]-sidecar/` - -2. **Variable Usage**: - - `module` is your module code/name - -3. **Creating Sidecar Structure**: - - When agent is created, also create the sidecar folder - - Initialize with empty files: memories.md, instructions.md and any other files the agent will need to have special knowledge or files to record information to - - Create sessions/ subfolder if interactions will result in new sessions - - These files are automatically loaded due to critical_actions - -4. **Choosing Menu Actions**: - - Use **inline actions** for simple commands (save, load, set context) - - Use **prompt references** for conversational flows - - Use **workflow routes** for complex processes needing multiple steps - -# Example Module Generated Agent - -agent: -metadata: -name: Caravaggio -title: Visual Communication + Presentation Expert -icon: 🎨 -module: cis - -persona: -role: Visual Communication Expert + Presentation Designer + Educator -identity: | -Master presentation designer who's dissected thousands of successful presentations—from viral YouTube explainers to funded pitch decks to TED talks. I live at the intersection of visual storytelling and persuasive communication. -communication_style: | -Constant sarcastic wit and experimental flair. Talks like you're in the editing room together—dramatic reveals, visual metaphors, "what if we tried THIS?!" energy. Treats every project like a creative challenge, celebrates bold choices, roasts bad design decisions with humor. -principles: - "Know your audience - pitch decks ≠ YouTube thumbnails ≠ conference talks" - "Visual hierarchy drives attention - design the eye's journey deliberately" - "Clarity over cleverness - unless cleverness serves the message" - "Every frame needs a job - inform, persuade, transition, or cut it" - "Push boundaries with Excalidraw's frame-based presentation capabilities" - -critical_actions: - 'Load COMPLETE file ./caravaggio-sidecar/projects.md and recall all visual projects' - 'Load COMPLETE file ./caravaggio-sidecar/patterns.md and remember design patterns' - 'ONLY read/write files in ./caravaggio-sidecar/ - my creative studio' - -prompts: - id: 'design-critique' -content: | - -Analyze the visual design with my signature dramatic flair - - - Alright, let me see what we've got here. *leans in closer* - - First impression: Is this making me shout "BRAVO!" or "BARF!"? - - Visual hierarchy scan: Where's my eye landing first? Second? Is it a deliberate journey or visual chaos? - - The good stuff: What's working? What's making me grin? - - The facepalm moments: Where are we losing impact? What's confusing the message? - - My "WHAT IF WE TRIED THIS?!": [Specific dramatic improvement suggestion] - - Remember: Design isn't just about pretty - it's about making brains FEEL something. - - - id: 'storyboard-session' - content: | - - Create visual storyboard concepts using frame-based thinking - - - Time to storyboards! Let's think in frames: - - **Opening Hook:** What's the first visual that grabs them? - **The Turn:** Where do we shift perspective? - **The Reveal:** What's the money shot? - **The Close:** What image sticks with them? - - For each frame: - - Visual: What do they SEE? - - Text: What do they READ? - - Emotion: What do they FEEL? - - Remember: Each frame is a scene in your visual story. Make it COUNT! - - - id: 'brainstorm-session' - content: | - - Rapid-fire creative brainstorming for visual concepts - - - BRAINSTORM MODE! 🔥 - - Give me three wild ideas: - 1. The safe but solid option - 2. The "ooh, interesting" middle ground - 3. The "are you crazy? LET'S DO IT!" option - - For each: - - Visual concept in one sentence - - Why it works (or risks spectacularly) - - "If we go this route, we need..." - - Let's push some boundaries! What's the most unexpected way to show this? - -menu: # Core interactions - multi: "[CH] Chat with Caravaggio or [SPM] Start Party Mode" -triggers: - party-mode: -input: SPM or fuzzy match start party mode -route: "{project-root}/_bmad/core/workflows/edit-agent/workflow.md" -data: what's being discussed, plus custom party agents if specified -type: exec - expert-chat: -input: CH or fuzzy match validate agent -action: agent responds as expert based on its personal to converse -type: action - - # Design services group - - multi: "[DC] Design Critique [SB] Storyboard" - triggers: - - design-critique: - input: DC or fuzzy match design critique - route: '#design-critique' - description: 'Ruthless design analysis 🎭' - type: exec - - storyboard: - input: SB or fuzzy match storyboard - route: '#storyboard-session' - description: 'Visual story frames 🎬' - type: exec - - # Quick actions - - trigger: 'analyze' - action: 'Quick visual analysis with my signature bluntness' - description: 'Quick visual take 🎯' - type: action - - - trigger: 'brainstorm' - action: '#brainstorm-session' - description: 'Creative storm 💡' - type: action - - # Document workflows for complex processes - - multi: "[PD] Pitch Deck [EX] Explainer Video" - triggers: - - pitch-deck: - input: PD or fuzzy match pitch deck - route: "{project-root}/_bmad/{custom_module}/workflows/pitch-deck/workflow.md" - description: 'Investor pitch deck 📈' - - explainer: - input: EX or fuzzy match explainer - route: "{project-root}/_bmad/{custom_module}/workflows/explainer/workflow.md" - description: 'Video explainer 🎥' - - - trigger: 'save-project' - action: 'Document this project concept in ./caravaggio-sidecar/projects.md with sketches and notes' - description: 'Save project 💾' diff --git a/_bmad/bmb/workflows/create-module/templates/installer.template.js b/_bmad/bmb/workflows/create-module/templates/installer.template.js deleted file mode 100644 index 428a57e..0000000 --- a/_bmad/bmb/workflows/create-module/templates/installer.template.js +++ /dev/null @@ -1,47 +0,0 @@ -/** - * {module_display_name} Module Installer - * Custom installation logic - */ - -/** - * @param {Object} options - Installation options - * @param {string} options.projectRoot - Project root directory - * @param {Object} options.config - Module configuration from module.yaml - * @param {Array} options.installedIDEs - List of IDE codes being configured - * @param {Object} options.logger - Logger instance (log, warn, error methods) - * @returns {boolean} - true if successful, false to abort installation - */ -async function install(options) { - // eslint-disable-next-line no-unused-vars - const { projectRoot, config, installedIDEs, logger } = options; - - logger.log('Installing {module_display_name}...'); - - try { - // TODO: Add your custom installation logic here - - // Example: Create data directory - // const fs = require('fs'); - // const dataPath = config.data_path; - // if (!fs.existsSync(dataPath)) { - // fs.mkdirSync(dataPath, { recursive: true }); - // logger.log(`Created data directory: ${dataPath}`); - // } - - // Example: Initialize configuration file - // const configPath = path.join(projectRoot, config.config_file); - // fs.writeFileSync(configPath, JSON.stringify({ - // initialized: new Date().toISOString(), - // version: config.module_version - // }, null, 2)); - - logger.log('{module_display_name} installation complete!'); - return true; - } catch (error) { - logger.error(`Installation failed: ${error.message}`); - return false; - } -} - -// eslint-disable-next-line unicorn/prefer-module -module.exports = { install }; diff --git a/_bmad/bmb/workflows/create-module/templates/module-plan.template.md b/_bmad/bmb/workflows/create-module/templates/module-plan.template.md deleted file mode 100644 index 7e4dab7..0000000 --- a/_bmad/bmb/workflows/create-module/templates/module-plan.template.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -stepsCompleted: [] ---- - -# Module Plan {module name} diff --git a/_bmad/bmb/workflows/create-module/templates/module.template.yaml b/_bmad/bmb/workflows/create-module/templates/module.template.yaml deleted file mode 100644 index 501f6e2..0000000 --- a/_bmad/bmb/workflows/create-module/templates/module.template.yaml +++ /dev/null @@ -1,53 +0,0 @@ -# {module_display_name} Module Configuration -# This file defines installation questions and module configuration values - -code: "${module_name}" # e.g., my-module -name: "{module_display_name}" -default_selected: false - -# Welcome message shown during installation -prompt: - - "Thank you for choosing {module_display_name}!" - - "{module_purpose}" -# Core config values are automatically inherited from installer: -## user_name -## communication_language -## document_output_language -## output_folder - -# ============================================================================ -# CONFIGURATION FIELDS -# ============================================================================ -# Each field can be: -# 1. INTERACTIVE (has 'prompt' - asks user during installation) -# 2. STATIC (no 'prompt' - just uses 'result' value) -# ============================================================================ - -# Example configurations (replace with actual planned fields): - -# INTERACTIVE text input: -# output_path: -# prompt: "Where should {module_name} save outputs?" -# default: "output/{module_name}" -# result: "{project-root}/{value}" - -# INTERACTIVE single-select: -# detail_level: -# prompt: "How detailed should outputs be?" -# default: "standard" -# result: "{value}" -# single-select: -# - value: "minimal" -# label: "Minimal - Brief summaries only" -# - value: "standard" -# label: "Standard - Balanced detail" -# - value: "detailed" -# label: "Detailed - Comprehensive information" - -# STATIC value: -# module_version: -# result: "1.0.0" - -# STATIC path: -# data_path: -# result: "{project-root}/_bmad/{module_name}/data" diff --git a/_bmad/bmb/workflows/create-module/templates/workflow-plan-template.md b/_bmad/bmb/workflows/create-module/templates/workflow-plan-template.md deleted file mode 100644 index 3d79eee..0000000 --- a/_bmad/bmb/workflows/create-module/templates/workflow-plan-template.md +++ /dev/null @@ -1,23 +0,0 @@ -# Workflow Plan Template - -Use this template when creating workflow plans in step-07-workflows.md - -## Template Structure - -Copy the content from step-07-workflows.md when creating workflow plans. The template is embedded in the step file as a code block under "Workflow plan template". - -## Usage - -1. Navigate to the workflow folder -2. Create workflow-plan.md -3. Use the template structure from step-07-workflows.md -4. Fill in details specific to your workflow - -## Required Sections - -- Purpose -- Requirements (User Inputs, Prerequisites, Dependencies) -- Proposed Steps -- Expected Outputs -- Integration Points -- Implementation Notes diff --git a/_bmad/bmb/workflows/create-module/validation.md b/_bmad/bmb/workflows/create-module/validation.md deleted file mode 100644 index 147664d..0000000 --- a/_bmad/bmb/workflows/create-module/validation.md +++ /dev/null @@ -1,126 +0,0 @@ -# Create Module Workflow Validation Checklist - -This document provides the validation criteria used in step-11-validate.md to ensure module quality and BMAD compliance. - -## Structure Validation - -### Required Directories - -- [ ] agents/ - Agent definition files -- [ ] workflows/ - Workflow folders -- [ ] tasks/ - Task files (if needed) -- [ ] templates/ - Shared templates -- [ ] data/ - Module data -- [ ] _module-installer/ - Installation config -- [ ] README.md - Module documentation -- [ ] module.yaml - module config file - -### Optional File in _module-installer/ - -- [ ] installer.js - Custom logic (if needed) - -## Configuration Validation - -### module.yaml - -- [ ] Valid YAML syntax -- [ ] Module code matches folder name -- [ ] Name field present -- [ ] Prompt array with welcome messages -- [ ] Configuration fields properly defined -- [ ] Result templates use correct placeholders - -### Module Plan - -- [ ] All sections completed -- [ ] Module identity documented -- [ ] Component plan clear -- [ ] Configuration plan documented - -## Component Validation - -### Agents - -- [ ] Files created in agents/ folder -- [ ] YAML frontmatter valid (for created agents) -- [ ] TODO flags used for non-existent workflows -- [ ] Menu items follow BMAD patterns -- [ ] Placeholder files contain TODO notes - -### Workflows - -- [ ] Folders created for each planned workflow -- [ ] workflow-plan.md in each folder -- [ ] README.md in each workflow folder -- [ ] Plans include all required sections -- [ ] Placeholder READMEs created for unplanned workflows - -## Documentation Validation - -### README.md - -- [ ] Module name and purpose -- [ ] Installation instructions -- [ ] Components section -- [ ] Quick start guide -- [ ] Module structure diagram -- [ ] Configuration section -- [ ] Usage examples -- [ ] Development status -- [ ] Author information - -### TODO.md - -- [ ] Development phases defined -- [ ] Tasks prioritized -- [ ] Quick commands included -- [ ] Completion criteria defined - -## Integration Validation - -### Path Consistency - -- [ ] All paths use correct template format -- [ ] Module code consistent throughout -- [ ] No hardcoded paths -- [ ] Cross-references correct - -### Agent-Workflow Integration - -- [ ] Agents reference correct workflows -- [ ] TODO flags used appropriately -- [ ] No circular dependencies -- [ ] Clear integration points - -## BMAD Compliance - -### Standards - -- [ ] Follows BMAD module structure -- [ ] Uses BMAD installation patterns -- [ ] Agent files follow BMAD format -- [ ] Workflow plans follow BMAD patterns - -### Best Practices - -- [ ] Clear naming conventions -- [ ] Proper documentation -- [ ] Version control ready -- [ ] Installable via bmad install - -## Final Checklist - -### Before Marking Complete - -- [ ] All validation items checked -- [ ] Critical issues resolved -- [ ] Module plan updated with final status -- [ ] stepsCompleted includes all 11 steps -- [ ] User satisfied with result - -### Ready for Testing - -- [ ] Installation should work -- [ ] Documentation accurate -- [ ] Structure complete -- [ ] Next steps clear diff --git a/_bmad/bmb/workflows/create-module/workflow.md b/_bmad/bmb/workflows/create-module/workflow.md deleted file mode 100644 index 9dad975..0000000 --- a/_bmad/bmb/workflows/create-module/workflow.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -name: create-module -description: 'Interactive workflow to build complete BMAD modules with agents, workflows, and installation infrastructure' -web_bundle: true -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' ---- - -# Create Module Workflow - -**Goal:** To guide users through creating complete, installable BMAD modules with proper structure, agents, workflow plans, and documentation. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a Module Architect and BMAD Systems Specialist collaborating with module creators. This is a partnership, not a client-vendor relationship. You bring expertise in BMAD architecture, component design, and installation patterns, while the user brings their domain knowledge and specific module requirements. Work together as equals. - -## WORKFLOW ARCHITECTURE - -### Core Principles - -- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time -- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - 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. Module 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 {installed_path}/steps/step-01-init.md to begin the workflow. diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv deleted file mode 100644 index 5467e30..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv +++ /dev/null @@ -1,18 +0,0 @@ -category,restriction,considerations,alternatives,notes -Allergy,Nuts,Severe allergy, check labels carefully,Seeds, sunflower seed butter -Allergy,Shellfish,Cross-reactivity with some fish,Fin fish, vegetarian proteins -Allergy,Dairy,Calcium and vitamin D needs,Almond milk, fortified plant milks -Allergy,Soy,Protein source replacement,Legumes, quinoa, seitan -Allergy,Gluten,Celiac vs sensitivity,Quinoa, rice, certified gluten-free -Medical,Diabetes,Carbohydrate timing and type,Fiber-rich foods, low glycemic -Medical,Hypertension,Sodium restriction,Herbs, spices, salt-free seasonings -Medical,IBS,FODMAP triggers,Low FODMAP vegetables, soluble fiber -Ethical,Vegetarian,Complete protein combinations,Quinoa, buckwheat, hemp seeds -Ethical,Vegan,B12 supplementation mandatory,Nutritional yeast, fortified foods -Ethical,Halal,Meat sourcing requirements,Halal-certified products -Ethical,Kosher,Dairy-meat separation,Parve alternatives -Intolerance,Lactose,Dairy digestion issues,Lactase pills, aged cheeses -Intolerance,FODMAP,Carbohydrate malabsorption,Low FODMAP fruits/veg -Preference,Dislikes,Texture/flavor preferences,Similar texture alternatives -Preference,Budget,Cost-effective options,Bulk buying, seasonal produce -Preference,Convenience,Time-saving options,Pre-cut vegetables, frozen produce \ No newline at end of file diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv deleted file mode 100644 index f16c189..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv +++ /dev/null @@ -1,16 +0,0 @@ -goal,activity_level,multiplier,protein_ratio,protein_min,protein_max,fat_ratio,carb_ratio -weight_loss,sedentary,1.2,0.3,1.6,2.2,0.35,0.35 -weight_loss,light,1.375,0.35,1.8,2.5,0.30,0.35 -weight_loss,moderate,1.55,0.4,2.0,2.8,0.30,0.30 -weight_loss,active,1.725,0.4,2.2,3.0,0.25,0.35 -weight_loss,very_active,1.9,0.45,2.5,3.3,0.25,0.30 -maintenance,sedentary,1.2,0.25,0.8,1.2,0.35,0.40 -maintenance,light,1.375,0.25,1.0,1.4,0.35,0.40 -maintenance,moderate,1.55,0.3,1.2,1.6,0.35,0.35 -maintenance,active,1.725,0.3,1.4,1.8,0.30,0.40 -maintenance,very_active,1.9,0.35,1.6,2.2,0.30,0.35 -muscle_gain,sedentary,1.2,0.35,1.8,2.5,0.30,0.35 -muscle_gain,light,1.375,0.4,2.0,2.8,0.30,0.30 -muscle_gain,moderate,1.55,0.4,2.2,3.0,0.25,0.35 -muscle_gain,active,1.725,0.45,2.5,3.3,0.25,0.30 -muscle_gain,very_active,1.9,0.45,2.8,3.5,0.25,0.30 \ No newline at end of file diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv deleted file mode 100644 index 5673899..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv +++ /dev/null @@ -1,28 +0,0 @@ -category,name,prep_time,cook_time,total_time,protein_per_serving,complexity,meal_type,restrictions_friendly,batch_friendly -Protein,Grilled Chicken Breast,10,20,30,35,beginner,lunch/dinner,all,yes -Protein,Baked Salmon,5,15,20,22,beginner,lunch/dinner,gluten-free,no -Protein,Lentils,0,25,25,18,beginner,lunch/dinner,vegan,yes -Protein,Ground Turkey,5,15,20,25,beginner,lunch/dinner,all,yes -Protein,Tofu Stir-fry,10,15,25,20,intermediate,lunch/dinner,vegan,no -Protein,Eggs Scrambled,5,5,10,12,beginner,breakfast,vegetarian,no -Protein,Greek Yogurt,0,0,0,17,beginner,snack,vegetarian,no -Carb,Quinoa,5,15,20,8,beginner,lunch/dinner,gluten-free,yes -Carb,Brown Rice,5,40,45,5,beginner,lunch/dinner,gluten-free,yes -Carb,Sweet Potato,5,45,50,4,beginner,lunch/dinner,all,yes -Carb,Oatmeal,2,5,7,5,beginner,breakfast,gluten-free,yes -Carb,Whole Wheat Pasta,2,10,12,7,beginner,lunch/dinner,vegetarian,no -Veggie,Broccoli,5,10,15,3,beginner,lunch/dinner,all,yes -Veggie,Spinach,2,3,5,3,beginner,lunch/dinner,all,no -Veggie,Bell Peppers,5,10,15,1,beginner,lunch/dinner,all,no -Veggie,Kale,5,5,10,3,beginner,lunch/dinner,all,no -Veggie,Avocado,2,0,2,2,beginner,snack/lunch,all,no -Snack,Almonds,0,0,0,6,beginner,snack,gluten-free,no -Snack,Apple with PB,2,0,2,4,beginner,snack,vegetarian,no -Snack,Protein Smoothie,5,0,5,25,beginner,snack,all,no -Snack,Hard Boiled Eggs,0,12,12,6,beginner,snack,vegetarian,yes -Breakfast,Overnight Oats,5,0,5,10,beginner,breakfast,vegan,yes -Breakfast,Protein Pancakes,10,10,20,20,intermediate,breakfast,vegetarian,no -Breakfast,Veggie Omelet,5,10,15,18,intermediate,breakfast,vegetarian,no -Quick Meal,Chicken Salad,10,0,10,30,beginner,lunch,gluten-free,no -Quick Meal,Tuna Wrap,5,0,5,20,beginner,lunch,gluten-free,no -Quick Meal,Buddha Bowl,15,0,15,15,intermediate,lunch,vegan,no \ No newline at end of file diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md deleted file mode 100644 index e72c3fe..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -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' - -# 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 ---- - -# Step 1: Workflow Initialization - -## 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 nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization and setup -- 🚫 FORBIDDEN to look ahead to future steps -- 💬 Handle initialization professionally -- 🚪 DETECT existing workflow state and handle continuation properly - -## 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 setup 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 document discovery happens in this step - -## STEP GOAL: - -To initialize the Nutrition Plan workflow by detecting continuation state, creating the output document, and preparing for the first collaborative session. - -## INITIALIZATION SEQUENCE: - -### 1. Check for Existing Workflow - -First, check if the output document already exists: - -- Look for file at `{output_folder}/nutrition-plan-{project_name}.md` -- If exists, read the complete file including frontmatter -- If not exists, this is a fresh workflow - -### 2. Handle Continuation (If Document Exists) - -If the document exists and has frontmatter with `stepsCompleted`: - -- **STOP here** and load `./step-01b-continue.md` immediately -- Do not proceed with any initialization tasks -- Let step-01b handle the continuation logic - -### 3. Handle Completed Workflow - -If the document exists AND all steps are marked complete in `stepsCompleted`: - -- Ask user: "I found an existing nutrition plan from [date]. Would you like to: - 1. Create a new nutrition plan - 2. Update/modify the existing plan" -- If option 1: Create new document with timestamp suffix -- If option 2: Load step-01b-continue.md - -### 4. Fresh Workflow Setup (If No Document) - -If no document exists or no `stepsCompleted` in frontmatter: - -#### A. Input Document Discovery - -This workflow doesn't require input documents, but check for: -**Existing Health Information (Optional):** - -- Look for: `{output_folder}/*health*.md` -- Look for: `{output_folder}/*goals*.md` -- If found, load completely and add to `inputDocuments` frontmatter - -#### B. Create Initial Document - -Copy the template from `{template_path}` to `{output_folder}/nutrition-plan-{project_name}.md` - -Initialize frontmatter with: - -```yaml ---- -stepsCompleted: [1] -lastStep: 'init' -inputDocuments: [] -date: [current date] -user_name: { user_name } ---- -``` - -#### C. Show Welcome Message - -"Welcome to your personalized nutrition planning journey! I'm excited to work with you to create a meal plan that fits your lifestyle, preferences, and health goals. - -Let's begin by getting to know you and your nutrition goals." - -## ✅ SUCCESS METRICS: - -- Document created from template -- Frontmatter initialized with step 1 marked complete -- User welcomed to the process -- Ready to proceed to step 2 - -## ❌ FAILURE MODES TO AVOID: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -### 7. Present MENU OPTIONS - -Display: **Proceeding to user profile collection...** - -#### 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, immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Document created from template -- Frontmatter initialized with step 1 marked complete -- User welcomed to the process -- Ready to proceed to step 2 - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN initialization setup is complete and document is created, will you then immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection. - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - ---- diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md deleted file mode 100644 index 704aabe..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -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 - -## STEP GOAL: - -To resume the nutrition planning workflow from where it was left off, ensuring smooth continuation without loss of context. - -## 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 nutrition expert and meal planning 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 nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on analyzing and resuming workflow state -- 🚫 FORBIDDEN to modify content completed in previous steps -- 💬 Maintain continuity with previous sessions -- 🚪 DETECT exact continuation point from frontmatter - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis of current state before taking action -- 💾 Keep existing frontmatter `stepsCompleted` values -- 📖 Review the template content already generated -- 🚫 FORBIDDEN to modify content completed in previous steps - -## CONTEXT BOUNDARIES: - -- Current nutrition-plan.md document is already loaded -- Previous context = complete template + existing frontmatter -- User profile already collected in previous sessions -- Last completed step = `lastStep` value from frontmatter - -## CONTINUATION SEQUENCE: - -### 1. Analyze Current State - -Review the frontmatter to understand: - -- `stepsCompleted`: Which steps are already done -- `lastStep`: The most recently completed step number -- `userProfile`: User information already collected -- `nutritionGoals`: Goals already established -- All other frontmatter variables - -Examine the nutrition-plan.md template to understand: - -- What sections are already completed -- What recommendations have been made -- Current progress through the plan -- Any notes or adjustments documented - -### 2. Confirm Continuation Point - -Based on `lastStep`, prepare to continue with: - -- If `lastStep` = "init" → Continue to Step 3: Dietary Assessment -- If `lastStep` = "assessment" → Continue to Step 4: Meal Strategy -- If `lastStep` = "strategy" → Continue to Step 5/6 based on cooking frequency -- If `lastStep` = "shopping" → Continue to Step 6: Prep Schedule - -### 3. Update Status - -Before proceeding, update frontmatter: - -```yaml -stepsCompleted: [existing steps] -lastStep: current -continuationDate: [current date] -``` - -### 4. Welcome Back Dialog - -"Welcome back! I see we've completed [X] steps of your nutrition plan. We last worked on [brief description]. Are you ready to continue with [next step]?" - -### 5. Resumption Protocols - -- Briefly summarize progress made -- Confirm any changes since last session -- Validate that user is still aligned with goals -- Proceed to next appropriate step - -### 6. Present MENU OPTIONS - -Display: **Resuming workflow - Select an Option:** [C] Continue - -#### 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: 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 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. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Correctly identified last completed step -- User confirmed readiness to continue -- Frontmatter updated with continuation date -- Workflow resumed at appropriate step - -### ❌ SYSTEM FAILURE: - -- Skipping analysis of existing state -- Modifying content from previous steps -- Loading wrong next step -- Not updating frontmatter properly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md deleted file mode 100644 index 95a3ca8..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_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 -profileTemplate: '{workflow_path}/templates/profile-section.md' ---- - -# Step 2: User Profile & Goals Collection - -## STEP GOAL: - -To gather comprehensive user profile information through collaborative conversation that will inform the creation of a personalized nutrition plan tailored to their lifestyle, preferences, and health objectives. - -## 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 nutrition expert and meal planning 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 nutritional expertise and structured planning -- ✅ User brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on collecting profile and goal information -- 🚫 FORBIDDEN to provide meal recommendations or nutrition advice in this step -- 💬 Ask questions conversationally, not like a form -- 🚫 DO NOT skip any profile section - each affects meal recommendations - -## EXECUTION PROTOCOLS: - -- 🎯 Engage in natural conversation to gather profile information -- 💾 After collecting all information, append to {outputFile} -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and content is saved - -## CONTEXT BOUNDARIES: - -- Document and frontmatter are already loaded from initialization -- Focus ONLY on collecting user profile and goals -- Don't provide meal recommendations in this step -- This is about understanding, not prescribing - -## PROFILE COLLECTION PROCESS: - -### 1. Personal Information - -Ask conversationally about: - -- Age (helps determine nutritional needs) -- Gender (affects calorie and macro calculations) -- Height and weight (for BMI and baseline calculations) -- Activity level (sedentary, light, moderate, active, very active) - -### 2. Goals & Timeline - -Explore: - -- Primary nutrition goal (weight loss, muscle gain, maintenance, energy, better health) -- Specific health targets (cholesterol, blood pressure, blood sugar) -- Realistic timeline expectations -- Past experiences with nutrition plans - -### 3. Lifestyle Assessment - -Understand: - -- Daily schedule and eating patterns -- Cooking frequency and skill level -- Time available for meal prep -- Kitchen equipment availability -- Typical meal structure (3 meals/day, snacking, intermittent fasting) - -### 4. Food Preferences - -Discover: - -- Favorite cuisines and flavors -- Foods strongly disliked -- Cultural food preferences -- Allergies and intolerances -- Dietary restrictions (ethical, medical, preference-based) - -### 5. Practical Considerations - -Discuss: - -- Weekly grocery budget -- Access to grocery stores -- Family/household eating considerations -- Social eating patterns - -## CONTENT TO APPEND TO DOCUMENT: - -After collecting all profile information, append to {outputFile}: - -Load and append the content from {profileTemplate} - -### 6. 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 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](#6-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin dietary needs assessment step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Profile collected through conversation (not interrogation) -- All user preferences documented -- Content appended to {outputFile} -- {outputFile} frontmatter updated with step completion -- Menu presented after completing every other step first in order and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Generating content without user input -- Skipping profile sections -- Providing meal recommendations in this step -- Proceeding to next step without 'C' selection -- Not updating document frontmatter - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md deleted file mode 100644 index f77fd67..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -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' - -# Template References -assessmentTemplate: '{workflow_path}/templates/assessment-section.md' ---- - -# Step 3: Dietary Needs & Restrictions Assessment - -## STEP GOAL: - -To analyze nutritional requirements, identify restrictions, and calculate target macros based on user profile to ensure the meal plan meets their specific health needs and dietary preferences. - -## 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 nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and assessment knowledge, user brings their health context -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 ALWAYS check for allergies and medical restrictions first -- 🚫 DO NOT provide medical advice - always recommend consulting professionals -- 💬 Explain the "why" behind nutritional recommendations -- 📋 Load dietary-restrictions.csv and macro-calculator.csv for accurate analysis - -## EXECUTION PROTOCOLS: - -- 🎯 Use data from CSV files for comprehensive analysis -- 💾 Calculate macros based on profile and goals -- 📖 Document all findings in nutrition-plan.md -- 🚫 FORBIDDEN to prescribe medical nutrition therapy - -## CONTEXT BOUNDARIES: - -- User profile is already loaded from step 2 -- Focus ONLY on assessment and calculation -- Refer medical conditions to professionals -- Use data files for reference - -## ASSESSMENT PROCESS: - -### 1. Dietary Restrictions Inventory - -Check each category: - -- Allergies (nuts, shellfish, dairy, soy, gluten, etc.) -- Medical conditions (diabetes, hypertension, IBS, etc.) -- Ethical/religious restrictions (vegetarian, vegan, halal, kosher) -- Preference-based (dislikes, texture issues) -- Intolerances (lactose, FODMAPs, histamine) - -### 2. Macronutrient Targets - -Using macro-calculator.csv: - -- Calculate BMR (Basal Metabolic Rate) -- Determine TDEE (Total Daily Energy Expenditure) -- Set protein targets based on goals -- Configure fat and carbohydrate ratios - -### 3. Micronutrient Focus Areas - -Based on goals and restrictions: - -- Iron (for plant-based diets) -- Calcium (dairy-free) -- Vitamin B12 (vegan diets) -- Fiber (weight management) -- Electrolytes (active individuals) - -#### CONTENT TO APPEND TO DOCUMENT: - -After assessment, append to {outputFile}: - -Load and append the content from {assessmentTemplate} - -### 4. 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 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](#4-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-04-strategy.md` to execute and begin meal strategy creation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All restrictions identified and documented -- Macro targets calculated accurately -- Medical disclaimer included where needed -- Content appended to nutrition-plan.md -- Frontmatter updated with step completion -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Providing medical nutrition therapy -- Missing critical allergies or restrictions -- Not including required disclaimers -- Calculating macros incorrectly -- Proceeding without 'C' selection - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - ---- diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md deleted file mode 100644 index 08ef67a..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Data References -recipeDatabase: '{workflow_path}/data/recipe-database.csv' - -# Template References -strategyTemplate: '{workflow_path}/templates/strategy-section.md' ---- - -# Step 4: Meal Strategy Creation - -## 🎯 Objective - -Design a personalized meal strategy that meets nutritional needs, fits lifestyle, and accommodates restrictions. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest meals without considering ALL user restrictions -- 📖 CRITICAL: Reference recipe-database.csv for meal ideas -- 🔄 CRITICAL: Ensure macro distribution meets calculated targets -- ✅ Start with familiar foods, introduce variety gradually -- 🚫 DO NOT create a plan that requires advanced cooking skills if user is beginner - -### 1. Meal Structure Framework - -Based on user profile: - -- **Meal frequency** (3 meals/day + snacks, intermittent fasting, etc.) -- **Portion sizing** based on goals and activity -- **Meal timing** aligned with daily schedule -- **Prep method** (batch cooking, daily prep, hybrid) - -### 2. Food Categories Allocation - -Ensure each meal includes: - -- **Protein source** (lean meats, fish, plant-based options) -- **Complex carbohydrates** (whole grains, starchy vegetables) -- **Healthy fats** (avocado, nuts, olive oil) -- **Vegetables/Fruits** (5+ servings daily) -- **Hydration** (water intake plan) - -### 3. Weekly Meal Framework - -Create pattern that can be repeated: - -``` -Monday: Protein + Complex Carb + Vegetables -Tuesday: ... -Wednesday: ... -``` - -- Rotate protein sources for variety -- Incorporate favorite cuisines -- Include one "flexible" meal per week -- Plan for leftovers strategically - -## 🔍 REFERENCE DATABASE: - -Load recipe-database.csv for: - -- Quick meal ideas (<15 min) -- Batch prep friendly recipes -- Restriction-specific options -- Macro-friendly alternatives - -## 🎯 PERSONALIZATION FACTORS: - -### For Beginners: - -- Simple 3-ingredient meals -- One-pan/one-pot recipes -- Prep-ahead breakfast options -- Healthy convenience meals - -### For Busy Schedules: - -- 30-minute or less meals -- Grab-and-go options -- Minimal prep breakfasts -- Slow cooker/air fryer options - -### For Budget Conscious: - -- Bulk buying strategies -- Seasonal produce focus -- Protein budgeting -- Minimize food waste - -## ✅ SUCCESS METRICS: - -- All nutritional targets met -- Realistic for user's cooking skill level -- Fits within time constraints -- Respects budget limitations -- Includes enjoyable foods - -## ❌ FAILURE MODES TO AVOID: - -- Too complex for cooking skill level -- Requires expensive specialty ingredients -- Too much time required -- Boring/repetitive meals -- Doesn't account for eating out/social events - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Looking at your goals and love for Mediterranean flavors, we could create a weekly rotation featuring grilled chicken, fish, and plant proteins. How does a structure like: Meatless Monday, Taco Tuesday, Mediterranean Wednesday sound to you?" - -**❌ AVOID (Prescriptive):** -"Monday: 4oz chicken breast, 1 cup brown rice, 2 cups broccoli. Tuesday: 4oz salmon..." - -## 📊 APPEND TO TEMPLATE: - -Begin building nutrition-plan.md by loading and appending content from {strategyTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic meal planning partner** who: - -- Balances nutrition with practicality -- Builds on user's existing preferences -- Makes healthy eating feel achievable -- Adapts to real-life constraints - -## 📝 OUTPUT REQUIREMENTS: - -Update workflow.md frontmatter: - -```yaml -mealStrategy: - structure: [meal pattern] - proteinRotation: [list] - prepMethod: [batch/daily/hybrid] - cookingComplexity: [beginner/intermediate/advanced] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitian Collaboration [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: - -- HALT and AWAIT ANSWER -- 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: Save content to nutrition-plan.md, update frontmatter, check cooking frequency: - - IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` - - IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/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 content is saved to document and frontmatter is updated: - -- IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` to generate shopping list -- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to skip shopping list diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md deleted file mode 100644 index 3290090..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -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' -outputFile: '{output_folder}/nutrition-plan-{project_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 -shoppingTemplate: '{workflow_path}/templates/shopping-section.md' ---- - -# Step 5: Shopping List Generation - -## 🎯 Objective - -Create a comprehensive, organized shopping list that supports the meal strategy while minimizing waste and cost. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 CRITICAL: This step is OPTIONAL - skip if user cooks <2x per week -- 📖 CRITICAL: Cross-reference with existing pantry items -- 🔄 CRITICAL: Organize by store section for efficient shopping -- ✅ Include quantities based on serving sizes and meal frequency -- 🚫 DO NOT forget staples and seasonings - Only proceed if: - -```yaml -cookingFrequency: "3-5x" OR "daily" -``` - -Otherwise, skip to Step 5: Prep Schedule - -## 📊 Shopping List Organization: - -### 1. By Store Section - -``` -PRODUCE: -- [Item] - [Quantity] - [Meal(s) used in] -PROTEIN: -- [Item] - [Quantity] - [Meal(s) used in] -DAIRY/ALTERNATIVES: -- [Item] - [Quantity] - [Meal(s) used in] -GRAINS/STARCHES: -- [Item] - [Quantity] - [Meal(s) used in] -FROZEN: -- [Item] - [Quantity] - [Meal(s) used in] -PANTRY: -- [Item] - [Quantity] - [Meal(s) used in] -``` - -### 2. Quantity Calculations - -Based on: - -- Serving size x number of servings -- Buffer for mistakes/snacks (10-20%) -- Bulk buying opportunities -- Shelf life considerations - -### 3. Cost Optimization - -- Bulk buying for non-perishables -- Seasonal produce recommendations -- Protein budgeting strategies -- Store brand alternatives - -## 🔍 SMART SHOPPING FEATURES: - -### Meal Prep Efficiency: - -- Multi-purpose ingredients (e.g., spinach for salads AND smoothies) -- Batch prep staples (grains, proteins) -- Versatile seasonings - -### Waste Reduction: - -- "First to use" items for perishables -- Flexible ingredient swaps -- Portion planning - -### Budget Helpers: - -- Priority items (must-have vs nice-to-have) -- Bulk vs fresh decisions -- Seasonal substitutions - -## ✅ SUCCESS METRICS: - -- Complete list organized by store section -- Quantities calculated accurately -- Pantry items cross-referenced -- Budget considerations addressed -- Waste minimization strategies included - -## ❌ FAILURE MODES TO AVOID: - -- Forgetting staples and seasonings -- Buying too much of perishable items -- Not organizing by store section -- Ignoring user's budget constraints -- Not checking existing pantry items - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Let's organize your shopping trip for maximum efficiency. I'll group items by store section. Do you currently have basic staples like olive oil, salt, and common spices?" - -**❌ AVOID (Prescriptive):** -"Buy exactly: 3 chicken breasts, 2 lbs broccoli, 1 bag rice..." - -## 📝 OUTPUT REQUIREMENTS: - -Append to {outputFile} by loading and appending content from {shoppingTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic shopping partner** who: - -- Makes shopping efficient and organized -- Helps save money without sacrificing nutrition -- Plans for real-life shopping scenarios -- Minimizes food waste thoughtfully - -## 📊 STATUS UPDATE: - -Update workflow.md frontmatter: - -```yaml -shoppingListGenerated: true -budgetOptimized: [yes/partial/no] -pantryChecked: [yes/no] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping Perspectives [C] Continue to Prep Schedule - -#### 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: - -- HALT and AWAIT ANSWER -- 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: Save content to nutrition-plan.md, update frontmatter, then load, read entire file, then execute `{workflow_path}/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 content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to execute and begin meal prep schedule creation. diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md deleted file mode 100644 index e7adbf5..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -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 -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -prepScheduleTemplate: '{workflow_path}/templates/prep-schedule-section.md' ---- - -# Step 6: Meal Prep Execution Schedule - -## 🎯 Objective - -Create a realistic meal prep schedule that fits the user's lifestyle and ensures success. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest a prep schedule that requires more time than user has available -- 📖 CRITICAL: Base schedule on user's actual cooking frequency -- 🔄 CRITICAL: Include storage and reheating instructions -- ✅ Start with a sustainable prep routine -- 🚫 DO NOT overwhelm with too much at once - -### 1. Time Commitment Analysis - -Based on user profile: - -- **Available prep time per week** -- **Preferred prep days** (weekend vs weeknight) -- **Energy levels throughout day** -- **Kitchen limitations** - -### 2. Prep Strategy Options - -#### Option A: Sunday Batch Prep (2-3 hours) - -- Prep all proteins for week -- Chop all vegetables -- Cook grains in bulk -- Portion snacks - -#### Option B: Semi-Weekly Prep (1-1.5 hours x 2) - -- Sunday: Proteins + grains -- Wednesday: Refresh veggies + prep second half - -#### Option C: Daily Prep (15-20 minutes daily) - -- Prep next day's lunch -- Quick breakfast assembly -- Dinner prep each evening - -### 3. Detailed Timeline Breakdown - -``` -Sunday (2 hours): -2:00-2:30: Preheat oven, marinate proteins -2:30-3:15: Cook proteins (bake chicken, cook ground turkey) -3:15-3:45: Cook grains (rice, quinoa) -3:45-4:00: Chop vegetables and portion snacks -4:00-4:15: Clean and organize refrigerator -``` - -## 📦 Storage Guidelines: - -### Protein Storage: - -- Cooked chicken: 4 days refrigerated, 3 months frozen -- Ground meat: 3 days refrigerated, 3 months frozen -- Fish: Best fresh, 2 days refrigerated - -### Vegetable Storage: - -- Cut vegetables: 3-4 days in airtight containers -- Hard vegetables: Up to 1 week (carrots, bell peppers) -- Leafy greens: 2-3 days with paper towels - -### Meal Assembly: - -- Keep sauces separate until eating -- Consider texture changes when reheating -- Label with preparation date - -## 🔧 ADAPTATION STRATEGIES: - -### For Busy Weeks: - -- Emergency freezer meals -- Quick backup options -- 15-minute meal alternatives - -### For Low Energy Days: - -- No-cook meal options -- Smoothie packs -- Assembly-only meals - -### For Social Events: - -- Flexible meal timing -- Restaurant integration -- "Off-plan" guilt-free guidelines - -## ✅ SUCCESS METRICS: - -- Realistic time commitment -- Clear instructions for each prep session -- Storage and reheating guidelines included -- Backup plans for busy weeks -- Sustainable long-term approach - -## ❌ FAILURE MODES TO AVOID: - -- Overly ambitious prep schedule -- Not accounting for cleaning time -- Ignoring user's energy patterns -- No flexibility for unexpected events -- Complex instructions for beginners - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Based on your 2-hour Sunday availability, we could create a prep schedule that sets you up for the week. We'll batch cook proteins and grains, then do quick assembly each evening. How does that sound with your energy levels?" - -**❌ AVOID (Prescriptive):** -"You must prep every Sunday from 2-4 PM. No exceptions." - -## 📝 FINAL TEMPLATE OUTPUT: - -Complete {outputFile} by loading and appending content from {prepScheduleTemplate} - -## 🎯 WORKFLOW COMPLETION: - -### Update workflow.md frontmatter: - -```yaml -stepsCompleted: ['init', 'assessment', 'strategy', 'shopping', 'prep-schedule'] -lastStep: 'prep-schedule' -completionDate: [current date] -userSatisfaction: [to be rated] -``` - -### Final Message Template: - -"Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" - -## 📊 NEXT STEPS FOR USER: - -1. Review complete plan -2. Shop for ingredients -3. Execute first prep session -4. Note any adjustments needed -5. Schedule follow-up review - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Prep Techniques [P] Coach Perspectives [C] Complete Workflow - -#### 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: - -- HALT and AWAIT ANSWER -- 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 frontmatter with all steps completed, mark workflow complete, display final message -- 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 content is saved to document: - -1. Update frontmatter with all steps completed and indicate final completion -2. Display final completion message -3. End workflow session - -**Final Message:** "Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md deleted file mode 100644 index 610f397..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md +++ /dev/null @@ -1,25 +0,0 @@ -## 📊 Daily Nutrition Targets - -**Daily Calories:** [calculated amount] -**Protein:** [grams]g ([percentage]% of calories) -**Carbohydrates:** [grams]g ([percentage]% of calories) -**Fat:** [grams]g ([percentage]% of calories) - ---- - -## ⚠️ Dietary Considerations - -### Allergies & Intolerances - -- [List of identified restrictions] -- [Cross-reactivity notes if applicable] - -### Medical Considerations - -- [Conditions noted with professional referral recommendation] -- [Special nutritional requirements] - -### Preferences - -- [Cultural/ethical restrictions] -- [Strong dislikes to avoid] diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md deleted file mode 100644 index 8c67f79..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md +++ /dev/null @@ -1,68 +0,0 @@ -# Personalized Nutrition Plan - -**Created:** {{date}} -**Author:** {{user_name}} - ---- - -## ✅ Progress Tracking - -**Steps Completed:** - -- [ ] Step 1: Workflow Initialization -- [ ] Step 2: User Profile & Goals -- [ ] Step 3: Dietary Assessment -- [ ] Step 4: Meal Strategy -- [ ] Step 5: Shopping List _(if applicable)_ -- [ ] Step 6: Meal Prep Schedule - -**Last Updated:** {{date}} - ---- - -## 📋 Executive Summary - -**Primary Goal:** [To be filled in Step 1] - -**Daily Nutrition Targets:** - -- Calories: [To be calculated in Step 2] -- Protein: [To be calculated in Step 2]g -- Carbohydrates: [To be calculated in Step 2]g -- Fat: [To be calculated in Step 2]g - -**Key Considerations:** [To be filled in Step 2] - ---- - -## 🎯 Your Nutrition Goals - -[Content to be added in Step 1] - ---- - -## 🍽️ Meal Framework - -[Content to be added in Step 3] - ---- - -## 🛒 Shopping List - -[Content to be added in Step 4 - if applicable] - ---- - -## ⏰ Meal Prep Schedule - -[Content to be added in Step 5] - ---- - -## 📝 Notes & Next Steps - -[Add any notes or adjustments as you progress] - ---- - -**Medical Disclaimer:** This nutrition plan is for educational purposes only and is not medical advice. Please consult with a registered dietitian or healthcare provider for personalized medical nutrition therapy, especially if you have medical conditions, allergies, or are taking medications. diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md deleted file mode 100644 index 1143cd5..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md +++ /dev/null @@ -1,29 +0,0 @@ -## Meal Prep Schedule - -### [Chosen Prep Strategy] - -### Weekly Prep Tasks - -- [Day]: [Tasks] - [Time needed] -- [Day]: [Tasks] - [Time needed] - -### Daily Assembly - -- Morning: [Quick tasks] -- Evening: [Assembly instructions] - -### Storage Guide - -- Proteins: [Instructions] -- Vegetables: [Instructions] -- Grains: [Instructions] - -### Success Tips - -- [Personalized success strategies] - -### Weekly Review Checklist - -- [ ] Check weekend schedule -- [ ] Review meal plan satisfaction -- [ ] Adjust next week's plan diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md deleted file mode 100644 index 3784c1d..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md +++ /dev/null @@ -1,47 +0,0 @@ -## 🎯 Your Nutrition Goals - -### Primary Objective - -[User's main goal and motivation] - -### Target Timeline - -[Realistic timeframe and milestones] - -### Success Metrics - -- [Specific measurable outcomes] -- [Non-scale victories] -- [Lifestyle improvements] - ---- - -## 👤 Personal Profile - -### Basic Information - -- **Age:** [age] -- **Gender:** [gender] -- **Height:** [height] -- **Weight:** [current weight] -- **Activity Level:** [activity description] - -### Lifestyle Factors - -- **Daily Schedule:** [typical day structure] -- **Cooking Frequency:** [how often they cook] -- **Cooking Skill:** [beginner/intermediate/advanced] -- **Available Time:** [time for meal prep] - -### Food Preferences - -- **Favorite Cuisines:** [list] -- **Disliked Foods:** [list] -- **Allergies:** [list] -- **Dietary Restrictions:** [list] - -### Budget & Access - -- **Weekly Budget:** [range] -- **Shopping Access:** [stores available] -- **Special Considerations:** [family, social, etc.] diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md deleted file mode 100644 index 6a17215..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md +++ /dev/null @@ -1,37 +0,0 @@ -## Weekly Shopping List - -### Check Pantry First - -- [List of common staples to verify] - -### Produce Section - -- [Item] - [Quantity] - [Used in] - -### Protein - -- [Item] - [Quantity] - [Used in] - -### Dairy/Alternatives - -- [Item] - [Quantity] - [Used in] - -### Grains/Starches - -- [Item] - [Quantity] - [Used in] - -### Frozen - -- [Item] - [Quantity] - [Used in] - -### Pantry - -- [Item] - [Quantity] - [Used in] - -### Money-Saving Tips - -- [Personalized savings strategies] - -### Flexible Swaps - -- [Alternative options if items unavailable] diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md b/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md deleted file mode 100644 index 9c11d05..0000000 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md +++ /dev/null @@ -1,18 +0,0 @@ -## Weekly Meal Framework - -### Protein Rotation - -- Monday: [Protein source] -- Tuesday: [Protein source] -- Wednesday: [Protein source] -- Thursday: [Protein source] -- Friday: [Protein source] -- Saturday: [Protein source] -- Sunday: [Protein source] - -### Meal Timing - -- Breakfast: [Time] - [Type] -- Lunch: [Time] - [Type] -- Dinner: [Time] - [Type] -- Snacks: [As needed] diff --git a/_bmad/bmb/workflows/create-workflow/steps/step-01-init.md b/_bmad/bmb/workflows/create-workflow/steps/step-01-init.md deleted file mode 100644 index a888d21..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-02-gather.md b/_bmad/bmb/workflows/create-workflow/steps/step-02-gather.md deleted file mode 100644 index 5ef645d..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md b/_bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md deleted file mode 100644 index c58d258..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md b/_bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md deleted file mode 100644 index 5a541d7..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md b/_bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md deleted file mode 100644 index 7062f2e..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-07-build.md b/_bmad/bmb/workflows/create-workflow/steps/step-07-build.md deleted file mode 100644 index 01a7be8..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-08-review.md b/_bmad/bmb/workflows/create-workflow/steps/step-08-review.md deleted file mode 100644 index a3d7258..0000000 --- a/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-09-complete.md b/_bmad/bmb/workflows/create-workflow/steps/step-09-complete.md deleted file mode 100644 index 4a9125b..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md b/_bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md deleted file mode 100644 index 6974272..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md b/_bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md deleted file mode 100644 index bf9fbca..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md b/_bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md deleted file mode 100644 index ea9b513..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md b/_bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md deleted file mode 100644 index ae98a2b..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md b/_bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md deleted file mode 100644 index d53c3af..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/templates/completion-summary.md b/_bmad/bmb/workflows/edit-workflow/templates/completion-summary.md deleted file mode 100644 index ca888ff..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md b/_bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md deleted file mode 100644 index 895cb7d..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/templates/improvement-log.md b/_bmad/bmb/workflows/edit-workflow/templates/improvement-log.md deleted file mode 100644 index d544523..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/templates/validation-results.md b/_bmad/bmb/workflows/edit-workflow/templates/validation-results.md deleted file mode 100644 index 5ca7689..0000000 --- a/_bmad/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/_bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md b/_bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md deleted file mode 100644 index 1ef5221..0000000 --- a/_bmad/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/_bmad/bmb/workflows/module/data/agent-architecture.md b/_bmad/bmb/workflows/module/data/agent-architecture.md new file mode 100644 index 0000000..7cfac33 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/data/agent-spec-template.md b/_bmad/bmb/workflows/module/data/agent-spec-template.md new file mode 100644 index 0000000..5452abb --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/data/module-standards.md b/_bmad/bmb/workflows/module/data/module-standards.md new file mode 100644 index 0000000..34d8e3c --- /dev/null +++ b/_bmad/bmb/workflows/module/data/module-standards.md @@ -0,0 +1,263 @@ +# 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 + +--- + +## 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 +└── {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 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 + +--- + +## 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 | diff --git a/_bmad/bmb/workflows/module/data/module-yaml-conventions.md b/_bmad/bmb/workflows/module/data/module-yaml-conventions.md new file mode 100644 index 0000000..ee3b31a --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/module-help-generate.md b/_bmad/bmb/workflows/module/module-help-generate.md new file mode 100644 index 0000000..1bb145f --- /dev/null +++ b/_bmad/bmb/workflows/module/module-help-generate.md @@ -0,0 +1,254 @@ +--- +name: module-help-generate +description: Generate or update module-help.csv for any BMad module with proper structure +web_bundle: false + +# Path variables (to be set by caller) +modulePath: '{module_path}' +moduleYamlFile: '{module_path}/module.yaml' +moduleHelpCsvFile: '{module_path}/module-help.csv' +workflowsDir: '{module_path}/workflows' +agentsDir: '{module_path}/agents' +--- + +# Module Help CSV Generator + +**Goal:** Generate or update a `module-help.csv` file that serves as the central registry for all module functionality - workflows, agents, and commands. + +**Your Role:** You are a Module Documentation Architect. You will analyze a module's structure and create a properly formatted CSV that enables discoverability and CLI integration. + +--- + +## CRITICAL RULES (NO EXCEPTIONS) + +- ALWAYS read existing `module-help.csv` first if it exists - update/validate rather than replace +- ALWAYS read `module.yaml` to get module code and type +- ALWAYS read ALL agent `.yaml` files to understand menu triggers +- ALWAYS read ALL workflow `workflow.md` files to understand purpose +- ALWAYS place `anytime` entries at the TOP with EMPTY sequence +- ALWAYS place phased entries BELOW anytime entries +- ALWAYS number phases starting at `-1` (phase-1, phase-2, phase-3...) +- ALWAYS leave sequence EMPTY for `anytime` entries (user chooses, not ordered) +- ALWAYS include sequence number for phased entries (defines order within phase) +- ALWAYS use EMPTY `workflow-file` for agent-only menu triggers +- ALWAYS include `agent` column for agent-based features +- NEVER assume workflow paths - verify from actual file structure +- ALWAYS search for and put the file at the root of the module ONLY + +--- + +## CSV STRUCTURE (13 columns) + +``` +module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs, +``` + +| Column | Purpose | Rules | +|--------|---------|-------| +| `module` | Module code from `module.yaml` | Required | +| `phase` | `anytime` or `phase-1`, `phase-2`, etc. | Phases start at -1 | +| `name` | Display name of the feature | User-facing | +| `code` | Short code for commands | Unique within module | +| `sequence` | Order within phase | EMPTY for anytime, number for phases | +| `workflow-file` | Path to workflow.md | EMPTY for agent-only | +| `command` | Internal command name | Format: `{module_code}_{feature_code}` | +| `required` | Whether required | Usually `false` | +| `agent` | Associated agent name | From agent YAML metadata | +| `options` | Mode or action type | e.g., "Create Mode", "Chat Mode" | +| `description` | User-facing description | Explain what and when to use | +| `output-location` | Where output goes | Folder name or EMPTY | +| `outputs` | What is produced | Output type or EMPTY | + +--- + +## PHASE AND SEQUENCING RULES + +### 1. anytime +- Use for: standalone features, agent menu triggers, unrelated utilities +- Place at TOP of file +- `sequence` column MUST BE EMPTY +- User chooses what to run - no order + +### 2. Phases (phase-1, phase-2, phase-3...) +- Use for: sequential workflows, guided processes +- Place BELOW anytime entries +- Phases ALWAYS start at `-1` (not 0 or 1) +- `sequence` defines order WITHIN phase (10, 20, 30...) +- the name can be named differently than just phase but should be dash number at the end if sequence is needed + +### 3. Module Integration Patterns + +**Full module with phases:** +``` +anytime entries (sequence empty) +phase-1 entries (sequence 10, 20, 30...) +phase-2 entries (sequence 10, 20, 30...) +``` + +**Add-on to existing module:** +``` +May only have phase-3 entries that integrate into another module's workflow +Sequence numbers fit logically before/after existing items +``` + +**Standalone/Unitary collections:** +``` +All entries are anytime +No sequence numbers +User picks one as needed +``` + +**Agent-only features:** +``` +Empty workflow-file column +Agent handles everything via its menu +``` + +--- + +## EXECUTION SEQUENCE + +### Step 1: Identify Target Module + +Ask user: +1. What is the path to the module? +2. Or should we scan for modules in the workspace? + +### Step 2: Read Module Configuration + +Load and read: +``` +{moduleYamlFile} +``` + +Extract: +- `code` - Module identifier +- `type` - Module type (module, unitary, etc.) +- `name` - Module display name + +### Step 3: Check for Existing module-help.csv + +Check if exists: +``` +{moduleHelpCsvFile} +``` + +**If exists:** +- Read entire file +- Parse all existing entries +- Ask user: Update existing, validate, or regenerate? + +**If not exists:** +- Note: Will create new file +- Proceed to discovery + +### Step 4: Discover All Workflows + +Scan the workflows directory: +``` +{workflowsDir} +``` + +For each workflow found: +- Read the `workflow.md` file +- Extract: name, description, goal, role +- Note the relative path for CSV entry + +### Step 5: Discover All Agents + +Scan the agents directory: +``` +{agentsDir} +``` + +For each agent found: +- Read the `.agent.yaml` file +- Extract: metadata (name, title), persona, menu triggers +- Identify agent-only triggers (no workflow route) +- Identify workflow-routing triggers + +### Step 6: Determine Phasing Strategy + +Analyze the module and decide: + +**Question for each workflow:** +- Is this part of a sequential journey? → Use phases +- Is this standalone/optional? → Use anytime +- Can user do this anytime? → Use anytime + +**For agent menu items:** +- Does it route to a workflow? → Map to that workflow or anytime +- Is it an inline action? → anytime, no workflow file + +### Step 7: Generate CSV Content + +Build the CSV following structure: + +**Header:** +``` +module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs, +``` + +**Entry Rules:** +1. ALL `anytime` entries FIRST - `sequence` EMPTY +2. THEN phased entries - `phase-1`, `phase-2`, etc. +3. Within phases, `sequence` orders execution (10, 20, 30...) +4. Agent-only actions: empty `workflow-file`, specify `agent` + +**Code Format:** +- Command: `{module_code}_{feature_name}` +- Keep codes short but memorable (2-3 letters usually) + +**Description Guidance:** +- Explain WHAT the feature does +- Include WHEN to use it (especially for phased items) +- For add-on modules: "Best used after X but before Y" + +### Step 8: Present to User + +Before writing: +1. Show the CSV content in a readable table format +2. Explain phasing decisions +3. Highlight any agent-only entries +4. Ask for confirmation or adjustments + +### Step 9: Write File + +On confirmation: +``` +Write to: {moduleHelpCsvFile} +``` + +--- + +## EXAMPLE OUTPUT STRUCTURE + +### Full Module with Phases (like mwm): +```csv +module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs, +mwm,anytime,Chat with Wellness,CWC,,"mwm_chat",false,wellness-companion,Chat Mode,"Have a supportive conversation anytime",,, +mwm,anytime,Quick Breathing,QB,,"mwm_breathing",false,meditation-guide,Breathing,"Quick 4-7-8 breathing exercise",,, +mwm,phase-1,Daily Check In,DCI,10,_bmad/mwm/workflows/daily-checkin/workflow.md,mwm_daily_checkin,false,wellness-companion,Check In Mode,"Start your day with wellness check-in",mwm_output,"summary", +mwm,phase-2,Wellness Journal,WJ,20,_bmad/mwm/workflows/wellness-journal/workflow.md,mwm_journal,false,wellness-companion,Journal Mode,"Reflect and track your wellness journey",mwm_output,"entry", +``` + +### Unitary/Standalone Module (like bmad-custom): +```csv +module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs, +bmad-custom,anytime,Quiz Master,QM,,"bmad_quiz",false,,Trivia,"Interactive trivia quiz with gameshow atmosphere",bmad_output,"results", +bmad-custom,anytime,Wassup,WS,,"bmad_wassup",false,,Status,"Check uncommitted changes and suggest commits",bmad_output,"summary", +bmad-custom,anytime,Write Commit,WC,,"bmad_write_commit",false,commit-poet,Write,"Craft a commit message from your changes",bmad_output,"message", +``` + +--- + +## INITIALIZATION + +To begin this workflow: + +1. Ask user for the target module path if not provided +2. Load and read `module.yaml` in the root of the target if it exists +3. Check for existing `module-help.csv` +4. Scan for all workflows and agents +5. Generate CSV following all rules above +6. Update the file and review with the user - never auto commit and push diff --git a/_bmad/bmb/workflows/module/steps-b/step-01-welcome.md b/_bmad/bmb/workflows/module/steps-b/step-01-welcome.md new file mode 100644 index 0000000..b415eca --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-02-spark.md b/_bmad/bmb/workflows/module/steps-b/step-02-spark.md new file mode 100644 index 0000000..1a1b17f --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-03-module-type.md b/_bmad/bmb/workflows/module/steps-b/step-03-module-type.md new file mode 100644 index 0000000..0e5290c --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-04-vision.md b/_bmad/bmb/workflows/module/steps-b/step-04-vision.md new file mode 100644 index 0000000..ada702a --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-05-identity.md b/_bmad/bmb/workflows/module/steps-b/step-05-identity.md new file mode 100644 index 0000000..ddb94a0 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-06-users.md b/_bmad/bmb/workflows/module/steps-b/step-06-users.md new file mode 100644 index 0000000..d42639f --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-07-value.md b/_bmad/bmb/workflows/module/steps-b/step-07-value.md new file mode 100644 index 0000000..05de208 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-08-agents.md b/_bmad/bmb/workflows/module/steps-b/step-08-agents.md new file mode 100644 index 0000000..8769ebe --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-09-workflows.md b/_bmad/bmb/workflows/module/steps-b/step-09-workflows.md new file mode 100644 index 0000000..1feeb9e --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-10-tools.md b/_bmad/bmb/workflows/module/steps-b/step-10-tools.md new file mode 100644 index 0000000..0ead632 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-11-scenarios.md b/_bmad/bmb/workflows/module/steps-b/step-11-scenarios.md new file mode 100644 index 0000000..026e811 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-12-creative.md b/_bmad/bmb/workflows/module/steps-b/step-12-creative.md new file mode 100644 index 0000000..dc2486c --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-13-review.md b/_bmad/bmb/workflows/module/steps-b/step-13-review.md new file mode 100644 index 0000000..d0c8fee --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-b/step-14-finalize.md b/_bmad/bmb/workflows/module/steps-b/step-14-finalize.md new file mode 100644 index 0000000..594915f --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-c/step-01-load-brief.md b/_bmad/bmb/workflows/module/steps-c/step-01-load-brief.md new file mode 100644 index 0000000..dac7592 --- /dev/null +++ b/_bmad/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: '../data/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. Agent placeholder/spec files +4. Workflow placeholder/spec files +5. README.md and TODO.md +6. module-help.csv (generated from specs) + +"**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/_bmad/bmb/workflows/module/steps-c/step-01b-continue.md b/_bmad/bmb/workflows/module/steps-c/step-01b-continue.md new file mode 100644 index 0000000..4dced79 --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-c/step-01b-continue.md @@ -0,0 +1,82 @@ +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation for Create mode' + +workflowFile: '../workflow-create-module.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-agents | +| step-04-agents | step-05-workflows | +| step-05-workflows | step-06-docs | +| step-06-docs | step-07-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/_bmad/bmb/workflows/module/steps-c/step-02-structure.md b/_bmad/bmb/workflows/module/steps-c/step-02-structure.md new file mode 100644 index 0000000..e9d1611 --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-c/step-02-structure.md @@ -0,0 +1,104 @@ +--- +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} +``` + +"**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/` + +### 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/ +✅ Build tracking updated diff --git a/_bmad/bmb/workflows/module/steps-c/step-03-config.md b/_bmad/bmb/workflows/module/steps-c/step-03-config.md new file mode 100644 index 0000000..35b0bec --- /dev/null +++ b/_bmad/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-agents.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/_bmad/bmb/workflows/module/steps-c/step-04-agents.md b/_bmad/bmb/workflows/module/steps-c/step-04-agents.md new file mode 100644 index 0000000..14a762e --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-c/step-04-agents.md @@ -0,0 +1,167 @@ +--- +name: 'step-04-agents' +description: 'Create agent placeholder/spec files' + +nextStepFile: './step-05-workflows.md' +agentSpecTemplate: '../data/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 4: 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-04-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/_bmad/bmb/workflows/module/steps-c/step-05-workflows.md b/_bmad/bmb/workflows/module/steps-c/step-05-workflows.md new file mode 100644 index 0000000..60482b6 --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-c/step-05-workflows.md @@ -0,0 +1,183 @@ +--- +name: 'step-05-workflows' +description: 'Create workflow placeholder/spec files' + +nextStepFile: './step-06-docs.md' +workflowSpecTemplate: '../templates/workflow-spec-template.md' +buildTrackingFile: '{bmad_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 5: 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-05-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/_bmad/bmb/workflows/module/steps-c/step-06-docs.md b/_bmad/bmb/workflows/module/steps-c/step-06-docs.md new file mode 100644 index 0000000..aaeed54 --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-c/step-06-docs.md @@ -0,0 +1,400 @@ +--- +name: 'step-06-docs' +description: 'Generate README.md, TODO.md, and docs/ folder' + +nextStepFile: './step-07-complete.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 6: 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/ +``` + +--- + +## 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 +- [ ] Verify all agents and workflows are discoverable + +--- + +## 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-06-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/_bmad/bmb/workflows/module/steps-c/step-07-complete.md b/_bmad/bmb/workflows/module/steps-c/step-07-complete.md new file mode 100644 index 0000000..843c866 --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-c/step-07-complete.md @@ -0,0 +1,152 @@ +--- +name: 'step-07-complete' +description: 'Finalize, offer to run validation' + +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +moduleHelpGenerateWorkflow: '../module-help-generate.md' +validationWorkflow: '../steps-v/step-01-validate.md' +moduleHelpCsvFile: '{build_tracking_targetLocation}/module-help.csv' +--- + +# Step 7: 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. Generate module-help.csv + +"**🎯 Generating module-help.csv...**" + +Load and execute the module-help-generate workflow: +``` +{moduleHelpGenerateWorkflow} +``` + +**Set these variables before loading:** +- `modulePath: {targetLocation}` +- `moduleYamlFile: {targetLocation}/module.yaml` +- `moduleHelpCsvFile: {targetLocation}/module-help.csv` +- `workflowsDir: {targetLocation}/workflows` +- `agentsDir: {targetLocation}/agents` + +**What this does:** +- Scans all workflows in `{workflowsDir}/` +- Scans all agents in `{agentsDir}/` +- Generates `{moduleHelpCsvFile}` with proper structure: + - `anytime` entries at top (no sequence) + - Phased entries below (phase-1, phase-2, etc.) + - Agent-only entries have empty `workflow-file` + +**Wait for workflow completion** before proceeding. + +### 2. 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 | +| Help Registry | 1 | module-help.csv | +| Documentation | 2 | README.md, TODO.md | + +### 3. 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-agents', 'step-05-workflows', 'step-06-docs', 'step-07-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 + +✅ module-help.csv generated at module root +✅ Build tracking marked COMPLETE +✅ Summary presented to user +✅ Next steps clearly explained +✅ Validation offered (optional) diff --git a/_bmad/bmb/workflows/module/steps-e/step-01-load-target.md b/_bmad/bmb/workflows/module/steps-e/step-01-load-target.md new file mode 100644 index 0000000..023864d --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-e/step-02-select-edit.md b/_bmad/bmb/workflows/module/steps-e/step-02-select-edit.md new file mode 100644 index 0000000..be1baf7 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-e/step-03-apply-edit.md b/_bmad/bmb/workflows/module/steps-e/step-03-apply-edit.md new file mode 100644 index 0000000..a6dd6af --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-e/step-04-review.md b/_bmad/bmb/workflows/module/steps-e/step-04-review.md new file mode 100644 index 0000000..6c0e79c --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-e/step-05-confirm.md b/_bmad/bmb/workflows/module/steps-e/step-05-confirm.md new file mode 100644 index 0000000..486fb9d --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-v/step-01-load-target.md b/_bmad/bmb/workflows/module/steps-v/step-01-load-target.md new file mode 100644 index 0000000..08237f3 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-v/step-02-file-structure.md b/_bmad/bmb/workflows/module/steps-v/step-02-file-structure.md new file mode 100644 index 0000000..966f3ce --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-v/step-02-file-structure.md @@ -0,0 +1,93 @@ +--- +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) + +**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/_bmad/bmb/workflows/module/steps-v/step-03-module-yaml.md b/_bmad/bmb/workflows/module/steps-v/step-03-module-yaml.md new file mode 100644 index 0000000..48f73dd --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-v/step-04-agent-specs.md b/_bmad/bmb/workflows/module/steps-v/step-04-agent-specs.md new file mode 100644 index 0000000..8420397 --- /dev/null +++ b/_bmad/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: '../data/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/_bmad/bmb/workflows/module/steps-v/step-05-workflow-specs.md b/_bmad/bmb/workflows/module/steps-v/step-05-workflow-specs.md new file mode 100644 index 0000000..10ec49a --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-v/step-06-documentation.md b/_bmad/bmb/workflows/module/steps-v/step-06-documentation.md new file mode 100644 index 0000000..d71a99e --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/steps-v/step-07-installation.md b/_bmad/bmb/workflows/module/steps-v/step-07-installation.md new file mode 100644 index 0000000..fcfd0c3 --- /dev/null +++ b/_bmad/bmb/workflows/module/steps-v/step-07-installation.md @@ -0,0 +1,102 @@ +--- +name: 'step-07-installation' +description: 'Installation readiness check' + +nextStepFile: './step-08-report.md' +moduleHelpGenerateWorkflow: '../module-help-generate.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +moduleHelpCsvFile: '{validation_target_path}/module-help.csv' +--- + +# 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 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 + +### 2. Check module-help.csv + +**CRITICAL:** Every module must have `module-help.csv` at its root. + +**Check:** +- [ ] `module-help.csv` exists at `{moduleHelpCsvFile}` +- [ ] Has valid header: `module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs,` +- [ ] `anytime` entries at TOP with EMPTY sequence +- [ ] Phased entries BELOW anytime (phase-1, phase-2, etc.) +- [ ] Agent-only entries have EMPTY `workflow-file` + +**If missing:** +- FAIL - Module is not ready for installation without help registry +- Suggest running `{moduleHelpGenerateWorkflow}` + +### 3. 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 + +### 4. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Installation Readiness + +**Status:** {PASS/FAIL/WARNINGS} + +**Install Variables:** {count} variables +**Install Variables:** {count} variables +**Help Registry:** {present/missing} - {status} +**Ready to Install:** {yes/no} + +**Issues Found:** +{list any issues} +``` + +### 5. Auto-Proceed + +"**✓ Installation readiness check complete.**" + +Proceeding to final report... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ Installation readiness assessed +✅ module-help.csv presence and structure validated +✅ Module type compatibility checked +✅ Results recorded diff --git a/_bmad/bmb/workflows/module/steps-v/step-08-report.md b/_bmad/bmb/workflows/module/steps-v/step-08-report.md new file mode 100644 index 0000000..f521159 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/templates/brief-template.md b/_bmad/bmb/workflows/module/templates/brief-template.md new file mode 100644 index 0000000..01ad3f3 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/templates/workflow-spec-template.md b/_bmad/bmb/workflows/module/templates/workflow-spec-template.md new file mode 100644 index 0000000..40133a8 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/module/workflow-create-module-brief.md b/_bmad/bmb/workflows/module/workflow-create-module-brief.md new file mode 100644 index 0000000..4dca2df --- /dev/null +++ b/_bmad/bmb/workflows/module/workflow-create-module-brief.md @@ -0,0 +1,71 @@ +--- +name: create-module-brief +description: Create product brief for BMAD module development +web_bundle: true +installed_path: '{project-root}/_bmad/bmb/workflows/module' +briefWorkflow: './steps-b/step-01-welcome.md' +--- + +# Create Module Brief + +**Goal:** Collaboratively explore and design your module vision through creative discovery. + +**Your Role:** You are the **Module Architect** — a specialist in BMAD module design. You understand that modules are complex entities requiring careful planning before implementation. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution. + +### Core Principles + +- **Micro-file Design**: Each step is a self contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Sequence within the step files must be completed in order +- **State Tracking**: Document progress in output file frontmatter +- **Append-Only Building**: Build documents by appending content as directed + +### 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 +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, only proceed when user selects 'C' +5. **SAVE STATE**: Update frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### 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 writing final output for a step +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** create mental todo lists from future steps +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with config `{communication_language}` + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml` and resolve: + +- `project_name`, `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. Route to Brief Workflow + +"**Brief Mode: Creating a module brief through exploratory, creative discovery.**" + +Load, read completely, then execute `{briefWorkflow}` (steps-b/step-01-welcome.md) + +--- + +## OUTPUT + +**Brief mode produces:** +- `module-brief-{code}.md` — Complete module vision document diff --git a/_bmad/bmb/workflows/module/workflow-create-module.md b/_bmad/bmb/workflows/module/workflow-create-module.md new file mode 100644 index 0000000..7c2edc2 --- /dev/null +++ b/_bmad/bmb/workflows/module/workflow-create-module.md @@ -0,0 +1,86 @@ +--- +name: create-module +description: Create a complete BMAD module with agents, workflows, and infrastructure +web_bundle: true +installed_path: '{project-root}/_bmad/bmb/workflows/module' +createWorkflow: './steps-c/step-01-load-brief.md' +--- + +# Create Module + +**Goal:** Build a complete, installable BMAD module from a module brief. + +**Your Role:** You are the **Module Architect** — a specialist in BMAD module design and implementation. You transform module visions into fully structured, compliant modules. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution. + +### Core Principles + +- **Micro-file Design**: Each step is a self contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Sequence within the step files must be completed in order +- **State Tracking**: Document progress in output file frontmatter +- **Append-Only Building**: Build documents by appending content as directed + +### 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 +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, only proceed when user selects 'C' +5. **SAVE STATE**: Update frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### 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 writing final output for a step +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** create mental todo lists from future steps +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with config `{communication_language}` + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml` and resolve: + +- `project_name`, `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. Route to Create Workflow + +"**Create Mode: Building a complete BMAD module from a module brief.**" + +Ask: "Where is the module brief? Please provide the path to the module-brief-{code}.md file." + +Then load, read completely, and execute `{createWorkflow}` (steps-c/step-01-load-brief.md) + +--- + +## CONFIGURATION + +This workflow references: +- `{installed_path}/data/` — Module standards and templates +- `{installed_path}/templates/` — Output templates + +--- + +## OUTPUT + +**Create mode produces:** +- Module directory structure +- `module.yaml` with install configuration +- Agent placeholder/spec files +- Workflow placeholder/spec files +- `README.md` and `TODO.md` +- `module-help.csv` (generated from specs) diff --git a/_bmad/bmb/workflows/module/workflow-edit-module.md b/_bmad/bmb/workflows/module/workflow-edit-module.md new file mode 100644 index 0000000..6cd3024 --- /dev/null +++ b/_bmad/bmb/workflows/module/workflow-edit-module.md @@ -0,0 +1,66 @@ +--- +name: edit-module +description: Edit existing BMAD modules while maintaining coherence +web_bundle: true +installed_path: '{project-root}/_bmad/bmb/workflows/module' +editWorkflow: './steps-e/step-01-load-target.md' +--- + +# Edit Module + +**Goal:** Modify existing BMAD module briefs or module structures while maintaining coherence and compliance. + +**Your Role:** You are the **Module Architect** — a specialist in BMAD module design and maintenance. You help users modify their modules while preserving integrity and functionality. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution. + +### Core Principles + +- **Micro-file Design**: Each step is a self contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Sequence within the step files must be completed in order +- **State Tracking**: Document progress in output file frontmatter +- **Append-Only Building**: Build documents by appending content as directed + +### 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 +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, only proceed when user selects 'C' +5. **SAVE STATE**: Update frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### 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 writing final output for a step +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** create mental todo lists from future steps +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with config `{communication_language}` + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml` and resolve: + +- `project_name`, `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. Route to Edit Workflow + +"**Edit Mode: Modifying an existing BMAD module brief or module structure.**" + +Ask: "What would you like to edit? Please provide the path to the module brief or module directory." + +Then load, read completely, and execute `{editWorkflow}` (steps-e/step-01-assess.md) diff --git a/_bmad/bmb/workflows/module/workflow-validate-module.md b/_bmad/bmb/workflows/module/workflow-validate-module.md new file mode 100644 index 0000000..83da7f0 --- /dev/null +++ b/_bmad/bmb/workflows/module/workflow-validate-module.md @@ -0,0 +1,66 @@ +--- +name: validate-module +description: Run compliance check on BMAD modules against best practices +web_bundle: true +installed_path: '{project-root}/_bmad/bmb/workflows/module' +validateWorkflow: './steps-v/step-01-validate.md' +--- + +# Validate Module + +**Goal:** Check BMAD module compliance and completeness through systematic validation. + +**Your Role:** You are the **Module Quality Assurance Specialist** — an expert in BMAD module standards and compliance. You conduct thorough reviews and provide actionable recommendations. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution. + +### Core Principles + +- **Micro-file Design**: Each step is a self contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Sequence within the step files must be completed in order +- **State Tracking**: Document progress in output file frontmatter +- **Append-Only Building**: Build documents by appending content as directed + +### 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 +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, only proceed when user selects 'C' +5. **SAVE STATE**: Update frontmatter before loading next step +6. **LOAD NEXT**: When directed, read fully and follow the next step file + +### 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 writing final output for a step +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** create mental todo lists from future steps +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with config `{communication_language}` + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml` and resolve: + +- `project_name`, `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. Route to Validate Workflow + +"**Validate Mode: Running compliance check on BMAD module.**" + +Ask: "What would you like to validate? Please provide the path to the module brief or module directory." + +Then load, read completely, and execute `{validateWorkflow}` (steps-v/step-01-validate.md) diff --git a/_bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md deleted file mode 100644 index b7c55d4..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md deleted file mode 100644 index 70d818d..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md deleted file mode 100644 index 5d601a7..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md deleted file mode 100644 index 26505b4..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md deleted file mode 100644 index 08992f9..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md deleted file mode 100644 index c9b84af..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md deleted file mode 100644 index 005b852..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md b/_bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md deleted file mode 100644 index 43bfd3e..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md b/_bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md deleted file mode 100644 index 2fd5e8a..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow-compliance-check/workflow.md b/_bmad/bmb/workflows/workflow-compliance-check/workflow.md deleted file mode 100644 index 5fc29ff..0000000 --- a/_bmad/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/_bmad/bmb/workflows/workflow/data/architecture.md b/_bmad/bmb/workflows/workflow/data/architecture.md new file mode 100644 index 0000000..a19223f --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/architecture.md @@ -0,0 +1,150 @@ +# 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 Standards + +**CRITICAL:** workflow.md MUST be lean — entry point only. + +**❌ PROHIBITED:** +- Listing all steps (defeats progressive disclosure) +- Detailed step descriptions (steps are self-documenting) +- Validation checklists (belong in steps-v/) +- Implementation details (belong in step files) + +**✅ REQUIRED:** +- Frontmatter: name, description, web_bundle +- Goal: What the workflow accomplishes +- Role: Who the AI embodies +- Meta-context: Architecture background (if pattern demo) +- Core principles (step-file design, JIT loading, etc.) +- Initialization/routing: How to start, which step first + +**Progressive Disclosure:** Users ONLY know about current step. workflow.md routes to first step, each step routes to next. No step lists in workflow.md! + +--- + +## Core Principles + +### 1. Micro-File Design +- Each step: ~80-200 lines, focused +- One concept per step +- Self-contained instructions + +### 2. Just-In-Time Loading +- Only current step in memory +- Never load future steps until 'C' selected +- Progressive disclosure = LLM focus + +### 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:** +``` +workflow.md → step-01-init.md (detects existing) → step-01b-continue.md → [next step] +``` + +--- + +## Frontmatter Variables + +### Standard +```yaml +workflow_path: '{project-root}/_bmad/[module]/workflows/[name]' +thisStepFile: './step-[N]-[name].md' +nextStepFile: './step-[N+1]-[name].md' +outputFile: '{output_folder}/[output].md' +``` + +### Module-Specific +```yaml +bmb_creations_output_folder: '{project-root}/_bmad/bmb-creations' +``` + +### 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 BEFORE loading next: + +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/_bmad/bmb/workflows/workflow/data/common-workflow-tools.csv b/_bmad/bmb/workflows/workflow/data/common-workflow-tools.csv new file mode 100644 index 0000000..0304bab --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/common-workflow-tools.csv @@ -0,0 +1,19 @@ +propose,type,tool_name,description,url,requires_install +always,workflow,party-mode,"Enables collaborative idea generation by managing turn-taking, summarizing contributions, and synthesizing ideas from multiple AI personas in structured conversation sessions.",{project-root}/_bmad/core/workflows/party-mode/workflow.md,no +always,workflow,advanced-elicitation,"Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs.",{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml,no +always,task,brainstorming,"Facilitates idea generation by prompting users with targeted questions and synthesizing concepts into actionable insights.",{project-root}/_bmad/core/tasks/brainstorming.xml,no +always,llm-tool-feature,web-browsing,"Provides LLM with capabilities to perform real-time web searches and incorporate current information.",,no +always,llm-tool-feature,file-io,"Enables LLM to manage file operations such as creating, reading, updating, and deleting files.",,no +always,llm-tool-feature,sub-agents,"Allows LLM to create and manage specialized sub-agents for parallel processing and modular task delegation.",,no +always,llm-tool-feature,sub-processes,"Enables LLM to initiate and manage subprocesses for parallel processing of complex tasks.",,no +always,tool-memory,sidecar-file,"Creates a persistent history file for session-to-session state management, enabling continuity through workflow initialization with previous context.",,no +example,tool-memory,vector-database,"Stores and retrieves semantic information through embeddings for intelligent memory access based on meaning rather than exact matches.",https://github.com/modelcontextprotocol/servers/tree/main/src/rag-agent,yes +example,mcp,context-7,"A curated knowledge base of API documentation and third-party tool references for integration and development tasks.",https://github.com/modelcontextprotocol/servers/tree/main/src/context-7,yes +example,mcp,playwright,"Provides capabilities for web browser automation including navigation, form submission, and data extraction.",https://github.com/modelcontextprotocol/servers/tree/main/src/playwright,yes +example,workflow,security-auditor,"Analyzes workflows and code for security vulnerabilities, compliance issues, and best practices violations.",,no +example,task,code-review,"Performs systematic code analysis identifying bugs, performance issues, style violations, and architectural problems.",,no +example,mcp,git-integration,"Enables direct Git repository operations including commits, branches, merges, and history analysis.",https://github.com/modelcontextprotocol/servers/tree/main/src/git,yes +example,mcp,database-connector,"Provides direct database connectivity for querying, updating, and managing data across multiple database types.",https://github.com/modelcontextprotocol/servers/tree/main/src/postgres,yes +example,task,api-testing,"Automated API endpoint testing with request/response validation and authentication handling for REST and GraphQL.",,no +example,workflow,deployment-manager,"Orchestrates application deployment across multiple environments with rollback capabilities and health checks.",,no +example,task,data-validator,"Validates data quality, schema compliance, and business rules through comprehensive data profiling.",,no diff --git a/_bmad/bmb/workflows/workflow/data/csv-data-file-standards.md b/_bmad/bmb/workflows/workflow/data/csv-data-file-standards.md new file mode 100644 index 0000000..24ea3c3 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/csv-data-file-standards.md @@ -0,0 +1,53 @@ +# CSV Data File Standards + +## When to Use CSV + +Use for: +- Domain-specific data not in training data +- Too large for prompt context +- Structured lookup/reference needs +- Cross-session consistency required + +**Don't use for:** Web-searchable info, common syntax, general knowledge, LLM-generatable content + +## CSV Structure + +```csv +category,name,pattern,description +"collaboration","Think Aloud Protocol","user speaks thoughts → facilitator captures","Make thinking visible during work" +``` + +**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 + +### Method Registry +```csv +category,name,pattern +collaboration,Think Aloud,user speaks thoughts → facilitator captures +advanced,Six Thinking Hats,view problem from 6 perspectives +``` + +### Knowledge Base Index +```csv +keywords,document_path,section +"nutrition,macros",data/nutrition-reference.md,## Daily Targets +``` + +### Configuration Lookup +```csv +scenario,required_steps,output_sections +"2D Platformer",step-01,step-03,step-07,movement,physics,collision +``` + +## Best Practices + +- Keep files small (<1MB preferred) +- No unused columns +- Use efficient encoding (codes vs full descriptions) +- Document purpose +- Validate data quality diff --git a/_bmad/bmb/workflows/workflow/data/frontmatter-standards.md b/_bmad/bmb/workflows/workflow/data/frontmatter-standards.md new file mode 100644 index 0000000..4864fd0 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/frontmatter-standards.md @@ -0,0 +1,184 @@ +# 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** - NO `workflow_path` variable allowed + +--- + +## Standard Variables + +| Variable | Example | +|----------|---------| +| `{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`. + +**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 variables used in this step +```yaml +--- +# Step to step (SAME folder) - use ./filename.md +nextStepFile: './step-02-vision.md' + +# Step to template (PARENT folder) - use ../filename.md +productBriefTemplate: '../product-brief.template.md' + +# Step to data (SUBFOLDER) - use ./data/filename.md +someData: './data/config.csv' + +# Output files - use variable +outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' + +# External references - use {project-root} +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- +``` + +--- + +## Critical Rule: Unused Variables Forbidden + +**Detection Rule:** For EVERY variable in frontmatter, search the step body for `{variableName}`. If not found, it's a violation. + +### ❌ VIOLATION +```yaml +--- +outputFile: '{output_folder}/output.md' +thisStepFile: './step-01-init.md' # ❌ NEVER USED +workflowFile: './workflow.md' # ❌ NEVER USED +--- +``` + +### ✅ CORRECT +```yaml +--- +outputFile: '{output_folder}/output.md' +nextStepFile: './step-02-foo.md' +--- +``` + +--- + +## Path Rules + +| Type | Format | Example | +|------|--------|---------| +| Step to Step (same folder) | `./filename.md` | `./step-02-vision.md` | +| Step to Template (parent) | `../filename.md` | `../template.md` | +| Step to Subfolder | `./subfolder/file.md` | `./data/config.csv` | +| External References | `{project-root}/...` | `{project-root}/_bmad/core/workflows/...` | +| Output Files | `{folder_variable}/...` | `{planning_artifacts}/output.md` | + +--- + +## ❌ FORBIDDEN Patterns + +| Pattern | Why | +|---------|-----| +| `workflow_path: '{project-root}/...'` | Use relative paths | +| `thisStepFile: './step-XX.md'` | Remove unless referenced | +| `workflowFile: './workflow.md'` | Remove unless referenced | +| `{workflow_path}/templates/...` | Use `../template.md` | +| `{workflow_path}/data/...` | Use `./data/file.md` | + +--- + +## Variable Naming + +Use `snake_case` with descriptive prefixes: + +| Suffix | Usage | Example | +|--------|-------|---------| +| `*_File` | File references | `outputFile`, `nextStepFile` | +| `*_Task` | Task references | `advancedElicitationTask` | +| `*_Workflow` | Workflow references | `partyModeWorkflow` | +| `*_Template` | Templates | `productBriefTemplate` | +| `*_Data` | Data files | `dietaryData` | + +--- + +## Defining New Variables + +Steps can define NEW variables for future steps. + +**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`. + +--- + +## Validation Checklist + +For EVERY step frontmatter, verify: + +- [ ] `name` present, kebab-case format +- [ ] `description` present +- [ ] Extract ALL variable names from frontmatter +- [ ] For EACH variable, search body: is `{variableName}` present? +- [ ] If variable NOT in body → ❌ VIOLATION, remove from frontmatter +- [ ] All step-to-step paths use `./filename.md` format +- [ ] All parent-folder paths use `../filename.md` format +- [ ] All subfolder paths use `./subfolder/filename.md` format +- [ ] NO `{workflow_path}` variable exists +- [ ] External paths use `{project-root}` variable +- [ ] Module variables only used if workflow belongs to that module diff --git a/_bmad/bmb/workflows/workflow/data/input-discovery-standards.md b/_bmad/bmb/workflows/workflow/data/input-discovery-standards.md new file mode 100644 index 0000000..e7795c5 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/input-discovery-standards.md @@ -0,0 +1,191 @@ +# Input Document Discovery Standards + +**Purpose:** Workflow input discovery, validation, and selection from prior workflows or external sources. + +--- + +## Discovery Patterns + +1. **Prior Workflow Output** - Sequential workflows (e.g., PRD → Architecture → Epics) +2. **Module Folder Search** - Known project locations +3. **User-Specified Paths** - User-provided document locations +4. **Pattern-Based Discovery** - File naming pattern matching (e.g., `*-brief.md`) + +--- + +## Discovery Step Pattern + +**When:** Step 1 (init) or Step 2 (discovery) + +**Frontmatter:** +```yaml +--- +# Input discovery variables +inputDocuments: [] # Discovered docs +requiredInputCount: 1 # Minimum required +optionalInputCount: 0 # Additional optional docs +moduleInputFolder: '{planning_artifacts}' +inputFilePatterns: + - '*-prd.md' + - '*-ux.md' +--- +``` + +**Discovery Logic:** +```markdown +## 1. Check Known Prior Workflow Outputs +Search 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: match {inputFilePatterns} in {moduleInputFolder} and {project_folder}/docs/ + +## 3. Present Findings +"Found these documents: +- [1] prd-my-project.md (3 days ago) +- [2] ux-research.md (1 week ago) + +Select multiple or provide additional paths." + +## 4. Confirm and Load +Add selections to {inputDocuments} array in output frontmatter +``` + +--- + +## Required vs Optional Inputs + +**Required:** Workflow cannot proceed without these. +```markdown +## INPUT REQUIREMENT: +Requires PRD to proceed. + +Searching: {bmm_creations_output_folder}/prd-*.md, {planning_artifacts}/*-prd.md + +[Found:] "Found PRD: prd-my-project.md. Use this?" +[Missing:] "No PRD found. Run PRD workflow first or provide path." +``` + +**Optional:** Workflow can proceed without these. +```markdown +## OPTIONAL INPUTS: +Can incorporate research if available. + +Searching: {bmm_creations_output_folder}/research-*.md, {project_folder}/research/ + +[Found:] "Found research documents. Include any? (None required)" +``` + +--- + +## Module Workflow Chaining + +**Frontmatter in workflow.md:** +```yaml +--- +## INPUT FROM PRIOR WORKFLOWS + +### Required Inputs: +- {module_output_folder}/prd-{project_name}.md + +### Optional Inputs: +- {module_output_folder}/ux-research-{project_name}.md +--- +``` + +**Step 1 discovery:** +```markdown +## 1. Discover Prior Workflow Outputs + +Check required: {module_output_folder}/prd-{project_name}.md +- Missing → Error: "Run PRD workflow first" +- Found → Confirm with user + +Check optional: Search for patterns, present findings, add selections to {inputDocuments} +``` + +--- + +## Input Validation + +```markdown +## INPUT VALIDATION: + +For each discovered document: +1. Load frontmatter +2. Check workflowType matches expected +3. Check stepsCompleted == complete +4. Check date (warn if old) + +[Fail:] "Document appears incomplete. Last step: step-06 (of 11). Proceed anyway?" +``` + +--- + +## Multiple Input Selection + +```markdown +## Document Selection + +"Found relevant documents: +[1] prd-my-project.md (3 days ago) ✓ Recommended +[2] prd-v1.md (2 months ago) ⚠ Older + +Enter numbers (comma-separated): > 1, 3" +``` + +**Track in frontmatter:** +```yaml +--- +inputDocuments: + - path: '{output_folder}/prd-my-project.md' + type: 'prd' + source: 'prior-workflow' + selected: true +--- +``` + +--- + +## Search Path Variables + +| 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 + +- [ ] 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 diff --git a/_bmad/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md b/_bmad/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md new file mode 100644 index 0000000..a54e84d --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md @@ -0,0 +1,44 @@ +# 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/_bmad/bmb/workflows/workflow/data/menu-handling-standards.md b/_bmad/bmb/workflows/workflow/data/menu-handling-standards.md new file mode 100644 index 0000000..fde9827 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/menu-handling-standards.md @@ -0,0 +1,133 @@ +# 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), Step 2 if only loading documents, validation sequences, 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 Rules + +### ❌ DON'T: +- Omit handler section after Display +- Include A/P in Step 1 (no content to refine) +- Forget "redisplay menu" for non-C options +- Miss "halt and wait" in EXECUTION RULES + +### ✅ 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/_bmad/bmb/workflows/workflow/data/output-format-standards.md b/_bmad/bmb/workflows/workflow/data/output-format-standards.md new file mode 100644 index 0000000..1b456b1 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/output-format-standards.md @@ -0,0 +1,135 @@ +# Output Format Standards + +## 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 + +``` +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 +``` + +### Pattern 2: Direct-to-Final + +``` +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 +``` + +## Four Template Types + +### 1. Free-Form (RECOMMENDED) +- Minimal template, progressive append, final polish + +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- + +# {{document_title}} + +[Content appended progressively by workflow steps] +``` + +### 2. Structured +- Single template with placeholders, clear sections + +```markdown +# {{title}} + +## {{section_1}} +[Content to be filled] + +## {{section_2}} +[Content to be filled] +``` + +### 3. Semi-Structured +- Core required sections + optional additions + +### 4. Strict +- Multiple templates, exact field definitions +- Use for: 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' +``` diff --git a/_bmad/bmb/workflows/workflow/data/step-file-rules.md b/_bmad/bmb/workflows/workflow/data/step-file-rules.md new file mode 100644 index 0000000..405358e --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/step-file-rules.md @@ -0,0 +1,235 @@ +# Step File Rules + +**Purpose:** Quick reference for step 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 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 complete step file before taking 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 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/_bmad/bmb/workflows/workflow/data/step-type-patterns.md b/_bmad/bmb/workflows/workflow/data/step-type-patterns.md new file mode 100644 index 0000000..7b0531e --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/step-type-patterns.md @@ -0,0 +1,257 @@ +# Step Type Patterns + +## Core Skeleton +```markdown +--- +name: 'step-[N]-[name]' +description: '[action]' +[file refs only if used] +--- + +# Step [N]: [Name] + +## STEP GOAL: +[single sentence] + +## MANDATORY EXECUTION RULES: +### Universal: +- 🛑 NEVER generate without user input +- 📖 Read complete step file before action +- 🔄 When loading with 'C', read entire file +- 📋 Facilitator, not generator + +### Role: +- ✅ Role: [specific] +- ✅ Collaborative dialogue +- ✅ You bring [expertise], user brings [theirs] + +### Step-Specific: +- 🎯 Focus: [task] +- 🚫 Forbidden: [action] +- 💬 Approach: [method] + +## EXECUTION PROTOCOLS: +- 🎯 Follow MANDATORY SEQUENCE exactly +- 💾 [protocol] +- 📖 [protocol] + +## CONTEXT BOUNDARIES: +- Available: [context] +- Focus: [scope] +- Limits: [bounds] +- Dependencies: [reqs] + +## MANDATORY SEQUENCE +**Follow exactly. No skip/reorder without user request.** + +### 1. [action] +[instructions] + +### N. MENU OPTIONS +[see menu-handling-standards.md] + +## 🚨 SUCCESS/FAILURE: +### ✅ SUCCESS: [criteria] +### ❌ FAILURE: [criteria] +**Master Rule:** Skipping steps FORBIDDEN. +``` + +## Step Types + +### 1. Init (Non-Continuable) +**Use:** Single-session workflow + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: 'Initialize [workflow]' +nextStepFile: './step-02-[name].md' +outputFile: '{output_folder}/[output].md' +templateFile: '../templates/[template].md' +--- +``` +- No continuation detection +- Auto-proceeds to step 2 +- No A/P menu +- Creates output from template + +### 2. Init (Continuable) +**Use:** Multi-session workflow + +**Frontmatter:** Add `continueFile: './step-01b-continue.md'` + +**Logic:** +```markdown +## 1. Check Existing Workflow +- Look for {outputFile} +- If exists + has stepsCompleted → load {continueFile} +- If not → continue to setup +``` +**Ref:** `step-01-init-continuable-template.md` + +### 3. Continuation (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` from output +2. Read last completed step file to find nextStep +3. Welcome user back +4. Route to appropriate step + +**Ref:** `step-1b-template.md` + +### 4. Middle (Standard) +**Use:** Collaborative content generation + +**Frontmatter:** +```yaml +--- +name: 'step-[N]-[name]' +nextStepFile: './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 + +### 5. Middle (Simple) +**Use:** Data gathering, no refinement + +**Menu:** C only + +### 6. Branch Step +**Use:** User choice determines path + +**Frontmatter:** +```yaml +nextStepFile: './step-[default].md' +altStepFile: './step-[alternate].md' +``` +**Menu:** Custom letters (L/R/etc.) + +### 7. Validation Sequence +**Use:** Multiple checks without interruption + +**Menu:** Auto-proceed + +**Pattern:** +```markdown +## 1. Perform validation check +[logic] + +## 2. Write results to {outputFile} +Append findings + +## 3. Proceed to next validation +"**Proceeding to next check...**" +→ Load {nextValidationStep} +``` + +### 8. Init (With Input Discovery) +**Use:** Requires documents from prior workflows/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' +--- +``` +**Logic:** +```markdown +## 1. Discover Inputs +Search {moduleInputFolder} + {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 docs +Add to {inputDocuments} + +## 4. Auto-Proceed +If all required inputs → step 2 +If missing → Error with guidance +``` +**Ref:** `input-discovery-standards.md` + +### 9. Final Polish +**Use:** Optimizes document section-by-section + +**Frontmatter:** +```yaml +--- +name: 'step-[N]-polish' +description: 'Optimize and finalize document' +outputFile: '{output_folder}/[document].md' +--- +``` +**Logic:** +```markdown +## 1. Load Complete Document +Read {outputFile} + +## 2. Document Optimization +Review for: +1. Flow/coherence +2. Duplication (remove, preserve essential) +3. Proper ## Level 2 headers +4. Smooth transitions +5. Readability + +## 3. Optimize +Maintain: +- General order +- Essential info +- User's voice + +## 4. Final Output +Save, mark complete +``` +**Use for:** Free-form output workflows + +### 10. Final Step +**Use:** Last step, completion + +**Frontmatter:** No `nextStepFile` + +**Logic:** +- Update frontmatter (mark complete) +- Final summary +- No next step + +## Step Size Limits +| Type | Max | +| --------------------- | ------ | +| Init | 150 | +| Init (with discovery) | 200 | +| Continuation | 200 | +| Middle (simple) | 200 | +| Middle (complex) | 250 | +| Branch | 200 | +| Validation sequence | 150 | +| Final polish | 200 | +| Final | 200 | + +**If exceeded:** Split steps or extract to `/data/`. diff --git a/_bmad/bmb/workflows/workflow/data/subprocess-optimization-patterns.md b/_bmad/bmb/workflows/workflow/data/subprocess-optimization-patterns.md new file mode 100644 index 0000000..4318c12 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/subprocess-optimization-patterns.md @@ -0,0 +1,188 @@ +# Subprocess Optimization Patterns + +**Purpose:** Context-saving and performance patterns for subprocess/subagent usage in BMAD workflows. + +--- + +## Golden Rules + +1. **Subprocess when operations benefit from parallelization or context isolation** +2. **Return ONLY findings to parent, not full file contents** +3. **Always provide graceful fallback** for LLMs without subprocess capability +4. **Match pattern to operation type** - grep/regex, deep analysis, or data operations + +--- + +## Pattern 1: Single Subprocess for Grep/Regex Across Many Files + +**Use when:** One command across many files, only need matches/failures +**Context savings:** Massive (1000:1 ratio) + +**Template:** +```markdown +Launch a subprocess that: +1. Runs grep/regex across all target files +2. Extracts only matching lines or failures +3. Returns structured findings to parent +``` + +**Good:** "Launch subprocess to grep all files for pattern, return only matches" +**Bad:** "For EACH file, load the file and search for pattern" + +**Example return:** +```json +{"violations": [{"file": "step-02.md", "line": 45, "match": "..."}], "summary": {"total_files_checked": 10, "violations_found": 3}} +``` + +--- + +## Pattern 2: Separate Subprocess Per File for Deep Analysis + +**Use when:** Reading prose, logic, quality, or flow of each file +**Context savings:** High (10:1 ratio) + +**Template:** +```markdown +DO NOT BE LAZY - For EACH file, launch a subprocess that: +1. Loads that file +2. Reads and analyzes content deeply +3. Returns structured analysis findings to parent +``` + +**Good:** "DO NOT BE LAZY - For EACH step file, launch subprocess to analyze instruction style, return findings" +**Bad:** "Load every step file and analyze its instruction style" + +**Use cases:** Instruction style validation, collaborative quality assessment, frontmatter compliance, step type validation + +--- + +## Pattern 3: Subprocess for Data File Operations + +**Use when:** Loading reference data, fuzzy/best matching, summarizing large datasets +**Context savings:** Massive (100:1 ratio) + +**Template:** +```markdown +Launch a subprocess that: +1. Loads the data file (reference docs, CSV, knowledge base) +2. Performs lookup, matching, or summarization +3. Returns ONLY relevant rows or key findings to parent +``` + +**Good:** "Launch subprocess to load {dataFile}, find applicable rules, return only those" +**Bad:** "Load {dataFile} with 500 rules and find applicable ones" + +**Use cases:** Reference rules lookup, CSV fuzzy matching, document summarization, knowledge base search + +--- + +## Pattern 4: Parallel Execution Opportunities + +**Use when:** Multiple independent operations could run simultaneously +**Performance gain:** Reduced total execution time + +**Template:** +```markdown +Launch subprocesses in parallel that: +1. Each handles one independent operation +2. All run simultaneously +3. Parent aggregates results when complete +``` + +**Example:** Instead of sequential checks, launch 3 subprocesses in parallel (frontmatter, menu, step types), then aggregate. + +--- + +## Graceful Fallback Pattern (CRITICAL) + +**Universal Rule:** +```markdown +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread +``` + +**Implementation:** +```markdown +### Step-Specific Rules: +- 🎯 Use subprocess optimization when available - [pattern description] +- 💬 If subprocess unavailable, perform operations in main thread +``` + +--- + +## Return Pattern for Subprocesses + +**Subprocesses must either:** + +**Option A: Update report directly** - "Subprocess loads validation report, appends findings, saves" + +**Option B: Return structured findings to parent** - "Subprocess returns JSON findings to parent for aggregation" + +**Good return:** `{"file": "step-02.md", "violations": ["..."], "opportunities": ["..."], "priority": "HIGH"}` +**Bad:** "Subprocess loads file and returns full content to parent" + +--- + +## When to Use Each Pattern + +| Pattern | Use When | Context Savings | +| -------- | -------- | --------------- | +| Pattern 1: Grep/regex | Finding patterns across many files | Massive (1000:1) | +| Pattern 2: Per-file analysis | Understanding prose, logic, quality | High (10:1) | +| Pattern 3: Data operations | Reference data, matching, summarizing | Massive (100:1) | +| Pattern 4: Parallel execution | Independent operations | Performance gain | + +--- + +## Step File Integration + +### Universal Rule (all steps) +```markdown +### Universal Rules: +- ⚙️ TOOL/SUBPROCESS FALLBACK: If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread +``` + +### Step-Specific Rules +```markdown +### Step-Specific Rules: +- 🎯 [which pattern applies] +- 💬 Subprocess must either update report OR return findings to parent +- 🚫 DO NOT BE LAZY - [specific guidance for Pattern 2] +``` + +### Command Directives +- Pattern 1: "Launch subprocess that runs [command] across all files, returns [results]" +- Pattern 2: "DO NOT BE LAZY - For EACH file, launch subprocess that [analyzes], returns [findings]" +- Pattern 3: "Launch subprocess that loads [data file], performs [operation], returns [results]" + +--- + +## Validation Checklist + +- [ ] Universal fallback rule present +- [ ] Step-specific rules mention which pattern applies +- [ ] Command sequence uses appropriate subprocess directive +- [ ] "DO NOT BE LAZY" language included for Pattern 2 +- [ ] Return pattern specified (update report OR return to parent) +- [ ] Graceful fallback addressed +- [ ] Pattern matches operation type (grep/regex, deep analysis, or data ops) + +--- + +## Anti-Patterns to Avoid + +| ❌ Anti-Pattern | ✅ Correct Approach | +| --------------- | ------------------- | +| "For EACH file, load the file, analyze it" | "Launch subprocess per file that returns analysis" | +| "Subprocess loads file and returns content" | "Subprocess returns structured findings only" | +| "Use subprocess to [operation]" (no fallback) | Include fallback rule for non-subprocess LLMs | +| "Launch subprocess per file to grep" | Use Pattern 1 (single subprocess for grep) | +| "Launch subprocess to analyze files" | Specify what subprocess returns | + +--- + +## See Also + +- `step-file-rules.md` - When to extract content to data files +- `step-08b-subprocess-optimization.md` - Validation step for optimization opportunities +- `../steps-v/step-02b-path-violations.md` - Example of Pattern 1 +- `../steps-v/step-08b-subprocess-optimization.md` - Example of Pattern 2 diff --git a/_bmad/bmb/workflows/workflow/data/trimodal-workflow-structure.md b/_bmad/bmb/workflows/workflow/data/trimodal-workflow-structure.md new file mode 100644 index 0000000..d737bbd --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/trimodal-workflow-structure.md @@ -0,0 +1,164 @@ +# Tri-Modal Workflow Structure + +## Golden Rule + +**For complex critical workflows: Implement tri-modal structure (create/validate/edit) with cross-mode integration.** + +**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) +```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 +```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 +```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 +```yaml +# In create step-10-confirmation +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 +--- +``` diff --git a/_bmad/bmb/workflows/workflow/data/workflow-chaining-standards.md b/_bmad/bmb/workflows/workflow/data/workflow-chaining-standards.md new file mode 100644 index 0000000..5f97486 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/workflow-chaining-standards.md @@ -0,0 +1,222 @@ +# Workflow Chaining Standards + +## 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 + +**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 + +**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 + +```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` | + +## 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'] +--- +``` + +## Cross-Module Dependencies + +```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) +``` diff --git a/_bmad/bmb/workflows/workflow/data/workflow-examples.md b/_bmad/bmb/workflows/workflow/data/workflow-examples.md new file mode 100644 index 0000000..fecc7b7 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/workflow-examples.md @@ -0,0 +1,232 @@ +# Novel Workflow Examples + +**Purpose:** Illustrative examples across diverse domains. + +--- + +## Workflow Structure + +**Each arrow (→) = one step file. Each step file contains:** +- STEP GOAL +- MANDATORY EXECUTION RULES +- EXECUTION PROTOCOLS +- MANDATORY SEQUENCE (numbered sub-steps) +- Menu options +- Success/failure metrics + +**Simple workflow:** 3-4 step files. **Complex workflow:** 10+ step files. + +--- + +## Example 1: Personalized Meal Plan Generator + +**Domain:** Health & Fitness + +| Aspect | Details | +|--------|---------| +| **Flow** | Discovery → Assessment → Strategy → Shopping List → Prep Schedule | +| **Step Files** | ~5: step-01-discovery, step-02-assessment, step-03-strategy, step-04-shopping, step-05-prep | +| **Output** | Direct-to-final document, each step appends section | +| **Intent/Prescriptive** | Intent-based - Facilitates discovery | +| **Planning** | No - builds directly | +| **Continuable** | Yes - 200+ tokens possible | +| **Structure** | Linear, 5 steps | +| **Conversation** | Open-ended, progressive questioning (1-2 at a time) | + +--- + +## Example 2: Year-End Tax Organizer + +**Domain:** Finance + +| Aspect | Details | +|--------|---------| +| **Flow** | Input Discovery → Document Categorization → Missing Document Alert → Final Summary | +| **Step Files** | 4: step-01-input-discovery, step-02-categorize, step-03-missing-alerts, step-04-summary | +| **Output** | Analysis-only + checklist | +| **Intent/Prescriptive** | Highly Prescriptive - Tax compliance, exact categories | +| **Planning** | N/A | +| **Continuable** | No - single-session | +| **Structure** | Linear, 4 steps | +| **Conversation** | Focused - specific questions, document what provided | + +--- + +## Example 3: Employee Termination Checklist + +**Domain:** Legal / HR / Compliance + +| Aspect | Details | +|--------|---------| +| **Flow** | Context → Regulatory Check → Document Requirements → Notification Timeline → Final Checklist | +| **Step Files** | 5: step-01-context, step-02-regulatory, step-03-documents, step-04-timeline, step-05-checklist | +| **Output** | Direct-to-final compliance checklist | +| **Intent/Prescriptive** | Highly Prescriptive - Legal compliance, state-specific | +| **Planning** | No | +| **Continuable** | No - single-session | +| **Structure** | Branching within steps by: reason, location, employee count | +| **Conversation** | Focused - classification questions, present requirements | + +--- + +## Example 4: Tabletop RPG Campaign Builder + +**Domain:** Entertainment / Games + +| Aspect | Details | +|--------|---------| +| **Flow** | Session Concept → NPC Creation → Scene Setup → Key Beats → Generate → [Repeat per session] | +| **Step Files** | 4 core files reused each session: step-01-concept, step-02-npc, step-03-scene, step-04-beats, step-05-generate | +| **Output** | Per-session document, maintains campaign continuity | +| **Intent/Prescriptive** | Intent-based - Creative facilitation | +| **Planning** | No - builds directly | +| **Continuable** | Yes - months-long campaigns | +| **Structure** | Repeating loop - same steps, new content | +| **Conversation** | Open-ended creative facilitation, "What if..." prompts | + +--- + +## Example 5: Course Syllabus Creator + +**Domain:** Education + +| Aspect | Details | +|--------|---------| +| **Flow** | Course Type → Learning Objectives → Module Breakdown → Assessment → [Branch: academic] → Accreditation → [Branch: vocational] → Certification → Final | +| **Output** | Direct-to-final syllabus | +| **Intent/Prescriptive** | Balanced - Framework prescriptive, content flexible | +| **Planning** | No | +| **Continuable** | Yes - complex syllabi | +| **Structure** | Branching by course type | +| **Conversation** | Mixed - framework (prescriptive) + content discovery (intent) | + +--- + +## Example 6: SOP Writer + +**Domain:** Business Process + +| Aspect | Details | +|--------|---------| +| **Flow** | Process Selection → Scope Definition → Documentation → Review → [Generate] → "Create another?" → If yes, repeat | +| **Output** | Independent SOPs stored in `{sop_folder}/` | +| **Intent/Prescriptive** | Prescriptive - SOPs must be exact | +| **Planning** | No - direct generation | +| **Continuable** | No - single SOP per run, repeatable workflow | +| **Structure** | Repeating - multiple SOPs per session | +| **Conversation** | Focused on process details - "Walk me through step 1" | + +--- + +## Example 7: Novel Outliner + +**Domain:** Creative Writing + +| Aspect | Details | +|--------|---------| +| **Flow** | Structure Selection → Character Arcs → Beat Breakdown → Pacing Review → Final Polish | +| **Output** | Free-form with Final Polish for coherence | +| **Intent/Prescriptive** | Intent-based - "What does your character want?" | +| **Planning** | No - builds directly | +| **Continuable** | Yes - weeks-long sessions | +| **Structure** | Branching by structure choice | +| **Conversation** | Open-ended creative coaching, provocations | + +--- + +## Example 8: Wedding Itinerary Coordinator + +**Domain:** Event Planning + +| Aspect | Details | +|--------|---------| +| **Flow** | Venue Type → Vendor Coordination → Timeline → Guest Experience → [Branch: hybrid] → Virtual Setup → Day-of Schedule | +| **Output** | Direct-to-final itinerary | +| **Intent/Prescriptive** | Intent-based - Facilitates vision | +| **Planning** | No | +| **Continuable** | Yes - months-long planning | +| **Structure** | Branching by venue type | +| **Conversation** | Open-ended discovery of preferences, budget, constraints | + +--- + +## Example 9: Annual Life Review + +**Domain:** Personal Development + +| Aspect | Details | +|--------|---------| +| **Flow** | Input Discovery (prior goals) → Life Areas Assessment → Reflections → Goal Setting → Action Planning → Final Polish | +| **Output** | Free-form with Final Polish, discovers prior review first | +| **Intent/Prescriptive** | Intent-based - Coaching questions | +| **Planning** | No - direct to life plan | +| **Continuable** | Yes - deep reflection | +| **Structure** | Linear with Input Discovery | +| **Conversation** | Open-ended coaching, progressive questioning | + +--- + +## Example 10: Room Renovation Planner + +**Domain:** Home Improvement + +| Aspect | Details | +|--------|---------| +| **Flow** | Room Type → Budget Assessment → Phase Planning → Materials → Contractor Timeline → [Branch: DIY] → Instructions | +| **Output** | Direct-to-final renovation plan | +| **Intent/Prescriptive** | Balanced - Code compliance prescriptive, design intent-based | +| **Planning** | No | +| **Continuable** | Yes - complex planning | +| **Structure** | Branching by room type and DIY vs pro | +| **Conversation** | Mixed - budget questions + vision discovery | + +--- + +## Pattern Analysis + +### Structure Types + +| Type | Count | Examples | +|------|-------|----------| +| Linear | 5 | Meal Plan, Tax, Termination, Life Review, Renovation | +| Branching | 5 | Termination, Syllabus, Novel, Wedding, Renovation | +| Repeating Loop | 2 | RPG Campaign, SOP Writer | + +### Intent Spectrum + +| Type | Count | Examples | +|------|-------|----------| +| Intent-based | 7 | Meal Plan, RPG, Syllabus (partial), Novel, Wedding, Life Review, Renovation (partial) | +| Prescriptive | 3 | Tax, Termination, SOP | +| Balanced | 2 | Syllabus, Renovation | + +### Continuable vs Single-Session + +| Type | Count | Examples | +|------|-------|----------| +| Continuable | 7 | Meal Plan, RPG, Syllabus, Novel, Wedding, Life Review, Renovation | +| Single-Session | 3 | Tax, Termination, SOP | + +### Output Patterns + +| Type | Count | Examples | +|------|-------|----------| +| Direct-to-Final | 9 | All except Tax | +| Analysis Only | 1 | Tax | +| With Final Polish | 2 | Novel, Life Review | +| Repeating Output | 2 | RPG (sessions), SOP (multiple) | + +--- + +## Design Questions + +1. **Domain:** Problem space? +2. **Output:** What is produced? (Document, checklist, analysis, physical?) +3. **Intent:** Prescriptive (compliance) or intent-based (creative)? +4. **Planning:** Plan-then-build or direct-to-final? +5. **Continuable:** Multiple sessions or high token count? +6. **Structure:** Linear, branching, or repeating loop? +7. **Inputs:** Requires prior workflow documents or external sources? +8. **Chaining:** Part of module sequence? What comes before/after? +9. **Polish:** Final output need optimization for flow/coherence? +10. **Conversation:** Focused questions or open-ended facilitation? diff --git a/_bmad/bmb/workflows/workflow/data/workflow-type-criteria.md b/_bmad/bmb/workflows/workflow/data/workflow-type-criteria.md new file mode 100644 index 0000000..1ded1da --- /dev/null +++ b/_bmad/bmb/workflows/workflow/data/workflow-type-criteria.md @@ -0,0 +1,134 @@ +# Workflow Type Criteria + +## Key Decisions + +1. **Module affiliation** - Standalone or part of a module? +2. **Continuable** - Can it span multiple sessions? +3. **Edit/Validate support** - Will it have edit and validate flows? +4. **Document output** - Does it produce a document? + +## 1. Module Affiliation + +### Standalone Workflow +- NOT part of any module +- Stored in user's custom location +- Only standard variables available + +### Module-Based Workflow +- Part of a specific module (e.g., BMB) +- Has access to module-specific variables +- Stored in module's workflows directory + +**BMB additional variable:** `{bmb_creations_output_folder}` + +## 2. Continuable or Single-Session? + +### Continuable (Multi-Session) +**Use when:** Workflow might consume MASSIVE tokens, complex, many steps + +**Required:** +- `step-01-init.md` with continuation detection +- `step-01b-continue.md` for resuming +- `stepsCompleted` tracking in output frontmatter + +**Frontmatter:** +```yaml +stepsCompleted: ['step-01-init', 'step-02-gather'] +lastStep: 'step-02-gather' +lastContinued: '2025-01-02' +``` + +**Rule:** Each step appends its NAME to `stepsCompleted` + +### Single-Session +**Use when:** Simple, quick (<15 min), token-efficient + +**Required:** +- Standard `step-01-init.md` (no continuation logic) +- No `stepsCompleted` tracking needed + +## 3. Edit/Validate Support + +### Create-Only +``` +workflow-folder/ +├── workflow.md +├── data/ +└── steps-c/ + ├── step-01-init.md + └── step-N-final.md +``` + +**Use when:** Simple workflows, experimental, one-off + +### Create + Edit + Validate (Tri-Modal) +``` +workflow-folder/ +├── workflow.md +├── data/ # SHARED +├── steps-c/ # Create +├── steps-e/ # Edit +└── steps-v/ # Validate +``` + +**Key:** +- Each mode is SELF-CONTAINED +- NO shared step files between modes +- DATA folder is SHARED (prevents drift) +- Duplicative steps OK (better than confusion) + +**Use when:** Complex workflows that will be maintained + +## 4. Document Output + +### Document-Producing +- Creates persistent output file +- Uses templates for structure +- Each step contributes to document +- Consider final polish step + +### Non-Document +- Performs actions without persistent output +- May produce temporary files +- Focus on execution, not creation + +## Decision Tree + +``` +START: Creating a workflow +│ +├─ Part of a module? +│ ├─ YES → Module-based (include module variables) +│ └─ NO → Standalone (standard variables only) +│ +├─ Could this take multiple sessions / lots of tokens? +│ ├─ YES → Continuable (add step-01b-continue.md) +│ └─ NO → Single-session (simpler init) +│ +└─ Will users need to edit/validate this workflow? + ├─ YES → Tri-modal (steps-c/, steps-e/, steps-v/) + └─ NO → Create-only (steps-c/ only) +``` + +## Output Format Decision + +| Workflow Type | Init Template | Output Format | +| ----------------------- | ------------------------ | ------------- | +| Continuable + Document | step-01-init-continuable | Free-form | +| Single-Session + Document| Standard init | Free-form | +| Continuable + No Doc | step-01-init-continuable | N/A | +| Single-Session + No Doc | Standard init | N/A | + +**Free-form template** (recommended): +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- + +# {{document_title}} + +[Content appended progressively] +``` diff --git a/_bmad/bmb/workflows/workflow/steps-c/step-00-conversion.md b/_bmad/bmb/workflows/workflow/steps-c/step-00-conversion.md new file mode 100644 index 0000000..a9e2e00 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-01-discovery.md b/_bmad/bmb/workflows/workflow/steps-c/step-01-discovery.md new file mode 100644 index 0000000..a2e3577 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-01b-continuation.md b/_bmad/bmb/workflows/workflow/steps-c/step-01b-continuation.md new file mode 100644 index 0000000..f3280db --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-c/step-01b-continuation.md @@ -0,0 +1,3 @@ +# TODO - THIS IS A PLACE HOLDER NOT IMPLEMENTED YET IN THIS FLOW + +YOU CAN CALL OUT AS A WARNING IN ANY VALIDATION CHECKS of this specific workflow - but this is a known pending todo to implement. diff --git a/_bmad/bmb/workflows/workflow/steps-c/step-02-classification.md b/_bmad/bmb/workflows/workflow/steps-c/step-02-classification.md new file mode 100644 index 0000000..131afbb --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-03-requirements.md b/_bmad/bmb/workflows/workflow/steps-c/step-03-requirements.md new file mode 100644 index 0000000..32c2674 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-04-tools.md b/_bmad/bmb/workflows/workflow/steps-c/step-04-tools.md new file mode 100644 index 0000000..2ffb3a2 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-05-plan-review.md b/_bmad/bmb/workflows/workflow/steps-c/step-05-plan-review.md new file mode 100644 index 0000000..f0ff662 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/create-workflow/steps/step-06-design.md b/_bmad/bmb/workflows/workflow/steps-c/step-06-design.md similarity index 63% rename from _bmad/bmb/workflows/create-workflow/steps/step-06-design.md rename to _bmad/bmb/workflows/workflow/steps-c/step-06-design.md index f4031ca..90e1baa 100644 --- a/_bmad/bmb/workflows/create-workflow/steps/step-06-design.md +++ b/_bmad/bmb/workflows/workflow/steps-c/step-06-design.md @@ -2,22 +2,20 @@ 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' +subprocessPatterns: '../data/subprocess-optimization-patterns.md' --- # Step 6: Workflow Structure Design @@ -55,7 +53,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 +67,36 @@ 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 will load these data standards as needed (ideally within subprocesses that can return the relevant insights during the design step): -- `{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.md](../workflow.md) for reference of a perfect workflow.md with some complex options (not all workflows will offer multiple next step options like this one - most will just auto route right to a step 1 file) + +## 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? @@ -173,6 +175,47 @@ Design quality assurance: - How can users recover from errors? - What constitutes successful completion? +### 6a. Subprocess Optimization Design + +Load {subprocessPatterns} to understand subprocess optimization patterns that can save context and improve performance during workflow execution. + +Ask the user: + +"**Should we design this workflow to leverage subprocess optimization patterns?** Consider: + +- **Pattern 1 (Grep/Regex):** Will any step search across many files or documents for patterns? +- **Pattern 2 (Deep Analysis):** Will any step analyze multiple files for prose, logic, quality, or flow? +- **Pattern 3 (Data Operations):** Will any step load large reference data, knowledge bases, or datasets? +- **Pattern 4 (Parallel Execution):** Can any validation or analysis checks run in parallel instead of sequentially? + +If **YES** to any of these, we should design those steps with subprocess optimization in mind." + +**If subprocess optimization is applicable:** + +For each step that could benefit from subprocesses: +- Identify which pattern(s) apply (Pattern 1, 2, 3, or 4) +- Design what the subprocess should return (findings only, not full content) +- Plan graceful fallback for LLMs without subprocess capability +- Document optimization strategy in the build plan + +**Example subprocess integration:** + +```markdown +### Step-Specific Rules: +- 🎯 Analyze X files for Y - use subprocess per file (Pattern 2) +- 💬 Subprocess returns structured findings, not full content +- ⚙️ If subprocess unavailable: Perform analysis in main thread +``` + +**Document in the plan:** + +For each step identified for subprocess optimization, record: +- Step number and name +- Pattern type(s) to apply +- What the subprocess will analyze +- Expected return structure +- Fallback approach + ### 7. Special Features Design Identify unique requirements: @@ -182,6 +225,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/_bmad/bmb/workflows/workflow/steps-c/step-07-foundation.md b/_bmad/bmb/workflows/workflow/steps-c/step-07-foundation.md new file mode 100644 index 0000000..c6b107d --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-08-build-step-01.md b/_bmad/bmb/workflows/workflow/steps-c/step-08-build-step-01.md new file mode 100644 index 0000000..17f5914 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-c/step-08-build-step-01.md @@ -0,0 +1,377 @@ +--- +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' +subprocessPatterns: '../data/subprocess-optimization-patterns.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.** + +### 5a. Apply Subprocess Optimization (If Designed) + +**Check the approved design from step 6:** Was subprocess optimization identified for step-01? + +**If YES, apply the appropriate pattern(s):** + +Load {subprocessPatterns} and implement the subprocess optimization: + +1. **Identify the pattern(s) from the design:** + - Pattern 1: Single subprocess for grep/regex across many files + - Pattern 2: Per-file subprocess for deep analysis + - Pattern 3: Subprocess for data file operations + - Pattern 4: Parallel execution of independent operations + +2. **Add subprocess-specific Step-Specific Rules:** + ```markdown + ### Step-Specific Rules: + - 🎯 [Brief description of which pattern applies] + - 💬 Subprocess must either update report OR return findings to parent + - 🚫 DO NOT BE LAZY - [specific guidance if Pattern 2] + - ⚙️ TOOL/SUBPROCESS FALLBACK: If subprocess unavailable, perform in main thread + ``` + +3. **Implement subprocess directives in the MANDATORY SEQUENCE:** + - Use appropriate subprocess language: + - Pattern 1: "Launch a subprocess that runs [command] across all files, returns [results]" + - Pattern 2: "DO NOT BE LAZY - For EACH file, launch a subprocess that [analyzes], returns [findings]" + - Pattern 3: "Launch a subprocess that loads [data file], performs [operation], returns [results]" + - Pattern 4: "Launch subprocesses in parallel that [operations], aggregate results" + +4. **Ensure return patterns are specified:** + - Subprocess updates report directly OR + - Subprocess returns structured findings to parent for aggregation + +5. **Verify graceful fallback is documented:** + - Universal fallback rule in Universal Rules + - Step-specific fallback in Step-Specific Rules + - Clear instructions for LLMs without subprocess capability + +**If NO subprocess optimization was designed for step-01:** + +Skip this section and proceed to document build in plan. + +### 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/_bmad/bmb/workflows/workflow/steps-c/step-09-build-next-step.md b/_bmad/bmb/workflows/workflow/steps-c/step-09-build-next-step.md new file mode 100644 index 0000000..54b7a96 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-c/step-09-build-next-step.md @@ -0,0 +1,350 @@ +--- +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' +subprocessPatterns: '../data/subprocess-optimization-patterns.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. + +### 2a. Apply Subprocess Optimization (If Designed for This Step) + +**Check the approved design from step 6:** Was subprocess optimization identified for this step? + +**If YES, apply the appropriate pattern(s):** + +Load {subprocessPatterns} and implement the subprocess optimization for this step: + +1. **Identify the pattern(s) from the design for this step:** + - Pattern 1: Single subprocess for grep/regex across many files + - Pattern 2: Per-file subprocess for deep analysis + - Pattern 3: Subprocess for data file operations + - Pattern 4: Parallel execution of independent operations + +2. **Add subprocess-specific Step-Specific Rules to this step:** + ```markdown + ### Step-Specific Rules: + - 🎯 [Brief description of which pattern applies] + - 💬 Subprocess must either update report OR return findings to parent + - 🚫 DO NOT BE LAZY - [specific guidance if Pattern 2] + - ⚙️ TOOL/SUBPROCESS FALLBACK: If subprocess unavailable, perform in main thread + ``` + +3. **Implement subprocess directives in the MANDATORY SEQUENCE:** + - Use appropriate subprocess language: + - Pattern 1: "Launch a subprocess that runs [command] across all files, returns [results]" + - Pattern 2: "DO NOT BE LAZY - For EACH file, launch a subprocess that [analyzes], returns [findings]" + - Pattern 3: "Launch a subprocess that loads [data file], performs [operation], returns [results]" + - Pattern 4: "Launch subprocesses in parallel that [operations], aggregate results" + +4. **Ensure return patterns are specified:** + - Subprocess updates report directly OR + - Subprocess returns structured findings to parent for aggregation + +5. **Verify graceful fallback is documented:** + - Universal fallback rule in Universal Rules + - Step-specific fallback in Step-Specific Rules + - Clear instructions for LLMs without subprocess capability + +**If NO subprocess optimization was designed for this step:** + +Skip this section and proceed to build the step file. + +### 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/_bmad/bmb/workflows/workflow/steps-c/step-10-confirmation.md b/_bmad/bmb/workflows/workflow/steps-c/step-10-confirmation.md new file mode 100644 index 0000000..c7534cb --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-c/step-11-completion.md b/_bmad/bmb/workflows/workflow/steps-c/step-11-completion.md new file mode 100644 index 0000000..efa9fdf --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md new file mode 100644 index 0000000..295b7fa --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md new file mode 100644 index 0000000..d54a9a5 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md new file mode 100644 index 0000000..7d4da1c --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md new file mode 100644 index 0000000..96f8d71 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md new file mode 100644 index 0000000..00b55fb --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md new file mode 100644 index 0000000..b3912f0 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-e/step-e-07-complete.md b/_bmad/bmb/workflows/workflow/steps-e/step-e-07-complete.md new file mode 100644 index 0000000..56ad055 --- /dev/null +++ b/_bmad/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/_bmad/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md b/_bmad/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md new file mode 100644 index 0000000..3662490 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md @@ -0,0 +1,109 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +parallel-steps: ['./step-01b-structure.md', './step-02-frontmatter-validation.md', './step-02b-path-violations.md', './step-03-menu-validation.md' './step-04-step-type-validation.md', './step-05-output-format-validation.md', './step-06-validation-design-check.md', './step-07-instruction-style-check.md', './step-08-collaborative-experience-check.md', './step-08b-subprocess-optimization.md', './step-09-cohesive-review.md'] +nextStep: './step-10-report-complete.md' +targetWorkflowPath: '{workflow_folder_path}' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +partialValidationFragmentFile: '{workflow_folder_path}/validation-report-{step-name}.md' +stepFileRules: '../data/step-file-rules.md' +--- + +# Validation Step 1: File Structure & Size + +## STEP GOAL: + +To create the validation report that all parallel tasks that this will kick off will be able to report to. + +## 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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure using subprocess optimization when available +- 🚫 DO NOT skip checking any file - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow using subprocess optimization when available - single subprocess for bash/grep operations, separate subprocess per file for size analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. IF there is no subprocess type tool available that can achieve running a process in a subprocess and handle starting multiple - let the user know they need to restart validation specifically NOT using max-parallel mode and HALT and end this workflow! + +### 1. Create Validation Report + +Create {validationReportFile} with header structure: + +```markdown +--- +validationDate: [current date] +workflowName: {new_workflow_name} +workflowPath: {workflow_folder_path} +validationStatus: IN_PROGRESS +--- + +# Validation Report: {new_workflow_name} + +**Validation Started:** [current date] +**Validator:** BMAD Workflow Validation System +**Standards Version:** BMAD Workflow Standards + +{{TOC}} + +{{#each parallel-steps}} +## {{title}} + +{{results}} + +{{/each}} + +``` + +Save the file (without the handlebars output of course) before proceeding. + +### 2. Launch Mass Parallelization and consolidate results! + +Utilizing a subprocess for each step file in {parallel-steps} - complete all of these - with the caveat indication to the subprocess that at the end of the specific step it will not on its own proceed to the nextStep file! + +Critically - instruct that instructions to write out or return results within each subprocess for a step file in the array MUST ensure that it writes it to {partialValidationFragmentFile} file name even though the step file it loads might indicate otherwise! + +Once every process has completed - there should be a separate validation file for each given step. Also - each step should return JUST its results and recommendations to you also. + +### 3. CRITICAL WRITES to the report. + +You MUST now ensure that all results are added to the final cohesive {validationReportFile} following the indicated handlebars sequence - and then after appending each subprocess report to a level 2 section - and the TOC to accurately reflect the documents state using proper markdown linking conventions to the actual heading names you created. + +IF a file is missing or empty from a given subprocess - but it did return to you results - you will append those results - ONLY do this if you cannot access the specific steps file produced or it is empty though. IE File from subprocess is primary, results returned from step complete are backup insurance. + +### 4. Proceed to Completion Step + +ONLY after ensuring all has been written to the final report, let the user know about the final report that is a consolidation - and they can ignore or remove the smaller files or use them as they like to focus on a specific validation (but its all in the master doc), and then proceed to {nextStep}, ensuring that in the {nextStep} it is focused on the {validationReportFile} + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report created with header structure +- EVERY section of the template is filled in with content from a subprocess that added the results of its area of expertise + +### ❌ SYSTEM FAILURE: + +- Output Report does not exist with content all filled in +- EVERY step listed in {parallel-steps} was not executed in a subprocess and completed with its results captured in output diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md b/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md new file mode 100644 index 0000000..2732591 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md @@ -0,0 +1,221 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +nextStepFile: './step-02-frontmatter-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure using subprocess optimization when available +- 🚫 DO NOT skip checking any file - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow using subprocess optimization when available - single subprocess for bash/grep operations, separate subprocess per file for size analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## 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: {workflow_folder_path} +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...* + +## Critical Path Violations +*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...* + +## Subprocess Optimization Opportunities +*Pending...* + +## Cohesive Review +*Pending...* + +## Plan Quality Validation +*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 + +**Launch a single subprocess that:** + +1. Lists the entire folder structure using bash commands +2. Verifies all required folders and files exist +3. Returns structured findings to parent for aggregation + +```bash +# List folder structure +find {targetWorkflowPath} -type f -name "*.md" | sort +``` + +**Expected structure:** +``` +{targetWorkflowPath}/ +├── workflow.md +├── steps*/ potentially more than one folder like this (such as steps-v, steps-c - the folder name is not critical but should make sense) +│ ├── step-01-init.md +│ ├── step-01b-continue.md (if continuable) +│ ├── step-02-*.md +│ └── ... +├── */ # any other random files - critical will be later ensure its all used - aside from potential documentation for user later. +├── data/ +│ └── [as needed] +└── templates/ + └── [as needed] +``` + +**Check:** +- ✅ workflow.md exists +- ✅ step files are in a well organized folder +- ✅ non step reference files are organized in other folders such as data, templates, or others that make sense for the workflow +- ✅ Folder names make sense + +### 4. Check File Sizes + +**DO NOT BE LAZY - For EACH step file in steps-c/, launch a subprocess that:** + +1. Loads that step file +2. Counts lines and checks against size limits +3. Returns structured findings to parent for aggregation + +**Limits:** +- < 200 lines: ✅ Good +- 200-250 lines: ⚠️ Approaching limit +- > 250 lines: ❌ Exceeds limit + +**Subprocess returns:** File name, line count, status (Good/Approaching limit/Exceeds limit), and any issues found. + +**Subprocess must either:** +- Update validation report directly with findings, OR +- Return structured findings to parent for aggregation into report + +**Document findings in validation report:** +- List all step files checked with their line counts +- Note any files approaching or exceeding size limits (<200 recommended, 250 max) +- Check data and reference files for size issues (large files should be sharded or indexed) +- Identify specific size violations and recommendations + +### 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: + +**Document the following:** +- Folder structure assessment +- Required files presence check +- File size analysis results +- List of any issues found (missing files, extra files, size violations, naming issues) +- Overall validation 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/_bmad/bmb/workflows/workflow/steps-v/step-01b-structure.md b/_bmad/bmb/workflows/workflow/steps-v/step-01b-structure.md new file mode 100644 index 0000000..927f03f --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-01b-structure.md @@ -0,0 +1,152 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +nextStepFile: './step-02-frontmatter-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure using subprocess optimization when available +- 🚫 DO NOT skip checking any file - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow using subprocess optimization when available - single subprocess for bash/grep operations, separate subprocess per file for size analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Check Folder Structure + +**Launch a single subprocess that will do all of the following for items:** + +1. Load {stepFileRules} to understand: +- File size limits (<200 recommended, 250 max) +- Required folder structure +- Required files +2. Lists the entire folder structure using bash commands +3. Verifies all required folders and files exist +4. Returns structured findings to parent for aggregation + +```bash +# List folder structure +find {targetWorkflowPath} -type f -name "*.md" | sort +``` + +**Expected structure:** +``` +{targetWorkflowPath}/ +├── workflow.md +├── steps*/ potentially more than one folder like this (such as steps-v, steps-c - the folder name is not critical but should make sense) +│ ├── step-01-init.md +│ ├── step-01b-continue.md (if continuable) +│ ├── step-02-*.md +│ └── ... +├── */ # any other random files - critical will be later ensure its all used - aside from potential documentation for user later. +├── data/ +│ └── [as needed] +└── templates/ + └── [as needed] +``` + +**Check:** +- ✅ workflow.md exists +- ✅ step files are in a well organized folder +- ✅ non step reference files are organized in other folders such as data, templates, or others that make sense for the workflow +- ✅ Folder names make sense + +### 4. Check File Sizes + +**DO NOT BE LAZY - For EACH step file in steps-c/, launch a subprocess that:** + +1. Loads that step file +2. Counts lines and checks against size limits +3. Returns structured findings to parent for aggregation + +**Limits:** +- < 200 lines: ✅ Good +- 200-300 lines: ⚠️ Approaching limit +- > 300 lines: ❌ Exceeds limit + +**Subprocess returns:** File name, line count, status (Good/Approaching limit/Exceeds limit), and any issues found. + +**Subprocess must either:** +- Update validation report directly with findings, OR +- Return structured findings to parent for aggregation into report + +**Document findings in validation report:** +- List all step files checked with their line counts +- Note any files approaching or exceeding size limits (<200 recommended, 250 max) +- Check data and reference files for size issues (large files should be sharded or indexed) +- Identify specific size violations and recommendations + +### 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. Document all findings in a report + +**Document the following:** +- Folder structure assessment +- Required files presence check +- File size analysis results +- List of any issues found (missing files, extra files, size violations, naming issues) +- Overall validation status (PASS/FAIL/WARNINGS) + +### 7. Save Report + +**CRITICAL:** Save the validation report BEFORE COMPLETING THIS STEP + +**Display:** "**File Structure & Size validation complete.**" + +--- + +## 🚨 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/_bmad/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md b/_bmad/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md new file mode 100644 index 0000000..09dde53 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md @@ -0,0 +1,199 @@ +--- +name: 'step-02-frontmatter-validation' +description: 'Validate frontmatter compliance across all step files' + +nextStepFile: './step-02b-path-violations.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.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 relative paths, NO unused variables. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - VALIDATE EVERY FILE'S FRONTMATTER +- 📖 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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread + +### Step-Specific Rules: + +- 🎯 Validate EVERY step file's frontmatter using subprocess optimization - each file in its own subprocess +- 🚫 DO NOT skip any files or checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough using per-file deep analysis (Pattern 2) + +## EXECUTION PROTOCOLS: + +- 🎯 Load frontmatter standards first, then validate each file in its own subprocess for deep analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Aggregate all findings into validation report before loading next step +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in the workflow must be validated +- Load {frontmatterStandards} for validation criteria +- Check for: unused variables, non-relative paths, missing required fields, forbidden patterns + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Frontmatter Standards + +Load {frontmatterStandards} to understand validation criteria. + +**Key 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 - NO `workflow_path` allowed + +**Forbidden Patterns:** +- `workflow_path: '...'` - use relative paths instead +- `thisStepFile: '...'` - remove unless actually referenced in body +- `workflowFile: '...'` - remove unless actually referenced in body +- `./...` - use `./step-XX.md` +- `{workflow_path}/templates/...` - use `../template.md` + +### 2. Validate EVERY Step File - Systematic Algorithm with Subprocess Optimization + +**DO NOT BE LAZY - For EACH step file, launch a subprocess that:** + +1. Loads that file +2. Loads {frontmatterStandards} to understand validation criteria +3. Performs all frontmatter validation checks on that file (extract variables, check usage, validate paths) +4. **EITHER** updates the validation report directly with its findings +5. **OR** returns structured findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN:** + +For each file, the subprocess performs the following deep analysis: + +#### Step 2.1: Extract Frontmatter Variables + +```python +# Algorithm to extract variables from frontmatter: +1. Find content between first `---` and second `---` +2. For each line, extract key before `:` +3. Skip `name`, `description`, and comment lines starting with `#` +4. Collect all variable names +``` + +Example frontmatter: +```yaml +--- +# File References +nextStepFile: './step-02-vision.md' +outputFile: '{planning_artifacts}/product-brief-{{project_name}}.md' +workflow_path: '{project-root}/...' # ❌ FORBIDDEN +thisStepFile: './step-01-init.md' # ❌ Likely unused +--- +``` + +Variables extracted: `nextStepFile`, `outputFile`, `workflow_path`, `thisStepFile` + +#### Step 2.2: Check Each Variable Is Used + +```python +# Algorithm to check variable usage: +for each variable in extracted_variables: + search_body = "{variableName}" # with curly braces + if search_body NOT found in step body (after frontmatter): + MARK_AS_UNUSED(variable) +``` + +**Example:** +- Variable `nextStepFile`: Search body for `{nextStepFile}` → Found in line 166 ✅ +- Variable `thisStepFile`: Search body for `{thisStepFile}` → Not found ❌ VIOLATION + +#### Step 2.3: Check Path Formats + +For each variable containing a file path: + +```python +# Algorithm to validate paths: +if path contains "{workflow_path}": + MARK_AS_VIOLATION("workflow_path is forbidden - use relative paths") + +if path is to another step file: + if not path.startswith("./step-"): + MARK_AS_VIOLATION("Step-to-step paths must be ./filename.md") + +if path is to parent folder template: + if not path.startswith("../"): + MARK_AS_VIOLATION("Parent folder paths must be ../filename.md") + +if path contains "{project-root}" and is internal workflow reference: + MARK_AS_VIOLATION("Internal paths must be relative, not project-root") +``` + +**RETURN FORMAT:** + +Subprocess returns file name, frontmatter compliance status, unused variables found, path violations, and overall status (PASS/FAIL). Include specific variable names and violation details for documentation. + +Check ALL files systematically. Return findings for compilation and appendage to validation report. + +### 3. Aggregate Findings and Document Results + +Document frontmatter validation results in the validation report showing: +- Which files were checked +- Frontmatter compliance status for each file +- Unused variables found in each file +- Path violations detected +- Overall pass/fail status for each file + +### 4. List All Violations + +Document all violations found in the validation report, including: +- Specific files with violations +- Unused variable names and why they're unused +- Forbidden patterns detected with explanation +- Path format violations with details +- Files that passed all checks + +### 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 validated using subprocess optimization (Pattern 2: per-file deep analysis) +- Each subprocess validates frontmatter, checks variable usage, validates paths +- Structured findings returned to parent OR report updated directly by subprocesses +- All violations documented with specific variable names +- Findings aggregated into validation report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not validating every file using subprocess optimization +- Not systematically checking each variable for usage in subprocess +- Missing forbidden pattern detection +- Not documenting violations with specific details +- Not returning structured findings OR updating report from subprocess +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough using subprocess optimization. DO NOT BE LAZY. For EACH file, launch a subprocess that validates frontmatter, checks variable usage, validates paths, and returns findings. Auto-proceed through all validation steps. diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-02b-path-violations.md b/_bmad/bmb/workflows/workflow/steps-v/step-02b-path-violations.md new file mode 100644 index 0000000..cfb442c --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-02b-path-violations.md @@ -0,0 +1,265 @@ +--- +name: 'step-02b-path-violations' +description: 'CRITICAL: Catch path violations step-02 misses - hardcoded paths, dead links, module awareness' + +nextStepFile: './step-03-menu-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +--- + +# Validation Step 2b: Critical Path Violations + +## STEP GOAL: + +CRITICAL path checks that step-02's frontmatter validation MISSES. This catches violations in CONTENT (not frontmatter), dead links, and module path unawareness using grep/bash (ideally in a subprocess that can update the report or return all results to parent). + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - CHECK EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction in this file references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the instructed outcome in your main context thread and available toolset + +### Step-Specific Rules: + +- 🎯 Perform systematic bash/grep checks using subprocess optimization - single subprocess for grep/regex across many files +- 🚫 DO NOT skip any file or violation type - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This catches what step-02 misses - CONTENT violations, dead links, module awareness, links in code and not in front matter + +## EXECUTION PROTOCOLS: + +- 🎯 Perform systematic checks using subprocess optimization when available - single subprocess for grep/regex across many files, separate subprocess per file for deep analysis, subprocess for data file operations +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before continuing to {nextStepFile} + +## CONTEXT BOUNDARIES: + +- Step-02 validated frontmatter (variables, relative paths) +- This step validates CONTENT and file existence with a Focus on: hardcoded paths in body, dead links, module awareness in every file found under {targetWorkflowPath} +- **CRITICAL:** Output files the workflow itself being validated produces won't exist during validation - a contract document creation workflow might have a reference to said output - but it of course will not yet exist during workflow validation + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Perform Critical Path Violation Detection + +**Perform systematic path violation checks on EVERY workflow file using subprocess optimization when available - each file in its own subprocess:** + +**SUBPROCESS EXECUTION PATTERN:** + +For EACH file in the workflow being validated, launch a subprocess that: +1. Loads any reference files it needs (to avoid bloating parent context) +2. Performs all required checks on that file +3. **EITHER** updates the validation report directly with its findings +4. **OR** returns structured findings to parent for aggregation + +**DO NOT BE LAZY - Use appropriate subprocess pattern for each check:** +- **Single subprocess for grep/regex**: Run one command across many files, return matches +- **Separate subprocess per file**: When deep analysis of each file's content is required +- **Subprocess for data operations**: Load reference data, find matches, summarize key findings + +**PHASE 1: Identify Config Variables (EXCEPTIONS to path checks):** + +Read {targetWorkflowPath}/workflow.md to extract known config variables from the Configuration Loading section: + +```bash +# Extract config variables from workflow.md +grep -A 20 "Configuration Loading" {targetWorkflowPath}/workflow.md | grep -E "^\s+-\s+`\{[^}]+\}`" | sed "s/.*//;s/[`']//g" +``` + +**Store these as KNOWN_CONFIG_VARIABLES for reference in later checks.** + +These are EXCEPTIONS - paths using these variables are VALID even if not relative: +- Example: `{output_folder}/doc.md` - VALID (uses config variable) +- Example: `{planning_artifacts}/prd.md` - VALID (uses config variable) +- These paths won't exist during validation (workflow not running yet) + +--- + +**PHASE 2: Hardcoded paths in CONTENT (CRITICAL):** + +Step-02 checks frontmatter - this checks CONTENT (body text after frontmatter). + +**Launch a single subprocess that:** + +1. Runs grep across all step files to find hardcoded {project-root}/ paths in content +2. Extracts content after frontmatter from each file +3. Returns all findings to parent for aggregation + +```bash +# Extract content after frontmatter from all files, search for {project-root}/ +for file in steps-c/*.md; do + awk '/^---$/,0 {if (p) print; p=1} /^---$/{p=1}' "$file" | grep -n "{project-root}/" && echo "Found in: $file" +done +``` + +**What we're catching:** +- Content like: `Load {project-root}/_bmad/foo/workflows/.../file.csv` +- Should be: `Load {dataFile}` (frontmatter variable with a relative path like ../data/file.csv) + +**SKIP:** Paths using KNOWN_CONFIG_VARIABLES (these are valid exceptions) + +--- + +**PHASE 3: Dead or bad links - referenced files don't exist (CRITICAL):** + +**Launch a single subprocess that:** + +1. Extracts all frontmatter path references from all files +2. Tests file existence for each reference (skipping output files that use config variables) +3. Returns all dead link findings to parent for aggregation + +**CRITICAL DISTINCTION:** +- **Output files using config variables:** Skip (won't exist yet - workflow not installed/running) + - Example: `{output_folder}/my-doc.md` - SKIP + - Example: `{planning_artifacts}/prd.md` - SKIP + - Example: `{bmb_creations_output_folder}/file.md` - SKIP + +- **Data files, step files, other workflows:** MUST EXIST - flag if missing + - Example: `{dataFile}` where value is `../data/config.csv` - MUST EXIST + - Example: `{nextStepFile}` where value is `./step-02.md` - MUST EXIST + - Example: `{advancedElicitationTask}` - MUST EXIST + - Example: `{partyModeWorkflow}` - MUST EXIST + +**Bash execution pattern:** +```bash +# Extract all frontmatter path references from all files +for file in steps-c/*.md; do + # Extract file reference variables from frontmatter + grep "^\w*File:" "$file" | sed "s/.*: //" + + # Resolve path (handle relative paths) + resolved_path=$(resolve_relative_path "$file" "$value") + + # Check file existence - BUT SKIP output files using config variables + if ! path_uses_known_config_variable "$value"; then + if ! test -f "$resolved_path"; then + echo "DEAD LINK: $file references $resolved_path (not found)" + fi + fi +done +``` + +**What we're catching:** +- Dead links to any files that don't exist that the workflow needs during execution + +--- + +**PHASE 4: Module path awareness:** + +**Launch a single subprocess that:** + +1. Determines if current workflow is in a non-bmb module +2. If yes, runs grep across all files to find bmb-specific path assumptions +3. Returns all module awareness issues to parent for aggregation + +```bash +# Check if in non-bmb module, then search for bmb-specific paths +if pwd | grep -q "/modules/[^/]\+/" && ! pwd | grep -q "/bmb/"; then + grep -rn "{project-root}/_bmad/bmb/" steps-c/ steps-e/ steps-v/ 2>/dev/null || echo "No bmb-specific paths found" +fi +``` + +--- + +**RETURN FORMAT:** + +```json +{ + "known_config_variables": ["output_folder", "planning_artifacts", "bmb_creations_output_folder", ...], + "content_violations": [ + {"file": "step-v-01-discovery.md", "line": 63, "violation": "hardcoded path in content", "details": "{project-root}/src/modules/.../prd-purpose.md"} + ], + "dead_links": [ + {"file": "step-06-innovation.md", "line": 215, "violation": "dead link", "details": "nextStepFile './step-07-project-type.md' should be './step-07-project-type.md'"} + ], + "module_awareness_issues": [ + {"file": "step-XX.md", "issue": "using bmb-specific path in non-bmb module"} + ], + "summary": {"critical": N, "high": N, "medium": N} +} +``` + +Check ALL files systematically. Return structured report for compilation and appendage to validation report. + +### 2. Process Findings and Update Report + +**Create/Update "Critical Path Violations" section in {validationReportFile}:** + +If ANY violations found: + +```markdown +## Critical Path Violations + +### Config Variables (Exceptions) + +The following config variables were identified from workflow.md Configuration Loading section. +Paths using these variables are valid even if not relative (they reference post-install output locations): + +{list of known_config_variables found} + +### Content Path Violations + +| File | Line | Issue | Details | +| ---- | ---- | ----- | ------- | +{table from content_violations} + +### Dead Links + +| File | Line | Issue | Details | +| ---- | ---- | ----- | ------- | +{table from dead_links} + +**Note:** Output files using config variables were correctly skipped during existence checks. + +### Module Awareness + +{module_awareness_issues} + +### Summary + +- **CRITICAL:** {critical_count} violations (must fix - workflow will break) +- **HIGH:** {high_count} violations (should fix) +- **MEDIUM:** {medium_count} violations (review) + +**Status:** {"❌ FAIL - Critical violations detected" or "⚠️ WARNINGS - Review recommended" or "✅ PASS - No violations"} +``` + +### 3. Handle Critical Violations + +**If CRITICAL violations found (content violations OR dead links):** + +Halt process once all files have been checked and aggregated - and share the severity of the issue with the user and ask them if they want to stop and you can try to fix these now, or else go to the next item in this list. If not proceeding - its still critical all findings thus far are documented in the report output. + +### 4. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report to {validationReportFile} BEFORE loading and executing {nextStepFile}. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Config variables identified from workflow.md FIRST +- Known config variables used as exceptions in later checks +- ALL step files checked for content path violations +- Dead links detected via file existence tests (skipping output files) +- Module awareness issues flagged +- Findings appended to validation report +- CRITICAL violations halt validation +- Clean workflows proceed to step-03 + +### ❌ SYSTEM FAILURE: + +- Not identifying config variables first +- Not skipping output files during existence checks +- Not checking content (only frontmatter) +- Missing dead link detection +- Not detecting module-specific assumptions +- Proceeding despite critical violations diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-03-menu-validation.md b/_bmad/bmb/workflows/workflow/steps-v/step-03-menu-validation.md new file mode 100644 index 0000000..89f7c98 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-03-menu-validation.md @@ -0,0 +1,164 @@ +--- +name: 'step-03-menu-validation' +description: 'Validate menu handling compliance across all step files' + +nextStepFile: './step-04-step-type-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Validate EVERY step file's menus using subprocess optimization - per-file deep analysis pattern (Pattern 2) +- 🚫 DO NOT skip any files or checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough, leveraging per-file subprocess for menu structure analysis + +## EXECUTION PROTOCOLS: + +- 🎯 Load menu standards first +- 💾 Check EVERY file's menu structure using subprocess optimization when available - per-file deep analysis for menu structure validation +- 📖 Append findings to validation report (subprocesses either update report OR return findings for parent aggregation) +- 🚫 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 EVERY file in steps-c/, launch a subprocess that:** + +1. Loads that step file +2. Loads {menuHandlingStandards} to understand validation criteria +3. Validates menu structure deeply (handler section, execution rules, A/P appropriateness, reserved letter compliance) +4. **EITHER** updates validation report directly with findings +5. **OR** returns structured validation findings to parent for aggregation + +**SUBPROCESS VALIDATION PATTERN - Each subprocess checks for:** + +**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 + +**RETURN FORMAT:** +Each subprocess should return validation findings for its assigned file including: +- File name +- Whether a menu is present +- Results of all 5 checks (handler section, execution rules, redisplay menu, C sequence, A/P appropriateness) +- List of any violations found +- Overall status (PASS/FAIL/WARN) + +**Context savings estimate:** Each subprocess returns structured findings vs full file content. Parent aggregates all findings into final report table. + +### 3. Aggregate Findings and Document Results + +After ALL files have been validated (either via subprocess or main context), document the menu handling validation results in the validation report, including: + +- Overall assessment of menu handling compliance across all step files +- Summary of files checked and their menu status +- Files that passed all menu validation checks +- Files with warnings or issues that need attention +- Files that failed validation with specific violations + +### 4. List Violations + +Compile and document all violations found during validation, organizing them by file and providing clear descriptions of each issue, such as: + +- Missing handler sections +- Incomplete execution rules +- Improper A/P usage +- Missing redisplay menu instructions +- Any other menu handling standard violations + +### 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: + +- Menu standards loaded and understood +- EVERY step file's menus validated via subprocess (per-file deep analysis) OR main context +- All violations documented across handler sections, execution rules, A/P appropriateness +- Findings aggregated into validation report (subprocesses either updated report OR returned findings) +- 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 +- Loading full file contents into parent context instead of using subprocess analysis + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Use subprocess optimization (Pattern 2) - each file in its own subprocess for deep menu structure analysis. Subprocess returns only findings to parent. Auto-proceed through all validation steps. diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md b/_bmad/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md new file mode 100644 index 0000000..544ae50 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md @@ -0,0 +1,211 @@ +--- +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: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +stepTypePatterns: '../data/step-type-patterns.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Load and validate EVERY step against its type pattern - use subprocess optimization (Pattern 2: per-file deep analysis) when available +- 🚫 DO NOT skip any files or checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load step type patterns first (use subprocess for data operations when available) +- 💾 Check EACH file follows its designated type pattern - use per-file subprocesses for deep analysis when available +- 📖 Append findings to validation report (subprocess updates report OR returns findings to parent) +- 🚫 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:** + +**If subprocess capability available:** +```markdown +Launch a subprocess that: +1. Loads {stepTypePatterns} +2. Extracts all pattern definitions deeply +3. Returns summary of patterns to parent (not full file - saves context) +``` + +**If subprocess unavailable:** +```markdown +Load {stepTypePatterns} in main context +# Larger context but still functional - demonstrates graceful fallback +``` + +**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/, launch a subprocess that:** + +1. Determines what type this step SHOULD be from: + - Step number (01 = init, 01b = continuation, last = final) + - Design in {workflowPlanFile} + - Step name pattern + +2. Loads the step file + +3. Validates it follows the pattern for its type + +4. **EITHER** updates the validation report directly with its findings +5. **OR** returns structured findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN - Validate each step file for:** + +**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 + +**RETURN FORMAT:** +Return a concise summary containing: +- File name analyzed +- What type the step should be +- What type it actually is +- Whether it follows the correct pattern +- List of any violations found +- Overall pass/fail status + +**Context savings:** Each subprocess returns only validation findings, not full file contents. Parent receives structured analysis objects instead of 10+ full step files. + +### 3. Aggregate Findings and Document + +**After ALL files analyzed, aggregate findings from subprocesses and document results:** + +**Document the following in the validation report:** + +- Overall summary of step type validation (how many steps checked, pass/fail counts) +- For each step file: + - File name + - What type the step should be (based on design, step number, naming) + - What type it actually is + - Whether it follows the correct pattern for its type + - Any violations or issues found + - Pass/fail/warning status + +**Format:** Create a clear, readable section in the validation report that shows the validation results for each step file. + +### 4. List Violations + +**Compile and document all violations found:** + +**Document the following for any violations:** + +- File name with violation +- What the violation is (specifically what doesn't match the expected pattern) +- What should be changed to fix it +- Severity level (error/warning) + +**For files that pass validation:** Briefly note they 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 (ideally using per-file subprocess optimization) +- All violations documented with structured findings +- Findings aggregated from subprocesses into report +- Report saved before proceeding +- Next validation step loaded +- Context saved: parent receives only findings, not full file contents + +### ❌ 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/_bmad/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md b/_bmad/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md new file mode 100644 index 0000000..c6e1ec6 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md @@ -0,0 +1,200 @@ +--- +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: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +outputFormatStandards: '../data/output-format-standards.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread + +### Step-Specific Rules: + +- 🎯 Validate output format using subprocess optimization - per-file subprocess for step-to-output validation +- 🚫 DO NOT skip any checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report OR return findings to parent for aggregation +- 🚪 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 +- 🔍 Use subprocess optimization for step-to-output mapping validation - per-file subprocess for deep analysis +- 🚫 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 + +**DO NOT BE LAZY - For EACH step that outputs to document, launch a subprocess that:** + +1. Loads that step file +2. Analyzes frontmatter for `outputFile` variable +3. Analyzes step body to verify output is written before loading next step +4. Checks menu C option saves to output before proceeding +5. Returns structured findings to parent for aggregation + +**SUBPROCESS EXECUTION PATTERN:** + +**For EACH step file, launch a subprocess that:** +1. Loads the step file +2. Performs deep analysis of output operations (frontmatter, body, menu options) +3. Returns findings to parent for aggregation + +**RETURN FORMAT:** +Each subprocess should return: +- Step filename +- Whether output variable exists in frontmatter +- Whether output is saved before loading next step +- Whether menu option C saves to output before proceeding +- Output order number (if applicable) +- Any issues found +- Overall status (PASS/FAIL/WARNING) + +**Parent aggregates findings into:** + +**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 + +Document your output format validation findings in the validation report. Include: + +- **Document Production**: Whether the workflow produces documents and what template type it uses +- **Template Assessment**: Template file existence, whether it matches the designed type, and frontmatter correctness +- **Final Polish Evaluation**: Whether a final polish step is required (for free-form workflows) and if present, whether it properly loads the entire document and optimizes flow +- **Step-to-Output Mapping**: For each step that outputs to the document, document whether it has the output variable in frontmatter, saves output before loading the next step, and properly saves in menu option C +- **Subprocess Analysis Summary**: Count of total steps analyzed, steps with output, steps saving correctly, and steps with issues +- **Issues Identified**: List any problems found with template structure, polish step, or output mapping +- **Overall Status**: Pass, fail, or warning designation + +### 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 via subprocess optimization +- All findings documented +- Report saved before proceeding +- Next validation step loaded +- Subprocess pattern applied correctly (per-file analysis for step-to-output validation) + +### ❌ SYSTEM FAILURE: + +- Not checking template file +- Missing final polish step for free-form +- Not documenting mapping issues +- Not saving report before proceeding +- Not using subprocess optimization for step-to-output validation +- Loading all step files into parent context instead of per-file subprocess + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check template, polish step, and mapping. Use subprocess optimization for step-to-output validation - per-file subprocess returns analysis, not full content. Auto-proceed through all validation steps. diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md b/_bmad/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md new file mode 100644 index 0000000..2c4c98a --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md @@ -0,0 +1,195 @@ +--- +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: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Check if workflow needs validation steps - use subprocess optimization (per-file deep analysis for Pattern 2) +- 🚫 DO NOT skip any validation step reviews - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Determine if validation is critical for this workflow - use subprocess optimization when available +- 💾 Check validation steps exist and are well-designed - launch subprocess for per-file deep analysis (Pattern 2) +- 💬 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 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 EVERY validation step file, launch a subprocess that:** + +1. Loads that validation step file +2. Reads and analyzes the step's content deeply (prose, logic, quality, flow, anti-lazy language) +3. Returns structured analysis findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN - Check each validation step file 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 + +**RETURN FORMAT:** +Return a structured analysis containing: +- Step file name +- Proper design checklist (loads data, systematic checks, auto-proceeds, clear criteria, reports findings) +- Anti-lazy language check (has mandate, mandate text, comprehensive coverage) +- Critical flow check (location, segregation, independence) +- Any issues found +- Overall status (PASS/FAIL/WARN) + +**Context savings:** Each subprocess returns analysis (~30 lines), not full step file (~200 lines). Parent gets structured findings, not file contents. + +### 3. Aggregate Findings from All Subprocesses + +After all validation step files have been analyzed in subprocesses, aggregate findings: + +**Process subprocess results:** +- Compile all structured analysis findings +- Identify patterns across validation steps +- Note any critical issues or warnings + +### 4. 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 + +### 5. Document Findings + +**Create/Update "Validation Design Check" section in {validationReportFile} using aggregated subprocess findings:** + +Document the following information: + +**Whether validation is required:** Indicate if this workflow needs validation steps based on its domain type (critical/compliance/safety workflows vs. creative/exploratory ones) + +**List of validation steps found:** Provide the names/paths of all validation step files in the workflow + +**Validation step quality assessment:** For each validation step, document: +- Whether it loads validation data/standards from the data/ folder +- Whether it has a systematic check sequence +- Whether it auto-proceeds through checks (vs. stopping for user input) +- Whether it includes "DO NOT BE LAZY" or similar anti-lazy language mandates +- Whether it has clear pass/fail criteria +- Overall status (PASS/FAIL/WARN) + +**"DO NOT BE LAZY" language presence:** For each validation step, note whether anti-lazy language is present and what it says + +**Critical flow segregation:** For workflows requiring validation, document: +- The workflow domain type +- Whether validation steps are in the steps-v/ folder (tri-modal structure) or inline with create steps +- Whether this segregation is appropriate for the workflow type + +**Validation data files:** List any validation data files found in the data/ folder, or note if they are missing + +**Issues identified:** List any problems found with the validation design, missing data files, or quality concerns + +**Overall status:** Provide final assessment (PASS/FAIL/WARN/N/A) with reasoning + +### 6. Append to Report + +Update {validationReportFile} - replace "## Validation Design Check *Pending...*" with actual findings from subprocess aggregation. + +### 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:** +"**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/_bmad/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md b/_bmad/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md new file mode 100644 index 0000000..000f6f6 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md @@ -0,0 +1,209 @@ +--- +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: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +intentVsPrescriptive: '../data/intent-vs-prescriptive-spectrum.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Review EVERY step's instruction style using subprocess optimization - separate subprocess per file for deep analysis +- 🚫 DO NOT skip any files or style checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load intent vs prescriptive standards +- 💾 Check EACH step's instruction style using subprocess optimization - each file in its own subprocess +- 📖 Validate style is appropriate for domain +- 🚫 DO NOT halt for user input - validation runs to completion +- 💬 Subprocesses must either update validation report OR return findings for parent aggregation + +## 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, launch a subprocess that:** + +1. Loads that step file +2. Reads the instruction sections (MANDATORY SEQUENCE) +3. Analyzes and classifies instruction style deeply +4. **EITHER** updates validation report directly with findings +5. **OR** returns structured analysis findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN:** + +Each subprocess performs deep analysis of instruction prose to 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) + +**RETURN FORMAT:** +Each subprocess should return findings including: +- Step file identifier +- Instruction style classification (Intent-based/Prescriptive/Mixed) +- Style indicators observed +- Appropriateness assessment (PASS/WARN/FAIL) +- Specific notes and observations +- Examples of good and concerning instruction patterns + +**Parent aggregates all subprocess findings into unified report section.** + +### 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. Aggregate Findings and Document + +After ALL subprocesses have analyzed their respective step files, aggregate findings and create/update section in {validationReportFile}. + +Document the following: + +**Workflow Domain Assessment:** +- Document the domain type (creative/interactive vs compliance/legal) +- State the appropriate instruction style for this domain + +**Instruction Style Findings:** +- List each step and its instruction style classification (intent-based/prescriptive/mixed) +- Note whether the style is appropriate for the domain +- Document specific examples of instruction language that demonstrate the style +- Identify any steps with inappropriate style (e.g., prescriptive in creative domain) + +**Issues Identified:** +- List any steps that are overly prescriptive for their domain +- List any steps that should be more prescriptive (for compliance domains) +- Note any style inconsistencies across steps + +**Positive Findings:** +- Highlight steps with excellent instruction style +- Note effective use of intent-based facilitation language +- Identify appropriate use of prescriptive instructions (if applicable) + +**Overall Status:** +- Provide final assessment (PASS/FAIL/WARN) +- Summarize key findings + +**Context Savings Note:** Using subprocess pattern (Pattern 2: per-file deep analysis), parent context receives only structured analysis findings (~50-100 lines per file) instead of full file contents (~200+ lines per file). For 10 steps: ~500-1000 lines received vs ~2000+ lines if loading all files in parent. + +### 6. Update Report with Aggregated Findings + +Update {validationReportFile} - replace "## Instruction Style Check *Pending...*" with actual aggregated findings from all subprocesses. + +### 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 via subprocess optimization (Pattern 2: per-file deep analysis) +- Each step analyzed in its own subprocess for style classification +- Style validated against domain appropriateness +- Issues documented with specific examples +- Subprocess findings aggregated into unified report section +- Context savings achieved (~500-1000 lines received vs ~2000+ if loading all files) +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every step's style via subprocess +- Not analyzing each file in its own subprocess +- Not validating against domain +- Not documenting style issues +- Not aggregating subprocess findings +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. For EACH step file, launch a subprocess to analyze instruction style deeply. Aggregate findings. Auto-proceed through all validation steps. Use graceful fallback if subprocess unavailable. diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md b/_bmad/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md new file mode 100644 index 0000000..43416b1 --- /dev/null +++ b/_bmad/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-08b-subprocess-optimization.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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/_bmad/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md b/_bmad/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md new file mode 100644 index 0000000..5d0219a --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md @@ -0,0 +1,179 @@ +--- +name: 'step-08b-subprocess-optimization' +description: 'Identify subprocess optimization opportunities - reduce context load, improve performance' + +nextStepFile: './step-09-cohesive-review.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +subprocessPatterns: '../data/subprocess-optimization-patterns.md' +--- + +# Validation Step 8b: Subprocess Optimization Analysis + +## STEP GOAL: + +To identify opportunities for subprocess optimization throughout the workflow - reducing context load, improving performance, and enabling massive operations that would otherwise exceed context limits. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - ANALYZE EVERY FILE IN ITS OWN SUBPROCESS +- 📖 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 +- ⚙️ If any instruction references a subprocess/subagent/tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Analyze EVERY step file for subprocess optimization - each file in its own subprocess +- 🚫 DO NOT skip any file - DO NOT BE LAZY +- 💬 Load {subprocessPatterns} in subprocess performing some action required to understand patterns deeply with examples (if subprocess available), else load in main context +- 🚪 This identifies context-saving and performance-optimizing opportunities + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze each step file in its own subprocess - deep analysis of subprocess potential +- 💾 Subprocesses must identify optimization patterns and return findings to parent for aggregation +- 📖 Aggregate findings into validation report before loading next step + +## CONTEXT BOUNDARIES: + +- Three patterns: grep/regex across files, per-file deep analysis, data file operations, parallel execution +- **Context-saving goal**: Return ONLY key findings to parent, not full file contents + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Subprocess Pattern Reference (Context Optimization!) + +**First, understand the subprocess optimization patterns by loading {subprocessPatterns}:** + +**If subprocess capability available:** +```markdown +Launch a subprocess that: +1. Loads {subprocessPatterns} +2. Studies all patterns and examples deeply (Pattern 3: data operations!) +3. Returns summary of key patterns to parent (not full file - saves context) +``` + +**If subprocess unavailable:** +```markdown +Load {subprocessPatterns} in main context +# Larger context but still functional - demonstrates graceful fallback +``` + +**This step itself demonstrates Pattern 3 from the reference!** + +--- + +### 2. Perform Subprocess Optimization Analysis + +**DO NOT BE LAZY - For EVERY step file, launch a subprocess that:** + +1. Loads that step file +2. ALSO loads {subprocessPatterns} to understand all patterns deeply (subprocess needs full context!) +3. Analyzes the step against each pattern looking for optimization opportunities +4. Returns specific, actionable suggestions to parent + +**Subprocess gets full context:** +- The step file being analyzed +- The subprocess-optimization-patterns.md reference (all examples and patterns) +- Returns only findings to parent (context savings!) + +**SUBPROCESS ANALYSIS PATTERN - Check each step file for:** + +**Pattern 1: Single subprocess for grep/regex** - Operations that check/search multiple files for patterns (frontmatter validation, menu checks, path searches). Suggest: "Use single grep subprocess, return only matches" + +**Pattern 2: Separate subprocess per file** - Operations requiring deep analysis of prose/logic/quality/style/flow per file (instruction review, collaborative quality assessment, step type compliance). Suggest: "Each file in own subprocess, return analysis findings" + +**Pattern 3: Subprocess for data operations** - Operations loading large data files to find matches, extract key details, or summarize findings. Suggest: "Subprocess loads data, returns ONLY relevant rows/findings" + +**Pattern 4: Parallel execution** - Independent operations that could run simultaneously. Suggest: "Run in parallel subprocesses to reduce execution time" + +**RETURN FORMAT (example structure, adapt as needed):** +```json +{ + "step_file": "step-02-*.md", + "opportunities": [ + { + "pattern": "grep/regex|per-file|data-ops|parallel", + "location": "Line XX: [quote relevant instruction]", + "issue": "Loads all files into parent context", + "suggestion": "Use single grep subprocess, return only failures", + "impact": "Saves ~N lines per file, faster execution", + "priority": "HIGH|MEDIUM|LOW" + } + ] +} +``` + +### 2. Aggregate Findings and Create Report Section + +After ALL files analyzed, create/update section in {validationReportFile}: + +```markdown +## Subprocess Optimization Opportunities + +**Total Opportunities:** {count} | **High Priority:** {count} | **Estimated Context Savings:** {description} + +### High-Priority Opportunities + +**{Step Name}** - {Pattern Type} +- **Current:** {brief description of current approach} +- **Suggested:** {specific optimization suggestion} +- **Impact:** {context savings, performance gain} +- **Example:** `{brief code/pseudocode}` + +[Repeat for each high-priority opportunity...] + +### Moderate/Low-Priority Opportunities + +{List with brief descriptions} + +### Summary by Pattern + +- **Pattern 1 (grep/regex):** {count} opportunities - {total savings} +- **Pattern 2 (per-file):** {count} opportunities - {total savings} +- **Pattern 3 (data ops):** {count} opportunities - {total savings} +- **Pattern 4 (parallel):** {count} opportunities - {performance gain} + +### Implementation Recommendations + +**Quick Wins:** {easy implementations with big savings} +**Strategic:** {higher effort but big payoff} +**Future:** {moderate impact, consider later} + +**Status:** ✅ Complete / ⚠️ Review recommended +``` + +### 3. Save Report and Auto-Proceed + +**CRITICAL:** Save report BEFORE loading next step. + +Then load, read entire file, execute {nextStepFile}. + +**Display:** "**Subprocess optimization analysis complete.** Identified {count} opportunities with potential context savings. Proceeding to Cohesive Review..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step file analyzed in its own subprocess +- ALL optimization opportunities identified +- Findings aggregated into report +- Prioritized recommendations with context savings +- Report saved, next step loaded + +### ❌ SYSTEM FAILURE: + +- Not analyzing every file +- Skipping opportunity identification +- Not providing specific suggestions +- Not estimating savings +- Not aggregating findings + +**Master Rule:** DO NOT BE LAZY. Analyze EVERY file in its own subprocess. Identify ALL optimization opportunities across 4 patterns. Provide specific, actionable recommendations with context savings. Return findings to parent. Auto-proceed. diff --git a/_bmad/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md b/_bmad/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md new file mode 100644 index 0000000..adf1ab4 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md @@ -0,0 +1,186 @@ +--- +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: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Review the workflow as a cohesive whole - **NOTE: This step loads ENTIRE workflow for holistic review (different pattern from other validation steps)** +- 🚫 DO NOT skip any aspect of the review - DO NOT BE LAZY +- 💬 Subprocess optimization: When available, can use subprocesses to load individual step files and return structured summaries to parent for aggregation +- 💬 However, since cohesive review requires understanding the COMPLETE workflow as one unit, parent may need full context for proper holistic assessment +- 🚪 This is the meta-review - overall assessment + +## EXECUTION PROTOCOLS: + +- 🎯 Walk through the ENTIRE workflow end-to-end using subprocess optimization when available +- 💬 When using subprocesses: Each subprocess loads one step file, performs deep analysis, returns structured findings to parent for aggregation +- 💬 Subprocess must either update validation report directly OR return findings to parent for compilation +- 💾 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 using subprocess optimization when available:** + +**SUBPROCESS APPROACH (when available):** + +For EACH workflow file (workflow.md + all step files in order), launch a subprocess that: +1. Loads that single file +2. Performs deep analysis of content, flow, quality, and connection points +3. Returns structured findings to parent for holistic aggregation + +**Subprocess should return:** +- File name analyzed +- Purpose and flow position within the workflow +- How it connects to previous and next steps +- Quality indicators and any issues found +- Voice and tone consistency assessment + +**FALLBACK APPROACH (if subprocess unavailable):** + +Load workflow.md and EVERY step file in steps-c/ sequentially in main context: +1. Load workflow.md +2. Load EVERY step file in steps-c/ in order +3. Read through each step +4. Understand the complete flow + +**CRITICAL:** Whether using subprocess or main context, you must understand the COMPLETE workflow as one cohesive unit before proceeding to assessment. + +### 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 + +**Evaluate the workflow across key dimensions:** + +Consider goal clarity, logical flow, facilitation quality, user experience, and goal achievement. Provide an overall quality assessment based on these dimensions. + +### 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 + +**Assess overall workflow readiness:** + +Determine if the workflow is excellent (ready to use, exemplifies best practices), good (solid with minor improvements possible), needs work (has issues to address), or problematic (major issues requiring significant revision). Provide a clear recommendation on readiness for use. + +### 7. Document Findings + +**Document your cohesive review findings in the validation report:** + +Include your overall assessment (excellent/good/needs work/problematic), quality evaluation across key dimensions, cohesiveness analysis (flow, progression, voice and tone), identified strengths and weaknesses, any critical issues, what makes the workflow work well, what could be improved, user experience forecast, and your recommendation on readiness for use. + +### 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/_bmad/bmb/workflows/workflow/steps-v/step-10-report-complete.md b/_bmad/bmb/workflows/workflow/steps-v/step-10-report-complete.md new file mode 100644 index 0000000..ee55053 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-10-report-complete.md @@ -0,0 +1,154 @@ +--- +name: 'step-10-report-complete' +description: 'Finalize validation report - check for plan file, summarize all findings, present to user' + +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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}` +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### 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 10 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 a comprehensive summary that includes: + +- Validation completion date +- Overall status assessment (based on all validation steps) +- List of all validation steps completed with their individual results +- Summary of critical issues that must be fixed (or note if none found) +- Summary of warnings that should be addressed (or note if none found) +- Key strengths identified during validation +- Overall assessment of workflow quality +- Recommendation on readiness (ready to use / needs tweaks / needs revision / major rework needed) +- Suggested next steps for the user + +Present this information in a clear, readable format - the exact structure is flexible as long as it covers all these points. + +### 4. Update Report Status + +Update the frontmatter of {validationReportFile} to set validationStatus to COMPLETE and add the completionDate. Keep existing fields like validationDate, workflowName, and workflowPath unchanged. + +### 5. Present Summary to User + +Present a clear summary to the user that includes: + +- Confirmation that validation is complete +- Overall status of the workflow +- Quick results overview showing each validation step and its result +- Count of critical issues and warnings (or note if none found) +- Recommendation on workflow readiness +- Path to the full validation report +- Options for next steps (review detailed findings, make changes, explain results, or other actions) + +Present this information in a natural, conversational way - the exact format doesn't matter as long as all this information is clearly communicated. + +### 6. 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) + +### 7. If User Wants to Fix Issues + +Explain the available options for fixing issues: + +- Manual edits: User edits files directly, then re-runs validation +- Guided edits: User specifies what to fix, help create specific edits for user approval +- Edit workflow: If the workflow has steps-e/, use the edit workflow to make systematic changes + +The exact format doesn't matter - just ensure the user understands their options for addressing issues. + +### 8. Update Plan with Validation Status + +If a plan file exists at {workflowPlanFile}, update its frontmatter to include the validation status (COMPLETE), the current validation date, and a reference to the validation report file. + +## 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/_bmad/bmb/workflows/workflow/steps-v/step-11-plan-validation.md b/_bmad/bmb/workflows/workflow/steps-v/step-11-plan-validation.md new file mode 100644 index 0000000..32c951a --- /dev/null +++ b/_bmad/bmb/workflows/workflow/steps-v/step-11-plan-validation.md @@ -0,0 +1,237 @@ +--- +name: 'step-11-plan-validation' +description: 'Validate plan quality - ensure all user intent and requirements are implemented' + +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.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 +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread + +### Step-Specific Rules: + +- 🎯 Validate plan requirements using subprocess optimization - separate subprocess per requirement area for deep analysis +- 🚫 DO NOT skip checking any requirement from the plan - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This ensures the build actually delivered what was planned + +## EXECUTION PROTOCOLS: + +- 🎯 Load plan and extract all requirements/intent using subprocess optimization when available - separate subprocess per requirement area for deep analysis +- 💾 Subprocesses validate implementation against plan requirements and return findings for aggregation +- 📖 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:** + +**SUBPROCESS EXECUTION PATTERN:** + +Launch a subprocess that: +1. Loads {workflowPlanFile} +2. Extracts all requirements from each section (Discovery, Classification, Requirements, Design, Tools) +3. Returns structured requirements list to parent + +**SUBPROCESS RETURNS:** +Structured requirements list organized by section (discovery, classification, requirements, design, tools) with all extracted items and a count of total requirements. + +**If subprocess unavailable:** Load {workflowPlanFile} in main context and extract requirements (larger context but still functional - demonstrates graceful fallback). + +--- + +### 3. Validate Each Requirement Against Built Workflow + +**DO NOT BE LAZY - For EACH requirement area, launch a subprocess that:** + +1. Loads relevant workflow files (workflow.md, step files, etc.) +2. Validates that specific requirement area is implemented correctly +3. Assesses quality of implementation +4. **EITHER** updates validation report directly with findings +5. **OR** returns structured validation results to parent for aggregation + +**PATTERN 2: Separate subprocess per requirement area for deep analysis** + +Each subprocess gets full context to deeply understand that requirement area and validate implementation quality: + +--- + +**SUBPROCESS 1: Discovery Validation** + +**Subprocess analyzes:** +- ✅ Built workflow addresses the original problem? +- ✅ Vision from discovery is reflected in final workflow? + +**Subprocess returns:** +Discovery validation results indicating whether the original problem and vision from the plan are addressed in the built workflow, with quality assessment, status (✅/❌), and any gaps identified. + +--- + +**SUBPROCESS 2: Classification Validation** + +**Subprocess analyzes:** +- ✅ Document output matches plan (yes/no)? +- ✅ Module affiliation correct? +- ✅ Continuable support as specified? +- ✅ Tri-modal structure as specified? + +**Subprocess returns:** +Classification validation results for each classification attribute (document output, module, continuable, tri-modal) comparing what was specified vs what was implemented, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**SUBPROCESS 3: Requirements Validation** + +**Subprocess analyzes:** +- ✅ Flow structure matches plan? +- ✅ User interaction style as specified? +- ✅ All required inputs configured? +- ✅ Output format matches specification? +- ✅ Success criteria achievable? + +**Subprocess returns:** +Requirements validation results for flow structure, interaction style, inputs, outputs, and success criteria comparing what was specified vs what was implemented, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**SUBPROCESS 4: Design Validation** + +**Subprocess analyzes:** +- ✅ All steps from design present in workflow? +- ✅ Step purposes match design? +- ✅ Flow follows design diagram? +- ✅ Interaction patterns as specified? + +**Subprocess returns:** +Design validation results for each step from the plan checking if it exists in the workflow and if the purpose matches, along with whether the flow follows the design diagram and interaction patterns match, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**SUBPROCESS 5: Tools Validation** + +**Subprocess analyzes:** +- ✅ Specified tools configured in workflow? +- ✅ Data files created as specified? + +**Subprocess returns:** +Tools validation results checking which specified tools are configured and which data files were created, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**If subprocess unavailable:** Validate each requirement area sequentially in main context (larger context but still functional - demonstrates graceful fallback). + +--- + +### 4. Aggregate Findings and Update Report + +After ALL requirement area subprocesses complete, aggregate findings into validation report. + +Document the following information: + +**Plan Information:** +- Plan file location +- Whether a plan was found +- Total number of requirements extracted from the plan + +**Implementation Coverage:** +For each requirement area from the plan (Discovery/Vision, Classification attributes, Requirements specifications, Design elements, Tools): +- What was specified in the plan +- Whether it was implemented in the workflow +- Quality assessment (High/Medium/Low) +- Implementation status + +**Implementation Gaps:** +List any requirements from the plan that are NOT present in the built workflow + +**Quality Issues:** +List any requirements that are implemented but with quality concerns + +**Plan-Reality Alignment:** +Describe where the built workflow doesn't match what was planned + +**Overall Assessment:** +- Plan implementation score (percentage) +- Overall status (Fully Implemented/Partially Implemented/Poorly Implemented/Missing Critical Items) + +**Quality Assessment Framework:** +For each implemented requirement, assess quality: +- **High Quality**: Implementation follows best practices, would facilitate effectively +- **Medium Quality**: Functional but has issues or gaps +- **Low Quality**: Minimal/barely working, would not facilitate well + +Examples: +- Plan specifies "Highly collaborative, intent-based facilitation" and implementation has A/P menus with intent-based language = High Quality +- Plan specifies "Continuable workflow with session resume" and implementation has step-01b-continue.md tracking stepsCompleted = High Quality + +### 5. Append to Report + +Append the aggregated findings to {validationReportFile} after the "## Cohesive Review" section. + +### 6. 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 (in subprocess or main context) +- Every requirement extracted and validated using subprocess optimization when available +- Each requirement area analyzed in separate subprocess (or main context with graceful fallback) +- Implementation gaps documented with structured findings +- Quality assessed for each requirement +- Findings aggregated and appended to report +- Context saved via subprocess pattern (return only findings, not full file contents) + +### ❌ SYSTEM FAILURE: + +- Not loading complete plan +- Skipping requirement checks +- Not validating each requirement area deeply +- Not using subprocess optimization when available +- Not documenting implementation gaps +- Not assessing quality +- Loading full file contents into parent instead of returning only findings + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY requirement from the plan. Use subprocess optimization (Pattern 2: per-requirement deep analysis) when available. Document all gaps. Return only findings to parent, not full file contents. diff --git a/_bmad/bmb/workflows/workflow/templates/minimal-output-template.md b/_bmad/bmb/workflows/workflow/templates/minimal-output-template.md new file mode 100644 index 0000000..ecb1fb9 --- /dev/null +++ b/_bmad/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/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md b/_bmad/bmb/workflows/workflow/templates/step-01-init-continuable-template.md similarity index 97% rename from _bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md rename to _bmad/bmb/workflows/workflow/templates/step-01-init-continuable-template.md index 9b5794e..84e4628 100644 --- a/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md +++ b/_bmad/bmb/workflows/workflow/templates/step-01-init-continuable-template.md @@ -17,11 +17,11 @@ workflow\*path: `{project-root}/_bmad/[module-path]/workflows/[workflow-name]` # File References (all use {variable} format in file) -thisStepFile: `{workflow_path}/steps/step-01-init.md` -nextStepFile: `{workflow_path}/steps/step-02-[step-name].md` +thisStepFile: `./step-01-init.md` +nextStepFile: `./step-02-[step-name].md` workflowFile: `{workflow_path}/workflow.md` outputFile: `{output_folder}/[output-file-name]-{project_name}.md` -continueFile: `{workflow_path}/steps/step-01b-continue.md` +continueFile: `./step-01b-continue.md` templateFile: `{workflow_path}/templates/[main-template].md` # Template References diff --git a/_bmad/bmb/docs/workflows/templates/step-1b-template.md b/_bmad/bmb/workflows/workflow/templates/step-1b-template.md similarity index 99% rename from _bmad/bmb/docs/workflows/templates/step-1b-template.md rename to _bmad/bmb/workflows/workflow/templates/step-1b-template.md index 8e34bdd..0f5e710 100644 --- a/_bmad/bmb/docs/workflows/templates/step-1b-template.md +++ b/_bmad/bmb/workflows/workflow/templates/step-1b-template.md @@ -17,7 +17,7 @@ workflow\*path: '{project-root}/_bmad/[module-path]/workflows/[workflow-name]' # File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' outputFile: '{output_folder}/[output-file-name]-{project_name}.md' workflowFile: '{workflow_path}/workflow.md' diff --git a/_bmad/bmb/docs/workflows/templates/step-template.md b/_bmad/bmb/workflows/workflow/templates/step-template.md similarity index 88% rename from _bmad/bmb/docs/workflows/templates/step-template.md rename to _bmad/bmb/workflows/workflow/templates/step-template.md index 38b447e..87098d8 100644 --- a/_bmad/bmb/docs/workflows/templates/step-template.md +++ b/_bmad/bmb/workflows/workflow/templates/step-template.md @@ -15,9 +15,9 @@ workflow\*path: '{project-root}/_bmad/[module]/reference/workflows/[workflow-nam # File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-[N]-[short-name].md' -nextStep{N+1}: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step or no next step -altStep{Y}: '{workflow_path}/steps/step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic +thisStepFile: './step-[N]-[short-name].md' +nextStep{N+1}: './step-[N+1]-[next-short-name].md' # Remove for final step or no next step +altStep{Y}: './step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/[output-file-name]-{project_name}.md' @@ -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 @@ -243,7 +243,7 @@ Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step ### Initialization Step Example -See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of: +See [step-01-discovery.md](../steps-c/step-01-discovery.md) for an example of: - Detecting existing workflow state and short circuit to 1b - Creating output documents from templates @@ -252,16 +252,16 @@ See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src ### Continuation Step Example -See [step-01b-continue.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of: +See [step-01b-continue.md](../steps-c/step-01b-continuation.md) for an example of: -- Handling already-in-progress workflows -- Detecting completion status +- Handling already-in-progress workflows that the user now wants to continue progress +- Detecting completion status (which step was already completed last) - Presenting update vs new plan options -- Seamless workflow resumption +- Seamless workflow resumption by reviewing existing plan and output thus far that has been recorded and then jumping to the proper step ### Standard Step with Menu Example -See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of: +See [step-02-classification.md](../steps-c/step-02-classification.md#8-present-menu-options) for an example of: - Presenting a menu with A/P/C options - Forcing halt until user selects 'C' (Continue) @@ -271,12 +271,12 @@ See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/ ### Final Step Example -See [step-06-prep-schedule.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of: +See [step-11-completion.md](../steps-c/step-11-completion.md) for an example of: - Completing workflow deliverables - Marking workflow as complete in frontmatter - Providing final success messages -- Ending the workflow session gracefully +- Ending the workflow session gracefully or moving on to a validation workflow if applicable ## Best Practices diff --git a/_bmad/bmb/docs/workflows/templates/workflow-template.md b/_bmad/bmb/workflows/workflow/templates/workflow-template.md similarity index 94% rename from _bmad/bmb/docs/workflows/templates/workflow-template.md rename to _bmad/bmb/workflows/workflow/templates/workflow-template.md index 5cc687a..42a3d35 100644 --- a/_bmad/bmb/docs/workflows/templates/workflow-template.md +++ b/_bmad/bmb/workflows/workflow/templates/workflow-template.md @@ -97,8 +97,6 @@ Copy the template above and replace: Update the last line of the workflow.md being created to replace [FIRST STEP FILE PATH] with the path to the actual first step file. -Example: Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. +Example: Load, read the full file and then execute `./step-01-init.md` to begin the workflow. -### NOTE: You can View a real example of a perfect workflow.md file that was created from this template - -`{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md` +### NOTE: You can View a real example of a perfect workflow.md file from the one you were executed from `../workflow.md` diff --git a/_bmad/bmb/workflows/workflow/workflow-create-workflow.md b/_bmad/bmb/workflows/workflow/workflow-create-workflow.md new file mode 100644 index 0000000..2aa5521 --- /dev/null +++ b/_bmad/bmb/workflows/workflow/workflow-create-workflow.md @@ -0,0 +1,79 @@ +--- +name: create-workflow +description: Create a new BMAD workflow with proper structure and best practices +web_bundle: true +createWorkflow: './steps-c/step-01-discovery.md' +conversionWorkflow: './steps-c/step-00-conversion.md' +--- + +# Create Workflow + +**Goal:** Create structured, repeatable standalone workflows through collaborative conversation and step-by-step guidance. + +**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 + +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 +- **Tri-Modal Structure**: Separate step folders for Create (steps-c/), Validate (steps-v/), and Edit (steps-e/) modes + +### 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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +--- + +## 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. Create Mode Selection + +"**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" + +Wait for user selection. + +### 3. Route to First Step + +- **IF F:** Load, read completely, then execute `{createWorkflow}` (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 `{conversionWorkflow}` (steps-c/step-00-conversion.md) +- **IF Any other:** help user respond, then redisplay create mode menu diff --git a/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md b/_bmad/bmb/workflows/workflow/workflow-edit-workflow.md similarity index 63% rename from _bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md rename to _bmad/bmb/workflows/workflow/workflow-edit-workflow.md index f0276b3..753f640 100644 --- a/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md +++ b/_bmad/bmb/workflows/workflow/workflow-edit-workflow.md @@ -1,14 +1,15 @@ --- -name: Meal Prep & Nutrition Plan -description: Creates personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. +name: edit-workflow +description: Edit existing BMAD workflows while maintaining integrity web_bundle: true +editWorkflow: './steps-e/step-e-01-assess-workflow.md' --- -# Meal Prep & Nutrition Plan Workflow +# Edit Workflow -**Goal:** Create personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. +**Goal:** Edit and improve existing workflows while maintaining their integrity and compliance with BMAD standards. -**Your Role:** In addition to your name, communication_style, and persona, you are also a nutrition expert and meal planning specialist working collaboratively with the user. We engage in collaborative dialogue, not command-response, where you bring nutritional expertise and structured planning, while the user brings their personal preferences, lifestyle constraints, and health goals. Work together to create a sustainable, enjoyable nutrition plan. +**Your Role:** Workflow improvement specialist. In addition to your name, communication_style, and persona, you are also a workflow architect and systems designer collaborating with a workflow creator to improve their existing workflow. This is a partnership, not a client-vendor relationship. --- @@ -42,6 +43,7 @@ This uses **step-file architecture** for disciplined execution: - 🎯 **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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` --- @@ -49,11 +51,15 @@ This uses **step-file architecture** for disciplined execution: ### 1. Configuration Loading -Load and read full config from {project-root}/_bmad/core/config.yaml and resolve: +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` +- `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. Route to Edit Workflow -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. +"**Edit Mode: Improving an existing workflow while maintaining BMAD compliance.**" + +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 `{editWorkflow}` (steps-e/step-e-01-assess-workflow.md) diff --git a/_bmad/bmb/workflows/edit-workflow/workflow.md b/_bmad/bmb/workflows/workflow/workflow-rework-workflow.md similarity index 70% rename from _bmad/bmb/workflows/edit-workflow/workflow.md rename to _bmad/bmb/workflows/workflow/workflow-rework-workflow.md index 738c3c5..69165aa 100644 --- a/_bmad/bmb/workflows/edit-workflow/workflow.md +++ b/_bmad/bmb/workflows/workflow/workflow-rework-workflow.md @@ -1,14 +1,15 @@ --- -name: edit-workflow -description: Intelligent workflow editor that helps modify existing workflows while following best practices +name: rework-workflow +description: Rework a Workflow to a V6 Compliant Version web_bundle: true +reworkWorkflow: './steps-r/step-01-assess-rework.md' --- -# Edit Workflow +# Rework Workflow -**Goal:** Collaboratively edit and improve existing workflows, ensuring they follow best practices and meet user needs effectively. +**Goal:** Rework and modernize existing workflows to V6 compliance standards. -**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. +**Your Role:** Workflow modernization specialist. In addition to your name, communication_style, and persona, you are also a workflow architect and systems designer helping users upgrade their existing workflows to V6 compliance standards. --- @@ -42,6 +43,7 @@ This uses **step-file architecture** for disciplined execution: - 🎯 **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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` --- @@ -54,6 +56,10 @@ 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. Route to Rework Workflow -Load, read the full file and then execute `{workflow_path}/steps/step-01-analyze.md` to begin the workflow. +"**Rework Mode: Upgrading an existing workflow to V6 compliance standards.**" + +Prompt for workflow path: "Which workflow would you like to rework to V6? Please provide the path to the workflow.md file." + +Then load, read completely, and execute `{reworkWorkflow}` (steps-r/step-01-assess-rework.md) diff --git a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md b/_bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md similarity index 54% rename from _bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md rename to _bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md index a63fa50..d239033 100644 --- a/_bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md +++ b/_bmad/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md @@ -1,20 +1,21 @@ --- -name: Meal Prep & Nutrition Plan -description: Creates personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. +name: validate-max-parallel-workflow +description: Run validation checks in MAX-PARALLEL mode against a workflow requires a tool that supports Parallel Sub-Processes web_bundle: true +validateWorkflow: './steps-v/step-01-validate-max-mode.md' --- -# Meal Prep & Nutrition Plan Workflow +# Validate Max-Parallel Workflow -**Goal:** Create personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. +**Goal:** Validate existing workflows against BMAD standards using maximum parallel execution for comprehensive review. -**Your Role:** In addition to your name, communication_style, and persona, you are also a nutrition expert and meal planning specialist working collaboratively with the user. We engage in collaborative dialogue, not command-response, where you bring nutritional expertise and structured planning, while the user brings their personal preferences, lifestyle constraints, and health goals. Work together to create a sustainable, enjoyable nutrition plan. +**Your Role:** Validation Architect and Quality Assurance Specialist with parallel processing expertise. You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. --- ## WORKFLOW ARCHITECTURE -This uses **step-file architecture** for disciplined execution: +This uses **step-file architecture** for disciplined execution with parallel optimization: ### Core Principles @@ -23,6 +24,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 +- **Parallel Optimization**: When available, use subprocess/Task tools to run independent validation steps in parallel ### Step Processing Rules @@ -42,6 +44,7 @@ This uses **step-file architecture** for disciplined execution: - 🎯 **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 +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` --- @@ -49,10 +52,15 @@ This uses **step-file architecture** for disciplined execution: ### 1. Configuration Loading -Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: +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`, `user_skill_level` +- `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. Route to Validate Max-Parallel Workflow -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. +"**Validate Max-Parallel Mode: Validating an existing workflow against BMAD standards using maximum parallel execution.**" + +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 `{validateWorkflow}` (steps-v/step-01-validate-max-mode.md) diff --git a/_bmad/bmb/workflows/create-workflow/workflow.md b/_bmad/bmb/workflows/workflow/workflow-validate-workflow.md similarity index 71% rename from _bmad/bmb/workflows/create-workflow/workflow.md rename to _bmad/bmb/workflows/workflow/workflow-validate-workflow.md index 568edc8..ee0a756 100644 --- a/_bmad/bmb/workflows/create-workflow/workflow.md +++ b/_bmad/bmb/workflows/workflow/workflow-validate-workflow.md @@ -1,14 +1,15 @@ --- -name: create-workflow -description: Create structured standalone workflows using markdown-based step architecture +name: validate-workflow +description: Run validation check on BMAD workflows against best practices web_bundle: true +validateWorkflow: './steps-v/step-01-validate.md' --- -# Create Workflow +# Validate Workflow -**Goal:** Create structured, repeatable standalone workflows through collaborative conversation and step-by-step guidance. +**Goal:** Validate existing workflows against BMAD standards through comprehensive review. -**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. +**Your Role:** Validation Architect and Quality Assurance Specialist. You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. --- @@ -53,7 +54,12 @@ 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. Route to Validate Workflow -Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. +"**Validate Mode: Validating an existing workflow against BMAD standards.**" + +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 `{validateWorkflow}` (steps-v/step-01-validate.md) diff --git a/_bmad/bmgd/agents/game-architect.md b/_bmad/bmgd/agents/game-architect.md deleted file mode 100644 index 59d4d6d..0000000 --- a/_bmad/bmgd/agents/game-architect.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -name: "game architect" -description: "Game Architect" ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/_bmad/bmgd/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - - Remember: user's name is {user_name} - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` - When creating architecture, validate against GDD pillars and target platform constraints - Always document performance budgets and critical path decisions - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml": - - 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it - 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected - Display Menu items as the item dictates and in the order given. - Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml - - - Principal Game Systems Architect + Technical Director - Master architect with 20+ years shipping 30+ titles. Expert in distributed systems, engine design, multiplayer architecture, and technical leadership across all platforms. - Speaks like a wise sage from an RPG - calm, measured, uses architectural metaphors about building foundations and load-bearing walls - - Architecture is about delaying decisions until you have enough data - Build for tomorrow without over-engineering today - Hours of planning save weeks of refactoring hell - Every system must handle the hot path at 60fps - Avoid "Not Invented Here" syndrome, always check if work has been done before - - - [MH] Redisplay Menu Help - [CH] Chat with the Agent about anything - [WS] Get workflow status or initialize a workflow if not already done (optional) - [GA] Produce a Scale Adaptive Game Architecture - [PC] Create optimized project-context.md for AI agent consistency - [CC] Course Correction Analysis (when implementation is off-track) - [PM] Start Party Mode - [DA] Dismiss Agent - - -``` diff --git a/_bmad/bmgd/agents/game-designer.md b/_bmad/bmgd/agents/game-designer.md deleted file mode 100644 index 8d3aa56..0000000 --- a/_bmad/bmgd/agents/game-designer.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: "game designer" -description: "Game Designer" ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/_bmad/bmgd/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - - Remember: user's name is {user_name} - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` - When creating GDDs, always validate against game pillars and core loop - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml": - - 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it - 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected - Display Menu items as the item dictates and in the order given. - Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml - - - Lead Game Designer + Creative Vision Architect - Veteran designer with 15+ years crafting AAA and indie hits. Expert in mechanics, player psychology, narrative design, and systemic thinking. - Talks like an excited streamer - enthusiastic, asks about player motivations, celebrates breakthroughs with 'Let's GOOO!' - - Design what players want to FEEL, not what they say they want - Prototype fast - one hour of playtesting beats ten hours of discussion - Every mechanic must serve the core fantasy - - - [MH] Redisplay Menu Help - [CH] Chat with the Agent about anything - [WS] Get workflow status or initialize a workflow if not already done (optional) - [BG] Brainstorm Game ideas and concepts - [GB] Create a Game Brief document - [GDD] Create a Game Design Document - [ND] Design narrative elements and story - [QP] Rapid game prototyping - test mechanics and ideas quickly - [PM] Start Party Mode - [DA] Dismiss Agent - - -``` diff --git a/_bmad/bmgd/agents/game-dev.md b/_bmad/bmgd/agents/game-dev.md deleted file mode 100644 index 38eae25..0000000 --- a/_bmad/bmgd/agents/game-dev.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -name: "game dev" -description: "Game Developer" ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/_bmad/bmgd/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - - Remember: user's name is {user_name} - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` - When running *dev-story, follow story acceptance criteria exactly and validate with tests - Always check for performance implications on game loop code - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml": - - 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it - 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected - Display Menu items as the item dictates and in the order given. - Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml - - - Senior Game Developer + Technical Implementation Specialist - Battle-hardened dev with expertise in Unity, Unreal, and custom engines. Ten years shipping across mobile, console, and PC. Writes clean, performant code. - Speaks like a speedrunner - direct, milestone-focused, always optimizing for the fastest path to ship - - 60fps is non-negotiable - Write code designers can iterate without fear - Ship early, ship often, iterate on player feedback - Red-green-refactor: tests first, implementation second - - - [MH] Redisplay Menu Help - [CH] Chat with the Agent about anything - [WS] Get workflow status or check current sprint progress (optional) - [DS] Execute Dev Story workflow, implementing tasks and tests - [CR] Perform a thorough clean context QA code review on a story flagged Ready for Review - [QD] Flexible game development - implement features with game-specific considerations - [QP] Rapid game prototyping - test mechanics and ideas quickly - [AE] Advanced elicitation techniques to challenge the LLM to get better results - [PM] Start Party Mode - [DA] Dismiss Agent - - -``` diff --git a/_bmad/bmgd/agents/game-qa.md b/_bmad/bmgd/agents/game-qa.md deleted file mode 100644 index 086497b..0000000 --- a/_bmad/bmgd/agents/game-qa.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -name: "game qa" -description: "Game QA Architect" ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/_bmad/bmgd/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - - Remember: user's name is {user_name} - Consult {project-root}/_bmad/bmgd/gametest/qa-index.csv to select knowledge fragments under knowledge/ and load only the files needed for the current task - Load the referenced fragment(s) from {project-root}/_bmad/bmgd/gametest/knowledge/ before giving recommendations - Cross-check recommendations with the current official Unity Test Framework, Unreal Automation, or Godot GUT documentation - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml": - - 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it - 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected - Display Menu items as the item dictates and in the order given. - Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml - - - Game QA Architect + Test Automation Specialist - Senior QA architect with 12+ years in game testing across Unity, Unreal, and Godot. Expert in automated testing frameworks, performance profiling, and shipping bug-free games on console, PC, and mobile. - Speaks like GLaDOS, the AI from Valve's 'Portal' series. Runs tests because we can. 'Trust, but verify with tests.' - - Test what matters: gameplay feel, performance, progression - Automated tests catch regressions, humans catch fun problems - Every shipped bug is a process failure, not a people failure - Flaky tests are worse than no tests - they erode trust - Profile before optimize, test before ship - - - [MH] Redisplay Menu Help - [CH] Chat with the Agent about anything - [WS] Get workflow status or check current project state (optional) - [TF] Initialize game test framework (Unity/Unreal/Godot) - [TD] Create comprehensive game test scenarios - [TA] Generate automated game tests - [PP] Create structured playtesting plan - [PT] Design performance testing strategy - [TR] Review test quality and coverage - [AE] Advanced elicitation techniques to challenge the LLM to get better results - [PM] Start Party Mode - [DA] Dismiss Agent - - -``` diff --git a/_bmad/bmgd/agents/game-scrum-master.md b/_bmad/bmgd/agents/game-scrum-master.md deleted file mode 100644 index f5f1f17..0000000 --- a/_bmad/bmgd/agents/game-scrum-master.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -name: "game scrum master" -description: "Game Dev Scrum Master" ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/_bmad/bmgd/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - - Remember: user's name is {user_name} - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` - When running *create-story for game features, use GDD, Architecture, and Tech Spec to generate complete draft stories without elicitation, focusing on playable outcomes. - Generate complete story drafts from existing documentation without additional elicitation - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml": - - 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When command has: validate-workflow="path/to/workflow.yaml" - 1. You MUST LOAD the file at: {project-root}/_bmad/core/tasks/validate-workflow.xml - 2. READ its entire contents and EXECUTE all instructions in that file - 3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist - 4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify - - - When menu item has: data="path/to/file.json|yaml|yml|csv|xml" - Load the file first, parse according to extension - Make available as {data} variable to subsequent handler operations - - - - When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it - 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected - Display Menu items as the item dictates and in the order given. - Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml - - - Game Development Scrum Master + Sprint Orchestrator - Certified Scrum Master specializing in game dev workflows. Expert at coordinating multi-disciplinary teams and translating GDDs into actionable stories. - Talks in game terminology - milestones are save points, handoffs are level transitions, blockers are boss fights - - Every sprint delivers playable increments - Clean separation between design and implementation - Keep the team moving through each phase - Stories are single source of truth for implementation - - - [MH] Redisplay Menu Help - [CH] Chat with the Agent about anything - [WS] Get workflow status or initialize a workflow if not already done (optional) - [SP] Generate or update sprint-status.yaml from epic files (Required after GDD+Epics are created) - [SS] View sprint progress, surface risks, and get next action recommendation - [CS] Create Story with direct ready-for-dev marking (Required to prepare stories for development) - [VS] Validate Story Draft with Independent Review (Highly Recommended) - [ER] Facilitate team retrospective after a game development epic is completed - [CC] Navigate significant changes during game dev sprint (When implementation is off-track) - [AE] Advanced elicitation techniques to challenge the LLM to get better results - [PM] Start Party Mode - [DA] Dismiss Agent - - -``` diff --git a/_bmad/bmgd/agents/game-solo-dev.md b/_bmad/bmgd/agents/game-solo-dev.md deleted file mode 100644 index 6516412..0000000 --- a/_bmad/bmgd/agents/game-solo-dev.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: "game solo dev" -description: "Game Solo Dev" ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/_bmad/bmgd/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - - Remember: user's name is {user_name} - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match - On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml": - - 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item or handler has: exec="path/to/file.md": - 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise - 2. Read the complete file and follow all instructions within it - 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. - Stay in character until exit selected - Display Menu items as the item dictates and in the order given. - Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml - - - Elite Indie Game Developer + Quick Flow Specialist - Indie is a battle-hardened solo game developer who ships complete games from concept to launch. Expert in Unity, Unreal, and Godot, they've shipped titles across mobile, PC, and console. Lives and breathes the Quick Flow workflow - prototyping fast, iterating faster, and shipping before the hype dies. No team politics, no endless meetings - just pure, focused game development. - Direct, confident, and gameplay-focused. Uses dev slang, thinks in game feel and player experience. Every response moves the game closer to ship. 'Does it feel good? Ship it.' - - Prototype fast, fail fast, iterate faster. Quick Flow is the indie way. - A playable build beats a perfect design doc. Ship early, playtest often. - 60fps is non-negotiable. Performance is a feature. - The core loop must be fun before anything else matters. - - - [MH] Redisplay Menu Help - [CH] Chat with the Agent about anything - [WS] Get workflow status or check current project state (optional) - [QP] Rapid prototype to test if the mechanic is fun (Start here for new ideas) - [QD] Implement features end-to-end solo with game-specific considerations - [TS] Architect a technical spec with implementation-ready stories - [CR] Review code quality (use fresh context for best results) - [TF] Set up automated testing for your game engine - [AE] Advanced elicitation techniques to challenge the LLM to get better results - [PM] Start Party Mode - [DA] Dismiss Agent - - -``` diff --git a/_bmad/bmgd/config.yaml b/_bmad/bmgd/config.yaml deleted file mode 100644 index 2894c48..0000000 --- a/_bmad/bmgd/config.yaml +++ /dev/null @@ -1,21 +0,0 @@ -# BMGD Module Configuration -# Generated by BMAD installer -# Version: 6.0.0-alpha.22 -# Date: 2026-01-07T12:48:59.886Z - -project_name: Socialflow -game_dev_experience: intermediate -planning_artifacts: "{project-root}/_bmad-output/planning-artifacts" -implementation_artifacts: "{project-root}/_bmad-output/implementation-artifacts" -project_knowledge: "{project-root}/docs" -primary_platform: - - unity - - unreal - - godot - - other - -# Core Configuration Values -user_name: Michael -communication_language: Francais -document_output_language: francais -output_folder: "{project-root}/_bmad-output" diff --git a/_bmad/bmgd/gametest/knowledge/balance-testing.md b/_bmad/bmgd/gametest/knowledge/balance-testing.md deleted file mode 100644 index 9aad8eb..0000000 --- a/_bmad/bmgd/gametest/knowledge/balance-testing.md +++ /dev/null @@ -1,220 +0,0 @@ -# Balance Testing for Games - -## Overview - -Balance testing validates that your game's systems create fair, engaging, and appropriately challenging experiences. It covers difficulty, economy, progression, and competitive balance. - -## Types of Balance - -### Difficulty Balance - -- Is the game appropriately challenging? -- Does difficulty progress smoothly? -- Are difficulty spikes intentional? - -### Economy Balance - -- Is currency earned at the right rate? -- Are prices fair for items/upgrades? -- Can the economy be exploited? - -### Progression Balance - -- Does power growth feel satisfying? -- Are unlocks paced well? -- Is there meaningful choice in builds? - -### Competitive Balance - -- Are all options viable? -- Is there a dominant strategy? -- Do counters exist for strong options? - -## Balance Testing Methods - -### Spreadsheet Modeling - -Before implementation, model systems mathematically: - -- DPS calculations -- Time-to-kill analysis -- Economy simulations -- Progression curves - -### Automated Simulation - -Run thousands of simulated games: - -- AI vs AI battles -- Economy simulations -- Progression modeling -- Monte Carlo analysis - -### Telemetry Analysis - -Gather data from real players: - -- Win rates by character/weapon/strategy -- Currency flow analysis -- Completion rates by level -- Time to reach milestones - -### Expert Testing - -High-skill players identify issues: - -- Exploits and degenerate strategies -- Underpowered options -- Skill ceiling concerns -- Meta predictions - -## Key Balance Metrics - -### Combat Balance - -| Metric | Target | Red Flag | -| ------------------------- | ------------------- | ------------------------- | -| Win rate (symmetric) | 50% | <45% or >55% | -| Win rate (asymmetric) | Varies by design | Outliers by >10% | -| Time-to-kill | Design dependent | Too fast = no counterplay | -| Damage dealt distribution | Even across options | One option dominates | - -### Economy Balance - -| Metric | Target | Red Flag | -| -------------------- | -------------------- | ------------------------------- | -| Currency earned/hour | Design dependent | Too fast = trivializes content | -| Item purchase rate | Healthy distribution | Nothing bought = bad prices | -| Currency on hand | Healthy churn | Hoarding = nothing worth buying | -| Premium currency | Reasonable value | Pay-to-win concerns | - -### Progression Balance - -| Metric | Target | Red Flag | -| ------------------ | ---------------------- | ---------------------- | -| Time to max level | Design dependent | Too fast = no journey | -| Power growth curve | Smooth, satisfying | Flat periods = boring | -| Build diversity | Multiple viable builds | One "best" build | -| Content completion | Healthy progression | Walls or trivial skips | - -## Balance Testing Process - -### 1. Define Design Intent - -- What experience are you creating? -- What should feel powerful? -- What trade-offs should exist? - -### 2. Model Before Building - -- Spreadsheet the math -- Simulate outcomes -- Identify potential issues - -### 3. Test Incrementally - -- Test each system in isolation -- Then test systems together -- Then test at scale - -### 4. Gather Data - -- Internal playtesting -- Telemetry from beta -- Expert feedback - -### 5. Iterate - -- Adjust based on data -- Re-test changes -- Document rationale - -## Common Balance Issues - -### Power Creep - -- **Symptom:** New content is always stronger -- **Cause:** Fear of releasing weak content -- **Fix:** Sidegrades over upgrades, periodic rebalancing - -### Dominant Strategy - -- **Symptom:** One approach beats all others -- **Cause:** Insufficient counters, math oversight -- **Fix:** Add counters, nerf dominant option, buff alternatives - -### Feast or Famine - -- **Symptom:** Players either crush or get crushed -- **Cause:** Snowball mechanics, high variance -- **Fix:** Comeback mechanics, reduce variance - -### Analysis Paralysis - -- **Symptom:** Too many options, players can't choose -- **Cause:** Over-complicated systems -- **Fix:** Simplify, provide recommendations - -## Balance Tools - -### Spreadsheets - -- Model DPS, TTK, economy -- Simulate progression -- Compare options side-by-side - -### Simulation Frameworks - -- Monte Carlo for variance -- AI bots for combat testing -- Economy simulations - -### Telemetry Systems - -- Track player choices -- Measure outcomes -- A/B test changes - -### Visualization - -- Graphs of win rates over time -- Heat maps of player deaths -- Flow charts of progression - -## Balance Testing Checklist - -### Pre-Launch - -- [ ] Core systems modeled in spreadsheets -- [ ] Internal playtesting complete -- [ ] No obvious dominant strategies -- [ ] Difficulty curve feels right -- [ ] Economy tested for exploits -- [ ] Progression pacing validated - -### Live Service - -- [ ] Telemetry tracking key metrics -- [ ] Regular balance reviews scheduled -- [ ] Player feedback channels monitored -- [ ] Hotfix process for critical issues -- [ ] Communication plan for changes - -## Communicating Balance Changes - -### Patch Notes Best Practices - -- Explain the "why" not just the "what" -- Use concrete numbers when possible -- Acknowledge player concerns -- Set expectations for future changes - -### Example - -``` -**Sword of Valor - Damage reduced from 100 to 85** -Win rate for Sword users was 58%, indicating it was -overperforming. This brings it in line with other weapons -while maintaining its identity as a high-damage option. -We'll continue monitoring and adjust if needed. -``` diff --git a/_bmad/bmgd/gametest/knowledge/certification-testing.md b/_bmad/bmgd/gametest/knowledge/certification-testing.md deleted file mode 100644 index 4e268f8..0000000 --- a/_bmad/bmgd/gametest/knowledge/certification-testing.md +++ /dev/null @@ -1,319 +0,0 @@ -# Platform Certification Testing Guide - -## Overview - -Certification testing ensures games meet platform holder requirements (Sony TRC, Microsoft XR, Nintendo Guidelines). Failing certification delays launch and costs money—test thoroughly before submission. - -## Platform Requirements Overview - -### Major Platforms - -| Platform | Requirements Doc | Submission Portal | -| --------------- | -------------------------------------- | ------------------------- | -| PlayStation | TRC (Technical Requirements Checklist) | PlayStation Partners | -| Xbox | XR (Xbox Requirements) | Xbox Partner Center | -| Nintendo Switch | Guidelines | Nintendo Developer Portal | -| Steam | Guidelines (less strict) | Steamworks | -| iOS | App Store Guidelines | App Store Connect | -| Android | Play Store Policies | Google Play Console | - -## Common Certification Categories - -### Account and User Management - -``` -REQUIREMENT: User Switching - GIVEN user is playing game - WHEN system-level user switch occurs - THEN game handles transition gracefully - AND no data corruption - AND correct user data loads - -REQUIREMENT: Guest Accounts - GIVEN guest user plays game - WHEN guest makes progress - THEN progress is not saved to other accounts - AND appropriate warnings displayed - -REQUIREMENT: Parental Controls - GIVEN parental controls restrict content - WHEN restricted content is accessed - THEN content is blocked or modified - AND appropriate messaging shown -``` - -### System Events - -``` -REQUIREMENT: Suspend/Resume (PS4/PS5) - GIVEN game is running - WHEN console enters rest mode - AND console wakes from rest mode - THEN game resumes correctly - AND network reconnects if needed - AND no audio/visual glitches - -REQUIREMENT: Controller Disconnect - GIVEN player is in gameplay - WHEN controller battery dies - THEN game pauses immediately - AND reconnect prompt appears - AND gameplay resumes when connected - -REQUIREMENT: Storage Full - GIVEN storage is nearly full - WHEN game attempts save - THEN graceful error handling - AND user informed of issue - AND no data corruption -``` - -### Network Requirements - -``` -REQUIREMENT: PSN/Xbox Live Unavailable - GIVEN online features - WHEN platform network is unavailable - THEN offline features still work - AND appropriate error messages - AND no crashes - -REQUIREMENT: Network Transition - GIVEN active online session - WHEN network connection lost - THEN graceful handling - AND reconnection attempted - AND user informed of status - -REQUIREMENT: NAT Type Handling - GIVEN various NAT configurations - WHEN multiplayer is attempted - THEN appropriate feedback on connectivity - AND fallback options offered -``` - -### Save Data - -``` -REQUIREMENT: Save Data Integrity - GIVEN save data exists - WHEN save is loaded - THEN data is validated - AND corrupted data handled gracefully - AND no crashes on invalid data - -REQUIREMENT: Cloud Save Sync - GIVEN cloud saves enabled - WHEN save conflict occurs - THEN user chooses which to keep - AND no silent data loss - -REQUIREMENT: Save Data Portability (PS4→PS5) - GIVEN save from previous generation - WHEN loaded on current generation - THEN data migrates correctly - AND no features lost -``` - -## Platform-Specific Requirements - -### PlayStation (TRC) - -| Requirement | Description | Priority | -| ----------- | --------------------------- | -------- | -| TRC R4010 | Suspend/resume handling | Critical | -| TRC R4037 | User switching | Critical | -| TRC R4062 | Parental controls | Critical | -| TRC R4103 | PS VR comfort ratings | VR only | -| TRC R4120 | DualSense haptics standards | PS5 | -| TRC R5102 | PSN sign-in requirements | Online | - -### Xbox (XR) - -| Requirement | Description | Priority | -| ----------- | ----------------------------- | ----------- | -| XR-015 | Title timeout handling | Critical | -| XR-045 | User sign-out handling | Critical | -| XR-067 | Active user requirement | Critical | -| XR-074 | Quick Resume support | Series X/S | -| XR-115 | Xbox Accessibility Guidelines | Recommended | - -### Nintendo Switch - -| Requirement | Description | Priority | -| ------------------ | ------------------- | -------- | -| Docked/Handheld | Seamless transition | Critical | -| Joy-Con detachment | Controller handling | Critical | -| Home button | Immediate response | Critical | -| Screenshots/Video | Proper support | Required | -| Sleep mode | Resume correctly | Critical | - -## Automated Test Examples - -### System Event Testing - -```cpp -// Unreal - Suspend/Resume Test -IMPLEMENT_SIMPLE_AUTOMATION_TEST( - FSuspendResumeTest, - "Certification.System.SuspendResume", - EAutomationTestFlags::ApplicationContextMask | EAutomationTestFlags::ProductFilter -) - -bool FSuspendResumeTest::RunTest(const FString& Parameters) -{ - // Get game state before suspend - FGameState StateBefore = GetCurrentGameState(); - - // Simulate suspend - FCoreDelegates::ApplicationWillEnterBackgroundDelegate.Broadcast(); - - // Simulate resume - FCoreDelegates::ApplicationHasEnteredForegroundDelegate.Broadcast(); - - // Verify state matches - FGameState StateAfter = GetCurrentGameState(); - - TestEqual("Player position preserved", - StateAfter.PlayerPosition, StateBefore.PlayerPosition); - TestEqual("Game progress preserved", - StateAfter.Progress, StateBefore.Progress); - - return true; -} -``` - -```csharp -// Unity - Controller Disconnect Test -[UnityTest] -public IEnumerator ControllerDisconnect_ShowsPauseMenu() -{ - // Simulate gameplay - GameManager.Instance.StartGame(); - yield return new WaitForSeconds(1f); - - // Simulate controller disconnect - InputSystem.DisconnectDevice(Gamepad.current); - yield return null; - - // Verify pause menu shown - Assert.IsTrue(PauseMenu.IsVisible, "Pause menu should appear"); - Assert.IsTrue(Time.timeScale == 0, "Game should be paused"); - - // Simulate reconnect - InputSystem.ReconnectDevice(Gamepad.current); - yield return null; - - // Verify prompt appears - Assert.IsTrue(ReconnectPrompt.IsVisible); -} -``` - -```gdscript -# Godot - Save Corruption Test -func test_corrupted_save_handling(): - # Create corrupted save file - var file = FileAccess.open("user://save_corrupt.dat", FileAccess.WRITE) - file.store_string("CORRUPTED_GARBAGE_DATA") - file.close() - - # Attempt to load - var result = SaveManager.load("save_corrupt") - - # Should handle gracefully - assert_null(result, "Should return null for corrupted save") - assert_false(OS.has_feature("crashed"), "Should not crash") - - # Should show user message - var message_shown = ErrorDisplay.current_message != "" - assert_true(message_shown, "Should inform user of corruption") -``` - -## Pre-Submission Checklist - -### General Requirements - -- [ ] Game boots to interactive state within platform time limit -- [ ] Controller disconnect pauses game -- [ ] User sign-out handled correctly -- [ ] Save data validates on load -- [ ] No crashes in 8+ hours of automated testing -- [ ] Memory usage within platform limits -- [ ] Load times meet requirements - -### Platform Services - -- [ ] Achievements/Trophies work correctly -- [ ] Friends list integration works -- [ ] Invite system functions -- [ ] Store/DLC integration validated -- [ ] Cloud saves sync properly - -### Accessibility (Increasingly Required) - -- [ ] Text size options -- [ ] Colorblind modes -- [ ] Subtitle options -- [ ] Controller remapping -- [ ] Screen reader support (where applicable) - -### Content Compliance - -- [ ] Age rating displayed correctly -- [ ] Parental controls respected -- [ ] No prohibited content -- [ ] Required legal text present - -## Common Certification Failures - -| Issue | Platform | Fix | -| --------------------- | ------------ | ----------------------------------- | -| Home button delay | All consoles | Respond within required time | -| Controller timeout | PlayStation | Handle reactivation properly | -| Save on suspend | PlayStation | Don't save during suspend | -| User context loss | Xbox | Track active user correctly | -| Joy-Con drift | Switch | Proper deadzone handling | -| Background memory | Mobile | Release resources when backgrounded | -| Crash on corrupt data | All | Validate all loaded data | - -## Testing Matrix - -### Build Configurations to Test - -| Configuration | Scenarios | -| --------------- | ----------------------- | -| First boot | No save data exists | -| Return user | Save data present | -| Upgrade path | Previous version save | -| Fresh install | After uninstall | -| Low storage | Minimum space available | -| Network offline | No connectivity | - -### Hardware Variants - -| Platform | Variants to Test | -| ----------- | ------------------------------- | -| PlayStation | PS4, PS4 Pro, PS5 | -| Xbox | One, One X, Series S, Series X | -| Switch | Docked, Handheld, Lite | -| PC | Min spec, recommended, high-end | - -## Best Practices - -### DO - -- Read platform requirements document thoroughly -- Test on actual hardware, not just dev kits -- Automate certification test scenarios -- Submit with extra time for re-submission -- Document all edge case handling -- Test with real user accounts - -### DON'T - -- Assume debug builds behave like retail -- Skip testing on oldest supported hardware -- Ignore platform-specific features -- Wait until last minute to test certification items -- Use placeholder content in submission build -- Skip testing with real platform services diff --git a/_bmad/bmgd/gametest/knowledge/compatibility-testing.md b/_bmad/bmgd/gametest/knowledge/compatibility-testing.md deleted file mode 100644 index 291bdfc..0000000 --- a/_bmad/bmgd/gametest/knowledge/compatibility-testing.md +++ /dev/null @@ -1,228 +0,0 @@ -# Compatibility Testing for Games - -## Overview - -Compatibility testing ensures your game works correctly across different hardware, operating systems, and configurations that players use. - -## Types of Compatibility Testing - -### Hardware Compatibility - -- Graphics cards (NVIDIA, AMD, Intel) -- CPUs (Intel, AMD, Apple Silicon) -- Memory configurations -- Storage types (HDD, SSD, NVMe) -- Input devices (controllers, keyboards, mice) - -### Software Compatibility - -- Operating system versions -- Driver versions -- Background software conflicts -- Antivirus interference - -### Platform Compatibility - -- Console SKUs (PS5, Xbox Series X|S) -- PC storefronts (Steam, Epic, GOG) -- Mobile devices (iOS, Android) -- Cloud gaming services - -### Configuration Compatibility - -- Graphics settings combinations -- Resolution and aspect ratios -- Refresh rates (60Hz, 144Hz, etc.) -- HDR and color profiles - -## Testing Matrix - -### Minimum Hardware Matrix - -| Component | Budget | Mid-Range | High-End | -| --------- | -------- | --------- | -------- | -| GPU | GTX 1050 | RTX 3060 | RTX 4080 | -| CPU | i5-6400 | i7-10700 | i9-13900 | -| RAM | 8GB | 16GB | 32GB | -| Storage | HDD | SATA SSD | NVMe | - -### OS Matrix - -- Windows 10 (21H2, 22H2) -- Windows 11 (22H2, 23H2) -- macOS (Ventura, Sonoma) -- Linux (Ubuntu LTS, SteamOS) - -### Controller Matrix - -- Xbox Controller (wired, wireless, Elite) -- PlayStation DualSense -- Nintendo Pro Controller -- Generic XInput controllers -- Keyboard + Mouse - -## Testing Approach - -### 1. Define Supported Configurations - -- Minimum specifications -- Recommended specifications -- Officially supported platforms -- Known unsupported configurations - -### 2. Create Test Matrix - -- Prioritize common configurations -- Include edge cases -- Balance coverage vs. effort - -### 3. Execute Systematic Testing - -- Full playthrough on key configs -- Spot checks on edge cases -- Automated smoke tests where possible - -### 4. Document Issues - -- Repro steps with exact configuration -- Severity and frequency -- Workarounds if available - -## Common Compatibility Issues - -### Graphics Issues - -| Issue | Cause | Detection | -| -------------------- | ---------------------- | -------------------------------- | -| Crashes on launch | Driver incompatibility | Test on multiple GPUs | -| Rendering artifacts | Shader issues | Visual inspection across configs | -| Performance variance | Optimization gaps | Profile on multiple GPUs | -| Resolution bugs | Aspect ratio handling | Test non-standard resolutions | - -### Input Issues - -| Issue | Cause | Detection | -| ----------------------- | ------------------ | ------------------------------ | -| Controller not detected | Missing driver/API | Test all supported controllers | -| Wrong button prompts | Platform detection | Swap controllers mid-game | -| Stick drift handling | Deadzone issues | Test worn controllers | -| Mouse acceleration | Raw input issues | Test at different DPIs | - -### Audio Issues - -| Issue | Cause | Detection | -| -------------- | ---------------- | --------------------------- | -| No sound | Device selection | Test multiple audio devices | -| Crackling | Buffer issues | Test under CPU load | -| Wrong channels | Surround setup | Test stereo vs 5.1 vs 7.1 | - -## Platform-Specific Considerations - -### PC - -- **Steam:** Verify Steam Input, Steamworks features -- **Epic:** Test EOS features if used -- **GOG:** Test offline/DRM-free functionality -- **Game Pass:** Test Xbox services integration - -### Console - -- **Certification Requirements:** Study TRCs/XRs early -- **SKU Differences:** Test on all variants (S vs X) -- **External Storage:** Test on USB drives -- **Quick Resume:** Test suspend/resume cycles - -### Mobile - -- **Device Fragmentation:** Test across screen sizes -- **OS Versions:** Test min supported to latest -- **Permissions:** Test permission flows -- **App Lifecycle:** Test background/foreground - -## Automated Compatibility Testing - -### Smoke Tests - -```yaml -# Run on matrix of configurations -compatibility_test: - matrix: - os: [windows-10, windows-11, ubuntu-22] - gpu: [nvidia, amd, intel] - script: - - launch_game --headless - - verify_main_menu_reached - - check_no_errors -``` - -### Screenshot Comparison - -- Capture screenshots on different GPUs -- Compare for rendering differences -- Flag significant deviations - -### Cloud Testing Services - -- AWS Device Farm -- BrowserStack (web games) -- LambdaTest -- Sauce Labs - -## Compatibility Checklist - -### Pre-Alpha - -- [ ] Minimum specs defined -- [ ] Key platforms identified -- [ ] Test matrix created -- [ ] Test hardware acquired/rented - -### Alpha - -- [ ] Full playthrough on min spec -- [ ] Controller support verified -- [ ] Major graphics issues found -- [ ] Platform SDK integrated - -### Beta - -- [ ] All matrix configurations tested -- [ ] Edge cases explored -- [ ] Certification pre-check done -- [ ] Store page requirements met - -### Release - -- [ ] Final certification passed -- [ ] Known issues documented -- [ ] Workarounds communicated -- [ ] Support matrix published - -## Documenting Compatibility - -### System Requirements - -``` -MINIMUM: -- OS: Windows 10 64-bit -- Processor: Intel Core i5-6400 or AMD equivalent -- Memory: 8 GB RAM -- Graphics: NVIDIA GTX 1050 or AMD RX 560 -- Storage: 50 GB available space - -RECOMMENDED: -- OS: Windows 11 64-bit -- Processor: Intel Core i7-10700 or AMD equivalent -- Memory: 16 GB RAM -- Graphics: NVIDIA RTX 3060 or AMD RX 6700 XT -- Storage: 50 GB SSD -``` - -### Known Issues - -Maintain a public-facing list of known compatibility issues with: - -- Affected configurations -- Symptoms -- Workarounds -- Fix status diff --git a/_bmad/bmgd/gametest/knowledge/godot-testing.md b/_bmad/bmgd/gametest/knowledge/godot-testing.md deleted file mode 100644 index e282be2..0000000 --- a/_bmad/bmgd/gametest/knowledge/godot-testing.md +++ /dev/null @@ -1,376 +0,0 @@ -# Godot GUT Testing Guide - -## Overview - -GUT (Godot Unit Test) is the standard unit testing framework for Godot. It provides a full-featured testing framework with assertions, mocking, and CI integration. - -## Installation - -### Via Asset Library - -1. Open AssetLib in Godot -2. Search for "GUT" -3. Download and install -4. Enable the plugin in Project Settings - -### Via Git Submodule - -```bash -git submodule add https://github.com/bitwes/Gut.git addons/gut -``` - -## Project Structure - -``` -project/ -├── addons/ -│ └── gut/ -├── src/ -│ ├── player/ -│ │ └── player.gd -│ └── combat/ -│ └── damage_calculator.gd -└── tests/ - ├── unit/ - │ └── test_damage_calculator.gd - └── integration/ - └── test_player_combat.gd -``` - -## Basic Test Structure - -### Simple Test Class - -```gdscript -# tests/unit/test_damage_calculator.gd -extends GutTest - -var calculator: DamageCalculator - -func before_each(): - calculator = DamageCalculator.new() - -func after_each(): - calculator.free() - -func test_calculate_base_damage(): - var result = calculator.calculate(100.0, 1.0) - assert_eq(result, 100.0, "Base damage should equal input") - -func test_calculate_critical_hit(): - var result = calculator.calculate(100.0, 2.0) - assert_eq(result, 200.0, "Critical hit should double damage") - -func test_calculate_with_zero_multiplier(): - var result = calculator.calculate(100.0, 0.0) - assert_eq(result, 0.0, "Zero multiplier should result in zero damage") -``` - -### Parameterized Tests - -```gdscript -func test_damage_scenarios(): - var scenarios = [ - {"base": 100.0, "mult": 1.0, "expected": 100.0}, - {"base": 100.0, "mult": 2.0, "expected": 200.0}, - {"base": 50.0, "mult": 1.5, "expected": 75.0}, - {"base": 0.0, "mult": 2.0, "expected": 0.0}, - ] - - for scenario in scenarios: - var result = calculator.calculate(scenario.base, scenario.mult) - assert_eq( - result, - scenario.expected, - "Base %s * %s should equal %s" % [ - scenario.base, scenario.mult, scenario.expected - ] - ) -``` - -## Testing Nodes - -### Scene Testing - -```gdscript -# tests/integration/test_player.gd -extends GutTest - -var player: Player -var player_scene = preload("res://src/player/player.tscn") - -func before_each(): - player = player_scene.instantiate() - add_child(player) - -func after_each(): - player.queue_free() - -func test_player_initial_health(): - assert_eq(player.health, 100, "Player should start with 100 health") - -func test_player_takes_damage(): - player.take_damage(30) - assert_eq(player.health, 70, "Health should be reduced by damage") - -func test_player_dies_at_zero_health(): - player.take_damage(100) - assert_true(player.is_dead, "Player should be dead at 0 health") -``` - -### Testing with Signals - -```gdscript -func test_damage_emits_signal(): - watch_signals(player) - - player.take_damage(10) - - assert_signal_emitted(player, "health_changed") - assert_signal_emit_count(player, "health_changed", 1) - -func test_death_emits_signal(): - watch_signals(player) - - player.take_damage(100) - - assert_signal_emitted(player, "died") -``` - -### Testing with Await - -```gdscript -func test_attack_cooldown(): - player.attack() - assert_true(player.is_attacking) - - # Wait for cooldown - await get_tree().create_timer(player.attack_cooldown).timeout - - assert_false(player.is_attacking) - assert_true(player.can_attack) -``` - -## Mocking and Doubles - -### Creating Doubles - -```gdscript -func test_enemy_uses_pathfinding(): - var mock_pathfinding = double(Pathfinding).new() - stub(mock_pathfinding, "find_path").to_return([Vector2(0, 0), Vector2(10, 10)]) - - var enemy = Enemy.new() - enemy.pathfinding = mock_pathfinding - - enemy.move_to(Vector2(10, 10)) - - assert_called(mock_pathfinding, "find_path") -``` - -### Partial Doubles - -```gdscript -func test_player_inventory(): - var player_double = partial_double(Player).new() - stub(player_double, "save_to_disk").to_do_nothing() - - player_double.add_item("sword") - - assert_eq(player_double.inventory.size(), 1) - assert_called(player_double, "save_to_disk") -``` - -## Physics Testing - -### Testing Collision - -```gdscript -func test_projectile_hits_enemy(): - var projectile = Projectile.new() - var enemy = Enemy.new() - - add_child(projectile) - add_child(enemy) - - projectile.global_position = Vector2(0, 0) - enemy.global_position = Vector2(100, 0) - - projectile.velocity = Vector2(200, 0) - - # Simulate physics frames - for i in range(60): - await get_tree().physics_frame - - assert_true(enemy.was_hit, "Enemy should be hit by projectile") - - projectile.queue_free() - enemy.queue_free() -``` - -### Testing Area2D - -```gdscript -func test_pickup_collected(): - var pickup = Pickup.new() - var player = player_scene.instantiate() - - add_child(pickup) - add_child(player) - - pickup.global_position = Vector2(50, 50) - player.global_position = Vector2(50, 50) - - # Wait for physics to process overlap - await get_tree().physics_frame - await get_tree().physics_frame - - assert_true(pickup.is_queued_for_deletion(), "Pickup should be collected") - - player.queue_free() -``` - -## Input Testing - -### Simulating Input - -```gdscript -func test_jump_on_input(): - var input_event = InputEventKey.new() - input_event.keycode = KEY_SPACE - input_event.pressed = true - - Input.parse_input_event(input_event) - await get_tree().process_frame - - player._unhandled_input(input_event) - - assert_true(player.is_jumping, "Player should jump on space press") -``` - -### Testing Input Actions - -```gdscript -func test_attack_action(): - # Simulate action press - Input.action_press("attack") - await get_tree().process_frame - - player._process(0.016) - - assert_true(player.is_attacking) - - Input.action_release("attack") -``` - -## Resource Testing - -### Testing Custom Resources - -```gdscript -func test_weapon_stats_resource(): - var weapon = WeaponStats.new() - weapon.base_damage = 10.0 - weapon.attack_speed = 2.0 - - assert_eq(weapon.dps, 20.0, "DPS should be damage * speed") - -func test_save_load_resource(): - var original = PlayerData.new() - original.level = 5 - original.gold = 1000 - - ResourceSaver.save(original, "user://test_save.tres") - var loaded = ResourceLoader.load("user://test_save.tres") - - assert_eq(loaded.level, 5) - assert_eq(loaded.gold, 1000) - - DirAccess.remove_absolute("user://test_save.tres") -``` - -## GUT Configuration - -### gut_config.json - -```json -{ - "dirs": ["res://tests/"], - "include_subdirs": true, - "prefix": "test_", - "suffix": ".gd", - "should_exit": true, - "should_exit_on_success": true, - "log_level": 1, - "junit_xml_file": "results.xml", - "font_size": 16 -} -``` - -## CI Integration - -### Command Line Execution - -```bash -# Run all tests -godot --headless -s addons/gut/gut_cmdln.gd - -# Run specific tests -godot --headless -s addons/gut/gut_cmdln.gd \ - -gdir=res://tests/unit \ - -gprefix=test_ - -# With JUnit output -godot --headless -s addons/gut/gut_cmdln.gd \ - -gjunit_xml_file=results.xml -``` - -### GitHub Actions - -```yaml -test: - runs-on: ubuntu-latest - container: - image: barichello/godot-ci:4.2 - steps: - - uses: actions/checkout@v4 - - - name: Run Tests - run: | - godot --headless -s addons/gut/gut_cmdln.gd \ - -gjunit_xml_file=results.xml - - - name: Publish Results - uses: mikepenz/action-junit-report@v4 - with: - report_paths: results.xml -``` - -## Best Practices - -### DO - -- Use `before_each`/`after_each` for setup/teardown -- Free nodes after tests to prevent leaks -- Use meaningful assertion messages -- Group related tests in the same file -- Use `watch_signals` for signal testing -- Await physics frames when testing physics - -### DON'T - -- Don't test Godot's built-in functionality -- Don't rely on execution order between test files -- Don't leave orphan nodes -- Don't use `yield` (use `await` in Godot 4) -- Don't test private methods directly - -## Troubleshooting - -| Issue | Cause | Fix | -| -------------------- | ------------------ | ------------------------------------ | -| Tests not found | Wrong prefix/path | Check gut_config.json | -| Orphan nodes warning | Missing cleanup | Add `queue_free()` in `after_each` | -| Signal not detected | Signal not watched | Call `watch_signals()` before action | -| Physics not working | Missing frames | Await `physics_frame` | -| Flaky tests | Timing issues | Use proper await/signals | diff --git a/_bmad/bmgd/gametest/knowledge/input-testing.md b/_bmad/bmgd/gametest/knowledge/input-testing.md deleted file mode 100644 index ed4f7b3..0000000 --- a/_bmad/bmgd/gametest/knowledge/input-testing.md +++ /dev/null @@ -1,315 +0,0 @@ -# Input Testing Guide - -## Overview - -Input testing validates that all supported input devices work correctly across platforms. Poor input handling frustrates players instantly—responsive, accurate input is foundational to game feel. - -## Input Categories - -### Device Types - -| Device | Platforms | Key Concerns | -| ----------------- | -------------- | ----------------------------------- | -| Keyboard + Mouse | PC | Key conflicts, DPI sensitivity | -| Gamepad (Xbox/PS) | PC, Console | Deadzone, vibration, button prompts | -| Touch | Mobile, Switch | Multi-touch, gesture recognition | -| Motion Controls | Switch, VR | Calibration, drift, fatigue | -| Specialty | Various | Flight sticks, wheels, fight sticks | - -### Input Characteristics - -| Characteristic | Description | Test Focus | -| -------------- | ---------------------------- | -------------------------------- | -| Responsiveness | Input-to-action delay | Should feel instant (< 100ms) | -| Accuracy | Input maps to correct action | No ghost inputs or missed inputs | -| Consistency | Same input = same result | Deterministic behavior | -| Accessibility | Alternative input support | Remapping, assist options | - -## Test Scenarios - -### Keyboard and Mouse - -``` -SCENARIO: All Keybinds Functional - GIVEN default keyboard bindings - WHEN each bound key is pressed - THEN corresponding action triggers - AND no key conflicts exist - -SCENARIO: Key Remapping - GIVEN player remaps "Jump" from Space to F - WHEN F is pressed - THEN jump action triggers - AND Space no longer triggers jump - AND remapping persists after restart - -SCENARIO: Mouse Sensitivity - GIVEN sensitivity set to 5 (mid-range) - WHEN mouse moves 10cm - THEN camera rotation matches expected degrees - AND movement feels consistent at different frame rates - -SCENARIO: Mouse Button Support - GIVEN mouse with 5+ buttons - WHEN side buttons are pressed - THEN they can be bound to actions - AND they function correctly in gameplay -``` - -### Gamepad - -``` -SCENARIO: Analog Stick Deadzone - GIVEN controller with slight stick drift - WHEN stick is in neutral position - THEN no movement occurs (deadzone filters drift) - AND intentional small movements still register - -SCENARIO: Trigger Pressure - GIVEN analog triggers - WHEN trigger is partially pressed - THEN partial values are read (e.g., 0.5 for half-press) - AND full press reaches 1.0 - -SCENARIO: Controller Hot-Swap - GIVEN game running with keyboard - WHEN gamepad is connected - THEN input prompts switch to gamepad icons - AND gamepad input works immediately - AND keyboard still works if used - -SCENARIO: Vibration Feedback - GIVEN rumble-enabled controller - WHEN damage is taken - THEN controller vibrates appropriately - AND vibration intensity matches damage severity -``` - -### Touch Input - -``` -SCENARIO: Multi-Touch Accuracy - GIVEN virtual joystick and buttons - WHEN left thumb on joystick AND right thumb on button - THEN both inputs register simultaneously - AND no interference between touch points - -SCENARIO: Gesture Recognition - GIVEN swipe-to-attack mechanic - WHEN player swipes right - THEN attack direction matches swipe - AND swipe is distinguished from tap - -SCENARIO: Touch Target Size - GIVEN minimum touch target of 44x44 points - WHEN buttons are placed - THEN all interactive elements meet minimum size - AND elements have adequate spacing -``` - -## Platform-Specific Testing - -### PC - -- Multiple keyboard layouts (QWERTY, AZERTY, QWERTZ) -- Different mouse DPI settings (400-3200+) -- Multiple monitors (cursor confinement) -- Background application conflicts -- Steam Input API integration - -### Console - -| Platform | Specific Tests | -| ----------- | ------------------------------------------ | -| PlayStation | Touchpad, adaptive triggers, haptics | -| Xbox | Impulse triggers, Elite controller paddles | -| Switch | Joy-Con detachment, gyro, HD rumble | - -### Mobile - -- Different screen sizes and aspect ratios -- Notch/cutout avoidance -- External controller support -- Apple MFi / Android gamepad compatibility - -## Automated Test Examples - -### Unity - -```csharp -using UnityEngine.InputSystem; - -[UnityTest] -public IEnumerator Movement_WithGamepad_RespondsToStick() -{ - var gamepad = InputSystem.AddDevice(); - - yield return null; - - // Simulate stick input - Set(gamepad.leftStick, new Vector2(1, 0)); - yield return new WaitForSeconds(0.1f); - - Assert.Greater(player.transform.position.x, 0f, - "Player should move right"); - - InputSystem.RemoveDevice(gamepad); -} - -[UnityTest] -public IEnumerator InputLatency_UnderLoad_StaysAcceptable() -{ - float inputTime = Time.realtimeSinceStartup; - bool actionTriggered = false; - - player.OnJump += () => { - float latency = (Time.realtimeSinceStartup - inputTime) * 1000; - Assert.Less(latency, 100f, "Input latency should be under 100ms"); - actionTriggered = true; - }; - - var keyboard = InputSystem.AddDevice(); - Press(keyboard.spaceKey); - - yield return new WaitForSeconds(0.2f); - - Assert.IsTrue(actionTriggered, "Jump should have triggered"); -} - -[Test] -public void Deadzone_FiltersSmallInputs() -{ - var settings = new InputSettings { stickDeadzone = 0.2f }; - - // Input below deadzone - var filtered = InputProcessor.ApplyDeadzone(new Vector2(0.1f, 0.1f), settings); - Assert.AreEqual(Vector2.zero, filtered); - - // Input above deadzone - filtered = InputProcessor.ApplyDeadzone(new Vector2(0.5f, 0.5f), settings); - Assert.AreNotEqual(Vector2.zero, filtered); -} -``` - -### Unreal - -```cpp -bool FInputTest::RunTest(const FString& Parameters) -{ - // Test gamepad input mapping - APlayerController* PC = GetWorld()->GetFirstPlayerController(); - - // Simulate gamepad stick input - FInputKeyParams Params; - Params.Key = EKeys::Gamepad_LeftX; - Params.Delta = FVector(1.0f, 0, 0); - PC->InputKey(Params); - - // Verify movement - APawn* Pawn = PC->GetPawn(); - FVector Velocity = Pawn->GetVelocity(); - - TestTrue("Pawn should be moving", Velocity.SizeSquared() > 0); - - return true; -} -``` - -### Godot - -```gdscript -func test_input_action_mapping(): - # Verify action exists - assert_true(InputMap.has_action("jump")) - - # Simulate input - var event = InputEventKey.new() - event.keycode = KEY_SPACE - event.pressed = true - - Input.parse_input_event(event) - await get_tree().process_frame - - assert_true(Input.is_action_just_pressed("jump")) - -func test_gamepad_deadzone(): - var input = Vector2(0.15, 0.1) - var deadzone = 0.2 - - var processed = input_processor.apply_deadzone(input, deadzone) - - assert_eq(processed, Vector2.ZERO, "Small input should be filtered") - -func test_controller_hotswap(): - # Simulate controller connect - Input.joy_connection_changed(0, true) - await get_tree().process_frame - - var prompt_icon = ui.get_action_prompt("jump") - - assert_true(prompt_icon.texture.resource_path.contains("gamepad"), - "Should show gamepad prompts after controller connect") -``` - -## Accessibility Testing - -### Requirements Checklist - -- [ ] Full keyboard navigation (no mouse required) -- [ ] Remappable controls for all actions -- [ ] Button hold alternatives to rapid press -- [ ] Toggle options for hold actions -- [ ] One-handed control schemes -- [ ] Colorblind-friendly UI indicators -- [ ] Screen reader support for menus - -### Accessibility Test Scenarios - -``` -SCENARIO: Keyboard-Only Navigation - GIVEN mouse is disconnected - WHEN navigating through all menus - THEN all menu items are reachable via keyboard - AND focus indicators are clearly visible - -SCENARIO: Button Hold Toggle - GIVEN "sprint requires hold" is toggled OFF - WHEN sprint button is tapped once - THEN sprint activates - AND sprint stays active until tapped again - -SCENARIO: Reduced Button Mashing - GIVEN QTE assist mode enabled - WHEN QTE sequence appears - THEN single press advances sequence - AND no rapid input required -``` - -## Performance Metrics - -| Metric | Target | Maximum Acceptable | -| ----------------------- | --------------- | ------------------ | -| Input-to-render latency | < 50ms | 100ms | -| Polling rate match | 1:1 with device | No input loss | -| Deadzone processing | < 1ms | 5ms | -| Rebind save/load | < 100ms | 500ms | - -## Best Practices - -### DO - -- Test with actual hardware, not just simulated input -- Support simultaneous keyboard + gamepad -- Provide sensible default deadzones -- Show device-appropriate button prompts -- Allow complete control remapping -- Test at different frame rates - -### DON'T - -- Assume controller layout (Xbox vs PlayStation) -- Hard-code input mappings -- Ignore analog input precision -- Skip accessibility considerations -- Forget about input during loading/cutscenes -- Neglect testing with worn/drifting controllers diff --git a/_bmad/bmgd/gametest/knowledge/localization-testing.md b/_bmad/bmgd/gametest/knowledge/localization-testing.md deleted file mode 100644 index fd4b034..0000000 --- a/_bmad/bmgd/gametest/knowledge/localization-testing.md +++ /dev/null @@ -1,304 +0,0 @@ -# Localization Testing Guide - -## Overview - -Localization testing ensures games work correctly across languages, regions, and cultures. Beyond translation, it validates text display, cultural appropriateness, and regional compliance. - -## Test Categories - -### Linguistic Testing - -| Category | Focus | Examples | -| -------------------- | ----------------------- | ------------------------------ | -| Translation accuracy | Meaning preserved | Idioms, game terminology | -| Grammar/spelling | Language correctness | Verb tense, punctuation | -| Consistency | Same terms throughout | "Health" vs "HP" vs "Life" | -| Context | Meaning in game context | Item names, skill descriptions | - -### Functional Testing - -| Category | Focus | Examples | -| -------------- | ----------------------- | --------------------------- | -| Text display | Fits in UI | Button labels, dialog boxes | -| Font support | Characters render | CJK, Cyrillic, Arabic | -| Text expansion | Longer translations | German is ~30% longer | -| RTL support | Right-to-left languages | Arabic, Hebrew layouts | - -### Cultural Testing - -| Category | Focus | Examples | -| -------------------- | ------------------ | ------------------------- | -| Cultural sensitivity | Offensive content | Gestures, symbols, colors | -| Regional compliance | Legal requirements | Ratings, gambling laws | -| Date/time formats | Local conventions | DD/MM/YYYY vs MM/DD/YYYY | -| Number formats | Decimal separators | 1,000.00 vs 1.000,00 | - -## Test Scenarios - -### Text Display - -``` -SCENARIO: Text Fits UI Elements - GIVEN all localized strings - WHEN displayed in target language - THEN text fits within UI boundaries - AND no truncation or overflow occurs - AND text remains readable - -SCENARIO: Dynamic Text Insertion - GIVEN template "Player {name} scored {points} points" - WHEN name="Alexander" and points=1000 - THEN German: "Spieler Alexander hat 1.000 Punkte erzielt" - AND text fits UI element - AND variables are correctly formatted for locale - -SCENARIO: Plural Forms - GIVEN English "1 coin" / "5 coins" - WHEN displaying in Polish (4 plural forms) - THEN correct plural form is used - AND all plural forms are translated -``` - -### Character Support - -``` -SCENARIO: CJK Character Rendering - GIVEN Japanese localization - WHEN displaying text with kanji/hiragana/katakana - THEN all characters render correctly - AND no missing glyphs (tofu boxes) - AND line breaks respect CJK rules - -SCENARIO: Special Characters - GIVEN text with accented characters (é, ñ, ü) - WHEN displayed in-game - THEN all characters render correctly - AND sorting works correctly - -SCENARIO: User-Generated Content - GIVEN player can name character - WHEN name includes non-Latin characters - THEN name displays correctly - AND name saves/loads correctly - AND name appears correctly to other players -``` - -### Layout and Direction - -``` -SCENARIO: Right-to-Left Layout - GIVEN Arabic localization - WHEN viewing UI - THEN text reads right-to-left - AND UI elements mirror appropriately - AND numbers remain left-to-right - AND mixed content (Arabic + English) displays correctly - -SCENARIO: Text Expansion Accommodation - GIVEN English UI "OK" / "Cancel" buttons - WHEN localized to German "OK" / "Abbrechen" - THEN button expands or text size adjusts - AND button remains clickable - AND layout doesn't break -``` - -## Locale-Specific Formatting - -### Date and Time - -| Locale | Date Format | Time Format | -| ------ | -------------- | ----------- | -| en-US | 12/25/2024 | 3:30 PM | -| en-GB | 25/12/2024 | 15:30 | -| de-DE | 25.12.2024 | 15:30 Uhr | -| ja-JP | 2024年12月25日 | 15時30分 | - -### Numbers and Currency - -| Locale | Number | Currency | -| ------ | -------- | ---------- | -| en-US | 1,234.56 | $1,234.56 | -| de-DE | 1.234,56 | 1.234,56 € | -| fr-FR | 1 234,56 | 1 234,56 € | -| ja-JP | 1,234.56 | ¥1,235 | - -## Automated Test Examples - -### Unity - -```csharp -using UnityEngine.Localization; - -[Test] -public void Localization_AllKeysHaveTranslations([Values("en", "de", "ja", "zh-CN")] string locale) -{ - var stringTable = LocalizationSettings.StringDatabase - .GetTable("GameStrings", new Locale(locale)); - - foreach (var entry in stringTable) - { - Assert.IsFalse(string.IsNullOrEmpty(entry.Value.LocalizedValue), - $"Missing translation for '{entry.Key}' in {locale}"); - } -} - -[Test] -public void TextFits_AllUIElements() -{ - var languages = new[] { "en", "de", "fr", "ja" }; - - foreach (var lang in languages) - { - LocalizationSettings.SelectedLocale = new Locale(lang); - - foreach (var textElement in FindObjectsOfType()) - { - var rectTransform = textElement.GetComponent(); - var textComponent = textElement.GetComponent(); - - Assert.LessOrEqual( - textComponent.preferredWidth, - rectTransform.rect.width, - $"Text overflows in {lang}: {textElement.name}"); - } - } -} - -[TestCase("en", 1, "1 coin")] -[TestCase("en", 5, "5 coins")] -[TestCase("ru", 1, "1 монета")] -[TestCase("ru", 2, "2 монеты")] -[TestCase("ru", 5, "5 монет")] -public void Pluralization_ReturnsCorrectForm(string locale, int count, string expected) -{ - var result = Localization.GetPlural("coin", count, locale); - Assert.AreEqual(expected, result); -} -``` - -### Unreal - -```cpp -bool FLocalizationTest::RunTest(const FString& Parameters) -{ - TArray Cultures = {"en", "de", "ja", "ko"}; - - for (const FString& Culture : Cultures) - { - FInternationalization::Get().SetCurrentCulture(Culture); - - // Test critical strings exist - FText LocalizedText = NSLOCTEXT("Game", "StartButton", "Start"); - TestFalse( - FString::Printf(TEXT("Missing StartButton in %s"), *Culture), - LocalizedText.IsEmpty()); - - // Test number formatting - FText NumberText = FText::AsNumber(1234567); - TestTrue( - TEXT("Number should be formatted"), - NumberText.ToString().Len() > 7); // Has separators - } - - return true; -} -``` - -### Godot - -```gdscript -func test_all_translations_complete(): - var locales = ["en", "de", "ja", "es"] - var keys = TranslationServer.get_all_keys() - - for locale in locales: - TranslationServer.set_locale(locale) - for key in keys: - var translated = tr(key) - assert_ne(translated, key, - "Missing translation for '%s' in %s" % [key, locale]) - -func test_plural_forms(): - TranslationServer.set_locale("ru") - - assert_eq(tr_n("coin", "coins", 1), "1 монета") - assert_eq(tr_n("coin", "coins", 2), "2 монеты") - assert_eq(tr_n("coin", "coins", 5), "5 монет") - assert_eq(tr_n("coin", "coins", 21), "21 монета") - -func test_text_fits_buttons(): - var locales = ["en", "de", "fr"] - - for locale in locales: - TranslationServer.set_locale(locale) - await get_tree().process_frame # Allow UI update - - for button in get_tree().get_nodes_in_group("localized_buttons"): - var label = button.get_node("Label") - assert_lt(label.size.x, button.size.x, - "Button text overflows in %s: %s" % [locale, button.name]) -``` - -## Visual Verification Checklist - -### Text Display - -- [ ] No truncation in any language -- [ ] Consistent font sizing -- [ ] Proper line breaks -- [ ] No overlapping text - -### UI Layout - -- [ ] Buttons accommodate longer text -- [ ] Dialog boxes resize appropriately -- [ ] Menu items align correctly -- [ ] Scrollbars appear when needed - -### Cultural Elements - -- [ ] Icons are culturally appropriate -- [ ] Colors don't have negative connotations -- [ ] Gestures are region-appropriate -- [ ] No unintended political references - -## Regional Compliance - -### Ratings Requirements - -| Region | Rating Board | Special Requirements | -| ------------- | ------------ | ------------------------- | -| North America | ESRB | Content descriptors | -| Europe | PEGI | Age-appropriate icons | -| Japan | CERO | Strict content guidelines | -| Germany | USK | Violence restrictions | -| China | GRAC | Approval process | - -### Common Regional Issues - -| Issue | Regions Affected | Solution | -| ---------------- | ---------------- | ------------------------ | -| Blood color | Japan, Germany | Option for green/disable | -| Gambling imagery | Many regions | Remove or modify | -| Skulls/bones | China | Alternative designs | -| Nazi imagery | Germany | Remove entirely | - -## Best Practices - -### DO - -- Test with native speakers -- Plan for text expansion (reserve 30% extra space) -- Use placeholder text during development (Lorem ipsum-style) -- Support multiple input methods (IME for CJK) -- Test all language combinations (UI language + audio language) -- Validate string format parameters - -### DON'T - -- Hard-code strings in source code -- Assume left-to-right layout -- Concatenate translated strings -- Use machine translation without review -- Forget about date/time/number formatting -- Ignore cultural context of images and icons diff --git a/_bmad/bmgd/gametest/knowledge/multiplayer-testing.md b/_bmad/bmgd/gametest/knowledge/multiplayer-testing.md deleted file mode 100644 index 7ee8ddf..0000000 --- a/_bmad/bmgd/gametest/knowledge/multiplayer-testing.md +++ /dev/null @@ -1,322 +0,0 @@ -# Multiplayer Testing Guide - -## Overview - -Multiplayer testing validates network code, synchronization, and the player experience under real-world conditions. Network bugs are notoriously hard to reproduce—systematic testing is essential. - -## Test Categories - -### Synchronization Testing - -| Test Type | Description | Priority | -| ------------------- | ---------------------------------------- | -------- | -| State sync | All clients see consistent game state | P0 | -| Position sync | Character positions match across clients | P0 | -| Event ordering | Actions occur in correct sequence | P0 | -| Conflict resolution | Simultaneous actions handled correctly | P1 | -| Late join | New players sync correctly mid-game | P1 | - -### Network Conditions - -| Condition | Simulation Method | Test Focus | -| --------------- | ----------------- | ------------------------ | -| High latency | 200-500ms delay | Input responsiveness | -| Packet loss | 5-20% drop rate | State recovery | -| Jitter | Variable delay | Interpolation smoothness | -| Bandwidth limit | Throttle to 1Mbps | Data prioritization | -| Disconnection | Kill connection | Reconnection handling | - -## Test Scenarios - -### Basic Multiplayer - -``` -SCENARIO: Player Join/Leave - GIVEN host has started multiplayer session - WHEN Player 2 joins - THEN Player 2 appears in host's game - AND Player 1 appears in Player 2's game - AND player counts sync across all clients - -SCENARIO: State Synchronization - GIVEN 4 players in match - WHEN Player 1 picks up item at position (10, 5) - THEN item disappears for all players - AND Player 1's inventory updates for all players - AND no duplicate pickups possible - -SCENARIO: Combat Synchronization - GIVEN Player 1 attacks Player 2 - WHEN attack hits - THEN damage is consistent on all clients - AND hit effects play for all players - AND health updates sync within 100ms -``` - -### Network Degradation - -``` -SCENARIO: High Latency Gameplay - GIVEN 200ms latency between players - WHEN Player 1 moves forward - THEN movement is smooth on Player 1's screen - AND other players see interpolated movement - AND position converges within 500ms - -SCENARIO: Packet Loss Recovery - GIVEN 10% packet loss - WHEN important game event occurs (goal, kill, etc.) - THEN event is eventually delivered - AND game state remains consistent - AND no duplicate events processed - -SCENARIO: Player Disconnection - GIVEN Player 2 disconnects unexpectedly - WHEN 5 seconds pass - THEN other players are notified - AND Player 2's character handles gracefully (despawn/AI takeover) - AND game continues without crash -``` - -### Edge Cases - -``` -SCENARIO: Simultaneous Actions - GIVEN Player 1 and Player 2 grab same item simultaneously - WHEN both inputs arrive at server - THEN only one player receives item - AND other player sees consistent state - AND no item duplication - -SCENARIO: Host Migration - GIVEN host disconnects - WHEN migration begins - THEN new host is selected - AND game state transfers correctly - AND gameplay resumes within 10 seconds - -SCENARIO: Reconnection - GIVEN Player 2 disconnects temporarily - WHEN Player 2 reconnects within 60 seconds - THEN Player 2 rejoins same session - AND state is synchronized - AND progress is preserved -``` - -## Network Simulation Tools - -### Unity - -```csharp -// Using Unity Transport with Network Simulator -using Unity.Netcode; - -public class NetworkSimulator : MonoBehaviour -{ - [SerializeField] private int latencyMs = 100; - [SerializeField] private float packetLossPercent = 5f; - [SerializeField] private int jitterMs = 20; - - void Start() - { - var transport = NetworkManager.Singleton.GetComponent(); - var simulator = transport.GetSimulatorParameters(); - - simulator.PacketDelayMS = latencyMs; - simulator.PacketDropRate = (int)(packetLossPercent * 100); - simulator.PacketJitterMS = jitterMs; - } -} - -// Test -[UnityTest] -public IEnumerator Position_UnderLatency_ConvergesWithinThreshold() -{ - EnableNetworkSimulation(latencyMs: 200); - - // Move player - player1.Move(Vector3.forward * 10); - - yield return new WaitForSeconds(1f); - - // Check other client's view - var player1OnClient2 = client2.GetPlayerPosition(player1.Id); - var actualPosition = player1.transform.position; - - Assert.Less(Vector3.Distance(player1OnClient2, actualPosition), 0.5f); -} -``` - -### Unreal - -```cpp -// Using Network Emulation -void UNetworkTestHelper::EnableLatencySimulation(int32 LatencyMs) -{ - if (UNetDriver* NetDriver = GetWorld()->GetNetDriver()) - { - FPacketSimulationSettings Settings; - Settings.PktLag = LatencyMs; - Settings.PktLagVariance = LatencyMs / 10; - Settings.PktLoss = 0; - - NetDriver->SetPacketSimulationSettings(Settings); - } -} - -// Functional test for sync -void AMultiplayerSyncTest::StartTest() -{ - Super::StartTest(); - - // Spawn item on server - APickupItem* Item = GetWorld()->SpawnActor( - ItemClass, FVector(0, 0, 100)); - - // Wait for replication - FTimerHandle TimerHandle; - GetWorld()->GetTimerManager().SetTimer(TimerHandle, [this, Item]() - { - // Verify client has item - if (VerifyItemExistsOnAllClients(Item)) - { - FinishTest(EFunctionalTestResult::Succeeded, "Item replicated"); - } - else - { - FinishTest(EFunctionalTestResult::Failed, "Item not found on clients"); - } - }, 2.0f, false); -} -``` - -### Godot - -```gdscript -# Network simulation -extends Node - -var simulated_latency_ms := 0 -var packet_loss_percent := 0.0 - -func _ready(): - # Hook into network to simulate conditions - multiplayer.peer_packet_received.connect(_on_packet_received) - -func _on_packet_received(id: int, packet: PackedByteArray): - if packet_loss_percent > 0 and randf() < packet_loss_percent / 100: - return # Drop packet - - if simulated_latency_ms > 0: - await get_tree().create_timer(simulated_latency_ms / 1000.0).timeout - - _process_packet(id, packet) - -# Test -func test_position_sync_under_latency(): - NetworkSimulator.simulated_latency_ms = 200 - - # Move player on host - host_player.position = Vector3(100, 0, 100) - - await get_tree().create_timer(1.0).timeout - - # Check client view - var client_view_position = client.get_remote_player_position(host_player.id) - var distance = host_player.position.distance_to(client_view_position) - - assert_lt(distance, 1.0, "Position should converge within 1 unit") -``` - -## Dedicated Server Testing - -### Test Matrix - -| Scenario | Test Focus | -| --------------------- | ------------------------------------ | -| Server startup | Clean initialization, port binding | -| Client authentication | Login validation, session management | -| Server tick rate | Consistent updates under load | -| Maximum players | Performance at player cap | -| Server crash recovery | State preservation, reconnection | - -### Load Testing - -``` -SCENARIO: Maximum Players - GIVEN server configured for 64 players - WHEN 64 players connect - THEN all connections succeed - AND server tick rate stays above 60Hz - AND latency stays below 50ms - -SCENARIO: Stress Test - GIVEN 64 players performing actions simultaneously - WHEN running for 10 minutes - THEN no memory leaks - AND no desync events - AND server CPU below 80% -``` - -## Matchmaking Testing - -``` -SCENARIO: Skill-Based Matching - GIVEN players with skill ratings [1000, 1050, 2000, 2100] - WHEN matchmaking runs - THEN [1000, 1050] are grouped together - AND [2000, 2100] are grouped together - -SCENARIO: Region Matching - GIVEN players from US-East, US-West, EU - WHEN matchmaking runs - THEN players prefer same-region matches - AND cross-region only when necessary - AND latency is acceptable for all players - -SCENARIO: Queue Timeout - GIVEN player waiting in queue - WHEN 3 minutes pass without match - THEN matchmaking expands search criteria - AND player is notified of expanded search -``` - -## Security Testing - -| Vulnerability | Test Method | -| ---------------- | --------------------------- | -| Speed hacking | Validate movement on server | -| Teleportation | Check position delta limits | -| Damage hacking | Server-authoritative damage | -| Packet injection | Validate packet checksums | -| Replay attacks | Use unique session tokens | - -## Performance Metrics - -| Metric | Good | Acceptable | Poor | -| --------------------- | --------- | ---------- | ---------- | -| Round-trip latency | < 50ms | < 100ms | > 150ms | -| Sync delta | < 100ms | < 200ms | > 500ms | -| Packet loss tolerance | < 5% | < 10% | > 15% | -| Bandwidth per player | < 10 KB/s | < 50 KB/s | > 100 KB/s | -| Server tick rate | 60+ Hz | 30+ Hz | < 20 Hz | - -## Best Practices - -### DO - -- Test with real network conditions, not just localhost -- Simulate worst-case scenarios (high latency + packet loss) -- Use server-authoritative design for competitive games -- Implement lag compensation for fast-paced games -- Test host migration paths -- Log network events for debugging - -### DON'T - -- Trust client data for important game state -- Assume stable connections -- Skip testing with maximum player counts -- Ignore edge cases (simultaneous actions) -- Test only in ideal network conditions -- Forget to test reconnection flows diff --git a/_bmad/bmgd/gametest/knowledge/performance-testing.md b/_bmad/bmgd/gametest/knowledge/performance-testing.md deleted file mode 100644 index 38f363e..0000000 --- a/_bmad/bmgd/gametest/knowledge/performance-testing.md +++ /dev/null @@ -1,204 +0,0 @@ -# Performance Testing for Games - -## Overview - -Performance testing ensures your game runs smoothly on target hardware. Frame rate, load times, and memory usage directly impact player experience. - -## Key Performance Metrics - -### Frame Rate - -- **Target:** 30fps, 60fps, 120fps depending on platform/genre -- **Measure:** Average, minimum, 1% low, 0.1% low -- **Goal:** Consistent frame times, no stutters - -### Frame Time Budget - -At 60fps, you have 16.67ms per frame: - -``` -Rendering: 8ms (48%) -Game Logic: 4ms (24%) -Physics: 2ms (12%) -Audio: 1ms (6%) -UI: 1ms (6%) -Headroom: 0.67ms (4%) -``` - -### Memory - -- **RAM:** Total allocation, peak usage, fragmentation -- **VRAM:** Texture memory, render targets, buffers -- **Goal:** Stay within platform limits with headroom - -### Load Times - -- **Initial Load:** Time to main menu -- **Level Load:** Time between scenes -- **Streaming:** Asset loading during gameplay -- **Goal:** Meet platform certification requirements - -## Profiling Tools by Engine - -### Unity - -- **Profiler Window** - CPU, GPU, memory, rendering -- **Frame Debugger** - Draw call analysis -- **Memory Profiler** - Heap snapshots -- **Profile Analyzer** - Compare captures - -### Unreal Engine - -- **Unreal Insights** - Comprehensive profiling -- **Stat Commands** - Runtime statistics -- **GPU Visualizer** - GPU timing breakdown -- **Memory Report** - Allocation tracking - -### Godot - -- **Debugger** - Built-in profiler -- **Monitors** - Real-time metrics -- **Remote Debugger** - Profile on device - -### Platform Tools - -- **PIX** (Xbox/Windows) - GPU debugging -- **RenderDoc** - GPU capture and replay -- **Instruments** (iOS/macOS) - Apple profiling -- **Android Profiler** - Android Studio tools - -## Performance Testing Process - -### 1. Establish Baselines - -- Profile on target hardware -- Record key metrics -- Create benchmark scenes - -### 2. Set Budgets - -- Define frame time budgets per system -- Set memory limits -- Establish load time targets - -### 3. Monitor Continuously - -- Integrate profiling in CI -- Track metrics over time -- Alert on regressions - -### 4. Optimize When Needed - -- Profile before optimizing -- Target biggest bottlenecks -- Verify improvements - -## Common Performance Issues - -### CPU Bottlenecks - -| Issue | Symptoms | Solution | -| --------------------- | ----------------- | --------------------------------- | -| Too many game objects | Slow update loop | Object pooling, LOD | -| Expensive AI | Spiky frame times | Budget AI, spread over frames | -| Physics overload | Physics spikes | Simplify colliders, reduce bodies | -| GC stutter | Regular hitches | Avoid runtime allocations | - -### GPU Bottlenecks - -| Issue | Symptoms | Solution | -| ------------------- | ----------------- | -------------------------------- | -| Overdraw | Fill rate limited | Occlusion culling, reduce layers | -| Too many draw calls | CPU-GPU bound | Batching, instancing, atlasing | -| Shader complexity | Long GPU times | Simplify shaders, LOD | -| Resolution too high | Fill rate limited | Dynamic resolution, FSR/DLSS | - -### Memory Issues - -| Issue | Symptoms | Solution | -| ------------- | ----------------- | ---------------------------- | -| Texture bloat | High VRAM | Compress, mipmap, stream | -| Leaks | Growing memory | Track allocations, fix leaks | -| Fragmentation | OOM despite space | Pool allocations, defrag | - -## Benchmark Scenes - -Create standardized test scenarios: - -### Stress Test Scene - -- Maximum entities on screen -- Complex visual effects -- Worst-case for performance - -### Typical Gameplay Scene - -- Representative of normal play -- Average entity count -- Baseline for comparison - -### Isolated System Tests - -- Combat only (no rendering) -- Rendering only (no game logic) -- AI only (pathfinding stress) - -## Automated Performance Testing - -### CI Integration - -```yaml -# Example: Fail build if frame time exceeds budget -performance_test: - script: - - run_benchmark --scene stress_test - - check_metrics --max-frame-time 16.67ms --max-memory 2GB - artifacts: - - performance_report.json -``` - -### Regression Detection - -- Compare against previous builds -- Alert on significant changes (>10%) -- Track trends over time - -## Platform-Specific Considerations - -### Console - -- Fixed hardware targets -- Strict certification requirements -- Thermal throttling concerns - -### PC - -- Wide hardware range -- Scalable quality settings -- Min/recommended specs - -### Mobile - -- Thermal throttling -- Battery impact -- Memory constraints -- Background app pressure - -## Performance Testing Checklist - -### Before Release - -- [ ] Profiled on all target platforms -- [ ] Frame rate targets met -- [ ] No memory leaks -- [ ] Load times acceptable -- [ ] No GC stutters in gameplay -- [ ] Thermal tests passed (mobile/console) -- [ ] Certification requirements met - -### Ongoing - -- [ ] Performance tracked in CI -- [ ] Regression alerts configured -- [ ] Benchmark scenes maintained -- [ ] Budgets documented and enforced diff --git a/_bmad/bmgd/gametest/knowledge/playtesting.md b/_bmad/bmgd/gametest/knowledge/playtesting.md deleted file mode 100644 index c22242a..0000000 --- a/_bmad/bmgd/gametest/knowledge/playtesting.md +++ /dev/null @@ -1,384 +0,0 @@ -# Playtesting Fundamentals - -## Overview - -Playtesting is the process of having people play your game to gather feedback and identify issues. It's distinct from QA testing in that it focuses on player experience, fun factor, and design validation rather than bug hunting. - -## Types of Playtesting - -### Internal Playtesting - -- **Developer Testing** - Daily testing during development -- **Team Testing** - Cross-discipline team plays together -- **Best for:** Rapid iteration, catching obvious issues - -### External Playtesting - -- **Friends & Family** - Trusted external testers -- **Focus Groups** - Targeted demographic testing -- **Public Beta** - Large-scale community testing -- **Best for:** Fresh perspectives, UX validation - -### Specialized Playtesting - -- **Accessibility Testing** - Players with disabilities -- **Localization Testing** - Regional/cultural validation -- **Competitive Testing** - Balance and meta testing - -## Playtesting Process - -### 1. Define Goals - -Before each playtest session, define: - -- What questions are you trying to answer? -- What features are you testing? -- What metrics will you gather? - -### 2. Prepare the Build - -- Create a stable, playable build -- Include telemetry/logging if needed -- Prepare any necessary documentation - -### 3. Brief Testers - -- Explain what to test (or don't, for blind testing) -- Set expectations for bugs/polish level -- Provide feedback mechanisms - -### 4. Observe and Record - -- Watch players without intervening -- Note confusion points, frustration, delight -- Record gameplay if possible - -### 5. Gather Feedback - -- Structured surveys for quantitative data -- Open discussion for qualitative insights -- Allow time for "what else?" comments - -### 6. Analyze and Act - -- Identify patterns across testers -- Prioritize issues by frequency and severity -- Create actionable tasks from findings - -## Key Metrics to Track - -### Engagement Metrics - -- Session length -- Return rate -- Completion rate -- Drop-off points - -### Difficulty Metrics - -- Deaths/failures per section -- Time to complete sections -- Hint/help usage -- Difficulty setting distribution - -### UX Metrics - -- Time to first action -- Tutorial completion rate -- Menu navigation patterns -- Control scheme preferences - -## Playtesting by Game Type - -Different genres require different playtesting approaches and focus areas. - -### Action/Platformer Games - -**Focus Areas:** - -- Control responsiveness and "game feel" -- Difficulty curve across levels -- Checkpoint placement and frustration points -- Visual clarity during fast-paced action - -**Key Questions:** - -- Does the character feel good to control? -- Are deaths feeling fair or cheap? -- Is the player learning organically or hitting walls? - -### RPG/Story Games - -**Focus Areas:** - -- Narrative pacing and engagement -- Quest clarity and tracking -- Character/dialogue believability -- Progression and reward timing - -**Key Questions:** - -- Do players understand their current objective? -- Are choices feeling meaningful? -- Is the story holding attention or being skipped? - -### Puzzle Games - -**Focus Areas:** - -- Solution discoverability -- "Aha moment" timing -- Hint system effectiveness -- Difficulty progression - -**Key Questions:** - -- Are players solving puzzles the intended way? -- How long before frustration sets in? -- Do solutions feel satisfying or arbitrary? - -### Multiplayer/Competitive Games - -**Focus Areas:** - -- Balance across characters/builds/strategies -- Meta development and dominant strategies -- Social dynamics and toxicity vectors -- Matchmaking feel - -**Key Questions:** - -- Are there "must-pick" or "never-pick" options? -- Do losing players understand why they lost? -- Is the skill ceiling high enough for mastery? - -### Survival/Sandbox Games - -**Focus Areas:** - -- Early game onboarding and survival -- Goal clarity vs. freedom balance -- Resource economy and pacing -- Emergent gameplay moments - -**Key Questions:** - -- Do players know what to do first? -- Is the loop engaging beyond the first hour? -- Are players creating their own goals? - -### Mobile/Casual Games - -**Focus Areas:** - -- Session length appropriateness -- One-hand playability (if applicable) -- Interruption handling (calls, notifications) -- Monetization friction points - -**Key Questions:** - -- Can players play in 2-minute sessions? -- Is the core loop immediately understandable? -- Where do players churn? - -### Horror Games - -**Focus Areas:** - -- Tension and release pacing -- Scare effectiveness and desensitization -- Safe space placement -- Audio/visual atmosphere - -**Key Questions:** - -- When do players feel safe vs. threatened? -- Are scares landing or becoming predictable? -- Is anxiety sustainable or exhausting? - -## Processing Feedback Effectively - -Raw feedback is noise. Processed feedback is signal. - -### The Feedback Processing Pipeline - -``` -Raw Feedback → Categorize → Pattern Match → Root Cause → Prioritize → Action -``` - -### Step 1: Categorize Feedback - -Sort all feedback into buckets: - -| Category | Examples | -| ------------- | ---------------------------------- | -| **Bugs** | Crashes, glitches, broken features | -| **Usability** | Confusing UI, unclear objectives | -| **Balance** | Too hard, too easy, unfair | -| **Feel** | Controls, pacing, satisfaction | -| **Content** | Wants more of X, dislikes Y | -| **Polish** | Audio, visuals, juice | - -### Step 2: Pattern Matching - -Individual feedback is anecdotal. Patterns are data. - -**Threshold Guidelines:** - -- 1 person mentions it → Note it -- 3+ people mention it → Investigate -- 50%+ mention it → Priority issue - -**Watch for:** - -- Same complaint, different words -- Same area, different complaints (signals deeper issue) -- Contradictory feedback (may indicate preference split) - -### Step 3: Root Cause Analysis - -Players report symptoms, not diseases. - -**Example:** - -- **Symptom:** "The boss is too hard" -- **Possible Root Causes:** - - Boss mechanics unclear - - Player didn't learn required skill earlier - - Checkpoint too far from boss - - Health/damage tuning off - - Boss pattern has no safe windows - -**Ask "Why?" five times** to get to root cause. - -### Step 4: Separate Fact from Opinion - -| Fact (Actionable) | Opinion (Context) | -| --------------------------------- | ----------------------- | -| "I died 12 times on level 3" | "Level 3 is too hard" | -| "I didn't use the shield ability" | "The shield is useless" | -| "I quit after 20 minutes" | "The game is boring" | - -**Facts tell you WHAT happened. Opinions tell you how they FELT about it.** - -Both matter, but facts drive solutions. - -### Step 5: The Feedback Matrix - -Plot issues on impact vs. effort: - -``` - High Impact - │ - Quick │ Major - Wins │ Projects - │ -─────────────┼───────────── - │ - Fill │ Reconsider - Time │ - │ - Low Impact - Low Effort ──────── High Effort -``` - -### Step 6: Validate Before Acting - -Before making changes based on feedback: - -1. **Reproduce** - Can you see the issue yourself? -2. **Quantify** - How many players affected? -3. **Contextualize** - Is this your target audience? -4. **Test solutions** - Will the fix create new problems? - -### Handling Contradictory Feedback - -When Player A wants X and Player B wants the opposite: - -1. **Check sample size** - Is it really split or just 2 loud voices? -2. **Segment audiences** - Are these different player types? -3. **Find the underlying need** - Both may want the same thing differently -4. **Consider options** - Difficulty settings, toggles, multiple paths -5. **Make a decision** - You can't please everyone; know your target - -### Feedback Red Flags - -**Dismiss or investigate carefully:** - -- "Make it like [other game]" - They want a feeling, not a clone -- "Add multiplayer" - Feature creep disguised as feedback -- "I would have bought it if..." - Hypothetical customers aren't real -- Feedback from non-target audience - Know who you're building for - -**Take seriously:** - -- Confusion about core mechanics -- Consistent drop-off at same point -- "I wanted to like it but..." -- Silent quitting (no feedback, just gone) - -### Documentation Best Practices - -**For each playtest session, record:** - -- Date and build version -- Tester demographics/experience -- Session length -- Key observations (timestamped if recorded) -- Quantitative survey results -- Top 3 issues identified -- Actions taken as result - -**Maintain a living document** that tracks: - -- Issue → First reported → Times reported → Status → Resolution -- This prevents re-discovering the same issues - -## Common Playtesting Pitfalls - -### Leading Questions - -**Bad:** "Did you find the combat exciting?" -**Good:** "How would you describe the combat?" - -### Intervening Too Soon - -Let players struggle before helping. Confusion is valuable data. - -### Testing Too Late - -Start playtesting early with paper prototypes and gray boxes. - -### Ignoring Negative Feedback - -Negative feedback is often the most valuable. Don't dismiss it. - -### Over-Relying on Verbal Feedback - -Watch what players DO, not just what they SAY. Actions reveal truth. - -## Playtesting Checklist - -### Pre-Session - -- [ ] Goals defined -- [ ] Build stable and deployed -- [ ] Recording setup (if applicable) -- [ ] Feedback forms ready -- [ ] Testers briefed - -### During Session - -- [ ] Observing without intervening -- [ ] Taking notes on behavior -- [ ] Tracking time markers for notable moments -- [ ] Noting emotional reactions - -### Post-Session - -- [ ] Feedback collected -- [ ] Patterns identified -- [ ] Priority issues flagged -- [ ] Action items created -- [ ] Results shared with team diff --git a/_bmad/bmgd/gametest/knowledge/qa-automation.md b/_bmad/bmgd/gametest/knowledge/qa-automation.md deleted file mode 100644 index 491660b..0000000 --- a/_bmad/bmgd/gametest/knowledge/qa-automation.md +++ /dev/null @@ -1,190 +0,0 @@ -# QA Automation for Games - -## Overview - -Automated testing in games requires different approaches than traditional software. Games have complex state, real-time interactions, and subjective quality measures that challenge automation. - -## Testing Pyramid for Games - -``` - /\ - / \ Manual Playtesting - /----\ (Experience, Feel, Fun) - / \ - /--------\ Integration Tests - / \ (Systems, Workflows) - /------------\ - / \ Unit Tests -/________________\ (Pure Logic, Math, Data) -``` - -### Unit Tests (Foundation) - -Test pure logic that doesn't depend on engine runtime: - -- Math utilities (vectors, transforms, curves) -- Data validation (save files, configs) -- State machines (isolated logic) -- Algorithm correctness - -### Integration Tests (Middle Layer) - -Test system interactions: - -- Combat system + inventory -- Save/load round-trips -- Scene transitions -- Network message handling - -### Manual Testing (Top) - -What can't be automated: - -- "Does this feel good?" -- "Is this fun?" -- "Is the difficulty right?" - -## Automation Strategies by Engine - -### Unity - -```csharp -// Unity Test Framework -[Test] -public void DamageCalculation_CriticalHit_DoublesDamage() -{ - var baseDamage = 100; - var result = DamageCalculator.Calculate(baseDamage, isCritical: true); - Assert.AreEqual(200, result); -} - -// Play Mode Tests (runtime) -[UnityTest] -public IEnumerator PlayerJump_WhenGrounded_BecomesAirborne() -{ - var player = CreateTestPlayer(); - player.Jump(); - yield return new WaitForFixedUpdate(); - Assert.IsFalse(player.IsGrounded); -} -``` - -### Unreal Engine - -```cpp -// Automation Framework -IMPLEMENT_SIMPLE_AUTOMATION_TEST(FDamageTest, "Game.Combat.Damage", - EAutomationTestFlags::ApplicationContextMask | EAutomationTestFlags::ProductFilter) - -bool FDamageTest::RunTest(const FString& Parameters) -{ - float BaseDamage = 100.f; - float Result = UDamageCalculator::Calculate(BaseDamage, true); - TestEqual("Critical hit doubles damage", Result, 200.f); - return true; -} -``` - -### Godot - -```gdscript -# GUT Testing Framework -func test_damage_critical_hit(): - var base_damage = 100 - var result = DamageCalculator.calculate(base_damage, true) - assert_eq(result, 200, "Critical hit should double damage") -``` - -## What to Automate - -### High Value Targets - -- **Save/Load** - Data integrity is critical -- **Economy** - Currency, items, progression math -- **Combat Math** - Damage, stats, modifiers -- **Localization** - String loading, formatting -- **Network Serialization** - Message encoding/decoding - -### Medium Value Targets - -- **State Machines** - Character states, game states -- **Pathfinding** - Known scenarios -- **Spawning** - Wave generation, loot tables -- **UI Data Binding** - Correct values displayed - -### Low Value / Avoid - -- **Visual Quality** - Screenshots drift, hard to maintain -- **Input Feel** - Timing-sensitive, needs human judgment -- **Audio** - Subjective, context-dependent -- **Fun** - Cannot be automated - -## Continuous Integration for Games - -### Build Pipeline - -1. **Compile** - Build game executable -2. **Unit Tests** - Fast, isolated tests -3. **Integration Tests** - Longer, system tests -4. **Smoke Test** - Can the game launch and reach main menu? -5. **Nightly** - Extended test suites, performance benchmarks - -### CI Gotchas for Games - -- **Long build times** - Games take longer than web apps -- **GPU requirements** - Some tests need graphics hardware -- **Asset dependencies** - Large files, binary formats -- **Platform builds** - Multiple targets to maintain - -## Regression Testing - -### Automated Regression - -- Run full test suite on every commit -- Flag performance regressions (frame time, memory) -- Track test stability (flaky tests) - -### Save File Regression - -- Maintain library of save files from previous versions -- Test that new builds can load old saves -- Alert on schema changes - -## Test Data Management - -### Test Fixtures - -``` -tests/ -├── fixtures/ -│ ├── save_files/ -│ │ ├── new_game.sav -│ │ ├── mid_game.sav -│ │ └── endgame.sav -│ ├── configs/ -│ │ └── test_balance.json -│ └── scenarios/ -│ └── boss_fight_setup.scene -``` - -### Deterministic Testing - -- Seed random number generators -- Control time/delta time -- Mock external services - -## Metrics and Reporting - -### Track Over Time - -- Test count (growing is good) -- Pass rate (should be ~100%) -- Execution time (catch slow tests) -- Code coverage (where applicable) -- Flaky test rate (should be ~0%) - -### Alerts - -- Immediate: Any test failure on main branch -- Daily: Coverage drops, new flaky tests -- Weekly: Trend analysis, slow test growth diff --git a/_bmad/bmgd/gametest/knowledge/regression-testing.md b/_bmad/bmgd/gametest/knowledge/regression-testing.md deleted file mode 100644 index 975c465..0000000 --- a/_bmad/bmgd/gametest/knowledge/regression-testing.md +++ /dev/null @@ -1,280 +0,0 @@ -# Regression Testing for Games - -## Overview - -Regression testing catches bugs introduced by new changes. In games, this includes functional regressions, performance regressions, and design regressions. - -## Types of Regression - -### Functional Regression - -- Features that worked before now break -- New bugs introduced by unrelated changes -- Broken integrations between systems - -### Performance Regression - -- Frame rate drops -- Memory usage increases -- Load time increases -- Battery drain (mobile) - -### Design Regression - -- Balance changes with unintended side effects -- UX changes that hurt usability -- Art changes that break visual consistency - -### Save Data Regression - -- Old save files no longer load -- Progression lost or corrupted -- Achievements/unlocks reset - -## Regression Testing Strategy - -### Test Suite Layers - -``` -High-Frequency (Every Commit) -├── Unit Tests - Fast, isolated -├── Smoke Tests - Can game launch and run? -└── Critical Path - Core gameplay works - -Medium-Frequency (Nightly) -├── Integration Tests - System interactions -├── Full Playthrough - Automated or manual -└── Performance Benchmarks - Frame time, memory - -Low-Frequency (Release) -├── Full Matrix - All platforms/configs -├── Certification Tests - Platform requirements -└── Localization - All languages -``` - -### What to Test - -#### Critical Path (Must Not Break) - -- Game launches -- New game starts -- Save/load works -- Core gameplay loop completes -- Main menu navigation - -#### High Priority - -- All game systems function -- Progression works end-to-end -- Multiplayer connects and syncs -- In-app purchases process -- Achievements trigger - -#### Medium Priority - -- Edge cases in systems -- Optional content accessible -- Settings persist correctly -- Localization displays - -## Automated Regression Tests - -### Smoke Tests - -```python -# Run on every commit -def test_game_launches(): - process = launch_game() - assert wait_for_main_menu(timeout=30) - process.terminate() - -def test_new_game_starts(): - launch_game() - click_new_game() - assert wait_for_gameplay(timeout=60) - -def test_save_load_roundtrip(): - launch_game() - start_new_game() - perform_actions() - save_game() - load_game() - assert verify_state_matches() -``` - -### Playthrough Bots - -```python -# Automated player that plays through content -class PlaythroughBot: - def run_level(self, level): - self.load_level(level) - while not self.level_complete: - self.perform_action() - self.check_for_softlocks() - self.record_metrics() -``` - -### Visual Regression - -```python -# Compare screenshots against baselines -def test_main_menu_visual(): - launch_game() - screenshot = capture_screen() - assert compare_to_baseline(screenshot, 'main_menu', threshold=0.01) -``` - -## Performance Regression Detection - -### Metrics to Track - -- Average frame time -- 1% low frame time -- Memory usage (peak, average) -- Load times -- Draw calls -- Texture memory - -### Automated Benchmarks - -```yaml -performance_benchmark: - script: - - run_benchmark_scene --duration 60s - - collect_metrics - - compare_to_baseline - fail_conditions: - - frame_time_avg > baseline * 1.1 # 10% tolerance - - memory_peak > baseline * 1.05 # 5% tolerance -``` - -### Trend Tracking - -- Graph metrics over time -- Alert on upward trends -- Identify problematic commits - -## Save Compatibility Testing - -### Version Matrix - -Maintain save files from: - -- Previous major version -- Previous minor version -- Current development build - -### Automated Validation - -```python -def test_save_compatibility(): - for save_file in LEGACY_SAVES: - load_save(save_file) - assert no_errors() - assert progress_preserved() - assert inventory_intact() -``` - -### Schema Versioning - -- Version your save format -- Implement upgrade paths -- Log migration issues - -## Regression Bug Workflow - -### 1. Detection - -- Automated test fails -- Manual tester finds issue -- Player report comes in - -### 2. Verification - -- Confirm it worked before -- Identify when it broke -- Find the breaking commit - -### 3. Triage - -- Assess severity -- Determine fix urgency -- Assign to appropriate developer - -### 4. Fix and Verify - -- Implement fix -- Add regression test -- Verify fix doesn't break other things - -### 5. Post-Mortem - -- Why wasn't this caught? -- How can we prevent similar issues? -- Do we need new tests? - -## Bisecting Regressions - -When a regression is found, identify the breaking commit: - -### Git Bisect - -```bash -git bisect start -git bisect bad HEAD # Current is broken -git bisect good v1.2.0 # Known good version -# Git will checkout commits to test -# Run test, mark good/bad -git bisect good/bad -# Repeat until culprit found -``` - -### Automated Bisect - -```bash -git bisect start HEAD v1.2.0 -git bisect run ./run_regression_test.sh -``` - -## Regression Testing Checklist - -### Per Commit - -- [ ] Unit tests pass -- [ ] Smoke tests pass -- [ ] Build succeeds on all platforms - -### Per Merge to Main - -- [ ] Integration tests pass -- [ ] Performance benchmarks within tolerance -- [ ] Save compatibility verified - -### Per Release - -- [ ] Full playthrough completed -- [ ] All platforms tested -- [ ] Legacy saves load correctly -- [ ] No new critical regressions -- [ ] All previous hotfix issues still resolved - -## Building a Regression Suite - -### Start Small - -1. Add tests for bugs as they're fixed -2. Cover critical path first -3. Expand coverage over time - -### Maintain Quality - -- Delete flaky tests -- Keep tests fast -- Update tests with design changes - -### Measure Effectiveness - -- Track bugs caught by tests -- Track bugs that slipped through -- Identify coverage gaps diff --git a/_bmad/bmgd/gametest/knowledge/save-testing.md b/_bmad/bmgd/gametest/knowledge/save-testing.md deleted file mode 100644 index 663898a..0000000 --- a/_bmad/bmgd/gametest/knowledge/save-testing.md +++ /dev/null @@ -1,280 +0,0 @@ -# Save System Testing Guide - -## Overview - -Save system testing ensures data persistence, integrity, and compatibility across game versions. Save bugs are among the most frustrating for players—data loss destroys trust. - -## Test Categories - -### Data Integrity - -| Test Type | Description | Priority | -| -------------------- | ------------------------------------------- | -------- | -| Round-trip | Save → Load → Verify all data matches | P0 | -| Corruption detection | Tampered/corrupted files handled gracefully | P0 | -| Partial write | Power loss during save doesn't corrupt | P0 | -| Large saves | Performance with max-size save files | P1 | -| Edge values | Min/max values for all saved fields | P1 | - -### Version Compatibility - -| Scenario | Expected Behavior | -| ----------------------- | ------------------------------------- | -| Current → Current | Full compatibility | -| Old → New (upgrade) | Migration with data preservation | -| New → Old (downgrade) | Graceful rejection or limited support | -| Corrupted version field | Fallback to recovery mode | - -## Test Scenarios - -### Core Save/Load Tests - -``` -SCENARIO: Basic Save Round-Trip - GIVEN player has 100 health, 50 gold, position (10, 5, 20) - AND player has inventory: ["sword", "potion", "key"] - WHEN game is saved - AND game is reloaded - THEN player health equals 100 - AND player gold equals 50 - AND player position equals (10, 5, 20) - AND inventory contains exactly ["sword", "potion", "key"] - -SCENARIO: Save During Gameplay - GIVEN player is in combat - AND enemy has 50% health remaining - WHEN autosave triggers - AND game is reloaded - THEN combat state is restored - AND enemy health equals 50% - -SCENARIO: Multiple Save Slots - GIVEN save slot 1 has character "Hero" at level 10 - AND save slot 2 has character "Mage" at level 5 - WHEN switching between slots - THEN correct character data loads for each slot - AND no cross-contamination between slots -``` - -### Edge Cases - -``` -SCENARIO: Maximum Inventory Save - GIVEN player has 999 items in inventory - WHEN game is saved - AND game is reloaded - THEN all 999 items are preserved - AND save/load completes within 5 seconds - -SCENARIO: Unicode Character Names - GIVEN player name is "プレイヤー名" - WHEN game is saved - AND game is reloaded - THEN player name displays correctly - -SCENARIO: Extreme Play Time - GIVEN play time is 9999:59:59 - WHEN game is saved - AND game is reloaded - THEN play time displays correctly - AND timer continues from saved value -``` - -### Corruption Recovery - -``` -SCENARIO: Corrupted Save Detection - GIVEN save file has been manually corrupted - WHEN game attempts to load - THEN error is detected before loading - AND user is informed of corruption - AND game does not crash - -SCENARIO: Missing Save File - GIVEN save file has been deleted externally - WHEN game attempts to load - THEN graceful error handling - AND option to start new game or restore backup - -SCENARIO: Interrupted Save (Power Loss) - GIVEN save operation is interrupted mid-write - WHEN game restarts - THEN backup save is detected and offered - AND no data loss from previous valid save -``` - -## Platform-Specific Testing - -### PC (Steam/Epic) - -- Cloud save sync conflicts -- Multiple Steam accounts on same PC -- Offline → Online sync -- Save location permissions (Program Files issues) - -### Console (PlayStation/Xbox/Switch) - -- System-level save management -- Storage full scenarios -- User switching mid-game -- Suspend/resume with unsaved changes -- Cloud save quota limits - -### Mobile - -- App termination during save -- Low storage warnings -- iCloud/Google Play sync -- Device migration - -## Automated Test Examples - -### Unity - -```csharp -[Test] -public void SaveLoad_PlayerStats_PreservesAllValues() -{ - var original = new PlayerData - { - Health = 75, - MaxHealth = 100, - Gold = 1234567, - Position = new Vector3(100.5f, 0, -50.25f), - PlayTime = 36000f // 10 hours - }; - - SaveManager.Save(original, "test_slot"); - var loaded = SaveManager.Load("test_slot"); - - Assert.AreEqual(original.Health, loaded.Health); - Assert.AreEqual(original.Gold, loaded.Gold); - Assert.AreEqual(original.Position, loaded.Position); - Assert.AreEqual(original.PlayTime, loaded.PlayTime, 0.01f); -} - -[Test] -public void SaveLoad_CorruptedFile_HandlesGracefully() -{ - File.WriteAllText(SaveManager.GetPath("corrupt"), "INVALID DATA"); - - Assert.Throws(() => - SaveManager.Load("corrupt")); - - // Game should not crash - Assert.IsTrue(SaveManager.IsValidSaveSlot("corrupt") == false); -} -``` - -### Unreal - -```cpp -bool FSaveSystemTest::RunTest(const FString& Parameters) -{ - // Create test save - USaveGame* SaveGame = UGameplayStatics::CreateSaveGameObject( - UMySaveGame::StaticClass()); - UMySaveGame* MySave = Cast(SaveGame); - - MySave->PlayerLevel = 50; - MySave->Gold = 999999; - MySave->QuestsCompleted = {"Quest1", "Quest2", "Quest3"}; - - // Save - UGameplayStatics::SaveGameToSlot(MySave, "TestSlot", 0); - - // Load - USaveGame* Loaded = UGameplayStatics::LoadGameFromSlot("TestSlot", 0); - UMySaveGame* LoadedSave = Cast(Loaded); - - TestEqual("Level preserved", LoadedSave->PlayerLevel, 50); - TestEqual("Gold preserved", LoadedSave->Gold, 999999); - TestEqual("Quests count", LoadedSave->QuestsCompleted.Num(), 3); - - return true; -} -``` - -### Godot - -```gdscript -func test_save_load_round_trip(): - var original = { - "health": 100, - "position": Vector3(10, 0, 20), - "inventory": ["sword", "shield"], - "quest_flags": {"intro_complete": true, "boss_defeated": false} - } - - SaveManager.save_game(original, "test_save") - var loaded = SaveManager.load_game("test_save") - - assert_eq(loaded.health, 100) - assert_eq(loaded.position, Vector3(10, 0, 20)) - assert_eq(loaded.inventory.size(), 2) - assert_true(loaded.quest_flags.intro_complete) - assert_false(loaded.quest_flags.boss_defeated) - -func test_corrupted_save_detection(): - var file = FileAccess.open("user://saves/corrupt.sav", FileAccess.WRITE) - file.store_string("CORRUPTED GARBAGE DATA") - file.close() - - var result = SaveManager.load_game("corrupt") - - assert_null(result, "Should return null for corrupted save") - assert_false(SaveManager.is_valid_save("corrupt")) -``` - -## Migration Testing - -### Version Upgrade Matrix - -| From Version | To Version | Test Focus | -| -------------- | ---------------- | ---------------------------- | -| 1.0 → 1.1 | Minor update | New fields default correctly | -| 1.x → 2.0 | Major update | Schema migration works | -| Beta → Release | Launch migration | All beta saves convert | - -### Migration Test Template - -``` -SCENARIO: Save Migration v1.0 to v2.0 - GIVEN save file from version 1.0 - AND save contains old inventory format (array) - WHEN game version 2.0 loads the save - THEN inventory is migrated to new format (dictionary) - AND all items are preserved - AND migration is logged - AND backup of original is created -``` - -## Performance Benchmarks - -| Metric | Target | Maximum | -| ------------------------ | --------------- | ------- | -| Save time (typical) | < 500ms | 2s | -| Save time (large) | < 2s | 5s | -| Load time (typical) | < 1s | 3s | -| Save file size (typical) | < 1MB | 10MB | -| Memory during save | < 50MB overhead | 100MB | - -## Best Practices - -### DO - -- Use atomic saves (write to temp, then rename) -- Keep backup of previous save -- Version your save format -- Encrypt sensitive data -- Test on minimum-spec hardware -- Compress large saves - -### DON'T - -- Store absolute file paths -- Save derived/calculated data -- Trust save file contents blindly -- Block gameplay during save -- Forget to handle storage-full scenarios -- Skip testing save migration paths diff --git a/_bmad/bmgd/gametest/knowledge/smoke-testing.md b/_bmad/bmgd/gametest/knowledge/smoke-testing.md deleted file mode 100644 index 20be2ae..0000000 --- a/_bmad/bmgd/gametest/knowledge/smoke-testing.md +++ /dev/null @@ -1,404 +0,0 @@ -# Smoke Testing Guide - -## Overview - -Smoke testing (Build Verification Testing) validates that a build's critical functionality works before investing time in detailed testing. A failed smoke test means "stop, this build is broken." - -## Purpose - -| Goal | Description | -| ------------------- | ---------------------------------------------- | -| Fast feedback | Know within minutes if build is viable | -| Block bad builds | Prevent broken builds from reaching QA/players | -| Critical path focus | Test only what matters most | -| CI/CD integration | Automated gate before deployment | - -## Smoke Test Principles - -### What Makes a Good Smoke Test - -- **Fast**: Complete in 5-15 minutes -- **Critical**: Tests only essential functionality -- **Deterministic**: Same result every run -- **Automated**: No human intervention required -- **Clear**: Pass/fail with actionable feedback - -### What to Include - -| Category | Examples | -| ----------------- | ------------------------------ | -| Boot sequence | Game launches without crash | -| Core loop | Player can perform main action | -| Save/Load | Data persists correctly | -| Critical UI | Menus are navigable | -| Platform services | Connects to required services | - -### What NOT to Include - -- Edge cases and boundary conditions -- Performance benchmarks (separate tests) -- Full feature coverage -- Content verification -- Balance testing - -## Smoke Test Scenarios - -### Boot and Load - -``` -TEST: Game Launches - WHEN game executable is started - THEN main menu appears within 60 seconds - AND no crashes occur - AND required services connect - -TEST: New Game Start - GIVEN game at main menu - WHEN "New Game" is selected - THEN gameplay loads within 30 seconds - AND player can control character - -TEST: Continue Game - GIVEN existing save file - WHEN "Continue" is selected - THEN correct save loads - AND game state matches saved state -``` - -### Core Gameplay - -``` -TEST: Player Movement - GIVEN player in game world - WHEN movement input applied - THEN player moves in expected direction - AND no physics glitches occur - -TEST: Core Action (Game-Specific) - GIVEN player can perform primary action - WHEN action is triggered - THEN action executes correctly - AND expected results occur - - Examples: - - Shooter: Can fire weapon, bullets hit targets - - RPG: Can attack enemy, damage is applied - - Puzzle: Can interact with puzzle elements - - Platformer: Can jump, platforms are solid -``` - -### Save System - -``` -TEST: Save Creates File - GIVEN player makes progress - WHEN save is triggered - THEN save file is created - AND save completes without error - -TEST: Load Restores State - GIVEN valid save file exists - WHEN load is triggered - THEN saved state is restored - AND gameplay can continue -``` - -### Critical UI - -``` -TEST: Menu Navigation - GIVEN main menu is displayed - WHEN each menu option is selected - THEN correct screen/action occurs - AND navigation back works - -TEST: Settings Persist - GIVEN settings are changed - WHEN game is restarted - THEN settings remain changed -``` - -## Automated Smoke Test Examples - -### Unity - -```csharp -using System.Collections; -using NUnit.Framework; -using UnityEngine; -using UnityEngine.UI; -using UnityEngine.TestTools; -using UnityEngine.SceneManagement; - -[TestFixture] -public class SmokeTests -{ - [UnityTest, Timeout(60000)] - public IEnumerator Game_Launches_ToMainMenu() - { - // Load main menu scene - SceneManager.LoadScene("MainMenu"); - yield return new WaitForSeconds(5f); - - // Verify menu is active - var mainMenu = GameObject.Find("MainMenuCanvas"); - Assert.IsNotNull(mainMenu, "Main menu should be present"); - Assert.IsTrue(mainMenu.activeInHierarchy, "Main menu should be active"); - } - - [UnityTest, Timeout(120000)] - public IEnumerator NewGame_LoadsGameplay() - { - // Start from main menu - SceneManager.LoadScene("MainMenu"); - yield return new WaitForSeconds(2f); - - // Click new game - var newGameButton = GameObject.Find("NewGameButton") - .GetComponent; -}; - -// Run test: PASSES - Component renders and handles clicks - -// Step 3: REFACTOR - Improve implementation -// Add disabled state, loading state, variants -type ButtonProps = { - label: string; - onClick?: () => void; - disabled?: boolean; - loading?: boolean; - variant?: 'primary' | 'secondary' | 'danger'; -}; - -export const Button = ({ - label, - onClick, - disabled = false, - loading = false, - variant = 'primary' -}: ButtonProps) => { - return ( - - ); -}; - -// Step 4: Expand tests for new features -describe('Button Component', () => { - it('should render with label', () => { - cy.mount(