From 0d57ad84a03013a0fefc8ee35aec27c4f49d678a Mon Sep 17 00:00:00 2001 From: lihang Date: Sat, 6 Dec 2025 23:03:58 +0800 Subject: [PATCH] fix(bmm): PRD workflow step count and remove non-existent workflow references MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PRD workflow fixes: - Fix step files to show correct total (11 steps, not 10) - Fix path typo in step-01-init.md (step โ†’ steps) - Fix step-01b-continue.md completion condition (10 โ†’ 11) Documentation fixes (remove non-existent workflows): - Remove story-context references from all docs (only exists in BMGD module) - Remove validate-architecture references (no implementation) - Update workflow chains: create-story โ†’ dev-story (no story-context) - Update glossary definitions to reflect actual workflow behavior - Fix agents-guide.md Architect and SM workflow lists - Fix document-project output filename (bmm-index.md โ†’ index.md) ๐Ÿค– Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude --- src/modules/bmm/docs/agents-guide.md | 4 +--- src/modules/bmm/docs/brownfield-guide.md | 23 ++++++++----------- src/modules/bmm/docs/faq.md | 10 ++------ src/modules/bmm/docs/glossary.md | 4 ++-- src/modules/bmm/docs/quick-start.md | 9 ++++---- .../bmm/docs/workflows-implementation.md | 2 +- .../prd/steps/step-01-init.md | 6 ++--- .../prd/steps/step-01b-continue.md | 6 ++--- .../prd/steps/step-02-discovery.md | 4 ++-- .../prd/steps/step-03-success.md | 4 ++-- .../document-project/instructions.md | 2 +- 11 files changed, 31 insertions(+), 43 deletions(-) diff --git a/src/modules/bmm/docs/agents-guide.md b/src/modules/bmm/docs/agents-guide.md index 16e5d633..8e8ad7c7 100644 --- a/src/modules/bmm/docs/agents-guide.md +++ b/src/modules/bmm/docs/agents-guide.md @@ -144,7 +144,6 @@ The BMad Method Module (BMM) provides a comprehensive team of specialized AI age - `workflow-status` - Check what to do next - `create-architecture` - Produce a Scale Adaptive Architecture -- `validate-architecture` - Validate architecture document - `implementation-readiness` - Validate PRD + Architecture + Epics + UX (optional) **Communication Style:** Comprehensive yet pragmatic. Uses architectural metaphors. Balances technical depth with accessibility. Connects decisions to business value. @@ -644,7 +643,6 @@ Many workflows have optional validation workflows that perform independent revie | Validation | Agent | Validates | | -------------------------- | ----------- | ------------------------------------------ | | `implementation-readiness` | Architect | PRD + Architecture + Epics + UX (optional) | -| `validate-architecture` | Architect | Architecture document | | `validate-design` | UX Designer | UX specification and artifacts | | `validate-create-story` | SM | Story draft | @@ -976,7 +974,7 @@ Quick reference for agent selection: | **PM** | ๐Ÿ“‹ | 2 (Planning) | prd, tech-spec, epics-stories | Planning, requirements docs | | **UX Designer** | ๐ŸŽจ | 2 (Planning) | create-ux-design, validate-design | UX-heavy projects, design | | **Architect** | ๐Ÿ—๏ธ | 3 (Solutioning) | architecture, implementation-readiness | Technical design, architecture | -| **SM** | ๐Ÿƒ | 4 (Implementation) | sprint-planning, create-story, story-context | Story management, sprint coordination | +| **SM** | ๐Ÿƒ | 4 (Implementation) | sprint-planning, create-story | Story management, sprint coordination | | **DEV** | ๐Ÿ’ป | 4 (Implementation) | develop-story, code-review | Implementation, coding | | **TEA** | ๐Ÿงช | All Phases | framework, atdd, automate, trace, ci | Testing, quality assurance | | **Paige (Tech Writer)** | ๐Ÿ“š | All Phases | document-project, diagrams, validation | Documentation, diagrams | diff --git a/src/modules/bmm/docs/brownfield-guide.md b/src/modules/bmm/docs/brownfield-guide.md index 5ab15be0..17497c5c 100644 --- a/src/modules/bmm/docs/brownfield-guide.md +++ b/src/modules/bmm/docs/brownfield-guide.md @@ -250,8 +250,8 @@ Without AI-optimized documentation, workflows fail: - **tech-spec** (Quick Flow) can't auto-detect stack/patterns โ†’ Makes wrong assumptions - **PRD** (BMad Method) can't reference existing code โ†’ Designs incompatible features -- **architecture** can't build on existing structure โ†’ Suggests conflicting patterns -- **story-context** can't inject existing patterns โ†’ Dev agent rewrites working code +- **create-architecture** can't build on existing structure โ†’ Suggests conflicting patterns +- **create-story** can't provide existing pattern context โ†’ Stories lack integration guidance - **dev-story** invents implementations โ†’ Breaks existing integrations ### Key Principle @@ -370,7 +370,7 @@ When workflow-init asks about your work: ### 4. Respect Existing Patterns -Tech-spec and story-context will detect conventions. Follow them unless explicitly modernizing. +Tech-spec and create-story workflows will detect conventions from existing documentation. Follow them unless explicitly modernizing. ### 5. Plan Integration Points Explicitly @@ -446,7 +446,7 @@ Document in tech-spec/architecture: - Analyzes existing auth patterns - Confirms conventions - Creates tech-spec.md + epic + 3-5 stories -3. **Implement:** Load SM โ†’ `sprint-planning` โ†’ `create-story` โ†’ `story-context` +3. **Implement:** Load SM โ†’ `sprint-planning` โ†’ `create-story` Load DEV โ†’ `dev-story` for each story 4. **Review:** Load DEV โ†’ `code-review` @@ -512,12 +512,9 @@ Document in tech-spec/architecture: - `product-brief` - Strategic document 3. **Plan:** Load PM โ†’ `prd` (comprehensive FRs/NFRs) 4. **Solution:** - - `create-architecture` - Full system architecture - - `integration-planning` - Phased migration strategy - - `create-architecture` - Multi-tenancy architecture - - `validate-architecture` - External review + - `create-architecture` - Full system architecture including multi-tenancy design - `create-epics-and-stories` - Create epics and stories - - `implementation-readiness` - Executive approval + - `implementation-readiness` - Final validation before implementation 5. **Implement:** Phased sprint-based (50+ stories) **Time:** 3-6 months @@ -564,7 +561,7 @@ Document in tech-spec/architecture: **Solution:** 1. Ensure `document-project` captured existing architecture -2. Check `story-context` - should document integration points +2. Check story files created by `create-story` - should include integration context 3. In tech-spec/architecture - explicitly document: - Which existing modules to modify - What APIs/services to integrate with @@ -597,7 +594,7 @@ Document in tech-spec/architecture: 1. Check convention detection (Quick Spec Flow should detect patterns) 2. Review documentation - ensure `document-project` captured patterns -3. Use `story-context` - injects pattern guidance +3. Use `create-story` workflow - it loads context from existing documentation 4. Add to code-review checklist: pattern adherence, convention consistency 5. Run retrospective to identify deviations early @@ -626,9 +623,9 @@ prd # BMad Method/Enterprise tracks # Phase 3: Solutioning (BMad Method/Enterprise) # Architect agent: -architecture # Create/extend architecture +create-architecture # Create/extend architecture create-epics-and-stories # Create epics and stories (after architecture) -implementation-readiness # Final validation +implementation-readiness # Final validation # Phase 4: Implementation (All Tracks) # SM agent: diff --git a/src/modules/bmm/docs/faq.md b/src/modules/bmm/docs/faq.md index 3270f9c4..71b8e925 100644 --- a/src/modules/bmm/docs/faq.md +++ b/src/modules/bmm/docs/faq.md @@ -193,15 +193,9 @@ PRDs are for Level 2-4 projects with multiple features requiring product-level c ## Implementation -### Q: Do I need story-context for every story? +### Q: Does create-story include implementation context? -**A:** Technically no, but it's recommended. story-context provides implementation-specific guidance, references existing patterns, and injects expertise. Skip it only if: - -- Very simple story (self-explanatory) -- You're already expert in the area -- Time is extremely limited - -For Level 0-1 using tech-spec, story-context is less critical because tech-spec is already comprehensive. +**A:** Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler. ### Q: How do I mark a story as done? diff --git a/src/modules/bmm/docs/glossary.md b/src/modules/bmm/docs/glossary.md index 62735532..a85d03c2 100644 --- a/src/modules/bmm/docs/glossary.md +++ b/src/modules/bmm/docs/glossary.md @@ -187,7 +187,7 @@ backlog โ†’ drafted โ†’ ready-for-dev โ†’ in-progress โ†’ review โ†’ done - **backlog** - Story exists in epic but not yet drafted - **drafted** - Story file created by SM via create-story -- **ready-for-dev** - Story has context, ready for DEV via story-context +- **ready-for-dev** - Story drafted and reviewed, ready for DEV - **in-progress** - DEV is implementing via dev-story - **review** - Implementation complete, awaiting code-review - **done** - Completed with DoD met @@ -238,7 +238,7 @@ Markdown file containing story details: description, acceptance criteria, techni ### Story Context -Technical guidance document created via story-context workflow that provides implementation-specific context, references existing patterns, suggests approaches, and injects expertise for the specific story. +Implementation guidance embedded within story files during the create-story workflow. Provides implementation-specific context, references existing patterns, suggests approaches, and helps maintain consistency with established codebase conventions. ### Sprint Planning diff --git a/src/modules/bmm/docs/quick-start.md b/src/modules/bmm/docs/quick-start.md index fae2da8c..3aff89ef 100644 --- a/src/modules/bmm/docs/quick-start.md +++ b/src/modules/bmm/docs/quick-start.md @@ -313,11 +313,10 @@ flowchart LR direction TB D1[Per Epic:
epic context] D2[Per Story:
create-story] - D3[story-context] - D4[dev-story] - D5[code-review] - D6[SM, DEV] - D1 ~~~ D2 ~~~ D3 ~~~ D4 ~~~ D5 ~~~ D6 + D3[dev-story] + D4[code-review] + D5[SM, DEV] + D1 ~~~ D2 ~~~ D3 ~~~ D4 ~~~ D5 end P1 --> P2 diff --git a/src/modules/bmm/docs/workflows-implementation.md b/src/modules/bmm/docs/workflows-implementation.md index 39d6d591..7dd05641 100644 --- a/src/modules/bmm/docs/workflows-implementation.md +++ b/src/modules/bmm/docs/workflows-implementation.md @@ -70,7 +70,7 @@ For a visual representation of the complete workflow, see: [workflow-method-gree Stories move through these states in the sprint status file: 1. **TODO** - Story identified but not started -2. **IN PROGRESS** - Story being implemented (create-story โ†’ story-context โ†’ dev-story) +2. **IN PROGRESS** - Story being implemented (create-story โ†’ dev-story) 3. **READY FOR REVIEW** - Implementation complete, awaiting code review 4. **DONE** - Accepted and complete 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/step-01-init.md index 58b05c6f..c6846466 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/step-01-init.md @@ -1,6 +1,6 @@ # Step 1: Workflow Initialization -**Progress: Step 1 of 10** - Next: Project Discovery +**Progress: Step 1 of 11** - Next: Project Discovery ## MANDATORY EXECUTION RULES (READ FIRST): @@ -134,7 +134,7 @@ Report what was found: Do you have any other documents you'd like me to include, or shall we continue to the next step? -[C] Continue - Save this and move to Project Discovery (Step 2 of 10) +[C] Continue - Save this and move to Project Discovery (Step 2 of 11) ## SUCCESS METRICS: @@ -158,4 +158,4 @@ Do you have any other documents you'd like me to include, or shall we continue t ## NEXT STEP: -After user selects [C] to continue, load `{installed_path}/step/step-02-discovery.md` to begin the project discovery phase. +After user selects [C] to continue, load `{installed_path}/steps/step-02-discovery.md` to begin the project discovery phase. 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/step-01b-continue.md index 4d602e82..cea3b465 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/step-01b-continue.md @@ -74,7 +74,7 @@ Based on `lastStep` value, determine which step to load next: - If `lastStep = 2` โ†’ Load `./step-03-success.md` - If `lastStep = 3` โ†’ Load `./step-04-journeys.md` - Continue this pattern for all steps -- If `lastStep = 10` โ†’ Workflow already complete +- If `lastStep = 11` โ†’ Workflow already complete ### 5. Present Continuation Options @@ -103,10 +103,10 @@ After presenting current progress, ask: ## WORKFLOW ALREADY COMPLETE? -If `lastStep = 10` (final step completed): +If `lastStep = 11` (final step completed): "Great news! It looks like we've already completed the PRD workflow for {{project_name}}. -The final document is ready at {output_folder}/prd.md with all sections completed through step 10. +The final document is ready at {output_folder}/prd.md with all sections completed through step 11. Would you like me to: 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 index 5a023154..ad90308a 100644 --- 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 @@ -1,6 +1,6 @@ # Step 2: Project & Domain Discovery -**Progress: Step 2 of 10** - Next: Success Criteria Definition +**Progress: Step 2 of 11** - Next: Success Criteria Definition ## MANDATORY EXECUTION RULES (READ FIRST): @@ -206,7 +206,7 @@ Show the generated content to the user and present: **What would you like to do?** [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 10)" +[C] Continue - Save this and move to Success Criteria Definition (Step 3 of 11)" ### 8. Handle Menu Selection 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/step-03-success.md index aa4d30b8..b3526b53 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/step-03-success.md @@ -1,6 +1,6 @@ # Step 3: Success Criteria Definition -**Progress: Step 3 of 10** - Next: User Journey Mapping +**Progress: Step 3 of 11** - Next: User Journey Mapping ## MANDATORY EXECUTION RULES (READ FIRST): @@ -204,7 +204,7 @@ Show the generated content and present choices: **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 10)" +[C] Continue - Save success criteria and move to User Journey Mapping (Step 4 of 11)" ### 9. Handle Menu Selection diff --git a/src/modules/bmm/workflows/document-project/instructions.md b/src/modules/bmm/workflows/document-project/instructions.md index 5f8b2139..526a462b 100644 --- a/src/modules/bmm/workflows/document-project/instructions.md +++ b/src/modules/bmm/workflows/document-project/instructions.md @@ -196,7 +196,7 @@ Your choice [1/2/3]: - Mode: {{workflow_mode}} - Scan Level: {{scan_level}} -- Output: {output_folder}/bmm-index.md and related files +- Output: {output_folder}/index.md and related files {{#if status_file_found}} **Status Updated:**