From c3b7e982412b93b03f5481e1b14825c255f39673 Mon Sep 17 00:00:00 2001 From: Brian Date: Sun, 11 Jan 2026 11:13:38 +0800 Subject: [PATCH] Workflow Creator and Validator Tools with Sub Process Support and PRD Validation Step now available! * critical file issues in prd refactor resolved caught using the BMB workflow validator!! * subprocess optimization and path violation checks in the workflow validator, along with fixes to the BMM PRD workflow * standardize workflow and PRD step markdown formatting - Improve consistency across workflow validation steps - Standardize PRD innovation step structure * Workflow Validation Max Parallel Mode POC * prd trimodal compliant * correct PRD completion suggested next steps --- .../quiz-master/steps/step-01-init.md | 6 +- .../workflows/quiz-master/steps/step-02-q1.md | 6 +- .../workflows/quiz-master/steps/step-03-q2.md | 6 +- .../workflows/quiz-master/steps/step-04-q3.md | 6 +- .../workflows/quiz-master/steps/step-05-q4.md | 6 +- .../workflows/quiz-master/steps/step-06-q5.md | 6 +- .../workflows/quiz-master/steps/step-07-q6.md | 6 +- .../workflows/quiz-master/steps/step-08-q7.md | 6 +- .../workflows/quiz-master/steps/step-09-q8.md | 6 +- .../workflows/quiz-master/steps/step-10-q9.md | 6 +- .../quiz-master/steps/step-11-q10.md | 6 +- .../quiz-master/steps/step-12-results.md | 4 +- .../workflows/quiz-master/workflow.md | 2 +- .../bmb/agents/workflow-builder.agent.yaml | 4 + src/modules/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/meal-prep-nutrition/workflow.md | 60 --- .../workflows/workflow/data/architecture.md | 4 +- .../data/dietary-restrictions.csv | 18 - .../data/macro-calculator.csv | 16 - .../data/recipe-database.csv | 28 -- .../steps-c/step-01-init.md | 170 ------- .../steps-c/step-01b-continue.md | 142 ------ .../steps-c/step-02-profile.md | 158 ------- .../steps-c/step-03-assessment.md | 146 ------ .../steps-c/step-04-strategy.md | 176 ------- .../steps-c/step-05-shopping.md | 161 ------- .../steps-c/step-06-prep-schedule.md | 188 -------- .../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 - .../examples/meal-prep-nutrition/workflow.md | 59 --- .../workflow/data/frontmatter-standards.md | 48 +- .../workflow/data/step-type-patterns.md | 37 +- .../data/subprocess-optimization-patterns.md | 386 ++++++++++++++++ .../workflow/steps-c/step-01b-continuation.md | 3 + .../workflow/steps-c/step-06-design.md | 47 +- .../workflow/steps-c/step-08-build-step-01.md | 44 ++ .../steps-c/step-09-build-next-step.md | 44 ++ .../steps-v/step-01-validate-max-mode.md | 109 +++++ .../workflow/steps-v/step-01-validate.md | 140 +++--- .../workflow/steps-v/step-01b-structure.md | 152 ++++++ .../steps-v/step-02-frontmatter-validation.md | 93 ++-- .../steps-v/step-02b-path-violations.md | 265 +++++++++++ .../steps-v/step-03-menu-validation.md | 87 ++-- .../steps-v/step-04-step-type-validation.md | 113 +++-- .../step-05-output-format-validation.md | 87 ++-- .../step-06-validation-design-check.md | 111 ++--- .../step-07-instruction-style-check.md | 109 +++-- .../step-08-collaborative-experience-check.md | 8 +- .../step-08b-subprocess-optimization.md | 179 ++++++++ .../steps-v/step-09-cohesive-review.md | 123 ++--- .../steps-v/step-10-report-complete.md | 154 ++----- .../steps-v/step-11-plan-validation.md | 196 ++++---- .../step-01-init-continuable-template.md | 6 +- .../workflow/templates/step-1b-template.md | 2 +- .../workflow/templates/step-template.md | 22 +- .../workflow/templates/workflow-template.md | 6 +- .../bmb/workflows/workflow/workflow.md | 6 + .../brainstorm-game/steps/step-01-init.md | 4 +- .../brainstorm-game/steps/step-02-context.md | 4 +- .../brainstorm-game/steps/step-03-ideation.md | 4 +- .../brainstorm-game/steps/step-04-complete.md | 2 +- .../brainstorm-game/workflow.md | 2 +- .../game-brief/steps/step-01-init.md | 6 +- .../game-brief/steps/step-01b-continue.md | 2 +- .../game-brief/steps/step-02-vision.md | 4 +- .../game-brief/steps/step-03-market.md | 4 +- .../game-brief/steps/step-04-fundamentals.md | 4 +- .../game-brief/steps/step-05-scope.md | 4 +- .../game-brief/steps/step-06-references.md | 4 +- .../game-brief/steps/step-07-content.md | 4 +- .../game-brief/steps/step-08-complete.md | 2 +- .../2-design/gdd/steps/step-01-init.md | 6 +- .../2-design/gdd/steps/step-01b-continue.md | 2 +- .../2-design/gdd/steps/step-02-context.md | 4 +- .../2-design/gdd/steps/step-03-platforms.md | 4 +- .../2-design/gdd/steps/step-04-vision.md | 4 +- .../gdd/steps/step-05-core-gameplay.md | 4 +- .../2-design/gdd/steps/step-06-mechanics.md | 4 +- .../2-design/gdd/steps/step-07-game-type.md | 4 +- .../2-design/gdd/steps/step-08-progression.md | 4 +- .../2-design/gdd/steps/step-09-levels.md | 4 +- .../2-design/gdd/steps/step-10-art-audio.md | 4 +- .../2-design/gdd/steps/step-11-technical.md | 4 +- .../2-design/gdd/steps/step-12-epics.md | 4 +- .../2-design/gdd/steps/step-13-metrics.md | 4 +- .../2-design/gdd/steps/step-14-complete.md | 2 +- .../2-design/narrative/steps/step-01-init.md | 6 +- .../narrative/steps/step-01b-continue.md | 22 +- .../narrative/steps/step-02-foundation.md | 4 +- .../2-design/narrative/steps/step-03-story.md | 4 +- .../narrative/steps/step-04-characters.md | 4 +- .../2-design/narrative/steps/step-05-world.md | 4 +- .../narrative/steps/step-06-dialogue.md | 4 +- .../narrative/steps/step-07-environmental.md | 4 +- .../narrative/steps/step-08-delivery.md | 4 +- .../narrative/steps/step-09-integration.md | 4 +- .../narrative/steps/step-10-production.md | 4 +- .../narrative/steps/step-11-complete.md | 2 +- .../workflows/2-design/narrative/workflow.md | 2 +- .../game-architecture/steps/step-01-init.md | 6 +- .../steps/step-01b-continue.md | 18 +- .../steps/step-02-context.md | 4 +- .../steps/step-03-starter.md | 4 +- .../steps/step-04-decisions.md | 4 +- .../steps/step-05-crosscutting.md | 4 +- .../steps/step-06-structure.md | 4 +- .../steps/step-07-patterns.md | 4 +- .../steps/step-08-validation.md | 4 +- .../steps/step-09-complete.md | 2 +- .../3-technical/game-architecture/workflow.md | 2 +- src/modules/bmm/agents/pm.agent.yaml | 12 +- .../prd/{ => data}/domain-complexity.csv | 0 .../2-plan-workflows/prd/data/prd-purpose.md | 197 ++++++++ .../prd/{ => data}/project-types.csv | 0 .../prd/{steps => steps-c}/step-01-init.md | 20 +- .../{steps => steps-c}/step-01b-continue.md | 85 ++-- .../prd/steps-c/step-02-discovery.md | 224 +++++++++ .../prd/{steps => steps-c}/step-03-success.md | 164 ++----- .../prd/steps-c/step-04-journeys.md | 213 +++++++++ .../prd/steps-c/step-05-domain.md | 207 +++++++++ .../{steps => steps-c}/step-06-innovation.md | 122 ++--- .../step-07-project-type.md | 95 ++-- .../prd/{steps => steps-c}/step-08-scoping.md | 157 ++----- .../{steps => steps-c}/step-09-functional.md | 81 +--- .../step-10-nonfunctional.md | 116 ++--- .../prd/steps-c/step-11-polish.md | 217 +++++++++ .../prd/steps-c/step-12-complete.md | 180 ++++++++ .../prd/steps-e/step-e-01-discovery.md | 247 ++++++++++ .../steps-e/step-e-01b-legacy-conversion.md | 208 +++++++++ .../prd/steps-e/step-e-02-review.md | 249 ++++++++++ .../prd/steps-e/step-e-03-edit.md | 253 ++++++++++ .../prd/steps-e/step-e-04-complete.md | 168 +++++++ .../prd/steps-v/step-v-01-discovery.md | 218 +++++++++ .../prd/steps-v/step-v-02-format-detection.md | 191 ++++++++ .../prd/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 +++++++++++ .../prd/steps-v/step-v-10-smart-validation.md | 209 +++++++++ .../step-v-11-holistic-quality-validation.md | 264 +++++++++++ .../step-v-12-completeness-validation.md | 242 ++++++++++ .../prd/steps-v/step-v-13-report-complete.md | 232 ++++++++++ .../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 -------- .../prd/{ => templates}/prd-template.md | 1 - .../prd/validation-report-prd-workflow.md | 433 ++++++++++++++++++ .../2-plan-workflows/prd/workflow.md | 105 ++++- .../steps/step-01-document-discovery.md | 4 +- .../steps/step-02-prd-analysis.md | 4 +- .../steps/step-03-epic-coverage-validation.md | 4 +- .../steps/step-04-ux-alignment.md | 4 +- .../steps/step-05-epic-quality-review.md | 4 +- .../steps/step-06-final-assessment.md | 2 +- .../workflow.md | 2 +- .../steps/step-01-validate-prerequisites.md | 4 +- .../steps/step-02-design-epics.md | 4 +- .../steps/step-03-create-stories.md | 4 +- .../steps/step-04-final-validation.md | 2 +- .../quick-dev/steps/step-01-mode-detection.md | 6 +- .../steps/step-02-context-gathering.md | 4 +- .../quick-dev/steps/step-03-execute.md | 4 +- .../quick-dev/steps/step-04-self-check.md | 4 +- .../steps/step-05-adversarial-review.md | 4 +- .../steps/step-06-resolve-findings.md | 2 +- .../quick-spec/steps/step-01-understand.md | 8 +- .../quick-spec/steps/step-02-investigate.md | 4 +- .../quick-spec/steps/step-03-generate.md | 4 +- src/modules/cis/module.yaml | 1 - 194 files changed, 8349 insertions(+), 5649 deletions(-) delete mode 100644 src/modules/bmb/reference/readme.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md delete mode 100644 src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/profile-section.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md delete mode 100644 src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md create mode 100644 src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md create mode 100644 src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md create mode 100644 src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md rename src/modules/bmm/workflows/2-plan-workflows/prd/{ => data}/domain-complexity.csv (100%) create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md rename src/modules/bmm/workflows/2-plan-workflows/prd/{ => data}/project-types.csv (100%) rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-01-init.md (91%) rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-01b-continue.md (70%) create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-03-success.md (55%) create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-06-innovation.md (58%) rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-07-project-type.md (68%) rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-08-scoping.md (53%) rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-09-functional.md (70%) rename src/modules/bmm/workflows/2-plan-workflows/prd/{steps => steps-c}/step-10-nonfunctional.md (64%) create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md delete mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md delete mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md delete mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md delete mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md rename src/modules/bmm/workflows/2-plan-workflows/prd/{ => templates}/prd-template.md (93%) create mode 100644 src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md index 9ed3ffe2..cb2135c5 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md @@ -6,8 +6,8 @@ description: 'Initialize quiz game with mode selection and category choice' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-q1.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-q1.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' csvTemplate: '{workflow_path}/templates/csv-headers.template' @@ -146,7 +146,7 @@ Display: **Starting your quiz adventure...** ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `{workflow_path}/steps/step-02-q1.md` to begin the first question. +ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `./step-02-q1.md` to begin the first question. ## 🚨 SYSTEM SUCCESS/FAILURE METRICS diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md index 2fe668e1..3141dd3c 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md @@ -6,9 +6,9 @@ description: 'Question 1 - Level 1 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-02-q1.md' -nextStepFile: '{workflow_path}/steps/step-03-q2.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-02-q1.md' +nextStepFile: './step-03-q2.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' # Task References diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md index 489317f9..b7ca00da 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md @@ -6,9 +6,9 @@ description: 'Question 2 - Level 2 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-03-q2.md' -nextStepFile: '{workflow_path}/steps/step-04-q3.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-03-q2.md' +nextStepFile: './step-04-q3.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md index 8184f3e5..c16a0d7f 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md @@ -6,9 +6,9 @@ description: 'Question 3 - Level 3 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-04-q3.md' -nextStepFile: '{workflow_path}/steps/step-04-q3.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-04-q3.md' +nextStepFile: './step-04-q3.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md index ca8fec89..c5e2414f 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md @@ -6,9 +6,9 @@ description: 'Question 4 - Level 4 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-05-q4.md' -nextStepFile: '{workflow_path}/steps/step-05-q4.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-05-q4.md' +nextStepFile: './step-05-q4.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md index d98b43f2..815ee91a 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md @@ -6,9 +6,9 @@ description: 'Question 5 - Level 5 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-06-q5.md' -nextStepFile: '{workflow_path}/steps/step-06-q5.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-06-q5.md' +nextStepFile: './step-06-q5.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md index baaf49f1..d216e0f1 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md @@ -6,9 +6,9 @@ description: 'Question 6 - Level 6 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-07-q6.md' -nextStepFile: '{workflow_path}/steps/step-07-q6.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-07-q6.md' +nextStepFile: './step-07-q6.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md index 1563fb84..1ca2589c 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md @@ -6,9 +6,9 @@ description: 'Question 7 - Level 7 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-08-q7.md' -nextStepFile: '{workflow_path}/steps/step-08-q7.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-08-q7.md' +nextStepFile: './step-08-q7.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md index 8dc7f711..2f1a04eb 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md @@ -6,9 +6,9 @@ description: 'Question 8 - Level 8 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-09-q8.md' -nextStepFile: '{workflow_path}/steps/step-09-q8.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-09-q8.md' +nextStepFile: './step-09-q8.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md index 6c76c0fc..d85b1016 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md @@ -6,9 +6,9 @@ description: 'Question 9 - Level 9 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-10-q9.md' -nextStepFile: '{workflow_path}/steps/step-10-q9.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-10-q9.md' +nextStepFile: './step-10-q9.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md index 4468c937..22eb6ebe 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md @@ -6,9 +6,9 @@ description: 'Question 10 - Level 10 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-11-q10.md' -nextStepFile: '{workflow_path}/steps/results.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-11-q10.md' +nextStepFile: './results.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md index a0eb36d8..0d20ccfb 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md @@ -6,8 +6,8 @@ description: 'Final results and celebration' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-12-results.md' -initStepFile: '{workflow_path}/steps/step-01-init.md' +thisStepFile: './step-12-results.md' +initStepFile: './step-01-init.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' # Task References diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md index badf9c51..b446773d 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md @@ -51,4 +51,4 @@ Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: ### 2. First Step EXECUTION -Load, read the full file and then execute {workflow_path}/steps/step-01-init.md to begin the workflow. +Load, read the full file and then execute ./step-01-init.md to begin the workflow. diff --git a/src/modules/bmb/agents/workflow-builder.agent.yaml b/src/modules/bmb/agents/workflow-builder.agent.yaml index 36281c98..9ac0af16 100644 --- a/src/modules/bmb/agents/workflow-builder.agent.yaml +++ b/src/modules/bmb/agents/workflow-builder.agent.yaml @@ -40,6 +40,10 @@ agent: exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" description: "[VW] Run validation check on BMAD workflows against best practices" + - trigger: MV or fuzzy match on validate-max-parallel-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[MV] Run validation checks in MAX-PARALLEL mode against a workflow (requires a tool that supports Parallel Sub-Processes)" + - trigger: RW or fuzzy match on convert-or-rework-workflow exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" description: "[RW] Rework a Workflow to a V6 Compliant Version" diff --git a/src/modules/bmb/reference/readme.md b/src/modules/bmb/reference/readme.md deleted file mode 100644 index b7e8e17a..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv b/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv deleted file mode 100644 index 5467e306..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv b/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv deleted file mode 100644 index f16c1892..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv b/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv deleted file mode 100644 index 56738992..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md deleted file mode 100644 index a6cb91e7..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md deleted file mode 100644 index a01d7711..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md deleted file mode 100644 index 29fc76b2..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md deleted file mode 100644 index 6e0ead93..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md deleted file mode 100644 index 39a25484..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md deleted file mode 100644 index 6e035b05..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md deleted file mode 100644 index 545ce1c9..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md deleted file mode 100644 index 610f397c..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md deleted file mode 100644 index 8c67f79a..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md deleted file mode 100644 index 1143cd51..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md deleted file mode 100644 index 3784c1d9..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md deleted file mode 100644 index 6a172159..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md deleted file mode 100644 index 9c11d05b..00000000 --- a/src/modules/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/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md deleted file mode 100644 index 4bcdd903..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. -web_bundle: true -standalone: false ---- - -# Meal Prep & Nutrition Plan Workflow - -**Goal:** Create personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. - -**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. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/core/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 `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/workflow/data/architecture.md b/src/modules/bmb/workflows/workflow/data/architecture.md index e0d0c2e1..d594c61a 100644 --- a/src/modules/bmb/workflows/workflow/data/architecture.md +++ b/src/modules/bmb/workflows/workflow/data/architecture.md @@ -91,8 +91,8 @@ workflow.md → step-01-init.md (detects existing) → step-01b-continue.md → ### Standard (All Workflows) ```yaml workflow_path: '{project-root}/_bmad/[module]/workflows/[name]' -thisStepFile: '{workflow_path}/steps/step-[N]-[name].md' -nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' +thisStepFile: './step-[N]-[name].md' +nextStepFile: './step-[N+1]-[name].md' outputFile: '{output_folder}/[output].md' ``` diff --git a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv deleted file mode 100644 index 5467e306..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv deleted file mode 100644 index f16c1892..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv deleted file mode 100644 index 56738992..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md deleted file mode 100644 index a3845ce3..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01-init.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -name: 'step-01-init' -description: 'Initialize the nutrition plan workflow by detecting continuation state and creating output document' - -nextStepFile: './step-02-profile.md' -continueFile: './step-01b-continue.md' - -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' -templateFile: '../templates/nutrition-plan.md' ---- - -# 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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md deleted file mode 100644 index a1ccef43..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-01b-continue.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -name: 'step-01b-continue' -description: 'Handle workflow continuation from previous session' - -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 - -### 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 ./step-03-assessment.md - - IF lastStep = "assessment": load ./step-04-strategy.md - - IF lastStep = "strategy": check cooking frequency, then load load ./step-04-shopping.md - - IF lastStep = "shopping": load ./step-06-prep-schedule.md -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and continuation analysis is complete, will you then update frontmatter and load, read entire file, then execute the appropriate next step file as outlined in menu handling logic. - ---- - -## 🚨 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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md deleted file mode 100644 index 4359cd9d..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-02-profile.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -name: 'step-02-profile' -description: 'Gather comprehensive user profile information through collaborative conversation' - -nextStepFile: './step-03-assessment.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: '../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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md deleted file mode 100644 index 4a06f6ef..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-03-assessment.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -name: 'step-03-assessment' -description: 'Analyze nutritional requirements, identify restrictions, and calculate target macros' - -nextStepFile: './step-04-strategy.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: '../data/dietary-restrictions.csv' -macroCalculatorDB: '../data/macro-calculator.csv' - -# Template References -assessmentTemplate: '../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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md deleted file mode 100644 index 8012ea63..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-04-strategy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -name: 'step-04-strategy' -description: 'Design a personalized meal strategy that meets nutritional needs and fits lifestyle' - -nextStepFile: './step-05-shopping.md' -alternateNextStepFile: './step-06-prep-schedule.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: '../data/recipe-database.csv' - -# Template References -strategyTemplate: '../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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md deleted file mode 100644 index ab565a63..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-05-shopping.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -name: 'step-05-shopping' -description: 'Create a comprehensive shopping list that supports the meal strategy' - -nextStepFile: './step-06-prep-schedule.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: '../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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md deleted file mode 100644 index 4db06828..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/steps-c/step-06-prep-schedule.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -name: 'step-06-prep-schedule' -description: "Create a realistic meal prep schedule that fits the user's lifestyle" - -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: '../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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md deleted file mode 100644 index 610f397c..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md deleted file mode 100644 index 8c67f79a..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md deleted file mode 100644 index 1143cd51..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/profile-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/profile-section.md deleted file mode 100644 index 3784c1d9..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md deleted file mode 100644 index 6a172159..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md deleted file mode 100644 index 9c11d05b..00000000 --- a/src/modules/bmb/workflows/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/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md b/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md deleted file mode 100644 index b24c0cb7..00000000 --- a/src/modules/bmb/workflows/workflow/data/examples/meal-prep-nutrition/workflow.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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. -web_bundle: true -standalone: false ---- - -# Meal Prep & Nutrition Plan Workflow - -**Goal:** Create personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. - -**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. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `user_skill_level` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `./steps-c/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md b/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md index ba3dda17..86432a92 100644 --- a/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md +++ b/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md @@ -14,14 +14,14 @@ ## Standard Variables (Always Available) -| Variable | Example Value | -| ----------------- | -------------------------------------- | -| `{project-root}` | `/Users/user/dev/BMAD-METHOD` | -| `{project_name}` | `my-project` | -| `{output_folder}` | `/Users/user/dev/BMAD-METHOD/output` | -| `{user_name}` | `Brian` | -| `{communication_language}` | `english` | -| `{document_output_language}` | `english` | +| Variable | Example Value | +| ---------------------------- | ------------------------------------ | +| `{project-root}` | `/Users/user/dev/BMAD-METHOD` | +| `{project_name}` | `my-project` | +| `{output_folder}` | `/Users/user/dev/BMAD-METHOD/output` | +| `{user_name}` | `Brian` | +| `{communication_language}` | `english` | +| `{document_output_language}` | `english` | --- @@ -101,7 +101,7 @@ nextStepFile: './step-02-foo.md' ### 1. Step to Step (SAME folder) = ./filename.md ```yaml # ❌ WRONG -nextStepFile: '{workflow_path}/steps/step-02.md' +nextStepFile: './step-02.md' nextStepFile: '{project-root}/_bmad/bmm/workflows/foo/steps/step-02.md' # ✅ CORRECT @@ -145,14 +145,14 @@ outputFile: '{output_folder}/output.md' These patterns are **NEVER ALLOWED** in workflow step frontmatter: -| Pattern | Why It's Wrong | -|---------|----------------| -| `workflow_path: '{project-root}/...'` | Use relative paths instead | -| `thisStepFile: './step-XX.md'` | Almost never used - remove unless actually referenced | -| `workflowFile: './workflow.md'` | Almost never used - remove unless actually referenced | -| `{workflow_path}/steps/...` | Use `./step-XX.md` (same folder) | -| `{workflow_path}/templates/...` | Use `../template.md` (parent folder) | -| `{workflow_path}/data/...` | Use `./data/file.md` (subfolder) | +| Pattern | Why It's Wrong | +| ------------------------------------- | ----------------------------------------------------- | +| `workflow_path: '{project-root}/...'` | Use relative paths instead | +| `thisStepFile: './step-XX.md'` | Almost never used - remove unless actually referenced | +| `workflowFile: './workflow.md'` | Almost never used - remove unless actually referenced | +| `./...` | Use `./step-XX.md` (same folder) | +| `{workflow_path}/templates/...` | Use `../template.md` (parent folder) | +| `{workflow_path}/data/...` | Use `./data/file.md` (subfolder) | --- @@ -160,13 +160,13 @@ These patterns are **NEVER ALLOWED** in workflow step frontmatter: Use `snake_case` with descriptive prefixes: -| Pattern | Usage | Example | -| --------- | ---------------------- | -------------------------- | -| `{*_File}` | File references | `outputFile`, `nextStepFile` | -| `{*_Task}` | Task references | `advancedElicitationTask` | -| `{*_Workflow}` | Workflow references | `partyModeWorkflow` | -| `{*_Template}` | Templates | `productBriefTemplate` | -| `{*_Data}` | Data files | `dietaryData` | +| Pattern | Usage | Example | +| -------------- | ------------------- | ---------------------------- | +| `{*_File}` | File references | `outputFile`, `nextStepFile` | +| `{*_Task}` | Task references | `advancedElicitationTask` | +| `{*_Workflow}` | Workflow references | `partyModeWorkflow` | +| `{*_Template}` | Templates | `productBriefTemplate` | +| `{*_Data}` | Data files | `dietaryData` | --- diff --git a/src/modules/bmb/workflows/workflow/data/step-type-patterns.md b/src/modules/bmb/workflows/workflow/data/step-type-patterns.md index 4bc9478a..772b6be3 100644 --- a/src/modules/bmb/workflows/workflow/data/step-type-patterns.md +++ b/src/modules/bmb/workflows/workflow/data/step-type-patterns.md @@ -11,7 +11,7 @@ All steps share this skeleton: --- name: 'step-[N]-[name]' description: '[what it does]' -[file references - ONLY used variables] +[file references - relative path and only if used in this steps file] --- # Step [N]: [Name] @@ -76,10 +76,9 @@ description: '[what it does]' --- name: 'step-01-init' description: 'Initialize [workflow]' -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-[name].md' +nextStepFile: './step-02-[name].md' outputFile: '{output_folder}/[output].md' -templateFile: '{workflow_path}/templates/[template].md' +templateFile: '../templates/[template].md' --- ``` @@ -97,7 +96,7 @@ templateFile: '{workflow_path}/templates/[template].md' **Frontmatter:** Add `continueFile` reference ```yaml -continueFile: '{workflow_path}/steps/step-01b-continue.md' +continueFile: './step-01b-continue.md' ``` **Logic:** @@ -140,7 +139,7 @@ workflowFile: '{workflow_path}/workflow.md' ```yaml --- name: 'step-[N]-[name]' -nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' +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' @@ -161,8 +160,8 @@ partyModeWorkflow: '{project-root}/.../party-mode/workflow.md' **Frontmatter:** ```yaml -nextStepFile: '{workflow_path}/steps/step-[default].md' -altStepFile: '{workflow_path}/steps/step-[alternate].md' +nextStepFile: './step-[default].md' +altStepFile: './step-[alternate].md' ``` **Menu:** Custom letters (L/R/etc.) with branching logic @@ -297,16 +296,16 @@ Mark workflow complete ## Step Size Guidelines -| Type | Recommended | Maximum | -| ------------------------ | ----------- | ------- | -| Init | < 100 | 150 | -| Init (with discovery) | < 150 | 200 | -| Continuation | < 150 | 200 | -| Middle (simple) | < 150 | 200 | -| Middle (complex) | < 200 | 250 | -| Branch | < 150 | 200 | -| Validation sequence | < 100 | 150 | -| Final polish | < 150 | 200 | -| Final | < 150 | 200 | +| Type | Recommended | Maximum | +| --------------------- | ----------- | ------- | +| Init | < 100 | 150 | +| Init (with discovery) | < 150 | 200 | +| Continuation | < 150 | 200 | +| Middle (simple) | < 150 | 200 | +| Middle (complex) | < 200 | 250 | +| Branch | < 150 | 200 | +| Validation sequence | < 100 | 150 | +| Final polish | < 150 | 200 | +| Final | < 150 | 200 | **If exceeded:** Split into multiple steps or extract to `/data/` files. diff --git a/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md b/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md new file mode 100644 index 00000000..5aa17a34 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md @@ -0,0 +1,386 @@ +# 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** (massive context savings) +3. **Always provide graceful fallback** for LLMs without subprocess capability +4. **Match pattern to operation type** - grep/regex, deep analysis, or data operations + +--- + +## The Three Patterns + +### Pattern 1: Single Subprocess for Grep/Regex Across Many Files + +**Use when:** You can run one command across many files and just need matches/failures + +**Context savings:** Massive - returns only matching lines, not full file contents + +**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 + +```bash +# Example: Find hardcoded paths across all files +for file in steps-c/*.md; do + grep -n "{project-root}/" "$file" || echo "No matches in: $file" +done +``` + +**Subprocess returns to parent:** +```json +{ + "violations": [ + {"file": "step-02.md", "line": 45, "match": "{project-root}/_bmad/bmb/..."} + ], + "summary": {"total_files_checked": 10, "violations_found": 3} +} +``` + +**❌ BAD - Loads all files into parent:** +```markdown +"For EACH file, load the file and search for {project-root}/" +# Parent context gets 10 full files × 200 lines = 2000 lines loaded +``` + +**✅ GOOD - Single subprocess returns only matches:** +```markdown +"Launch a subprocess to grep all files for {project-root}/, return only matches" +# Parent context gets only matching lines = ~50 lines returned +``` + +--- + +### Pattern 2: Separate Subprocess Per File for Deep Analysis + +**Use when:** You need to read and understand each file's prose, logic, quality, or flow + +**Context savings:** High - each subprocess returns analysis, not full content + +**Template:** +```markdown +**DO NOT BE LAZY - For EACH file, launch a subprocess that:** + +1. Loads that file +2. Reads and analyzes content deeply (prose, logic, flow, quality) +3. Returns structured analysis findings to parent for aggregation + +**Subprocess returns to parent:** +```json +{ + "file": "step-03-inquiry.md", + "analysis": { + "instruction_style": "Intent-based ✅", + "collaborative_quality": "Good - asks 1-2 questions at a time", + "issues": ["Line 67: Laundry list of 7 questions detected"] + }, + "optimization_opportunities": ["Could use Pattern 1 for menu validation checks"] +} +``` + +**Example use cases:** +- Instruction style validation (read prose, classify intent vs prescriptive) +- Collaborative quality assessment (analyze question patterns) +- Frontmatter compliance (check each variable is used) +- Step type validation (verify step follows its type pattern) + +**❌ BAD - Parent loads all files:** +```markdown +"Load every step file and analyze its instruction style" +# Parent context: 10 files × 200 lines = 2000 lines +``` + +**✅ GOOD - Per-file subprocess returns analysis:** +```markdown +"DO NOT BE LAZY - For EACH step file, launch a subprocess to analyze instruction style, return findings" +# Parent context: 10 structured analysis objects = ~200 lines +``` + +--- + +### Pattern 3: Subprocess for Data File Operations + +**Use when:** Loading reference data, finding fuzzy/best matches, summarizing key findings from large datasets + +**Context savings:** Massive - returns only matching rows or summaries, not entire data file + +**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 + +**Subprocess returns to parent:** +```json +{ + "matches": [ + {"row": 42, "rule": "Frontmatter variables must be used in body", "applies": true}, + {"row": 87, "rule": "Relative paths for same-folder refs", "applies": true} + ], + "summary": {"total_rules": 150, "applicable_rules": 2} +} +``` + +**Example use cases:** +- **Reference rules lookup**: Load 500-line standards file, return only applicable rules +- **CSV fuzzy matching**: Load product database, find best matching category +- **Document summarization**: Review 10 documents, extract only key requirements +- **Knowledge base search**: Search large knowledge base, return only top matches + +**❌ BAD - Parent loads entire data file:** +```markdown +"Load {dataFile} with 500 rules and find applicable ones" +# Parent context: All 500 rules loaded (5000+ lines) +``` + +**✅ GOOD - Subprocess returns only matches:** +```markdown +"Launch subprocess to load {dataFile}, find applicable rules, return only those" +# Parent context: Only 2 applicable rules returned (~50 lines) +``` + +**Advanced example - Document review:** +```markdown +**Review 10 requirement documents to extract key details:** + +"DO NOT BE LAZY - For EACH document, launch a subprocess that: +1. Loads that document +2. Extracts key requirements, decisions, constraints +3. Returns structured summary to parent + +**Subprocess returns:** +```json +{ + "document": "prd-requirements.md", + "key_findings": { + "requirements": ["User auth", "Data export", "API integration"], + "decisions": ["Use JWT", "PostgreSQL", "REST API"], + "constraints": ["HIPAA compliant", "Max 100ms response"] + } +} +``` + +# Parent gets summaries, not 10 full documents +``` + +--- + +## Pattern 4: Parallel Execution Opportunities + +**Use when:** Multiple independent operations could run simultaneously + +**Performance gain:** Reduced total execution time via parallelization + +**Template:** +```markdown +**Launch subprocesses in parallel that:** + +1. Each subprocess handles one independent operation +2. All subprocesses run simultaneously +3. Parent aggregates results when all complete + +**Example:** +```markdown +# Instead of sequential (3× time): +"Check frontmatter, then check menu, then check step types" + +# Use parallel (1× time): +"Launch 3 subprocesses in parallel: +- Subprocess 1: Check frontmatter compliance +- Subprocess 2: Check menu compliance +- Subprocess 3: Check step type compliance +Aggregate all findings" +``` + +--- + +## Graceful Fallback Pattern + +**CRITICAL:** Always ensure LLMs without subprocess capability can still execute + +**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 + +### Execution: +- LLMs with subprocess: Launch subprocess, aggregate findings +- LLMs without subprocess: Perform same operations sequentially in main context +``` + +--- + +## Return Pattern for Subprocesses + +**Subprocesses must either:** + +**Option A: Update report directly** +```markdown +"Subprocess loads validation report, appends findings, saves" +# Parent doesn't need to aggregate +``` + +**Option B: Return structured findings to parent** +```markdown +"Subprocess returns JSON findings to parent for aggregation" +# Parent compiles all subprocess results into report +``` + +**✅ GOOD - Structured return:** +```json +{ + "file": "step-02.md", + "violations": ["..."], + "opportunities": ["..."], + "priority": "HIGH" +} +``` + +**❌ BAD - Returns full content:** +```markdown +"Subprocess loads file and returns full content to parent" +# Defeats purpose - parent gets full context anyway +``` + +--- + +## When to Use Each Pattern + +| Pattern | Use When | Context Savings | Example | +| -------- | -------- | --------------- | ------- | +| **Pattern 1: Single subprocess for grep/regex** | Finding patterns across many files | Massive (1000:1 ratio) | Validate frontmatter across all steps | +| **Pattern 2: Per-file subprocess for deep analysis** | Understanding prose, logic, quality | High (10:1 ratio) | Instruction style validation | +| **Pattern 3: Data file operations** | Loading reference data, matching, summarizing | Massive (100:1 ratio) | Find applicable rules from standards | +| **Pattern 4: Parallel execution** | Independent operations that can run simultaneously | Performance gain | Frontmatter + Menu + Step type checks | + +--- + +## Step File Integration + +**How to add subprocess patterns to step files:** + +### 1. Universal Rule (add to 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 +``` + +### 2. Step-Specific Rules (pattern-specific) +```markdown +### Step-Specific Rules: +- 🎯 [Brief: which pattern applies] +- 💬 Subprocess must either update report OR return findings to parent +- 🚫 DO NOT BE LAZY - [specific "do not be lazy" guidance if applicable] +``` + +### 3. Command Sequence (detailed pattern) +```markdown +### 1. [Operation Name] + +**[Appropriate subprocess directive]:** + +For [Pattern 1 - grep/regex]: +"Launch a subprocess that runs [command] across all files, returns [results]" + +For [Pattern 2 - per-file analysis]: +"DO NOT BE LAZY - For EACH file, launch a subprocess that [analyzes], returns [findings]" + +For [Pattern 3 - data ops]: +"Launch a subprocess that loads [data file], performs [operation], returns [results]" +``` + +--- + +## Subprocess Loading Reference Data (Meta-Pattern!) + +**Context-saving optimization:** + +When a step needs to understand subprocess patterns with examples, load this reference file in a subprocess: + +```markdown +### Step-Specific Rules: +- 🎯 Analyze subprocess optimization opportunities - use subprocess to load reference patterns for detailed examples +- 💬 Subprocess loads {subprocessPatterns} to understand patterns deeply, returns specific opportunities +- 🚫 If subprocess unavailable: Load {subprocessPatterns} in main context + +**Execution:** +- With subprocess: Launch subprocess to load this file, understand patterns, identify opportunities +- Without subprocess: Load this file in main context (larger context but still functional) +``` + +**This step file (step-08b) demonstrates this pattern!** + +--- + +## Validation Checklist + +For subprocess optimization in step files: + +- [ ] 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 +- [ ] Context savings estimated (if applicable) +- [ ] Pattern matches operation type (grep/regex, deep analysis, or data ops) + +--- + +## Anti-Patterns to Avoid + +### ❌ Loading full files into parent +```markdown +"For EACH file, load the file, analyze it, and add to report" +# Defeats purpose - parent gets full context +``` + +### ❌ Subprocess returns raw content +```markdown +"Subprocess loads file and returns content to parent" +# Parent gets full content anyway +``` + +### ❌ No graceful fallback +```markdown +"Use subprocess to [operation]" +# LLMs without subprocess cannot proceed +``` + +### ❌ Wrong pattern for operation +```markdown +"Launch a subprocess per file to grep for pattern" +# Should use Pattern 1 (single subprocess for all files) +``` + +### ❌ Missing return specification +```markdown +"Launch a subprocess to analyze files" +# Unclear what subprocess returns to parent +``` + +--- + +## See Also + +- `step-file-rules.md` - When to extract content to data files +- `step-08b-subprocess-optimization.md` - Validation step that identifies optimization opportunities +- `../steps-v/step-02b-path-violations.md` - Example of Pattern 1 (grep across files) +- `../steps-v/step-08b-subprocess-optimization.md` - Example of Pattern 2 (per-file analysis) diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md b/src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md new file mode 100644 index 00000000..f3280dbd --- /dev/null +++ b/src/modules/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/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md b/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md index f3b1da67..90e1baa2 100644 --- a/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md +++ b/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md @@ -15,6 +15,7 @@ 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 @@ -66,7 +67,7 @@ To collaboratively design the workflow structure, step sequence, and interaction ## DESIGN REFERENCE MATERIALS: -When designing, you may load these data standards 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): - {stepTemplate} - Step file structure template - {stepTypePatterns} - Templates for different step types (init, middle, branch, validation, final) @@ -77,8 +78,7 @@ When designing, you may load these data standards as needed: - {workflowChainingStandards} - How workflows connect in sequences - {trimodalWorkflowStructure} - Tri-modal workflow patterns (if applicable) -Example workflow: -- `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md` +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 @@ -175,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: diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md b/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md index 8179ed35..17f59142 100644 --- a/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md +++ b/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md @@ -11,6 +11,7 @@ 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' --- @@ -266,6 +267,49 @@ Display continuation status and offer to proceed. **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}: diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md b/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md index e7dcbb5e..54b7a960 100644 --- a/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md +++ b/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md @@ -11,6 +11,7 @@ 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' --- @@ -97,6 +98,49 @@ Confirm: "The next step to build is **step-{N}-{name}** which is a [step type]. **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. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md new file mode 100644 index 00000000..36624900 --- /dev/null +++ b/src/modules/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/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md index f605f15a..27325912 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md @@ -3,9 +3,9 @@ name: 'step-01-validate' description: 'Initialize validation: create report and check file structure & size' nextStepFile: './step-02-frontmatter-validation.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +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' --- @@ -23,28 +23,22 @@ To create the validation report and check that the workflow has correct file str - 📖 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 -- 🚫 DO NOT skip checking any file -- 💬 Append findings to report, then auto-load next step +- 🎯 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 -- 💾 Append findings to validation report +- 🎯 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 -## CONTEXT BOUNDARIES: - -- Workflow has been built in steps-c/ -- Check the entire folder structure -- Verify all required files exist -- Check file sizes against limits - ## MANDATORY SEQUENCE **CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. @@ -57,7 +51,7 @@ Create {validationReportFile} with header structure: --- validationDate: [current date] workflowName: {new_workflow_name} -workflowPath: {targetWorkflowPath} +workflowPath: {workflow_folder_path} validationStatus: IN_PROGRESS --- @@ -76,6 +70,9 @@ validationStatus: IN_PROGRESS ## Frontmatter Validation *Pending...* +## Critical Path Violations +*Pending...* + ## Menu Handling Validation *Pending...* @@ -94,9 +91,15 @@ validationStatus: IN_PROGRESS ## Collaborative Experience Check *Pending...* +## Subprocess Optimization Opportunities +*Pending...* + ## Cohesive Review *Pending...* +## Plan Quality Validation +*Pending...* + ## Summary *Pending...* ``` @@ -110,19 +113,27 @@ Load {stepFileRules} to understand: ### 3. Check Folder Structure -**DO NOT BE LAZY - List EVERY folder and file:** +**Launch a single subprocess that:** -Use bash commands to list the entire structure: +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-c/ +├── 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 │ └── ... -├── steps-v/ -│ └── [this validation] +├── */ # any other random files - critical will be later ensure its all used - aside from potential documentation for user later. ├── data/ │ └── [as needed] └── templates/ @@ -131,53 +142,34 @@ Use bash commands to list the entire structure: **Check:** - ✅ workflow.md exists -- ✅ steps-c/ folder exists with all step files -- ✅ data/ folder exists (may be empty) -- ✅ templates/ folder exists (may be empty) -- ✅ No unexpected files -- ✅ Folder names follow conventions +- ✅ 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 - Check EVERY step file:** +**DO NOT BE LAZY - For EACH step file in steps-c/, launch a subprocess that:** -For each file in `steps-c/`: -1. Read the file -2. Count lines -3. Check against limits: - - < 200 lines: ✅ Good - - 200-250 lines: ⚠️ Approaching limit - - > 250 lines: ❌ Exceeds limit +1. Loads that step file +2. Counts lines and checks against size limits +3. Returns structured findings to parent for aggregation -**Check for Large Data Files:** +**Limits:** +- < 200 lines: ✅ Good +- 200-250 lines: ⚠️ Approaching limit +- > 250 lines: ❌ Exceeds limit -For each file in `data/` folder: -1. Check file size in lines -2. If > 500 lines: ⚠️ WARNING - Large data file detected -3. If > 1000 lines: ❌ ERROR - Data file too large for direct loading +**Subprocess returns:** File name, line count, status (Good/Approaching limit/Exceeds limit), and any issues found. -**For large data files, recommend:** -- Create an index/csv/yaml so LLM knows what's available and can load specific sections -- Use sharding technique (core module has sharding tool) to split large files -- Consider if all data is needed or if lookup/reference pattern would work better +**Subprocess must either:** +- Update validation report directly with findings, OR +- Return structured findings to parent for aggregation into report -**Report format:** -```markdown -### File Size Check - -| File | Lines | Status | -|------|-------|--------| -| step-01-init.md | 180 | ✅ Good | -| step-02-*.md | 245 | ⚠️ Approaching limit | -| step-03-*.md | 267 | ❌ Exceeds limit - should split | - -### Data File Size Check - -| Data File | Lines | Status | -|-----------|-------|--------| -| reference-data.csv | 150 | ✅ Good | -| large-data.md | 2500 | ❌ Too large - use sharding or create index | -``` +**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 @@ -191,28 +183,12 @@ From the design in {workflowPlanFile}, verify: Replace the "## File Structure & Size" section in {validationReportFile} with actual findings: -```markdown -## File Structure & Size - -### Folder Structure -[Report findings - is structure correct?] - -### Files Present -[Report findings - are all required files present?] - -### File Size Check -[Table as shown above] - -### Issues Found -[List any issues: -- Missing files -- Extra files -- Size violations -- Naming convention violations] - -### Status -✅ PASS / ❌ FAIL / ⚠️ WARNINGS -``` +**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 diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md b/src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md new file mode 100644 index 00000000..927f03fb --- /dev/null +++ b/src/modules/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/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md index 71778037..09dde534 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md @@ -2,9 +2,9 @@ name: 'step-02-frontmatter-validation' description: 'Validate frontmatter compliance across all step files' -nextStepFile: './step-03-menu-validation.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +nextStepFile: './step-02b-path-violations.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' frontmatterStandards: '../data/frontmatter-standards.md' --- @@ -18,23 +18,24 @@ To validate that EVERY step file's frontmatter follows the frontmatter standards ### Universal Rules: -- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 🛑 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: -- 🎯 Load and validate EVERY step file's frontmatter -- 🚫 DO NOT skip any files or checks -- 💬 Append findings to report, then auto-load next step -- 🚪 This is validation - systematic and thorough +- 🎯 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 -- 💾 Check EVERY file against standards -- 📖 Append findings to validation report +- 🎯 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: @@ -60,12 +61,22 @@ Load {frontmatterStandards} to understand validation criteria. - `workflow_path: '...'` - use relative paths instead - `thisStepFile: '...'` - remove unless actually referenced in body - `workflowFile: '...'` - remove unless actually referenced in body -- `{workflow_path}/steps/...` - use `./step-XX.md` +- `./...` - use `./step-XX.md` - `{workflow_path}/templates/...` - use `../template.md` -### 2. Validate EVERY Step File - Systematic Algorithm +### 2. Validate EVERY Step File - Systematic Algorithm with Subprocess Optimization -**DO NOT BE LAZY - For EACH step file:** +**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 @@ -125,34 +136,29 @@ if path contains "{project-root}" and is internal workflow reference: MARK_AS_VIOLATION("Internal paths must be relative, not project-root") ``` -### 3. Document Findings +**RETURN FORMAT:** -Create report table: +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. -```markdown -### Frontmatter Validation Results +Check ALL files systematically. Return findings for compilation and appendage to validation report. -| File | Required | All Vars Used | Relative Paths | No Forbidden | Status | -|------|----------|---------------|----------------|-------------|--------| -| step-01-init.md | ✅ | ❌ Unused: thisStepFile, workflowFile | ✅ | ✅ | ❌ FAIL | -| step-02-vision.md | ✅ | ✅ | ✅ | ✅ | ✅ PASS | -``` +### 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 -For EACH file with violations: - -```markdown -### Violations Found - -**step-01-init.md:** -- ❌ Unused variable: `thisStepFile` (defined but {thisStepFile} never appears in body) -- ❌ Unused variable: `workflowFile` (defined but {workflowFile} never appears in body) -- ❌ Forbidden pattern: `workflow_path` variable found (use relative paths instead) - -**step-02-vision.md:** -- ✅ All checks passed -``` +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 @@ -173,20 +179,21 @@ Then immediately load, read entire file, then execute {nextStepFile}. ### ✅ SUCCESS: -- EVERY step file's frontmatter validated using systematic algorithm -- Each variable checked for usage in step body -- Each path checked for proper relative format +- 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 appended to report +- Findings aggregated into validation report - Report saved before proceeding - Next validation step loaded ### ❌ SYSTEM FAILURE: -- Not checking every file -- Not systematically checking each variable for usage +- 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. DO NOT BE LAZY. For EACH variable in frontmatter, verify it's used in the body. For EACH path, verify it's relative. Auto-proceed through all validation steps. +**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/src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md b/src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md new file mode 100644 index 00000000..cfb442cc --- /dev/null +++ b/src/modules/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/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md index 77242856..89f7c980 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md @@ -3,8 +3,8 @@ name: 'step-03-menu-validation' description: 'Validate menu handling compliance across all step files' nextStepFile: './step-04-step-type-validation.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' menuHandlingStandards: '../data/menu-handling-standards.md' --- @@ -22,19 +22,20 @@ To validate that EVERY step file's menus follow the menu handling standards - pr - 📖 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 file's menus -- 🚫 DO NOT skip any files or checks -- 💬 Append findings to report, then auto-load next step -- 🚪 This is validation - systematic and thorough +- 🎯 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 -- 📖 Append findings to validation report +- 💾 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: @@ -64,11 +65,15 @@ Load {menuHandlingStandards} to understand validation criteria: ### 2. Check EVERY Step File -**DO NOT BE LAZY - For EACH file in steps-c/:** +**DO NOT BE LAZY - For EVERY file in steps-c/, launch a subprocess that:** -1. Load the file -2. Find the menu section (if present) -3. Validate against each rule: +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 @@ -92,39 +97,35 @@ Load {menuHandlingStandards} to understand validation criteria: - Validation sequences should auto-proceed, not have menus - ❌ If A/P in wrong place: mark as violation -### 3. Document Findings +**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) -Create report table: +**Context savings estimate:** Each subprocess returns structured findings vs full file content. Parent aggregates all findings into final report table. -```markdown -### Menu Handling Validation Results +### 3. Aggregate Findings and Document Results -| File | Has Menu | Handler Section | Exec Rules | A/P Appropriate | Status | -|------|----------|----------------|------------|-----------------|--------| -| step-01-init.md | ✅ (C-only) | ✅ | ✅ | N/A | ✅ PASS | -| step-02-*.md | ✅ (A/P/C) | ✅ | ✅ | ✅ | ✅ PASS | -| step-03-*.md | ✅ (C-only) | ❌ Missing | ⚠️ Incomplete | N/A | ❌ FAIL | -| step-04-*.md | ❌ No menu | N/A | N/A | Should have A/P/C | ⚠️ WARN | -``` +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 -```markdown -### Menu Violations Found +Compile and document all violations found during validation, organizing them by file and providing clear descriptions of each issue, such as: -**step-03-[name].md:** -- Missing handler section after menu display -- EXECUTION RULES section incomplete - -**step-04-[name].md:** -- No menu found - this is a collaborative content step, should have A/P/C menu - -**step-05-[name].md:** -- A/P options don't specify "redisplay menu" after execution - -**step-06-[name].md:** -- All checks passed ✅ -``` +- Missing handler sections +- Incomplete execution rules +- Improper A/P usage +- Missing redisplay menu instructions +- Any other menu handling standard violations ### 5. Append to Report @@ -145,9 +146,10 @@ Then immediately load, read entire file, then execute {nextStepFile}. ### ✅ SUCCESS: -- EVERY step file's menus validated -- All violations documented -- Findings appended to report +- 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 @@ -157,5 +159,6 @@ Then immediately load, read entire file, then execute {nextStepFile}. - 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. Check EVERY file's menus. Auto-proceed through all validation steps. +**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/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md index cccc58be..544ae506 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md @@ -3,10 +3,10 @@ name: 'step-04-step-type-validation' description: 'Validate that each step follows its correct step type pattern' nextStepFile: './step-05-output-format-validation.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' stepTypePatterns: '../data/step-type-patterns.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' --- # Validation Step 4: Step Type Validation @@ -23,19 +23,20 @@ To validate that each step file follows the correct pattern for its step type - - 📖 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 -- 🚫 DO NOT skip any files or checks -- 💬 Append findings to report, then auto-load next step +- 🎯 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 -- 💾 Check EACH file follows its designated type pattern -- 📖 Append findings to validation report +- 🎯 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: @@ -50,7 +51,21 @@ To validate that each step file follows the correct pattern for its step type - ### 1. Load Step Type Patterns -Load {stepTypePatterns} to understand the pattern for each type: +**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 @@ -66,16 +81,21 @@ Load {stepTypePatterns} to understand the pattern for each type: ### 2. Check EACH Step Against Its Type -**DO NOT BE LAZY - For EACH file in steps-c/:** +**DO NOT BE LAZY - For EACH file in steps-c/, launch a subprocess that:** -1. Determine what type this step SHOULD be from: +1. Determines what type this step SHOULD be from: - Step number (01 = init, 01b = continuation, last = final) - Design in {workflowPlanFile} - Step name pattern -2. Load the step file +2. Loads the step file -3. Validate it follows the pattern for its type: +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) @@ -114,42 +134,46 @@ Load {stepTypePatterns} to understand the pattern for each type: - ✅ Completion message - ✅ No next step to load -### 3. Document Findings +**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 -Create report table: +**Context savings:** Each subprocess returns only validation findings, not full file contents. Parent receives structured analysis objects instead of 10+ full step files. -```markdown -### Step Type Validation Results +### 3. Aggregate Findings and Document -| File | Should Be Type | Follows Pattern | Issues | Status | -|------|----------------|-----------------|--------|--------| -| step-01-init.md | Init (Continuable) | ✅ | None | ✅ PASS | -| step-01b-continue.md | Continuation | ✅ | None | ✅ PASS | -| step-02-*.md | Middle (Standard) | ✅ | None | ✅ PASS | -| step-03-*.md | Middle (Simple) | ❌ | Has A/P (should be C-only) | ❌ FAIL | -| step-04-*.md | Branch | ⚠️ | Missing custom menu letters | ⚠️ WARN | -| step-N-final.md | Final | ✅ | None | ✅ PASS | -``` +**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 -```markdown -### Step Type Violations Found +**Compile and document all violations found:** -**step-03-[name].md:** -- Designated as Middle (Simple) but has A/P menu -- Should have C-only menu +**Document the following for any violations:** -**step-04-[name].md:** -- Designated as Branch but missing custom menu letters -- Handler doesn't route to different steps +- 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) -**step-05-[name].md:** -- Designated as Validation Sequence but has user menu -- Should auto-proceed - -**All other steps:** ✅ Follow their type patterns correctly -``` +**For files that pass validation:** Briefly note they follow their type patterns correctly. ### 5. Append to Report @@ -170,11 +194,12 @@ Then immediately load, read entire file, then execute {nextStepFile}. ### ✅ SUCCESS: -- EVERY step validated against its type pattern -- All violations documented -- Findings appended to report +- 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: diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md index d5da8dad..c6e1ec62 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md @@ -3,10 +3,10 @@ name: 'step-05-output-format-validation' description: 'Validate output format compliance - template type, final polish, step-to-output mapping' nextStepFile: './step-06-validation-design-check.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' outputFormatStandards: '../data/output-format-standards.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' --- # Validation Step 5: Output Format Validation @@ -23,12 +23,13 @@ To validate that the workflow's output format matches the design - correct templ - 📖 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 against design specifications -- 🚫 DO NOT skip any checks -- 💬 Append findings to report, then auto-load next step +- 🎯 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: @@ -36,6 +37,7 @@ To validate that the workflow's output format matches the design - correct templ - 🎯 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: @@ -114,11 +116,32 @@ From {workflowPlanFile}, identify: ### 5. Validate Step-to-Output Mapping -**For EACH step that outputs to document:** +**DO NOT BE LAZY - For EACH step that outputs to document, launch a subprocess that:** -1. Check the step has `outputFile` in frontmatter -2. Check the step appends/writes to output before loading next -3. Check the menu C option saves to output before proceeding +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 @@ -128,36 +151,15 @@ From {workflowPlanFile}, identify: ### 6. Document Findings -```markdown -### Output Format Validation Results +Document your output format validation findings in the validation report. Include: -**Workflow Produces Documents:** [Yes/No] - -**Template Type:** [Free-form/Structured/Semi-structured/Strict] - -**Template File Check:** -- Template exists: ✅/❌ -- Matches designed type: ✅/❌ -- Proper frontmatter: ✅/❌ - -**Final Polish Step:** -- Required: [Yes/No - based on template type] -- Present: ✅/❌ -- Loads entire document: ✅/❌ -- Optimizes flow: ✅/❌ - -**Step-to-Output Mapping:** -| Step | Has Output Variable | Saves Before Next | Status | -|------|-------------------|-------------------|--------| -| step-01-init.md | ✅ | ✅ | ✅ | -| step-02-*.md | ✅ | ✅ | ✅ | -| step-03-*.md | ❌ | N/A | ❌ FAIL | - -**Issues Found:** -[List any issues with template, polish step, or mapping] - -**Status:** ✅ PASS / ❌ FAIL / ⚠️ WARNINGS -``` +- **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 @@ -180,10 +182,11 @@ Then immediately load, read entire file, then execute {nextStepFile}. - Template type matches design - Final polish step present if needed -- Step-to-output mapping validated +- 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: @@ -191,5 +194,7 @@ Then immediately load, read entire file, then execute {nextStepFile}. - 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. Auto-proceed through all validation steps. +**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/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md index f0f0cf32..2c4c98a7 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md @@ -3,9 +3,9 @@ name: 'step-06-validation-design-check' description: 'Check if workflow has proper validation steps that load validation data (if validation is critical)' nextStepFile: './step-07-instruction-style-check.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +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' --- @@ -23,18 +23,20 @@ To check if the workflow has proper validation steps when validation is critical - 📖 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 -- 🚫 DO NOT skip any validation step reviews -- 💬 Append findings to report, then auto-load next step +- 🎯 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 -- 💾 Check validation steps exist and are well-designed +- 🎯 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 @@ -67,11 +69,13 @@ From {workflowPlanFile}, check: ### 2. If Validation Is Critical, Check Validation Steps -**DO NOT BE LAZY - For EACH validation step in the workflow:** +**DO NOT BE LAZY - For EVERY validation step file, launch a subprocess that:** -1. Find the step (usually named with "validate", "check", "review") -2. Load the step file -3. Check for: +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 @@ -93,7 +97,27 @@ From {workflowPlanFile}, check: - ⚠️ For non-critical flows (entertainment, therapy, casual): validation may be inline - ❌ ERROR if critical validation is mixed into create steps -### 3. Check Validation Data Files +**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:** @@ -103,57 +127,42 @@ From {workflowPlanFile}, check: - Markdown files have clear criteria - Data is referenced in step frontmatter -### 4. Document Findings +### 5. Document Findings -```markdown -### Validation Design Check Results +**Create/Update "Validation Design Check" section in {validationReportFile} using aggregated subprocess findings:** -**Workflow Requires Validation:** [Yes/No] +Document the following information: -**Workflow Domain Type:** [Critical/Compliance/Creative/Entertainment/Therapy/Casual] +**Whether validation is required:** Indicate if this workflow needs validation steps based on its domain type (critical/compliance/safety workflows vs. creative/exploratory ones) -**If Yes:** +**List of validation steps found:** Provide the names/paths of all validation step files in the workflow -**Validation Steps Found:** -- [List each validation step] +**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) -**Validation Step Quality:** -| Step | Loads Data | Systematic | Auto-proceed | DO NOT BE LAZY | Criteria | Status | -|------|-----------|------------|--------------|----------------|----------|--------| -| step-04-validate.md | ✅ | ✅ | ✅ | ✅ | ✅ Clear | ✅ PASS | -| step-07-check.md | ❌ | ⚠️ Vague | ❌ User choice each | ❌ | ❌ Unclear | ❌ FAIL | +**"DO NOT BE LAZY" language presence:** For each validation step, note whether anti-lazy language is present and what it says -**"DO NOT BE LAZY" Language Check:** -| Step | Has Anti-Lazy Language | Status | -|------|----------------------|--------| -| step-04-validate.md | ✅ "DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE" | ✅ PASS | -| step-07-check.md | ❌ No anti-lazy language found | ⚠️ WARN | +**Critical flow 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 -**Critical Flow Check:** -- Workflow domain: [Critical/Creative/Therapy/etc.] -- Validation location: [steps-v/ folder / inline with create] -- For [critical] workflows: Validation is in steps-v/ ✅ / ❌ mixed in create -- Status: ✅ Properly segregated / ⚠️ Consider segregation / ❌ Should be in steps-v/ +**Validation data files:** List any validation data files found in the data/ folder, or note if they are missing -**Validation Data Files:** -- [List data files found, or note if missing] +**Issues identified:** List any problems found with the validation design, missing data files, or quality concerns -**Issues Found:** -[List issues with validation design] +**Overall status:** Provide final assessment (PASS/FAIL/WARN/N/A) with reasoning -**If No (Validation Not Required):** -- Workflow is [creative/exploratory/type] -- Validation is user's responsibility -- No validation steps needed ✅ +### 6. Append to Report -**Status:** ✅ PASS / ❌ FAIL / ⚠️ WARNINGS / N/A (not applicable) -``` +Update {validationReportFile} - replace "## Validation Design Check *Pending...*" with actual findings from subprocess aggregation. -### 5. Append to Report - -Update {validationReportFile} - replace "## Validation Design Check *Pending...*" with actual findings. - -### 6. Save Report and Auto-Proceed +### 7. Save Report and Auto-Proceed **CRITICAL:** Save the validation report BEFORE loading next step. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md index fe604633..000f6f6e 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md @@ -3,10 +3,10 @@ name: 'step-07-instruction-style-check' description: 'Check instruction style - intent-based vs prescriptive, appropriate for domain' nextStepFile: './step-08-collaborative-experience-check.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' intentVsPrescriptive: '../data/intent-vs-prescriptive-spectrum.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' --- # Validation Step 7: Instruction Style Check @@ -23,20 +23,22 @@ To validate that workflow instructions use appropriate style - intent-based for - 📖 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 -- 🚫 DO NOT skip any files or style checks -- 💬 Append findings to report, then auto-load next step +- 🎯 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 +- 💾 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: @@ -84,11 +86,17 @@ From {workflowPlanFile}, identify the workflow domain: ### 3. Check EACH Step's Instruction Style -**DO NOT BE LAZY - For EACH step file:** +**DO NOT BE LAZY - For EACH step file, launch a subprocess that:** -1. Load the step -2. Read the instruction sections (MANDATORY SEQUENCE) -3. Classify style: +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 @@ -108,6 +116,17 @@ From {workflowPlanFile}, identify the workflow domain: - 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:** @@ -118,47 +137,41 @@ From {workflowPlanFile}, identify the workflow domain: - ✅ Instructions should be prescriptive where compliance matters - ⚠️ May have intent-based sections for creative elements -### 5. Document Findings +### 5. Aggregate Findings and Document -```markdown -### Instruction Style Check Results +After ALL subprocesses have analyzed their respective step files, aggregate findings and create/update section in {validationReportFile}. -**Domain Type:** [Creative/Personal/Exploratory OR Legal/Medical/Compliance] +Document the following: -**Appropriate Style:** [Intent-based/Prescriptive/Mixed] +**Workflow Domain Assessment:** +- Document the domain type (creative/interactive vs compliance/legal) +- State the appropriate instruction style for this domain -**Step Instruction Style Analysis:** -| Step | Style Type | Appropriate | Notes | Status | -|------|-----------|-------------|-------|--------| -| step-01-init.md | Intent-based | ✅ | Goals described, flexible | ✅ PASS | -| step-02-*.md | Intent-based | ✅ | "Think about response" | ✅ PASS | -| step-03-*.md | Prescriptive | ❌ | Domain is creative, too rigid | ⚠️ WARN | -| step-04-*.md | Intent-based | ✅ | Good facilitation language | ✅ PASS | -| step-05-*.md | Mixed | ✅ | Prescriptive for compliance, intent elsewhere | ✅ PASS | +**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 Found:** +**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 -**Overly Prescriptive Steps:** -- [List steps that are too prescriptive for their domain] -- Example: "step-03-*.md says 'Ask exactly: X, Y, Z' but this is a creative workflow" +**Positive Findings:** +- Highlight steps with excellent instruction style +- Note effective use of intent-based facilitation language +- Identify appropriate use of prescriptive instructions (if applicable) -**Overly Flexible Steps (if prescriptive domain):** -- [List steps that should be more prescriptive] -- Example: "step-04-*.md is vague but this is a compliance workflow" +**Overall Status:** +- Provide final assessment (PASS/FAIL/WARN) +- Summarize key findings -**Style Inconsistencies:** -- [List steps where style doesn't match domain] +**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. -**Good Examples Found:** -- [Highlight steps with excellent intent-based instructions] -- [Highlight steps with appropriate prescriptive language] +### 6. Update Report with Aggregated Findings -**Status:** ✅ PASS / ❌ FAIL / ⚠️ WARNINGS -``` - -### 6. Append to Report - -Update {validationReportFile} - replace "## Instruction Style Check *Pending...*" with actual findings. +Update {validationReportFile} - replace "## Instruction Style Check *Pending...*" with actual aggregated findings from all subprocesses. ### 7. Save Report and Auto-Proceed @@ -175,18 +188,22 @@ Then immediately load, read entire file, then execute {nextStepFile}. ### ✅ SUCCESS: -- EVERY step's instruction style reviewed +- 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 -- Findings appended to report +- 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 +- 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. Check EVERY step's instruction style. Auto-proceed through all validation steps. +**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/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md index b5aacfcc..43416b10 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md @@ -2,10 +2,10 @@ name: 'step-08-collaborative-experience-check' description: 'Check collaborative quality - does this workflow facilitate well or just interrogate?' -nextStepFile: './step-09-cohesive-review.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +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 diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md b/src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md new file mode 100644 index 00000000..5d0219a9 --- /dev/null +++ b/src/modules/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/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md b/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md index 0453ab93..adf1ab45 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md @@ -3,9 +3,9 @@ name: 'step-09-cohesive-review' description: 'Cohesive ultra-think review - overall quality, does this workflow actually facilitate well?' nextStepFile: './step-10-report-complete.md' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' --- # Validation Step 9: Cohesive Review @@ -22,17 +22,21 @@ To perform a cohesive "ultra-think" review of the entire workflow - walk through - 📖 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 -- 🚫 DO NOT skip any aspect of the review -- 💬 Think deeply about quality and facilitation +- 🎯 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 +- 🎯 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 @@ -50,13 +54,32 @@ To perform a cohesive "ultra-think" review of the entire workflow - walk through ### 1. Load the Entire Workflow -**DO NOT BE LAZY - Load EVERY step file:** +**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:** @@ -93,16 +116,9 @@ To perform a cohesive "ultra-think" review of the entire workflow - walk through ### 4. Assess Overall Quality -**Rate the workflow on:** +**Evaluate the workflow across key dimensions:** -| Aspect | Rating (1-5) | Notes | -|--------|-------------|-------| -| Clear Goal | ⭐⭐⭐⭐⭐ | Is the purpose clear? | -| Logical Flow | ⭐⭐⭐⭐⭐ | Do steps progress logically? | -| Facilitation Quality | ⭐⭐⭐⭐⭐ | Does it facilitate well? | -| User Experience | ⭐⭐⭐⭐⭐ | Would users enjoy this? | -| Goal Achievement | ⭐⭐⭐⭐⭐ | Does it accomplish what it set out to? | -| Overall Quality | ⭐⭐⭐⭐⭐ | Total assessment | +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 @@ -122,80 +138,15 @@ To perform a cohesive "ultra-think" review of the entire workflow - walk through ### 6. Provide Recommendation -**Overall Assessment:** -- ✅ **EXCELLENT** - Ready to use, exemplifies best practices -- ✅ **GOOD** - Solid workflow, minor improvements possible -- ⚠️ **NEEDS WORK** - Has issues that should be addressed -- ❌ **PROBLEMATIC** - Major issues, needs significant revision +**Assess overall workflow readiness:** -**Recommendation:** -- [Ready for use / Ready with minor tweaks / Needs revision / Major rework needed] +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 -```markdown -### Cohesive Review Results +**Document your cohesive review findings in the validation report:** -**Overall Assessment:** [EXCELLENT/GOOD/NEEDS WORK/PROBLEMATIC] - -**Quality Ratings:** -| Aspect | Rating | Notes | -|--------|--------|-------| -| Clear Goal | ⭐⭐⭐⭐⭐ | [Notes] | -| Logical Flow | ⭐⭐⭐⭐⭐ | [Notes] | -| Facilitation Quality | ⭐⭐⭐⭐⭐ | [Notes] | -| User Experience | ⭐⭐⭐⭐⭐ | [Notes] | -| Goal Achievement | ⭐⭐⭐⭐⭐ | [Notes] | -| **Overall Quality** | **⭐⭐⭐⭐⭐** | [Total assessment] | - -**Cohesiveness Analysis:** - -**Flow Assessment:** -- [Describe the overall flow - does it work?] -- [Are there any jarring transitions?] -- [Does each step connect to the next?] - -**Progression Assessment:** -- [Does the workflow build toward its goal?] -- [Is there a clear arc?] -- [Would a user feel they're making progress?] - -**Voice and Tone:** -- [Is the voice consistent throughout?] -- [Does the AI persona work well?] -- [Is the collaboration style appropriate?] - -**Strengths:** -1. [Major strength #1] -2. [Major strength #2] -3. [What makes this workflow excellent] - -**Weaknesses:** -1. [Issue #1 that could be improved] -2. [Issue #2 that could be improved] -3. [What doesn't work as well] - -**Critical Issues (if any):** -- [List any show-stopper problems] -- [Or note: No critical issues] - -**What Makes This Work Well:** -- [Describe the excellent elements] -- [What should other workflows learn from this?] - -**What Could Be Improved:** -- [Specific actionable improvements] -- [Priority: High/Medium/Low] - -**User Experience Forecast:** -- [How would a user experience this workflow?] -- [Would they feel: guided/confused/satisfied/frustrated?] - -**Recommendation:** -- [Ready for use / Ready with minor tweaks / Needs revision / Major rework needed] - -**Status:** ✅ EXCELLENT / ✅ GOOD / ⚠️ NEEDS WORK / ❌ PROBLEMATIC -``` +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 diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md b/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md index c011bc33..ee550530 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md @@ -2,9 +2,9 @@ name: 'step-10-report-complete' description: 'Finalize validation report - check for plan file, summarize all findings, present to user' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +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' --- @@ -21,6 +21,7 @@ To check if a plan file exists (and run plan validation if it does), then summar - 📖 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: @@ -38,7 +39,7 @@ To check if a plan file exists (and run plan validation if it does), then summar ## CONTEXT BOUNDARIES: -- All 9 previous validation steps have completed +- 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 @@ -64,105 +65,39 @@ After plan validation (if applicable), load {validationReportFile} and read ALL ### 3. Create Summary Section -At the end of {validationReportFile}, replace "## Summary *Pending...*" with: +At the end of {validationReportFile}, replace "## Summary *Pending...*" with a comprehensive summary that includes: -```markdown -## Summary +- 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 -**Validation Completed:** [current date] +Present this information in a clear, readable format - the exact structure is flexible as long as it covers all these points. -**Overall Status:** -[Based on all validation steps, determine overall status] +### 4. Update Report Status -**Validation Steps Completed:** -1. ✅ File Structure & Size - [PASS/FAIL/WARN] -2. ✅ Frontmatter Validation - [PASS/FAIL/WARN] -3. ✅ Menu Handling Validation - [PASS/FAIL/WARN] -4. ✅ Step Type Validation - [PASS/FAIL/WARN] -5. ✅ Output Format Validation - [PASS/FAIL/WARN] -6. ✅ Validation Design Check - [PASS/FAIL/WARN/N/A] -7. ✅ Instruction Style Check - [PASS/FAIL/WARN] -8. ✅ Collaborative Experience Check - [PASS/FAIL/WARN] -9. ✅ Cohesive Review - [EXCELLENT/GOOD/NEEDS WORK/PROBLEMATIC] -10. ✅ Plan Quality Validation - [FULLY IMPLEMENTED/PARTIALLY/MISSING/N/A] +Update the frontmatter of {validationReportFile} to set validationStatus to COMPLETE and add the completionDate. Keep existing fields like validationDate, workflowName, and workflowPath unchanged. -**Issues Summary:** +### 5. Present Summary to User -**Critical Issues (Must Fix):** -- [List any critical issues from all validation steps] -- [If none, state: No critical issues found] +Present a clear summary to the user that includes: -**Warnings (Should Fix):** -- [List any warnings from all validation steps] -- [If none, state: No warnings found] +- 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) -**Strengths:** -- [List key strengths identified in validation] +Present this information in a natural, conversational way - the exact format doesn't matter as long as all this information is clearly communicated. -**Overall Assessment:** -[Summarize the overall quality of the workflow] - -**Recommendation:** -- [Ready to use / Ready with minor tweaks / Needs revision / Major rework needed] - -**Next Steps:** -- Review the detailed findings above -- Decide what changes to make -- Either fix issues directly or use edit workflow (if tri-modal) -``` - -### 3. Update Report Status - -Update frontmatter of {validationReportFile}: - -```yaml ---- -validationDate: [original date] -completionDate: [current date] -workflowName: {new_workflow_name} -workflowPath: {targetWorkflowPath} -validationStatus: COMPLETE ---- -``` - -### 4. Present Summary to User - -"**✅ Validation Complete!** - -I've completed extensive validation of your workflow. Here's the summary:" - -**Overall Status:** [Overall status from summary] - -**Quick Results:** -| Validation Step | Result | -|-----------------|--------| -| File Structure & Size | [emoji] [result] | -| Frontmatter | [emoji] [result] | -| Menu Handling | [emoji] [result] | -| Step Types | [emoji] [result] | -| Output Format | [emoji] [result] | -| Validation Design | [emoji] [result or N/A] | -| Instruction Style | [emoji] [result] | -| Collaborative Experience | [emoji] [result] | -| Cohesive Review | [emoji] [result] | -| Plan Quality | [emoji] [result or N/A] | - -**Issues Found:** -- **Critical:** [count or "none"] -- **Warnings:** [count or "none"] - -**Recommendation:** [Ready to use / Needs tweaks / Needs revision] - -"**The full validation report is available at:** -`{validationReportFile}` - -**Would you like me to:** -1. Review the detailed findings with you -2. Make specific changes to address issues -3. Explain any validation result in detail -4. Something else" - -### 5. Present MENU OPTIONS +### 6. Present MENU OPTIONS Display: **Validation Complete! Select an Option:** [R] Review Detailed Findings [F] Fix Issues [X] Exit Validation @@ -178,34 +113,19 @@ Display: **Validation Complete! Select an Option:** [R] Review Detailed Findings - IF X: "Validation complete. Your workflow is at: {targetWorkflowPath}. You can make changes and re-run validation anytime." - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) -### 6. If User Wants to Fix Issues +### 7. If User Wants to Fix Issues -**Options for fixing:** +Explain the available options for fixing issues: -**Option A: Manual Edits** -- User edits files directly -- Re-run validation to check fixes +- 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 -**Option B: Guided Edits** -- User specifies what to fix -- Help create specific edits for user approval -- User applies edits +The exact format doesn't matter - just ensure the user understands their options for addressing issues. -**Option C: Edit Workflow (if tri-modal)** -- If workflow has steps-e/, use edit workflow -- Edit workflow can make systematic changes +### 8. Update Plan with Validation Status -### 7. Update Plan with Validation Status - -Update {workflowPlanFile} frontmatter: - -```yaml ---- -validationStatus: COMPLETE -validationDate: [current date] -validationReport: {validationReportFile} ---- -``` +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 diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md index 83f55cae..32c951a6 100644 --- a/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md +++ b/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md @@ -2,9 +2,9 @@ name: 'step-11-plan-validation' description: 'Validate plan quality - ensure all user intent and requirements are implemented' -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -validationReportFile: '{targetWorkflowPath}/validation-report-{new_workflow_name}.md' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +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 @@ -20,18 +20,19 @@ To validate that a workflow plan (if it exists) has been fully implemented - all - 🛑 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: -- 🎯 Load the complete plan file -- 🚫 DO NOT skip checking any requirement from the plan -- 💬 Validate that built workflow matches plan specifications +- 🎯 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 -- 💾 Check built workflow against plan +- 🎯 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 @@ -61,126 +62,148 @@ First, check if {workflowPlanFile} exists: **DO NOT BE LAZY - Extract EVERY requirement from the plan:** -From {workflowPlanFile}, extract: +**SUBPROCESS EXECUTION PATTERN:** -**From Discovery Section:** -- User's original idea/vision -- Core problem being solved +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 -**From Classification Section:** -- 4 key decisions (document output, module, continuable, tri-modal) -- Target path -- Workflow name +**SUBPROCESS RETURNS:** +Structured requirements list organized by section (discovery, classification, requirements, design, tools) with all extracted items and a count of total requirements. -**From Requirements Section:** -- Flow structure (linear/looping/branching) -- User interaction style -- Inputs required -- Output specifications -- Success criteria +**If subprocess unavailable:** Load {workflowPlanFile} in main context and extract requirements (larger context but still functional - demonstrates graceful fallback). -**From Design Section:** -- Step outline with names and purposes -- Flow diagram -- Interaction patterns -- File structure requirements - -**From Tools Section:** -- Tools configured -- Data files specified +--- ### 3. Validate Each Requirement Against Built Workflow -**For EACH requirement extracted:** +**DO NOT BE LAZY - For EACH requirement area, launch a subprocess that:** -Check the built workflow to see if it was implemented: +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 -**Discovery Validation:** +**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? -**Classification Validation:** +**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? -**Requirements Validation:** +**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? -**Design Validation:** +**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? -**Tools Validation:** +**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? -### 4. Check Implementation Quality +**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. -For each implemented requirement, assess quality: +--- -**Quality Questions:** -- Is the implementation high quality or minimal/barely working? -- Would this actually facilitate well? -- Are there obvious gaps or issues? +**If subprocess unavailable:** Validate each requirement area sequentially in main context (larger context but still functional - demonstrates graceful fallback). -**Example:** -- Plan: "Highly collaborative, intent-based facilitation" -- Implementation: Has A/P menus, uses intent-based language ✅ +--- -- Plan: "Continuable workflow with session resume" -- Implementation: Has step-01b-continue.md, tracks stepsCompleted ✅ +### 4. Aggregate Findings and Update Report -### 5. Document Findings +After ALL requirement area subprocesses complete, aggregate findings into validation report. -```markdown -### Plan Quality Validation Results +Document the following information: -**Plan File:** {workflowPlanFile} -**Plan Exists:** ✅ Yes - -**Requirements Extracted:** [number] requirements from plan sections +**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 -| Requirement Area | Specified | Implemented | Quality | Status | -|------------------|-----------|--------------|---------|--------| -| Discovery/Vision | [summary] | ✅/❌ | High/Med/Low | ✅/❌ | -| Document Output | [yes/no] | ✅/❌ | High/Med/Low | ✅/❌ | -| Continuable | [yes/no] | ✅/❌ | High/Med/Low | ✅/❌ | -| Tri-Modal | [yes/no] | ✅/❌ | High/Med/Low | ✅/❌ | -| Flow Structure | [type] | ✅/❌ | High/Med/Low | ✅/❌ | -| Interaction Style | [style] | ✅/❌ | High/Med/Low | ✅/❌ | -| [Step 01] | [purpose] | ✅/❌ | High/Med/Low | ✅/❌ | -| [Step 02] | [purpose] | ✅/❌ | High/Med/Low | ✅/❌ | -| ... | ... | ... | ... | ... | - -**Missing Implementations:** -- [List any requirements from plan that are NOT in the built workflow] +**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 poor quality] +List any requirements that are implemented but with quality concerns -**Gaps Between Plan and Reality:** -- [List where the built workflow doesn't match the plan] +**Plan-Reality Alignment:** +Describe where the built workflow doesn't match what was planned -**Plan Implementation Score:** [X]% +**Overall Assessment:** +- Plan implementation score (percentage) +- Overall status (Fully Implemented/Partially Implemented/Poorly Implemented/Missing Critical Items) -**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 -### 6. Append to Report +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 -Append findings to {validationReportFile} after the "## Cohesive Review" section. +### 5. Append to Report -### 7. Save and Complete +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. @@ -193,17 +216,22 @@ Save the validation report. This is the final validation step. ### ✅ SUCCESS: -- Plan file loaded completely -- Every requirement extracted and validated -- Implementation gaps documented +- 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 appended to report +- 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. Document all gaps. +**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/src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md b/src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md index 9b5794ef..84e4628c 100644 --- a/src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md +++ b/src/modules/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/src/modules/bmb/workflows/workflow/templates/step-1b-template.md b/src/modules/bmb/workflows/workflow/templates/step-1b-template.md index 8e34bdd4..0f5e7104 100644 --- a/src/modules/bmb/workflows/workflow/templates/step-1b-template.md +++ b/src/modules/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/src/modules/bmb/workflows/workflow/templates/step-template.md b/src/modules/bmb/workflows/workflow/templates/step-template.md index a6758603..87098d86 100644 --- a/src/modules/bmb/workflows/workflow/templates/step-template.md +++ b/src/modules/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' @@ -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/src/modules/bmb/workflows/workflow/templates/workflow-template.md b/src/modules/bmb/workflows/workflow/templates/workflow-template.md index 5cc687a3..42a3d35f 100644 --- a/src/modules/bmb/workflows/workflow/templates/workflow-template.md +++ b/src/modules/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/src/modules/bmb/workflows/workflow/workflow.md b/src/modules/bmb/workflows/workflow/workflow.md index a3e15c03..692ea689 100644 --- a/src/modules/bmb/workflows/workflow/workflow.md +++ b/src/modules/bmb/workflows/workflow/workflow.md @@ -64,6 +64,7 @@ Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - If user invoked with "create workflow" or "new workflow" or "build workflow" → Set mode to **create** - If user invoked with "validate workflow" or "review workflow" or "-v" or "--validate" → Set mode to **validate** +- If user invoked with "validate workflow MAX-PARALLEL" or "review workflow MAX-PARALLEL" or "-vmax" or "--validate-max" → Set mode to **validate-max-parallel** - If user invoked with "edit workflow" or "modify workflow" or "-e" or "--edit" → Set mode to **edit** **If mode is still unclear, ask user:** @@ -72,6 +73,7 @@ Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: **[C]reate** - Build a new workflow from scratch **[V]alidate** - Review an existing workflow and generate validation report +**[VMP] Validate Max Parallel** - Review an existing workflow and generate validation report running max steps as possible in parallel **[E]dit** - Modify an existing workflow Please select: [C]reate / [V]alidate / [E]dit" @@ -98,6 +100,10 @@ Please select: [F]rom scratch / [C]onvert existing" Prompt for workflow path: "Which workflow would you like to validate? Please provide the path to the workflow.md file." Then load, read completely, and execute `steps-v/step-01-validate.md` +**IF mode == validate-max-parallel:** +Prompt for workflow path: "Which workflow would you like to validate? Please provide the path to the workflow.md file." validate a subprocess or task agent tool or similar is available +Then load, read completely, and execute `steps-v/step-01-validate-max-mode.md` + **IF mode == edit:** Prompt for workflow path: "Which workflow would you like to edit? Please provide the path to the workflow.md file." Then load, read completely, and execute `steps-e/step-e-01-assess-workflow.md` diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md index 661c68f4..ef1719ef 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md @@ -6,8 +6,8 @@ description: 'Initialize the game brainstorming workflow and validate readiness' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-context.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-context.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md index 9380031a..b7312261 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md @@ -6,8 +6,8 @@ description: 'Load game-specific brainstorming context and techniques' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-02-context.md' -nextStepFile: '{workflow_path}/steps/step-03-ideation.md' +thisStepFile: './step-02-context.md' +nextStepFile: './step-03-ideation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md index 3e4c7d5b..355297a0 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md @@ -6,8 +6,8 @@ description: 'Execute the brainstorming session with game-specific techniques' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-03-ideation.md' -nextStepFile: '{workflow_path}/steps/step-04-complete.md' +thisStepFile: './step-03-ideation.md' +nextStepFile: './step-04-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md index 14118fc1..3807e0af 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md @@ -6,7 +6,7 @@ description: 'Complete the brainstorming session with summary and next steps' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-04-complete.md' +thisStepFile: './step-04-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md index 1ba0767e..948ab591 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md @@ -28,7 +28,7 @@ stepsCompleted: [1, 2, 3, ...] # Array of completed step numbers To begin, load and execute step-01-init.md: ``` -{workflow_path}/steps/step-01-init.md +./step-01-init.md ``` ## Critical Rules diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md index 534e57e7..b203fbe2 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize the Game Brief workflow by detecting continuation state workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-vision.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-vision.md' +continueStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md index bd943bde..514be496 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md @@ -6,7 +6,7 @@ description: 'Resume an interrupted Game Brief workflow from the last completed workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' --- diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md index 85ddd1ad..34f84a06 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md @@ -6,8 +6,8 @@ description: 'Define the core game vision including name, concept, pitch, and vi workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-02-vision.md' -nextStepFile: '{workflow_path}/steps/step-03-market.md' +thisStepFile: './step-02-vision.md' +nextStepFile: './step-03-market.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md index 1f902b29..6fb67ffb 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md @@ -6,8 +6,8 @@ description: 'Define target audience and market context' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-03-market.md' -nextStepFile: '{workflow_path}/steps/step-04-fundamentals.md' +thisStepFile: './step-03-market.md' +nextStepFile: './step-04-fundamentals.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md index 63ce809f..2238262d 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md @@ -6,8 +6,8 @@ description: 'Define core gameplay pillars, mechanics, and player experience goa workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-04-fundamentals.md' -nextStepFile: '{workflow_path}/steps/step-05-scope.md' +thisStepFile: './step-04-fundamentals.md' +nextStepFile: './step-05-scope.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md index 7a8c8e50..3f5fce6a 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md @@ -6,8 +6,8 @@ description: 'Define project scope including platforms, constraints, and resourc workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-05-scope.md' -nextStepFile: '{workflow_path}/steps/step-06-references.md' +thisStepFile: './step-05-scope.md' +nextStepFile: './step-06-references.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md index 05241075..3ed60259 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md @@ -6,8 +6,8 @@ description: 'Define inspiration games, competitive analysis, and key differenti workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-06-references.md' -nextStepFile: '{workflow_path}/steps/step-07-content.md' +thisStepFile: './step-06-references.md' +nextStepFile: './step-07-content.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md index 1e98a5a9..1a48dcc1 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md @@ -6,8 +6,8 @@ description: 'Define content framework, art/audio direction, and risk assessment workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-07-content.md' -nextStepFile: '{workflow_path}/steps/step-08-complete.md' +thisStepFile: './step-07-content.md' +nextStepFile: './step-08-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md index 2ab5abe0..3b3f6f7b 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md @@ -6,7 +6,7 @@ description: 'Define success criteria and complete the game brief with handoff g workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-08-complete.md' +thisStepFile: './step-08-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md index 5f87633d..ae40ccd3 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize the GDD workflow by detecting continuation state and se workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-context.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-context.md' +continueStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md index eb70d7d2..29318ee4 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md @@ -6,7 +6,7 @@ description: 'Resume an interrupted GDD workflow from the last completed step' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' --- diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md index 12b5bd03..300ffd6d 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md @@ -6,8 +6,8 @@ description: 'Load game context from brief and determine the game type' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-02-context.md' -nextStepFile: '{workflow_path}/steps/step-03-platforms.md' +thisStepFile: './step-02-context.md' +nextStepFile: './step-03-platforms.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md index 0ccc1ee6..5433eab1 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md @@ -6,8 +6,8 @@ description: 'Define target platforms and target audience for the game' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-03-platforms.md' -nextStepFile: '{workflow_path}/steps/step-04-vision.md' +thisStepFile: './step-03-platforms.md' +nextStepFile: './step-04-vision.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md index 1c5e6623..1df86679 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md @@ -6,8 +6,8 @@ description: 'Define project goals, context, and unique selling points' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-04-vision.md' -nextStepFile: '{workflow_path}/steps/step-05-core-gameplay.md' +thisStepFile: './step-04-vision.md' +nextStepFile: './step-05-core-gameplay.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md index ae62ab2f..b2756e53 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md @@ -6,8 +6,8 @@ description: 'Define game pillars, core gameplay loop, and win/loss conditions' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-05-core-gameplay.md' -nextStepFile: '{workflow_path}/steps/step-06-mechanics.md' +thisStepFile: './step-05-core-gameplay.md' +nextStepFile: './step-06-mechanics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md index 0dbc9eb8..e5322a02 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md @@ -6,8 +6,8 @@ description: 'Define primary game mechanics and control schemes' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-06-mechanics.md' -nextStepFile: '{workflow_path}/steps/step-07-game-type.md' +thisStepFile: './step-06-mechanics.md' +nextStepFile: './step-07-game-type.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md index 00ae53b1..4fc8bcd7 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md @@ -6,8 +6,8 @@ description: 'Process game-type specific sections from the loaded game type guid workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-07-game-type.md' -nextStepFile: '{workflow_path}/steps/step-08-progression.md' +thisStepFile: './step-07-game-type.md' +nextStepFile: './step-08-progression.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md index bcd3a33e..2cb2ae31 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md @@ -6,8 +6,8 @@ description: 'Define player progression systems and game balance' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-08-progression.md' -nextStepFile: '{workflow_path}/steps/step-09-levels.md' +thisStepFile: './step-08-progression.md' +nextStepFile: './step-09-levels.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md index d286cc42..edd35846 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md @@ -6,8 +6,8 @@ description: 'Define level design framework and level progression' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-09-levels.md' -nextStepFile: '{workflow_path}/steps/step-10-art-audio.md' +thisStepFile: './step-09-levels.md' +nextStepFile: './step-10-art-audio.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md index a9ceb02c..8ac6b3c5 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md @@ -6,8 +6,8 @@ description: 'Define art style and audio direction' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-10-art-audio.md' -nextStepFile: '{workflow_path}/steps/step-11-technical.md' +thisStepFile: './step-10-art-audio.md' +nextStepFile: './step-11-technical.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md index a3b3e3d6..e60fcce2 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md @@ -6,8 +6,8 @@ description: 'Define technical specifications and requirements' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-11-technical.md' -nextStepFile: '{workflow_path}/steps/step-12-epics.md' +thisStepFile: './step-11-technical.md' +nextStepFile: './step-12-epics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md index 83fc2213..dff49301 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md @@ -6,8 +6,8 @@ description: 'Define development epics and high-level story breakdown' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-12-epics.md' -nextStepFile: '{workflow_path}/steps/step-13-metrics.md' +thisStepFile: './step-12-epics.md' +nextStepFile: './step-13-metrics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' epicsOutputFile: '{output_folder}/epics.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md index 00fed1be..d2360f77 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md @@ -6,8 +6,8 @@ description: 'Define success metrics for technical and gameplay evaluation' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-13-metrics.md' -nextStepFile: '{workflow_path}/steps/step-14-complete.md' +thisStepFile: './step-13-metrics.md' +nextStepFile: './step-14-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md index df6f531f..cafa778d 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md @@ -6,7 +6,7 @@ description: 'Document out of scope items, capture assumptions, and provide hand workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-14-complete.md' +thisStepFile: './step-14-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' epicsFile: '{output_folder}/epics.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md index fc022641..aa3dfc7b 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize narrative workflow, load GDD context, and assess narrat workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' -nextStepFile: '{workflow_path}/steps/step-02-foundation.md' +thisStepFile: './step-01-init.md' +continueStepFile: './step-01b-continue.md' +nextStepFile: './step-02-foundation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' templateFile: '{workflow_path}/templates/narrative-template.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md index 8acb86a4..28558abe 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md @@ -6,21 +6,21 @@ description: 'Continue an existing narrative workflow from where it left off' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Step Files (for routing) -step02: '{workflow_path}/steps/step-02-foundation.md' -step03: '{workflow_path}/steps/step-03-story.md' -step04: '{workflow_path}/steps/step-04-characters.md' -step05: '{workflow_path}/steps/step-05-world.md' -step06: '{workflow_path}/steps/step-06-dialogue.md' -step07: '{workflow_path}/steps/step-07-environmental.md' -step08: '{workflow_path}/steps/step-08-delivery.md' -step09: '{workflow_path}/steps/step-09-integration.md' -step10: '{workflow_path}/steps/step-10-production.md' -step11: '{workflow_path}/steps/step-11-complete.md' +step02: './step-02-foundation.md' +step03: './step-03-story.md' +step04: './step-04-characters.md' +step05: './step-05-world.md' +step06: './step-06-dialogue.md' +step07: './step-07-environmental.md' +step08: './step-08-delivery.md' +step09: './step-09-integration.md' +step10: './step-10-production.md' +step11: './step-11-complete.md' --- # Step 1b: Continue Existing Narrative diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md index c432467e..509cdcad 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md @@ -6,8 +6,8 @@ description: 'Define narrative premise, themes, tone, and story structure' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-02-foundation.md' -nextStepFile: '{workflow_path}/steps/step-03-story.md' +thisStepFile: './step-02-foundation.md' +nextStepFile: './step-03-story.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md index fe1278df..5f633e7e 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md @@ -6,8 +6,8 @@ description: 'Define major story beats and narrative pacing' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-03-story.md' -nextStepFile: '{workflow_path}/steps/step-04-characters.md' +thisStepFile: './step-03-story.md' +nextStepFile: './step-04-characters.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md index a5bb6537..e03f6815 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md @@ -6,8 +6,8 @@ description: 'Develop all characters including protagonists, antagonists, suppor workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-04-characters.md' -nextStepFile: '{workflow_path}/steps/step-05-world.md' +thisStepFile: './step-04-characters.md' +nextStepFile: './step-05-world.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md index 2e8da212..a77a6bc7 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md @@ -6,8 +6,8 @@ description: 'Build the world including setting, history, factions, and key loca workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-05-world.md' -nextStepFile: '{workflow_path}/steps/step-06-dialogue.md' +thisStepFile: './step-05-world.md' +nextStepFile: './step-06-dialogue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md index cef4ed33..70a79015 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md @@ -6,8 +6,8 @@ description: 'Define dialogue style, key conversations, and branching systems' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-06-dialogue.md' -nextStepFile: '{workflow_path}/steps/step-07-environmental.md' +thisStepFile: './step-06-dialogue.md' +nextStepFile: './step-07-environmental.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md index a6dcf7b0..05f37827 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md @@ -6,8 +6,8 @@ description: 'Plan environmental storytelling including visual, audio, and found workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-07-environmental.md' -nextStepFile: '{workflow_path}/steps/step-08-delivery.md' +thisStepFile: './step-07-environmental.md' +nextStepFile: './step-08-delivery.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md index 3af385db..2e76b208 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md @@ -6,8 +6,8 @@ description: 'Design narrative delivery methods including cutscenes, in-game sto workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-08-delivery.md' -nextStepFile: '{workflow_path}/steps/step-09-integration.md' +thisStepFile: './step-08-delivery.md' +nextStepFile: './step-09-integration.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md index a99f41df..460eac73 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md @@ -6,8 +6,8 @@ description: 'Define how narrative integrates with gameplay including gating, ag workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-09-integration.md' -nextStepFile: '{workflow_path}/steps/step-10-production.md' +thisStepFile: './step-09-integration.md' +nextStepFile: './step-10-production.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md index d3a8b405..f262956d 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md @@ -6,8 +6,8 @@ description: 'Plan production scope including writing estimates, localization, a workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-10-production.md' -nextStepFile: '{workflow_path}/steps/step-11-complete.md' +thisStepFile: './step-10-production.md' +nextStepFile: './step-11-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md index 205e9d89..a6bd67c9 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md @@ -6,7 +6,7 @@ description: 'Complete the narrative workflow with final summary, visualizations workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-11-complete.md' +thisStepFile: './step-11-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' diff --git a/src/modules/bmgd/workflows/2-design/narrative/workflow.md b/src/modules/bmgd/workflows/2-design/narrative/workflow.md index e9012d29..2757c351 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/workflow.md +++ b/src/modules/bmgd/workflows/2-design/narrative/workflow.md @@ -36,7 +36,7 @@ stepsCompleted: [1, 2, 3, ...] # Array of completed step numbers To begin, load and execute step-01-init.md: ``` -{workflow_path}/steps/step-01-init.md +./step-01-init.md ``` ## Critical Rules diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md index 37ee96e7..36448a27 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize the architecture workflow, validate readiness, and disc workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' -nextStepFile: '{workflow_path}/steps/step-02-context.md' +thisStepFile: './step-01-init.md' +continueStepFile: './step-01b-continue.md' +nextStepFile: './step-02-context.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' templateFile: '{workflow_path}/templates/architecture-template.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md index 0f095fca..4ac31018 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md @@ -6,19 +6,19 @@ description: 'Continue an existing architecture workflow from where it left off' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' # Step Files (for routing) -step02: '{workflow_path}/steps/step-02-context.md' -step03: '{workflow_path}/steps/step-03-starter.md' -step04: '{workflow_path}/steps/step-04-decisions.md' -step05: '{workflow_path}/steps/step-05-crosscutting.md' -step06: '{workflow_path}/steps/step-06-structure.md' -step07: '{workflow_path}/steps/step-07-patterns.md' -step08: '{workflow_path}/steps/step-08-validation.md' -step09: '{workflow_path}/steps/step-09-complete.md' +step02: './step-02-context.md' +step03: './step-03-starter.md' +step04: './step-04-decisions.md' +step05: './step-05-crosscutting.md' +step06: './step-06-structure.md' +step07: './step-07-patterns.md' +step08: './step-08-validation.md' +step09: './step-09-complete.md' --- # Step 1b: Continue Existing Architecture diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md index ffa6009e..7c83a111 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md @@ -6,8 +6,8 @@ description: 'Load and understand project context from GDD and supporting docume workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-02-context.md' -nextStepFile: '{workflow_path}/steps/step-03-starter.md' +thisStepFile: './step-02-context.md' +nextStepFile: './step-03-starter.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md index eeda5e90..bc55778b 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md @@ -6,8 +6,8 @@ description: 'Discover and evaluate game engine and starter template options' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-03-starter.md' -nextStepFile: '{workflow_path}/steps/step-04-decisions.md' +thisStepFile: './step-03-starter.md' +nextStepFile: './step-04-decisions.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md index de1d6e9c..025e13fa 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md @@ -6,8 +6,8 @@ description: 'Facilitate collaborative architectural decision making for game sy workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-04-decisions.md' -nextStepFile: '{workflow_path}/steps/step-05-crosscutting.md' +thisStepFile: './step-04-decisions.md' +nextStepFile: './step-05-crosscutting.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md index 46a24b91..d195dc0c 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md @@ -6,8 +6,8 @@ description: 'Address cross-cutting concerns that affect all game systems' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-05-crosscutting.md' -nextStepFile: '{workflow_path}/steps/step-06-structure.md' +thisStepFile: './step-05-crosscutting.md' +nextStepFile: './step-06-structure.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md index 4c6160c4..698aa6d2 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md @@ -6,8 +6,8 @@ description: 'Define project structure, directory organization, and architectura workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-06-structure.md' -nextStepFile: '{workflow_path}/steps/step-07-patterns.md' +thisStepFile: './step-06-structure.md' +nextStepFile: './step-07-patterns.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md index 08099061..31ccc90b 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md @@ -6,8 +6,8 @@ description: 'Design implementation patterns and novel architectural patterns fo workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-07-patterns.md' -nextStepFile: '{workflow_path}/steps/step-08-validation.md' +thisStepFile: './step-07-patterns.md' +nextStepFile: './step-08-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md index 5b550d1a..c8785a5c 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md @@ -6,8 +6,8 @@ description: 'Validate architectural coherence and completeness' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-08-validation.md' -nextStepFile: '{workflow_path}/steps/step-09-complete.md' +thisStepFile: './step-08-validation.md' +nextStepFile: './step-09-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' checklistFile: '{workflow_path}/checklist.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md index 2247d83e..810011c2 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md @@ -6,7 +6,7 @@ description: 'Complete the architecture workflow with final review and handoff g workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-09-complete.md' +thisStepFile: './step-09-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md b/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md index 9311f67e..60a9595e 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md @@ -34,7 +34,7 @@ stepsCompleted: [1, 2, 3, ...] # Array of completed step numbers To begin, load and execute step-01-init.md: ``` -{workflow_path}/steps/step-01-init.md +./step-01-init.md ``` ## Critical Rules diff --git a/src/modules/bmm/agents/pm.agent.yaml b/src/modules/bmm/agents/pm.agent.yaml index 28326994..8e44cd9b 100644 --- a/src/modules/bmm/agents/pm.agent.yaml +++ b/src/modules/bmm/agents/pm.agent.yaml @@ -26,9 +26,17 @@ agent: workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - trigger: PR or fuzzy match on prd + - trigger: CP or fuzzy match on create-prd exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" - description: "[PR] Create Product Requirements Document (PRD) (Required for BMad Method flow)" + description: "[CP] Create Product Requirements Document (PRD)" + + - trigger: VP or fuzzy match on validate-prd + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + description: "[VP] Validate a Product Requirements Document (PRD)" + + - trigger: EP or fuzzy match on edit-prd + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + description: "[EP] Edit a Product Requirements Document (PRD)" - trigger: ES or fuzzy match on epics-stories exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv b/src/modules/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv rename to src/modules/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md b/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md new file mode 100644 index 00000000..755230be --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md @@ -0,0 +1,197 @@ +# BMAD PRD Purpose + +**The PRD is the top of the required funnel that feeds all subsequent product development work in rhw BMad Method.** + +--- + +## What is a BMAD PRD? + +A dual-audience document serving: +1. **Human Product Managers and builders** - Vision, strategy, stakeholder communication +2. **LLM Downstream Consumption** - UX Design → Architecture → Epics → Development AI Agents + +Each successive document becomes more AI-tailored and granular. + +--- + +## Core Philosophy: Information Density + +**High Signal-to-Noise Ratio** + +Every sentence must carry information weight. LLMs consume precise, dense content efficiently. + +**Anti-Patterns (Eliminate These):** +- ❌ "The system will allow users to..." → ✅ "Users can..." +- ❌ "It is important to note that..." → ✅ State the fact directly +- ❌ "In order to..." → ✅ "To..." +- ❌ Conversational filler and padding → ✅ Direct, concise statements + +**Goal:** Maximum information per word. Zero fluff. + +--- + +## The Traceability Chain + +**PRD starts the chain:** +``` +Vision → Success Criteria → User Journeys → Functional Requirements → (future: User Stories) +``` + +**In the PRD, establish:** +- Vision → Success Criteria alignment +- Success Criteria → User Journey coverage +- User Journey → Functional Requirement mapping +- All requirements traceable to user needs + +**Why:** Each downstream artifact (UX, Architecture, Epics, Stories) must trace back to documented user needs and business objectives. This chain ensures we build the right thing. + +--- + +## What Makes Great Functional Requirements? + +### FRs are Capabilities, Not Implementation + +**Good FR:** "Users can reset their password via email link" +**Bad FR:** "System sends JWT via email and validates with database" (implementation leakage) + +**Good FR:** "Dashboard loads in under 2 seconds for 95th percentile" +**Bad FR:** "Fast loading time" (subjective, unmeasurable) + +### SMART Quality Criteria + +**Specific:** Clear, precisely defined capability +**Measurable:** Quantifiable with test criteria +**Attainable:** Realistic within constraints +**Relevant:** Aligns with business objectives +**Traceable:** Links to source (executive summary or user journey) + +### FR Anti-Patterns + +**Subjective Adjectives:** +- ❌ "easy to use", "intuitive", "user-friendly", "fast", "responsive" +- ✅ Use metrics: "completes task in under 3 clicks", "loads in under 2 seconds" + +**Implementation Leakage:** +- ❌ Technology names, specific libraries, implementation details +- ✅ Focus on capability and measurable outcomes + +**Vague Quantifiers:** +- ❌ "multiple users", "several options", "various formats" +- ✅ "up to 100 concurrent users", "3-5 options", "PDF, DOCX, TXT formats" + +**Missing Test Criteria:** +- ❌ "The system shall provide notifications" +- ✅ "The system shall send email notifications within 30 seconds of trigger event" + +--- + +## What Makes Great Non-Functional Requirements? + +### NFRs Must Be Measurable + +**Template:** +``` +"The system shall [metric] [condition] [measurement method]" +``` + +**Examples:** +- ✅ "The system shall respond to API requests in under 200ms for 95th percentile as measured by APM monitoring" +- ✅ "The system shall maintain 99.9% uptime during business hours as measured by cloud provider SLA" +- ✅ "The system shall support 10,000 concurrent users as measured by load testing" + +### NFR Anti-Patterns + +**Unmeasurable Claims:** +- ❌ "The system shall be scalable" → ✅ "The system shall handle 10x load growth through horizontal scaling" +- ❌ "High availability required" → ✅ "99.9% uptime as measured by cloud provider SLA" + +**Missing Context:** +- ❌ "Response time under 1 second" → ✅ "API response time under 1 second for 95th percentile under normal load" + +--- + +## Domain-Specific Requirements + +**Auto-Detect and Enforce Based on Project Context** + +Certain industries have mandatory requirements that must be present: + +- **Healthcare:** HIPAA Privacy & Security Rules, PHI encryption, audit logging, MFA +- **Fintech:** PCI-DSS Level 1, AML/KYC compliance, SOX controls, financial audit trails +- **GovTech:** NIST framework, Section 508 accessibility (WCAG 2.1 AA), FedRAMP, data residency +- **E-Commerce:** PCI-DSS for payments, inventory accuracy, tax calculation by jurisdiction + +**Why:** Missing these requirements in the PRD means they'll be missed in architecture and implementation, creating expensive rework. During PRD creation there is a step to cover this - during validation we want to make sure it was covered. For this purpose steps will utilize a domain-complexity.csv and project-types.csv. + +--- + +## Document Structure (Markdown, Human-Readable) + +### Required Sections +1. **Executive Summary** - Vision, differentiator, target users +2. **Success Criteria** - Measurable outcomes (SMART) +3. **Product Scope** - MVP, Growth, Vision phases +4. **User Journeys** - Comprehensive coverage +5. **Domain Requirements** - Industry-specific compliance (if applicable) +6. **Innovation Analysis** - Competitive differentiation (if applicable) +7. **Project-Type Requirements** - Platform-specific needs +8. **Functional Requirements** - Capability contract (FRs) +9. **Non-Functional Requirements** - Quality attributes (NFRs) + +### Formatting for Dual Consumption + +**For Humans:** +- Clear, professional language +- Logical flow from vision to requirements +- Easy for stakeholders to review and approve + +**For LLMs:** +- ## Level 2 headers for all main sections (enables extraction) +- Consistent structure and patterns +- Precise, testable language +- High information density + +--- + +## Downstream Impact + +**How the PRD Feeds Next Artifacts:** + +**UX Design:** +- User journeys → interaction flows +- FRs → design requirements +- Success criteria → UX metrics + +**Architecture:** +- FRs → system capabilities +- NFRs → architecture decisions +- Domain requirements → compliance architecture +- Project-type requirements → platform choices + +**Epics & Stories (created after architecture):** +- FRs → user stories (1 FR could map to 1-3 stories potentially) +- Acceptance criteria → story acceptance tests +- Priority → sprint sequencing +- Traceability → stories map back to vision + +**Development AI Agents:** +- Precise requirements → implementation clarity +- Test criteria → automated test generation +- Domain requirements → compliance enforcement +- Measurable NFRs → performance targets + +--- + +## Summary: What Makes a Great BMAD PRD? + +✅ **High Information Density** - Every sentence carries weight, zero fluff +✅ **Measurable Requirements** - All FRs and NFRs are testable with specific criteria +✅ **Clear Traceability** - Each requirement links to user need and business objective +✅ **Domain Awareness** - Industry-specific requirements auto-detected and included +✅ **Zero Anti-Patterns** - No subjective adjectives, implementation leakage, or vague quantifiers +✅ **Dual Audience Optimized** - Human-readable AND LLM-consumable +✅ **Markdown Format** - Professional, clean, accessible to all stakeholders + +--- + +**Remember:** The PRD is the foundation. Quality here ripples through every subsequent phase. A dense, precise, well-traced PRD makes UX design, architecture, epic breakdown, and AI development dramatically more effective. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv b/src/modules/bmm/workflows/2-plan-workflows/prd/data/project-types.csv similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv rename to src/modules/bmm/workflows/2-plan-workflows/prd/data/project-types.csv diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md similarity index 91% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md index 7bafaae4..63a8e7ae 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md @@ -2,19 +2,13 @@ name: 'step-01-init' description: 'Initialize the PRD workflow by detecting continuation state and setting up the document' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-discovery.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-02-discovery.md' +continueStepFile: './step-01b-continue.md' outputFile: '{planning_artifacts}/prd.md' - -# Template References -prdTemplate: '{workflow_path}/prd-template.md' +# Template Reference +prdTemplate: '../templates/prd-template.md' --- # Step 1: Workflow Initialization @@ -157,7 +151,7 @@ Display menu after setup report: #### Menu Handling Logic: -- IF C: Update frontmatter with `stepsCompleted: [1]`, then load, read entire {nextStepFile}, then execute {nextStepFile} +- IF C: Update output file frontmatter, adding this step name to the end of the list of stepsCompleted, then load, read entire {nextStepFile}, then execute {nextStepFile} - IF user provides additional files: Load them, update inputDocuments and documentCounts, redisplay report - IF user asks questions: Answer and redisplay menu @@ -168,7 +162,7 @@ Display menu after setup report: ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [frontmatter properly updated with stepsCompleted: [1] and documentCounts], will you then load and read fully `{nextStepFile}` to execute and begin project discovery. +ONLY WHEN [C continue option] is selected and [frontmatter properly updated with this step added to stepsCompleted and documentCounts], will you then load and read fully `{nextStepFile}` to execute and begin project discovery. --- @@ -182,7 +176,7 @@ ONLY WHEN [C continue option] is selected and [frontmatter properly updated with - All discovered files tracked in frontmatter `inputDocuments` - User clearly informed of brownfield vs greenfield status - Menu presented and user input handled correctly -- Frontmatter updated with `stepsCompleted: [1]` before proceeding +- Frontmatter updated with this step name added to stepsCompleted before proceeding ### ❌ SYSTEM FAILURE: diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md similarity index 70% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md index 5f77a30e..5f3999bf 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md @@ -2,12 +2,7 @@ name: 'step-01b-continue' description: 'Resume an interrupted PRD workflow from the last completed step' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/prd.md' --- @@ -60,10 +55,9 @@ Resume the PRD workflow from where it was left off, ensuring smooth continuation **State Assessment:** Review the frontmatter to understand: -- `stepsCompleted`: Which steps are already done -- `lastStep`: The most recently completed step number +- `stepsCompleted`: Array of completed step filenames +- Last element of `stepsCompleted` array: The most recently completed step - `inputDocuments`: What context was already loaded -- `documentCounts`: briefs, research, brainstorming, projectDocs counts - All other frontmatter variables ### 2. Restore Context Documents @@ -74,47 +68,27 @@ Review the frontmatter to understand: - This ensures you have full context for continuation - Don't discover new documents - only reload what was previously processed -### 3. Present Current Progress +### 3. Determine Next Step -**Progress Report to User:** -"Welcome back {{user_name}}! I'm resuming our PRD collaboration for {{project_name}}. +**Simplified Next Step Logic:** +1. Get the last element from the `stepsCompleted` array (this is the filename of the last completed step, e.g., "step-03-success.md") +2. Load that step file and read its frontmatter +3. Extract the `nextStepFile` value from the frontmatter +4. That's the next step to load! -**Current Progress:** +**Example:** +- If `stepsCompleted = ["step-01-init.md", "step-02-discovery.md", "step-03-success.md"]` +- Last element is `"step-03-success.md"` +- Load `step-03-success.md`, read its frontmatter +- Find `nextStepFile: './step-04-journeys.md'` +- Next step to load is `./step-04-journeys.md` -- Steps completed: {stepsCompleted} -- Last worked on: Step {lastStep} -- Context documents available: {len(inputDocuments)} files +### 4. Handle Workflow Completion -**Document Status:** - -- Current PRD document is ready with all completed sections -- Ready to continue from where we left off - -Does this look right, or do you want to make any adjustments before we proceed?" - -### 4. Determine Continuation Path - -**Next Step Logic:** -Based on `lastStep` value, determine which step to load next: - -- If `lastStep = 1` → Load `./step-02-discovery.md` -- If `lastStep = 2` → Load `./step-03-success.md` -- If `lastStep = 3` → Load `./step-04-journeys.md` -- If `lastStep = 4` → Load `./step-05-domain.md` -- If `lastStep = 5` → Load `./step-06-innovation.md` -- If `lastStep = 6` → Load `./step-07-project-type.md` -- If `lastStep = 7` → Load `./step-08-scoping.md` -- If `lastStep = 8` → Load `./step-09-functional.md` -- If `lastStep = 9` → Load `./step-10-nonfunctional.md` -- If `lastStep = 10` → Load `./step-11-complete.md` -- If `lastStep = 11` → Workflow already complete - -### 5. Handle Workflow Completion - -**If workflow already complete (`lastStep = 11`):** +**If `stepsCompleted` array contains `"step-11-complete.md"`:** "Great news! It looks like we've already completed the PRD workflow for {{project_name}}. -The final document is ready at `{outputFile}` with all sections completed through step 11. +The final document is ready at `{outputFile}` with all sections completed. Would you like me to: @@ -124,16 +98,29 @@ Would you like me to: What would be most helpful?" -### 6. Present MENU OPTIONS +### 5. Present Current Progress **If workflow not complete:** -Display: "Ready to continue with Step {nextStepNumber}? +"Welcome back {{user_name}}! I'm resuming our PRD collaboration for {{project_name}}. -**Select an Option:** [C] Continue to next step" +**Current Progress:** +- Last completed: {last step filename from stepsCompleted array} +- Next up: {nextStepFile determined from that step's frontmatter} +- Context documents available: {len(inputDocuments)} files + +**Document Status:** +- Current PRD document is ready with all completed sections +- Ready to continue from where we left off + +Does this look right, or do you want to make any adjustments before we proceed?" + +### 6. Present MENU OPTIONS + +Display: "**Select an Option:** [C] Continue to {next step name}" #### Menu Handling Logic: -- IF C: Load, read entire file, then execute the appropriate next step file based on `lastStep` +- IF C: Load, read entire file, then execute the {nextStepFile} determined in step 3 - IF Any other comments or queries: respond and redisplay menu #### EXECUTION RULES: @@ -143,7 +130,7 @@ Display: "Ready to continue with Step {nextStepNumber}? ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the appropriate next step file to resume the workflow. +ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the {nextStepFile} to resume the workflow. --- @@ -160,7 +147,7 @@ ONLY WHEN [C continue option] is selected and [current state confirmed], will yo - Discovering new input documents instead of reloading existing ones - Modifying content from already completed steps -- Loading wrong next step based on `lastStep` value +- Failing to extract nextStepFile from the last completed step's frontmatter - Proceeding without user confirmation of current state **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md new file mode 100644 index 00000000..49f2557e --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md @@ -0,0 +1,224 @@ +--- +name: 'step-02-discovery' +description: 'Discover project type, domain, and context through collaborative dialogue' + +# File References +nextStepFile: './step-03-success.md' +outputFile: '{planning_artifacts}/prd.md' + +# Data Files +projectTypesCSV: '../data/project-types.csv' +domainComplexityCSV: '../data/domain-complexity.csv' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 2: Project Discovery + +**Progress: Step 2 of 13** - Next: Product Vision + +## STEP GOAL: + +Discover and classify the project - understand what type of product this is, what domain it operates in, and the project context (greenfield vs brownfield). + +## 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 the entire file is read +- ✅ ALWAYS treat this as collaborative discovery between PM peers +- 📋 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 product-focused PM facilitator collaborating with an expert peer +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision + +### Step-Specific Rules: + +- 🎯 Focus on classification and understanding - no content generation yet +- 🚫 FORBIDDEN to generate executive summary or vision statements (that's next steps) +- 💬 APPROACH: Natural conversation to understand the project +- 🎯 LOAD classification data BEFORE starting discovery conversation + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- ⚠️ Present A/P/C menu after classification complete +- 💾 ONLY save classification to frontmatter when user chooses C (Continue) +- 📖 Update frontmatter, adding this step to the end of the list of stepsCompleted +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from step 1 are available +- Input documents already loaded are in memory (product briefs, research, brainstorming, project docs) +- **Document counts available in frontmatter `documentCounts`** +- Classification CSV data will be loaded in this step only +- No executive summary or vision content yet (that's steps 2b and 2c) + +## YOUR TASK: + +Discover and classify the project through natural conversation: +- What type of product is this? (web app, API, mobile, etc.) +- What domain does it operate in? (healthcare, fintech, e-commerce, etc.) +- What's the project context? (greenfield new product vs brownfield existing system) +- How complex is this domain? (low, medium, high) + +## DISCOVERY SEQUENCE: + +### 1. Check Document State + +Read the frontmatter from `{outputFile}` to get document counts: +- `briefCount` - Product briefs available +- `researchCount` - Research documents available +- `brainstormingCount` - Brainstorming docs available +- `projectDocsCount` - Existing project documentation + +**Announce your understanding:** + +"From step 1, I have loaded: +- Product briefs: {{briefCount}} +- Research: {{researchCount}} +- Brainstorming: {{brainstormingCount}} +- Project docs: {{projectDocsCount}} + +{{if projectDocsCount > 0}}This is a brownfield project - I'll focus on understanding what you want to add or change.{{else}}This is a greenfield project - I'll help you define the full product vision.{{/if}}" + +### 2. Load Classification Data + +**Attempt subprocess data lookup:** + +**Project Type Lookup:** +"Your task: Lookup data in {projectTypesCSV} + +**Search criteria:** +- Find row where project_type matches {{detectedProjectType}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +project_type, detection_signals + +**Do NOT return the entire CSV - only the matching row.**" + +**Domain Complexity Lookup:** +"Your task: Lookup data in {domainComplexityCSV} + +**Search criteria:** +- Find row where domain matches {{detectedDomain}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +domain, complexity, typical_concerns, compliance_requirements + +**Do NOT return the entire CSV - only the matching row.**" + +**Graceful degradation (if Task tool unavailable):** +- Load the CSV files directly +- Find the matching rows manually +- Extract required fields +- Keep in memory for intelligent classification + +### 3. Begin Discovery Conversation + +**Start with what you know:** + +If the user has a product brief or project docs, acknowledge them and share your understanding. Then ask clarifying questions to deepen your understanding. + +If this is a greenfield project with no docs, start with open-ended discovery: +- What problem does this solve? +- Who's it for? +- What excites you about building this? + +**Listen for classification signals:** + +As the user describes their product, match against: +- **Project type signals** (API, mobile, SaaS, etc.) +- **Domain signals** (healthcare, fintech, education, etc.) +- **Complexity indicators** (regulated industries, novel technology, etc.) + +### 4. Confirm Classification + +Once you have enough understanding, share your classification: + +"I'm hearing this as: +- **Project Type:** {{detectedType}} +- **Domain:** {{detectedDomain}} +- **Complexity:** {{complexityLevel}} + +Does this sound right to you?" + +Let the user confirm or refine your classification. + +### 5. Save Classification to Frontmatter + +When user selects 'C', update frontmatter with classification: +```yaml +classification: + projectType: {{projectType}} + domain: {{domain}} + complexity: {{complexityLevel}} + projectContext: {{greenfield|brownfield}} +``` + +### N. Present MENU OPTIONS + +Present the project classification for review, then display menu: + +"Based on our conversation, I've discovered and classified your project. + +**Here's the classification:** + +**Project Type:** {{detectedType}} +**Domain:** {{detectedDomain}} +**Complexity:** {{complexityLevel}} +**Project Context:** {{greenfield|brownfield}} + +**What would you like to do?**" + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Product Vision (Step 2b of 13)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current classification, process the enhanced insights that come back, ask user if they accept the improvements, if yes update classification then redisplay menu, if no keep original classification then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current classification, process the collaborative insights, ask user if they accept the changes, if yes update classification then redisplay menu, if no keep original classification then redisplay menu +- IF C: Save classification to {outputFile} frontmatter, add this step name to the end of stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: 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 + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [classification saved to frontmatter], will you then load and read fully `{nextStepFile}` to explore product vision. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Document state checked and announced to user +- Classification data loaded and used intelligently +- Natural conversation to understand project type, domain, complexity +- Classification validated with user before saving +- Frontmatter updated with classification when C selected +- User's existing documents acknowledged and built upon + +### ❌ SYSTEM FAILURE: + +- Not reading documentCounts from frontmatter first +- Skipping classification data loading +- Generating executive summary or vision content (that's later steps!) +- Not validating classification with user +- Being prescriptive instead of having natural conversation +- Proceeding without user selecting 'C' + +**Master Rule:** This is classification and understanding only. No content generation yet. Build on what the user already has. Have natural conversations, don't follow scripts. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md similarity index 55% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md index d379f504..90906981 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md @@ -2,13 +2,8 @@ name: 'step-03-success' description: 'Define comprehensive success criteria covering user, business, and technical success' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-03-success.md' -nextStepFile: '{workflow_path}/steps/step-04-journeys.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-04-journeys.md' outputFile: '{planning_artifacts}/prd.md' # Task References @@ -37,24 +32,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 🎯 Show your analysis before taking any action - ⚠️ Present A/P/C menu after generating success criteria content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper insights about success metrics -- **P (Party Mode)**: Bring multiple perspectives to define comprehensive success criteria -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available @@ -76,38 +56,21 @@ Define comprehensive success criteria that cover user success, business success, Analyze product brief, research, and brainstorming documents for success criteria already mentioned. **If Input Documents Contain Success Criteria:** -"Looking at your product brief and research, I see some initial success criteria already defined: - -**From your brief:** -{{extracted_success_criteria_from_brief}} - -**From research:** -{{extracted_success_criteria_from_research}} - -**From brainstorming:** -{{extracted_success_criteria_from_brainstorming}} - -This gives us a great foundation. Let's refine and expand on these initial thoughts: - -**User Success First:** -Based on what we have, how would you refine these user success indicators: - -- {{refined_user_success_from_documents}} -- Are there other user success metrics we should consider? - -**What would make a user say 'this was worth it'** beyond what's already captured?" +Guide user to refine existing success criteria: +- Acknowledge what's already documented in their materials +- Extract key success themes from brief, research, and brainstorming +- Help user identify gaps and areas for expansion +- Probe for specific, measurable outcomes: When do users feel delighted/relieved/empowered? +- Ask about emotional success moments and completion scenarios +- Explore what "worth it" means beyond what's already captured **If No Success Criteria in Input Documents:** -Start with user-centered success: -"Now that we understand what makes {{project_name}} special, let's define what success looks like. - -**User Success First:** - -- What would make a user say 'this was worth it'? -- What's the moment where they realize this solved their problem? -- After using {{project_name}}, what outcome are they walking away with? - -Let's start with the user experience of success." +Start with user-centered success exploration: +- Guide conversation toward defining what "worth it" means for users +- Ask about the moment users realize their problem is solved +- Explore specific user outcomes and emotional states +- Identify success "aha!" moments and completion scenarios +- Focus on user experience of success first ### 2. Explore User Success Metrics @@ -121,15 +84,11 @@ Listen for specific user outcomes and help make them measurable: ### 3. Define Business Success Transition to business metrics: -"Now let's look at success from the business perspective. - -**Business Success:** - -- What does success look like at 3 months? 12 months? -- Are we measuring revenue, user growth, engagement, something else? -- What metric would make you say 'this is working'? - -Help me understand what success means for your business." +- Guide conversation to business perspective on success +- Explore timelines: What does 3-month success look like? 12-month success? +- Identify key business metrics: revenue, user growth, engagement, or other measures? +- Ask what specific metric would indicate "this is working" +- Understand business success from their perspective ### 4. Challenge Vague Metrics @@ -143,31 +102,25 @@ Push for specificity on business metrics: ### 5. Connect to Product Differentiator Tie success metrics back to what makes the product special: -"So success means users experience [differentiator] and achieve [outcome]. Does that capture it?" - -Adapt success criteria to context: - -- Consumer: User love, engagement, retention -- B2B: ROI, efficiency, adoption -- Developer tools: Developer experience, community -- Regulated: Compliance, safety, validation -- GovTech: Government compliance, accessibility, procurement +- Connect success criteria to the product's unique differentiator +- Ensure metrics reflect the specific value proposition +- Adapt success criteria to domain context: + - Consumer: User love, engagement, retention + - B2B: ROI, efficiency, adoption + - Developer tools: Developer experience, community + - Regulated: Compliance, safety, validation + - GovTech: Government compliance, accessibility, procurement ### 6. Smart Scope Negotiation Guide scope definition through success lens: -"The Scoping Game: - -1. What must work for this to be useful? → MVP -2. What makes it competitive? → Growth -3. What's the dream version? → Vision - -Challenge scope creep conversationally: - -- Could that wait until after launch? -- Is that essential for proving the concept? - -For complex domains, include compliance minimums in MVP." +- Help user distinguish MVP (must work to be useful) from growth (competitive) and vision (dream) +- Guide conversation through three scope levels: + 1. MVP: What's essential for proving the concept? + 2. Growth: What makes it competitive? + 3. Vision: What's the dream version? +- Challenge scope creep conversationally: Could this wait until after launch? Is this essential for MVP? +- For complex domains: Ensure compliance minimums are included in MVP ### 7. Generate Success Criteria Content @@ -211,43 +164,26 @@ When saving to document, append these Level 2 and Level 3 sections: [Content about future vision based on conversation] ``` -### 8. Present Content and Menu +### 8. Present MENU OPTIONS -Show the generated content and present choices: -"I've drafted our success criteria and scope definition based on our conversation. +Present the success criteria content for user review, then display menu: -**Here's what I'll add to the document:** +- Show the drafted success criteria and scope definition (using structure from section 7) +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of the conversation -[Show the complete markdown content from step 7] +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to User Journey Mapping (Step 4 of 11)" -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper and refine these success metrics -[P] Party Mode - Bring in different perspectives on success criteria -[C] Continue - Save success criteria and move to User Journey Mapping (Step 4 of 11)" +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current success criteria content, process the enhanced success metrics that come back, ask user "Accept these improvements to the success criteria? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current success criteria, process the collaborative improvements to metrics and scope, ask user "Accept these changes to the success criteria? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -### 9. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current success criteria content -- Process the enhanced success metrics that come back -- Ask user: "Accept these improvements to the success criteria? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current success criteria -- Process the collaborative improvements to metrics and scope -- Ask user: "Accept these changes to the success criteria? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step to the end of the steps completed array -- Load `./step-04-journeys.md` +#### 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 ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md new file mode 100644 index 00000000..765eb8b3 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md @@ -0,0 +1,213 @@ +--- +name: 'step-04-journeys' +description: 'Map ALL user types that interact with the system with narrative story-based journeys' + +# File References +nextStepFile: './step-05-domain.md' +outputFile: '{planning_artifacts}/prd.md' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 4: User Journey Mapping + +**Progress: Step 4 of 11** - Next: Domain Requirements + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without user input + +- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions +- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding +- ✅ ALWAYS treat this as collaborative discovery between PM peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on mapping ALL user types that interact with the system +- 🎯 CRITICAL: No journey = no functional requirements = product doesn't exist +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- ⚠️ Present A/P/C menu after generating journey content +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from previous steps are available +- Success criteria and scope already defined +- Input documents from step-01 are available (product briefs with user personas) +- Every human interaction with the system needs a journey + +## YOUR TASK: + +Create compelling narrative user journeys that leverage existing personas from product briefs and identify additional user types needed for comprehensive coverage. + +## JOURNEY MAPPING SEQUENCE: + +### 1. Leverage Existing Users & Identify Additional Types + +**Check Input Documents for Existing Personas:** +Analyze product brief, research, and brainstorming documents for user personas already defined. + +**If User Personas Exist in Input Documents:** +Guide user to build on existing personas: +- Acknowledge personas found in their product brief +- Extract key persona details and backstories +- Leverage existing insights about their needs +- Prompt to identify additional user types beyond those documented +- Suggest additional user types based on product context (admins, moderators, support, API consumers, internal ops) +- Ask what additional user types should be considered + +**If No Personas in Input Documents:** +Start with comprehensive user type discovery: +- Guide exploration of ALL people who interact with the system +- Consider beyond primary users: admins, moderators, support staff, API consumers, internal ops +- Ask what user types should be mapped for this specific product +- Ensure comprehensive coverage of all system interactions + +### 2. Create Narrative Story-Based Journeys + +For each user type, create compelling narrative journeys that tell their story: + +#### Narrative Journey Creation Process: + +**If Using Existing Persona from Input Documents:** +Guide narrative journey creation: +- Use persona's existing backstory from brief +- Explore how the product changes their life/situation +- Craft journey narrative: where do we meet them, how does product help them write their next chapter? + +**If Creating New Persona:** +Guide persona creation with story framework: +- Name: realistic name and personality +- Situation: What's happening in their life/work that creates need? +- Goal: What do they desperately want to achieve? +- Obstacle: What's standing in their way? +- Solution: How does the product solve their story? + +**Story-Based Journey Mapping:** + +Guide narrative journey creation using story structure: +- **Opening Scene**: Where/how do we meet them? What's their current pain? +- **Rising Action**: What steps do they take? What do they discover? +- **Climax**: Critical moment where product delivers real value +- **Resolution**: How does their situation improve? What's their new reality? + +Encourage narrative format with specific user details, emotional journey, and clear before/after contrast + +### 3. Guide Journey Exploration + +For each journey, facilitate detailed exploration: +- What happens at each step specifically? +- What could go wrong? What's the recovery path? +- What information do they need to see/hear? +- What's their emotional state at each point? +- Where does this journey succeed or fail? + +### 4. Connect Journeys to Requirements + +After each journey, explicitly state: +- This journey reveals requirements for specific capability areas +- Help user see how different journeys create different feature sets +- Connect journey needs to concrete capabilities (onboarding, dashboards, notifications, etc.) + +### 5. Aim for Comprehensive Coverage + +Guide toward complete journey set: + +- **Primary user** - happy path (core experience) +- **Primary user** - edge case (different goal, error recovery) +- **Secondary user** (admin, moderator, support, etc.) +- **API consumer** (if applicable) + +Ask if additional journeys are needed to cover uncovered user types + +### 6. Generate User Journey Content + +Prepare the content to append to the document: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## User Journeys + +[All journey narratives based on conversation] + +### Journey Requirements Summary + +[Summary of capabilities revealed by journeys based on conversation] +``` + +### 7. Present MENU OPTIONS + +Present the user journey content for review, then display menu: +- Show the mapped user journeys (using structure from section 6) +- Highlight how each journey reveals different capabilities +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Domain Requirements (Step 5 of 11)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current journey content, process the enhanced journey insights that come back, ask user "Accept these improvements to the user journeys? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current journeys, process the collaborative journey improvements and additions, ask user "Accept these changes to the user journeys? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: 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 + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 6. + +## SUCCESS METRICS: + +✅ Existing personas from product briefs leveraged when available +✅ All user types identified (not just primary users) +✅ Rich narrative storytelling for each persona and journey +✅ Complete story-based journey mapping with emotional arc +✅ Journey requirements clearly connected to capabilities needed +✅ Minimum 3-4 compelling narrative journeys covering different user types +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Ignoring existing personas from product briefs +❌ Only mapping primary user journeys and missing secondary users +❌ Creating generic journeys without rich persona details and narrative +❌ Missing emotional storytelling elements that make journeys compelling +❌ Missing critical decision points and failure scenarios +❌ Not connecting journeys to required capabilities +❌ Not having enough journey diversity (admin, support, API, etc.) +❌ Not presenting A/P/C menu after content generation +❌ Appending content without user selecting 'C' + +❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions +❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file +❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols + +## JOURNEY TYPES TO ENSURE: + +**Minimum Coverage:** + +1. **Primary User - Success Path**: Core experience journey +2. **Primary User - Edge Case**: Error recovery, alternative goals +3. **Admin/Operations User**: Management, configuration, monitoring +4. **Support/Troubleshooting**: Help, investigation, issue resolution +5. **API/Integration** (if applicable): Developer/technical user journey + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-05-domain.md`. + +Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md new file mode 100644 index 00000000..36351c64 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md @@ -0,0 +1,207 @@ +--- +name: 'step-05-domain' +description: 'Explore domain-specific requirements for complex domains (optional step)' + +# File References +nextStepFile: './step-06-innovation.md' +outputFile: '{planning_artifacts}/prd.md' +domainComplexityCSV: '../data/domain-complexity.csv' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 5: Domain-Specific Requirements (Optional) + +**Progress: Step 5 of 13** - Next: Innovation Focus + +## STEP GOAL: + +For complex domains only that have a mapping in {domainComplexityCSV}, explore domain-specific constraints, compliance requirements, and technical considerations that shape the product. + +## 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 the entire file is read +- ✅ ALWAYS treat this as collaborative discovery between PM peers +- 📋 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 product-focused PM facilitator collaborating with an expert peer +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise + +### Step-Specific Rules: + +- 🎯 This step is OPTIONAL - only needed for complex domains +- 🚫 SKIP if domain complexity is "low" from step-02 +- 💬 APPROACH: Natural conversation to discover domain-specific needs +- 🎯 Focus on constraints, compliance, and domain patterns + +## EXECUTION PROTOCOLS: + +- 🎯 Check domain complexity from step-02 classification first +- ⚠️ If complexity is "low", offer to skip this step +- ⚠️ Present A/P/C menu after domain requirements defined (or skipped) +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Domain classification from step-02 is available +- If complexity is low, this step may be skipped +- Domain CSV data provides complexity reference +- Focus on domain-specific constraints, not general requirements + +## YOUR TASK: + +For complex domains, explore what makes this domain special: +- **Compliance requirements** - regulations, standards, certifications +- **Technical constraints** - security, privacy, integration requirements +- **Domain patterns** - common patterns, best practices, anti-patterns +- **Risks and mitigations** - what could go wrong, how to prevent it + +## DOMAIN DISCOVERY SEQUENCE: + +### 1. Check Domain Complexity + +**Review classification from step-02:** + +- What's the domain complexity level? (low/medium/high) +- What's the specific domain? (healthcare, fintech, education, etc.) + +**If complexity is LOW:** + +Offer to skip: +"The domain complexity from our discovery is low. We may not need deep domain-specific requirements. Would you like to: +- [C] Skip this step and move to Innovation +- [D] Do domain exploration anyway" + +**If complexity is MEDIUM or HIGH:** + +Proceed with domain exploration. + +### 2. Load Domain Reference Data + +**Attempt subprocess data lookup:** + +"Your task: Lookup data in {domainComplexityCSV} + +**Search criteria:** +- Find row where domain matches {{domainFromStep02}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +domain, complexity, typical_concerns, compliance_requirements + +**Do NOT return the entire CSV - only the matching row.**" + +**Graceful degradation (if Task tool unavailable):** +- Load the CSV file directly +- Find the matching row manually +- Extract required fields +- Understand typical concerns and compliance requirements + +### 3. Explore Domain-Specific Concerns + +**Start with what you know:** + +Acknowledge the domain and explore what makes it complex: +- What regulations apply? (HIPAA, PCI-DSS, GDPR, SOX, etc.) +- What standards matter? (ISO, NIST, domain-specific standards) +- What certifications are needed? (security, privacy, domain-specific) +- What integrations are required? (EMR systems, payment processors, etc.) + +**Explore technical constraints:** +- Security requirements (encryption, audit logs, access control) +- Privacy requirements (data handling, consent, retention) +- Performance requirements (real-time, batch, latency) +- Availability requirements (uptime, disaster recovery) + +### 4. Document Domain Requirements + +**Structure the requirements around key concerns:** + +```markdown +### Compliance & Regulatory +- [Specific requirements] + +### Technical Constraints +- [Security, privacy, performance needs] + +### Integration Requirements +- [Required systems and data flows] + +### Risk Mitigations +- [Domain-specific risks and how to address them] +``` + +### 5. Validate Completeness + +**Check with the user:** + +"Are there other domain-specific concerns we should consider? For [this domain], what typically gets overlooked?" + +### N. Present MENU OPTIONS + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue - Save and Proceed to Innovation (Step 6 of 13)" + +#### 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 + +## APPEND TO DOCUMENT + +When user selects 'C', append to `{outputFile}`: + +```markdown +## Domain-Specific Requirements + +{{discovered domain requirements}} +``` + +If step was skipped, append nothing and proceed. + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [content saved or skipped], will you then load and read fully `{nextStepFile}` to explore innovation. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Domain complexity checked before proceeding +- Offered to skip if complexity is low +- Natural conversation exploring domain concerns +- Compliance, technical, and integration requirements identified +- Domain-specific risks documented with mitigations +- User validated completeness +- Content properly saved (or step skipped) when C selected + +### ❌ SYSTEM FAILURE: + +- Not checking domain complexity first +- Not offering to skip for low-complexity domains +- Missing critical compliance requirements +- Not exploring technical constraints +- Not asking about domain-specific risks +- Being generic instead of domain-specific +- Proceeding without user validation + +**Master Rule:** This step is OPTIONAL for simple domains. For complex domains, focus on compliance, constraints, and domain patterns. Natural conversation, not checklists. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md similarity index 58% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md index 28af51eb..85e3d473 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md @@ -2,17 +2,12 @@ name: 'step-06-innovation' description: 'Detect and explore innovative aspects of the product (optional step)' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-06-innovation.md' -nextStepFile: '{workflow_path}/steps/step-07-project-type.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-07-project-type.md' outputFile: '{planning_artifacts}/prd.md' # Data Files -projectTypesCSV: '{workflow_path}/project-types.csv' +projectTypesCSV: '../data/project-types.csv' # Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -40,24 +35,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 🎯 Show your analysis before taking any action - ⚠️ Present A/P/C menu after generating innovation content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper innovation insights -- **P (Party Mode)**: Bring creative perspectives to explore innovation opportunities -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available @@ -84,7 +64,7 @@ Detect and explore innovation patterns in the product, focusing on what makes it Load innovation signals specific to this project type: -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv` completely +- Load `{projectTypesCSV}` completely - Find the row where `project_type` matches detected type from step-02 - Extract `innovation_signals` (semicolon-separated list) - Extract `web_search_triggers` for potential innovation research @@ -113,27 +93,22 @@ Match user descriptions against innovation_signals for their project_type: ### 3. Initial Innovation Screening Ask targeted innovation discovery questions: -"As we explore {{project_name}}, I'm listening for what makes it innovative. - -**Innovation Indicators:** - -- Are you challenging any existing assumptions about how things work? -- Are you combining technologies or approaches in new ways? -- Is there something about this that hasn't been done before? - -What aspects of {{project_name}} feel most innovative to you?" +- Guide exploration of what makes the product innovative +- Explore if they're challenging existing assumptions +- Ask about novel combinations of technologies/approaches +- Identify what hasn't been done before +- Understand which aspects feel most innovative ### 4. Deep Innovation Exploration (If Detected) If innovation signals are found, explore deeply: #### Innovation Discovery Questions: - -- "What makes it unique compared to existing solutions?" -- "What assumption are you challenging?" -- "How do we validate it works?" -- "What's the fallback if it doesn't?" -- "Has anyone tried this before?" +- What makes it unique compared to existing solutions? +- What assumption are you challenging? +- How do we validate it works? +- What's the fallback if it doesn't? +- Has anyone tried this before? #### Market Context Research: @@ -169,54 +144,43 @@ When saving to document, append these Level 2 and Level 3 sections: [Innovation risks and fallbacks based on conversation] ``` -### 6. Present Content and Menu (Only if Innovation Detected) +### 6. Present MENU OPTIONS (Only if Innovation Detected) -Show the generated innovation content and present choices: -"I've identified some innovative aspects of {{project_name}} that differentiate it from existing solutions. +Present the innovation content for review, then display menu: +- Show identified innovative aspects (using structure from section 5) +- Highlight differentiation from existing solutions +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -**Here's what I'll add to the document:** +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Project Type Analysis (Step 7 of 11)" -[Show the complete markdown content from step 5] +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current innovation content, process the enhanced innovation insights that come back, ask user "Accept these improvements to the innovation analysis? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current innovation content, process the collaborative innovation exploration and ideation, ask user "Accept these changes to the innovation analysis? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these innovation opportunities -[P] Party Mode - Bring creative perspectives to explore innovation further -[C] Continue - Save this and move to Project Type Analysis (Step 7 of 11)" - -### 7. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current innovation content -- Process the enhanced innovation insights that come back -- Ask user: "Accept these improvements to the innovation analysis? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current innovation content -- Process the collaborative innovation exploration and ideation -- Ask user: "Accept these changes to the innovation analysis? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` +#### 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 ## NO INNOVATION DETECTED: If no genuine innovation signals are found after exploration: -"After exploring {{project_name}}, I don't see clear innovation signals that warrant a dedicated innovation section. This is perfectly fine - many successful products are excellent executions of existing concepts rather than breakthrough innovations. +- Acknowledge that no clear innovation signals were found +- Note this is fine - many successful products are excellent executions of existing concepts +- Ask if they'd like to try finding innovative angles or proceed -**Options:** -[A] Force innovation exploration - Let's try to find innovative angles -[C] Continue - Skip innovation section and move to Project Type Analysis (Step 7 of 11)" +Display: "**Select:** [A] Advanced Elicitation - Let's try to find innovative angles [C] Continue - Skip innovation section and move to Project Type Analysis (Step 7 of 11)" -If user selects 'A', proceed with content generation anyway. If 'C', skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`. +### Menu Handling Logic: +- IF A: Proceed with content generation anyway, then return to menu +- IF C: Skip this step, then load, read entire file, then execute {nextStepFile} + +### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' ## APPEND TO DOCUMENT: @@ -248,7 +212,7 @@ When user selects 'C', append the content directly to the document using the str ## SKIP CONDITIONS: -Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` if: +Skip this step and load `{nextStepFile}` if: - No innovation signals detected in conversation - Product is incremental improvement rather than breakthrough @@ -257,6 +221,6 @@ Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd ## NEXT STEP: -After user selects 'C' and content is saved to document (or step is skipped), load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`. +After user selects 'C' and content is saved to document (or step is skipped), load `{nextStepFile}`. Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu (or confirms step skip)! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md similarity index 68% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md index 3b992526..27650819 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md @@ -2,17 +2,12 @@ name: 'step-07-project-type' description: 'Conduct project-type specific discovery using CSV-driven guidance' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-07-project-type.md' -nextStepFile: '{workflow_path}/steps/step-08-scoping.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-08-scoping.md' outputFile: '{planning_artifacts}/prd.md' # Data Files -projectTypesCSV: '{workflow_path}/project-types.csv' +projectTypesCSV: '../data/project-types.csv' # Task References advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' @@ -40,24 +35,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 🎯 Show your analysis before taking any action - ⚠️ Present A/P/C menu after generating project-type content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper project-type insights -- **P (Party Mode)**: Bring technical perspectives to explore project-specific requirements -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available @@ -73,11 +53,23 @@ Conduct project-type specific discovery using CSV-driven guidance to define tech ### 1. Load Project-Type Configuration Data -Load project-type specific configuration: +**Attempt subprocess data lookup:** -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv` completely -- Find the row where `project_type` matches detected type from step-02 -- Extract these columns: +"Your task: Lookup data in {projectTypesCSV} + +**Search criteria:** +- Find row where project_type matches {{projectTypeFromStep02}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +project_type, key_questions, required_sections, skip_sections, innovation_signals + +**Do NOT return the entire CSV - only the matching row.**" + +**Graceful degradation (if Task tool unavailable):** +- Load the CSV file directly +- Find the matching row manually +- Extract required fields: - `key_questions` (semicolon-separated list of discovery questions) - `required_sections` (semicolon-separated list of sections to document) - `skip_sections` (semicolon-separated list of sections to skip) @@ -165,47 +157,34 @@ When saving to document, append these Level 2 and Level 3 sections: [Implementation specific requirements based on conversation] ``` -### 6. Present Content and Menu +### 6. Present MENU OPTIONS -Show the generated project-type content and present choices: -"I've documented the {project_type}-specific requirements for {{project_name}} based on our conversation and best practices for this type of product. +Present the project-type content for review, then display menu: + +"Based on our conversation and best practices for this product type, I've documented the {project_type}-specific requirements for {{project_name}}. **Here's what I'll add to the document:** -[Show the complete markdown content from step 5] +[Show the complete markdown content from section 5] -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these technical requirements -[P] Party Mode - Bring technical expertise perspectives to validate requirements -[C] Continue - Save this and move to Scoping (Step 8 of 11)" +**What would you like to do?**" -### 7. Handle Menu Selection +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Scoping (Step 8 of 11)" -#### If 'A' (Advanced Elicitation): +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current project-type content, process the enhanced technical insights that come back, ask user "Accept these improvements to the technical requirements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current project-type requirements, process the collaborative technical expertise and validation, ask user "Accept these changes to the technical requirements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current project-type content -- Process the enhanced technical insights that come back -- Ask user: "Accept these improvements to the technical requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current project-type requirements -- Process the collaborative technical expertise and validation -- Ask user: "Accept these changes to the technical requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` +#### 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 ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the document using the structure from step 5. +When user selects 'C', append the content directly to the document using the structure from previous steps. ## SUCCESS METRICS: @@ -253,6 +232,6 @@ When user selects 'C', append the content directly to the document using the str ## NEXT STEP: -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` to define project scope. +After user selects 'C' and content is saved to document, load `{nextStepFile}` to define project scope. Remember: Do NOT proceed to step-08 (Scoping) until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md similarity index 53% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md index 33f72f5c..c26ad663 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md @@ -2,13 +2,8 @@ name: 'step-08-scoping' description: 'Define MVP boundaries and prioritize features across development phases' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-08-scoping.md' -nextStepFile: '{workflow_path}/steps/step-09-functional.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-09-functional.md' outputFile: '{planning_artifacts}/prd.md' # Task References @@ -38,23 +33,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📚 Review the complete PRD document built so far - ⚠️ Present A/P/C menu after generating scoping decisions - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to explore innovative scoping approaches -- **P (Party Mode)**: Bring multiple perspectives to ensure comprehensive scope decisions -- **C (Continue)**: Save the scoping decisions and proceed to functional requirements - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed -- User accepts/rejects protocol changes before proceeding ## CONTEXT BOUNDARIES: @@ -72,80 +53,46 @@ Conduct comprehensive scoping exercise to define MVP boundaries and prioritize f ### 1. Review Current PRD State Analyze everything documented so far: -"I've reviewed your complete PRD so far. Here's what we've established: - -**Product Vision & Success:** -{{summary_of_vision_and_success_criteria}} - -**User Journeys:** {{number_of_journeys}} mapped with rich narratives - -**Domain & Innovation Focus:** -{{summary_of_domain_requirements_and_innovation}} - -**Current Scope Implications:** -Based on everything we've documented, this looks like it could be: - -- [ ] Simple MVP (small team, lean scope) -- [ ] Medium scope (moderate team, balanced features) -- [ ] Complex project (large team, comprehensive scope) - -Does this initial assessment feel right, or do you see this differently?" +- Present synthesis of established vision, success criteria, journeys +- Assess domain and innovation focus +- Evaluate scope implications: simple MVP, medium, or complex project +- Ask if initial assessment feels right or if they see it differently ### 2. Define MVP Strategy Facilitate strategic MVP decisions: - -"Let's think strategically about your launch strategy: - -**MVP Philosophy Options:** - -1. **Problem-Solving MVP**: Solve the core problem with minimal features -2. **Experience MVP**: Deliver the key user experience with basic functionality -3. **Platform MVP**: Build the foundation for future expansion -4. **Revenue MVP**: Generate early revenue with essential features - -**Critical Questions:** - -- What's the minimum that would make users say 'this is useful'? -- What would make investors/partners say 'this has potential'? -- What's the fastest path to validated learning? - -**Which MVP approach feels right for {{project_name}}?**" +- Explore MVP philosophy options: problem-solving, experience, platform, or revenue MVP +- Ask critical questions: + - What's the minimum that would make users say 'this is useful'? + - What would make investors/partners say 'this has potential'? + - What's the fastest path to validated learning? +- Guide toward appropriate MVP approach for their product ### 3. Scoping Decision Framework Use structured decision-making for scope: **Must-Have Analysis:** -"Let's identify absolute MVP necessities. For each journey and success criterion, ask: - -- **Without this, does the product fail?** (Y/N) -- **Can this be manual initially?** (Y/N) -- **Is this a deal-breaker for early adopters?** (Y/N) - -**Current Document Review:** -Looking at your user journeys, what are the absolute core experiences that must work? - -{{analyze_journeys_for_mvp_essentials}}" +- Guide identification of absolute MVP necessities +- For each journey and success criterion, ask: + - Without this, does the product fail? + - Can this be manual initially? + - Is this a deal-breaker for early adopters? +- Analyze journeys for MVP essentials **Nice-to-Have Analysis:** -"Let's also identify what could be added later: - -**Post-MVP Enhancements:** - -- Features that enhance but aren't essential -- User types that can be added later -- Advanced functionality that builds on MVP - -**What features could we add in versions 2, 3, etc.?**" +- Identify what could be added later: + - Features that enhance but aren't essential + - User types that can be added later + - Advanced functionality that builds on MVP +- Ask what features could be added in versions 2, 3, etc. ### 4. Progressive Feature Roadmap Create phased development approach: - -"Let's map your features across development phases: - -**Phase 1: MVP** +- Guide mapping of features across development phases +- Structure as Phase 1 (MVP), Phase 2 (Growth), Phase 3 (Vision) +- Ensure clear progression and dependencies - Core user value delivery - Essential user journeys @@ -225,44 +172,26 @@ Prepare comprehensive scoping section: **Resource Risks:** {{contingency_approach}} ``` -### 7. Present Content and Menu +### 7. Present MENU OPTIONS -Show the scoping decisions and present choices: +Present the scoping decisions for review, then display menu: +- Show strategic scoping plan (using structure from step 6) +- Highlight MVP boundaries and phased roadmap +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -"I've analyzed your complete PRD and created a strategic scoping plan for {{project_name}}. +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Functional Requirements (Step 9 of 11)" -**Here's what I'll add to the document:** +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current scoping analysis, process the enhanced insights that come back, ask user if they accept the improvements, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the scoping context, process the collaborative insights on MVP and roadmap decisions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -[Show the complete markdown content from step 6] - -**What would you like to do?** -[A] Advanced Elicitation - Explore alternative scoping strategies -[P] Party Mode - Bring different perspectives on MVP and roadmap decisions -[C] Continue - Save scoping decisions and move to Functional Requirements (Step 9 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with current scoping analysis -- Process enhanced scoping insights that come back -- Ask user: "Accept these improvements to the scoping decisions? (y/n)" -- If yes: Update content, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with scoping context -- Process collaborative insights on MVP and roadmap decisions -- Ask user: "Accept these changes to the scoping decisions? (y/n)" -- If yes: Update content, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `./step-09-functional.md` +#### 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 ## APPEND TO DOCUMENT: @@ -294,6 +223,6 @@ When user selects 'C', append the content directly to the document using the str ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-09-functional.md`. +After user selects 'C' and content is saved to document, load {nextStepFile}. Remember: Do NOT proceed to step-09 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md similarity index 70% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md index d91e49b9..36fb71b4 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md @@ -2,13 +2,8 @@ name: 'step-09-functional' description: 'Synthesize all discovery into comprehensive functional requirements' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-09-functional.md' -nextStepFile: '{workflow_path}/steps/step-10-nonfunctional.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-10-nonfunctional.md' outputFile: '{planning_artifacts}/prd.md' # Task References @@ -37,23 +32,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 🎯 Show your analysis before taking any action - ⚠️ Present A/P/C menu after generating functional requirements - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive requirement coverage -- **P (Party Mode)**: Bring multiple perspectives to validate complete requirement set -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding ## CONTEXT BOUNDARIES: @@ -186,49 +167,29 @@ When saving to document, append these Level 2 and Level 3 sections: [Continue for all capability areas discovered in conversation] ``` -### 7. Present Content and Menu +### 7. Present MENU OPTIONS -Show the generated functional requirements and present choices: -"I've synthesized all our discussions into comprehensive functional requirements. This becomes the capability contract that UX designers, architects, and developers will all work from. +Present the functional requirements for review, then display menu: +- Show synthesized functional requirements (using structure from step 6) +- Emphasize this is the capability contract for all downstream work +- Highlight that every feature must trace back to these requirements +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -**Here's what I'll add to the document:** +**What would you like to do?**" -[Show the complete FR list from step 6] +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Non-Functional Requirements (Step 10 of 11)" -**This is critical because:** +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current FR list, process the enhanced capability coverage that comes back, ask user if they accept the additions, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current FR list, process the collaborative capability validation and additions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -- Every feature we build must trace back to one of these requirements -- UX designers will ONLY design interactions for these capabilities -- Architects will ONLY build systems to support these capabilities - -**What would you like to do?** -[A] Advanced Elicitation - Let's ensure we haven't missed any capabilities -[P] Party Mode - Bring different perspectives to validate complete coverage -[C] Continue - Save this and move to Non-Functional Requirements (Step 10 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current FR list -- Process the enhanced capability coverage that comes back -- Ask user: "Accept these additions to the functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current FR list -- Process the collaborative capability validation and additions -- Ask user: "Accept these changes to the functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` +#### 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 ## APPEND TO DOCUMENT: @@ -265,6 +226,6 @@ Emphasize to user: "This FR list is now binding. Any feature not listed here wil ## NEXT STEP: -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` to define non-functional requirements. +After user selects 'C' and content is saved to document, load {nextStepFile} to define non-functional requirements. Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md similarity index 64% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md index 48422859..403a647e 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md @@ -2,13 +2,8 @@ name: 'step-10-nonfunctional' description: 'Define quality attributes that matter for this specific product' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-10-nonfunctional.md' -nextStepFile: '{workflow_path}/steps/step-11-complete.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-11-polish.md' outputFile: '{planning_artifacts}/prd.md' # Task References @@ -18,7 +13,7 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Step 10: Non-Functional Requirements -**Progress: Step 10 of 11** - Next: Complete PRD +**Progress: Step 10 of 12** - Next: Polish Document ## MANDATORY EXECUTION RULES (READ FIRST): @@ -37,23 +32,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 🎯 Show your analysis before taking any action - ⚠️ Present A/P/C menu after generating NFR content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive quality attributes -- **P (Party Mode)**: Bring technical perspectives to validate NFR completeness -- **C (Continue)**: Save the content to the document and proceed to final step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding ## CONTEXT BOUNDARIES: @@ -97,56 +78,41 @@ For each relevant category, conduct targeted discovery: #### Performance NFRs (If relevant): -"Let's talk about performance requirements for {{project_name}}. - -**Performance Questions:** - +Explore performance requirements: - What parts of the system need to be fast for users to be successful? - Are there specific response time expectations? - What happens if performance is slower than expected? -- Are there concurrent user scenarios we need to support?" +- Are there concurrent user scenarios we need to support? #### Security NFRs (If relevant): -"Security is critical for products that handle sensitive information. - -**Security Questions:** - +Explore security requirements: - What data needs to be protected? - Who should have access to what? - What are the security risks we need to mitigate? -- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)?" +- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)? #### Scalability NFRs (If relevant): -"Scalability matters if we expect growth or have variable demand. - -**Scalability Questions:** - +Explore scalability requirements: - How many users do we expect initially? Long-term? - Are there seasonal or event-based traffic spikes? -- What happens if we exceed our capacity?" -- What growth scenarios should we plan for?" +- What happens if we exceed our capacity? +- What growth scenarios should we plan for? #### Accessibility NFRs (If relevant): -"Accessibility ensures the product works for users with disabilities. - -**Accessibility Questions:** - +Explore accessibility requirements: - Are we serving users with visual, hearing, or motor impairments? - Are there legal accessibility requirements (WCAG, Section 508)? -- What accessibility features are most important for our users?" +- What accessibility features are most important for our users? #### Integration NFRs (If relevant): -"Integration requirements matter for products that connect to other systems. - -**Integration Questions:** - +Explore integration requirements: - What external systems do we need to connect with? - Are there APIs or data formats we must support? -- How reliable do these integrations need to be?" +- How reliable do these integrations need to be? ### 4. Make NFRs Specific and Measurable @@ -190,45 +156,27 @@ When saving to document, append these Level 2 and Level 3 sections (only include [Integration requirements based on conversation - only include if relevant] ``` -### 6. Present Content and Menu +### 6. Present MENU OPTIONS -Show the generated NFR content and present choices: -"I've defined the non-functional requirements that specify how well {{project_name}} needs to perform. I've only included categories that actually matter for this product. +Present the non-functional requirements for review, then display menu: +- Show defined NFRs (using structure from step 5) +- Note that only relevant categories were included +- Emphasize NFRs specify how well the system needs to perform +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -**Here's what I'll add to the document:** +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Polish Document (Step 11 of 12)" -[Show the complete NFR content from step 5] +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current NFR content, process the enhanced quality attribute insights that come back, ask user if they accept the improvements, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current NFR list, process the collaborative technical validation and additions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -**Note:** We've skipped categories that don't apply to avoid unnecessary requirements. - -**What would you like to do?** -[A] Advanced Elicitation - Let's ensure we haven't missed critical quality attributes -[P] Party Mode - Bring technical perspectives to validate NFR specifications -[C] Continue - Save this and move to Complete PRD (Step 11 of 11)" - -### 7. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current NFR content -- Process the enhanced quality attribute insights that come back -- Ask user: "Accept these improvements to the non-functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current NFR list -- Process the collaborative technical validation and additions -- Ask user: "Accept these changes to the non-functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` +#### 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 ## APPEND TO DOCUMENT: @@ -289,6 +237,6 @@ When user selects 'C', append the content directly to the document using the str ## NEXT STEP: -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` to finalize the PRD and complete the workflow. +After user selects 'C' and content is saved to document, load {nextStepFile} to finalize the PRD and complete the workflow. Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md new file mode 100644 index 00000000..1edbf0bf --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md @@ -0,0 +1,217 @@ +--- +name: 'step-11-polish' +description: 'Optimize and polish the complete PRD document for flow, coherence, and readability' + +# File References +nextStepFile: './step-12-complete.md' +outputFile: '{planning_artifacts}/prd.md' +purposeFile: './data/prd-purpose.md' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 11: Document Polish + +**Progress: Step 11 of 12** - Next: Complete PRD + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 CRITICAL: Load the ENTIRE document before making changes +- 📖 CRITICAL: Read complete step file before taking action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- ✅ This is a POLISH step - optimize existing content +- 📋 IMPROVE flow, coherence, and readability +- 💬 PRESERVE user's voice and intent +- 🎯 MAINTAIN all essential information while improving presentation +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## EXECUTION PROTOCOLS: + +- 🎯 Load complete document first +- 📝 Review for flow and coherence issues +- ✂️ Reduce duplication while preserving essential info +- 📖 Ensure proper ## Level 2 headers throughout +- 💾 Save optimized document +- ⚠️ Present A/P/C menu after polish +- 🚫 DO NOT skip review steps + +## CONTEXT BOUNDARIES: + +- Complete PRD document exists from all previous steps +- Document may have duplication from progressive append +- Sections may not flow smoothly together +- Level 2 headers ensure document can be split if needed +- Focus on readability and coherence + +## YOUR TASK: + +Optimize the complete PRD document for flow, coherence, and professional presentation while preserving all essential information. + +## DOCUMENT POLISH SEQUENCE: + +### 1. Load Context and Document + +**CRITICAL:** Load the PRD purpose document first: + +- Read `{purposeFile}` to understand what makes a great BMAD PRD +- Internalize the philosophy: information density, traceability, measurable requirements +- Keep the dual-audience nature (humans + LLMs) in mind + +**Then Load the PRD Document:** + +- Read `{outputFile}` completely from start to finish +- Understand the full document structure and content +- Identify all sections and their relationships +- Note areas that need attention + +### 2. Document Quality Review + +Review the entire document with PRD purpose principles in mind: + +**Information Density:** +- Are there wordy phrases that can be condensed? +- Is conversational padding present? +- Can sentences be more direct and concise? + +**Flow and Coherence:** +- Do sections transition smoothly? +- Are there jarring topic shifts? +- Does the document tell a cohesive story? +- Is the progression logical for readers? + +**Duplication Detection:** +- Are ideas repeated across sections? +- Is the same information stated multiple times? +- Can redundant content be consolidated? +- Are there contradictory statements? + +**Header Structure:** +- Are all main sections using ## Level 2 headers? +- Is the hierarchy consistent (##, ###, ####)? +- Can sections be easily extracted or referenced? +- Are headers descriptive and clear? + +**Readability:** +- Are sentences clear and concise? +- Is the language consistent throughout? +- Are technical terms used appropriately? +- Would stakeholders find this easy to understand? + +### 3. Optimization Actions + +Make targeted improvements: + +**Improve Flow:** +- Add transition sentences between sections +- Smooth out jarring topic shifts +- Ensure logical progression +- Connect related concepts across sections + +**Reduce Duplication:** +- Consolidate repeated information +- Keep content in the most appropriate section +- Use cross-references instead of repetition +- Remove redundant explanations + +**Enhance Coherence:** +- Ensure consistent terminology throughout +- Align all sections with product differentiator +- Maintain consistent voice and tone +- Verify scope consistency across sections + +**Optimize Headers:** +- Ensure all main sections use ## Level 2 +- Make headers descriptive and action-oriented +- Check that headers follow consistent patterns +- Verify headers support document navigation + +### 4. Preserve Critical Information + +**While optimizing, ensure NOTHING essential is lost:** + +**Must Preserve:** +- All user success criteria +- All functional requirements (capability contract) +- All user journey narratives +- All scope decisions (MVP, Growth, Vision) +- All non-functional requirements +- Product differentiator and vision +- Domain-specific requirements +- Innovation analysis (if present) + +**Can Consolidate:** +- Repeated explanations of the same concept +- Redundant background information +- Multiple versions of similar content +- Overlapping examples + +### 5. Generate Optimized Document + +Create the polished version: + +**Polishing Process:** +1. Start with original document +2. Apply all optimization actions +3. Review to ensure nothing essential was lost +4. Verify improvements enhance readability +5. Prepare optimized version for review + +### 6. Present MENU OPTIONS + +Present the polished document for review, then display menu: +- Show what changed in the polish +- Highlight improvements made (flow, duplication, headers) +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Complete PRD (Step 12 of 12)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the polished document, process the enhanced refinements that come back, ask user "Accept these polish improvements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu +- IF P: Execute {partyModeWorkflow} with the polished document, process the collaborative refinements to flow and coherence, ask user "Accept these polish changes? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu +- IF C: Save the polished document to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: 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 + +## APPEND TO DOCUMENT: + +When user selects 'C', replace the entire document content with the polished version. + +## SUCCESS METRICS: + +✅ Complete document loaded and reviewed +✅ Flow and coherence improved +✅ Duplication reduced while preserving essential information +✅ All main sections use ## Level 2 headers +✅ Transitions between sections are smooth +✅ User's voice and intent preserved +✅ Document is more readable and professional +✅ A/P/C menu presented and handled correctly +✅ Polished document saved when C selected + +## FAILURE MODES: + +❌ Loading only partial document (leads to incomplete polish) +❌ Removing essential information while reducing duplication +❌ Not preserving user's voice and intent +❌ Changing content instead of improving presentation +❌ Not ensuring ## Level 2 headers for main sections +❌ Making arbitrary style changes instead of coherence improvements +❌ Not presenting A/P/C menu for user approval +❌ Saving polished document without user selecting 'C' + +❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions +❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file +❌ **CRITICAL**: Making changes without complete understanding of document requirements + +## NEXT STEP: + +After user selects 'C' and polished document is saved, load `./step-12-complete.md` to complete the workflow. + +Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and polished document is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md new file mode 100644 index 00000000..435c9084 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md @@ -0,0 +1,180 @@ +--- +name: 'step-12-complete' +description: 'Complete the PRD workflow, update status files, and suggest next steps including validation' + +# File References +outputFile: '{planning_artifacts}/prd.md' +validationFlow: '../steps-v/step-v-01-discovery.md' +--- + +# Step 12: Workflow Completion + +**Final Step - Complete the PRD** + +## MANDATORY EXECUTION RULES (READ FIRST): + +- ✅ THIS IS A FINAL STEP - Workflow completion required +- 📖 CRITICAL: ALWAYS read the complete step file before taking any action +- 🛑 NO content generation - this is a wrap-up step +- 📋 FINALIZE document and update workflow status +- 💬 FOCUS on completion, validation options, and next steps +- 🎯 UPDATE workflow status files with completion information +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 💾 Update the main workflow status file with completion information (if exists) +- 📖 Offer validation workflow options to user +- 🚫 DO NOT load additional steps after this one + +## TERMINATION STEP PROTOCOLS: + +- This is a FINAL step - workflow completion required +- Update workflow status file with finalized document +- Suggest validation and next workflow steps +- Mark workflow as complete in status tracking + +## CONTEXT BOUNDARIES: + +- Complete and polished PRD document is available from all previous steps +- Workflow frontmatter shows all completed steps including polish +- All collaborative content has been generated, saved, and optimized +- Focus on completion, validation options, and next steps + +## YOUR TASK: + +Complete the PRD workflow, update status files, offer validation options, and suggest next steps for the project. + +## WORKFLOW COMPLETION SEQUENCE: + +### 1. Announce Workflow Completion + +Inform user that the PRD is complete and polished: +- Celebrate successful completion of comprehensive PRD +- Summarize all sections that were created +- Highlight that document has been polished for flow and coherence +- Emphasize document is ready for downstream work + +### 2. Workflow Status Update + +Update the main workflow status file if there is one: + +- Load `{status_file}` from workflow configuration (if exists) +- Update workflow_status["prd"] = "{default_output_file}" +- Save file, preserving all comments and structure +- Mark current timestamp as completion time + +### 3. Validation Workflow Options + +Offer validation workflows to ensure PRD is ready for implementation: + +**Available Validation Workflows:** + +**Option 1: Check Implementation Readiness** (`{checkImplementationReadinessWorkflow}`) +- Validates PRD has all information needed for development +- Checks epic coverage completeness +- Reviews UX alignment with requirements +- Assesses epic quality and readiness +- Identifies gaps before architecture/design work begins + +**When to use:** Before starting technical architecture or epic breakdown + +**Option 2: Skip for Now** +- Proceed directly to next workflows (architecture, UX, epics) +- Validation can be done later if needed +- Some teams prefer to validate during architecture reviews + +### 4. Suggest Next Workflows + +Provide guidance on logical next workflows - strongly suggesting any of these chosen are started in a fresh context with the appropriate agent: + +**Typical Next Workflows:** + +**Immediate Next Steps:** + +1. **PRD Quality Validation First (Recommended):** + - execute the `{validationFlow}` workflow if selected or start a new chat with me and select the validate PRD menu item + - Ensures PRD is complete and ready + - Identifies any gaps or issues + - Validates before committing to architecture/design + +2. **UX Design:** `workflow create-ux-design` with the UX-Designer Agent (if UI exists) + - User journey insights from step-04 inform interaction design + - Functional requirements from step-09 define design scope + - Polish-optimized document provides clear design requirements + +3. **Technical Architecture:** `workflow create-architecture` with the Architect Agent + - Project-type requirements from step-07 guide technical decisions + - Non-functional requirements from step-10 inform architecture choices + - Functional requirements define system capabilities + +4. **Epic Breakdown:** `workflow create-epics-and-stories` with me again - but really recommend first doing a UX if needed and an architecture! + - Functional requirements from step-09 become epics and stories + - Scope definition from step-03 guides sprint planning + - Richer when created after UX/architecture + +**Strategic Considerations:** + +- Validation adds confidence before architecture/design investment +- UX design and architecture can happen in parallel after validation +- Epics/stories are richer when created after UX/architecture +- Order depends on team preferences and project needs + +### 5. Final Completion Confirmation + +- Confirm completion with user and summarize what has been accomplished +- Document now contains: Executive Summary, Success Criteria, User Journeys, Domain Requirements (if applicable), Innovation Analysis (if applicable), Project-Type Requirements, Functional Requirements (capability contract), Non-Functional Requirements, and has been polished for flow and coherence +- Ask if they'd like to run validation workflow or proceed to next workflows + +## SUCCESS METRICS: + +✅ PRD document contains all required sections and has been polished +✅ All collaborative content properly saved and optimized +✅ Workflow status file updated with completion information (if exists) +✅ Validation workflow options clearly presented +✅ Clear next step guidance provided to user +✅ Document quality validation completed +✅ User acknowledges completion and understands next options + +## FAILURE MODES: + +❌ Not updating workflow status file with completion information (if exists) +❌ Not offering validation workflow options +❌ Missing clear next step guidance for user +❌ Not confirming document completeness with user +❌ Workflow not properly marked as complete in status tracking (if applicable) +❌ User unclear about what happens next or what validation options exist + +❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions +❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols + +## WORKFLOW COMPLETION CHECKLIST: + +### Document Structure Complete: + +- [ ] Executive Summary with vision and differentiator +- [ ] Success Criteria with measurable outcomes +- [ ] Product Scope (MVP, Growth, Vision) +- [ ] User Journeys (comprehensive coverage) +- [ ] Domain Requirements (if applicable) +- [ ] Innovation Analysis (if applicable) +- [ ] Project-Type Requirements +- [ ] Functional Requirements (capability contract) +- [ ] Non-Functional Requirements +- [ ] Document polished for flow and coherence + +### Process Complete: + +- [ ] All steps (including polish) completed with user confirmation +- [ ] All content saved and optimized +- [ ] Frontmatter properly updated +- [ ] Workflow status file updated (if exists) +- [ ] Validation options presented +- [ ] Next steps clearly communicated + +## FINAL REMINDER to give the user: + +The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning. + +**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉 diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md new file mode 100644 index 00000000..4b9e882a --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md @@ -0,0 +1,247 @@ +--- +name: 'step-e-01-discovery' +description: 'Discovery & Understanding - Understand what user wants to edit and detect PRD format' + +# File references (ONLY variables used in this step) +altStepFile: './step-e-01b-legacy-conversion.md' +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step E-1: Discovery & Understanding + +## STEP GOAL: + +Understand what the user wants to edit in the PRD, detect PRD format/type, check for validation report guidance, and route appropriately. + +## 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 Validation Architect and PRD 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 analytical expertise and improvement guidance +- ✅ User brings domain knowledge and edit requirements + +### Step-Specific Rules: + +- 🎯 Focus ONLY on discovering user intent and PRD format +- 🚫 FORBIDDEN to make any edits yet +- 💬 Approach: Inquisitive and analytical, understanding before acting +- 🚪 This is a branch step - may route to legacy conversion + +## EXECUTION PROTOCOLS: + +- 🎯 Discover user's edit requirements +- 🎯 Auto-detect validation reports in PRD folder (use as guide) +- 🎯 Load validation report if provided (use as guide) +- 🎯 Detect PRD format (BMAD/legacy) +- 🎯 Route appropriately based on format +- 💾 Document discoveries for next step +- 🚫 FORBIDDEN to proceed without understanding requirements + +## CONTEXT BOUNDARIES: + +- Available context: PRD file to edit, optional validation report, auto-detected validation reports +- Focus: User intent discovery and format detection only +- Limits: Don't edit yet, don't validate yet +- Dependencies: None - this is first edit step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load PRD Purpose Standards + +Load and read the complete file at: +`{prdPurpose}` (data/prd-purpose.md) + +This file defines what makes a great BMAD PRD. Internalize this understanding - it will guide improvement recommendations. + +### 2. Discover PRD to Edit + +"**PRD Edit Workflow** + +Which PRD would you like to edit? + +Please provide the path to the PRD file you want to edit." + +**Wait for user to provide PRD path.** + +### 3. Validate PRD Exists and Load + +Once PRD path is provided: +- Check if PRD file exists at specified path +- If not found: "I cannot find a PRD at that path. Please check the path and try again." +- If found: Load the complete PRD file including frontmatter + +### 4. Check for Existing Validation Report + +**Check if validation report exists in the PRD folder:** + +```bash +# Look for most recent validation report in the PRD folder +ls -t {prd_folder_path}/validation-report-*.md 2>/dev/null | head -1 +``` + +**If validation report found:** + +Display: +"**📋 Found Validation Report** + +I found a validation report from {validation_date} in the PRD folder. + +This report contains findings from previous validation checks and can help guide our edits to fix known issues. + +**Would you like to:** +- **[U] Use validation report** - Load it to guide and prioritize edits +- **[S] Skip** - Proceed with manual edit discovery" + +**Wait for user input.** + +**IF U (Use validation report):** +- Load the validation report file +- Extract findings, issues, and improvement suggestions +- Note: "Validation report loaded - will use it to guide prioritized improvements" +- Continue to step 5 + +**IF S (Skip) or no validation report found:** +- Note: "Proceeding with manual edit discovery" +- Continue to step 5 + +**If no validation report found:** +- Note: "No validation report found in PRD folder" +- Continue to step 5 without asking user + +### 5. Ask About Validation Report + +"**Do you have a validation report to guide edits?** + +If you've run the validation workflow on this PRD, I can use that report to guide improvements and prioritize changes. + +Validation report path (or type 'none'):" + +**Wait for user input.** + +**If validation report path provided:** +- Load the validation report +- Extract findings, severity, improvement suggestions +- Note: "Validation report loaded - will use it to guide prioritized improvements" + +**If no validation report:** +- Note: "Proceeding with manual edit discovery" +- Continue to step 6 + +### 6. Discover Edit Requirements + +"**What would you like to edit in this PRD?** + +Please describe the changes you want to make. For example: +- Fix specific issues (information density, implementation leakage, etc.) +- Add missing sections or content +- Improve structure and flow +- Convert to BMAD format (if legacy PRD) +- General improvements +- Other changes + +**Describe your edit goals:**" + +**Wait for user to describe their requirements.** + +### 7. Detect PRD Format + +Analyze the loaded PRD: + +**Extract all ## Level 2 headers** from PRD + +**Check for BMAD PRD core sections:** +1. Executive Summary +2. Success Criteria +3. Product Scope +4. User Journeys +5. Functional Requirements +6. Non-Functional Requirements + +**Classify format:** +- **BMAD Standard:** 5-6 core sections present +- **BMAD Variant:** 3-4 core sections present, generally follows BMAD patterns +- **Legacy (Non-Standard):** Fewer than 3 core sections, does not follow BMAD structure + +### 8. Route Based on Format and Context + +**IF validation report provided OR PRD is BMAD Standard/Variant:** + +Display: "**Edit Requirements Understood** + +**PRD Format:** {classification} +{If validation report: "**Validation Guide:** Yes - will use validation report findings"} +**Edit Goals:** {summary of user's requirements} + +**Proceeding to deep review and analysis...**" + +Load and execute next step (step-e-02-review.md) + +**IF PRD is Legacy (Non-Standard) AND no validation report:** + +Display: "**Format Detected:** Legacy PRD + +This PRD does not follow BMAD standard structure (only {count}/6 core sections present). + +**Your edit goals:** {user's requirements} + +**How would you like to proceed?**" + +Present MENU OPTIONS below for user selection + +### 9. Present MENU OPTIONS (Legacy PRDs Only) + +**[C] Convert to BMAD Format** - Convert PRD to BMAD standard structure, then apply your edits +**[E] Edit As-Is** - Apply your edits without converting the format +**[X] Exit** - Exit and review conversion options + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF C (Convert): Load, read entire file, then execute {altStepFile} (step-e-01b-legacy-conversion.md) +- IF E (Edit As-Is): Display "Proceeding with edits..." then load next step +- IF X (Exit): Display summary and exit +- IF Any other: help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- User's edit requirements clearly understood +- Auto-detected validation reports loaded and analyzed (when found) +- Manual validation report loaded and analyzed (if provided) +- PRD format detected correctly +- BMAD PRDs proceed directly to review step +- Legacy PRDs pause and present conversion options +- User can choose conversion path or edit as-is + +### ❌ SYSTEM FAILURE: + +- Not discovering user's edit requirements +- Not auto-detecting validation reports in PRD folder +- Not loading validation report when provided (auto or manual) +- Missing format detection +- Not pausing for legacy PRDs without guidance +- Auto-proceeding without understanding intent + +**Master Rule:** Understand before editing. Detect format early so we can guide users appropriately. Auto-detect and use validation reports for prioritized improvements. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md new file mode 100644 index 00000000..b8c67753 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md @@ -0,0 +1,208 @@ +--- +name: 'step-e-01b-legacy-conversion' +description: 'Legacy PRD Conversion Assessment - Analyze legacy PRD and propose conversion strategy' + +# File references (ONLY variables used in this step) +nextStepFile: './step-e-02-review.md' +prdFile: '{prd_file_path}' +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +--- + +# Step E-1B: Legacy PRD Conversion Assessment + +## STEP GOAL: + +Analyze legacy PRD against BMAD standards, identify gaps, propose conversion strategy, and let user choose how to proceed. + +## 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 Validation Architect and PRD 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 BMAD standards expertise and conversion guidance +- ✅ User brings domain knowledge and edit requirements + +### Step-Specific Rules: + +- 🎯 Focus ONLY on conversion assessment and proposal +- 🚫 FORBIDDEN to perform conversion yet (that comes in edit step) +- 💬 Approach: Analytical gap analysis with clear recommendations +- 🚪 This is a branch step - user chooses conversion path + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze legacy PRD against BMAD standard +- 💾 Identify gaps and estimate conversion effort +- 📖 Present conversion options with effort estimates +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Legacy PRD, user's edit requirements, prd-purpose standards +- Focus: Conversion assessment only (not actual conversion) +- Limits: Don't convert yet, don't validate yet +- Dependencies: Step e-01 detected legacy format and routed here + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Assessment + +**Try to use Task tool with sub-agent:** + +"Perform legacy PRD conversion assessment: + +**Load the PRD and prd-purpose.md** + +**For each BMAD PRD section, analyze:** +1. Does PRD have this section? (Executive Summary, Success Criteria, Product Scope, User Journeys, Functional Requirements, Non-Functional Requirements) +2. If present: Is it complete and well-structured? +3. If missing: What content exists that could migrate to this section? +4. Effort to create/complete: Minimal / Moderate / Significant + +**Identify:** +- Core sections present: {count}/6 +- Content gaps in each section +- Overall conversion effort: Quick / Moderate / Substantial +- Recommended approach: Full restructuring vs targeted improvements + +Return conversion assessment with gap analysis and effort estimate." + +**Graceful degradation (if no Task tool):** +- Manually check PRD for each BMAD section +- Note what's present and what's missing +- Estimate conversion effort +- Identify best conversion approach + +### 2. Build Gap Analysis + +**For each BMAD core section:** + +**Executive Summary:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Success Criteria:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Product Scope:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**User Journeys:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Functional Requirements:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Non-Functional Requirements:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Overall Assessment:** +- Sections Present: {count}/6 +- Total Conversion Effort: [Quick/Moderate/Substantial] +- Recommended: [Full restructuring / Targeted improvements] + +### 3. Present Conversion Assessment + +Display: + +"**Legacy PRD Conversion Assessment** + +**Current PRD Structure:** +- Core sections present: {count}/6 +{List which sections are present/missing} + +**Gap Analysis:** + +{Present gap analysis table showing each section's status and effort} + +**Overall Conversion Effort:** {effort level} + +**Your Edit Goals:** +{Reiterate user's stated edit requirements} + +**Recommendation:** +{Based on effort and user goals, recommend best approach} + +**How would you like to proceed?**" + +### 4. Present MENU OPTIONS + +**[R] Restructure to BMAD** - Full conversion to BMAD format, then apply your edits +**[I] Targeted Improvements** - Apply your edits to existing structure without restructuring +**[E] Edit & Restructure** - Do both: convert format AND apply your edits +**[X] Exit** - Review assessment and decide + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF R (Restructure): Note conversion mode, then load next step +- IF I (Targeted): Note targeted mode, then load next step +- IF E (Edit & Restructure): Note both mode, then load next step +- IF X (Exit): Display summary, exit + +### 5. Document Conversion Strategy + +Store conversion decision for next step: + +- **Conversion mode:** [Full restructuring / Targeted improvements / Both] +- **Edit requirements:** [user's requirements from step e-01] +- **Gap analysis:** [summary of gaps identified] + +Display: "**Conversion Strategy Documented** + +Mode: {conversion mode} +Edit goals: {summary} + +**Proceeding to deep review...**" + +Load and execute {nextStepFile} (step-e-02-review.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All 6 BMAD core sections analyzed for gaps +- Effort estimates provided for each section +- Overall conversion effort assessed correctly +- Clear recommendation provided based on effort and user goals +- User chooses conversion strategy (restructure/targeted/both) +- Conversion strategy documented for next step + +### ❌ SYSTEM FAILURE: + +- Not analyzing all 6 core sections +- Missing effort estimates +- Not providing clear recommendation +- Auto-proceeding without user selection +- Not documenting conversion strategy + +**Master Rule:** Legacy PRDs need conversion assessment so users understand the work involved and can choose the best approach. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md new file mode 100644 index 00000000..31c80971 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md @@ -0,0 +1,249 @@ +--- +name: 'step-e-02-review' +description: 'Deep Review & Analysis - Thoroughly review existing PRD and prepare detailed change plan' + +# File references (ONLY variables used in this step) +nextStepFile: './step-e-03-edit.md' +prdFile: '{prd_file_path}' +validationReport: '{validation_report_path}' # If provided +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + +# Step E-2: Deep Review & Analysis + +## STEP GOAL: + +Thoroughly review the existing PRD, analyze validation report findings (if provided), and prepare a detailed change plan before editing. + +## 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 Validation Architect and PRD 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 analytical expertise and improvement planning +- ✅ User brings domain knowledge and approval authority + +### Step-Specific Rules: + +- 🎯 Focus ONLY on review and analysis, not editing yet +- 🚫 FORBIDDEN to make changes to PRD in this step +- 💬 Approach: Thorough analysis with user confirmation on plan +- 🚪 This is a middle step - user confirms plan before proceeding + +## EXECUTION PROTOCOLS: + +- 🎯 Load and analyze validation report (if provided) +- 🎯 Deep review of entire PRD +- 🎯 Map validation findings to specific sections +- 🎯 Prepare detailed change plan +- 💬 Get user confirmation on plan +- 🚫 FORBIDDEN to proceed to edit without user approval + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report (if provided), user requirements from step e-01 +- Focus: Analysis and planning only (no editing) +- Limits: Don't change PRD yet, don't validate yet +- Dependencies: Step e-01 completed - requirements and format known + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Deep Review + +**Try to use Task tool with sub-agent:** + +"Perform deep PRD review and change planning: + +**Context from step e-01:** +- User's edit requirements: {user_requirements} +- PRD format: {BMAD/legacy} +- Validation report provided: {yes/no} +- Conversion mode: {restructure/targeted/both} (if legacy) + +**IF validation report provided:** +1. Extract all findings from validation report +2. Map findings to specific PRD sections +3. Prioritize by severity: Critical > Warning > Informational +4. For each critical issue: identify specific fix needed +5. For user's manual edit goals: identify where in PRD to apply + +**IF no validation report:** +1. Read entire PRD thoroughly +2. Analyze against BMAD standards (from prd-purpose.md) +3. Identify issues in: + - Information density (anti-patterns) + - Structure and flow + - Completeness (missing sections/content) + - Measurability (unmeasurable requirements) + - Traceability (broken chains) + - Implementation leakage +4. Map user's edit goals to specific sections + +**Output:** +- Section-by-section analysis +- Specific changes needed for each section +- Prioritized action list +- Recommended order for applying changes + +Return detailed change plan with section breakdown." + +**Graceful degradation (if no Task tool):** +- Manually read PRD sections +- Manually analyze validation report findings (if provided) +- Build section-by-section change plan +- Prioritize changes by severity/user goals + +### 2. Build Change Plan + +**Organize by PRD section:** + +**For each section (in order):** +- **Current State:** Brief description of what exists +- **Issues Identified:** [List from validation report or manual analysis] +- **Changes Needed:** [Specific changes required] +- **Priority:** [Critical/High/Medium/Low] +- **User Requirements Met:** [Which user edit goals address this section] + +**Include:** +- Sections to add (if missing) +- Sections to update (if present but needs work) +- Content to remove (if incorrect/leakage) +- Structure changes (if reformatting needed) + +### 3. Prepare Change Plan Summary + +**Summary sections:** + +**Changes by Type:** +- **Additions:** {count} sections to add +- **Updates:** {count} sections to update +- **Removals:** {count} items to remove +- **Restructuring:** {yes/no} if format conversion needed + +**Priority Distribution:** +- **Critical:** {count} changes (must fix) +- **High:** {count} changes (important) +- **Medium:** {count} changes (nice to have) +- **Low:** {count} changes (optional) + +**Estimated Effort:** +[Quick/Moderate/Substantial] based on scope and complexity + +### 4. Present Change Plan to User + +Display: + +"**Deep Review Complete - Change Plan** + +**PRD Analysis:** +{Brief summary of PRD current state} + +{If validation report provided:} +**Validation Findings:** +{count} issues identified: {critical} critical, {warning} warnings + +**Your Edit Requirements:** +{summary of what user wants to edit} + +**Proposed Change Plan:** + +**By Section:** +{Present section-by-section breakdown} + +**By Priority:** +- Critical: {count} items +- High: {count} items +- Medium: {count} items + +**Estimated Effort:** {effort level} + +**Questions:** +1. Does this change plan align with what you had in mind? +2. Any sections I should add/remove/reprioritize? +3. Any concerns before I proceed with edits? + +**Review the plan and let me know if you'd like any adjustments.**" + +### 5. Get User Confirmation + +Wait for user to review and provide feedback. + +**If user wants adjustments:** +- Discuss requested changes +- Revise change plan accordingly +- Represent for confirmation + +**If user approves:** +- Note: "Change plan approved. Proceeding to edit step." +- Continue to step 6 + +### 6. Document Approved Plan + +Store approved change plan for next step: + +- **Approved changes:** Section-by-section list +- **Priority order:** Sequence to apply changes +- **User confirmed:** Yes + +Display: "**Change Plan Approved** + +{Brief summary of approved plan} + +**Proceeding to edit step...**" + +Load and execute {nextStepFile} (step-e-03-edit.md) + +### 7. Present MENU OPTIONS (If User Wants Discussion) + +**[A] Advanced Elicitation** - Get additional perspectives on change plan +**[P] Party Mode** - Discuss with team for more ideas +**[C] Continue to Edit** - Proceed with approved plan + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed to edit when user selects 'C' + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, then return to discussion +- IF P: Execute {partyModeWorkflow}, then return to discussion +- IF C: Document approval, then load {nextStepFile} +- IF Any other: discuss, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report findings fully analyzed (if provided) +- Deep PRD review completed systematically +- Change plan built section-by-section +- Changes prioritized by severity/user goals +- User presented with clear plan +- User confirms or adjusts plan +- Approved plan documented for next step + +### ❌ SYSTEM FAILURE: + +- Not analyzing validation report findings (if provided) +- Superficial review instead of deep analysis +- Missing section-by-section breakdown +- Not prioritizing changes +- Proceeding without user approval + +**Master Rule:** Plan before editing. Thorough analysis ensures we make the right changes in the right order. User approval prevents misalignment. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md new file mode 100644 index 00000000..7c26891b --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md @@ -0,0 +1,253 @@ +--- +name: 'step-e-03-edit' +description: 'Edit & Update - Apply changes to PRD following approved change plan' + +# File references (ONLY variables used in this step) +nextStepFile: './step-e-04-complete.md' +prdFile: '{prd_file_path}' +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +--- + +# Step E-3: Edit & Update + +## STEP GOAL: + +Apply changes to the PRD following the approved change plan from step e-02, including content updates, structure improvements, and format conversion if needed. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 ALWAYS generate content WITH user input/approval +- 📖 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 Validation Architect and PRD 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 analytical expertise and precise editing skills +- ✅ User brings domain knowledge and approval authority + +### Step-Specific Rules: + +- 🎯 Focus ONLY on implementing approved changes from step e-02 +- 🚫 FORBIDDEN to make changes beyond the approved plan +- 💬 Approach: Methodical, section-by-section execution +- 🚪 This is a middle step - user can request adjustments + +## EXECUTION PROTOCOLS: + +- 🎯 Follow approved change plan systematically +- 💾 Edit PRD content according to plan +- 📖 Update frontmatter as needed +- 🚫 FORBIDDEN to proceed without completion + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, approved change plan from step e-02, prd-purpose standards +- Focus: Implementing changes from approved plan only +- Limits: Don't add changes beyond plan, don't validate yet +- Dependencies: Step e-02 completed - plan approved by user + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Retrieve Approved Change Plan + +From step e-02, retrieve: +- **Approved changes:** Section-by-section list +- **Priority order:** Sequence to apply changes +- **User requirements:** Edit goals from step e-01 + +Display: "**Starting PRD Edits** + +**Change Plan:** {summary} +**Total Changes:** {count} +**Estimated Effort:** {effort level} + +**Proceeding with edits section by section...**" + +### 2. Attempt Sub-Process Edits (For Complex Changes) + +**Try to use Task tool with sub-agent for major sections:** + +"Execute PRD edits for {section_name}: + +**Context:** +- Section to edit: {section_name} +- Current content: {existing content} +- Changes needed: {specific changes from plan} +- BMAD PRD standards: Load from prd-purpose.md + +**Tasks:** +1. Read current PRD section +2. Apply specified changes +3. Ensure BMAD PRD principles compliance: + - High information density (no filler) + - Measurable requirements + - Clear structure + - Proper markdown formatting +4. Return updated section content + +Apply changes and return updated section." + +**Graceful degradation (if no Task tool):** +- Perform edits directly in current context +- Load PRD section, apply changes, save + +### 3. Execute Changes Section-by-Section + +**For each section in approved plan (in priority order):** + +**a) Load current section** +- Read the current PRD section content +- Note what exists + +**b) Apply changes per plan** +- Additions: Create new sections with proper content +- Updates: Modify existing content per plan +- Removals: Remove specified content +- Restructuring: Reformat content to BMAD standard + +**c) Update PRD file** +- Apply changes to PRD +- Save updated PRD +- Verify changes applied correctly + +**Display progress after each section:** +"**Section Updated:** {section_name} +Changes: {brief summary} +{More sections remaining...}" + +### 4. Handle Restructuring (If Needed) + +**If conversion mode is "Full restructuring" or "Both":** + +**For restructuring:** +- Reorganize PRD to BMAD standard structure +- Ensure proper ## Level 2 headers +- Reorder sections logically +- Update PRD frontmatter to match BMAD format + +**Follow BMAD PRD structure:** +1. Executive Summary +2. Success Criteria +3. Product Scope +4. User Journeys +5. Domain Requirements (if applicable) +6. Innovation Analysis (if applicable) +7. Project-Type Requirements +8. Functional Requirements +9. Non-Functional Requirements + +Display: "**PRD Restructured** +BMAD standard structure applied. +{Sections added/reordered}" + +### 5. Update PRD Frontmatter + +**Ensure frontmatter is complete and accurate:** + +```yaml +--- +workflowType: 'prd' +workflow: 'create' # or 'validate' or 'edit' +classification: + domain: '{domain}' + projectType: '{project_type}' + complexity: '{complexity}' +inputDocuments: [list of input documents] +stepsCompleted: ['step-e-01-discovery', 'step-e-02-review', 'step-e-03-edit'] +lastEdited: '{current_date}' +editHistory: + - date: '{current_date}' + changes: '{summary of changes}' +--- +``` + +**Update frontmatter accordingly.** + +### 6. Final Review of Changes + +**Load complete updated PRD** + +**Verify:** +- All approved changes applied correctly +- PRD structure is sound +- No unintended modifications +- Frontmatter is accurate + +**If issues found:** +- Fix them now +- Note corrections made + +**If user wants adjustments:** +- Accept feedback and make adjustments +- Re-verify after adjustments + +### 7. Confirm Completion + +Display: + +"**PRD Edits Complete** + +**Changes Applied:** {count} sections modified +**PRD Updated:** {prd_file_path} + +**Summary of Changes:** +{Brief bullet list of major changes} + +**PRD is ready for:** +- Use in downstream workflows (UX, Architecture) +- Validation (if not yet validated) + +**What would you like to do next?**" + +### 8. Present MENU OPTIONS + +**[V] Run Validation** - Execute full validation workflow (steps-v/step-v-01-discovery.md) +**[S] Summary Only** - End with summary of changes (no validation) +**[A] Adjust** - Make additional edits +**[X] Exit** - Exit edit workflow + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF V (Validate): Display "Starting validation workflow..." then load and execute steps-v/step-v-01-discovery.md +- IF S (Summary): Present edit summary and exit +- IF A (Adjust): Accept additional requirements, loop back to editing +- IF X (Exit): Display summary and exit + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All approved changes from step e-02 applied correctly +- Changes executed in planned priority order +- Restructuring completed (if needed) +- Frontmatter updated accurately +- Final verification confirms changes +- User can proceed to validation or exit with summary +- Option to run validation seamlessly integrates edit and validate modes + +### ❌ SYSTEM FAILURE: + +- Making changes beyond approved plan +- Not following priority order +- Missing restructuring (if conversion mode) +- Not updating frontmatter +- No final verification +- Not saving updated PRD + +**Master Rule:** Execute the plan exactly as approved. PRD is now ready for validation or downstream use. Validation integration ensures quality. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md new file mode 100644 index 00000000..780f2694 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md @@ -0,0 +1,168 @@ +--- +name: 'step-e-04-complete' +description: 'Complete & Validate - Present options for next steps including full validation' + +# File references (ONLY variables used in this step) +prdFile: '{prd_file_path}' +validationWorkflow: './steps-v/step-v-01-discovery.md' +--- + +# Step E-4: Complete & Validate + +## STEP GOAL: + +Present summary of completed edits and offer next steps including seamless integration with validation workflow. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 ALWAYS generate content WITH user input/approval +- 📖 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 Validation Architect and PRD 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 synthesis and summary expertise +- ✅ User chooses next actions + +### Step-Specific Rules: + +- 🎯 Focus ONLY on presenting summary and options +- 🚫 FORBIDDEN to make additional changes +- 💬 Approach: Clear, concise summary with actionable options +- 🚪 This is the final edit step - no more edits + +## EXECUTION PROTOCOLS: + +- 🎯 Compile summary of all changes made +- 🎯 Present options clearly with expected outcomes +- 📖 Route to validation if user chooses +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Updated PRD file, edit history from step e-03 +- Focus: Summary and options only (no more editing) +- Limits: Don't make changes, just present options +- Dependencies: Step e-03 completed - all edits applied + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Compile Edit Summary + +From step e-03 change execution, compile: + +**Changes Made:** +- Sections added: {list with names} +- Sections updated: {list with names} +- Content removed: {list} +- Structure changes: {description} + +**Edit Details:** +- Total sections affected: {count} +- Mode: {restructure/targeted/both} +- Priority addressed: {Critical/High/Medium/Low} + +**PRD Status:** +- Format: {BMAD Standard / BMAD Variant / Legacy (converted)} +- Completeness: {assessment} +- Ready for: {downstream use cases} + +### 2. Present Completion Summary + +Display: + +"**✓ PRD Edit Complete** + +**Updated PRD:** {prd_file_path} + +**Changes Summary:** +{Present bulleted list of major changes} + +**Edit Mode:** {mode} +**Sections Modified:** {count} + +**PRD Format:** {format} + +**PRD is now ready for:** +- Downstream workflows (UX Design, Architecture) +- Validation to ensure quality +- Production use + +**What would you like to do next?**" + +### 3. Present MENU OPTIONS + +Display: + +**[V] Run Full Validation** - Execute complete validation workflow (steps-v) to verify PRD quality +**[E] Edit More** - Make additional edits to the PRD +**[S] Summary** - End with detailed summary of changes +**[X] Exit** - Exit edit workflow + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- **IF V (Run Full Validation):** + - Display: "**Starting Validation Workflow**" + - Display: "This will run all 13 validation checks on the updated PRD." + - Display: "Preparing to validate: {prd_file_path}" + - Display: "**Proceeding to validation...**" + - Load, read entire file, then execute {validationWorkflow} (steps-v/step-v-01-discovery.md) + - Note: This hands off to the validation workflow which will run its complete 13-step process + +- **IF E (Edit More):** + - Display: "**Additional Edits**" + - Ask: "What additional edits would you like to make?" + - Accept input, then display: "**Returning to edit step...**" + - Load and execute step-e-03-edit.md again + +- **IF S (Summary):** + - Display detailed summary including: + - Complete list of all changes made + - Before/after comparison (key improvements) + - Recommendations for next steps + - Display: "**Edit Workflow Complete**" + - Exit + +- **IF X (Exit):** + - Display summary + - Display: "**Edit Workflow Complete**" + - Exit + +- **IF Any other:** Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete edit summary compiled accurately +- All changes clearly documented +- Options presented with clear expectations +- Validation option seamlessly integrates with steps-v workflow +- User can validate, edit more, or exit +- Clean handoff to validation workflow (if chosen) +- Edit workflow completes properly + +### ❌ SYSTEM FAILURE: + +- Missing changes in summary +- Not offering validation option +- Not documenting completion properly +- No clear handoff to validation workflow + +**Master Rule:** Edit workflow seamlessly integrates with validation. User can edit → validate → edit again → validate again in iterative improvement cycle. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md new file mode 100644 index 00000000..0d198495 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md @@ -0,0 +1,218 @@ +--- +name: 'step-v-01-discovery' +description: 'Document Discovery & Confirmation - Handle fresh context validation, confirm PRD path, discover input documents' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-02-format-detection.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +prdPurpose: '../data/prd-purpose.md' +--- + +# Step 1: Document Discovery & Confirmation + +## STEP GOAL: + +Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report. + +## 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 Validation 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 systematic validation expertise and analytical rigor +- ✅ User brings domain knowledge and specific PRD context + +### Step-Specific Rules: + +- 🎯 Focus ONLY on discovering PRD and input documents, not validating yet +- 🚫 FORBIDDEN to perform any validation checks in this step +- 💬 Approach: Systematic discovery with clear reporting to user +- 🚪 This is the setup step - get everything ready for validation + +## EXECUTION PROTOCOLS: + +- 🎯 Discover and confirm PRD to validate +- 💾 Load PRD and all input documents from frontmatter +- 📖 Initialize validation report next to PRD +- 🚫 FORBIDDEN to load next step until user confirms setup + +## CONTEXT BOUNDARIES: + +- Available context: PRD path (user-specified or discovered), workflow configuration +- Focus: Document discovery and setup only +- Limits: Don't perform validation, don't skip discovery +- Dependencies: Configuration loaded from PRD workflow.md initialization + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load PRD Purpose and Standards + +Load and read the complete file at: +`{prdPurpose}` + +This file contains the BMAD PRD philosophy, standards, and validation criteria that will guide all validation checks. Internalize this understanding - it defines what makes a great BMAD PRD. + +### 2. Discover PRD to Validate + +**If PRD path provided as invocation parameter:** +- Use provided path + +**If no PRD path provided:** +"**PRD Validation Workflow** + +Which PRD would you like to validate? + +Please provide the path to the PRD file you want to validate." + +**Wait for user to provide PRD path.** + +### 3. Validate PRD Exists and Load + +Once PRD path is provided: + +- Check if PRD file exists at specified path +- If not found: "I cannot find a PRD at that path. Please check the path and try again." +- If found: Load the complete PRD file including frontmatter + +### 4. Extract Frontmatter and Input Documents + +From the loaded PRD frontmatter, extract: + +- `inputDocuments: []` array (if present) +- Any other relevant metadata (classification, date, etc.) + +**If no inputDocuments array exists:** +Note this and proceed with PRD-only validation + +### 5. Load Input Documents + +For each document listed in `inputDocuments`: + +- Attempt to load the document +- Track successfully loaded documents +- Note any documents that fail to load + +**Build list of loaded input documents:** +- Product Brief (if present) +- Research documents (if present) +- Other reference materials (if present) + +### 6. Ask About Additional Reference Documents + +"**I've loaded the following documents from your PRD frontmatter:** + +{list loaded documents with file names} + +**Are there any additional reference documents you'd like me to include in this validation?** + +These could include: +- Additional research or context documents +- Project documentation not tracked in frontmatter +- Standards or compliance documents +- Competitive analysis or benchmarks + +Please provide paths to any additional documents, or type 'none' to proceed." + +**Load any additional documents provided by user.** + +### 7. Initialize Validation Report + +Create validation report at: `{validationReportPath}` + +**Initialize with frontmatter:** +```yaml +--- +validationTarget: '{prd_path}' +validationDate: '{current_date}' +inputDocuments: [list of all loaded documents] +validationStepsCompleted: [] +validationStatus: IN_PROGRESS +--- +``` + +**Initial content:** +```markdown +# PRD Validation Report + +**PRD Being Validated:** {prd_path} +**Validation Date:** {current_date} + +## Input Documents + +{list all documents loaded for validation} + +## Validation Findings + +[Findings will be appended as validation progresses] +``` + +### 8. Present Discovery Summary + +"**Setup Complete!** + +**PRD to Validate:** {prd_path} + +**Input Documents Loaded:** +- PRD: {prd_name} ✓ +- Product Brief: {count} {if count > 0}✓{else}(none found){/if} +- Research: {count} {if count > 0}✓{else}(none found){/if} +- Additional References: {count} {if count > 0}✓{else}(none){/if} + +**Validation Report:** {validationReportPath} + +**Ready to begin validation.**" + +### 9. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Format Detection + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- User can ask questions or add more documents - always respond and 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: Load, read entire file, then execute {nextStepFile} to begin format detection +- IF user provides additional document: Load it, update report, redisplay summary +- IF Any other: help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- PRD path discovered and confirmed +- PRD file exists and loads successfully +- All input documents from frontmatter loaded +- Additional reference documents (if any) loaded +- Validation report initialized next to PRD +- User clearly informed of setup status +- Menu presented and user input handled correctly + +### ❌ SYSTEM FAILURE: + +- Proceeding with non-existent PRD file +- Not loading input documents from frontmatter +- Creating validation report in wrong location +- Proceeding without user confirming setup +- Not handling missing input documents gracefully + +**Master Rule:** Complete discovery and setup BEFORE validation. This step ensures everything is in place for systematic validation checks. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md new file mode 100644 index 00000000..97566603 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md @@ -0,0 +1,191 @@ +--- +name: 'step-v-02-format-detection' +description: 'Format Detection & Structure Analysis - Classify PRD format and route appropriately' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-03-density-validation.md' +altStepFile: './step-v-02b-parity-check.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 2: Format Detection & Structure Analysis + +## STEP GOAL: + +Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard / BMAD Variant / Non-Standard, with optional parity check for non-standard formats. + +## 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 Validation 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 systematic validation expertise and pattern recognition +- ✅ User brings domain knowledge and PRD context + +### Step-Specific Rules: + +- 🎯 Focus ONLY on detecting format and classifying structure +- 🚫 FORBIDDEN to perform other validation checks in this step +- 💬 Approach: Analytical and systematic, clear reporting of findings +- 🚪 This is a branch step - may route to parity check for non-standard PRDs + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze PRD structure systematically +- 💾 Append format findings to validation report +- 📖 Route appropriately based on format classification +- 🚫 FORBIDDEN to skip format detection or proceed without classification + +## CONTEXT BOUNDARIES: + +- Available context: PRD file loaded in step 1, validation report initialized +- Focus: Format detection and classification only +- Limits: Don't perform other validation, don't skip classification +- Dependencies: Step 1 completed - PRD loaded and report initialized + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Extract PRD Structure + +Load the complete PRD file and extract: + +**All Level 2 (##) headers:** +- Scan through entire PRD document +- Extract all ## section headers +- List them in order + +**PRD frontmatter:** +- Extract classification.domain if present +- Extract classification.projectType if present +- Note any other relevant metadata + +### 2. Check for BMAD PRD Core Sections + +Check if the PRD contains the following BMAD PRD core sections: + +1. **Executive Summary** (or variations: ## Executive Summary, ## Overview, ## Introduction) +2. **Success Criteria** (or: ## Success Criteria, ## Goals, ## Objectives) +3. **Product Scope** (or: ## Product Scope, ## Scope, ## In Scope, ## Out of Scope) +4. **User Journeys** (or: ## User Journeys, ## User Stories, ## User Flows) +5. **Functional Requirements** (or: ## Functional Requirements, ## Features, ## Capabilities) +6. **Non-Functional Requirements** (or: ## Non-Functional Requirements, ## NFRs, ## Quality Attributes) + +**Count matches:** +- How many of these 6 core sections are present? +- Which specific sections are present? +- Which are missing? + +### 3. Classify PRD Format + +Based on core section count, classify: + +**BMAD Standard:** +- 5-6 core sections present +- Follows BMAD PRD structure closely + +**BMAD Variant:** +- 3-4 core sections present +- Generally follows BMAD patterns but may have structural differences +- Missing some sections but recognizable as BMAD-style + +**Non-Standard:** +- Fewer than 3 core sections present +- Does not follow BMAD PRD structure +- May be completely custom format, legacy format, or from another framework + +### 4. Report Format Findings to Validation Report + +Append to validation report: + +```markdown +## Format Detection + +**PRD Structure:** +[List all ## Level 2 headers found] + +**BMAD Core Sections Present:** +- Executive Summary: [Present/Missing] +- Success Criteria: [Present/Missing] +- Product Scope: [Present/Missing] +- User Journeys: [Present/Missing] +- Functional Requirements: [Present/Missing] +- Non-Functional Requirements: [Present/Missing] + +**Format Classification:** [BMAD Standard / BMAD Variant / Non-Standard] +**Core Sections Present:** [count]/6 +``` + +### 5. Route Based on Format Classification + +**IF format is BMAD Standard or BMAD Variant:** + +Display: "**Format Detected:** {classification} + +Proceeding to systematic validation checks..." + +Immediately load and execute {nextStepFile} (step-v-03-density-validation.md) + +**IF format is Non-Standard (< 3 core sections):** + +Display: "**Format Detected:** Non-Standard PRD + +This PRD does not follow BMAD standard structure (only {count}/6 core sections present). + +You have options:" + +Present MENU OPTIONS below for user selection + +### 6. Present MENU OPTIONS (Non-Standard PRDs Only) + +**[A] Parity Check** - Analyze gaps and estimate effort to reach BMAD PRD parity +**[B] Validate As-Is** - Proceed with validation using current structure +**[C] Exit** - Exit validation and review format findings + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF A (Parity Check): Load, read entire file, then execute {altStepFile} (step-v-02b-parity-check.md) +- IF B (Validate As-Is): Display "Proceeding with validation..." then load, read entire file, then execute {nextStepFile} +- IF C (Exit): Display format findings summary and exit validation +- IF Any other: help user respond, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All ## Level 2 headers extracted successfully +- BMAD core sections checked systematically +- Format classified correctly based on section count +- Findings reported to validation report +- BMAD Standard/Variant PRDs proceed directly to next validation step +- Non-Standard PRDs pause and present options to user +- User can choose parity check, validate as-is, or exit + +### ❌ SYSTEM FAILURE: + +- Not extracting all headers before classification +- Incorrect format classification +- Not reporting findings to validation report +- Not pausing for non-standard PRDs +- Proceeding without user decision for non-standard formats + +**Master Rule:** Format detection determines validation path. Non-standard PRDs require user choice before proceeding. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md new file mode 100644 index 00000000..3c1cc273 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md @@ -0,0 +1,209 @@ +--- +name: 'step-v-02b-parity-check' +description: 'Document Parity Check - Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-03-density-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 2B: Document Parity Check + +## STEP GOAL: + +Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity, presenting user with options for how to proceed. + +## 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 Validation 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 BMAD PRD standards expertise and gap analysis +- ✅ User brings domain knowledge and PRD context + +### Step-Specific Rules: + +- 🎯 Focus ONLY on analyzing gaps and estimating parity effort +- 🚫 FORBIDDEN to perform other validation checks in this step +- 💬 Approach: Systematic gap analysis with clear recommendations +- 🚪 This is an optional branch step - user chooses next action + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze each BMAD PRD section for gaps +- 💾 Append parity analysis to validation report +- 📖 Present options and await user decision +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Non-standard PRD from step 2, validation report in progress +- Focus: Parity analysis only - what's missing, what's needed +- Limits: Don't perform validation checks, don't auto-proceed +- Dependencies: Step 2 classified PRD as non-standard and user chose parity check + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Analyze Each BMAD PRD Section + +For each of the 6 BMAD PRD core sections, analyze: + +**Executive Summary:** +- Does PRD have vision/overview? +- Is problem statement clear? +- Are target users identified? +- Gap: [What's missing or incomplete] + +**Success Criteria:** +- Are measurable goals defined? +- Is success clearly defined? +- Gap: [What's missing or incomplete] + +**Product Scope:** +- Is scope clearly defined? +- Are in-scope items listed? +- Are out-of-scope items listed? +- Gap: [What's missing or incomplete] + +**User Journeys:** +- Are user types/personas identified? +- Are user flows documented? +- Gap: [What's missing or incomplete] + +**Functional Requirements:** +- Are features/capabilities listed? +- Are requirements structured? +- Gap: [What's missing or incomplete] + +**Non-Functional Requirements:** +- Are quality attributes defined? +- Are performance/security/etc. requirements documented? +- Gap: [What's missing or incomplete] + +### 2. Estimate Effort to Reach Parity + +For each missing or incomplete section, estimate: + +**Effort Level:** +- Minimal - Section exists but needs minor enhancements +- Moderate - Section missing but content exists elsewhere in PRD +- Significant - Section missing, requires new content creation + +**Total Parity Effort:** +- Based on individual section estimates +- Classify overall: Quick / Moderate / Substantial effort + +### 3. Report Parity Analysis to Validation Report + +Append to validation report: + +```markdown +## Parity Analysis (Non-Standard PRD) + +### Section-by-Section Gap Analysis + +**Executive Summary:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Success Criteria:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Product Scope:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**User Journeys:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Functional Requirements:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Non-Functional Requirements:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +### Overall Parity Assessment + +**Overall Effort to Reach BMAD Standard:** [Quick/Moderate/Substantial] +**Recommendation:** [Brief recommendation based on analysis] +``` + +### 4. Present Parity Analysis and Options + +Display: + +"**Parity Analysis Complete** + +Your PRD is missing {count} of 6 core BMAD PRD sections. The overall effort to reach BMAD standard is: **{effort level}** + +**Quick Summary:** +[2-3 sentence summary of key gaps] + +**Recommendation:** +{recommendation from analysis} + +**How would you like to proceed?**" + +### 5. Present MENU OPTIONS + +**[C] Continue Validation** - Proceed with validation using current structure +**[E] Exit & Review** - Exit validation and review parity report +**[S] Save & Exit** - Save parity report and exit + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF C (Continue): Display "Proceeding with validation..." then load, read entire file, then execute {nextStepFile} +- IF E (Exit): Display parity summary and exit validation +- IF S (Save): Confirm saved, display summary, exit +- IF Any other: help user respond, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All 6 BMAD PRD sections analyzed for gaps +- Effort estimates provided for each gap +- Overall parity effort assessed correctly +- Parity analysis reported to validation report +- Clear summary presented to user +- User can choose to continue validation, exit, or save report + +### ❌ SYSTEM FAILURE: + +- Not analyzing all 6 sections systematically +- Missing effort estimates +- Not reporting parity analysis to validation report +- Auto-proceeding without user decision +- Unclear recommendations + +**Master Rule:** Parity check informs user of gaps and effort, but user decides whether to proceed with validation or address gaps first. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md new file mode 100644 index 00000000..b7d4f330 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md @@ -0,0 +1,174 @@ +--- +name: 'step-v-03-density-validation' +description: 'Information Density Check - Scan for anti-patterns that violate information density principles' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-04-brief-coverage-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 3: Information Density Validation + +## STEP GOAL: + +Validate PRD meets BMAD information density standards by scanning for conversational filler, wordy phrases, and redundant expressions that violate conciseness principles. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and attention to detail +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on information density anti-patterns +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic scanning and categorization +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Scan PRD for density anti-patterns systematically +- 💾 Append density findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report with format findings +- Focus: Information density validation only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Step 2 completed - format classification done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform information density validation on this PRD: + +1. Load the PRD file +2. Scan for the following anti-patterns: + - Conversational filler phrases (examples: 'The system will allow users to...', 'It is important to note that...', 'In order to') + - Wordy phrases (examples: 'Due to the fact that', 'In the event of', 'For the purpose of') + - Redundant phrases (examples: 'Future plans', 'Absolutely essential', 'Past history') +3. Count violations by category with line numbers +4. Classify severity: Critical (>10 violations), Warning (5-10), Pass (<5) + +Return structured findings with counts and examples." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Scan for conversational filler patterns:** +- "The system will allow users to..." +- "It is important to note that..." +- "In order to" +- "For the purpose of" +- "With regard to" +- Count occurrences and note line numbers + +**Scan for wordy phrases:** +- "Due to the fact that" (use "because") +- "In the event of" (use "if") +- "At this point in time" (use "now") +- "In a manner that" (use "how") +- Count occurrences and note line numbers + +**Scan for redundant phrases:** +- "Future plans" (just "plans") +- "Past history" (just "history") +- "Absolutely essential" (just "essential") +- "Completely finish" (just "finish") +- Count occurrences and note line numbers + +### 3. Classify Severity + +**Calculate total violations:** +- Conversational filler count +- Wordy phrases count +- Redundant phrases count +- Total = sum of all categories + +**Determine severity:** +- **Critical:** Total > 10 violations +- **Warning:** Total 5-10 violations +- **Pass:** Total < 5 violations + +### 4. Report Density Findings to Validation Report + +Append to validation report: + +```markdown +## Information Density Validation + +**Anti-Pattern Violations:** + +**Conversational Filler:** {count} occurrences +[If count > 0, list examples with line numbers] + +**Wordy Phrases:** {count} occurrences +[If count > 0, list examples with line numbers] + +**Redundant Phrases:** {count} occurrences +[If count > 0, list examples with line numbers] + +**Total Violations:** {total} + +**Severity Assessment:** [Critical/Warning/Pass] + +**Recommendation:** +[If Critical] "PRD requires significant revision to improve information density. Every sentence should carry weight without filler." +[If Warning] "PRD would benefit from reducing wordiness and eliminating filler phrases." +[If Pass] "PRD demonstrates good information density with minimal violations." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Information Density Validation Complete** + +Severity: {Critical/Warning/Pass} + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-04-brief-coverage-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- PRD scanned for all three anti-pattern categories +- Violations counted with line numbers +- Severity classified correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scanning all anti-pattern categories +- Missing severity classification +- Not reporting findings to validation report +- Pausing for user input (should auto-proceed) +- Not attempting subprocess architecture + +**Master Rule:** Information density validation runs autonomously. Scan, classify, report, auto-proceed. No user interaction needed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md new file mode 100644 index 00000000..909114fe --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md @@ -0,0 +1,214 @@ +--- +name: 'step-v-04-brief-coverage-validation' +description: 'Product Brief Coverage Check - Validate PRD covers all content from Product Brief (if used as input)' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-05-measurability-validation.md' +prdFile: '{prd_file_path}' +productBrief: '{product_brief_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 4: Product Brief Coverage Validation + +## STEP GOAL: + +Validate that PRD covers all content from Product Brief (if brief was used as input), mapping brief content to PRD sections and identifying gaps. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and traceability expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on Product Brief coverage (conditional on brief existence) +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic mapping and gap analysis +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check if Product Brief exists in input documents +- 💬 If no brief: Skip this check and report "N/A - No Product Brief" +- 🎯 If brief exists: Map brief content to PRD sections +- 💾 Append coverage findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, input documents from step 1, validation report +- Focus: Product Brief coverage only (conditional) +- Limits: Don't validate other aspects, conditional execution +- Dependencies: Step 1 completed - input documents loaded + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Check for Product Brief + +Check if Product Brief was loaded in step 1's inputDocuments: + +**IF no Product Brief found:** +Append to validation report: +```markdown +## Product Brief Coverage + +**Status:** N/A - No Product Brief was provided as input +``` + +Display: "**Product Brief Coverage: Skipped** (No Product Brief provided) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} + +**IF Product Brief exists:** Continue to step 2 below + +### 2. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform Product Brief coverage validation: + +1. Load the Product Brief +2. Extract key content: + - Vision statement + - Target users/personas + - Problem statement + - Key features + - Goals/objectives + - Differentiators + - Constraints +3. For each item, search PRD for corresponding coverage +4. Classify coverage: Fully Covered / Partially Covered / Not Found / Intentionally Excluded +5. Note any gaps with severity: Critical / Moderate / Informational + +Return structured coverage map with classifications." + +### 3. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Extract from Product Brief:** +- Vision: What is this product? +- Users: Who is it for? +- Problem: What problem does it solve? +- Features: What are the key capabilities? +- Goals: What are the success criteria? +- Differentiators: What makes it unique? + +**For each item, search PRD:** +- Scan Executive Summary for vision +- Check User Journeys or user personas +- Look for problem statement +- Review Functional Requirements for features +- Check Success Criteria section +- Search for differentiators + +**Classify coverage:** +- **Fully Covered:** Content present and complete +- **Partially Covered:** Content present but incomplete +- **Not Found:** Content missing from PRD +- **Intentionally Excluded:** Content explicitly out of scope + +### 4. Assess Coverage and Severity + +**For each gap (Partially Covered or Not Found):** +- Is this Critical? (Core vision, primary users, main features) +- Is this Moderate? (Secondary features, some goals) +- Is this Informational? (Nice-to-have features, minor details) + +**Note:** Some exclusions may be intentional (valid scoping decisions) + +### 5. Report Coverage Findings to Validation Report + +Append to validation report: + +```markdown +## Product Brief Coverage + +**Product Brief:** {brief_file_name} + +### Coverage Map + +**Vision Statement:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Target Users:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Problem Statement:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Key Features:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: List specific features with severity] + +**Goals/Objectives:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Differentiators:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +### Coverage Summary + +**Overall Coverage:** [percentage or qualitative assessment] +**Critical Gaps:** [count] [list if any] +**Moderate Gaps:** [count] [list if any] +**Informational Gaps:** [count] [list if any] + +**Recommendation:** +[If critical gaps exist] "PRD should be revised to cover critical Product Brief content." +[If moderate gaps] "Consider addressing moderate gaps for complete coverage." +[If minimal gaps] "PRD provides good coverage of Product Brief content." +``` + +### 6. Display Progress and Auto-Proceed + +Display: "**Product Brief Coverage Validation Complete** + +Overall Coverage: {assessment} + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-05-measurability-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Checked for Product Brief existence correctly +- If no brief: Reported "N/A" and skipped gracefully +- If brief exists: Mapped all key brief content to PRD sections +- Coverage classified appropriately (Fully/Partially/Not Found/Intentionally Excluded) +- Severity assessed for gaps (Critical/Moderate/Informational) +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not checking for brief existence before attempting validation +- If brief exists: not mapping all key content areas +- Missing coverage classifications +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Product Brief coverage is conditional - skip if no brief, validate thoroughly if brief exists. Always auto-proceed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md new file mode 100644 index 00000000..18442e8a --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md @@ -0,0 +1,228 @@ +--- +name: 'step-v-05-measurability-validation' +description: 'Measurability Validation - Validate that all requirements (FRs and NFRs) are measurable and testable' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-06-traceability-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 5: Measurability Validation + +## STEP GOAL: + +Validate that all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) are measurable, testable, and follow proper format without implementation details. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and requirements engineering expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on FR and NFR measurability +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic requirement-by-requirement analysis +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Extract all FRs and NFRs from PRD +- 💾 Validate each for measurability and format +- 📖 Append findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: FR and NFR measurability only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-4 completed - initial validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform measurability validation on this PRD: + +**Functional Requirements (FRs):** +1. Extract all FRs from Functional Requirements section +2. Check each FR for: + - '[Actor] can [capability]' format compliance + - No subjective adjectives (easy, fast, simple, intuitive, etc.) + - No vague quantifiers (multiple, several, some, many, etc.) + - No implementation details (technology names, library names, data structures unless capability-relevant) +3. Document violations with line numbers + +**Non-Functional Requirements (NFRs):** +1. Extract all NFRs from Non-Functional Requirements section +2. Check each NFR for: + - Specific metrics with measurement methods + - Template compliance (criterion, metric, measurement method, context) + - Context included (why this matters, who it affects) +3. Document violations with line numbers + +Return structured findings with violation counts and examples." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Functional Requirements Analysis:** + +Extract all FRs and check each for: + +**Format compliance:** +- Does it follow "[Actor] can [capability]" pattern? +- Is actor clearly defined? +- Is capability actionable and testable? + +**No subjective adjectives:** +- Scan for: easy, fast, simple, intuitive, user-friendly, responsive, quick, efficient (without metrics) +- Note line numbers + +**No vague quantifiers:** +- Scan for: multiple, several, some, many, few, various, number of +- Note line numbers + +**No implementation details:** +- Scan for: React, Vue, Angular, PostgreSQL, MongoDB, AWS, Docker, Kubernetes, Redux, etc. +- Unless capability-relevant (e.g., "API consumers can access...") +- Note line numbers + +**Non-Functional Requirements Analysis:** + +Extract all NFRs and check each for: + +**Specific metrics:** +- Is there a measurable criterion? (e.g., "response time < 200ms", not "fast response") +- Can this be measured or tested? + +**Template compliance:** +- Criterion defined? +- Metric specified? +- Measurement method included? +- Context provided? + +### 3. Tally Violations + +**FR Violations:** +- Format violations: count +- Subjective adjectives: count +- Vague quantifiers: count +- Implementation leakage: count +- Total FR violations: sum + +**NFR Violations:** +- Missing metrics: count +- Incomplete template: count +- Missing context: count +- Total NFR violations: sum + +**Total violations:** FR violations + NFR violations + +### 4. Report Measurability Findings to Validation Report + +Append to validation report: + +```markdown +## Measurability Validation + +### Functional Requirements + +**Total FRs Analyzed:** {count} + +**Format Violations:** {count} +[If violations exist, list examples with line numbers] + +**Subjective Adjectives Found:** {count} +[If found, list examples with line numbers] + +**Vague Quantifiers Found:** {count} +[If found, list examples with line numbers] + +**Implementation Leakage:** {count} +[If found, list examples with line numbers] + +**FR Violations Total:** {total} + +### Non-Functional Requirements + +**Total NFRs Analyzed:** {count} + +**Missing Metrics:** {count} +[If missing, list examples with line numbers] + +**Incomplete Template:** {count} +[If incomplete, list examples with line numbers] + +**Missing Context:** {count} +[If missing, list examples with line numbers] + +**NFR Violations Total:** {total} + +### Overall Assessment + +**Total Requirements:** {FRs + NFRs} +**Total Violations:** {FR violations + NFR violations} + +**Severity:** [Critical if >10 violations, Warning if 5-10, Pass if <5] + +**Recommendation:** +[If Critical] "Many requirements are not measurable or testable. Requirements must be revised to be testable for downstream work." +[If Warning] "Some requirements need refinement for measurability. Focus on violating requirements above." +[If Pass] "Requirements demonstrate good measurability with minimal issues." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Measurability Validation Complete** + +Total Violations: {count} ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-06-traceability-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All FRs extracted and analyzed for measurability +- All NFRs extracted and analyzed for measurability +- Violations documented with line numbers +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not analyzing all FRs and NFRs +- Missing line numbers for violations +- Not reporting findings to validation report +- Not assessing severity +- Not auto-proceeding + +**Master Rule:** Requirements must be testable to be useful. Validate every requirement for measurability, document violations, auto-proceed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md new file mode 100644 index 00000000..2a2dcc76 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md @@ -0,0 +1,217 @@ +--- +name: 'step-v-06-traceability-validation' +description: 'Traceability Validation - Validate the traceability chain from vision → success → journeys → FRs is intact' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-07-implementation-leakage-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 6: Traceability Validation + +## STEP GOAL: + +Validate the traceability chain from Executive Summary → Success Criteria → User Journeys → Functional Requirements is intact, ensuring every requirement traces back to a user need or business objective. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and traceability matrix expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on traceability chain validation +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic chain validation and orphan detection +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Build and validate traceability matrix +- 💾 Identify broken chains and orphan requirements +- 📖 Append findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: Traceability chain validation only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-5 completed - initial validations done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform traceability validation on this PRD: + +1. Extract content from Executive Summary (vision, goals) +2. Extract Success Criteria +3. Extract User Journeys (user types, flows, outcomes) +4. Extract Functional Requirements (FRs) +5. Extract Product Scope (in-scope items) + +**Validate chains:** +- Executive Summary → Success Criteria: Does vision align with defined success? +- Success Criteria → User Journeys: Are success criteria supported by user journeys? +- User Journeys → Functional Requirements: Does each FR trace back to a user journey? +- Scope → FRs: Do MVP scope FRs align with in-scope items? + +**Identify orphans:** +- FRs not traceable to any user journey or business objective +- Success criteria not supported by user journeys +- User journeys without supporting FRs + +Build traceability matrix and identify broken chains and orphan FRs. + +Return structured findings with chain status and orphan list." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Step 1: Extract key elements** +- Executive Summary: Note vision, goals, objectives +- Success Criteria: List all criteria +- User Journeys: List user types and their flows +- Functional Requirements: List all FRs +- Product Scope: List in-scope items + +**Step 2: Validate Executive Summary → Success Criteria** +- Does Executive Summary mention the success dimensions? +- Are Success Criteria aligned with vision? +- Note any misalignment + +**Step 3: Validate Success Criteria → User Journeys** +- For each success criterion, is there a user journey that achieves it? +- Note success criteria without supporting journeys + +**Step 4: Validate User Journeys → FRs** +- For each user journey/flow, are there FRs that enable it? +- List FRs with no clear user journey origin +- Note orphan FRs (requirements without traceable source) + +**Step 5: Validate Scope → FR Alignment** +- Does MVP scope align with essential FRs? +- Are in-scope items supported by FRs? +- Note misalignments + +**Step 6: Build traceability matrix** +- Map each FR to its source (journey or business objective) +- Note orphan FRs +- Identify broken chains + +### 3. Tally Traceability Issues + +**Broken chains:** +- Executive Summary → Success Criteria gaps: count +- Success Criteria → User Journeys gaps: count +- User Journeys → FRs gaps: count +- Scope → FR misalignments: count + +**Orphan elements:** +- Orphan FRs (no traceable source): count +- Unsupported success criteria: count +- User journeys without FRs: count + +**Total issues:** Sum of all broken chains and orphans + +### 4. Report Traceability Findings to Validation Report + +Append to validation report: + +```markdown +## Traceability Validation + +### Chain Validation + +**Executive Summary → Success Criteria:** [Intact/Gaps Identified] +{If gaps: List specific misalignments} + +**Success Criteria → User Journeys:** [Intact/Gaps Identified] +{If gaps: List unsupported success criteria} + +**User Journeys → Functional Requirements:** [Intact/Gaps Identified] +{If gaps: List journeys without supporting FRs} + +**Scope → FR Alignment:** [Intact/Misaligned] +{If misaligned: List specific issues} + +### Orphan Elements + +**Orphan Functional Requirements:** {count} +{List orphan FRs with numbers} + +**Unsupported Success Criteria:** {count} +{List unsupported criteria} + +**User Journeys Without FRs:** {count} +{List journeys without FRs} + +### Traceability Matrix + +{Summary table showing traceability coverage} + +**Total Traceability Issues:** {total} + +**Severity:** [Critical if orphan FRs exist, Warning if gaps, Pass if intact] + +**Recommendation:** +[If Critical] "Orphan requirements exist - every FR must trace back to a user need or business objective." +[If Warning] "Traceability gaps identified - strengthen chains to ensure all requirements are justified." +[If Pass] "Traceability chain is intact - all requirements trace to user needs or business objectives." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Traceability Validation Complete** + +Total Issues: {count} ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-07-implementation-leakage-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All traceability chains validated systematically +- Orphan FRs identified with numbers +- Broken chains documented +- Traceability matrix built +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not validating all traceability chains +- Missing orphan FR detection +- Not building traceability matrix +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Every requirement should trace to a user need or business objective. Orphan FRs indicate broken traceability that must be fixed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md new file mode 100644 index 00000000..7d2839b5 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md @@ -0,0 +1,205 @@ +--- +name: 'step-v-07-implementation-leakage-validation' +description: 'Implementation Leakage Check - Ensure FRs and NFRs don\'t include implementation details' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-08-domain-compliance-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 7: Implementation Leakage Validation + +## STEP GOAL: + +Ensure Functional Requirements and Non-Functional Requirements don't include implementation details - they should specify WHAT, not HOW. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and separation of concerns expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on implementation leakage detection +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic scanning for technology and implementation terms +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Scan FRs and NFRs for implementation terms +- 💾 Distinguish capability-relevant vs leakage +- 📖 Append findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: Implementation leakage detection only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-6 completed - initial validations done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform implementation leakage validation on this PRD: + +**Scan for:** +1. Technology names (React, Vue, Angular, PostgreSQL, MongoDB, AWS, GCP, Azure, Docker, Kubernetes, etc.) +2. Library names (Redux, axios, lodash, Express, Django, Rails, Spring, etc.) +3. Data structures (JSON, XML, CSV) unless relevant to capability +4. Architecture patterns (MVC, microservices, serverless) unless business requirement +5. Protocol names (HTTP, REST, GraphQL, WebSockets) - check if capability-relevant + +**For each term found:** +- Is this capability-relevant? (e.g., 'API consumers can access...' - API is capability) +- Or is this implementation detail? (e.g., 'React component for...' - implementation) + +Document violations with line numbers and explanation. + +Return structured findings with leakage counts and examples." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Implementation leakage terms to scan for:** + +**Frontend Frameworks:** +React, Vue, Angular, Svelte, Solid, Next.js, Nuxt, etc. + +**Backend Frameworks:** +Express, Django, Rails, Spring, Laravel, FastAPI, etc. + +**Databases:** +PostgreSQL, MySQL, MongoDB, Redis, DynamoDB, Cassandra, etc. + +**Cloud Platforms:** +AWS, GCP, Azure, Cloudflare, Vercel, Netlify, etc. + +**Infrastructure:** +Docker, Kubernetes, Terraform, Ansible, etc. + +**Libraries:** +Redux, Zustand, axios, fetch, lodash, jQuery, etc. + +**Data Formats:** +JSON, XML, YAML, CSV (unless capability-relevant) + +**For each term found in FRs/NFRs:** +- Determine if it's capability-relevant or implementation leakage +- Example: "API consumers can access data via REST endpoints" - API/REST is capability +- Example: "React components fetch data using Redux" - implementation leakage + +**Count violations and note line numbers** + +### 3. Tally Implementation Leakage + +**By category:** +- Frontend framework leakage: count +- Backend framework leakage: count +- Database leakage: count +- Cloud platform leakage: count +- Infrastructure leakage: count +- Library leakage: count +- Other implementation details: count + +**Total implementation leakage violations:** sum + +### 4. Report Implementation Leakage Findings to Validation Report + +Append to validation report: + +```markdown +## Implementation Leakage Validation + +### Leakage by Category + +**Frontend Frameworks:** {count} violations +{If violations, list examples with line numbers} + +**Backend Frameworks:** {count} violations +{If violations, list examples with line numbers} + +**Databases:** {count} violations +{If violations, list examples with line numbers} + +**Cloud Platforms:** {count} violations +{If violations, list examples with line numbers} + +**Infrastructure:** {count} violations +{If violations, list examples with line numbers} + +**Libraries:** {count} violations +{If violations, list examples with line numbers} + +**Other Implementation Details:** {count} violations +{If violations, list examples with line numbers} + +### Summary + +**Total Implementation Leakage Violations:** {total} + +**Severity:** [Critical if >5 violations, Warning if 2-5, Pass if <2] + +**Recommendation:** +[If Critical] "Extensive implementation leakage found. Requirements specify HOW instead of WHAT. Remove all implementation details - these belong in architecture, not PRD." +[If Warning] "Some implementation leakage detected. Review violations and remove implementation details from requirements." +[If Pass] "No significant implementation leakage found. Requirements properly specify WHAT without HOW." + +**Note:** API consumers, GraphQL (when required), and other capability-relevant terms are acceptable when they describe WHAT the system must do, not HOW to build it. +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Implementation Leakage Validation Complete** + +Total Violations: {count} ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-08-domain-compliance-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Scanned FRs and NFRs for all implementation term categories +- Distinguished capability-relevant from implementation leakage +- Violations documented with line numbers and explanations +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scanning all implementation term categories +- Not distinguishing capability-relevant from leakage +- Missing line numbers for violations +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Requirements specify WHAT, not HOW. Implementation details belong in architecture documents, not PRDs. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md new file mode 100644 index 00000000..6bc473e7 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md @@ -0,0 +1,243 @@ +--- +name: 'step-v-08-domain-compliance-validation' +description: 'Domain Compliance Validation - Validate domain-specific requirements are present for high-complexity domains' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-09-project-type-validation.md' +prdFile: '{prd_file_path}' +prdFrontmatter: '{prd_frontmatter}' +validationReportPath: '{validation_report_path}' +domainComplexityData: '../data/domain-complexity.csv' +--- + +# Step 8: Domain Compliance Validation + +## STEP GOAL: + +Validate domain-specific requirements are present for high-complexity domains (Healthcare, Fintech, GovTech, etc.), ensuring regulatory and compliance requirements are properly documented. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring domain expertise and compliance knowledge +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on domain-specific compliance requirements +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Conditional validation based on domain classification +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check classification.domain from PRD frontmatter +- 💬 If low complexity (general): Skip detailed checks +- 🎯 If high complexity: Validate required special sections +- 💾 Append compliance findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file with frontmatter classification, validation report +- Focus: Domain compliance only (conditional on domain complexity) +- Limits: Don't validate other aspects, conditional execution +- Dependencies: Steps 2-7 completed - format and requirements validation done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Domain Complexity Data + +Load and read the complete file at: +`{domainComplexityData}` (../data/domain-complexity.csv) + +This CSV contains: +- Domain classifications and complexity levels (high/medium/low) +- Required special sections for each domain +- Key concerns and requirements for regulated industries + +Internalize this data - it drives which domains require special compliance sections. + +### 2. Extract Domain Classification + +From PRD frontmatter, extract: +- `classification.domain` - what domain is this PRD for? + +**If no domain classification found:** +Treat as "general" (low complexity) and proceed to step 4 + +### 2. Determine Domain Complexity + +**Low complexity domains (skip detailed checks):** +- General +- Consumer apps (standard e-commerce, social, productivity) +- Content websites +- Business tools (standard) + +**High complexity domains (require special sections):** +- Healthcare / Healthtech +- Fintech / Financial services +- GovTech / Public sector +- EdTech (educational records, accredited courses) +- Legal tech +- Other regulated domains + +### 3. For High-Complexity Domains: Validate Required Special Sections + +**Attempt subprocess validation:** + +"Perform domain compliance validation for {domain}: + +Based on {domain} requirements, check PRD for: + +**Healthcare:** +- Clinical Requirements section +- Regulatory Pathway (FDA, HIPAA, etc.) +- Safety Measures +- HIPAA Compliance (data privacy, security) +- Patient safety considerations + +**Fintech:** +- Compliance Matrix (SOC2, PCI-DSS, GDPR, etc.) +- Security Architecture +- Audit Requirements +- Fraud Prevention measures +- Financial transaction handling + +**GovTech:** +- Accessibility Standards (WCAG 2.1 AA, Section 508) +- Procurement Compliance +- Security Clearance requirements +- Data residency requirements + +**Other regulated domains:** +- Check for domain-specific regulatory sections +- Compliance requirements +- Special considerations + +For each required section: +- Is it present in PRD? +- Is it adequately documented? +- Note any gaps + +Return compliance matrix with presence/adequacy assessment." + +**Graceful degradation (if no Task tool):** +- Manually check for required sections based on domain +- List present sections and missing sections +- Assess adequacy of documentation + +### 5. For Low-Complexity Domains: Skip Detailed Checks + +Append to validation report: +```markdown +## Domain Compliance Validation + +**Domain:** {domain} +**Complexity:** Low (general/standard) +**Assessment:** N/A - No special domain compliance requirements + +**Note:** This PRD is for a standard domain without regulatory compliance requirements. +``` + +Display: "**Domain Compliance Validation Skipped** + +Domain: {domain} (low complexity) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} + +### 6. Report Compliance Findings (High-Complexity Domains) + +Append to validation report: + +```markdown +## Domain Compliance Validation + +**Domain:** {domain} +**Complexity:** High (regulated) + +### Required Special Sections + +**{Section 1 Name}:** [Present/Missing/Adequate] +{If missing or inadequate: Note specific gaps} + +**{Section 2 Name}:** [Present/Missing/Adequate] +{If missing or inadequate: Note specific gaps} + +[Continue for all required sections] + +### Compliance Matrix + +| Requirement | Status | Notes | +|-------------|--------|-------| +| {Requirement 1} | [Met/Partial/Missing] | {Notes} | +| {Requirement 2} | [Met/Partial/Missing] | {Notes} | +[... continue for all requirements] + +### Summary + +**Required Sections Present:** {count}/{total} +**Compliance Gaps:** {count} + +**Severity:** [Critical if missing regulatory sections, Warning if incomplete, Pass if complete] + +**Recommendation:** +[If Critical] "PRD is missing required domain-specific compliance sections. These are essential for {domain} products." +[If Warning] "Some domain compliance sections are incomplete. Strengthen documentation for full compliance." +[If Pass] "All required domain compliance sections are present and adequately documented." +``` + +### 7. Display Progress and Auto-Proceed + +Display: "**Domain Compliance Validation Complete** + +Domain: {domain} ({complexity}) +Compliance Status: {status} + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-09-project-type-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Domain classification extracted correctly +- Complexity assessed appropriately +- Low complexity domains: Skipped with clear "N/A" documentation +- High complexity domains: All required sections checked +- Compliance matrix built with status for each requirement +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not checking domain classification before proceeding +- Performing detailed checks on low complexity domains +- For high complexity: missing required section checks +- Not building compliance matrix +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Domain compliance is conditional. High-complexity domains require special sections - low complexity domains skip these checks. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md new file mode 100644 index 00000000..0aa4a2fb --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md @@ -0,0 +1,263 @@ +--- +name: 'step-v-09-project-type-validation' +description: 'Project-Type Compliance Validation - Validate project-type specific requirements are properly documented' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-10-smart-validation.md' +prdFile: '{prd_file_path}' +prdFrontmatter: '{prd_frontmatter}' +validationReportPath: '{validation_report_path}' +projectTypesData: '../data/project-types.csv' +--- + +# Step 9: Project-Type Compliance Validation + +## STEP GOAL: + +Validate project-type specific requirements are properly documented - different project types (api_backend, web_app, mobile_app, etc.) have different required and excluded sections. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring project type expertise and architectural knowledge +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on project-type compliance +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Validate required sections present, excluded sections absent +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check classification.projectType from PRD frontmatter +- 🎯 Validate required sections for that project type are present +- 🎯 Validate excluded sections for that project type are absent +- 💾 Append compliance findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file with frontmatter classification, validation report +- Focus: Project-type compliance only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-8 completed - domain and requirements validation done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Project Types Data + +Load and read the complete file at: +`{projectTypesData}` (../data/project-types.csv) + +This CSV contains: +- Detection signals for each project type +- Required sections for each project type +- Skip/excluded sections for each project type +- Innovation signals + +Internalize this data - it drives what sections must be present or absent for each project type. + +### 2. Extract Project Type Classification + +From PRD frontmatter, extract: +- `classification.projectType` - what type of project is this? + +**Common project types:** +- api_backend +- web_app +- mobile_app +- desktop_app +- data_pipeline +- ml_system +- library_sdk +- infrastructure +- other + +**If no projectType classification found:** +Assume "web_app" (most common) and note in findings + +### 3. Determine Required and Excluded Sections from CSV Data + +**From loaded project-types.csv data, for this project type:** + +**Required sections:** (from required_sections column) +These MUST be present in the PRD + +**Skip sections:** (from skip_sections column) +These MUST NOT be present in the PRD + +**Example mappings from CSV:** +- api_backend: Required=[endpoint_specs, auth_model, data_schemas], Skip=[ux_ui, visual_design] +- mobile_app: Required=[platform_reqs, device_permissions, offline_mode], Skip=[desktop_features, cli_commands] +- cli_tool: Required=[command_structure, output_formats, config_schema], Skip=[visual_design, ux_principles, touch_interactions] +- etc. + +### 4. Validate Against CSV-Based Requirements + +**Based on project type, determine:** + +**api_backend:** +- Required: Endpoint Specs, Auth Model, Data Schemas, API Versioning +- Excluded: UX/UI sections, mobile-specific sections + +**web_app:** +- Required: User Journeys, UX/UI Requirements, Responsive Design +- Excluded: None typically + +**mobile_app:** +- Required: Mobile UX, Platform specifics (iOS/Android), Offline mode +- Excluded: Desktop-specific sections + +**desktop_app:** +- Required: Desktop UX, Platform specifics (Windows/Mac/Linux) +- Excluded: Mobile-specific sections + +**data_pipeline:** +- Required: Data Sources, Data Transformation, Data Sinks, Error Handling +- Excluded: UX/UI sections + +**ml_system:** +- Required: Model Requirements, Training Data, Inference Requirements, Model Performance +- Excluded: UX/UI sections (unless ML UI) + +**library_sdk:** +- Required: API Surface, Usage Examples, Integration Guide +- Excluded: UX/UI sections, deployment sections + +**infrastructure:** +- Required: Infrastructure Components, Deployment, Monitoring, Scaling +- Excluded: Feature requirements (this is infrastructure, not product) + +### 4. Attempt Sub-Process Validation + +"Perform project-type compliance validation for {projectType}: + +**Check that required sections are present:** +{List required sections for this project type} +For each: Is it present in PRD? Is it adequately documented? + +**Check that excluded sections are absent:** +{List excluded sections for this project type} +For each: Is it absent from PRD? (Should not be present) + +Build compliance table showing: +- Required sections: [Present/Missing/Incomplete] +- Excluded sections: [Absent/Present] (Present = violation) + +Return compliance table with findings." + +**Graceful degradation (if no Task tool):** +- Manually check PRD for required sections +- Manually check PRD for excluded sections +- Build compliance table + +### 5. Build Compliance Table + +**Required sections check:** +- For each required section: Present / Missing / Incomplete +- Count: Required sections present vs total required + +**Excluded sections check:** +- For each excluded section: Absent / Present (violation) +- Count: Excluded sections present (violations) + +**Total compliance score:** +- Required: {present}/{total} +- Excluded violations: {count} + +### 6. Report Project-Type Compliance Findings to Validation Report + +Append to validation report: + +```markdown +## Project-Type Compliance Validation + +**Project Type:** {projectType} + +### Required Sections + +**{Section 1}:** [Present/Missing/Incomplete] +{If missing or incomplete: Note specific gaps} + +**{Section 2}:** [Present/Missing/Incomplete] +{If missing or incomplete: Note specific gaps} + +[Continue for all required sections] + +### Excluded Sections (Should Not Be Present) + +**{Section 1}:** [Absent/Present] ✓ +{If present: This section should not be present for {projectType}} + +**{Section 2}:** [Absent/Present] ✓ +{If present: This section should not be present for {projectType}} + +[Continue for all excluded sections] + +### Compliance Summary + +**Required Sections:** {present}/{total} present +**Excluded Sections Present:** {violations} (should be 0) +**Compliance Score:** {percentage}% + +**Severity:** [Critical if required sections missing, Warning if incomplete, Pass if complete] + +**Recommendation:** +[If Critical] "PRD is missing required sections for {projectType}. Add missing sections to properly specify this type of project." +[If Warning] "Some required sections for {projectType} are incomplete. Strengthen documentation." +[If Pass] "All required sections for {projectType} are present. No excluded sections found." +``` + +### 7. Display Progress and Auto-Proceed + +Display: "**Project-Type Compliance Validation Complete** + +Project Type: {projectType} +Compliance: {score}% + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-10-smart-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Project type extracted correctly (or default assumed) +- Required sections validated for presence and completeness +- Excluded sections validated for absence +- Compliance table built with status for all sections +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not checking project type before proceeding +- Missing required section checks +- Missing excluded section checks +- Not building compliance table +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Different project types have different requirements. API PRDs don't need UX sections - validate accordingly. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md new file mode 100644 index 00000000..94918c91 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md @@ -0,0 +1,209 @@ +--- +name: 'step-v-10-smart-validation' +description: 'SMART Requirements Validation - Validate Functional Requirements meet SMART quality criteria' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-11-holistic-quality-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + +# Step 10: SMART Requirements Validation + +## STEP GOAL: + +Validate Functional Requirements meet SMART quality criteria (Specific, Measurable, Attainable, Relevant, Traceable), ensuring high-quality 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring requirements engineering expertise and quality assessment +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on FR quality assessment using SMART framework +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Score each FR on SMART criteria (1-5 scale) +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Extract all FRs from PRD +- 🎯 Score each FR on SMART criteria (Specific, Measurable, Attainable, Relevant, Traceable) +- 💾 Flag FRs with score < 3 in any category +- 📖 Append scoring table and suggestions to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: FR quality assessment only using SMART framework +- Limits: Don't validate NFRs or other aspects, don't pause for user input +- Dependencies: Steps 2-9 completed - comprehensive validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Extract All Functional Requirements + +From the PRD's Functional Requirements section, extract: +- All FRs with their FR numbers (FR-001, FR-002, etc.) +- Count total FRs + +### 2. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform SMART requirements validation on these Functional Requirements: + +{List all FRs} + +**For each FR, score on SMART criteria (1-5 scale):** + +**Specific (1-5):** +- 5: Clear, unambiguous, well-defined +- 3: Somewhat clear but could be more specific +- 1: Vague, ambiguous, unclear + +**Measurable (1-5):** +- 5: Quantifiable metrics, testable +- 3: Partially measurable +- 1: Not measurable, subjective + +**Attainable (1-5):** +- 5: Realistic, achievable with constraints +- 3: Probably achievable but uncertain +- 1: Unrealistic, technically infeasible + +**Relevant (1-5):** +- 5: Clearly aligned with user needs and business objectives +- 3: Somewhat relevant but connection unclear +- 1: Not relevant, doesn't align with goals + +**Traceable (1-5):** +- 5: Clearly traces to user journey or business objective +- 3: Partially traceable +- 1: Orphan requirement, no clear source + +**For each FR with score < 3 in any category:** +- Provide specific improvement suggestions + +Return scoring table with all FR scores and improvement suggestions for low-scoring FRs." + +**Graceful degradation (if no Task tool):** +- Manually score each FR on SMART criteria +- Note FRs with low scores +- Provide improvement suggestions + +### 3. Build Scoring Table + +For each FR: +- FR number +- Specific score (1-5) +- Measurable score (1-5) +- Attainable score (1-5) +- Relevant score (1-5) +- Traceable score (1-5) +- Average score +- Flag if any category < 3 + +**Calculate overall FR quality:** +- Percentage of FRs with all scores ≥ 3 +- Percentage of FRs with all scores ≥ 4 +- Average score across all FRs and categories + +### 4. Report SMART Findings to Validation Report + +Append to validation report: + +```markdown +## SMART Requirements Validation + +**Total Functional Requirements:** {count} + +### Scoring Summary + +**All scores ≥ 3:** {percentage}% ({count}/{total}) +**All scores ≥ 4:** {percentage}% ({count}/{total}) +**Overall Average Score:** {average}/5.0 + +### Scoring Table + +| FR # | Specific | Measurable | Attainable | Relevant | Traceable | Average | Flag | +|------|----------|------------|------------|----------|-----------|--------|------| +| FR-001 | {s1} | {m1} | {a1} | {r1} | {t1} | {avg1} | {X if any <3} | +| FR-002 | {s2} | {m2} | {a2} | {r2} | {t2} | {avg2} | {X if any <3} | +[Continue for all FRs] + +**Legend:** 1=Poor, 3=Acceptable, 5=Excellent +**Flag:** X = Score < 3 in one or more categories + +### Improvement Suggestions + +**Low-Scoring FRs:** + +**FR-{number}:** {specific suggestion for improvement} +[For each FR with score < 3 in any category] + +### Overall Assessment + +**Severity:** [Critical if >30% flagged FRs, Warning if 10-30%, Pass if <10%] + +**Recommendation:** +[If Critical] "Many FRs have quality issues. Revise flagged FRs using SMART framework to improve clarity and testability." +[If Warning] "Some FRs would benefit from SMART refinement. Focus on flagged requirements above." +[If Pass] "Functional Requirements demonstrate good SMART quality overall." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**SMART Requirements Validation Complete** + +FR Quality: {percentage}% with acceptable scores ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-11-holistic-quality-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All FRs extracted from PRD +- Each FR scored on all 5 SMART criteria (1-5 scale) +- FRs with scores < 3 flagged for improvement +- Improvement suggestions provided for low-scoring FRs +- Scoring table built with all FR scores +- Overall quality assessment calculated +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scoring all FRs on all SMART criteria +- Missing improvement suggestions for low-scoring FRs +- Not building scoring table +- Not calculating overall quality metrics +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** FRs should be high-quality, not just present. SMART framework provides objective quality measure. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md new file mode 100644 index 00000000..65d41ea1 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md @@ -0,0 +1,264 @@ +--- +name: 'step-v-11-holistic-quality-validation' +description: 'Holistic Quality Assessment - Assess PRD as cohesive, compelling document - is it a good PRD?' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-12-completeness-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + +# Step 11: Holistic Quality Assessment + +## STEP GOAL: + +Assess the PRD as a cohesive, compelling document - evaluating document flow, dual audience effectiveness (humans and LLMs), BMAD PRD principles compliance, and overall quality rating. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and document quality expertise +- ✅ This step runs autonomously - no user input needed +- ✅ Uses Advanced Elicitation for multi-perspective evaluation + +### Step-Specific Rules: + +- 🎯 Focus ONLY on holistic document quality assessment +- 🚫 FORBIDDEN to validate individual components (done in previous steps) +- 💬 Approach: Multi-perspective evaluation using Advanced Elicitation +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Use Advanced Elicitation for multi-perspective assessment +- 🎯 Evaluate document flow, dual audience, BMAD principles +- 💾 Append comprehensive assessment to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: Complete PRD file, validation report with findings from steps 1-10 +- Focus: Holistic quality - the WHOLE document +- Limits: Don't re-validate individual components, don't pause for user input +- Dependencies: Steps 1-10 completed - all systematic checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process with Advanced Elicitation + +**Try to use Task tool to spawn a subprocess using Advanced Elicitation:** + +"Perform holistic quality assessment on this PRD using multi-perspective evaluation: + +**Load and execute Advanced Elicitation workflow:** +{advancedElicitationTask} + +**Evaluate the PRD from these perspectives:** + +**1. Document Flow & Coherence:** +- Read entire PRD +- Evaluate narrative flow - does it tell a cohesive story? +- Check transitions between sections +- Assess consistency - is it coherent throughout? +- Evaluate readability - is it clear and well-organized? + +**2. Dual Audience Effectiveness:** + +**For Humans:** +- Executive-friendly: Can executives understand vision and goals quickly? +- Developer clarity: Do developers have clear requirements to build from? +- Designer clarity: Do designers understand user needs and flows? +- Stakeholder decision-making: Can stakeholders make informed decisions? + +**For LLMs:** +- Machine-readable structure: Is the PRD structured for LLM consumption? +- UX readiness: Can an LLM generate UX designs from this? +- Architecture readiness: Can an LLM generate architecture from this? +- Epic/Story readiness: Can an LLM break down into epics and stories? + +**3. BMAD PRD Principles Compliance:** +- Information density: Every sentence carries weight? +- Measurability: Requirements testable? +- Traceability: Requirements trace to sources? +- Domain awareness: Domain-specific considerations included? +- Zero anti-patterns: No filler or wordiness? +- Dual audience: Works for both humans and LLMs? +- Markdown format: Proper structure and formatting? + +**4. Overall Quality Rating:** +Rate the PRD on 5-point scale: +- Excellent (5/5): Exemplary, ready for production use +- Good (4/5): Strong with minor improvements needed +- Adequate (3/5): Acceptable but needs refinement +- Needs Work (2/5): Significant gaps or issues +- Problematic (1/5): Major flaws, needs substantial revision + +**5. Top 3 Improvements:** +Identify the 3 most impactful improvements to make this a great PRD + +Return comprehensive assessment with all perspectives, rating, and top 3 improvements." + +**Graceful degradation (if no Task tool or Advanced Elicitation unavailable):** +- Perform holistic assessment directly in current context +- Read complete PRD +- Evaluate document flow, coherence, transitions +- Assess dual audience effectiveness +- Check BMAD principles compliance +- Assign overall quality rating +- Identify top 3 improvements + +### 2. Synthesize Assessment + +**Compile findings from multi-perspective evaluation:** + +**Document Flow & Coherence:** +- Overall assessment: [Excellent/Good/Adequate/Needs Work/Problematic] +- Key strengths: [list] +- Key weaknesses: [list] + +**Dual Audience Effectiveness:** +- For Humans: [assessment] +- For LLMs: [assessment] +- Overall dual audience score: [1-5] + +**BMAD Principles Compliance:** +- Principles met: [count]/7 +- Principles with issues: [list] + +**Overall Quality Rating:** [1-5 with label] + +**Top 3 Improvements:** +1. [Improvement 1] +2. [Improvement 2] +3. [Improvement 3] + +### 3. Report Holistic Quality Findings to Validation Report + +Append to validation report: + +```markdown +## Holistic Quality Assessment + +### Document Flow & Coherence + +**Assessment:** [Excellent/Good/Adequate/Needs Work/Problematic] + +**Strengths:** +{List key strengths} + +**Areas for Improvement:** +{List key weaknesses} + +### Dual Audience Effectiveness + +**For Humans:** +- Executive-friendly: [assessment] +- Developer clarity: [assessment] +- Designer clarity: [assessment] +- Stakeholder decision-making: [assessment] + +**For LLMs:** +- Machine-readable structure: [assessment] +- UX readiness: [assessment] +- Architecture readiness: [assessment] +- Epic/Story readiness: [assessment] + +**Dual Audience Score:** {score}/5 + +### BMAD PRD Principles Compliance + +| Principle | Status | Notes | +|-----------|--------|-------| +| Information Density | [Met/Partial/Not Met] | {notes} | +| Measurability | [Met/Partial/Not Met] | {notes} | +| Traceability | [Met/Partial/Not Met] | {notes} | +| Domain Awareness | [Met/Partial/Not Met] | {notes} | +| Zero Anti-Patterns | [Met/Partial/Not Met] | {notes} | +| Dual Audience | [Met/Partial/Not Met] | {notes} | +| Markdown Format | [Met/Partial/Not Met] | {notes} | + +**Principles Met:** {count}/7 + +### Overall Quality Rating + +**Rating:** {rating}/5 - {label} + +**Scale:** +- 5/5 - Excellent: Exemplary, ready for production use +- 4/5 - Good: Strong with minor improvements needed +- 3/5 - Adequate: Acceptable but needs refinement +- 2/5 - Needs Work: Significant gaps or issues +- 1/5 - Problematic: Major flaws, needs substantial revision + +### Top 3 Improvements + +1. **{Improvement 1}** + {Brief explanation of why and how} + +2. **{Improvement 2}** + {Brief explanation of why and how} + +3. **{Improvement 3}** + {Brief explanation of why and how} + +### Summary + +**This PRD is:** {one-sentence overall assessment} + +**To make it great:** Focus on the top 3 improvements above. +``` + +### 4. Display Progress and Auto-Proceed + +Display: "**Holistic Quality Assessment Complete** + +Overall Rating: {rating}/5 - {label} + +**Proceeding to final validation checks...**" + +Immediately load and execute {nextStepFile} (step-v-12-completeness-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Advanced Elicitation used for multi-perspective evaluation (or graceful degradation) +- Document flow & coherence assessed +- Dual audience effectiveness evaluated (humans and LLMs) +- BMAD PRD principles compliance checked +- Overall quality rating assigned (1-5 scale) +- Top 3 improvements identified +- Comprehensive assessment reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not using Advanced Elicitation for multi-perspective evaluation +- Missing document flow assessment +- Missing dual audience evaluation +- Not checking all BMAD principles +- Not assigning overall quality rating +- Missing top 3 improvements +- Not reporting comprehensive assessment to validation report +- Not auto-proceeding + +**Master Rule:** This evaluates the WHOLE document, not just components. Answers "Is this a good PRD?" and "What would make it great?" diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md new file mode 100644 index 00000000..825fbfe8 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md @@ -0,0 +1,242 @@ +--- +name: 'step-v-12-completeness-validation' +description: 'Completeness Check - Final comprehensive completeness check before report generation' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-13-report-complete.md' +prdFile: '{prd_file_path}' +prdFrontmatter: '{prd_frontmatter}' +validationReportPath: '{validation_report_path}' +--- + +# Step 12: Completeness Validation + +## STEP GOAL: + +Final comprehensive completeness check - validate no template variables remain, each section has required content, section-specific completeness, and frontmatter is properly populated. + +## 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 Validation 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 systematic validation, not collaborative dialogue +- ✅ You bring attention to detail and completeness verification +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on completeness verification +- 🚫 FORBIDDEN to validate quality (done in step 11) or other aspects +- 💬 Approach: Systematic checklist-style verification +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check template completeness (no variables remaining) +- 🎯 Validate content completeness (each section has required content) +- 🎯 Validate section-specific completeness +- 🎯 Validate frontmatter completeness +- 💾 Append completeness matrix to validation report +- 📖 Display "Proceeding to final step..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: Complete PRD file, frontmatter, validation report +- Focus: Completeness verification only (final gate) +- Limits: Don't assess quality, don't pause for user input +- Dependencies: Steps 1-11 completed - all validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform completeness validation on this PRD - final gate check: + +**1. Template Completeness:** +- Scan PRD for any remaining template variables +- Look for: {variable}, {{variable}}, {placeholder}, [placeholder], etc. +- List any found with line numbers + +**2. Content Completeness:** +- Executive Summary: Has vision statement? ({key content}) +- Success Criteria: All criteria measurable? ({metrics present}) +- Product Scope: In-scope and out-of-scope defined? ({both present}) +- User Journeys: User types identified? ({users listed}) +- Functional Requirements: FRs listed with proper format? ({FRs present}) +- Non-Functional Requirements: NFRs with metrics? ({NFRs present}) + +For each section: Is required content present? (Yes/No/Partial) + +**3. Section-Specific Completeness:** +- Success Criteria: Each has specific measurement method? +- User Journeys: Cover all user types? +- Functional Requirements: Cover MVP scope? +- Non-Functional Requirements: Each has specific criteria? + +**4. Frontmatter Completeness:** +- stepsCompleted: Populated? +- classification: Present (domain, projectType)? +- inputDocuments: Tracked? +- date: Present? + +Return completeness matrix with status for each check." + +**Graceful degradation (if no Task tool):** +- Manually scan for template variables +- Manually check each section for required content +- Manually verify frontmatter fields +- Build completeness matrix + +### 2. Build Completeness Matrix + +**Template Completeness:** +- Template variables found: count +- List if any found + +**Content Completeness by Section:** +- Executive Summary: Complete / Incomplete / Missing +- Success Criteria: Complete / Incomplete / Missing +- Product Scope: Complete / Incomplete / Missing +- User Journeys: Complete / Incomplete / Missing +- Functional Requirements: Complete / Incomplete / Missing +- Non-Functional Requirements: Complete / Incomplete / Missing +- Other sections: [List completeness] + +**Section-Specific Completeness:** +- Success criteria measurable: All / Some / None +- Journeys cover all users: Yes / Partial / No +- FRs cover MVP scope: Yes / Partial / No +- NFRs have specific criteria: All / Some / None + +**Frontmatter Completeness:** +- stepsCompleted: Present / Missing +- classification: Present / Missing +- inputDocuments: Present / Missing +- date: Present / Missing + +**Overall completeness:** +- Sections complete: X/Y +- Critical gaps: [list if any] + +### 3. Report Completeness Findings to Validation Report + +Append to validation report: + +```markdown +## Completeness Validation + +### Template Completeness + +**Template Variables Found:** {count} +{If count > 0, list variables with line numbers} +{If count = 0, note: No template variables remaining ✓} + +### Content Completeness by Section + +**Executive Summary:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Success Criteria:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Product Scope:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**User Journeys:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Functional Requirements:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Non-Functional Requirements:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +### Section-Specific Completeness + +**Success Criteria Measurability:** [All/Some/None] measurable +{If Some or None, note which criteria lack metrics} + +**User Journeys Coverage:** [Yes/Partial/No] - covers all user types +{If Partial or No, note missing user types} + +**FRs Cover MVP Scope:** [Yes/Partial/No] +{If Partial or No, note scope gaps} + +**NFRs Have Specific Criteria:** [All/Some/None] +{If Some or None, note which NFRs lack specificity} + +### Frontmatter Completeness + +**stepsCompleted:** [Present/Missing] +**classification:** [Present/Missing] +**inputDocuments:** [Present/Missing] +**date:** [Present/Missing] + +**Frontmatter Completeness:** {complete_fields}/4 + +### Completeness Summary + +**Overall Completeness:** {percentage}% ({complete_sections}/{total_sections}) + +**Critical Gaps:** [count] [list if any] +**Minor Gaps:** [count] [list if any] + +**Severity:** [Critical if template variables exist or critical sections missing, Warning if minor gaps, Pass if complete] + +**Recommendation:** +[If Critical] "PRD has completeness gaps that must be addressed before use. Fix template variables and complete missing sections." +[If Warning] "PRD has minor completeness gaps. Address minor gaps for complete documentation." +[If Pass] "PRD is complete with all required sections and content present." +``` + +### 4. Display Progress and Auto-Proceed + +Display: "**Completeness Validation Complete** + +Overall Completeness: {percentage}% ({severity}) + +**Proceeding to final step...**" + +Immediately load and execute {nextStepFile} (step-v-13-report-complete.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Scanned for template variables systematically +- Validated each section for required content +- Validated section-specific completeness (measurability, coverage, scope) +- Validated frontmatter completeness +- Completeness matrix built with all checks +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to final step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scanning for template variables +- Missing section-specific completeness checks +- Not validating frontmatter +- Not building completeness matrix +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Final gate to ensure document is complete before presenting findings. Template variables or critical gaps must be fixed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md new file mode 100644 index 00000000..8b138cfb --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md @@ -0,0 +1,232 @@ +--- +name: 'step-v-13-report-complete' +description: 'Validation Report Complete - Finalize report, summarize findings, present to user, offer next steps' + +# File references (ONLY variables used in this step) +validationReportPath: '{validation_report_path}' +prdFile: '{prd_file_path}' +--- + +# Step 13: Validation Report Complete + +## STEP GOAL: + +Finalize validation report, summarize all findings from steps 1-12, present summary to user conversationally, and offer actionable next steps. + +## 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 Validation 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 synthesis and summary expertise +- ✅ This is the FINAL step - requires user interaction + +### Step-Specific Rules: + +- 🎯 Focus ONLY on summarizing findings and presenting options +- 🚫 FORBIDDEN to perform additional validation +- 💬 Approach: Conversational summary with clear next steps +- 🚪 This is the final step - no next step after this + +## EXECUTION PROTOCOLS: + +- 🎯 Load complete validation report +- 🎯 Summarize all findings from steps 1-12 +- 🎯 Update report frontmatter with final status +- 💬 Present summary to user conversationally +- 💬 Offer menu options for next actions +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Complete validation report with findings from all validation steps +- Focus: Summary and presentation only (no new validation) +- Limits: Don't add new findings, just synthesize existing +- Dependencies: Steps 1-12 completed - all validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Complete Validation Report + +Read the entire validation report from {validationReportPath} + +Extract all findings from: +- Format Detection (Step 2) +- Parity Analysis (Step 2B, if applicable) +- Information Density (Step 3) +- Product Brief Coverage (Step 4) +- Measurability (Step 5) +- Traceability (Step 6) +- Implementation Leakage (Step 7) +- Domain Compliance (Step 8) +- Project-Type Compliance (Step 9) +- SMART Requirements (Step 10) +- Holistic Quality (Step 11) +- Completeness (Step 12) + +### 2. Update Report Frontmatter with Final Status + +Update validation report frontmatter: + +```yaml +--- +validationTarget: '{prd_path}' +validationDate: '{current_date}' +inputDocuments: [list of documents] +validationStepsCompleted: ['step-v-01-discovery', 'step-v-02-format-detection', 'step-v-03-density-validation', 'step-v-04-brief-coverage-validation', 'step-v-05-measurability-validation', 'step-v-06-traceability-validation', 'step-v-07-implementation-leakage-validation', 'step-v-08-domain-compliance-validation', 'step-v-09-project-type-validation', 'step-v-10-smart-validation', 'step-v-11-holistic-quality-validation', 'step-v-12-completeness-validation'] +validationStatus: COMPLETE +holisticQualityRating: '{rating from step 11}' +overallStatus: '{Pass/Warning/Critical based on all findings}' +--- +``` + +### 3. Create Summary of Findings + +**Overall Status:** +- Determine from all validation findings +- **Pass:** All critical checks pass, minor warnings acceptable +- **Warning:** Some issues found but PRD is usable +- **Critical:** Major issues that prevent PRD from being fit for purpose + +**Quick Results Table:** +- Format: [classification] +- Information Density: [severity] +- Measurability: [severity] +- Traceability: [severity] +- Implementation Leakage: [severity] +- Domain Compliance: [status] +- Project-Type Compliance: [compliance score] +- SMART Quality: [percentage] +- Holistic Quality: [rating/5] +- Completeness: [percentage] + +**Critical Issues:** List from all validation steps +**Warnings:** List from all validation steps +**Strengths:** List positives from all validation steps + +**Holistic Quality Rating:** From step 11 +**Top 3 Improvements:** From step 11 + +**Recommendation:** Based on overall status + +### 4. Present Summary to User Conversationally + +Display: + +"**✓ PRD Validation Complete** + +**Overall Status:** {Pass/Warning/Critical} + +**Quick Results:** +{Present quick results table with key findings} + +**Critical Issues:** {count or "None"} +{If any, list briefly} + +**Warnings:** {count or "None"} +{If any, list briefly} + +**Strengths:** +{List key strengths} + +**Holistic Quality:** {rating}/5 - {label} + +**Top 3 Improvements:** +1. {Improvement 1} +2. {Improvement 2} +3. {Improvement 3} + +**Recommendation:** +{Based on overall status: +- Pass: "PRD is in good shape. Address minor improvements to make it great." +- Warning: "PRD is usable but has issues that should be addressed. Review warnings and improve where needed." +- Critical: "PRD has significant issues that should be fixed before use. Focus on critical issues above."} + +**What would you like to do next?**" + +### 5. Present MENU OPTIONS + +Display: + +**[R] Review Detailed Findings** - Walk through validation report section by section +**[E] Use Edit Workflow** - Use validation report with Edit workflow for systematic improvements +**[F] Fix Simpler Items** - Immediate fixes for simple issues (anti-patterns, leakage, missing headers) +**[X] Exit** - Exit and review validation report + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- Only proceed based on user selection + +#### Menu Handling Logic: + +- **IF R (Review Detailed Findings):** + - Walk through validation report section by section + - Present findings from each validation step + - Allow user to ask questions + - After review, return to menu + +- **IF E (Use Edit Workflow):** + - Explain: "The Edit workflow (steps-e/) can use this validation report to systematically address issues. Edit mode will guide you through discovering what to edit, reviewing the PRD, and applying targeted improvements." + - Offer: "Would you like to launch Edit mode now? It will help you fix validation findings systematically." + - If yes: Load and execute steps-e/step-e-01-discovery.md + - If no: Return to menu + +- **IF F (Fix Simpler Items):** + - Offer immediate fixes for: + - Template variables (fill in with appropriate content) + - Conversational filler (remove wordy phrases) + - Implementation leakage (remove technology names from FRs/NFRs) + - Missing section headers (add ## headers) + - Ask: "Which simple fixes would you like me to make?" + - If user specifies fixes, make them and update validation report + - Return to menu + +- **IF X (Exit):** + - Display: "**Validation Report Saved:** {validationReportPath}" + - Display: "**Summary:** {overall status} - {recommendation}" + - Display: "**Next Steps:** Review the validation report and address findings. For systematic improvements, consider using Edit workflow when available, or manually fix issues identified in this report." + - Exit validation + +- **IF Any other:** Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete validation report loaded successfully +- All findings from steps 1-12 summarized +- Report frontmatter updated with final status +- Overall status determined correctly (Pass/Warning/Critical) +- Quick results table presented +- Critical issues, warnings, and strengths listed +- Holistic quality rating included +- Top 3 improvements presented +- Clear recommendation provided +- Menu options presented with clear explanations +- User can review findings, get help, or exit + +### ❌ SYSTEM FAILURE: + +- Not loading complete validation report +- Missing summary of findings +- Not updating report frontmatter +- Not determining overall status +- Missing menu options +- Unclear next steps + +**Master Rule:** User needs clear summary and actionable next steps. Edit workflow is best for complex issues; immediate fixes available for simpler ones. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md deleted file mode 100644 index 5127230b..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -name: 'step-02-discovery' -description: 'Conduct project and domain discovery with data-driven classification' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-discovery.md' -nextStepFile: '{workflow_path}/steps/step-03-success.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{planning_artifacts}/prd.md' - -# Data Files -projectTypesCSV: '{workflow_path}/project-types.csv' -domainComplexityCSV: '{workflow_path}/domain-complexity.csv' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 2: Project & Domain Discovery - -**Progress: Step 2 of 11** - Next: Success Criteria Definition - -## STEP GOAL: - -Conduct comprehensive project discovery that leverages existing input documents while allowing user refinement, with data-driven classification, and generate the Executive Summary content. - -## 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 product-focused PM facilitator collaborating with an expert peer -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision - -### Step-Specific Rules: - -- 🎯 Focus on project classification and vision alignment only -- 🚫 FORBIDDEN to generate content without real user input -- 💬 APPROACH: Adapt questions based on document context (brownfield vs greenfield) -- 🎯 LOAD classification data BEFORE starting discovery conversation - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after generating executive summary content -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step -- 🚫 FORBIDDEN to load next step until C is selected - -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper insights about the generated content -- **P (Party Mode)**: Bring multiple perspectives to discuss and improve the generated content -- **C (Continue)**: Append and save the content to the `{outputFile}` and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {advancedElicitationTask} -- When 'P' selected: Execute {partyModeWorkflow} -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - -## CONTEXT BOUNDARIES: - -- Current document and frontmatter from step 1 are available -- Input documents already loaded are in memory (product briefs, research, brainstorming, project docs) -- **Document counts available in frontmatter `documentCounts`** -- Classification CSV data will be loaded in this step only -- This will be the first content section appended to the document - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Read Document State from Frontmatter - -**CRITICAL FIRST ACTION:** Read the frontmatter from `{outputFile}` to get document counts. - -``` -Read documentCounts from prd.md frontmatter: -- briefCount = documentCounts.briefs -- researchCount = documentCounts.research -- brainstormingCount = documentCounts.brainstorming -- projectDocsCount = documentCounts.projectDocs -``` - -**ANNOUNCE your understanding:** - -"From step 1, I have loaded: - -- Product briefs: {{briefCount}} files -- Research: {{researchCount}} files -- Brainstorming: {{brainstormingCount}} files -- Project docs: {{projectDocsCount}} files - -{if projectDocsCount > 0}This is a **brownfield project** - I'll focus on understanding what you want to add or change.{else}This is a **greenfield project** - I'll help you define the full product vision.{/if}" - -### 2. Load Classification Data - -Load and prepare CSV data for intelligent classification: - -- Load `{projectTypesCSV}` completely -- Load `{domainComplexityCSV}` completely -- Parse column structures and store in memory for this step only - -### 3. Begin Discovery Conversation - -**SELECT EXACTLY ONE DISCOVERY PATH based on document state:** - ---- - -#### PATH A: Has Product Brief (briefCount > 0) - -**Use this path when:** `briefCount > 0` - -"As your PM peer, I've reviewed your product brief and have a great starting point for our discovery. Let me share what I understand and you can refine or correct as needed. - -**Based on your product brief:** - -**What you're building:** -{{extracted_vision_from_brief}} - -**Problem it solves:** -{{extracted_problem_from_brief}} - -**Target users:** -{{extracted_users_from_brief}} - -**What makes it special:** -{{extracted_differentiator_from_brief}} - -{if projectDocsCount > 0}I also see you have existing project documentation. This PRD will define how new features integrate with your existing system architecture.{/if} - -**How does this align with your vision?** Should we refine any of these points or are there important aspects I'm missing?" - -**AFTER this message, SKIP to Section 4.** - ---- - -#### PATH B: No Brief but Has Project Docs - Brownfield (briefCount == 0 AND projectDocsCount > 0) - -**Use this path when:** `briefCount == 0 AND projectDocsCount > 0` - -**NOTE:** Extract the following from loaded project documentation (index.md, architecture.md, project-overview.md, etc.): - -"As your PM peer, I've reviewed your existing project documentation from document-project. - -**Your existing system includes:** - -- **Tech Stack:** {analyze index.md and architecture.md for technologies used} -- **Architecture:** {summarize architecture patterns from architecture.md} -- **Key Components:** {list main components from source-tree-analysis.md or project-overview.md} - -This PRD will define **new features or changes** to add to this existing codebase. - -**Tell me about what you want to add or change:** - -- What new capability or feature do you want to build? -- What problem will this solve for your users? -- How should it integrate with the existing system? -- Is this adding new functionality, improving existing features, or fixing issues? - -I'll help you create a PRD focused on these additions while respecting your existing patterns and architecture." - -**AFTER this message, SKIP to Section 4.** - ---- - -#### PATH C: No Documents - Greenfield (briefCount == 0 AND projectDocsCount == 0) - -**Use this path when:** `briefCount == 0 AND projectDocsCount == 0` - -"As your PM peer, I'm excited to help you shape {{project_name}}. Let me start by understanding what you want to build. - -**Tell me about what you want to create:** - -- What problem does it solve? -- Who are you building this for? -- What excites you most about this product? - -I'll be listening for signals to help us classify the project and domain so we can ask the right questions throughout our process." - -**AFTER this message, continue to Section 4.** - ---- - -### 4. Listen for Classification Signals - -As the user describes their product/feature, listen for and match against: - -#### Project Type Signals - -Compare user description against `detection_signals` from `project-types.csv`: - -- Look for keyword matches from semicolon-separated signals -- Examples: "API,REST,GraphQL" → api_backend -- Examples: "iOS,Android,app,mobile" → mobile_app -- Store the best matching `project_type` - -#### Domain Signals - -Compare user description against `signals` from `domain-complexity.csv`: - -- Look for domain keyword matches -- Examples: "medical,diagnostic,clinical" → healthcare -- Examples: "payment,banking,trading" → fintech -- Store the matched `domain` and `complexity_level` - -### 5. Present Classification for Validation - -**SELECT EXACTLY ONE CLASSIFICATION PRESENTATION based on document state:** - ---- - -#### IF PATH A was used (briefCount > 0): - -"Based on your product brief and our discussion, I'm classifying this as: - -- **Project Type:** {project_type_from_brief_or_conversation} -- **Domain:** {domain_from_brief_or_conversation} -- **Complexity:** {complexity_from_brief_or_conversation} - -From your brief, I detected these classification signals: -{{classification_signals_from_brief}} - -{if projectDocsCount > 0}Your existing project documentation also indicates: - -- **Existing Tech Stack:** {from architecture.md or index.md} -- **Architecture Pattern:** {from architecture.md} - -I'll ensure the new features align with your existing system.{/if} - -Combined with our conversation, this suggests the above classification. Does this sound right?" - ---- - -#### IF PATH B was used (briefCount == 0 AND projectDocsCount > 0): - -"Based on your existing project documentation and our discussion about new features: - -- **Existing Project Type:** {detected from project docs - e.g., web_app, api_backend} -- **Tech Stack:** {from architecture.md or index.md} -- **New Feature Type:** {from user's description of what they want to add} -- **Domain:** {detected_domain} -- **Complexity:** {complexity_level} - -I'll ensure the PRD aligns with your existing architecture patterns. Does this classification sound right?" - ---- - -#### IF PATH C was used (briefCount == 0 AND projectDocsCount == 0): - -"Based on our conversation, I'm hearing this as: - -- **Project Type:** {detected_project_type} -- **Domain:** {detected_domain} -- **Complexity:** {complexity_level} - -Does this sound right to you? I want to make sure we're on the same page before diving deeper." - ---- - -### 6. Identify What Makes It Special - -**SELECT EXACTLY ONE DIFFERENTIATOR DISCOVERY based on document state:** - ---- - -#### IF PATH A was used (briefCount > 0): - -"From your product brief, I understand that what makes this special is: -{{extracted_differentiator_from_brief}} - -Let's explore this deeper: - -- **Refinement needed:** Does this capture the essence correctly, or should we adjust it? -- **Missing aspects:** Are there other differentiators that aren't captured in your brief? -- **Evolution:** How has your thinking on this evolved since you wrote the brief?" - ---- - -#### IF PATH B was used (briefCount == 0 AND projectDocsCount > 0): - -"Your existing system already provides certain capabilities. Now let's define what makes these **new additions** special: - -- What gap in your current system will this fill? -- How will this improve the experience for your existing users? -- What's the key insight that led you to prioritize this addition? -- What would make users say 'finally, this is what we needed'?" - ---- - -#### IF PATH C was used (briefCount == 0 AND projectDocsCount == 0): - -Ask focused questions to capture the product's unique value: - -- "What would make users say 'this is exactly what I needed'?" -- "What's the moment where users realize this is different/better?" -- "What assumption about [problem space] are you challenging?" -- "If this succeeds wildly, what changed for your users?" - ---- - -### 7. Generate Executive Summary Content - -Based on the conversation, prepare the content to append to the document: - -#### Content Structure: - -```markdown -## Executive Summary - -{vision_alignment_content} - -### What Makes This Special - -{product_differentiator_content} - -## Project Classification - -**Technical Type:** {project_type} -**Domain:** {domain} -**Complexity:** {complexity_level} -{if projectDocsCount > 0}**Project Context:** Brownfield - extending existing system{else}**Project Context:** Greenfield - new project{/if} - -{project_classification_content} -``` - -### 8. Present Content and Menu - -Show the generated content to the user and present: - -"I've drafted our Executive Summary based on our conversation. This will be the first section of your PRD. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 7] - -**Select an Option:** -[A] Advanced Elicitation - Let's dive deeper and refine this content -[P] Party Mode - Bring in different perspectives to improve this -[C] Continue - Save this and move to Success Criteria Definition (Step 3 of 11)" - -### 9. Handle Menu Selection - -#### IF A (Advanced Elicitation): - -- Execute {advancedElicitationTask} with the current content -- Process the enhanced content that comes back -- Ask user: "Accept these changes to the Executive Summary? (y/n)" -- If yes: Update the content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### IF P (Party Mode): - -- Execute {partyModeWorkflow} with the current content -- Process the collaborative improvements that come back -- Ask user: "Accept these changes to the Executive Summary? (y/n)" -- If yes: Update the content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### IF C (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{nextStepFile}` - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [executive summary content finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and begin success criteria definition. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Document counts read from frontmatter and announced -- Classification data loaded and used effectively -- **Correct discovery path selected based on document counts** -- Input documents analyzed and leveraged for head start -- User classifications validated and confirmed -- Product differentiator clearly identified and refined -- Executive summary content generated collaboratively with document context -- A/P/C menu presented and handled correctly -- Content properly appended to document when C selected -- Frontmatter updated with stepsCompleted: [1, 2] - -### ❌ SYSTEM FAILURE: - -- **Not reading documentCounts from frontmatter first** -- **Executing multiple discovery paths instead of exactly one** -- Skipping classification data loading and guessing classifications -- Not leveraging existing input documents to accelerate discovery -- Not validating classifications with user before proceeding -- Generating executive summary without real user input -- Missing the "what makes it special" discovery and refinement -- Not presenting A/P/C menu after content generation -- Appending content without user selecting 'C' - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## COMPLEXITY HANDLING: - -If `complexity_level = "high"`: - -- Note the `suggested_workflow` and `web_searches` from domain CSV -- Consider mentioning domain research needs in classification section -- Document complexity implications in project classification diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md deleted file mode 100644 index 9b61a1bd..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -name: 'step-04-journeys' -description: 'Map ALL user types that interact with the system with narrative story-based journeys' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-journeys.md' -nextStepFile: '{workflow_path}/steps/step-05-domain.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{planning_artifacts}/prd.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 4: User Journey Mapping - -**Progress: Step 4 of 11** - Next: Domain Requirements - -## MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER generate content without user input - -- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions -- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding -- ✅ ALWAYS treat this as collaborative discovery between PM peers -- 📋 YOU ARE A FACILITATOR, not a content generator -- 💬 FOCUS on mapping ALL user types that interact with the system -- 🎯 CRITICAL: No journey = no functional requirements = product doesn't exist -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after generating journey content -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step -- 🚫 FORBIDDEN to load next step until C is selected - -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper journey insights -- **P (Party Mode)**: Bring multiple perspectives to map comprehensive user journeys -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - -## CONTEXT BOUNDARIES: - -- Current document and frontmatter from previous steps are available -- Success criteria and scope already defined -- Input documents from step-01 are available (product briefs with user personas) -- Every human interaction with the system needs a journey - -## YOUR TASK: - -Create compelling narrative user journeys that leverage existing personas from product briefs and identify additional user types needed for comprehensive coverage. - -## JOURNEY MAPPING SEQUENCE: - -### 1. Leverage Existing Users & Identify Additional Types - -**Check Input Documents for Existing Personas:** -Analyze product brief, research, and brainstorming documents for user personas already defined. - -**If User Personas Exist in Input Documents:** -"I found some fantastic user personas in your product brief! Let me introduce them and see if we need to expand our cast of characters. - -**From your brief:** -{{extracted_personas_from_brief_with_details}} - -These are great starting points! Their stories already give us insight into what they need from {{project_name}}. - -**Beyond your identified users, who else touches this system?** -Based on your product type and scope, we might need: - -{{suggest_additional_user_types_based_on_project_context}} - -What additional user types should we consider for this product?" - -**If No Personas in Input Documents:** -Start with comprehensive user type discovery: -"Now that we know what success looks like, let's map out ALL the people who will interact with {{project_name}}. - -**Beyond primary users, who else touches this system?** -Consider: - -- End users (the primary focus) -- Admins - manage users, settings, content -- Moderators - review flagged content, enforce rules -- Support staff - help users, investigate issues -- API consumers - if dev tool or platform -- Internal ops - analytics, monitoring, billing - -What user types should we map for this product?" - -### 2. Create Narrative Story-Based Journeys - -For each user type, create compelling narrative journeys that tell their story: - -#### Narrative Journey Creation Process: - -**If Using Existing Persona from Input Documents:** -"Let's tell {{persona_name}}'s story with {{project_name}}. - -**Their Story So Far:** -{{persona_backstory_from_brief}} - -**How {{project_name}} Changes Their Life:** -{{how_product_helps_them}} - -Let's craft their journey narrative - where do we meet them in their story, and how does {{project_name}} help them write their next chapter?" - -**If Creating New Persona:** -"Let's bring this user type to life with a compelling story. - -**Creating Their Character:** - -- **Name**: Give them a realistic name and personality -- **Situation**: What's happening in their life/work that creates the need? -- **Goal**: What do they desperately want to achieve? -- **Obstacle**: What's standing in their way right now? - -**How {{project_name}} Becomes Their Solution:** -{{how_product_solves_their_story}} - -Now let's map their journey narrative." - -**Story-Based Journey Mapping:** - -"Let's craft this as a story with our hero (the user) facing challenges and finding solutions through {{project_name}}: - -**Story Structure:** - -- **Opening Scene**: Where and how do we meet them? What's their current pain? -- **Rising Action**: What steps do they take? What do they discover? -- **Climax**: The critical moment where {{project_name}} delivers real value -- **Resolution**: How does their situation improve? What's their new reality? - -**Use This Narrative Format such as this example:** - -```markdown -**Journey 1: Maria Santos - Reclaiming Her Creative Time** -Maria is a freelance graphic designer who loves creating beautiful logos but spends hours every week managing client projects, sending invoices, and chasing payments. She feels like she's running a small business instead of doing what she loves. Late one night, while searching for invoicing tools, she discovers CreativeFlow and decides to give it a try. - -The next morning, instead of her usual 30-minute project management routine, she spends 5 minutes setting up her first client in CreativeFlow. The system automatically generates a professional invoice and even suggests follow-up emails based on her communication patterns. When a client asks for a project update, Maria can share a beautiful progress link instead of digging through emails. - -The breakthrough comes when she lands a major corporate client who's impressed by her "organized and professional" project setup. Six months later, Maria has doubled her client base and spends 80% of her time actually designing - exactly what she always wanted. -``` - -### 3. Guide Journey Exploration - -For each journey, facilitate detailed exploration: - -- "What happens at each step specifically?" -- "What could go wrong here? What's the recovery path?" -- "What information do they need to see/hear?" -- "What's their emotional state at each point?" -- "Where does this journey succeed or fail?" - -### 4. Connect Journeys to Requirements - -After each journey, explicitly state: -"This journey reveals requirements for: - -- List specific capability areas (e.g., onboarding, meal planning, admin dashboard) -- Help user see how different journeys create different feature sets" - -### 5. Aim for Comprehensive Coverage - -Guide toward complete journey set: - -- **Primary user** - happy path (core experience) -- **Primary user** - edge case (different goal, error recovery) -- **Secondary user** (admin, moderator, support, etc.) -- **API consumer** (if applicable) - -Ask: "Another journey? We should cover [suggest uncovered user type]" - -### 6. Generate User Journey Content - -Prepare the content to append to the document: - -#### Content Structure: - -When saving to document, append these Level 2 and Level 3 sections: - -```markdown -## User Journeys - -[All journey narratives based on conversation] - -### Journey Requirements Summary - -[Summary of capabilities revealed by journeys based on conversation] -``` - -### 7. Present Content and Menu - -Show the generated journey content and present choices: -"I've mapped out the user journeys based on our conversation. Each journey reveals different capabilities needed for {{project_name}}. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 6] - -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these user journeys -[P] Party Mode - Bring different perspectives to ensure we have all journeys -[C] Continue - Save this and move to Domain Requirements (Step 5 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current journey content -- Process the enhanced journey insights that come back -- Ask user: "Accept these improvements to the user journeys? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current journeys -- Process the collaborative journey improvements and additions -- Ask user: "Accept these changes to the user journeys? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md` (or determine if step is optional based on domain complexity) - -## APPEND TO DOCUMENT: - -When user selects 'C', append the content directly to the document using the structure from step 6. - -## SUCCESS METRICS: - -✅ Existing personas from product briefs leveraged when available -✅ All user types identified (not just primary users) -✅ Rich narrative storytelling for each persona and journey -✅ Complete story-based journey mapping with emotional arc -✅ Journey requirements clearly connected to capabilities needed -✅ Minimum 3-4 compelling narrative journeys covering different user types -✅ A/P/C menu presented and handled correctly -✅ Content properly appended to document when C selected - -## FAILURE MODES: - -❌ Ignoring existing personas from product briefs -❌ Only mapping primary user journeys and missing secondary users -❌ Creating generic journeys without rich persona details and narrative -❌ Missing emotional storytelling elements that make journeys compelling -❌ Missing critical decision points and failure scenarios -❌ Not connecting journeys to required capabilities -❌ Not having enough journey diversity (admin, support, API, etc.) -❌ Not presenting A/P/C menu after content generation -❌ Appending content without user selecting 'C' - -❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions -❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file -❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols - -## JOURNEY TYPES TO ENSURE: - -**Minimum Coverage:** - -1. **Primary User - Success Path**: Core experience journey -2. **Primary User - Edge Case**: Error recovery, alternative goals -3. **Admin/Operations User**: Management, configuration, monitoring -4. **Support/Troubleshooting**: Help, investigation, issue resolution -5. **API/Integration** (if applicable): Developer/technical user journey - -## NEXT STEP: - -After user selects 'C' and content is saved to document, load `./step-05-domain.md`. - -Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md deleted file mode 100644 index 1140b035..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -name: 'step-05-domain' -description: 'Explore domain-specific requirements for complex domains (optional step)' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-domain.md' -nextStepFile: '{workflow_path}/steps/step-06-innovation.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{planning_artifacts}/prd.md' - -# Data Files -domainComplexityCSV: '{workflow_path}/domain-complexity.csv' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 5: Domain-Specific Exploration - -**Progress: Step 5 of 11** - Next: Innovation Focus - -## MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER generate content without user input - -- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions -- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding -- ✅ ALWAYS treat this as collaborative discovery between PM peers -- 📋 YOU ARE A FACILITATOR, not a content generator -- 💬 FOCUS on domain-specific requirements and compliance needs -- 🎯 OPTIONAL STEP: Only proceed if complexity_level = "high" from step-02 -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after generating domain content -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step -- 🚫 FORBIDDEN to load next step until C is selected - -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper domain insights -- **P (Party Mode)**: Bring domain expertise perspectives to explore requirements -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - -## CONTEXT BOUNDARIES: - -- Current document and frontmatter from previous steps are available -- Domain complexity from step-02 should be "high" to justify this step -- Domain-specific CSV data will be loaded in this step -- Focus on compliance, regulations, and domain-specific constraints - -## OPTIONAL STEP CHECK: - -Before proceeding with this step, verify: - -- Is `complexity_level` from step-02 equal to "high" and/or does the domain have specific regulatory/compliance needs? -- Would domain exploration significantly impact the product requirements? - -If NO to these questions, skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`. - -## YOUR TASK: - -Explore domain-specific requirements for complex domains that need specialized compliance, regulatory, or industry-specific considerations. - -## DOMAIN EXPLORATION SEQUENCE: - -### 1. Load Domain Configuration Data - -Load domain-specific configuration for complex domains: - -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv` completely -- Find the row where `domain` matches the detected domain from step-02 -- Extract these columns: - - `key_concerns` (semicolon-separated list) - - `required_knowledge` (domain expertise needed) - - `web_searches` (suggested research queries) - - `special_sections` (domain-specific sections to document) - -### 2. Present Domain Complexity Context - -Start by explaining why this step is needed: -"Since {{project_name}} is in the {domain} domain with high complexity, we need to explore domain-specific requirements. - -**Key Concerns for {domain}:** -[List the key_concerns from CSV] - -This step will help us understand regulatory requirements, compliance needs, and industry-specific constraints that will shape our product." - -### 3. Explore Domain-Specific Requirements - -For each concern in `key_concerns` from the CSV: - -#### Domain Concern Exploration: - -- Ask the user about their approach to this concern -- Discuss implications for the product design and requirements -- Document specific requirements, constraints, and compliance needs - -**Example for Healthcare Domain:** -If key_concerns = "FDA approval;Clinical validation;HIPAA compliance;Patient safety;Medical device classification;Liability" - -Ask about each: - -- "Will this product require FDA approval? What classification?" -- "How will you validate clinical accuracy and safety?" -- "What HIPAA compliance measures are needed?" -- "What patient safety protocols must be in place?" -- "What liability considerations affect the design?" - -### 4. Synthesize Domain Requirements - -Based on the conversation, synthesize domain requirements that will shape everything: - -#### Categories to Document: - -- **Regulatory requirements** (from key_concerns) -- **Compliance needs** (from key_concerns) -- **Industry standards** (from required_knowledge) -- **Safety/risk factors** (from key_concerns) -- **Required validations** (from key_concerns) -- **Special expertise needed** (from required_knowledge) - -Explain how these inform: - -- What features are mandatory -- What NFRs are critical -- How to sequence development -- What validation is required - -### 5. Generate Domain-Specific Content - -Prepare the content to append to the document: - -#### Content Structure: - -When saving to document, append these Level 2 and Level 3 sections: - -```markdown -## Domain-Specific Requirements - -### [Domain Name] Compliance & Regulatory Overview - -[Domain context summary based on conversation] - -### Key Domain Concerns - -[Key concerns addressed based on conversation] - -### Compliance Requirements - -[Compliance requirements based on conversation] - -### Industry Standards & Best Practices - -[Industry standards based on conversation] - -### Required Expertise & Validation - -[Required knowledge and validation based on conversation] - -### Implementation Considerations - -[Implementation implications based on conversation] -``` - -### 6. Handle Special Sections - -Parse `special_sections` list from the matched CSV row. For each section name, generate corresponding subsections: - -**Example mappings from CSV:** - -- "clinical_requirements" → Add clinical validation requirements -- "regulatory_pathway" → Document approval pathway timeline -- "safety_measures" → Specify safety protocols and monitoring -- "compliance_matrix" → Create compliance tracking matrix - -### 7. Present Content and Menu - -Show the generated domain content and present choices: -"I've documented the {domain}-specific requirements that will shape {{project_name}}. These constraints are critical for success in this complex domain. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 6] - -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these domain requirements -[P] Party Mode - Bring domain expertise perspectives to validate requirements -[C] Continue - Save this and move to Innovation Focus (Step 6 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current domain content -- Process the enhanced domain insights that come back -- Ask user: "Accept these domain requirement improvements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current domain requirements -- Process the collaborative domain expertise and validation -- Ask user: "Accept these changes to domain requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the content to `{outputFile}` -- Update frontmatter: add this step name to the end of the steps completed array -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md` - -## APPEND TO DOCUMENT: - -When user selects 'C', append the content directly to the document using the structure from step 6. - -## SUCCESS METRICS: - -✅ Domain complexity properly validated as high before proceeding -✅ All key concerns from CSV explored with user input -✅ Compliance requirements clearly documented -✅ Domain expertise needs identified and documented -✅ Special sections generated per CSV configuration -✅ A/P/C menu presented and handled correctly -✅ Content properly appended to document when C selected - -## FAILURE MODES: - -❌ Proceeding with domain exploration when complexity is not high -❌ Not loading or using CSV domain configuration properly -❌ Missing critical domain concerns from the key_concerns list -❌ Not connecting domain requirements to product implications -❌ Generating generic content without domain-specific details -❌ Not presenting A/P/C menu after content generation -❌ Appending content without user selecting 'C' - -❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions -❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file -❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols - -## SKIP CONDITIONS: - -Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md` if: - -- `complexity_level` from step-02 is not "high" -- Domain has no specific regulatory/compliance requirements -- User confirms domain exploration is not needed - -## NEXT STEP: - -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`. - -Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md deleted file mode 100644 index 1104eaa0..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -name: 'step-11-complete' -description: 'Complete the PRD workflow, update status files, and suggest next steps' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-11-complete.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{planning_artifacts}/prd.md' ---- - -# Step 11: Workflow Completion - -**Final Step - Complete the PRD** - -## MANDATORY EXECUTION RULES (READ FIRST): - -- ✅ THIS IS A FINAL STEP - Workflow completion required - -- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions -- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding -- 🛑 NO content generation - this is a wrap-up step -- 📋 FINALIZE document and update workflow status -- 💬 FOCUS on completion, next steps, and suggestions -- 🎯 UPDATE workflow status files with completion information -- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- 💾 Update the main workflow status file with completion information -- 📖 Suggest potential next workflow steps for the user -- 🚫 DO NOT load additional steps after this one - -## TERMINATION STEP PROTOCOLS: - -- This is a FINAL step - workflow completion required -- Output any remaining content if needed (none for this step) -- Update the main workflow status file with finalized document -- Suggest potential next steps for the user -- Mark workflow as complete in status tracking - -## CONTEXT BOUNDARIES: - -- Complete PRD document is available from all previous steps -- Workflow frontmatter shows all completed steps -- All collaborative content has been generated and saved -- Focus on completion, validation, and next steps - -## YOUR TASK: - -Complete the PRD workflow, update status files, and suggest next steps for the project. - -## WORKFLOW COMPLETION SEQUENCE: - -### 1. Announce Workflow Completion - -Inform user that the PRD is complete: -"🎉 **PRD Complete, {{user_name}}!** - -I've successfully collaborated with you to create a comprehensive Product Requirements Document for {{project_name}}. - -**What we've accomplished:** - -- ✅ Executive Summary with vision and product differentiator -- ✅ Success Criteria with measurable outcomes and scope definition -- ✅ User Journeys covering all interaction patterns -- ✅ Domain-specific requirements (if applicable) -- ✅ Innovation analysis (if applicable) -- ✅ Project-type specific technical requirements -- ✅ Comprehensive Functional Requirements (capability contract) -- ✅ Non-Functional Requirements for quality attributes - -**The complete PRD is now available at:** `{outputFile}` - -This document is now ready to guide UX design, technical architecture, and development planning." - -### 2. Workflow Status Update - -Update the main workflow status file if there is one: - -- Load `{status_file}` from workflow configuration (if exists) -- Update workflow_status["prd"] = "{default_output_file}" -- Save file, preserving all comments and structure -- Mark current timestamp as completion time - -### 3. Suggest Next Steps - -Provide guidance on logical next workflows: - -**Typical Next Workflows:** - -**Immediate Next Steps:** - -1. `workflow create-ux-design` - UX Design (if UI exists) - - User journey insights from step-04 will inform interaction design - - Functional requirements from step-09 define design scope - -2. `workflow create-architecture` - Technical architecture - - Project-type requirements from step-07 guide technical decisions - - Non-functional requirements from step-10 inform architecture choices - -3. `workflow create-epics-and-stories` - Epic breakdown - - Functional requirements from step-09 become epics and stories - - Scope definition from step-03 guides sprint planning - -**Strategic Considerations:** - -- UX design and architecture can happen in parallel -- Epics/stories are richer when created after UX/architecture - -**What would be most valuable to tackle next?** - -### 4. Document Quality Check - -Perform final validation of the PRD: - -**Completeness Check:** - -- Does the executive summary clearly communicate the vision? -- Are success criteria specific and measurable? -- Do user journeys cover all major user types? -- Are functional requirements comprehensive and testable? -- Are non-functional requirements relevant and specific? - -**Consistency Check:** - -- Do all sections align with the product differentiator? -- Is scope consistent across all sections? -- Are requirements traceable to user needs and success criteria? - -### 5. Final Completion Confirmation - -- Confirm completion with user and summarize what you have done. -- Update frontmatter: add this final step name to the end of the steps completed array. - -## SUCCESS METRICS: - -✅ PRD document contains all required sections -✅ All collaborative content properly saved to document -✅ Workflow status file updated with completion information -✅ Clear next step guidance provided to user -✅ Document quality validation completed -✅ User acknowledges completion and understands next options - -## FAILURE MODES: - -❌ Not updating workflow status file with completion information -❌ Missing clear next step guidance for user -❌ Not confirming document completeness with user -❌ Workflow not properly marked as complete in status tracking -❌ User unclear about what happens next - -❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions -❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file -❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols - -## WORKFLOW COMPLETION CHECKLIST: - -### Document Structure Complete: - -- [ ] Executive Summary with vision and differentiator -- [ ] Success Criteria with measurable outcomes -- [ ] Product Scope (MVP, Growth, Vision) -- [ ] User Journeys (comprehensive coverage) -- [ ] Domain Requirements (if applicable) -- [ ] Innovation Analysis (if applicable) -- [ ] Project-Type Requirements -- [ ] Functional Requirements (capability contract) -- [ ] Non-Functional Requirements - -### Process Complete: - -- [ ] All steps completed with user confirmation -- [ ] All content saved to document -- [ ] Frontmatter properly updated -- [ ] Workflow status file updated -- [ ] Next steps clearly communicated - -## FINAL REMINDER: - -This workflow is now complete. The PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD. - -**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉 diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md b/src/modules/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md similarity index 93% rename from src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md index 6b54dc50..d82219d2 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md @@ -2,7 +2,6 @@ stepsCompleted: [] inputDocuments: [] workflowType: 'prd' -lastStep: 0 --- # Product Requirements Document - {{project_name}} diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md b/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md new file mode 100644 index 00000000..a30227cd --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md @@ -0,0 +1,433 @@ +--- +validationTarget: 'PRD Workflow Structure' +validationDate: '2026-01-08' +inputDocuments: [] +validationStepsCompleted: ['discovery', 'frontmatter-validation', 'content-validation', 'documentation-validation', 'integration-validation', 'corrections-applied'] +validationStatus: COMPLETE - PRODUCTION READY +--- + +# PRD Workflow Validation Report + +**Workflow Being Validated:** /Users/brianmadison/dev/BMAD-METHOD/src/modules/bmm/workflows/2-plan-workflows/prd +**Validation Date:** 2026-01-08 +**Validator:** BMAD Workflow Validation System + +--- + +## Executive Summary + +This validation report assesses the PRD workflow structure against BMAD workflow standards. The PRD workflow is a tri-modal workflow system with Create, Validate, and Edit phases. + +--- + +## 1. File Structure & Size Analysis + +### Folder Structure + +``` +prd/ +├── workflow.md (main workflow file) +├── steps-c/ (Create steps - 12 files) +├── steps-v/ (Validation steps - 13 files) +├── steps-e/ (Edit steps - 5 files) +├── data/ +│ └── prd-purpose.md +└── templates/ + └── prd-template.md +``` + +**✅ Structure Status**: PASS - All required folders present + +### File Size Analysis + +#### Steps-C (Create Steps) - 12 files +| File | Lines | Status | +|------|-------|--------| +| step-01-init.md | 191 | ⚠️ Approaching limit | +| step-01b-continue.md | 153 | ✅ Good | +| step-02-discovery.md | 197 | ⚠️ Approaching limit | +| step-03-success.md | 226 | ⚠️ Approaching limit | +| step-04-journeys.md | 213 | ⚠️ Approaching limit | +| step-05-domain.md | 193 | ⚠️ Approaching limit | +| step-06-innovation.md | 226 | ⚠️ Approaching limit | +| step-07-project-type.md | 225 | ⚠️ Approaching limit | +| step-08-scoping.md | 228 | ⚠️ Approaching limit | +| step-09-functional.md | 231 | ⚠️ Approaching limit | +| step-10-nonfunctional.md | 242 | ⚠️ Approaching limit | +| step-11-polish.md | 217 | ⚠️ Approaching limit | +| step-12-complete.md | 185 | ✅ Good | + +#### Steps-V (Validation Steps) - 13 files +| File | Lines | Status | +|------|-------|--------| +| step-v-01-discovery.md | 217 | ⚠️ Approaching limit | +| step-v-02-format-detection.md | 191 | ⚠️ Approaching limit | +| step-v-02b-parity-check.md | 209 | ⚠️ Approaching limit | +| step-v-03-density-validation.md | 174 | ✅ Good | +| step-v-04-brief-coverage-validation.md | 214 | ⚠️ Approaching limit | +| step-v-05-measurability-validation.md | 228 | ⚠️ Approaching limit | +| step-v-06-traceability-validation.md | 217 | ⚠️ Approaching limit | +| step-v-07-implementation-leakage-validation.md | 205 | ⚠️ Approaching limit | +| step-v-08-domain-compliance-validation.md | 243 | ⚠️ Approaching limit | +| step-v-09-project-type-validation.md | 263 | ❌ Exceeds limit | +| step-v-10-smart-validation.md | 209 | ⚠️ Approaching limit | +| step-v-11-holistic-quality-validation.md | 264 | ❌ Exceeds limit | +| step-v-12-completeness-validation.md | 242 | ⚠️ Approaching limit | +| step-v-13-report-complete.md | 231 | ⚠️ Approaching limit | + +#### Steps-E (Edit Steps) - 5 files +| File | Lines | Status | +|------|-------|--------| +| step-e-01-discovery.md | 206 | ⚠️ Approaching limit | +| step-e-01b-legacy-conversion.md | 208 | ⚠️ Approaching limit | +| step-e-02-review.md | 249 | ⚠️ Approaching limit | +| step-e-03-edit.md | 253 | ❌ Exceeds limit | +| step-e-04-complete.md | 168 | ✅ Good | + +#### Data & Templates +| File | Lines | Status | +|------|-------|--------| +| data/prd-purpose.md | 197 | ⚠️ Approaching limit | +| templates/prd-template.md | 10 | ✅ Good | +| workflow.md | 114 | ✅ Good | + +### File Size Statistics + +- **Total Files**: 32 markdown files +- **✅ Good (<200 lines)**: 6 files (18.8%) +- **⚠️ Approaching limit (200-250)**: 23 files (71.9%) +- **❌ Exceeds limit (>250)**: 3 files (9.4%) +- **Average lines per file**: 213.3 lines + +### ⚠️ Recommendations + +1. **Files Exceeding 250-line limit**: + - `step-v-09-project-type-validation.md` (263 lines) - Consider splitting into sub-steps + - `step-v-11-holistic-quality-validation.md` (264 lines) - Consider splitting into sub-steps + - `step-e-03-edit.md` (253 lines) - Consider splitting into sub-steps + +2. **Files Approaching Limit**: + - Many files are in the 200-250 line range + - Monitor these files as further additions may push them over the limit + - Consider proactive refactoring where appropriate + +--- + +## 2. Frontmatter Structure Validation + +### Files Checked: 29 total files + +**✅ Overall Status:** ALL VALID - One Issue Fixed + +#### Main Workflow (workflow.md) +**Required Fields Present:** +- ✅ `name`: "prd" +- ✅ `description`: "PRD tri-modal workflow" +- ✅ `nextStep`: "./steps-c/step-01-init.md" +- ✅ `validateWorkflow`: "./steps-v/step-v-01-discovery.md" +- ✅ `editWorkflow`: "./steps-e/step-e-01-discovery.md" (FIXED - was assess-workflow.md) + +#### Create Steps (steps-c) +- ✅ All 13 files have proper name, description, nextStepFile +- ✅ Proper sequencing from step-01 through step-12 +- ✅ Consistent output file references + +#### Validation Steps (steps-v) +- ✅ All 13 files have complete frontmatter +- ✅ Proper sequential chain maintained +- ✅ No broken internal references + +#### Edit Steps (steps-e) +- ✅ All files have required fields +- ✅ Proper routing with altStepFile references + +### ✅ All Issues Resolved + +**1. Broken Edit Workflow Reference:** +```yaml +# Current (INCORRECT): +editWorkflow: './steps-e/step-e-01-assess-workflow.md' + +# Should be: +editWorkflow: './steps-e/step-e-01-discovery.md' +``` + +**2. Step Numbering Gap:** +- Original `step-11-complete.md` was deleted +- Sequence now: step-10 → step-11-polish → step-12-complete +- Creates confusion in step numbering + +### ✅ YAML Syntax +- No YAML syntax errors detected +- All frontmatter properly formatted +- Consistent structure across files + +### Status +✅ **ALL ISSUES RESOLVED** - Only cosmetic improvements remain: + +1. **✅ FIXED**: Edit workflow path corrected in workflow.md +2. **⚠️ OPTIONAL**: Address step numbering gap for clarity +3. **⚠️ OPTIONAL**: Rename step-01b-continue.md to step-01a-continue.md for consistency + +--- + +## 3. Step File Content Validation + +### Content Quality Assessment: 4.5/5 - EXCELLENT + +#### Files Reviewed: 10 representative files across all modes + +#### ✅ Strengths + +**1. Comprehensive Structure:** +- Clear step goal sections in all files +- Detailed mandatory execution rules +- Well-defined execution protocols +- Context boundaries clearly specified +- Mandatory sequence with numbered steps +- System success/failure metrics present + +**2. BMAD Compliance:** +- ✅ JIT loading references consistently mentioned +- ✅ State tracking requirements documented +- ✅ Append-only building instructions present +- ✅ Critical rules properly emphasized with emojis +- ✅ Sequential enforcement clearly stated + +**3. Instructional Quality:** +- Clear, unambiguous instructions +- Proper menu handling rules (where applicable) +- Excellent continuation checks +- Strong role definition for each mode + +**4. Role Clarity:** +- Create Mode: "Product-focused PM facilitator" +- Validate Mode: "Validation Architect and Quality Assurance Specialist" +- Edit Mode: "PRD improvement specialist" + +#### ⚠️ Minor Improvement Opportunities + +**1. Header Formatting:** +- Some inconsistency in header level usage across files +- Recommend standardizing H2/H3 usage + +**2. Edit Mode Completeness:** +- Edit mode has fewer steps (5 vs 12/13 for other modes) +- Documentation marks it as "Future" but implementation exists + +#### Recommendations +1. **LOW PRIORITY**: Standardize header formatting across all step files +2. **LOW PRIORITY**: Complete remaining edit mode steps for parity +3. **MAINTAIN**: Current excellent quality standards + +--- + +## 4. Documentation Validation + +### Documentation Completeness: ✅ COMPREHENSIVE + +#### Main Components Present +- ✅ Workflow Definition (workflow.md) +- ✅ Purpose Document (data/prd-purpose.md) +- ✅ Template (templates/prd-template.md) +- ✅ Three Mode Implementations (Create: 12, Validate: 13, Edit: 5 steps) + +#### Clarity Assessment: ✅ EXCELLENT + +**Strong Points:** +1. Clear mode determination (commands, flags, menu selection) +2. Detailed routing instructions for each mode +3. Comprehensive workflow architecture explanation +4. Well-defined critical rules with visual emphasis +5. Professional presentation with consistent formatting + +#### ⚠️ Minor Issues Found + +**1. Step Count Mismatch:** +- workflow.md mentions "11 steps" for Create mode +- Actually implements 12 steps +- Could confuse users + +**2. Edit Mode Status:** +- workflow.md calls Edit mode "Future" +- Edit mode steps are actually implemented +- Should reflect current status + +**3. Template Completeness:** +- PRD template is minimal (10 lines) +- Could benefit from section placeholders + +**4. Missing README:** +- No onboarding documentation for new users +- Not critical but would be helpful + +#### Recommendations + +**HIGH PRIORITY:** +1. Fix step count reference to match implementation (12 steps) +2. Update edit mode documentation to "Implemented" + +**MEDIUM PRIORITY:** +3. Enhance PRD template with section structure +4. Add quick-start README for new users + +**LOW PRIORITY:** +5. Add troubleshooting section +6. Document external dependencies (domain-complexity.csv, project-types.csv) + +--- + +## 5. Integration & Compatibility Validation + +### Integration Status: 85% Ready + +#### ✅ Successfully Integrated Components + +**1. Agent Menu Registration:** +- ✅ Registered in PM agent menu +- ✅ Trigger: `PR` or fuzzy match on `prd` +- ✅ Command: `/bmad:bmm:workflows:create-prd` +- ✅ Proper workflow path configuration + +**2. External Workflow References:** +- ✅ Party-mode workflow: Exists at `/src/core/workflows/party-mode/workflow.md` +- ✅ Advanced-elicitation task: Exists at `/src/core/workflows/advanced-elicitation/workflow.xml` + +**3. Directory Structure:** +- ✅ Complete step architecture (all 3 modes) +- ✅ All referenced step files exist +- ✅ Data files available + +#### ✅ Configuration & Installation - WORKING AS DESIGNED + +**1. BMM Config Reference:** +- Path: `{project-root}/_bmad/bmm/config.yaml` +- **Status:** ✅ Correct installation-time placeholder +- Resolves to actual config during workflow installation +- **Note:** This is expected behavior, not an issue + +**2. Planning Artifacts Folder:** +- Reference: `{planning_artifacts}/prd.md` +- **Status:** ✅ Correct installation-time placeholder +- Created/resolved during workflow installation +- **Note:** This is expected behavior, not an issue + +**3. Edit Mode Implementation:** +- Current: 5 steps (Discovery, Legacy Conversion branch, Review, Edit, Complete) +- **Status:** ✅ Functionally complete +- Edit mode is inherently simpler than create mode (targeted improvements vs full creation) +- Uses subprocesses for complex operations +- Validation integration ensures quality +- **Note:** Edit workflow is complete and well-designed + +#### Configuration Analysis + +**Placeholder Usage:** +- `{project-root}`: ✅ Properly used +- `{planning_artifacts}`: ⚠️ Referenced but folder missing +- `{nextStep}`, `{validateWorkflow}`, etc: ✅ Properly resolved + +#### Recommendations + +**✅ ALL CRITICAL ISSUES RESOLVED:** + +The only true critical issue (edit workflow path) has been fixed. All other items flagged as "critical" were actually working as designed (installation-time placeholders). + +**LOW PRIORITY:** +3. Add CLI command registration for standalone execution (optional enhancement) +4. Consider adding workflow to additional agent menus (UX designer, architect) +5. Create standalone execution documentation (nice-to-have) +6. Address step numbering gap if desired (cosmetic) + +--- + +## 6. Executive Summary & Overall Assessment + +### Overall Validation Status: ✅ PRODUCTION-READY + +#### Validation Scores by Category + +| Category | Status | Score | Notes | +|----------|--------|-------|-------| +| **File Structure & Size** | ⚠️ WARNINGS | 7/10 | 3 files exceed 250-line limit, 23 approaching | +| **Frontmatter Validation** | ✅ PASS | 9/10 | One broken path reference | +| **Step Content Quality** | ✅ EXCELLENT | 9.5/10 | High-quality instructional design | +| **Documentation** | ✅ EXCELLENT | 9/10 | Comprehensive, minor inconsistencies | +| **Integration** | ✅ PASS | 9/10 | All paths correct (one issue fixed) | +| **BMAD Compliance** | ✅ EXCELLENT | 9.5/10 | Strong adherence to standards | + +**Overall Score: 9.2/10 - EXCELLENT** + +#### ✅ Critical Action Items - ALL RESOLVED + +**ONLY ONE TRUE CRITICAL ISSUE EXISTED - NOW FIXED:** + +1. **✅ FIXED: Edit Workflow Path** + - File: `workflow.md` ✓ RESOLVED + - Changed from: `./steps-e/step-e-01-assess-workflow.md` + - Changed to: `./steps-e/step-e-01-discovery.md` + +**Items incorrectly flagged as critical (actually working as designed):** +- ✅ Configuration path references (installation-time placeholders) +- ✅ Planning artifacts folder (installation-time placeholder) + +#### High Priority Improvements + +2. **⚠️ Split Large Step Files** (>250 lines): + - `step-v-09-project-type-validation.md` (263 lines) + - `step-v-11-holistic-quality-validation.md` (264 lines) + - `step-e-03-edit.md` (253 lines) + +3. **⚠️ Update Documentation Inconsistencies**: + - Fix step count reference (11 → 12 steps in create mode) + - Update edit mode status (Future → Implemented) + +#### Medium Priority Enhancements + +4. **Enhance PRD Template** (currently minimal at 10 lines) +5. **Add quick-start README** for new users +6. **Address step numbering gap** (cosmetic - missing step-11-complete.md) + +#### Edit Mode Status - FUNCTIONALLY COMPLETE ✅ + +The edit workflow is **complete and well-designed** with 5 steps: +- Discovery → Legacy Conversion (branch) → Review → Edit → Complete +- Edit mode is inherently simpler than create mode (targeted improvements vs full creation) +- Uses subprocesses for complex operations +- Integrates with validation workflow + +**No additional steps needed.** + +### Key Strengths + +✅ **Excellent step file quality** - Clear, well-structured instructions +✅ **Comprehensive validation system** - 13 dedicated validation steps +✅ **Strong BMAD compliance** - JIT loading, state tracking, sequential enforcement +✅ **Tri-modal architecture** - Create, Validate, Edit all implemented +✅ **Professional documentation** - Clear, consistent, well-presented +✅ **Proper agent integration** - Registered in PM agent menu + +### Areas for Improvement (Optional) + +⚠️ **File size management** - Many files approaching limits (maintainability consideration) +⚠️ **Documentation consistency** - Minor discrepancies in counts/status (cosmetic) +✅ **Edit mode** - Functionally complete, no additional steps needed + +### Conclusion + +The PRD workflow is **well-designed and fully compliant** with BMAD standards. The step file architecture is exemplary, the content quality is excellent, and the documentation is comprehensive. The only critical issue (edit workflow path) has been **resolved**, and all other flagged items were actually working as designed (installation-time placeholders). + +**Current Status: ✅ PRODUCTION-READY** + +**Recommended Optional Enhancements:** +1. Split the 3 files exceeding 250-line limit (maintainability) +2. Update documentation inconsistencies (step counts, edit mode status) +3. Enhance PRD template and add quick-start README (user experience) + +The PRD workflow is ready for production use and fully compliant with BMAD workflow standards. + +--- + +**Validation Completed:** 2026-01-08 +**Validation Method:** Systematic subprocess analysis with maximum context coverage +**Validator:** BMAD Workflow Validation System (Wendy - Workflow Building Master) diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md b/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md index ef0ed523..2658f1e3 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md @@ -1,15 +1,70 @@ --- -name: create-prd -description: Creates a comprehensive PRD through collaborative step-by-step discovery between two product managers working as peers. +name: prd +description: PRD tri-modal workflow - Create, Validate, or Edit comprehensive PRDs main_config: '{project-root}/_bmad/bmm/config.yaml' +nextStep: './steps-c/step-01-init.md' +validateWorkflow: './steps-v/step-v-01-discovery.md' +editWorkflow: './steps-e/step-e-01-discovery.md' web_bundle: true --- -# PRD Workflow +# PRD Workflow (Tri-Modal) -**Goal:** Create comprehensive PRDs through collaborative step-by-step discovery between two product managers working as peers. +**Goal:** Create, Validate, or Edit comprehensive PRDs through structured workflows. -**Your Role:** You are a product-focused PM facilitator collaborating with an expert peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision. Work together as equals. You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. +**Your Role:** +- **Create Mode:** Product-focused PM facilitator collaborating with an expert peer +- **Validate Mode:** Validation Architect and Quality Assurance Specialist +- **Edit Mode:** PRD improvement specialist + +You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. + +--- + +## MODE DETERMINATION + +### Detect Workflow Mode + +Determine which mode to invoke based on: + +1. **Command/Invocation:** + - "create prd" or "new prd" → Create mode + - "validate prd" or "check prd" → Validate mode + - "edit prd" or "improve prd" → Edit mode + +2. **Context Detection:** + - If invoked with -c flag → Create mode + - If invoked with -v flag → Validate mode + - If invoked with -e flag → Edit mode + +3. **Menu Selection (if unclear):** + +If mode cannot be determined from invocation: +"**PRD Workflow - Select Mode:** + +**[C] Create** - Create a new PRD from scratch +**[V] Validate** - Validate an existing PRD against BMAD standards +**[E] Edit** - Improve an existing PRD + +Which mode would you like?" + +Wait for user selection. + +### Route to Appropriate Workflow + +**IF Create Mode:** +"**Create Mode: Creating a new PRD from scratch.**" +Load, read entire file, then execute: `{nextStep}` (steps-c/step-01-init.md) + +**IF Validate Mode:** +"**Validate Mode: Validating an existing PRD against BMAD standards.**" +Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file." +Then load, read entire file, and execute: `{validateWorkflow}` (steps-v/step-v-01-discovery.md) + +**IF Edit Mode:** +"**Edit Mode: Improving an existing PRD.**" +Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file." +Then load, read entire file, and execute: `{editWorkflow}` (steps-e/step-e-01-discovery.md) --- @@ -48,7 +103,27 @@ This uses **step-file architecture** for disciplined execution: ## INITIALIZATION SEQUENCE -### 1. Configuration Loading +### 1. Mode Determination + +**Check if mode was specified in the command invocation:** + +- If user invoked with "create prd" or "new prd" or "build prd" or "-c" or "--create" → Set mode to **create** +- If user invoked with "validate prd" or "review prd" or "check prd" or "-v" or "--validate" → Set mode to **validate** +- If user invoked with "edit prd" or "modify prd" or "improve prd" or "-e" or "--edit" → Set mode to **edit** + +**If mode is still unclear, ask user:** + +"**PRD Workflow - Select Mode:** + +**[C] Create** - Create a new PRD from scratch +**[V] Validate** - Validate an existing PRD against BMAD standards +**[E] Edit** - Improve an existing PRD + +Which mode would you like?" + +Wait for user selection. + +### 2. Configuration Loading Load and read full config from {main_config} and resolve: @@ -56,8 +131,20 @@ Load and read full config from {main_config} and resolve: - `communication_language`, `document_output_language`, `user_skill_level` - `date` as system-generated current datetime -### 2. First Step EXECUTION +✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. +### 3. Route to Appropriate Workflow -YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`. -Load, read the full file and then execute `steps/step-01-init.md` to begin the workflow. +**IF mode == create:** +"**Create Mode: Creating a new PRD from scratch.**" +Load, read entire file, then execute `{nextStep}` (steps-c/step-01-init.md) + +**IF mode == validate:** +"**Validate Mode: Validating an existing PRD against BMAD standards.**" +Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file." +Then load, read entire file, and execute `{validateWorkflow}` (steps-v/step-v-01-discovery.md) + +**IF mode == edit:** +"**Edit Mode: Improving an existing PRD.**" +Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file." +Then load, read entire file, and execute `{editWorkflow}` (steps-e/step-e-01-discovery.md) diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md index 5199316d..c9270cc7 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md @@ -6,8 +6,8 @@ description: 'Discover and inventory all project documents, handling duplicates workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-01-document-discovery.md' -nextStepFile: '{workflow_path}/steps/step-02-prd-analysis.md' +thisStepFile: './step-01-document-discovery.md' +nextStepFile: './step-02-prd-analysis.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' templateFile: '{workflow_path}/templates/readiness-report-template.md' diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md index 4dafecca..5dd08705 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md @@ -6,8 +6,8 @@ description: 'Read and analyze PRD to extract all FRs and NFRs for coverage vali workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-02-prd-analysis.md' -nextStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md' +thisStepFile: './step-02-prd-analysis.md' +nextStepFile: './step-03-epic-coverage-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md index f11228e1..981a5b63 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md @@ -6,8 +6,8 @@ description: 'Validate that all PRD FRs are covered in epics and stories' workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md' -nextStepFile: '{workflow_path}/steps/step-04-ux-alignment.md' +thisStepFile: './step-03-epic-coverage-validation.md' +nextStepFile: './step-04-ux-alignment.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' --- diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md index e26190f2..33aad045 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md @@ -6,8 +6,8 @@ description: 'Check for UX document and validate alignment with PRD and Architec workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-04-ux-alignment.md' -nextStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md' +thisStepFile: './step-04-ux-alignment.md' +nextStepFile: './step-05-epic-quality-review.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' --- diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md index 59a531d3..0203cdc1 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md @@ -6,8 +6,8 @@ description: 'Validate epics and stories against create-epics-and-stories best p workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md' -nextStepFile: '{workflow_path}/steps/step-06-final-assessment.md' +thisStepFile: './step-05-epic-quality-review.md' +nextStepFile: './step-06-final-assessment.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' epicsBestPractices: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md index aa78c14f..9469a226 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md @@ -6,7 +6,7 @@ description: 'Compile final assessment and polish the readiness report' workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-06-final-assessment.md' +thisStepFile: './step-06-final-assessment.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' --- diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md index ed9b890b..a06276fa 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md @@ -52,4 +52,4 @@ Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: ### 2. First Step EXECUTION -Load, read the full file and then execute `{workflow_path}/steps/step-01-document-discovery.md` to begin the workflow. +Load, read the full file and then execute `./step-01-document-discovery.md` to begin the workflow. diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md index 641c7081..ca52d4d2 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md @@ -6,8 +6,8 @@ description: 'Validate required documents exist and extract all requirements for workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-01-validate-prerequisites.md' -nextStepFile: '{workflow_path}/steps/step-02-design-epics.md' +thisStepFile: './step-01-validate-prerequisites.md' +nextStepFile: './step-02-design-epics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' epicsTemplate: '{workflow_path}/templates/epics-template.md' diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md index 4527f5f3..65b36627 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md @@ -6,8 +6,8 @@ description: 'Design and approve the epics_list that will organize all requireme workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-02-design-epics.md' -nextStepFile: '{workflow_path}/steps/step-03-create-stories.md' +thisStepFile: './step-02-design-epics.md' +nextStepFile: './step-03-create-stories.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md index 6e560e7c..3cdb3bf6 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md @@ -6,8 +6,8 @@ description: 'Generate all epics with their stories following the template struc workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-03-create-stories.md' -nextStepFile: '{workflow_path}/steps/step-04-final-validation.md' +thisStepFile: './step-03-create-stories.md' +nextStepFile: './step-04-final-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md index 309bef8c..3df1675b 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md @@ -6,7 +6,7 @@ description: 'Validate complete coverage of all requirements and ensure implemen workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-04-final-validation.md' +thisStepFile: './step-04-final-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md index 40b2fafa..cbb32894 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md @@ -3,9 +3,9 @@ name: 'step-01-mode-detection' description: 'Determine execution mode (tech-spec vs direct), handle escalation, set state variables' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-01-mode-detection.md' -nextStepFile_modeA: '{workflow_path}/steps/step-03-execute.md' -nextStepFile_modeB: '{workflow_path}/steps/step-02-context-gathering.md' +thisStepFile: './step-01-mode-detection.md' +nextStepFile_modeA: './step-03-execute.md' +nextStepFile_modeB: './step-02-context-gathering.md' --- # Step 1: Mode Detection diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md index 8e2126bc..a886b5f5 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md @@ -3,8 +3,8 @@ name: 'step-02-context-gathering' description: 'Quick context gathering for direct mode - identify files, patterns, dependencies' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-02-context-gathering.md' -nextStepFile: '{workflow_path}/steps/step-03-execute.md' +thisStepFile: './step-02-context-gathering.md' +nextStepFile: './step-03-execute.md' --- # Step 2: Context Gathering (Direct Mode) diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md index 1be12b98..f12113cf 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md @@ -3,8 +3,8 @@ name: 'step-03-execute' description: 'Execute implementation - iterate through tasks, write code, run tests' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-03-execute.md' -nextStepFile: '{workflow_path}/steps/step-04-self-check.md' +thisStepFile: './step-03-execute.md' +nextStepFile: './step-04-self-check.md' --- # Step 3: Execute Implementation diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md index c6d93162..6179ebba 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md @@ -3,8 +3,8 @@ name: 'step-04-self-check' description: 'Self-audit implementation against tasks, tests, AC, and patterns' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-04-self-check.md' -nextStepFile: '{workflow_path}/steps/step-05-adversarial-review.md' +thisStepFile: './step-04-self-check.md' +nextStepFile: './step-05-adversarial-review.md' --- # Step 4: Self-Check diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md index 2a366dbd..db03665f 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md @@ -3,8 +3,8 @@ name: 'step-05-adversarial-review' description: 'Construct diff and invoke adversarial review task' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-05-adversarial-review.md' -nextStepFile: '{workflow_path}/steps/step-06-resolve-findings.md' +thisStepFile: './step-05-adversarial-review.md' +nextStepFile: './step-06-resolve-findings.md' --- # Step 5: Adversarial Code Review diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md index f6af4697..fcc5146e 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md @@ -3,7 +3,7 @@ name: 'step-06-resolve-findings' description: 'Handle review findings interactively, apply fixes, update tech-spec with final status' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-06-resolve-findings.md' +thisStepFile: './step-06-resolve-findings.md' --- # Step 6: Resolve Findings diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md index 1e5e3f79..c321dcc7 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md @@ -2,9 +2,9 @@ name: 'step-01-understand' description: 'Analyze the requirement delta between current state and what user wants to build' -workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec' -nextStepFile: '{workflow_path}/steps/step-02-investigate.md' -skipToStepFile: '{workflow_path}/steps/step-03-generate.md' +workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec' +nextStepFile: './step-02-investigate.md' +skipToStepFile: './step-03-generate.md' templateFile: '{workflow_path}/tech-spec-template.md' wipFile: '{implementation_artifacts}/tech-spec-wip.md' --- @@ -59,7 +59,7 @@ a) **Menu Handling:** - Jump directly to the appropriate step based on `stepsCompleted`: - `[1]` → Load `{nextStepFile}` (Step 2) - `[1, 2]` → Load `{skipToStepFile}` (Step 3) - - `[1, 2, 3]` → Load `{workflow_path}/steps/step-04-review.md` (Step 4) + - `[1, 2, 3]` → Load `./step-04-review.md` (Step 4) - **[n] Archive and start fresh:** - Rename `{wipFile}` to `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md` diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md index 3dae5e61..1cb2ee40 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md @@ -2,8 +2,8 @@ name: 'step-02-investigate' description: 'Map technical constraints and anchor points within the codebase' -workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec' -nextStepFile: '{workflow_path}/steps/step-03-generate.md' +workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec' +nextStepFile: './step-03-generate.md' wipFile: '{implementation_artifacts}/tech-spec-wip.md' --- diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md index b731e566..4a33c7a1 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md @@ -2,8 +2,8 @@ name: 'step-03-generate' description: 'Build the implementation plan based on the technical mapping of constraints' -workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec' -nextStepFile: '{workflow_path}/steps/step-04-review.md' +workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec' +nextStepFile: './step-04-review.md' wipFile: '{implementation_artifacts}/tech-spec-wip.md' --- diff --git a/src/modules/cis/module.yaml b/src/modules/cis/module.yaml index 02ce7ca9..f03960d0 100644 --- a/src/modules/cis/module.yaml +++ b/src/modules/cis/module.yaml @@ -4,7 +4,6 @@ header: "Creative Innovation Suite (CIS) Module" subheader: "No custom configuration required - uses Core settings only" default_selected: false # This module will not be selected by default for new installations - # Variables from Core Config inserted: ## user_name ## communication_language