From 0f126b7f87516fd62e30f495e438380fbc6596f9 Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Tue, 14 Oct 2025 19:58:44 -0500 Subject: [PATCH] consolidated prd isntruction --- .../workflows/2-plan/prd/instructions-lg.md | 272 -------- .../workflows/2-plan/prd/instructions-med.md | 259 -------- .../bmm/workflows/2-plan/prd/instructions.md | 622 ++++++++++++++++++ .../bmm/workflows/2-plan/prd/workflow.yaml | 27 +- .../3-solutioning/tech-spec/README.md | 2 +- 5 files changed, 634 insertions(+), 548 deletions(-) delete mode 100644 src/modules/bmm/workflows/2-plan/prd/instructions-lg.md delete mode 100644 src/modules/bmm/workflows/2-plan/prd/instructions-med.md create mode 100644 src/modules/bmm/workflows/2-plan/prd/instructions.md diff --git a/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md b/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md deleted file mode 100644 index 753369a4..00000000 --- a/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md +++ /dev/null @@ -1,272 +0,0 @@ -# PRD Workflow - Large Projects (Level 3-4) - - - -The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {installed_path}/workflow.yaml -This is the LARGE instruction set for Level 3-4 projects - full PRD + architect handoff -Project analysis already completed - proceeding with comprehensive requirements -NO TECH-SPEC - architecture handled by specialist workflow -Uses prd_template for PRD output, epics_template for epics output -If users mention technical details, append to technical_preferences with timestamp - - - -Load bmm-workflow-status.md -Confirm Level 3-4 - Full product or platform - - - Load existing PRD.md and check completion status - Found existing work. Would you like to: - -1. Review what's done and continue -2. Modify existing sections -3. Start fresh - - If continuing, skip to first incomplete section - - - - Check `output_folder` for `product_brief`, `market_research`, and other docs. - -For Level 3-4, Product Brief is STRONGLY recommended - -Load prd_template from workflow.yaml - -Get comprehensive description of the project vision. - -description - - - - - - -What is the deployment intent? - -- MVP for early users -- Production SaaS/application -- Enterprise system -- Platform/ecosystem - - -deployment_intent - -**Goal Guidelines**: - -- Level 3: 3-5 strategic goals -- Level 4: 5-7 strategic goals - -Each goal should be measurable and outcome-focused. - -goals - - - - - -1-2 paragraphs on problem, current situation, why now. - -context -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - -**FR Guidelines**: - -- Level 3: 12-20 FRs -- Level 4: 20-30 FRs - -Group related features logically. - -functional_requirements -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - -Match NFRs to deployment intent (8-12 NFRs) - -non_functional_requirements - - - - - -**Journey Requirements**: - -- Level 3: 2-3 detailed journeys -- Level 4: 3-5 comprehensive journeys - -Map complete user flows with decision points. - -user_journeys -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - -8-10 UX principles guiding all interface decisions. - -ux_principles - - - - - -**Epic Guidelines**: - -- Level 3: 2-5 epics (12-40 stories) -- Level 4: 5+ epics (40+ stories) - -Each epic delivers significant value. - -epics -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - -Load epics_template from workflow.yaml - -Create separate epics.md with full story hierarchy - -epic_overview - - - -Generate Epic {{epic_number}} with expanded goals, capabilities, success criteria. - -Generate all stories with: - -- User story format -- Prerequisites -- Acceptance criteria (3-8 per story) -- Technical notes (high-level only) - -epic\_{{epic_number}}\_details -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - - - -List features/ideas preserved for future phases. - -out_of_scope - - - - - -Only document ACTUAL assumptions from discussion. - -assumptions_and_dependencies - - - - - -## Next Steps for {{project_name}} - -Since this is a Level {{project_level}} project, you need architecture before stories. - -**Start new chat with architect and provide:** - -1. This PRD: `{{default_output_file}}` -2. Epic structure: `{{epics_output_file}}` -3. Input documents: {{input_documents}} - -**Ask architect to:** - -- Run `architecture` workflow -- Consider reference architectures -- Generate solution fragments -- Create solution-architecture.md - -## Complete Next Steps Checklist - -Generate comprehensive checklist based on project analysis - -### Phase 1: Architecture and Design - -- [ ] **Run architecture workflow** (REQUIRED) - - Command: `workflow architecture` - - Input: PRD.md, epics.md - - Output: solution-architecture.md - - - -- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems) - Command: `workflow plan-project` then select "UX specification" - Or continue within this workflow if UI-heavy - Input: PRD.md, epics.md, solution-architecture.md (once available) - Output: ux-specification.md - Optional: AI Frontend Prompt for rapid prototyping - Note: Creates comprehensive UX/UI spec including IA, user flows, components - -Update workflow status file to mark ux-spec as next step -In status file, set next_action: "Run UX specification workflow" -In status file, set next_command: "ux-spec" -In status file, set next_agent: "PM" -Add to decisions log: "PRD complete. UX workflow required due to UI components." - - -### Phase 2: Detailed Planning - -- [ ] **Generate detailed user stories** - - Command: `workflow generate-stories` - - Input: epics.md + solution-architecture.md - - Output: user-stories.md with full acceptance criteria - -- [ ] **Create technical design documents** - - Database schema - - API specifications - - Integration points - -- [ ] **Define testing strategy** - - Unit test approach - - Integration test plan - - UAT criteria - -### Phase 3: Development Preparation - -- [ ] **Set up development environment** - - Repository structure - - CI/CD pipeline - - Development tools - -- [ ] **Create sprint plan** - - Story prioritization - - Sprint boundaries - - Resource allocation - -- [ ] **Establish monitoring and metrics** - - Success metrics from PRD - - Technical monitoring - - User analytics - -Project Planning Complete! Next immediate action: - -1. Start architecture workflow with the architect in a new context window -2. Create UX specification (if UI-heavy project) -3. Generate AI Frontend Prompt (if UX complete) -4. Review all outputs with stakeholders -5. Begin detailed story generation -6. Exit workflow - -Which would you like to proceed with? - - - {project-root}/bmad/bmm/workflows/2-plan/ux/workflow.yaml - Pass mode="integrated" with Level 3-4 context - - - - {project-root}/bmad/bmm/tasks/ai-fe-prompt.md - - - - - diff --git a/src/modules/bmm/workflows/2-plan/prd/instructions-med.md b/src/modules/bmm/workflows/2-plan/prd/instructions-med.md deleted file mode 100644 index abb277e8..00000000 --- a/src/modules/bmm/workflows/2-plan/prd/instructions-med.md +++ /dev/null @@ -1,259 +0,0 @@ -# PRD Workflow - Medium Projects (Level 1-2) - - - -The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {installed_path}/workflow.yaml -This is the MEDIUM instruction set for Level 1-2 projects - minimal PRD + solutioning handoff -Project analysis already completed - proceeding with focused requirements -Uses prd_template for PRD output, epics_template for epics output -NO TECH-SPEC - solutioning handled by specialist workflow -If users mention technical details, append to technical_preferences with timestamp - - - -Load bmm-workflow-status.md -Confirm Level 1-2 - Feature or small system - - - Load existing PRD.md and check completion status - Found existing work. Would you like to: - -1. Review what's done and continue -2. Modify existing sections -3. Start fresh - - If continuing, skip to first incomplete section - - - - Check `output_folder` for existing docs. Ask user if they have a Product Brief. - -Load prd_template from workflow.yaml -Discuss with them to get the core idea of what they're building - -description - - - - - - -What is the deployment intent? - -- Demo/POC -- MVP for early users -- Production app - - -deployment_intent - -**Goal Guidelines**: - -- Level 1: 1-2 primary goals -- Level 2: 2-3 primary goals - -goals - - - - - -**Keep it brief**: 1 paragraph on why this matters now. - -context - - - - - -**FR Guidelines**: - -- Level 1: 3-8 FRs -- Level 2: 8-15 FRs - -**Format**: `FR001: [user capability]` - -functional_requirements -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - -Focus on critical NFRs only (3-5 max) - -non_functional_requirements - - - - - -- Level 2: 1 simple user journey for primary use case - -user_journeys - - - - - -3-5 key UX principles if relevant - -ux_principles - - - - - -**Epic Guidelines**: - -- Level 1: 1 epic with 1-10 stories -- Level 2: 1-2 epics with 5-15 stories total - -Create simple epic list with story titles. - -epics - -Load epics_template from workflow.yaml - -Generate epic-stories.md with basic story structure. - -epic_stories -{project-root}/bmad/core/tasks/adv-elicit.xml - - - - - -List features/ideas preserved for future phases. - -out_of_scope - - - - - -Only document ACTUAL assumptions from discussion. - -assumptions_and_dependencies - - - - - -Offer to run cohesion validation - -Planning complete! Before proceeding to next steps, would you like to validate project cohesion? - -**Cohesion Validation** checks: - -- PRD-Tech Spec alignment -- Feature sequencing and dependencies -- Infrastructure setup order (greenfield) -- Integration risks and rollback plans (brownfield) -- External dependencies properly planned -- UI/UX considerations (if applicable) - -Run cohesion validation? (y/n) - - - Load {installed_path}/checklist.md - Review all outputs against "Cohesion Validation (All Levels)" section - Validate PRD sections, then cohesion sections A-H as applicable - Apply Section B (Greenfield) or Section C (Brownfield) based on field_type - Include Section E (UI/UX) if UI components exist - Generate comprehensive validation report with findings - - - - - - - -## Next Steps for {{project_name}} - -Since this is a Level {{project_level}} project, you need solutioning before implementation. - -**Start new chat with solutioning workflow and provide:** - -1. This PRD: `{{default_output_file}}` -2. Epic structure: `{{epics_output_file}}` -3. Input documents: {{input_documents}} - -**Ask solutioning workflow to:** - -- Run `3-solutioning` workflow -- Generate solution-architecture.md -- Create per-epic tech specs - -## Complete Next Steps Checklist - -Generate comprehensive checklist based on project analysis - -### Phase 1: Solution Architecture and Design - -- [ ] **Run solutioning workflow** (REQUIRED) - - Command: `workflow solution-architecture` - - Input: PRD.md, epic-stories.md - - Output: solution-architecture.md, tech-spec-epic-N.md files - - - -- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems) - Command: `workflow plan-project` then select "UX specification" - Or continue within this workflow if UI-heavy - Input: PRD.md, epic-stories.md, solution-architecture.md (once available) - Output: ux-specification.md - Optional: AI Frontend Prompt for rapid prototyping - Note: Creates comprehensive UX/UI spec including IA, user flows, components - -Update workflow status file to mark ux-spec as next step -In status file, set next_action: "Run UX specification workflow" -In status file, set next_command: "ux-spec" -In status file, set next_agent: "PM" -Add to decisions log: "PRD complete. UX workflow required due to UI components." - - -### Phase 2: Detailed Planning - -- [ ] **Generate detailed user stories** - - Command: `workflow generate-stories` - - Input: epic-stories.md + solution-architecture.md - - Output: user-stories.md with full acceptance criteria - -- [ ] **Create technical design documents** - - Database schema - - API specifications - - Integration points - -### Phase 3: Development Preparation - -- [ ] **Set up development environment** - - Repository structure - - CI/CD pipeline - - Development tools - -- [ ] **Create sprint plan** - - Story prioritization - - Sprint boundaries - - Resource allocation - -Project Planning Complete! Next immediate action: - -1. Start solutioning workflow -2. Create UX specification (if UI-heavy project) -3. Generate AI Frontend Prompt (if UX complete) -4. Review all outputs with stakeholders -5. Begin detailed story generation -6. Exit workflow - -Which would you like to proceed with? - - - {project-root}/bmad/bmm/workflows/2-plan/ux/workflow.yaml - Pass mode="integrated" with Level 1-2 context - - - - - {project-root}/bmad/bmm/tasks/ai-fe-prompt.md - - - - - - diff --git a/src/modules/bmm/workflows/2-plan/prd/instructions.md b/src/modules/bmm/workflows/2-plan/prd/instructions.md new file mode 100644 index 00000000..666c88de --- /dev/null +++ b/src/modules/bmm/workflows/2-plan/prd/instructions.md @@ -0,0 +1,622 @@ +# PRD Workflow - Unified Instructions (Level 2-4) + + + +The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {installed_path}/workflow.yaml +This is the UNIFIED instruction set for Level 2-4 projects - scale-adaptive PRD +Level 0-1 use tech-spec workflow - this workflow is ONLY for Level 2-4 +Uses prd_template for PRD output, epics_template for epics.md output +NO TECH-SPEC in this workflow - architecture/solutioning handled by specialist workflows +If users mention technical details, append to technical_preferences + + + +**Understanding template-output tags:** + +`section_name` +→ Fills a SECTION within the PRD template (creates/updates PRD.md) +→ Example: goals fills the "Goals" section in PRD.md + +`content_description` +→ Creates a SEPARATE PHYSICAL FILE using the specified template structure +→ This is NOT optional - you MUST create this file +→ Example: epic_details creates a new file called epics.md + +**Critical:** When you see `file="filename.md"`, you must physically create that file - it is a required deliverable! + + + + +Load bmm-workflow-status.md +Confirm project_level is 2, 3, or 4 + + + This workflow is for Level 2-4 only. Level 0-1 should use tech-spec workflow. + Exit and redirect to tech-spec workflow + + + + Load existing PRD.md and check completion status + Found existing work. Would you like to: + +1. Review what's done and continue +2. Modify existing sections +3. Start fresh + + If continuing, skip to first incomplete section + + + + Check `output_folder` for existing docs. + + + Product Brief is STRONGLY recommended for Level 3-4 + + + + Ask if they have a Product Brief (optional but helpful) + + +Load prd_template from workflow.yaml + + + Discuss to get core idea of what they're building + + + + Get comprehensive description of the project vision + + +description + + + + + + +What is the deployment intent? + + +- Demo/POC +- MVP for early users +- Production app + + + +- MVP for early users +- Production SaaS/application +- Enterprise system +- Platform/ecosystem + + + +deployment_intent + +**Goal Guidelines (scale-adaptive):** + +- **Level 2:** 2-3 primary goals +- **Level 3:** 3-5 strategic goals (measurable, outcome-focused) +- **Level 4:** 5-7 strategic goals (measurable, outcome-focused) + + + Each goal should be measurable and outcome-focused + + +goals + + + + + + + **Keep it brief:** 1 paragraph on why this matters now. + Focus: Immediate problem and solution value + + + + **Comprehensive context:** 1-2 paragraphs on problem, current situation, why now. + Focus: Strategic positioning and market context + + +context + + + {project-root}/bmad/core/tasks/adv-elicit.xml + + + + + + +**FR Guidelines (scale-adaptive):** + +- **Level 2:** 8-15 FRs (focused set - what's essential to launch) +- **Level 3:** 12-20 FRs (comprehensive - complete product vision) +- **Level 4:** 20-30 FRs (comprehensive - full platform capabilities) + + + Group related features by capability area. + Focus on core functionality needed for MVP. + + + + Group features logically across all domains. + Cover complete product vision with clear categorization. + + +**Format:** `FR001: [user capability]` + +functional_requirements +{project-root}/bmad/core/tasks/adv-elicit.xml + + + + + +**NFR Guidelines (scale-adaptive):** + +- **Level 2:** 3-5 NFRs (critical only - essential for deployment) +- **Level 3:** 8-12 NFRs (comprehensive - matched to deployment intent) +- **Level 4:** 8-12 NFRs (comprehensive - enterprise-grade requirements) + + + Focus on critical NFRs only (performance, security, availability basics). + + + + Match NFRs to deployment intent. Include scalability, monitoring, compliance, etc. + + +non_functional_requirements + + + + + +**Journey Guidelines (scale-adaptive):** + +- **Level 2:** 0-1 simple journey (optional - primary use case happy path) +- **Level 3:** 2-3 detailed journeys (required - complete flows with decision points) +- **Level 4:** 3-5 comprehensive journeys (required - all personas and edge cases) + + + Would you like to document a user journey for the primary use case? (recommended but optional) + + Create 1 simple journey showing the happy path. + + + + + User journeys are REQUIRED for Level 3-4 + Map complete user flows with decision points, alternatives, and edge cases. + + +user_journeys + + + {project-root}/bmad/core/tasks/adv-elicit.xml + + + + + + +**UX Principles Guidelines (scale-adaptive):** + +- **Level 2:** 3-5 key principles (optional - if UI-heavy) +- **Level 3:** 8-10 principles (required - guiding all interface decisions) +- **Level 4:** 8-10 principles (required - comprehensive design system guidance) + + + Does this project have significant UI components? If so, document 3-5 key UX principles. + + + + UX principles are REQUIRED for Level 3-4 + Document 8-10 comprehensive principles guiding all interface decisions. + + +ux_principles + + + + + +**Epic Guidelines (scale-adaptive):** + +- **Level 2:** 1-2 epics with 5-15 stories total +- **Level 3:** 2-5 epics with 12-40 stories total +- **Level 4:** 5+ epics with 40+ stories total + + + Focus: Get to implementation quickly with simple epic grouping. + Create simple epic list showing how work is organized. + + + + Focus: Comprehensive planning for phased rollout. + Each epic should deliver significant value and be independently deployable where possible. + + +**Create epic summary list for PRD:** + +- Epic name +- Epic goal (1-2 sentences) +- Story count estimate +- Priority/sequence + +epics + + + {project-root}/bmad/core/tasks/adv-elicit.xml + + + + {project-root}/bmad/core/tasks/adv-elicit.xml + + + + + + +REQUIRED FOR ALL LEVELS: Create separate epics.md with full story hierarchy +This is a SEPARATE FILE from PRD.md - you MUST physically create this file + +Load epics_template from workflow.yaml: {installed_path}/epics-template.md + +USE THIS TEMPLATE to create {epics_output_file} (epics.md) with the following structure: + +- Header with project metadata (project_name, user_name, date, project_level, target_scale) +- Epic Overview section (high-level summary of all epics and delivery strategy) +- Epic Details section (one subsection per epic with full story breakdown) + + +**Content Requirements (scale-adaptive):** + + + **Level 2 - Basic story structure:** + +For each epic, include: + +- Epic name and goal +- Story list with: - User story format: "As a [user], I want [goal], so that [benefit]" - Basic acceptance criteria (2-3 per story) - Story dependencies (if any) + + + + **Level 3-4 - Comprehensive story structure:** + +For each epic, include: + +- Epic name, goal, and expanded description +- Success criteria for the epic +- Story list with: - User story format: "As a [user], I want [goal], so that [benefit]" - Prerequisites and dependencies - Detailed acceptance criteria (3-8 per story) - Technical notes (high-level implementation considerations) - Priority and effort estimate (if known) + + + +**Structure to use:** + +# {{project_name}} - Epic Breakdown + +**Author:** {{user_name}} +**Date:** {{date}} +**Project Level:** {{project_level}} +**Target Scale:** {{target_scale}} + +--- + +## Epic Overview + +[High-level summary of all epics, delivery strategy, and phasing] + +--- + +## Epic Details + +### Epic 1: [Epic Name] + +**Goal:** [Epic goal statement] + + +**Success Criteria:** +- [Epic-level success criteria] + + +**Stories:** + +#### Story 1.1: [Story Title] + +**User Story:** As a [user], I want [goal], so that [benefit] + + +**Prerequisites:** +- [Dependencies or setup needed] + + +**Acceptance Criteria:** + +- [ ] [Criterion 1] +- [ ] [Criterion 2] +- [ ] [Criterion 3] + + +**Technical Notes:** +- [High-level implementation considerations] + +**Priority:** [High/Medium/Low] +**Estimated Effort:** [S/M/L/XL or story points] + + +[Repeat for all stories in epic] + +--- + +[Repeat Epic Details section for all epics] + + + + + {project-root}/bmad/core/tasks/adv-elicit.xml + + +Verify epics.md was created in {output_folder} + +Epic breakdown file created at {epics_output_file}. + + +Generated {{epic_count}} epic(s) with approximately {{story_count}} stories. + + + +Generated {{epic_count}} epics with approximately {{story_count}} stories across all epics. + + +Would you like to review the epic structure before continuing? (y/n) + + + + + + + Any features or ideas to preserve for future phases? (optional but recommended) + + + + Document features/ideas preserved for future phases + + +List features, capabilities, or ideas that are explicitly out of scope for this phase but valuable for future consideration. + +out_of_scope + + + + + + + Only document ACTUAL assumptions that came up in discussion (optional) + + + + Document all assumptions and dependencies + Include: + - Technical assumptions + - Business assumptions + - External dependencies + - Resource assumptions + + +assumptions_and_dependencies + + + + + +Verify all required files were created: + +- [ ] PRD.md exists at {default_output_file} +- [ ] epics.md exists at {epics_output_file} + + + CRITICAL: Required files missing! + Return to appropriate step and create missing files + + +All required documents created successfully. Would you like to run a validation check before proceeding to next phase? (y/n) + + + Validate PRD completeness: + - All required sections filled + - Epic count matches project level expectations + - Story count aligns with project level scale + - Cross-references between PRD and epics.md are consistent + +Generate brief validation summary with any warnings or suggestions + + + + + + +## Next Steps for {{project_name}} + + +Since this is a Level 2 project, you need **solutioning** before implementation. + +**Start new chat with solutioning workflow and provide:** + +1. This PRD: `{{default_output_file}}` +2. Epic structure: `{{epics_output_file}}` +3. Input documents: {{input_documents}} + +**Ask solutioning workflow to:** + +- Run `3-solutioning` workflow +- Generate solution-architecture.md +- Create per-epic tech specs as needed + +## Complete Next Steps Checklist + +### Phase 1: Solution Architecture and Design + +- [ ] **Run solutioning workflow** (REQUIRED) + - Command: `workflow solution-architecture` + - Input: PRD.md, epics.md + - Output: solution-architecture.md, tech-spec-epic-N.md files (as needed) + + +- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems) + - Command: `workflow plan-project` then select "UX specification" + - Or continue within this workflow if UI-heavy + - Input: PRD.md, epics.md, solution-architecture.md (once available) + - Output: ux-specification.md + - Optional: AI Frontend Prompt for rapid prototyping + - Note: Creates comprehensive UX/UI spec including IA, user flows, components + +Update workflow status file to mark ux-spec as potential next step + + +### Phase 2: Detailed Planning + +- [ ] **Generate detailed user stories** (if not already comprehensive) + - Command: `workflow generate-stories` + - Input: epics.md + solution-architecture.md + - Output: user-stories.md with full acceptance criteria + +- [ ] **Create technical design documents** + - Database schema + - API specifications + - Integration points + +### Phase 3: Development Preparation + +- [ ] **Set up development environment** + - Repository structure + - CI/CD pipeline + - Development tools + +- [ ] **Create sprint plan** + - Story prioritization + - Sprint boundaries + - Resource allocation + +Project Planning Complete! Next immediate action: + +1. Start solutioning workflow +2. Create UX specification (if UI-heavy project) +3. Generate AI Frontend Prompt (if UX complete) +4. Review all outputs with stakeholders +5. Begin detailed story generation +6. Exit workflow + +Which would you like to proceed with? + + + {project-root}/bmad/bmm/workflows/2-plan/ux/workflow.yaml + Pass mode="integrated" with Level 2 context + + + + {project-root}/bmad/bmm/tasks/ai-fe-prompt.md + + + + +Since this is a Level {{project_level}} project, you need **solutioning** before stories. + +**Start new chat with solutioning workflow and provide:** + +1. This PRD: `{{default_output_file}}` +2. Epic structure: `{{epics_output_file}}` +3. Input documents: {{input_documents}} + +**Ask solutioning workflow to:** + +- Run `solution-architecture` workflow +- Consider reference architectures and technology patterns +- Generate solution-architecture.md +- Create per-epic tech specs + +## Complete Next Steps Checklist + +### Phase 1: Solution Architecture and Design + +- [ ] **Run solutioning workflow** (REQUIRED) + - Command: `workflow solution-architecture` + - Input: PRD.md, epics.md + - Output: solution-architecture.md, tech-spec-epic-N.md files + + +- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems) + - Command: `workflow plan-project` then select "UX specification" + - Or continue within this workflow if UI-heavy + - Input: PRD.md, epics.md, solution-architecture.md (once available) + - Output: ux-specification.md + - Optional: AI Frontend Prompt for rapid prototyping + - Note: Creates comprehensive UX/UI spec including IA, user flows, components + +Update workflow status file to mark ux-spec as next step +In status file, set next_action: "Run UX specification workflow" +In status file, set next_command: "ux-spec" +In status file, set next_agent: "PM" +Add to decisions log: "PRD complete. UX workflow required due to UI components." + + +### Phase 2: Detailed Planning + +- [ ] **Generate detailed user stories** + - Command: `workflow generate-stories` + - Input: epics.md + solution-architecture.md + - Output: user-stories.md with full acceptance criteria + +- [ ] **Create technical design documents** + - Database schema + - API specifications + - Integration points + +- [ ] **Define testing strategy** + - Unit test approach + - Integration test plan + - UAT criteria + +### Phase 3: Development Preparation + +- [ ] **Set up development environment** + - Repository structure + - CI/CD pipeline + - Development tools + +- [ ] **Create sprint plan** + - Story prioritization + - Sprint boundaries + - Resource allocation + +- [ ] **Establish monitoring and metrics** + - Success metrics from PRD + - Technical monitoring + - User analytics + +Project Planning Complete! Next immediate action: + +1. Start solutioning workflow (solution-architecture) in a new context window +2. Create UX specification (if UI-heavy project) +3. Generate AI Frontend Prompt (if UX complete) +4. Review all outputs with stakeholders +5. Begin detailed story generation +6. Exit workflow + +Which would you like to proceed with? + + + {project-root}/bmad/bmm/workflows/2-plan/ux/workflow.yaml + Pass mode="integrated" with Level 3-4 context + + + + {project-root}/bmad/bmm/tasks/ai-fe-prompt.md + + + + + + diff --git a/src/modules/bmm/workflows/2-plan/prd/workflow.yaml b/src/modules/bmm/workflows/2-plan/prd/workflow.yaml index 1223e38a..9e015f5c 100644 --- a/src/modules/bmm/workflows/2-plan/prd/workflow.yaml +++ b/src/modules/bmm/workflows/2-plan/prd/workflow.yaml @@ -1,6 +1,6 @@ # Product Requirements Document (PRD) Workflow name: prd -description: "Scale-adaptive PRD workflow for project levels 1-4. Level 1-2: focused PRD + solutioning handoff. Level 3-4: full PRD with epics + architect handoff. Automatically adjusts scope based on project complexity." +description: "Scale-adaptive PRD workflow for project levels 2-4. All levels hand off to solutioning workflow (solution-architecture). Automatically adjusts scope based on project complexity. Note: Level 0-1 use tech-spec workflow." author: "BMad" # Critical variables from config @@ -13,9 +13,8 @@ date: system-generated # Workflow components installed_path: "{project-root}/bmad/bmm/workflows/2-plan/prd" -# Instructions - routes to appropriate level-based instructions -instructions_med: "{installed_path}/instructions-med.md" # Level 1-2 -instructions_lg: "{installed_path}/instructions-lg.md" # Level 3-4 +# Instructions - unified for all levels (2-4) with adaptive logic +instructions: "{installed_path}/instructions.md" # Level 2-4 (scale-adaptive) # Templates prd_template: "{installed_path}/prd-template.md" @@ -35,10 +34,9 @@ recommended_inputs: # Scale parameters - adaptive by project level scale_parameters: - level_1: "1-10 stories, 1 epic, minimal PRD + solutioning handoff" level_2: "5-15 stories, 1-2 epics, focused PRD + solutioning handoff" - level_3: "12-40 stories, 2-5 epics, full PRD + architect handoff" - level_4: "40+ stories, 5+ epics, enterprise PRD + architect handoff" + level_3: "12-40 stories, 2-5 epics, comprehensive PRD + solutioning handoff" + level_4: "40+ stories, 5+ epics, enterprise PRD + solutioning handoff" # Claude Code integration points claude_code_enhancements: @@ -64,24 +62,21 @@ frameworks: web_bundle: name: "prd" - description: "Scale-adaptive PRD workflow for project levels 1-4. Level 1-2: focused PRD + solutioning handoff. Level 3-4: full PRD with epics + architect handoff. Automatically adjusts scope based on project complexity." + description: "Scale-adaptive PRD workflow for project levels 2-4. All levels hand off to solutioning workflow (solution-architecture). Automatically adjusts scope based on project complexity. Note: Level 0-1 use tech-spec workflow." author: "BMad" - # Note: Router workflow will load appropriate instructions based on level - instructions_med: "bmad/bmm/workflows/2-plan/prd/instructions-med.md" - instructions_lg: "bmad/bmm/workflows/2-plan/prd/instructions-lg.md" + # Single unified instruction file with adaptive logic + instructions: "bmad/bmm/workflows/2-plan/prd/instructions.md" use_advanced_elicitation: true web_bundle_files: - - "bmad/bmm/workflows/2-plan/prd/instructions-med.md" - - "bmad/bmm/workflows/2-plan/prd/instructions-lg.md" + - "bmad/bmm/workflows/2-plan/prd/instructions.md" - "bmad/bmm/workflows/2-plan/prd/prd-template.md" - "bmad/bmm/workflows/_shared/bmm-workflow-status-template.md" - "bmad/bmm/workflows/2-plan/prd/epics-template.md" # Scale parameters - adaptive by project level scale_parameters: - level_1: "1-10 stories, 1 epic, minimal PRD + solutioning handoff" level_2: "5-15 stories, 1-2 epics, focused PRD + solutioning handoff" - level_3: "12-40 stories, 2-5 epics, full PRD + architect handoff" - level_4: "40+ stories, 5+ epics, enterprise PRD + architect handoff" + level_3: "12-40 stories, 2-5 epics, comprehensive PRD + solutioning handoff" + level_4: "40+ stories, 5+ epics, enterprise PRD + solutioning handoff" # Product frameworks available frameworks: - "Jobs-to-be-Done" diff --git a/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md b/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md index 052f1363..003d09f7 100644 --- a/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md +++ b/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md @@ -2,7 +2,7 @@ ## Overview -Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping. Creates detailed implementation guidance that bridges business requirements with technical execution. +Generate a comprehensive Technical Specification for a single epic from PRD, Epics file and Architecture to produce a document with full acceptance criteria and traceability mapping. Creates detailed implementation guidance that bridges business requirements with technical execution. ## Key Features