diff --git a/src/core/agents/bmad-master.agent.yaml b/src/core/agents/bmad-master.agent.yaml index efba6450..bba8be22 100644 --- a/src/core/agents/bmad-master.agent.yaml +++ b/src/core/agents/bmad-master.agent.yaml @@ -32,7 +32,7 @@ agent: description: "List Workflows" - trigger: "party-mode" - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: "Group chat with all agents" # Empty prompts section (no custom prompts for this agent) diff --git a/src/core/agents/bmad-web-orchestrator.agent.xml b/src/core/agents/bmad-web-orchestrator.agent.xml index 7f192627..cc315ad4 100644 --- a/src/core/agents/bmad-web-orchestrator.agent.xml +++ b/src/core/agents/bmad-web-orchestrator.agent.xml @@ -105,7 +105,7 @@ Show numbered command list List all available agents with their capabilities Transform into a specific agent - Enter group chat with all agents + Enter group chat with all agents simultaneously Push agent to perform advanced elicitation Exit current session diff --git a/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml b/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml index 42d4a195..56cad220 100644 --- a/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +++ b/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml @@ -49,5 +49,5 @@ agent: # Core workflow that exists - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: "Multi-agent security discussion" diff --git a/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml b/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml index 1fb3c1aa..7e76fe80 100644 --- a/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +++ b/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml @@ -53,5 +53,5 @@ agent: description: "Brainstorm trend implications" - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: "Discuss trends with other agents" diff --git a/src/modules/bmgd/agents/game-architect.agent.yaml b/src/modules/bmgd/agents/game-architect.agent.yaml index 318e2fe2..0e3a8fab 100644 --- a/src/modules/bmgd/agents/game-architect.agent.yaml +++ b/src/modules/bmgd/agents/game-architect.agent.yaml @@ -25,7 +25,7 @@ agent: description: Produce a Scale Adaptive Game Architecture - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmgd/agents/game-designer.agent.yaml b/src/modules/bmgd/agents/game-designer.agent.yaml index 95e63b4c..cac3c6ae 100644 --- a/src/modules/bmgd/agents/game-designer.agent.yaml +++ b/src/modules/bmgd/agents/game-designer.agent.yaml @@ -32,7 +32,7 @@ agent: description: 5. Create Narrative Design Document (story-driven games) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmgd/agents/game-dev.agent.yaml b/src/modules/bmgd/agents/game-dev.agent.yaml index 01e7f6cd..7073e107 100644 --- a/src/modules/bmgd/agents/game-dev.agent.yaml +++ b/src/modules/bmgd/agents/game-dev.agent.yaml @@ -32,7 +32,7 @@ agent: description: "Mark story done after DoD complete" - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmgd/agents/game-scrum-master.agent.yaml b/src/modules/bmgd/agents/game-scrum-master.agent.yaml index 5f24e22f..7203482e 100644 --- a/src/modules/bmgd/agents/game-scrum-master.agent.yaml +++ b/src/modules/bmgd/agents/game-scrum-master.agent.yaml @@ -67,7 +67,7 @@ agent: description: (Optional) Navigate significant changes during game dev sprint - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/analyst.agent.yaml b/src/modules/bmm/agents/analyst.agent.yaml index a581f011..eb0bc7c4 100644 --- a/src/modules/bmm/agents/analyst.agent.yaml +++ b/src/modules/bmm/agents/analyst.agent.yaml @@ -40,7 +40,7 @@ agent: description: Document your existing project (optional, but recommended for existing brownfield project efforts) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/architect.agent.yaml b/src/modules/bmm/agents/architect.agent.yaml index c8cc6b78..fc862745 100644 --- a/src/modules/bmm/agents/architect.agent.yaml +++ b/src/modules/bmm/agents/architect.agent.yaml @@ -23,7 +23,7 @@ agent: description: Get workflow status or initialize a workflow if not already done (optional) - trigger: create-architecture - workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/workflow.yaml" + exec: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/workflow.md" description: Create an Architecture Document to Guide Development of a PRD (required for BMad Method projects) - trigger: validate-architecture @@ -43,7 +43,7 @@ agent: description: Create data flow diagram (Excalidraw) (Use any time you need a diagram) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/pm.agent.yaml b/src/modules/bmm/agents/pm.agent.yaml index 2c6d4d8e..8c4ac559 100644 --- a/src/modules/bmm/agents/pm.agent.yaml +++ b/src/modules/bmm/agents/pm.agent.yaml @@ -41,7 +41,7 @@ agent: ide-only: true - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml b/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml index aeee5630..c909df4b 100644 --- a/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml +++ b/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml @@ -32,5 +32,5 @@ agent: description: Review code and improve it (Highly Recommended, use fresh context and different LLM for best results) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring in other experts when I need specialized backup diff --git a/src/modules/bmm/agents/sm.agent.yaml b/src/modules/bmm/agents/sm.agent.yaml index fa04e7cd..8be3ee66 100644 --- a/src/modules/bmm/agents/sm.agent.yaml +++ b/src/modules/bmm/agents/sm.agent.yaml @@ -46,7 +46,7 @@ agent: description: Execute correct-course task (When implementation is off-track) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/tea.agent.yaml b/src/modules/bmm/agents/tea.agent.yaml index 063ddc25..df18b836 100644 --- a/src/modules/bmm/agents/tea.agent.yaml +++ b/src/modules/bmm/agents/tea.agent.yaml @@ -61,7 +61,7 @@ agent: description: Review test quality using comprehensive knowledge base and best practices - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/tech-writer.agent.yaml b/src/modules/bmm/agents/tech-writer.agent.yaml index 06fe7155..6911c581 100644 --- a/src/modules/bmm/agents/tech-writer.agent.yaml +++ b/src/modules/bmm/agents/tech-writer.agent.yaml @@ -58,7 +58,7 @@ agent: description: Show BMAD documentation standards reference (CommonMark, Mermaid, OpenAPI) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/agents/ux-designer.agent.yaml b/src/modules/bmm/agents/ux-designer.agent.yaml index 94275b31..04ba4c86 100644 --- a/src/modules/bmm/agents/ux-designer.agent.yaml +++ b/src/modules/bmm/agents/ux-designer.agent.yaml @@ -36,7 +36,7 @@ agent: description: Create website or app wireframe (Excalidraw) - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Bring the whole team in to chat with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01-init.md index e56062d1..74bfbb43 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01-init.md @@ -3,6 +3,9 @@ ## 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 initialization and setup only - don't look ahead to future steps @@ -32,7 +35,7 @@ Initialize the product brief workflow by detecting continuation state and settin First, check if the output document already exists: -- Look for file at `{output_folder}/product-brief-{{project_name}}-{{date}}.md` +- Look for file at `{output_folder}/analysis/*product-brief*.md` - If exists, read the complete file including frontmatter - If not exists, this is a fresh workflow @@ -54,16 +57,16 @@ Discover and load context documents using smart discovery: **Research Documents (Priority: Sharded → Whole):** -1. Check for sharded research folder: `{output_folder}/*research*/**/*.md` +1. Check for sharded research folder: `{output_folder}/analysis/research/**/*.md` 2. If folder exists: Load EVERY file in that folder completely for comprehensive research context -3. If no folder exists: Try whole file: `{output_folder}/*research*.md` +3. If no folder exists: Try whole file: `{output_folder}/analysis/research/*research*.md` 4. Add discovered files to `inputDocuments` frontmatter **Brainstorming Documents (Priority: Sharded → Whole):** -1. Check for sharded brainstorming folder: `{output_folder}/*brainstorm*/**/*.md` +1. Check for sharded brainstorming folder: `{output_folder}/analysis/*brainstorm*/**/*.md` 2. If folder exists: Load useful brainstorming files completely -3. If no folder exists: Try whole file: `{output_folder}/*brainstorm*.md` +3. If no folder exists: Try whole file: `{output_folder}/analysis/*brainstorm*.md` 4. Add discovered files to `inputDocuments` frontmatter **Project Documentation (Existing Projects):** @@ -137,6 +140,10 @@ Do you have any other documents you'd like me to include, or shall we continue t ❌ Not checking sharded folders first before whole files ❌ Not reporting what documents were found to user +❌ **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 + ## NEXT STEP: After user selects [C] to continue, load `./step-02-vision.md` to begin the product vision discovery phase. diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01b-continue.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01b-continue.md index 615eb69b..904540ce 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01b-continue.md @@ -3,6 +3,9 @@ ## 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 understanding where we left off and continuing appropriately @@ -94,6 +97,10 @@ After presenting current progress, ask: ❌ Loading wrong next step based on `lastStep` value ❌ Proceeding without user confirmation of current state +❌ **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 ALREADY COMPLETE? If `lastStep = 6` (final step completed): diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md index 5a34abd1..9adf20ce 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md @@ -3,6 +3,9 @@ ## 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 product vision, problem, and solution discovery only @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -159,7 +162,7 @@ Show the generated content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current vision content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current vision content - Process the enhanced vision insights that come back - Ask user: "Accept these improvements to the product vision? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -167,7 +170,7 @@ Show the generated content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current vision content +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current vision content - Process the collaborative vision exploration and positioning insights - Ask user: "Accept these changes to the product vision? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -201,6 +204,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## CONTEXT INPUTS: If research or brainstorming documents were loaded in step 1, incorporate insights from those documents into the vision discovery: diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md index d0a752f9..118b2051 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md @@ -3,6 +3,9 @@ ## 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 defining who this product serves and how they interact with it @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -158,7 +161,7 @@ Show the generated user content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current user content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current user content - Process the enhanced user insights that come back - Ask user: "Accept these improvements to the target users? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -166,7 +169,7 @@ Show the generated user content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current user personas +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current user personas - Process the collaborative user validation and additional insights - Ask user: "Accept these changes to the target users? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -200,6 +203,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## USER INSIGHTS SOURCES: If user research documents were loaded in step 1, incorporate those insights: diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md index fd04f2c9..53627a68 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md @@ -3,6 +3,9 @@ ## 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 defining measurable success criteria and business objectives @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -161,7 +164,7 @@ Show the generated metrics content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current metrics content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current metrics content - Process the enhanced metric insights that come back - Ask user: "Accept these improvements to the success metrics? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -169,7 +172,7 @@ Show the generated metrics content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current success metrics +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current success metrics - Process the collaborative metric validation and additional insights - Ask user: "Accept these changes to the success metrics? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -203,6 +206,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## METRIC QUALITY CRITERIA: **Good Metrics:** diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md index 6bf56645..f76071f4 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md @@ -3,6 +3,9 @@ ## 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 defining minimum viable scope and future vision @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -175,7 +178,7 @@ Show the generated scope content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current scope content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current scope content - Process the enhanced scope insights that come back - Ask user: "Accept these improvements to the MVP scope? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -183,7 +186,7 @@ Show the generated scope content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current MVP scope +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current MVP scope - Process the collaborative scope validation and prioritization - Ask user: "Accept these changes to the MVP scope? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -217,6 +220,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## SCOPE NEGOTIATION PRINCIPLES: **MVP Mindset:** diff --git a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-06-complete.md b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-06-complete.md index ac891b31..aa70795b 100644 --- a/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-06-complete.md +++ b/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-06-complete.md @@ -3,6 +3,9 @@ ## MANDATORY EXECUTION RULES (READ FIRST): - ✅ THIS IS A FINAL STEP - Product brief 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 @@ -146,6 +149,10 @@ The brief captures everything needed to guide subsequent product development: ❌ 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 + ## PRODUCT BRIEF COMPLETION CHECKLIST: ### Document Structure Complete: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md index abadddf0..b0197f62 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md @@ -1,39 +1,26 @@ -# Domain Research Step 1: Initialization and Context +# Domain Research Step 1: Domain Research Scope Confirmation ## MANDATORY EXECUTION RULES (READ FIRST): -- 🛑 NEVER generate content without user input -- ✅ ALWAYS treat this as collaborative research partnership -- 📋 YOU ARE A RESEARCH FACILITATOR, not content generator -- 💬 FOCUS on domain/industry research with current web data -- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 🛑 NEVER generate content without user confirmation + +- 📖 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 +- ✅ FOCUS EXCLUSIVELY on confirming domain research scope and approach +- 📋 YOU ARE A DOMAIN RESEARCH PLANNER, not content generator +- 💬 ACKNOWLEDGE and CONFIRM understanding of domain research goals +- 🔍 This is SCOPE CONFIRMATION ONLY - no web research yet ## EXECUTION PROTOCOLS: - 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after initial context generation -- 💾 ONLY save when user chooses C (Continue) +- ⚠️ Present [C] continue option after scope confirmation +- 💾 ONLY proceed when user chooses C (Continue) - 📖 Update frontmatter `stepsCompleted: [1]` 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 multiple perspectives to validate domain scope -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode -- 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 main workflow are available - Research type = "domain" is already set - **Research topic = "{{research_topic}}"** - discovered from initial discussion - **Research goals = "{{research_goals}}"** - captured from initial discussion @@ -42,157 +29,108 @@ This step will generate content and present choices: ## YOUR TASK: -Initialize domain research scope and approach for the already-identified topic: **{{research_topic}}** +Confirm domain research scope and approach for **{{research_topic}}** with the user's goals in mind. -## DOMAIN RESEARCH INITIALIZATION: +## DOMAIN SCOPE CONFIRMATION: -### 1. Confirm Domain Research Direction +### 1. Begin Scope Confirmation -Begin with domain-specific positioning: -"I'll guide you through **domain research** for **{{research_topic}}** using current {{current_year}} web data with rigorous source verification. +Start with domain scope understanding: +"I understand you want to conduct **domain research** for **{{research_topic}}** with these goals: {{research_goals}} -**Research Goals Identified:** {{research_goals}} +**Domain Research Scope:** -**Domain Research Focus for {{research_topic}}:** +- **Industry Analysis**: Industry structure, market dynamics, and competitive landscape +- **Regulatory Environment**: Compliance requirements, regulations, and standards +- **Technology Patterns**: Innovation trends, technology adoption, and digital transformation +- **Economic Factors**: Market size, growth trends, and economic impact +- **Supply Chain**: Value chain analysis and ecosystem relationships -- Industry analysis and market dynamics for this domain -- Regulatory requirements and compliance standards affecting {{research_topic}} -- Technology trends and innovation patterns in {{research_topic}} -- Competitive landscape within the {{research_topic}} domain -- Supply chain and ecosystem analysis +**Research Approach:** -Let me refine the research scope specifically for **{{research_topic}}**: +- Current {{current_year}} web data with rigorous source verification +- Multi-source validation for critical domain claims +- Confidence levels for uncertain domain information +- Comprehensive domain coverage with industry-specific insights -### 2. Establish Research Context +### 2. Scope Confirmation -Refine domain-specific details based on the already-identified topic: +Present clear scope confirmation: +"**Domain Research Scope Confirmation:** -#### Context Refinement Questions: +For **{{research_topic}}**, I will research: -- "What specific aspects of {{research_topic}} are most critical for your goals?" -- "Are there particular segments or sub-domains within {{research_topic}} we should examine?" -- "What regulatory or compliance factors most impact {{research_topic}}?" -- "What time horizon for {{research_topic}} research - current state or include future trends?" -- "How deep should we analyze the {{research_topic}} domain - overview or comprehensive?" +✅ **Industry Analysis** - market structure, key players, competitive dynamics +✅ **Regulatory Requirements** - compliance standards, legal frameworks +✅ **Technology Trends** - innovation patterns, digital transformation +✅ **Economic Factors** - market size, growth projections, economic impact +✅ **Supply Chain Analysis** - value chain, ecosystem, partnerships -### 3. Define Research Scope +**All using current {{current_year}} web data with source verification.** -Collaboratively establish research boundaries: +**Does this domain research scope and approach align with your goals?** +[C] Continue - Begin domain research with this scope -#### Scope Definition: - -- "How broad should our domain analysis be?" -- "Are we looking at global markets or specific regions?" -- "Should we focus on current state or include future projections?" -- "What depth of research do you need (overview vs deep dive)?" - -### 4. Generate Research Overview Content - -Prepare initial content to append to the document: - -#### Content Structure: - -When saving to document, append these Level 2 and Level 3 sections: - -```markdown -## Research Overview - -### Research Objectives - -[Domain research objectives based on conversation] - -### Scope and Boundaries - -[Research scope definition based on conversation] - -### Research Methodology - -[Research methodology approach with {{current_year}} web data emphasis] - -### Source Verification Standards - -[Source verification approach and confidence level framework] -``` - -### 5. Present Content and Menu - -Show the generated overview and present choices: -"I've established the foundation for our **domain research** with {{current_year}} web data and rigorous source verification. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 4] - -**Research Standards:** - -- Always using {{current_year}} web searches -- Requiring multiple sources for critical claims -- Citing all factual claims with URLs -- Presenting conflicting information when sources disagree -- Using confidence levels for uncertain data - -**What would you like to do?** -[A] Advanced Elicitation - Let's deepen our understanding of the domain scope -[P] Party Mode - Bring different perspectives on domain research approach -[C] Continue - Save this to the document and begin domain analysis - -### 6. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute advanced-elicitation.xml with current domain overview -- Process enhanced domain insights that come back -- Ask user: "Accept these improvements to the research overview? (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 party-mode workflow with current domain overview -- Process collaborative domain expertise and additional insights -- Ask user: "Accept these changes to the research overview? (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 +### 3. Handle Continue Selection #### If 'C' (Continue): -- Append the final content to the research document +- Document scope confirmation in research file - Update frontmatter: `stepsCompleted: [1]` -- Load: `./step-02-domain-analysis.md` +- Load: `./step-02-industry-analysis.md` ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the research document using the structure from step 4. +When user selects 'C', append scope confirmation: + +```markdown +## Domain Research Scope Confirmation + +**Research Topic:** {{research_topic}} +**Research Goals:** {{research_goals}} + +**Domain Research Scope:** + +- Industry Analysis - market structure, competitive landscape +- Regulatory Environment - compliance requirements, legal frameworks +- Technology Trends - innovation patterns, digital transformation +- Economic Factors - market size, growth projections +- Supply Chain Analysis - value chain, ecosystem relationships + +**Research Methodology:** + +- Current {{current_year}} web data with rigorous source verification +- Multi-source validation for critical domain claims +- Confidence level framework for uncertain information +- Comprehensive domain coverage with industry-specific insights + +**Scope Confirmed:** {{date}} +``` ## SUCCESS METRICS: -✅ Domain research scope clearly defined and confirmed -✅ Research methodology established with {{current_year}} emphasis -✅ Source verification standards communicated and documented -✅ A/P/C menu presented and handled correctly -✅ Content properly appended to document when C selected +✅ Domain research scope clearly confirmed with user +✅ All domain analysis areas identified and explained +✅ Research methodology with {{current_year}} data emphasized +✅ [C] continue option presented and handled correctly +✅ Scope confirmation documented when user proceeds ✅ Proper routing to next domain research step ## FAILURE MODES: -❌ Not confirming specific domain/industry to research -❌ Missing research scope boundaries +❌ Not clearly confirming domain research scope with user +❌ Missing critical domain analysis areas ❌ Not emphasizing {{current_year}} web data requirement -❌ Not communicating source verification protocols -❌ Not presenting A/P/C menu after content generation -❌ Appending content without user selecting 'C' +❌ Not presenting [C] continue option +❌ Proceeding without user scope confirmation +❌ Not routing to next domain research step -## WEB RESEARCH READINESS: - -This step prepares for web research by: - -- Establishing {{current_year}} search query framework -- Defining source verification protocols -- Setting confidence level methodology -- Preparing for multiple source verification of critical claims +❌ **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 ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-02-domain-analysis.md` to begin web-based domain analysis with current {{current_year}} data. +After user selects 'C', load `./step-02-industry-analysis.md` to begin industry analysis with current {{current_year}} web data. -Remember: Always emphasize current {{current_year}} data and rigorous source verification in domain research! +Remember: This is SCOPE CONFIRMATION ONLY - no actual domain research yet, just confirming the research approach and scope! diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md index 82535262..505ddabc 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md @@ -3,189 +3,226 @@ ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification -- ✅ ALWAYS use {{current_year}} web searches for current data -- 📋 YOU ARE A RESEARCH ANALYST, not content generator -- 💬 FOCUS on industry/domain analysis with verified sources + +- 📖 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 use {{current_year}} web searches for current industry data +- 📋 YOU ARE AN INDUSTRY ANALYST, not content generator +- 💬 FOCUS on market size, growth, and industry dynamics - 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT ## EXECUTION PROTOCOLS: - 🎯 Show web search analysis before presenting findings -- ⚠️ Present [C] continue option after domain analysis content generation -- 💾 ONLY save when user chooses C (Continue) +- ⚠️ Present [C] continue option after industry analysis content generation +- 📝 WRITE INDUSTRY ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed when user chooses C (Continue) - 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step - 🚫 FORBIDDEN to load next step until C is selected ## CONTEXT BOUNDARIES: - Current document and frontmatter from step-01 are available -- Research type = "domain" is already set -- Focus on industry/domain web research with {{current_year}} data +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion +- Focus on market size, growth, and industry dynamics - Web search capabilities with source verification are enabled ## YOUR TASK: -Conduct comprehensive domain/industry analysis using current {{current_year}} web data with rigorous source verification. +Conduct industry analysis focusing on market size, growth, and industry dynamics using current {{current_year}} web data with rigorous source verification. -## DOMAIN ANALYSIS SEQUENCE: +## INDUSTRY ANALYSIS SEQUENCE: -### 1. Begin Domain Analysis +### 1. Begin Industry Analysis -**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different domain areas simultaneously and thoroughly +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different industry areas simultaneously and thoroughly. -Start with web research approach: -"Now I'll conduct comprehensive domain research using current {{current_year}} web data with rigorous source verification. +Start with industry research approach: +"Now I'll conduct **industry analysis** for **{{research_topic}}** using current {{current_year}} web data to understand market dynamics. -**Domain Analysis Focus:** +**Industry Analysis Focus:** -- Industry size, growth, and market dynamics -- Technology trends and innovation patterns -- Regulatory landscape and compliance requirements -- Key players and competitive ecosystem -- Supply chain and business model evolution +- Market size and valuation metrics +- Growth rates and market dynamics +- Market segmentation and structure +- Industry trends and evolution patterns +- Economic impact and value creation -**Let me search for current {{current_year}} data on [domain/industry] using parallel web searches for comprehensive coverage.**" +**Let me search for current industry insights.**" -### 2. Parallel Web Search Execution +### 2. Parallel Industry Research Execution **Execute multiple web searches simultaneously:** -`WebSearch: "[domain/industry] market size growth {{current_year}}"` -`WebSearch: "[domain/industry] technology trends {{current_year}}"` -`WebSearch: "[domain/industry] regulations compliance {{current_year}}"` -`WebSearch: "[domain/industry] key players ecosystem {{current_year}}"` +`WebSearch: "{{research_topic}} market size value {{current_year}}"` +`WebSearch: "{{research_topic}} market growth rate dynamics {{current_year}}"` +`WebSearch: "{{research_topic}} market segmentation structure {{current_year}}"` +`WebSearch: "{{research_topic}} industry trends evolution {{current_year}}"` **Analysis approach:** - Look for recent market research reports and industry analyses -- Identify market size, growth rates, and trends -- Find authoritative sources (market research firms, industry associations) -- Note conflicting information from different sources -- Gather technology trends and innovation patterns -- Research regulatory requirements and compliance standards -- Analyze competitive landscape and key players +- Search for authoritative sources (market research firms, industry associations) +- Identify market size, growth rates, and segmentation data +- Research industry trends and evolution patterns +- Analyze economic impact and value creation metrics ### 3. Analyze and Aggregate Results **Collect and analyze findings from all parallel searches:** -"After executing comprehensive parallel web searches, let me analyze and aggregate the findings: +"After executing comprehensive parallel web searches, let me analyze and aggregate industry findings: **Research Coverage:** -- Market analysis and industry dynamics -- Technology trends and innovation patterns -- Regulatory landscape and compliance requirements -- Key players and competitive ecosystem +- Market size and valuation analysis +- Growth rates and market dynamics +- Market segmentation and structure +- Industry trends and evolution patterns -**Cross-Domain Analysis:** -[Identify patterns, connections, and insights that emerge across multiple search areas] +**Cross-Industry Analysis:** +[Identify patterns connecting market dynamics, segmentation, and trends] **Quality Assessment:** [Overall confidence levels and research gaps identified]" -### 4. Generate Domain Analysis Content +### 4. Generate Industry Analysis Content -Prepare analysis content with source citations: +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare industry analysis with web search citations: #### Content Structure: When saving to document, append these Level 2 and Level 3 sections: ```markdown -## Industry Overview +## Industry Analysis -### Market Size and Growth +### Market Size and Valuation -[Market size and growth data with source citations] -_Source: [URL with {{current_year}} data]_ +[Market size analysis with source citations] +_Total Market Size: [Current market valuation with {{current_year}} data]_ +_Growth Rate: [CAGR and market growth projections]_ +_Market Segments: [Size and value of key market segments]_ +_Economic Impact: [Economic contribution and value creation]_ +_Source: [URL with {{current_year}} market size data]_ -### Technology Trends +### Market Dynamics and Growth -[Technology trends analysis with source citations] -_Source: [URL with {{current_year}} data]_ +[Market dynamics analysis with source citations] +_Growth Drivers: [Key factors driving market growth]_ +_Growth Barriers: [Factors limiting market expansion]_ +_Cyclical Patterns: [Industry seasonality and cycles]_ +_Market Maturity: [Life cycle stage and development phase]_ +_Source: [URL with {{current_year}} market dynamics data]_ -### Regulatory Landscape +### Market Structure and Segmentation -[Regulatory analysis with source citations] -_Source: [URL with {{current_year}} data]_ +[Market structure analysis with source citations] +_Primary Segments: [Key market segments and their characteristics]_ +_Sub-segment Analysis: [Detailed breakdown of market sub-segments]_ +_Geographic Distribution: [Regional market variations and concentrations]_ +_Vertical Integration: [Supply chain and value chain structure]_ +_Source: [URL with {{current_year}} market structure data]_ -### Key Players and Ecosystem +### Industry Trends and Evolution -[Key players analysis with source citations] -_Source: [URL with {{current_year}} data]_ +[Industry trends analysis with source citations] +_Emerging Trends: [Current industry developments and transformations]_ +_Historical Evolution: [Industry development over recent years]_ +_Technology Integration: [How technology is changing the industry]_ +_Future Outlook: [Projected industry developments and changes]_ +_Source: [URL with {{current_year}} industry trends data]_ -### Growth Drivers and Challenges +### Competitive Dynamics -[Growth drivers and challenges with source citations] -_Source: [URL with {{current_year}} data]_ +[Competitive dynamics analysis with source citations] +_Market Concentration: [Level of market consolidation and competition]_ +_Competitive Intensity: [Degree of competition and rivalry]_ +_Barriers to Entry: [Obstacles for new market entrants]_ +_Innovation Pressure: [Rate of innovation and change]_ +_Source: [URL with {{current_year}} competitive dynamics data]_ ``` ### 5. Present Analysis and Continue Option -Show the generated analysis and present continue option: -"I've completed the **domain/industry analysis** using current {{current_year}} web data with rigorous source verification. +**Show analysis and present continue option:** -**Key Findings:** +"I've completed **industry analysis** using current {{current_year}} data to understand market dynamics for {{research_topic}}. -- Multiple sources verified for critical market data -- Conflicting information noted where sources disagree -- Confidence levels applied to uncertain data -- All factual claims include source citations +**Key Industry Findings:** -**Ready to proceed to regulatory focus?** -[C] Continue - Save this to the document and move to regulatory focus +- Market size and valuation thoroughly analyzed +- Growth dynamics and market structure documented +- Industry trends and evolution patterns identified +- Competitive dynamics clearly mapped +- Multiple sources verified for critical insights + +**Ready to proceed to competitive landscape analysis?** +[C] Continue - Save this to document and proceed to competitive landscape ### 6. Handle Continue Selection #### If 'C' (Continue): -- Append the final content to the research document +- **CONTENT ALREADY WRITTEN TO DOCUMENT** - Update frontmatter: `stepsCompleted: [1, 2]` -- Load: `./step-03-regulatory-focus.md` +- Load: `./step-03-competitive-landscape.md` ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the research document using the structure from step 4. +Content is already written to document when generated in step 4. No additional append needed. ## SUCCESS METRICS: -✅ Industry size and growth data with current {{current_year}} citations -✅ Technology trends identified with current developments -✅ Regulatory landscape analysis with current requirements -✅ Key players and ecosystem mapped with current data +✅ Market size and valuation thoroughly analyzed +✅ Growth dynamics and market structure documented +✅ Industry trends and evolution patterns identified +✅ Competitive dynamics clearly mapped +✅ Multiple sources verified for critical insights +✅ Content written immediately to document ✅ [C] continue option presented and handled correctly -✅ Content properly appended to document when C selected -✅ Web searches properly structured with {{current_year}} parameter +✅ Proper routing to next step (competitive landscape) +✅ Research goals alignment maintained ## FAILURE MODES: -❌ Not using {{current_year}} in web search queries -❌ Not requiring source citations for factual claims -❌ Not presenting conflicting information when sources disagree -❌ Not applying confidence levels to uncertain data +❌ Not using {{current_year}} in industry web searches +❌ Missing critical market size or growth data +❌ Incomplete market structure analysis +❌ Not identifying key industry trends +❌ Not writing content immediately to document ❌ Not presenting [C] continue option after content generation -❌ Appending content without user selecting 'C' +❌ Not routing to competitive landscape step -## WEB RESEARCH PROTOCOLS: +❌ **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 -All web searches must: +## INDUSTRY RESEARCH PROTOCOLS: -- Include {{current_year}} for current data -- Require multiple sources for critical claims -- Present conflicting information when found -- Include source URLs for all factual claims +- Research market research reports and industry analyses +- Use authoritative sources (market research firms, industry associations) +- Analyze market size, growth rates, and segmentation data +- Study industry trends and evolution patterns +- Focus on current {{current_year}} industry data +- Present conflicting information when sources disagree - Apply confidence levels appropriately -## SOURCE VERIFICATION: +## INDUSTRY ANALYSIS STANDARDS: - Always cite URLs for web search results -- Use authoritative sources (market research firms, industry associations) +- Use authoritative industry research sources - Note data currency and potential limitations - Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable industry insights ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-03-regulatory-focus.md` to focus on specific regulatory and compliance requirements. +After user selects 'C', load `./step-03-competitive-landscape.md` to analyze competitive landscape, key players, and ecosystem analysis for {{research_topic}}. -Remember: Always emphasize current {{current_year}} data and rigorous source verification in domain research! +Remember: Always write research content to document immediately and emphasize current {{current_year}} industry data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md new file mode 100644 index 00000000..fd81f04c --- /dev/null +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md @@ -0,0 +1,237 @@ +# Domain Research Step 3: Competitive Landscape + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current competitive data +- 📋 YOU ARE A COMPETITIVE ANALYST, not content generator +- 💬 FOCUS on key players, market share, and competitive dynamics +- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT + +## EXECUTION PROTOCOLS: + +- 🎯 Show web search analysis before presenting findings +- ⚠️ Present [C] continue option after competitive analysis content generation +- 📝 WRITE COMPETITIVE ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from previous steps are available +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion +- Focus on key players, market share, and competitive dynamics +- Web search capabilities with source verification are enabled + +## YOUR TASK: + +Conduct competitive landscape analysis focusing on key players, market share, and competitive dynamics using current {{current_year}} web data with rigorous source verification. + +## COMPETITIVE LANDSCAPE ANALYSIS SEQUENCE: + +### 1. Begin Competitive Landscape Analysis + +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different competitive areas simultaneously and thoroughly. + +Start with competitive research approach: +"Now I'll conduct **competitive landscape analysis** for **{{research_topic}}** using current {{current_year}} web data to understand the competitive ecosystem. + +**Competitive Landscape Focus:** + +- Key players and market leaders +- Market share and competitive positioning +- Competitive strategies and differentiation +- Business models and value propositions +- Entry barriers and competitive dynamics + +**Let me search for current competitive insights.**" + +### 2. Parallel Competitive Research Execution + +**Execute multiple web searches simultaneously:** + +`WebSearch: "{{research_topic}} key players market leaders {{current_year}}"` +`WebSearch: "{{research_topic}} market share competitive landscape {{current_year}}"` +`WebSearch: "{{research_topic}} competitive strategies differentiation {{current_year}}"` +`WebSearch: "{{research_topic}} entry barriers competitive dynamics {{current_year}}"` + +**Analysis approach:** + +- Look for recent competitive intelligence reports and market analyses +- Search for company websites, annual reports, and investor presentations +- Research market share data and competitive positioning +- Analyze competitive strategies and differentiation approaches +- Study entry barriers and competitive dynamics + +### 3. Analyze and Aggregate Results + +**Collect and analyze findings from all parallel searches:** + +"After executing comprehensive parallel web searches, let me analyze and aggregate competitive findings: + +**Research Coverage:** + +- Key players and market leaders analysis +- Market share and competitive positioning assessment +- Competitive strategies and differentiation mapping +- Entry barriers and competitive dynamics evaluation + +**Cross-Competitive Analysis:** +[Identify patterns connecting players, strategies, and market dynamics] + +**Quality Assessment:** +[Overall confidence levels and research gaps identified]" + +### 4. Generate Competitive Landscape Content + +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare competitive landscape analysis with web search citations: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## Competitive Landscape + +### Key Players and Market Leaders + +[Key players analysis with source citations] +_Market Leaders: [Dominant players and their market positions]_ +_Major Competitors: [Significant competitors and their specialties]_ +_Emerging Players: [New entrants and innovative companies]_ +_Global vs Regional: [Geographic distribution of key players]_ +_Source: [URL with {{current_year}} competitive data]_ + +### Market Share and Competitive Positioning + +[Market share analysis with source citations] +_Market Share Distribution: [Current market share breakdown]_ +_Competitive Positioning: [How players position themselves in the market]_ +_Value Proposition Mapping: [Different value propositions across players]_ +_Customer Segments Served: [Different customer bases by competitor]_ +_Source: [URL with {{current_year}} market share data]_ + +### Competitive Strategies and Differentiation + +[Competitive strategies analysis with source citations] +_Cost Leadership Strategies: [Players competing on price and efficiency]_ +_Differentiation Strategies: [Players competing on unique value]_ +_Focus/Niche Strategies: [Players targeting specific segments]_ +_Innovation Approaches: [How different players innovate]_ +_Source: [URL with {{current_year}} competitive strategies data]_ + +### Business Models and Value Propositions + +[Business models analysis with source citations] +_Primary Business Models: [How competitors make money]_ +_Revenue Streams: [Different approaches to monetization]_ +_Value Chain Integration: [Vertical integration vs partnership models]_ +_Customer Relationship Models: [How competitors build customer loyalty]_ +_Source: [URL with {{current_year}} business models data]_ + +### Competitive Dynamics and Entry Barriers + +[Competitive dynamics analysis with source citations] +_Barriers to Entry: [Obstacles facing new market entrants]_ +_Competitive Intensity: [Level of rivalry and competitive pressure]_ +_Market Consolidation Trends: [M&A activity and market concentration]_ +_Switching Costs: [Costs for customers to switch between providers]_ +_Source: [URL with {{current_year}} competitive dynamics data]_ + +### Ecosystem and Partnership Analysis + +[Ecosystem analysis with source citations] +_Supplier Relationships: [Key supplier partnerships and dependencies]_ +_Distribution Channels: [How competitors reach customers]_ +_Technology Partnerships: [Strategic technology alliances]_ +_Ecosystem Control: [Who controls key parts of the value chain]_ +_Source: [URL with {{current_year}} ecosystem data]_ +``` + +### 5. Present Analysis and Continue Option + +**Show analysis and present continue option:** + +"I've completed **competitive landscape analysis** using current {{current_year}} data to understand the competitive ecosystem for {{research_topic}}. + +**Key Competitive Findings:** + +- Key players and market leaders thoroughly identified +- Market share and competitive positioning clearly mapped +- Competitive strategies and differentiation analyzed +- Business models and value propositions documented +- Competitive dynamics and entry barriers evaluated + +**Ready to proceed to regulatory focus analysis?** +[C] Continue - Save this to document and proceed to regulatory focus + +### 6. Handle Continue Selection + +#### If 'C' (Continue): + +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2, 3]` +- Load: `./step-04-regulatory-focus.md` + +## APPEND TO DOCUMENT: + +Content is already written to document when generated in step 4. No additional append needed. + +## SUCCESS METRICS: + +✅ Key players and market leaders thoroughly identified +✅ Market share and competitive positioning clearly mapped +✅ Competitive strategies and differentiation analyzed +✅ Business models and value propositions documented +✅ Competitive dynamics and entry barriers evaluated +✅ Content written immediately to document +✅ [C] continue option presented and handled correctly +✅ Proper routing to next step (regulatory focus) +✅ Research goals alignment maintained + +## FAILURE MODES: + +❌ Not using {{current_year}} in competitive web searches +❌ Missing critical key players or market leaders +❌ Incomplete market share or positioning analysis +❌ Not identifying competitive strategies +❌ Not writing content immediately to document +❌ Not presenting [C] continue option after content generation +❌ Not routing to regulatory focus step + +❌ **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 + +## COMPETITIVE RESEARCH PROTOCOLS: + +- Research competitive intelligence reports and market analyses +- Use company websites, annual reports, and investor presentations +- Analyze market share data and competitive positioning +- Study competitive strategies and differentiation approaches +- Focus on current {{current_year}} competitive data +- Present conflicting information when sources disagree +- Apply confidence levels appropriately + +## COMPETITIVE ANALYSIS STANDARDS: + +- Always cite URLs for web search results +- Use authoritative competitive intelligence sources +- Note data currency and potential limitations +- Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable competitive insights + +## NEXT STEP: + +After user selects 'C', load `./step-04-regulatory-focus.md` to analyze regulatory requirements, compliance frameworks, and legal considerations for {{research_topic}}. + +Remember: Always write research content to document immediately and emphasize current {{current_year}} competitive data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-regulatory-focus.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md similarity index 77% rename from src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-regulatory-focus.md rename to src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md index 12f77b47..8fb18f2f 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-regulatory-focus.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md @@ -1,38 +1,44 @@ -# Domain Research Step 3: Regulatory Focus +# Domain Research Step 4: Regulatory Focus ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current regulatory data - 📋 YOU ARE A REGULATORY ANALYST, not content generator - 💬 FOCUS on compliance requirements and regulatory landscape - 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT ## EXECUTION PROTOCOLS: - 🎯 Show web search analysis before presenting findings - ⚠️ Present [C] continue option after regulatory content generation +- 📝 WRITE REGULATORY ANALYSIS TO DOCUMENT IMMEDIATELY - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step - 🚫 FORBIDDEN to load next step until C is selected ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion - Focus on regulatory and compliance requirements for the domain - Web search capabilities with source verification are enabled -- May need to search for specific regulations and compliance frameworks ## YOUR TASK: -Conduct focused regulatory and compliance analysis using current {{current_year}} web data with emphasis on requirements that impact your project. +Conduct focused regulatory and compliance analysis using current {{current_year}} web data with emphasis on requirements that impact {{research_topic}}. ## REGULATORY FOCUS SEQUENCE: ### 1. Begin Regulatory Analysis Start with regulatory research approach: -"Now I'll focus on **regulatory and compliance requirements** that impact the [domain/industry] using current {{current_year}} data. +"Now I'll focus on **regulatory and compliance requirements** that impact **{{research_topic}}** using current {{current_year}} data. **Regulatory Focus Areas:** @@ -47,7 +53,7 @@ Start with regulatory research approach: ### 2. Web Search for Specific Regulations Search for current regulatory information: -`WebSearch: "[domain/industry] regulations compliance requirements {{current_year}}"` +`WebSearch: "{{research_topic}} regulations compliance requirements {{current_year}}"` **Regulatory focus:** @@ -59,7 +65,7 @@ Search for current regulatory information: ### 3. Web Search for Industry Standards Search for current industry standards: -`WebSearch: "[domain/industry] standards best practices {{current_year}}"` +`WebSearch: "{{research_topic}} standards best practices {{current_year}}"` **Standards focus:** @@ -71,7 +77,7 @@ Search for current industry standards: ### 4. Web Search for Data Privacy Requirements Search for current privacy regulations: -`WebSearch: "data privacy regulations [domain/industry] {{current_year}}"` +`WebSearch: "data privacy regulations {{research_topic}} {{current_year}}"` **Privacy focus:** @@ -129,7 +135,7 @@ _Source: [URL with {{current_year}} implementation data]_ ### 6. Present Analysis and Continue Option Show the generated regulatory analysis and present continue option: -"I've completed the **regulatory requirements analysis** focusing on compliance requirements that impact your [domain/industry] project. +"I've completed **regulatory requirements analysis** using current {{current_year}} data to understand compliance requirements for {{research_topic}}. **Key Regulatory Findings:** @@ -146,13 +152,13 @@ Show the generated regulatory analysis and present continue option: #### If 'C' (Continue): -- Append the final content to the research document -- Update frontmatter: `stepsCompleted: [1, 2, 3]` -- Load: `./step-04-technical-trends.md` +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` +- Load: `./step-05-technical-trends.md` ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the research document using the structure from step 5. +Content is already written to document when generated in step 5. No additional append needed. ## SUCCESS METRICS: @@ -173,6 +179,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Not presenting [C] continue option 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 + ## REGULATORY RESEARCH PROTOCOLS: - Search for specific regulations by name and number diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-technical-trends.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md similarity index 67% rename from src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-technical-trends.md rename to src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md index cba9f98f..7ee55070 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-technical-trends.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md @@ -1,38 +1,44 @@ -# Domain Research Step 4: Technical Trends +# Domain Research Step 5: Technical Trends ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current technical data - 📋 YOU ARE A TECHNOLOGY ANALYST, not content generator - 💬 FOCUS on emerging technologies and innovation patterns - 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT ## EXECUTION PROTOCOLS: - 🎯 Show web search analysis before presenting findings -- ⚠️ Present [C] complete option after technical trends content generation -- 💾 ONLY save when user chooses C (Complete) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before completing workflow -- 🚫 FORBIDDEN to complete workflow until C is selected +- ⚠️ Present [C] continue option after technical trends content generation +- 📝 WRITE TECHNICAL TRENDS ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed 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 ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion - Focus on emerging technologies and innovation patterns in the domain - Web search capabilities with source verification are enabled -- This is the final step in the domain research workflow ## YOUR TASK: -Conduct comprehensive technical trends analysis using current {{current_year}} web data with emphasis on innovations and emerging technologies impacting the domain. +Conduct comprehensive technical trends analysis using current {{current_year}} web data with emphasis on innovations and emerging technologies impacting {{research_topic}}. ## TECHNICAL TRENDS SEQUENCE: ### 1. Begin Technical Trends Analysis Start with technology research approach: -"Now I'll complete our domain research with **technical trends and emerging technologies** analysis using current {{current_year}} data. +"Now I'll conduct **technical trends and emerging technologies** analysis for **{{research_topic}}** using current {{current_year}} data. **Technical Trends Focus:** @@ -47,7 +53,7 @@ Start with technology research approach: ### 2. Web Search for Emerging Technologies Search for current technology information: -`WebSearch: "[domain/industry] emerging technologies innovations {{current_year}}"` +`WebSearch: "{{research_topic}} emerging technologies innovations {{current_year}}"` **Technology focus:** @@ -59,7 +65,7 @@ Search for current technology information: ### 3. Web Search for Digital Transformation Search for current transformation trends: -`WebSearch: "[domain/industry] digital transformation {{current_year}}"` +`WebSearch: "{{research_topic}} digital transformation {{current_year}}"` **Transformation focus:** @@ -71,7 +77,7 @@ Search for current transformation trends: ### 4. Web Search for Future Outlook Search for future projections: -`WebSearch: "[domain/industry] future outlook {{current_year}} 2025"` +`WebSearch: "{{research_topic}} future outlook {{current_year}} 2025"` **Future focus:** @@ -82,6 +88,8 @@ Search for future projections: ### 5. Generate Technical Trends Content +**WRITE IMMEDIATELY TO DOCUMENT** + Prepare technical analysis with source citations: #### Content Structure: @@ -139,7 +147,7 @@ _Source: [URL with {{current_year}} risk data]_ ### 6. Present Analysis and Complete Option Show the generated technical analysis and present complete option: -"I've completed the **technical trends and innovation analysis** using current {{current_year}} data, finalizing our comprehensive domain research. +"I've completed **technical trends and innovation analysis** using current {{current_year}} data to understand technology patterns for {{research_topic}}. **Technical Highlights:** @@ -149,27 +157,27 @@ Show the generated technical analysis and present complete option: - Implementation opportunities and challenges documented - Practical recommendations provided -**This completes our domain research covering:** +**Technical Trends Research Completed:** -- Industry overview and market dynamics -- Regulatory requirements and compliance -- Technical trends and innovations -- Strategic recommendations for your project +- Emerging technologies and innovations identified +- Digital transformation trends mapped +- Future outlook and projections analyzed +- Implementation opportunities and challenges documented -**Ready to complete the domain research report?** -[C] Complete Research - Save final document and conclude +**Ready to proceed to research synthesis and recommendations?** +[C] Continue - Save this to document and proceed to synthesis -### 7. Handle Complete Selection +### 7. Handle Continue Selection -#### If 'C' (Complete Research): +#### If 'C' (Continue): -- Append the final content to the research document -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` -- Complete the domain research workflow +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]` +- Load: `./step-06-research-synthesis.md` ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the research document using the structure from step 5. +Content is already written to document when generated in step 5. No additional append needed. ## SUCCESS METRICS: @@ -178,9 +186,10 @@ When user selects 'C', append the content directly to the research document usin ✅ Future outlook and projections analyzed ✅ Implementation opportunities and challenges mapped ✅ Strategic recommendations provided -✅ [C] complete option presented and handled correctly -✅ Content properly appended to document when C selected -✅ Research workflow completed successfully +✅ Content written immediately to document +✅ [C] continue option presented and handled correctly +✅ Proper routing to next step (research synthesis) +✅ Research goals alignment maintained ## FAILURE MODES: @@ -191,6 +200,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Not presenting completion option for research workflow ❌ 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 + ## TECHNICAL RESEARCH PROTOCOLS: - Search for cutting-edge technologies and innovations diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-research-synthesis.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md similarity index 95% rename from src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-research-synthesis.md rename to src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md index ab0d3119..bb31f3f8 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-research-synthesis.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md @@ -1,8 +1,11 @@ -# Domain Research Step 5: Research Synthesis and Completion +# Domain Research Step 6: Research Synthesis and Completion ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current domain data - 📋 YOU ARE A DOMAIN RESEARCH STRATEGIST, not content generator - 💬 FOCUS on comprehensive synthesis and authoritative conclusions @@ -14,7 +17,7 @@ - 🎯 Show web search analysis before presenting findings - ⚠️ Present [C] complete option after synthesis content generation - 💾 ONLY save when user chooses C (Complete) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before completing workflow +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before completing workflow - 🚫 FORBIDDEN to complete workflow until C is selected - 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary @@ -402,6 +405,10 @@ When user selects 'C', append the complete comprehensive research document using ❌ Producing document without professional structure ❌ Not presenting completion option for final document +❌ **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 + ## COMPREHENSIVE DOCUMENT STANDARDS: This step ensures the final research document: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md index fa1fb788..6feb3ff3 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md @@ -1,18 +1,20 @@ -# Market Research Step 1: Market Analysis +# Market Research Step 1: Market Research Initialization ## MANDATORY EXECUTION RULES (READ FIRST): -- 🛑 NEVER generate content without web search verification -- ✅ ALWAYS use {{current_year}} web searches for current market data -- 📋 YOU ARE A MARKET ANALYST, not content generator -- 💬 FOCUS on market size, growth, and competitive analysis -- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 🛑 NEVER generate research content in init step +- ✅ ALWAYS confirm understanding of user's research goals +- 📋 YOU ARE A MARKET RESEARCH FACILITATOR, not content generator +- 💬 FOCUS on clarifying scope and approach +- 🔍 NO WEB RESEARCH in init - that's for later steps +- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete research +- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding ## EXECUTION PROTOCOLS: -- 🎯 Show web search analysis before presenting findings -- ⚠️ Present [C] continue option after market analysis content generation -- 💾 ONLY save when user chooses C (Continue) +- 🎯 Confirm research understanding before proceeding +- ⚠️ Present [C] continue option after scope clarification +- 💾 Write initial scope document immediately - 📖 Update frontmatter `stepsCompleted: [1]` before loading next step - 🚫 FORBIDDEN to load next step until C is selected @@ -22,144 +24,159 @@ - Research type = "market" is already set - **Research topic = "{{research_topic}}"** - discovered from initial discussion - **Research goals = "{{research_goals}}"** - captured from initial discussion -- Focus on market research with current {{current_year}} data -- Web search capabilities with source verification are enabled +- Focus on market research scope clarification +- Web search capabilities are enabled for later steps ## YOUR TASK: -Initialize market research scope and approach for the already-identified topic: **{{research_topic}}** with goals: {{research_goals}} +Initialize market research by confirming understanding of {{research_topic}} and establishing clear research scope. -## MARKET ANALYSIS SEQUENCE: +## MARKET RESEARCH INITIALIZATION: -### 1. Initialize Market Research +### 1. Confirm Research Understanding -Start with market-specific positioning: -"I'll guide you through **market research** for **{{research_topic}}** using current {{current_year}} web data with rigorous source verification. +**INITIALIZE - DO NOT RESEARCH YET** -**Research Goals Identified:** {{research_goals}} +Start with research confirmation: +"I understand you want to conduct **market research** for **{{research_topic}}** with these goals: {{research_goals}} -**Market Research Focus for {{research_topic}}:** +**My Understanding of Your Research Needs:** -- Market size and growth projections for {{research_topic}} -- Customer segments and demographics interested in {{research_topic}} -- Competitive landscape analysis in {{research_topic}} market -- Pricing strategies and business models for {{research_topic}} -- Market trends and consumer behavior around {{research_topic}} +- **Research Topic**: {{research_topic}} +- **Research Goals**: {{research_goals}} +- **Research Type**: Market Research using current {{current_year}} data +- **Approach**: Comprehensive market analysis with rigorous source verification -Let me refine the market research scope specifically for **{{research_topic}}**: +**Market Research Areas We'll Cover:** -### 2. Establish Market Research Context +- Market size, growth dynamics, and trends +- Customer insights and behavior analysis +- Competitive landscape and positioning +- Strategic recommendations and implementation guidance -#### Market Context Questions: +**Does this accurately capture what you're looking for?**" -- "What specific market aspects of {{research_topic}} are most critical for your goals?" -- "Are there particular customer segments or demographics within {{research_topic}} we should focus on?" -- "Should we analyze the global {{research_topic}} market or specific regions?" -- "What time horizon for {{research_topic}} market research - current state or future projections?" -- "How comprehensive should the {{research_topic}} competitive analysis be?" +### 2. Refine Research Scope -### 3. Begin Market Research Execution +Gather any clarifications needed: -After scope refinement, proceed with: +#### Scope Clarification Questions: -### 2. Generate Market Analysis Content +- "Are there specific customer segments or aspects of {{research_topic}} we should prioritize?" +- "Should we focus on specific geographic regions or global market?" +- "Is this for market entry, expansion, product development, or other business purpose?" +- "Any competitors or market segments you specifically want us to analyze?" -Prepare market analysis with web search citations: +### 3. Document Initial Scope -#### Content Structure: +**WRITE IMMEDIATELY TO DOCUMENT** -When saving to document, append these Level 2 and Level 3 sections: +Write initial research scope to document: ```markdown -## Market Analysis +# Market Research: {{research_topic}} -### Market Size and Growth +## Research Initialization -[Market size and growth data with source citations] -_Source: [URL with {{current_year}} market data]_ +### Research Understanding Confirmed -### Customer Segments +**Topic**: {{research_topic}} +**Goals**: {{research_goals}} +**Research Type**: Market Research +**Data Currency**: {{current_year}} with rigorous source verification +**Date**: {{date}} -[Customer segments analysis with source citations] -_Source: [URL with {{current_year}} segment data]_ +### Research Scope -### Competitive Landscape +**Market Analysis Focus Areas:** -[Competitive landscape analysis with source citations] -_Source: [URL with {{current_year}} competitive data]_ +- Market size, growth projections, and dynamics +- Customer segments, behavior patterns, and insights +- Competitive landscape and positioning analysis +- Strategic recommendations and implementation guidance -### Market Trends +**Research Methodology:** -[Market trends analysis with source citations] -_Source: [URL with {{current_year}} trends data]_ +- Current {{current_year}} web data with source verification +- Multiple independent sources for critical claims +- Confidence level assessment for uncertain data +- Comprehensive coverage with no critical gaps -### Pricing and Business Models +### Next Steps -[Pricing analysis with source citations] -_Source: [URL with {{current_year}} pricing data]_ +**Research Workflow:** -### Market Opportunities +1. ✅ Initialization and scope setting (current step) +2. Customer Insights and Behavior Analysis +3. Competitive Landscape Analysis +4. Strategic Synthesis and Recommendations -[Market opportunities analysis with source citations] -_Source: [URL with {{current_year}} opportunity data]_ +**Research Status**: Scope confirmed, ready to proceed with detailed market analysis ``` -### 3. Present Analysis and Continue Option +### 4. Present Confirmation and Continue Option -Show the generated market analysis and present continue option: -"I've completed the **market analysis** using current {{current_year}} web data with rigorous source verification. +Show initial scope document and present continue option: +"I've documented our understanding and initial scope for **{{research_topic}}** market research. -**Key Market Findings:** +**What I've established:** -- Market size and growth projections identified -- Customer segments clearly defined -- Competitive landscape thoroughly analyzed -- Market trends and opportunities documented +- Research topic and goals confirmed +- Market analysis focus areas defined +- Research methodology with {{current_year}} data verification +- Clear workflow progression -**Ready to proceed to customer insights?** -[C] Continue - Save this to the document and proceed to customer insights +**Document Status:** Initial scope written to research file for your review -### 4. Handle Continue Selection +**Ready to begin detailed market research?** +[C] Continue - Confirm scope and proceed to customer insights analysis +[Modify] Suggest changes to research scope before proceeding + +### 5. Handle User Response #### If 'C' (Continue): -- Append the final content to the research document - Update frontmatter: `stepsCompleted: [1]` +- Add confirmation note to document: "Scope confirmed by user on {{date}}" - Load: `./step-02-customer-insights.md` -## APPEND TO DOCUMENT: +#### If 'Modify': -When user selects 'C', append the content directly to the research document using the structure from step 2. +- Gather user changes to scope +- Update document with modifications +- Re-present updated scope for confirmation ## SUCCESS METRICS: -✅ Market size and growth data with current {{current_year}} citations -✅ Customer segments clearly identified and analyzed -✅ Competitive landscape thoroughly mapped -✅ Market trends and opportunities documented +✅ Research topic and goals accurately understood +✅ Market research scope clearly defined +✅ Initial scope document written immediately +✅ User opportunity to review and modify scope ✅ [C] continue option presented and handled correctly -✅ Content properly appended to document when C selected -✅ Proper routing to customer insights step +✅ Document properly updated with scope confirmation ## FAILURE MODES: -❌ Not using {{current_year}} in market web searches -❌ Missing critical market size or growth data -❌ Not identifying key customer segments -❌ Incomplete competitive landscape analysis -❌ Not presenting [C] continue option after content generation -❌ Appending content without user selecting 'C' +❌ Not confirming understanding of research topic and goals +❌ Generating research content instead of just scope clarification +❌ Not writing initial scope document to file +❌ Not providing opportunity for user to modify scope +❌ Proceeding to next step without user confirmation +❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor research 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 -## MARKET RESEARCH PROTOCOLS: +## INITIALIZATION PRINCIPLES: -- Search for authoritative market research reports -- Use industry association and trade publication sources -- Cross-reference multiple sources for critical market data -- Note regional and demographic market variations -- Research market validation and sizing methodologies +This step ensures: + +- Clear mutual understanding of research objectives +- Well-defined research scope and approach +- Immediate documentation for user review +- User control over research direction before detailed work begins ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-02-customer-insights.md` to focus on customer behavior and insights. +After user confirmation and scope finalization, load `./step-02-customer-insights.md` to begin detailed market research with customer insights analysis using {{current_year}} data and rigorous source verification. -Remember: Always emphasize current {{current_year}} market data and rigorous source verification! +Remember: Init steps confirm understanding and scope, not generate research content! diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md new file mode 100644 index 00000000..4bc6e905 --- /dev/null +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md @@ -0,0 +1,235 @@ +# Market Research Step 2: Customer Behavior and Segments + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without web search verification +- ✅ ALWAYS use {{current_year}} web searches for current customer data +- 📋 YOU ARE A CUSTOMER BEHAVIOR ANALYST, not content generator +- 💬 FOCUS on customer behavior patterns and demographic analysis +- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT +- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete research +- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding + +## EXECUTION PROTOCOLS: + +- 🎯 Show web search analysis before presenting findings +- ⚠️ Present [C] continue option after customer behavior content generation +- 📝 WRITE CUSTOMER BEHAVIOR ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from step-01 are available +- Focus on customer behavior patterns and demographic analysis +- Web search capabilities with source verification are enabled +- Previous step confirmed research scope and goals +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion + +## YOUR TASK: + +Conduct customer behavior and segment analysis using current {{current_year}} web data with emphasis on patterns and demographics. + +## CUSTOMER BEHAVIOR ANALYSIS SEQUENCE: + +### 1. Begin Customer Behavior Analysis + +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different customer behavior areas simultaneously and thoroughly. + +Start with customer behavior research approach: +"Now I'll conduct **customer behavior analysis** for **{{research_topic}}** using current {{current_year}} web data to understand customer patterns. + +**Customer Behavior Focus:** + +- Customer behavior patterns and preferences +- Demographic profiles and segmentation +- Psychographic characteristics and values +- Behavior drivers and influences +- Customer interaction patterns and engagement + +**Let me search for current customer behavior insights.**" + +### 2. Parallel Customer Behavior Research Execution + +**Execute multiple web searches simultaneously:** + +`WebSearch: "{{research_topic}} customer behavior patterns {{current_year}}"` +`WebSearch: "{{research_topic}} customer demographics {{current_year}}"` +`WebSearch: "{{research_topic}} psychographic profiles {{current_year}}"` +`WebSearch: "{{research_topic}} customer behavior drivers {{current_year}}"` + +**Analysis approach:** + +- Look for customer behavior studies and research reports +- Search for demographic segmentation and analysis +- Research psychographic profiling and value systems +- Analyze behavior drivers and influencing factors +- Study customer interaction and engagement patterns + +### 3. Analyze and Aggregate Results + +**Collect and analyze findings from all parallel searches:** + +"After executing comprehensive parallel web searches, let me analyze and aggregate customer behavior findings: + +**Research Coverage:** + +- Customer behavior patterns and preferences +- Demographic profiles and segmentation +- Psychographic characteristics and values +- Behavior drivers and influences +- Customer interaction patterns and engagement + +**Cross-Behavior Analysis:** +[Identify patterns connecting demographics, psychographics, and behaviors] + +**Quality Assessment:** +[Overall confidence levels and research gaps identified]" + +### 4. Generate Customer Behavior Content + +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare customer behavior analysis with web search citations: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## Customer Behavior and Segments + +### Customer Behavior Patterns + +[Customer behavior patterns analysis with source citations] +_Behavior Drivers: [Key motivations and patterns from web search]_ +_Interaction Preferences: [Customer engagement and interaction patterns]_ +_Decision Habits: [How customers typically make decisions]_ +_Source: [URL with {{current_year}} customer behavior data]_ + +### Demographic Segmentation + +[Demographic analysis with source citations] +_Age Demographics: [Age groups and preferences]_ +_Income Levels: [Income segments and purchasing behavior]_ +_Geographic Distribution: [Regional/city differences]_ +_Education Levels: [Education impact on behavior]_ +_Source: [URL with {{current_year}} demographic data]_ + +### Psychographic Profiles + +[Psychographic analysis with source citations] +_Values and Beliefs: [Core values driving customer behavior]_ +_Lifestyle Preferences: [Lifestyle choices and behaviors]_ +_Attitudes and Opinions: [Customer attitudes toward products/services]_ +_Personality Traits: [Personality influences on behavior]_ +_Source: [URL with {{current_year}} psychographic data]_ + +### Customer Segment Profiles + +[Detailed customer segment profiles with source citations] +_Segment 1: [Detailed profile including demographics, psychographics, behavior]_ +_Segment 2: [Detailed profile including demographics, psychographics, behavior]_ +_Segment 3: [Detailed profile including demographics, psychographics, behavior]_ +_Source: [URL with {{current_year}} segment data]_ + +### Behavior Drivers and Influences + +[Behavior drivers analysis with source citations] +_Emotional Drivers: [Emotional factors influencing behavior]_ +_Rational Drivers: [Logical decision factors]_ +_Social Influences: [Social and peer influences]_ +_Economic Influences: [Economic factors affecting behavior]_ +_Source: [URL with {{current_year}} behavior drivers data]_ + +### Customer Interaction Patterns + +[Customer interaction analysis with source citations] +_Research and Discovery: [How customers find and research options]_ +_Purchase Decision Process: [Steps in purchase decision making]_ +_Post-Purchase Behavior: [After-purchase engagement patterns]_ +_Loyalty and Retention: [Factors driving customer loyalty]_ +_Source: [URL with {{current_year}} interaction data]_ +``` + +### 5. Present Analysis and Continue Option + +**Show analysis and present continue option:** + +"I've completed **customer behavior analysis** using current {{current_year}} data to understand customer patterns for {{research_topic}}. + +**Key Customer Behavior Findings:** + +- Customer behavior patterns clearly identified with drivers +- Demographic segmentation thoroughly analyzed +- Psychographic profiles mapped and documented +- Customer interaction patterns captured +- Multiple sources verified for critical insights + +**Ready to proceed to customer pain points?** +[C] Continue - Save this to document and proceed to pain points analysis + +### 6. Handle Continue Selection + +#### If 'C' (Continue): + +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2]` +- Load: `./step-03-customer-pain-points.md` + +## APPEND TO DOCUMENT: + +Content is already written to document when generated in step 4. No additional append needed. + +## SUCCESS METRICS: + +✅ Customer behavior patterns identified with current {{current_year}} citations +✅ Demographic segmentation thoroughly analyzed +✅ Psychographic profiles clearly documented +✅ Customer interaction patterns captured +✅ Multiple sources verified for critical insights +✅ Content written immediately to document +✅ [C] continue option presented and handled correctly +✅ Proper routing to next step (customer pain points) +✅ Research goals alignment maintained + +## FAILURE MODES: + +❌ Not using {{current_year}} in customer web searches +❌ Missing critical customer behavior patterns +❌ Incomplete demographic segmentation analysis +❌ Missing psychographic profile documentation +❌ Not writing content immediately to document +❌ Not presenting [C] continue option after content generation +❌ Not routing to customer pain points analysis step +❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor research 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 + +## CUSTOMER BEHAVIOR RESEARCH PROTOCOLS: + +- Research customer behavior studies and market research +- Use demographic data from authoritative sources +- Research psychographic profiling and value systems +- Analyze customer interaction and engagement patterns +- Focus on current {{current_year}} behavior data and trends +- Present conflicting information when sources disagree +- Apply confidence levels appropriately + +## BEHAVIOR ANALYSIS STANDARDS: + +- Always cite URLs for web search results +- Use authoritative customer research sources +- Note data currency and potential limitations +- Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable customer insights + +## NEXT STEP: + +After user selects 'C', load `./step-03-customer-pain-points.md` to analyze customer pain points, challenges, and unmet needs for {{research_topic}}. + +Remember: Always write research content to document immediately and emphasize current {{current_year}} customer data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md index 3b9d07d9..293af809 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md @@ -3,6 +3,9 @@ ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current customer data - 📋 YOU ARE A CUSTOMER INSIGHTS ANALYST, not content generator - 💬 FOCUS on customer behavior and needs analysis @@ -176,6 +179,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Not presenting [C] continue option 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 + ## CUSTOMER RESEARCH PROTOCOLS: - Search for customer behavior studies and surveys diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md new file mode 100644 index 00000000..898c6254 --- /dev/null +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md @@ -0,0 +1,247 @@ +# Market Research Step 3: Customer Pain Points and Needs + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current customer data +- 📋 YOU ARE A CUSTOMER NEEDS ANALYST, not content generator +- 💬 FOCUS on customer pain points, challenges, and unmet needs +- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT + +## EXECUTION PROTOCOLS: + +- 🎯 Show web search analysis before presenting findings +- ⚠️ Present [C] continue option after pain points content generation +- 📝 WRITE CUSTOMER PAIN POINTS ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from previous steps are available +- Customer behavior analysis completed in previous step +- Focus on customer pain points, challenges, and unmet needs +- Web search capabilities with source verification are enabled +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion + +## YOUR TASK: + +Conduct customer pain points and needs analysis using current {{current_year}} web data with emphasis on challenges and frustrations. + +## CUSTOMER PAIN POINTS ANALYSIS SEQUENCE: + +### 1. Begin Customer Pain Points Analysis + +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different customer pain point areas simultaneously and thoroughly. + +Start with customer pain points research approach: +"Now I'll conduct **customer pain points analysis** for **{{research_topic}}** using current {{current_year}} web data to understand customer challenges. + +**Customer Pain Points Focus:** + +- Customer challenges and frustrations +- Unmet needs and unaddressed problems +- Barriers to adoption or usage +- Service and support pain points +- Customer satisfaction gaps + +**Let me search for current customer pain points insights.**" + +### 2. Parallel Pain Points Research Execution + +**Execute multiple web searches simultaneously:** + +`WebSearch: "{{research_topic}} customer pain points challenges {{current_year}}"` +`WebSearch: "{{research_topic}} customer frustrations {{current_year}}"` +`WebSearch: "{{research_topic}} unmet customer needs {{current_year}}"` +`WebSearch: "{{research_topic}} customer barriers to adoption {{current_year}}"` + +**Analysis approach:** + +- Look for customer satisfaction surveys and reports +- Search for customer complaints and reviews +- Research customer support and service issues +- Analyze barriers to customer adoption +- Study unmet needs and market gaps + +### 3. Analyze and Aggregate Results + +**Collect and analyze findings from all parallel searches:** + +"After executing comprehensive parallel web searches, let me analyze and aggregate customer pain points findings: + +**Research Coverage:** + +- Customer challenges and frustrations +- Unmet needs and unaddressed problems +- Barriers to adoption or usage +- Service and support pain points + +**Cross-Pain Points Analysis:** +[Identify patterns connecting different types of pain points] + +**Quality Assessment:** +[Overall confidence levels and research gaps identified]" + +### 4. Generate Customer Pain Points Content + +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare customer pain points analysis with web search citations: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## Customer Pain Points and Needs + +### Customer Challenges and Frustrations + +[Customer challenges analysis with source citations] +_Primary Frustrations: [Major customer frustrations identified]_ +_Usage Barriers: [Barriers preventing effective usage]_ +_Service Pain Points: [Customer service and support issues]_ +_Frequency Analysis: [How often these challenges occur]_ +_Source: [URL with {{current_year}} customer challenges data]_ + +### Unmet Customer Needs + +[Unmet needs analysis with source citations] +_Critical Unmet Needs: [Most important unaddressed needs]_ +_Solution Gaps: [Opportunities to address unmet needs]_ +_Market Gaps: [Market opportunities from unmet needs]_ +_Priority Analysis: [Which needs are most critical]_ +_Source: [URL with {{current_year}} unmet needs data]_ + +### Barriers to Adoption + +[Adoption barriers analysis with source citations] +_Price Barriers: [Cost-related barriers to adoption]_ +_Technical Barriers: [Complexity or technical barriers]_ +_Trust Barriers: [Trust and credibility issues]_ +_Convenience Barriers: [Ease of use or accessibility issues]_ +_Source: [URL with {{current_year}} adoption barriers data]_ + +### Service and Support Pain Points + +[Service pain points analysis with source citations] +_Customer Service Issues: [Common customer service problems]_ +_Support Gaps: [Areas where customer support is lacking]_ +_Communication Issues: [Communication breakdowns and frustrations]_ +_Response Time Issues: [Slow response and resolution problems]_ +_Source: [URL with {{current_year}} service pain points data]_ + +### Customer Satisfaction Gaps + +[Satisfaction gap analysis with source citations] +_Expectation Gaps: [Differences between expectations and reality]_ +_Quality Gaps: [Areas where quality expectations aren't met]_ +_Value Perception Gaps: [Perceived value vs actual value]_ +_Trust and Credibility Gaps: [Trust issues affecting satisfaction]_ +_Source: [URL with {{current_year}} satisfaction gap data]_ + +### Emotional Impact Assessment + +[Emotional impact analysis with source citations] +_Frustration Levels: [Customer frustration severity assessment]_ +_Loyalty Risks: [How pain points affect customer loyalty]_ +_Reputation Impact: [Impact on brand or product reputation]_ +_Customer Retention Risks: [Risk of customer loss from pain points]_ +_Source: [URL with {{current_year}} emotional impact data]_ + +### Pain Point Prioritization + +[Pain point prioritization with source citations] +_High Priority Pain Points: [Most critical pain points to address]_ +_Medium Priority Pain Points: [Important but less critical pain points]_ +_Low Priority Pain Points: [Minor pain points with lower impact]_ +_Opportunity Mapping: [Pain points with highest solution opportunity]_ +_Source: [URL with {{current_year}} prioritization data]_ +``` + +### 5. Present Analysis and Continue Option + +**Show analysis and present continue option:** + +"I've completed **customer pain points analysis** using current {{current_year}} data to understand customer challenges for {{research_topic}}. + +**Key Pain Points Findings:** + +- Customer challenges and frustrations thoroughly documented +- Unmet needs and solution gaps clearly identified +- Adoption barriers and service pain points analyzed +- Customer satisfaction gaps assessed +- Pain points prioritized by impact and opportunity + +**Ready to proceed to customer decision processes?** +[C] Continue - Save this to document and proceed to decision processes analysis + +### 6. Handle Continue Selection + +#### If 'C' (Continue): + +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2, 3]` +- Load: `./step-04-customer-decisions.md` + +## APPEND TO DOCUMENT: + +Content is already written to document when generated in step 4. No additional append needed. + +## SUCCESS METRICS: + +✅ Customer challenges and frustrations clearly documented +✅ Unmet needs and solution gaps identified +✅ Adoption barriers and service pain points analyzed +✅ Customer satisfaction gaps assessed +✅ Pain points prioritized by impact and opportunity +✅ Content written immediately to document +✅ [C] continue option presented and handled correctly +✅ Proper routing to next step (customer decisions) +✅ Research goals alignment maintained + +## FAILURE MODES: + +❌ Not using {{current_year}} in customer web searches +❌ Missing critical customer challenges or frustrations +❌ Not identifying unmet needs or solution gaps +❌ Incomplete adoption barriers analysis +❌ Not writing content immediately to document +❌ Not presenting [C] continue option after content generation +❌ Not routing to customer decisions analysis step + +❌ **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 + +## CUSTOMER PAIN POINTS RESEARCH PROTOCOLS: + +- Research customer satisfaction surveys and reviews +- Use customer feedback and complaint data +- Analyze customer support and service issues +- Study barriers to customer adoption +- Focus on current {{current_year}} pain point data +- Present conflicting information when sources disagree +- Apply confidence levels appropriately + +## PAIN POINTS ANALYSIS STANDARDS: + +- Always cite URLs for web search results +- Use authoritative customer research sources +- Note data currency and potential limitations +- Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable pain point insights + +## NEXT STEP: + +After user selects 'C', load `./step-04-customer-decisions.md` to analyze customer decision processes, journey mapping, and decision factors for {{research_topic}}. + +Remember: Always write research content to document immediately and emphasize current {{current_year}} customer pain points data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md new file mode 100644 index 00000000..910995be --- /dev/null +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md @@ -0,0 +1,257 @@ +# Market Research Step 4: Customer Decisions and Journey + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current customer data +- 📋 YOU ARE A CUSTOMER DECISION ANALYST, not content generator +- 💬 FOCUS on customer decision processes and journey mapping +- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT + +## EXECUTION PROTOCOLS: + +- 🎯 Show web search analysis before presenting findings +- ⚠️ Present [C] continue option after decision processes content generation +- 📝 WRITE CUSTOMER DECISIONS ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed 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 + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from previous steps are available +- Customer behavior and pain points analysis completed in previous steps +- Focus on customer decision processes and journey mapping +- Web search capabilities with source verification are enabled +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion + +## YOUR TASK: + +Conduct customer decision processes and journey analysis using current {{current_year}} web data with emphasis on decision factors and journey mapping. + +## CUSTOMER DECISIONS ANALYSIS SEQUENCE: + +### 1. Begin Customer Decisions Analysis + +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different customer decision areas simultaneously and thoroughly. + +Start with customer decisions research approach: +"Now I'll conduct **customer decision processes analysis** for **{{research_topic}}** using current {{current_year}} web data to understand customer decision-making. + +**Customer Decisions Focus:** + +- Customer decision-making processes +- Decision factors and criteria +- Customer journey mapping +- Purchase decision influencers +- Information gathering patterns + +**Let me search for current customer decision insights.**" + +### 2. Parallel Decisions Research Execution + +**Execute multiple web searches simultaneously:** + +`WebSearch: "{{research_topic}} customer decision process {{current_year}}"` +`WebSearch: "{{research_topic}} buying criteria factors {{current_year}}"` +`WebSearch: "{{research_topic}} customer journey mapping {{current_year}}"` +`WebSearch: "{{research_topic}} decision influencing factors {{current_year}}"` + +**Analysis approach:** + +- Look for customer decision research studies +- Search for buying criteria and factor analysis +- Research customer journey mapping methodologies +- Analyze decision influence factors and channels +- Study information gathering and evaluation patterns + +### 3. Analyze and Aggregate Results + +**Collect and analyze findings from all parallel searches:** + +"After executing comprehensive parallel web searches, let me analyze and aggregate customer decision findings: + +**Research Coverage:** + +- Customer decision-making processes +- Decision factors and criteria +- Customer journey mapping +- Decision influence factors + +**Cross-Decisions Analysis:** +[Identify patterns connecting decision factors and journey stages] + +**Quality Assessment:** +[Overall confidence levels and research gaps identified]" + +### 4. Generate Customer Decisions Content + +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare customer decisions analysis with web search citations: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## Customer Decision Processes and Journey + +### Customer Decision-Making Processes + +[Decision processes analysis with source citations] +_Decision Stages: [Key stages in customer decision making]_ +_Decision Timelines: [Timeframes for different decisions]_ +_Complexity Levels: [Decision complexity assessment]_ +_Evaluation Methods: [How customers evaluate options]_ +_Source: [URL with {{current_year}} decision process data]_ + +### Decision Factors and Criteria + +[Decision factors analysis with source citations] +_Primary Decision Factors: [Most important factors in decisions]_ +_Secondary Decision Factors: [Supporting factors influencing decisions]_ +_Weighing Analysis: [How different factors are weighed]_ +_Evoluton Patterns: [How factors change over time]_ +_Source: [URL with {{current_year}} decision factors data]_ + +### Customer Journey Mapping + +[Journey mapping analysis with source citations] +_Awareness Stage: [How customers become aware of {{research_topic}}]_ +_Consideration Stage: [Evaluation and comparison process]_ +_Decision Stage: [Final decision-making process]_ +_Purchase Stage: [Purchase execution and completion]_ +_Post-Purchase Stage: [Post-decision evaluation and behavior]_ +_Source: [URL with {{current_year}} journey mapping data]_ + +### Touchpoint Analysis + +[Touchpoint analysis with source citations] +_Digital Touchpoints: [Online and digital interaction points]_ +_Offline Touchpoints: [Physical and in-person interaction points]_ +_Information Sources: [Where customers get information]_ +_Influence Channels: [What influences customer decisions]_ +_Source: [URL with {{current_year}} touchpoint data]_ + +### Information Gathering Patterns + +[Information patterns analysis with source citations] +_Research Methods: [How customers research options]_ +_Information Sources Trusted: [Most trusted information sources]_ +_Research Duration: [Time spent gathering information]_ +_Evaluation Criteria: [How customers evaluate information]_ +_Source: [URL with {{current_year}} information gathering data]_ + +### Decision Influencers + +[Decision influencer analysis with source citations] +_Peer Influence: [How friends and family influence decisions]_ +_Expert Influence: [How expert opinions affect decisions]_ +_Media Influence: [How media and marketing affect decisions]_ +_Social Proof Influence: [How reviews and testimonials affect decisions]_ +_Source: [URL with {{current_year}} decision influencer data]_ + +### Purchase Decision Factors + +[Purchase decision factors analysis with source citations] +_Immediate Purchase Drivers: [Factors triggering immediate purchase]_ +_Delayed Purchase Drivers: [Factors causing purchase delays]_ +_Brand Loyalty Factors: [Factors driving repeat purchases]_ +_Price Sensitivity: [How price affects purchase decisions]_ +_Source: [URL with {{current_year}} purchase decision data]_ + +### Customer Decision Optimizations + +[Decision optimization analysis with source citations] +_Friction Reduction: [Ways to make decisions easier]_ +_Trust Building: [Building customer trust in decisions]_ +_Conversion Optimization: [Optimizing decision-to-purchase rates]_ +_Loyalty Building: [Building long-term customer relationships]_ +_Source: [URL with {{current_year}} decision optimization data]_ +``` + +### 5. Present Analysis and Continue Option + +**Show analysis and present continue option:** + +"I've completed **customer decision processes analysis** using current {{current_year}} data to understand customer decision-making for {{research_topic}}. + +**Key Decision Findings:** + +- Customer decision-making processes clearly mapped +- Decision factors and criteria thoroughly analyzed +- Customer journey mapping completed across all stages +- Decision influencers and touchpoints identified +- Information gathering patterns documented + +**Ready to proceed to competitive analysis?** +[C] Continue - Save this to document and proceed to competitive analysis + +### 6. Handle Continue Selection + +#### If 'C' (Continue): + +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` +- Load: `./step-05-competitive-analysis.md` + +## APPEND TO DOCUMENT: + +Content is already written to document when generated in step 4. No additional append needed. + +## SUCCESS METRICS: + +✅ Customer decision-making processes clearly mapped +✅ Decision factors and criteria thoroughly analyzed +✅ Customer journey mapping completed across all stages +✅ Decision influencers and touchpoints identified +✅ Information gathering patterns documented +✅ Content written immediately to document +✅ [C] continue option presented and handled correctly +✅ Proper routing to next step (competitive analysis) +✅ Research goals alignment maintained + +## FAILURE MODES: + +❌ Not using {{current_year}} in customer web searches +❌ Missing critical decision-making process stages +❌ Not identifying key decision factors +❌ Incomplete customer journey mapping +❌ Not writing content immediately to document +❌ Not presenting [C] continue option after content generation +❌ Not routing to competitive analysis step + +❌ **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 + +## CUSTOMER DECISIONS RESEARCH PROTOCOLS: + +- Research customer decision studies and psychology +- Use customer journey mapping methodologies +- Analyze buying criteria and decision factors +- Study decision influence and touchpoint analysis +- Focus on current {{current_year}} decision data +- Present conflicting information when sources disagree +- Apply confidence levels appropriately + +## DECISION ANALYSIS STANDARDS: + +- Always cite URLs for web search results +- Use authoritative customer decision research sources +- Note data currency and potential limitations +- Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable decision insights + +## NEXT STEP: + +After user selects 'C', load `./step-05-competitive-analysis.md` to analyze competitive landscape, market positioning, and competitive strategies for {{research_topic}}. + +Remember: Always write research content to document immediately and emphasize current {{current_year}} customer decision data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-competitive-analysis.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md similarity index 88% rename from src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-competitive-analysis.md rename to src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md index c71439c2..4a8ff90c 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-competitive-analysis.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md @@ -1,8 +1,11 @@ -# Market Research Step 3: Competitive Analysis +# Market Research Step 5: Competitive Analysis ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current competitive data - 📋 YOU ARE A COMPETITIVE ANALYST, not content generator - 💬 FOCUS on competitive landscape and market positioning @@ -13,7 +16,7 @@ - 🎯 Show web search analysis before presenting findings - ⚠️ Present [C] complete option after competitive analysis content generation - 💾 ONLY save when user chooses C (Complete) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before completing workflow +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before completing workflow - 🚫 FORBIDDEN to complete workflow until C is selected ## CONTEXT BOUNDARIES: @@ -139,6 +142,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Not presenting completion option for research workflow ❌ 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 + ## COMPETITIVE RESEARCH PROTOCOLS: - Search for industry reports and competitive intelligence diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-research-completion.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md similarity index 95% rename from src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-research-completion.md rename to src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md index 1b70c8cb..14be3495 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-research-completion.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md @@ -1,8 +1,11 @@ -# Market Research Step 4: Research Completion +# Market Research Step 6: Research Completion ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current market data - 📋 YOU ARE A MARKET RESEARCH STRATEGIST, not content generator - 💬 FOCUS on strategic recommendations and actionable insights @@ -13,7 +16,7 @@ - 🎯 Show web search analysis before presenting findings - ⚠️ Present [C] complete option after completion content generation - 💾 ONLY save when user chooses C (Complete) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before completing workflow +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before completing workflow - 🚫 FORBIDDEN to complete workflow until C is selected - 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary @@ -22,7 +25,7 @@ - Current document and frontmatter from previous steps are available - **Research topic = "{{research_topic}}"** - comprehensive market analysis - **Research goals = "{{research_goals}}"** - achieved through exhaustive market research -- All market research sections have been completed (customer insights, competitive analysis) +- All market research sections have been completed (customer behavior, pain points, decisions, competitive analysis) - Web search capabilities with source verification are enabled - This is the final synthesis step producing the complete market research document @@ -417,6 +420,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Producing market document without professional structure ❌ Not presenting completion option for final market document +❌ **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 + ## STRATEGIC RESEARCH PROTOCOLS: - Search for current market strategy frameworks and best practices diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md index 92475ced..63f96ea9 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md @@ -1,203 +1,136 @@ -# Technical Research Step 1: Technical Initialization +# Technical Research Step 1: Technical Research Scope Confirmation ## MANDATORY EXECUTION RULES (READ FIRST): -- 🛑 NEVER generate content without user input -- ✅ ALWAYS use {{current_year}} web searches for current technical data -- 📋 YOU ARE A TECHNICAL ANALYST, not content generator -- 💬 FOCUS on technical architecture and implementation patterns -- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 🛑 NEVER generate content without user confirmation + +- 📖 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 +- ✅ FOCUS EXCLUSIVELY on confirming technical research scope and approach +- 📋 YOU ARE A TECHNICAL RESEARCH PLANNER, not content generator +- 💬 ACKNOWLEDGE and CONFIRM understanding of technical research goals +- 🔍 This is SCOPE CONFIRMATION ONLY - no web research yet ## EXECUTION PROTOCOLS: -- 🎯 Show web search analysis before presenting findings -- ⚠️ Present [C] continue option after technical overview content generation -- 💾 ONLY save when user chooses C (Continue) +- 🎯 Show your analysis before taking any action +- ⚠️ Present [C] continue option after scope confirmation +- 💾 ONLY proceed when user chooses C (Continue) - 📖 Update frontmatter `stepsCompleted: [1]` before loading next step - 🚫 FORBIDDEN to load next step until C is selected ## CONTEXT BOUNDARIES: -- Current document and frontmatter from main workflow discovery are available - Research type = "technical" is already set - **Research topic = "{{research_topic}}"** - discovered from initial discussion - **Research goals = "{{research_goals}}"** - captured from initial discussion -- Focus on technical research with current {{current_year}} data -- Web search capabilities with source verification are enabled +- Focus on technical architecture and implementation research +- Web search capabilities with {{current_year}} data are enabled ## YOUR TASK: -Initialize technical research scope and approach for the already-identified topic: **{{research_topic}}** with goals: {{research_goals}} +Confirm technical research scope and approach for **{{research_topic}}** with the user's goals in mind. -## TECHNICAL OVERVIEW SEQUENCE: +## TECHNICAL SCOPE CONFIRMATION: -### 1. Initialize Technical Research +### 1. Begin Scope Confirmation -Start with technical-specific positioning: -"I'll guide you through **technical research** for **{{research_topic}}** using current {{current_year}} web data with rigorous source verification. +Start with technical scope understanding: +"I understand you want to conduct **technical research** for **{{research_topic}}** with these goals: {{research_goals}} -**Research Goals Identified:** {{research_goals}} +**Technical Research Scope:** -**Technical Research Focus for {{research_topic}}:** +- **Architecture Analysis**: System design patterns, frameworks, and architectural decisions +- **Implementation Approaches**: Development methodologies, coding patterns, and best practices +- **Technology Stack**: Languages, frameworks, tools, and platforms relevant to {{research_topic}} +- **Integration Patterns**: APIs, communication protocols, and system interoperability +- **Performance Considerations**: Scalability, optimization, and performance patterns -- Technical architecture patterns and frameworks relevant to {{research_topic}} -- Implementation approaches and best practices for {{research_topic}} -- Technology stack evolution and trends affecting {{research_topic}} -- Integration patterns and interoperability for {{research_topic}} -- Performance and scalability considerations for {{research_topic}} +**Research Approach:** -Let me refine the technical research scope specifically for **{{research_topic}}**: +- Current {{current_year}} web data with rigorous source verification +- Multi-source validation for critical technical claims +- Confidence levels for uncertain technical information +- Comprehensive technical coverage with architecture-specific insights -### 2. Establish Technical Research Context +### 2. Scope Confirmation -#### Technical Context Questions: +Present clear scope confirmation: +"**Technical Research Scope Confirmation:** -- "What technical aspects of {{research_topic}} are most critical for your goals?" -- "Are there particular technologies or platforms within {{research_topic}} we should focus on?" -- "Should we analyze current state of {{research_topic}} or include future technical trends?" -- "What depth of technical analysis do you need for {{research_topic}} - overview or comprehensive?" -- "Are there specific integration or implementation concerns for {{research_topic}}?" +For **{{research_topic}}**, I will research: -### 3. Begin Technical Research Execution +✅ **Architecture Analysis** - design patterns, frameworks, system architecture +✅ **Implementation Approaches** - development methodologies, coding patterns +✅ **Technology Stack** - languages, frameworks, tools, platforms +✅ **Integration Patterns** - APIs, protocols, interoperability +✅ **Performance Considerations** - scalability, optimization, patterns -After scope refinement, proceed with: +**All using current {{current_year}} web data with source verification.** -### 2. Web Search for Technical Architecture +**Does this technical research scope and approach align with your goals?** +[C] Continue - Begin technical research with this scope -Search for current architecture patterns: -`WebSearch: "[technology/domain] architecture patterns frameworks {{current_year}}"` - -**Architecture focus:** - -- Current architectural patterns and design principles -- Frameworks and platforms commonly used -- Microservices, monolith, and hybrid approaches -- Cloud-native and edge computing patterns - -### 3. Web Search for Implementation Approaches - -Search for current implementation practices: -`WebSearch: "[technology/domain] implementation best practices {{current_year}}"` - -**Implementation focus:** - -- Development methodologies and approaches -- Code organization and structure patterns -- Testing and quality assurance practices -- Deployment and operations strategies - -### 4. Web Search for Technology Stack Trends - -Search for current technology trends: -`WebSearch: "[technology/domain] technology stack trends {{current_year}}"` - -**Stack focus:** - -- Programming languages and frameworks popularity -- Database and storage technologies -- APIs and communication protocols -- Development tools and platforms - -### 5. Generate Technical Overview Content - -Prepare technical analysis with web search citations: - -#### Content Structure: - -When saving to document, append these Level 2 and Level 3 sections: - -```markdown -## Technical Overview - -### Current Architecture Patterns - -[Architecture patterns analysis with source citations] -_Source: [URL with {{current_year}} architecture data]_ - -### Implementation Approaches - -[Implementation approaches analysis with source citations] -_Source: [URL with {{current_year}} implementation data]_ - -### Technology Stack Evolution - -[Technology stack analysis with source citations] -_Source: [URL with {{current_year}} technology data]_ - -### Integration and Interoperability - -[Integration patterns analysis with source citations] -_Source: [URL with {{current_year}} integration data]_ - -### Performance and Scalability Patterns - -[Performance patterns analysis with source citations] -_Source: [URL with {{current_year}} performance data]_ - -### Development and Operations Practices - -[DevOps practices analysis with source citations] -_Source: [URL with {{current_year}} DevOps data]_ -``` - -### 6. Present Analysis and Continue Option - -Show the generated technical overview and present continue option: -"I've completed the **technical overview analysis** using current {{current_year}} data to understand the technical landscape. - -**Key Technical Findings:** - -- Current architecture patterns and frameworks identified -- Implementation approaches and best practices mapped -- Technology stack evolution and trends documented -- Integration patterns and interoperability analyzed -- Performance and scalability considerations captured - -**Ready to proceed to architectural patterns?** -[C] Continue - Save this to the document and move to architectural patterns - -### 7. Handle Continue Selection +### 3. Handle Continue Selection #### If 'C' (Continue): -- Append the final content to the research document +- Document scope confirmation in research file - Update frontmatter: `stepsCompleted: [1]` -- Load: `./step-02-technical-overview.md` +- Load: `./step-02-technology-stack.md` ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the research document using the structure from step 5. +When user selects 'C', append scope confirmation: + +```markdown +## Technical Research Scope Confirmation + +**Research Topic:** {{research_topic}} +**Research Goals:** {{research_goals}} + +**Technical Research Scope:** + +- Architecture Analysis - design patterns, frameworks, system architecture +- Implementation Approaches - development methodologies, coding patterns +- Technology Stack - languages, frameworks, tools, platforms +- Integration Patterns - APIs, protocols, interoperability +- Performance Considerations - scalability, optimization, patterns + +**Research Methodology:** + +- Current {{current_year}} web data with rigorous source verification +- Multi-source validation for critical technical claims +- Confidence level framework for uncertain information +- Comprehensive technical coverage with architecture-specific insights + +**Scope Confirmed:** {{date}} +``` ## SUCCESS METRICS: -✅ Architecture patterns identified with current {{current_year}} citations -✅ Implementation approaches clearly documented -✅ Technology stack evolution thoroughly analyzed -✅ Integration patterns and interoperability mapped -✅ Performance and scalability considerations captured +✅ Technical research scope clearly confirmed with user +✅ All technical analysis areas identified and explained +✅ Research methodology with {{current_year}} data emphasized ✅ [C] continue option presented and handled correctly -✅ Content properly appended to document when C selected -✅ Proper routing to architectural patterns step +✅ Scope confirmation documented when user proceeds +✅ Proper routing to next technical research step ## FAILURE MODES: -❌ Not using {{current_year}} in technical web searches -❌ Missing critical architecture patterns or frameworks -❌ Not identifying current implementation best practices -❌ Incomplete technology stack evolution analysis -❌ Not presenting [C] continue option after content generation -❌ Appending content without user selecting 'C' +❌ Not clearly confirming technical research scope with user +❌ Missing critical technical analysis areas +❌ Not emphasizing {{current_year}} web data requirement +❌ Not presenting [C] continue option +❌ Proceeding without user scope confirmation +❌ Not routing to next technical research step -## TECHNICAL RESEARCH PROTOCOLS: - -- Search for technical documentation and architecture guides -- Use industry technical publications and conference proceedings -- Research open-source projects and their architectures -- Note technology adoption patterns and migration trends -- Research performance benchmarking and optimization techniques +❌ **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 ## NEXT STEP: -After user selects 'C', load `./step-02-technical-overview.md` to focus on specific architectural patterns and design decisions. +After user selects 'C', load `./step-02-technology-stack.md` to begin technology stack analysis with current {{current_year}} web data. -Remember: Always emphasize current {{current_year}} technical data and rigorous source verification! +Remember: This is SCOPE CONFIRMATION ONLY - no actual technical research yet, just confirming the research approach and scope! diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md index a610fcb6..a420fa55 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md @@ -1,185 +1,237 @@ -# Technical Research Step 2: Technical Overview +# Technical Research Step 2: Technology Stack Analysis ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification -- ✅ ALWAYS use {{current_year}} web searches for current technical data -- 📋 YOU ARE A TECHNICAL ANALYST, not content generator -- 💬 FOCUS on technical architecture and implementation patterns + +- 📖 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 use {{current_year}} web searches for current technology data +- 📋 YOU ARE A TECHNOLOGY STACK ANALYST, not content generator +- 💬 FOCUS on languages, frameworks, tools, and platforms - 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT ## EXECUTION PROTOCOLS: - 🎯 Show web search analysis before presenting findings -- ⚠️ Present [C] continue option after technical overview content generation -- 💾 ONLY save when user chooses C (Continue) +- ⚠️ Present [C] continue option after technology stack content generation +- 📝 WRITE TECHNOLOGY STACK ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed when user chooses C (Continue) - 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step - 🚫 FORBIDDEN to load next step until C is selected ## CONTEXT BOUNDARIES: - Current document and frontmatter from step-01 are available -- Focus on technical architecture and implementation landscape +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion +- Focus on languages, frameworks, tools, and platforms - Web search capabilities with source verification are enabled -- May need to search for current technical trends and frameworks ## YOUR TASK: -Conduct comprehensive technical overview using current {{current_year}} web data with emphasis on architecture patterns and implementation approaches. +Conduct technology stack analysis focusing on languages, frameworks, tools, and platforms using current {{current_year}} web data with rigorous source verification. -## TECHNICAL OVERVIEW SEQUENCE: +## TECHNOLOGY STACK ANALYSIS SEQUENCE: -### 1. Begin Technical Overview +### 1. Begin Technology Stack Analysis -**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different technical areas simultaneously and thoroughly +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different technology stack areas simultaneously and thoroughly. -Start with technical research approach: -"Now I'll conduct **technical overview analysis** using current {{current_year}} web data to understand the technical landscape for [technology/domain]. +Start with technology stack research approach: +"Now I'll conduct **technology stack analysis** for **{{research_topic}}** using current {{current_year}} web data to understand the technology landscape. -**Technical Overview Focus:** +**Technology Stack Focus:** -- Current technical architecture patterns and frameworks -- Implementation approaches and best practices -- Technology stack evolution and trends -- Integration patterns and interoperability -- Performance and scalability considerations +- Programming languages and their evolution +- Development frameworks and libraries +- Database and storage technologies +- Development tools and platforms +- Cloud infrastructure and deployment platforms -**Let me search for current technical landscape information using parallel web searches for comprehensive coverage.**" +**Let me search for current technology stack insights.**" -### 2. Parallel Technical Research Execution +### 2. Parallel Technology Stack Research Execution **Execute multiple web searches simultaneously:** -`WebSearch: "[technology/domain] architecture patterns frameworks {{current_year}}"` -`WebSearch: "[technology/domain] implementation best practices {{current_year}}"` -`WebSearch: "[technology/domain] technology stack trends {{current_year}}"` +`WebSearch: "{{research_topic}} programming languages frameworks {{current_year}}"` +`WebSearch: "{{research_topic}} development tools platforms {{current_year}}"` +`WebSearch: "{{research_topic}} database storage technologies {{current_year}}"` +`WebSearch: "{{research_topic}} cloud infrastructure platforms {{current_year}}"` **Analysis approach:** -- Look for recent technical documentation and architecture guides -- Search for technical publications and conference proceedings -- Research open-source projects and their architectures -- Note technology adoption patterns and migration trends -- Research performance benchmarking and optimization techniques +- Look for recent technology trend reports and developer surveys +- Search for technology documentation and best practices +- Research open-source projects and their technology choices +- Analyze technology adoption patterns and migration trends +- Study platform and tool evolution in the domain ### 3. Analyze and Aggregate Results **Collect and analyze findings from all parallel searches:** -"After executing comprehensive parallel web searches, let me analyze and aggregate the technical findings: +"After executing comprehensive parallel web searches, let me analyze and aggregate technology stack findings: **Research Coverage:** -- Architecture patterns and design principles -- Implementation approaches and methodologies -- Technology stack evolution and current trends +- Programming languages and frameworks analysis +- Development tools and platforms evaluation +- Database and storage technologies assessment +- Cloud infrastructure and deployment platform analysis -**Technical Integration Analysis:** -[Identify how architecture patterns influence implementation approaches and technology choices] +**Cross-Technology Analysis:** +[Identify patterns connecting language choices, frameworks, and platform decisions] **Quality Assessment:** [Overall confidence levels and research gaps identified]" -### 4. Generate Technical Overview Content +### 4. Generate Technology Stack Content -Prepare technical analysis with web search citations: +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare technology stack analysis with web search citations: #### Content Structure: When saving to document, append these Level 2 and Level 3 sections: ```markdown -## Technical Overview +## Technology Stack Analysis -### Current Architecture Patterns +### Programming Languages -[Architecture patterns analysis with source citations] -_Source: [URL with {{current_year}} architecture data]_ +[Programming languages analysis with source citations] +_Popular Languages: [Most widely used languages for {{research_topic}}]_ +_Emerging Languages: [Growing languages gaining adoption]_ +_Language Evolution: [How language preferences are changing]_ +_Performance Characteristics: [Language performance and suitability]_ +_Source: [URL with {{current_year}} language data]_ -### Implementation Approaches +### Development Frameworks and Libraries -[Implementation approaches analysis with source citations] -_Source: [URL with {{current_year}} implementation data]_ +[Frameworks analysis with source citations] +_Major Frameworks: [Dominant frameworks and their use cases]_ +_Micro-frameworks: [Lightweight options and specialized libraries]_ +_Evolution Trends: [How frameworks are evolving and changing]_ +_Ecosystem Maturity: [Library availability and community support]_ +_Source: [URL with {{current_year}} framework data]_ -### Technology Stack Evolution +### Database and Storage Technologies -[Technology stack analysis with source citations] -_Source: [URL with {{current_year}} technology data]_ +[Database analysis with source citations] +_Relational Databases: [Traditional SQL databases and their evolution]_ +_NoSQL Databases: [Document, key-value, graph, and other NoSQL options]_ +_In-Memory Databases: [Redis, Memcached, and performance-focused solutions]_ +_Data Warehousing: [Analytics and big data storage solutions]_ +_Source: [URL with {{current_year}} database data]_ -### Integration and Interoperability +### Development Tools and Platforms -[Integration patterns analysis with source citations] -_Source: [URL with {{current_year}} integration data]_ +[Tools and platforms analysis with source citations] +_IDE and Editors: [Development environments and their evolution]_ +_Version Control: [Git and related development tools]_ +_Build Systems: [Compilation, packaging, and automation tools]_ +_Testing Frameworks: [Unit testing, integration testing, and QA tools]_ +_Source: [URL with {{current_year}} tools data]_ -### Performance and Scalability Patterns +### Cloud Infrastructure and Deployment -[Performance patterns analysis with source citations] -_Source: [URL with {{current_year}} performance data]_ +[Cloud platforms analysis with source citations] +_Major Cloud Providers: [AWS, Azure, GCP and their services]_ +_Container Technologies: [Docker, Kubernetes, and orchestration]_ +_Serverless Platforms: [FaaS and event-driven computing]_ +_CDN and Edge Computing: [Content delivery and distributed computing]_ +_Source: [URL with {{current_year}} cloud data]_ -### Development and Operations Practices +### Technology Adoption Trends -[DevOps practices analysis with source citations] -_Source: [URL with {{current_year}} DevOps data]_ +[Adoption trends analysis with source citations] +_Migration Patterns: [How technology choices are evolving]_ +_Emerging Technologies: [New technologies gaining traction]_ +_Legacy Technology: [Older technologies being phased out]_ +_Community Trends: [Developer preferences and open-source adoption]_ +_Source: [URL with {{current_year}} adoption data]_ ``` ### 5. Present Analysis and Continue Option -Show the generated technical overview and present continue option: -"I've completed the **technical overview analysis** using current {{current_year}} data to understand the technical landscape. +**Show analysis and present continue option:** -**Key Technical Findings:** +"I've completed **technology stack analysis** using current {{current_year}} data to understand the technology landscape for {{research_topic}}. -- Current architecture patterns and frameworks identified -- Implementation approaches and best practices mapped -- Technology stack evolution and trends documented -- Integration patterns and interoperability analyzed -- Performance and scalability considerations captured +**Key Technology Stack Findings:** -**Ready to proceed to architectural patterns?** -[C] Continue - Save this to the document and move to architectural patterns +- Programming languages and frameworks thoroughly analyzed +- Database and storage technologies evaluated +- Development tools and platforms documented +- Cloud infrastructure and deployment options mapped +- Technology adoption trends identified + +**Ready to proceed to integration patterns analysis?** +[C] Continue - Save this to document and proceed to integration patterns ### 6. Handle Continue Selection #### If 'C' (Continue): -- Append the final content to the research document +- **CONTENT ALREADY WRITTEN TO DOCUMENT** - Update frontmatter: `stepsCompleted: [1, 2]` -- Load: `./step-03-architectural-patterns.md` +- Load: `./step-03-integration-patterns.md` ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the research document using the structure from step 4. +Content is already written to document when generated in step 4. No additional append needed. ## SUCCESS METRICS: -✅ Architecture patterns identified with current {{current_year}} citations -✅ Implementation approaches clearly documented -✅ Technology stack evolution thoroughly analyzed -✅ Integration patterns and interoperability mapped -✅ Performance and scalability considerations captured +✅ Programming languages and frameworks thoroughly analyzed +✅ Database and storage technologies evaluated +✅ Development tools and platforms documented +✅ Cloud infrastructure and deployment options mapped +✅ Technology adoption trends identified +✅ Content written immediately to document ✅ [C] continue option presented and handled correctly -✅ Content properly appended to document when C selected -✅ Proper routing to architectural patterns step +✅ Proper routing to next step (integration patterns) +✅ Research goals alignment maintained ## FAILURE MODES: -❌ Not using {{current_year}} in technical web searches -❌ Missing critical architecture patterns or frameworks -❌ Not identifying current implementation best practices -❌ Incomplete technology stack evolution analysis +❌ Not using {{current_year}} in technology web searches +❌ Missing critical programming languages or frameworks +❌ Incomplete database and storage technology analysis +❌ Not identifying development tools and platforms +❌ Not writing content immediately to document ❌ Not presenting [C] continue option after content generation -❌ Appending content without user selecting 'C' +❌ Not routing to integration patterns step -## TECHNICAL RESEARCH PROTOCOLS: +❌ **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 -- Search for technical documentation and architecture guides -- Use industry technical publications and conference proceedings -- Research open-source projects and their architectures -- Note technology adoption patterns and migration trends -- Research performance benchmarking and optimization techniques +## TECHNOLOGY STACK RESEARCH PROTOCOLS: + +- Research technology trend reports and developer surveys +- Use technology documentation and best practices guides +- Analyze open-source projects and their technology choices +- Study technology adoption patterns and migration trends +- Focus on current {{current_year}} technology data +- Present conflicting information when sources disagree +- Apply confidence levels appropriately + +## TECHNOLOGY STACK ANALYSIS STANDARDS: + +- Always cite URLs for web search results +- Use authoritative technology research sources +- Note data currency and potential limitations +- Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable technology insights ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-03-architectural-patterns.md` to focus on specific architectural patterns and design decisions. +After user selects 'C', load `./step-03-integration-patterns.md` to analyze APIs, communication protocols, and system interoperability for {{research_topic}}. -Remember: Always emphasize current {{current_year}} technical data and rigorous source verification! +Remember: Always write research content to document immediately and emphasize current {{current_year}} technology data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md new file mode 100644 index 00000000..78f89f5d --- /dev/null +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md @@ -0,0 +1,246 @@ +# Technical Research Step 3: Integration Patterns + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current integration data +- 📋 YOU ARE AN INTEGRATION ANALYST, not content generator +- 💬 FOCUS on APIs, protocols, and system interoperability +- 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT + +## EXECUTION PROTOCOLS: + +- 🎯 Show web search analysis before presenting findings +- ⚠️ Present [C] continue option after integration patterns content generation +- 📝 WRITE INTEGRATION PATTERNS ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from previous steps are available +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion +- Focus on APIs, protocols, and system interoperability +- Web search capabilities with source verification are enabled + +## YOUR TASK: + +Conduct integration patterns analysis focusing on APIs, communication protocols, and system interoperability using current {{current_year}} web data with rigorous source verification. + +## INTEGRATION PATTERNS ANALYSIS SEQUENCE: + +### 1. Begin Integration Patterns Analysis + +**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different integration areas simultaneously and thoroughly. + +Start with integration patterns research approach: +"Now I'll conduct **integration patterns analysis** for **{{research_topic}}** using current {{current_year}} web data to understand system integration approaches. + +**Integration Patterns Focus:** + +- API design patterns and protocols +- Communication protocols and data formats +- System interoperability approaches +- Microservices integration patterns +- Event-driven architectures and messaging + +**Let me search for current integration patterns insights.**" + +### 2. Parallel Integration Patterns Research Execution + +**Execute multiple web searches simultaneously:** + +`WebSearch: "{{research_topic}} API design patterns protocols {{current_year}}"` +`WebSearch: "{{research_topic}} communication protocols data formats {{current_year}}"` +`WebSearch: "{{research_topic}} system interoperability integration {{current_year}}"` +`WebSearch: "{{research_topic}} microservices integration patterns {{current_year}}"` + +**Analysis approach:** + +- Look for recent API design guides and best practices +- Search for communication protocol documentation and standards +- Research integration platform and middleware solutions +- Analyze microservices architecture patterns and approaches +- Study event-driven systems and messaging patterns + +### 3. Analyze and Aggregate Results + +**Collect and analyze findings from all parallel searches:** + +"After executing comprehensive parallel web searches, let me analyze and aggregate integration patterns findings: + +**Research Coverage:** + +- API design patterns and protocols analysis +- Communication protocols and data formats evaluation +- System interoperability approaches assessment +- Microservices integration patterns documentation + +**Cross-Integration Analysis:** +[Identify patterns connecting API choices, communication protocols, and system design] + +**Quality Assessment:** +[Overall confidence levels and research gaps identified]" + +### 4. Generate Integration Patterns Content + +**WRITE IMMEDIATELY TO DOCUMENT** + +Prepare integration patterns analysis with web search citations: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## Integration Patterns Analysis + +### API Design Patterns + +[API design patterns analysis with source citations] +_RESTful APIs: [REST principles and best practices for {{research_topic}}]_ +_GraphQL APIs: [GraphQL adoption and implementation patterns]_ +_RPC and gRPC: [High-performance API communication patterns]_ +_Webhook Patterns: [Event-driven API integration approaches]_ +_Source: [URL with {{current_year}} API design data]_ + +### Communication Protocols + +[Communication protocols analysis with source citations] +_HTTP/HTTPS Protocols: [Web-based communication patterns and evolution]_ +_WebSocket Protocols: [Real-time communication and persistent connections]_ +_Message Queue Protocols: [AMQP, MQTT, and messaging patterns]_ +_grpc and Protocol Buffers: [High-performance binary communication protocols]_ +_Source: [URL with {{current_year}} communication protocols data]_ + +### Data Formats and Standards + +[Data formats analysis with source citations] +_JSON and XML: [Structured data exchange formats and their evolution]_ +_Protobuf and MessagePack: [Efficient binary serialization formats]_ +_CSV and Flat Files: [Legacy data integration and bulk transfer patterns]_ +_Custom Data Formats: [Domain-specific data exchange standards]_ +_Source: [URL with {{current_year}} data formats data]_ + +### System Interoperability Approaches + +[Interoperability analysis with source citations] +_Point-to-Point Integration: [Direct system-to-system communication patterns]_ +_API Gateway Patterns: [Centralized API management and routing]_ +_Service Mesh: [Service-to-service communication and observability]_ +_Enterprise Service Bus: [Traditional enterprise integration patterns]_ +_Source: [URL with {{current_year}} interoperability data]_ + +### Microservices Integration Patterns + +[Microservices integration analysis with source citations] +_API Gateway Pattern: [External API management and routing]_ +_Service Discovery: [Dynamic service registration and discovery]_ +_Circuit Breaker Pattern: [Fault tolerance and resilience patterns]_ +_Saga Pattern: [Distributed transaction management]_ +_Source: [URL with {{current_year}} microservices data]_ + +### Event-Driven Integration + +[Event-driven analysis with source citations] +_Publish-Subscribe Patterns: [Event broadcasting and subscription models]_ +_Event Sourcing: [Event-based state management and persistence]_ +_Message Broker Patterns: [RabbitMQ, Kafka, and message routing]_ +_CQRS Patterns: [Command Query Responsibility Segregation]_ +_Source: [URL with {{current_year}} event-driven data]_ + +### Integration Security Patterns + +[Security patterns analysis with source citations] +_OAuth 2.0 and JWT: [API authentication and authorization patterns]_ +_API Key Management: [Secure API access and key rotation]_ +_Mutual TLS: [Certificate-based service authentication]_ +_Data Encryption: [Secure data transmission and storage]_ +_Source: [URL with {{current_year}} integration security data]_ +``` + +### 5. Present Analysis and Continue Option + +**Show analysis and present continue option:** + +"I've completed **integration patterns analysis** using current {{current_year}} data to understand system integration approaches for {{research_topic}}. + +**Key Integration Patterns Findings:** + +- API design patterns and protocols thoroughly analyzed +- Communication protocols and data formats evaluated +- System interoperability approaches documented +- Microservices integration patterns mapped +- Event-driven integration strategies identified + +**Ready to proceed to architectural patterns analysis?** +[C] Continue - Save this to document and proceed to architectural patterns + +### 6. Handle Continue Selection + +#### If 'C' (Continue): + +- **CONTENT ALREADY WRITTEN TO DOCUMENT** +- Update frontmatter: `stepsCompleted: [1, 2, 3]` +- Load: `./step-04-architectural-patterns.md` + +## APPEND TO DOCUMENT: + +Content is already written to document when generated in step 4. No additional append needed. + +## SUCCESS METRICS: + +✅ API design patterns and protocols thoroughly analyzed +✅ Communication protocols and data formats evaluated +✅ System interoperability approaches documented +✅ Microservices integration patterns mapped +✅ Event-driven integration strategies identified +✅ Content written immediately to document +✅ [C] continue option presented and handled correctly +✅ Proper routing to next step (architectural patterns) +✅ Research goals alignment maintained + +## FAILURE MODES: + +❌ Not using {{current_year}} in integration web searches +❌ Missing critical API design patterns or protocols +❌ Incomplete communication protocols analysis +❌ Not identifying system interoperability approaches +❌ Not writing content immediately to document +❌ Not presenting [C] continue option after content generation +❌ Not routing to architectural patterns step + +❌ **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 + +## INTEGRATION PATTERNS RESEARCH PROTOCOLS: + +- Research API design guides and best practices documentation +- Use communication protocol specifications and standards +- Analyze integration platform and middleware solutions +- Study microservices architecture patterns and case studies +- Focus on current {{current_year}} integration data +- Present conflicting information when sources disagree +- Apply confidence levels appropriately + +## INTEGRATION PATTERNS ANALYSIS STANDARDS: + +- Always cite URLs for web search results +- Use authoritative integration research sources +- Note data currency and potential limitations +- Present multiple perspectives when sources conflict +- Apply confidence levels to uncertain data +- Focus on actionable integration insights + +## NEXT STEP: + +After user selects 'C', load `./step-04-architectural-patterns.md` to analyze architectural patterns, design decisions, and system structures for {{research_topic}}. + +Remember: Always write research content to document immediately and emphasize current {{current_year}} integration data with rigorous source verification! diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-architectural-patterns.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md similarity index 85% rename from src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-architectural-patterns.md rename to src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md index 7355a9ad..ae1ff674 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-architectural-patterns.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md @@ -1,31 +1,37 @@ -# Technical Research Step 3: Architectural Patterns +# Technical Research Step 4: Architectural Patterns ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current architectural data - 📋 YOU ARE A SYSTEMS ARCHITECT, not content generator - 💬 FOCUS on architectural patterns and design decisions - 🔍 WEB RESEARCH REQUIRED - Use {{current_year}} data and verify sources +- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT ## EXECUTION PROTOCOLS: - 🎯 Show web search analysis before presenting findings - ⚠️ Present [C] continue option after architectural patterns content generation -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 📝 WRITE ARCHITECTURAL PATTERNS ANALYSIS TO DOCUMENT IMMEDIATELY +- 💾 ONLY proceed 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 ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available +- **Research topic = "{{research_topic}}"** - established from initial discussion +- **Research goals = "{{research_goals}}"** - established from initial discussion - Focus on architectural patterns and design decisions - Web search capabilities with source verification are enabled -- May need to search for specific architectural frameworks and patterns ## YOUR TASK: -Conduct comprehensive architectural patterns analysis using current {{current_year}} web data with emphasis on design decisions and implementation approaches. +Conduct comprehensive architectural patterns analysis using current {{current_year}} web data with emphasis on design decisions and implementation approaches for {{research_topic}}. ## ARCHITECTURAL PATTERNS SEQUENCE: @@ -175,6 +181,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Not presenting [C] continue option 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 + ## ARCHITECTURAL RESEARCH PROTOCOLS: - Search for architecture documentation and pattern catalogs diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-implementation-research.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md similarity index 93% rename from src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-implementation-research.md rename to src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md index af6be3cc..3fc52e03 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-implementation-research.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md @@ -3,6 +3,9 @@ ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current implementation data - 📋 YOU ARE AN IMPLEMENTATION ENGINEER, not content generator - 💬 FOCUS on implementation approaches and technology adoption @@ -200,6 +203,10 @@ When user selects 'C', append the content directly to the research document usin ❌ Not presenting completion option for research workflow ❌ 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 + ## IMPLEMENTATION RESEARCH PROTOCOLS: - Search for implementation case studies and success stories diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-research-synthesis.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md similarity index 97% rename from src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-research-synthesis.md rename to src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md index d59a2d50..67cd1ac6 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-research-synthesis.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md @@ -3,6 +3,9 @@ ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without web search verification + +- 📖 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 use {{current_year}} web searches for current technical data - 📋 YOU ARE A TECHNICAL RESEARCH STRATEGIST, not content generator - 💬 FOCUS on comprehensive technical synthesis and authoritative conclusions @@ -445,6 +448,10 @@ When user selects 'C', append the complete comprehensive technical research docu ❌ Producing technical document without professional structure ❌ Not presenting completion option for final technical document +❌ **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 + ## COMPREHENSIVE TECHNICAL DOCUMENT STANDARDS: This step ensures the final technical research document: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md index 8e08eac1..ea0435b4 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on initialization and setup only - don't look ahead to future steps @@ -145,6 +148,10 @@ Do you have any other documents you'd like me to include, or shall we continue t ❌ Not checking sharded folders first before whole files ❌ Not reporting what documents were found to user +❌ **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 + ## NEXT STEP: After user selects [C] to continue, load `./step-02-discovery.md` to begin the UX discovery phase. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md index 7732621f..84933913 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on understanding where we left off and continuing appropriately @@ -95,6 +98,10 @@ After presenting current progress, ask: ❌ Loading wrong next step based on `lastStep` value ❌ Proceeding without user confirmation of current state +❌ **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 ALREADY COMPLETE? If `lastStep` indicates the final step is completed: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md index a5cec745..540994d0 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on understanding project context and user needs @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -151,7 +154,7 @@ Show the generated project understanding content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current project understanding content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current project understanding content - Process the enhanced project insights that come back - Ask user: "Accept these improvements to the project understanding? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -159,7 +162,7 @@ Show the generated project understanding content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current project understanding +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current project understanding - Process the collaborative insights and different perspectives that come back - Ask user: "Accept these changes to the project understanding? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -195,6 +198,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-03-core-experience.md` to define the core user experience. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md index 5ab991d1..b24dceb2 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining the core user experience and platform @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -157,7 +160,7 @@ Show the generated core experience content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current core experience content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current core experience content - Process the enhanced experience insights that come back - Ask user: "Accept these improvements to the core experience definition? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -165,7 +168,7 @@ Show the generated core experience content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current core experience definition +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current core experience definition - Process the collaborative experience improvements that come back - Ask user: "Accept these changes to the core experience definition? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -201,6 +204,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-04-emotional-response.md` to define desired emotional responses. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md index 9798c3e0..85d75864 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining desired emotional responses and user feelings @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -160,7 +163,7 @@ Show the generated emotional response content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current emotional response content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current emotional response content - Process the enhanced emotional insights that come back - Ask user: "Accept these improvements to the emotional response definition? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -168,7 +171,7 @@ Show the generated emotional response content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current emotional response definition +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current emotional response definition - Process the collaborative emotional insights that come back - Ask user: "Accept these changes to the emotional response definition? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -204,6 +207,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-05-inspiration.md` to analyze UX patterns from inspiring products. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md index 7f80645c..d575178d 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on analyzing existing UX patterns and extracting inspiration @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -175,7 +178,7 @@ Show the generated inspiration analysis content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current inspiration analysis content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current inspiration analysis content - Process the enhanced pattern insights that come back - Ask user: "Accept these improvements to the inspiration analysis? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -183,7 +186,7 @@ Show the generated inspiration analysis content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current inspiration analysis +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current inspiration analysis - Process the collaborative pattern insights that come back - Ask user: "Accept these changes to the inspiration analysis? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -219,6 +222,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-06-design-system.md` to choose the appropriate design system approach. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md index cb8cc518..87009183 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on choosing appropriate design system approach @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -193,7 +196,7 @@ Show the generated design system content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current design system content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current design system content - Process the enhanced design system insights that come back - Ask user: "Accept these improvements to the design system decision? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -201,7 +204,7 @@ Show the generated design system content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current design system choice +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current design system choice - Process the collaborative design system insights that come back - Ask user: "Accept these changes to the design system decision? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -237,6 +240,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-07-defining-experience.md` to define the core user interaction. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md index c9faf97b..09173626 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining the core interaction that defines the product @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -195,7 +198,7 @@ Show the generated defining experience content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current defining experience content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current defining experience content - Process the enhanced experience insights that come back - Ask user: "Accept these improvements to the defining experience? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -203,7 +206,7 @@ Show the generated defining experience content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current defining experience +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current defining experience - Process the collaborative experience insights that come back - Ask user: "Accept these changes to the defining experience? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -239,6 +242,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-08-visual-foundation.md` to establish visual design foundation. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md index 1b2184fd..364f5ac6 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on establishing visual design foundation (colors, typography, spacing) @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -165,7 +168,7 @@ Show the generated visual foundation content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current visual foundation content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current visual foundation content - Process the enhanced visual insights that come back - Ask user: "Accept these improvements to the visual foundation? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -173,7 +176,7 @@ Show the generated visual foundation content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current visual foundation +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current visual foundation - Process the collaborative visual insights that come back - Ask user: "Accept these changes to the visual foundation? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -209,6 +212,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-09-design-directions.md` to generate design direction mockups. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md index d32b820c..185e5e83 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on generating and evaluating design direction variations @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -165,7 +168,7 @@ Show the generated design direction content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current design direction content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current design direction content - Process the enhanced design insights that come back - Ask user: "Accept these improvements to the design direction? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -173,7 +176,7 @@ Show the generated design direction content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current design direction +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current design direction - Process the collaborative design insights that come back - Ask user: "Accept these changes to the design direction? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -209,6 +212,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-10-user-journeys.md` to design user journey flows. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md index c02a5f03..5f9ff973 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on designing user flows and journey interactions @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -183,7 +186,7 @@ Show the generated user journey content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current user journey content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current user 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 @@ -191,7 +194,7 @@ Show the generated user journey content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current user journeys +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current user journeys - Process the collaborative journey insights that come back - Ask user: "Accept these changes to the user journeys? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -226,6 +229,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-11-component-strategy.md` to define component library strategy. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md index 8fe062e0..96dcec31 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining component library strategy and custom components @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -189,7 +192,7 @@ Show the generated component strategy content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current component strategy content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current component strategy content - Process the enhanced component insights that come back - Ask user: "Accept these improvements to the component strategy? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -197,7 +200,7 @@ Show the generated component strategy content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current component strategy +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current component strategy - Process the collaborative component insights that come back - Ask user: "Accept these changes to the component strategy? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -233,6 +236,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-12-ux-patterns.md` to define UX consistency patterns. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md index c31145d3..99ea7dba 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on establishing consistency patterns for common UX situations @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -178,7 +181,7 @@ Show the generated UX patterns content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current UX patterns content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current UX patterns content - Process the enhanced pattern insights that come back - Ask user: "Accept these improvements to the UX patterns? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -186,7 +189,7 @@ Show the generated UX patterns content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current UX patterns +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current UX patterns - Process the collaborative pattern insights that come back - Ask user: "Accept these changes to the UX patterns? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -222,6 +225,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-13-responsive-accessibility.md` to define responsive design and accessibility strategy. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md index 4440182d..ffb28e91 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md @@ -3,6 +3,9 @@ ## 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 UX facilitator and stakeholder - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on responsive design strategy and accessibility compliance @@ -27,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -205,7 +208,7 @@ Show the generated responsive and accessibility content and present choices: #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current responsive/accessibility content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current responsive/accessibility content - Process the enhanced insights that come back - Ask user: "Accept these improvements to the responsive/accessibility strategy? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -213,7 +216,7 @@ Show the generated responsive and accessibility content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current responsive/accessibility strategy +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md with the current responsive/accessibility strategy - Process the collaborative insights that come back - Ask user: "Accept these changes to the responsive/accessibility strategy? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -249,6 +252,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NEXT STEP: After user selects 'C' and content is saved to document, load `./step-14-complete.md` to finalize the UX design workflow. diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md index b72612a7..93cf838d 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md @@ -3,6 +3,9 @@ ## 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, validation, and next steps @@ -159,6 +162,10 @@ Confirm completion 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: ### Design Specification Complete: diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/domain-complexity.csv b/src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/domain-complexity.csv rename to src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/prd-template.md b/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/prd-template.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/project-types.csv b/src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/project-types.csv rename to src/modules/bmm/workflows/2-plan-workflows/prd/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/step-01-init.md index f0ea336a..58b05c6f 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,8 +1,13 @@ # Step 1: Workflow Initialization +**Progress: Step 1 of 10** - Next: Project Discovery + ## 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 initialization and setup only - don't look ahead to future steps @@ -76,7 +81,7 @@ Discover and load context documents using smart discovery: **Project Documentation (Existing Projects):** -1. Look for index file: `{output_folder}/**/index.md` +1. Look for index file: `{output_folder}/index.md` 2. CRITICAL: Load index.md to understand what project files are available 3. Read available files from index to understand existing project context 4. This provides essential context for extending existing project with new PRD @@ -129,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 to project discovery +[C] Continue - Save this and move to Project Discovery (Step 2 of 10) ## SUCCESS METRICS: @@ -147,6 +152,10 @@ Do you have any other documents you'd like me to include, or shall we continue t ❌ Not checking sharded folders first before whole files ❌ Not reporting what documents were found to user +❌ **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 + ## NEXT STEP: -After user selects [C] to continue, load `./step-02-discovery.md` to begin the project discovery phase. +After user selects [C] to continue, load `{installed_path}/step/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 2c3c6b25..4d602e82 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 @@ -3,6 +3,9 @@ ## 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 understanding where we left off and continuing appropriately @@ -94,6 +97,10 @@ After presenting current progress, ask: ❌ Loading wrong next step based on `lastStep` value ❌ Proceeding without user confirmation of current state +❌ **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 ALREADY COMPLETE? If `lastStep = 10` (final step completed): 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 e1a5e1bd..5a023154 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,8 +1,13 @@ # Step 2: Project & Domain Discovery +**Progress: Step 2 of 10** - Next: Success Criteria Definition + ## 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 project classification and vision alignment only @@ -27,20 +32,22 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/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 step 1 are available -- Input documents already loaded are in memory +- Input documents already loaded are in memory (product briefs, research, brainstorming, project docs) - Classification CSV data will be loaded in this step only - This will be the first content section appended to the document +- LEVERAGE existing input documents to accelerate discovery process +- installed_path = `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd` ## YOUR TASK: -Conduct comprehensive project discovery with data-driven classification and generate the first content section. +Conduct comprehensive project discovery that leverages existing input documents while allowing user refinement, with data-driven classification and generate the first content section. ## DISCOVERY SEQUENCE: @@ -48,13 +55,41 @@ Conduct comprehensive project discovery with data-driven classification and gene Load and prepare CSV data for intelligent classification: -- Load `./project-types.csv` completely -- Load `./domain-complexity.csv` completely +- Load `{installed_path}/project-types.csv` completely +- Load `{installed_path/domain-complexity.csv` completely - Parse column structures and store in memory for this step only -### 2. Begin Natural Discovery Conversation +### 2. Leverage Input Documents for Head Start -Start with open-ended discovery: +Analyze available input documents to provide informed discovery: + +**Check Input Documents Available:** + +- Product Briefs: {{number_of_briefs}} documents loaded +- Research Documents: {{number_of_research}} documents loaded +- Brainstorming Results: {{number_of_brainstorming}} documents loaded +- Project Documentation: {{number_of_project_docs}} documents loaded + +**If Input Documents Exist:** +"As your PM peer, I've reviewed your existing project documentation 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 and research:** + +**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}} + +**How does this align with your vision?** Should we refine any of these points or are there important aspects I'm missing?" + +**If No Input Documents:** "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:** @@ -87,8 +122,23 @@ Compare user description against `signals` from `domain-complexity.csv`: - Examples: "payment,banking,trading" → fintech - Store the matched `domain` and `complexity_level` -### 4. Validate Classifications +### 4. Enhanced Classification with Document Context +Leverage both user input and document analysis for classification: + +**If Input Documents Exist:** +"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}} + +Combined with our conversation, this suggests the above classification. Does this sound right?" + +**If No Input Documents:** Present your classifications for user validation: "Based on our conversation, I'm hearing this as: @@ -100,6 +150,19 @@ Does this sound right to you? I want to make sure we're on the same page before ### 5. Identify What Makes It Special +Leverage input documents for initial understanding, then refine: + +**If Input Documents Exist:** +"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 No Input Documents:** Ask focused questions to capture the product's unique value: - "What would make users say 'this is exactly what I needed'?" @@ -143,13 +206,13 @@ 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 to the document and move to next step" +[C] Continue - Save this and move to Success Criteria Definition (Step 3 of 10)" ### 8. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml 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 @@ -157,7 +220,7 @@ Show the generated content to the user and present: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current content +- Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md 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 @@ -176,21 +239,27 @@ When user selects 'C', append the content directly to the document using the str ## SUCCESS METRICS: ✅ Classification data loaded and used effectively +✅ Input documents analyzed and leveraged for head start ✅ User classifications validated and confirmed -✅ Product differentiator clearly identified -✅ Executive summary content generated collaboratively +✅ 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 ## FAILURE MODES: ❌ 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 +❌ Missing the "what makes it special" discovery and refinement ❌ 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 + ## COMPLEXITY HANDLING: If `complexity_level = "high"`: @@ -201,6 +270,6 @@ If `complexity_level = "high"`: ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-03-success.md` to define success criteria. +After user selects 'C' and content is saved to document, load `installed_path/steps/step-03-success.md` to define success criteria. Remember: Do NOT proceed to step-03 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-03-success.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md index 38d3289d..aa4d30b8 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,8 +1,13 @@ # Step 3: Success Criteria Definition +**Progress: Step 3 of 10** - Next: User Journey Mapping + ## 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 defining what winning looks like for this product @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -35,17 +40,45 @@ This step will generate content and present choices: - Current document and frontmatter from previous steps are available - Executive Summary and Project Classification already exist in document +- Input documents from step-01 are available (product briefs, research, brainstorming) - No additional data files needed for this step - Focus on measurable, specific success criteria +- LEVERAGE existing input documents to inform success criteria ## YOUR TASK: -Define comprehensive success criteria that cover user success, business success, and technical success. +Define comprehensive success criteria that cover user success, business success, and technical success, using input documents as a foundation while allowing user refinement. ## SUCCESS DISCOVERY SEQUENCE: ### 1. Begin Success Definition Conversation +**Check Input Documents for Success Indicators:** +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?" + +**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. @@ -171,13 +204,13 @@ 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 this to the document and move to next step" +[C] Continue - Save success criteria and move to User Journey Mapping (Step 4 of 10)" ### 9. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current success criteria content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -185,7 +218,7 @@ Show the generated content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current success criteria +- Execute {project-root}/{bmad_folder}/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 @@ -219,6 +252,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## DOMAIN CONSIDERATIONS: If working in regulated domains (healthcare, fintech, govtech): 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 index 1aa4afec..5de02ea9 100644 --- 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 @@ -1,8 +1,13 @@ # 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 @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -35,17 +40,36 @@ This step will generate content and present choices: - Current document and frontmatter from previous steps are available - Success criteria and scope already defined -- No additional data files needed for this step +- Input documents from step-01 are available (product briefs with user personas) - Every human interaction with the system needs a journey ## YOUR TASK: -Map comprehensive user journeys for ALL user types that interact with the system. +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. Identify All User Types +### 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}}. @@ -61,35 +85,58 @@ Consider: What user types should we map for this product?" -### 2. Create Detailed Narrative Journeys +### 2. Create Narrative Story-Based Journeys -For each user type, create rich, detailed journeys following this structure: +For each user type, create compelling narrative journeys that tell their story: -#### Journey Creation Process: +#### Narrative Journey Creation Process: -**1. Develop the Persona:** +**If Using Existing Persona from Input Documents:** +"Let's tell {{persona_name}}'s story with {{project_name}}. -- **Name**: Realistic name (Maria, Marcus, Jordan, etc.) -- **Backstory**: Who they are, what they want, why they need this -- **Motivation**: Core problem they're trying to solve -- **Emotional state**: How they feel about solving this problem +**Their Story So Far:** +{{persona_backstory_from_brief}} -**2. Map Complete Journey:** +**How {{project_name}} Changes Their Life:** +{{how_product_helps_them}} -- **Entry point**: How they discover and access the product -- **Key steps**: Each touchpoint in sequence (use arrows →) -- **Critical actions**: What they do at each step -- **Decision points**: Choices they make -- **Success moment**: Where they achieve their goal -- **Exit point**: How the journey concludes +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?" -**3. Use This Exact Format:** +**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 [Number]: [Persona Name] - [Journey Theme]** -[Persona description with backstory and motivation] +**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. -- [Entry point] → [step 1] → [step 2] → [step 3] → [critical moment] → [step N] → [completion] +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 @@ -151,13 +198,13 @@ Show the generated journey content and present choices: **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 to the document and move to next step" +[C] Continue - Save this and move to Domain Requirements (Step 5 of 11)" ### 8. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current journey content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -165,7 +212,7 @@ Show the generated journey content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current journeys +- Execute {project-root}/{bmad_folder}/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 @@ -175,7 +222,7 @@ Show the generated journey content and present choices: - Append the final content to `{output_folder}/prd.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` -- Load `./step-05-domain.md` (or determine if step is optional based on domain complexity) +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md` (or determine if step is optional based on domain complexity) ## APPEND TO DOCUMENT: @@ -183,24 +230,31 @@ When user selects 'C', append the content directly to the document using the str ## SUCCESS METRICS: +✅ Existing personas from product briefs leveraged when available ✅ All user types identified (not just primary users) -✅ Rich persona development for each journey -✅ Complete end-to-end journey mapping with critical moments +✅ 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 comprehensive journeys covering different user types +✅ 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 +❌ 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:** @@ -215,6 +269,4 @@ When user selects 'C', append the content directly to the document using the str After user selects 'C' and content is saved to document, load `./step-05-domain.md`. -Note: Step-05 is optional - check if domain complexity from step-02 warrants domain-specific exploration. - 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 index f0836e68..2dadc6c7 100644 --- 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 @@ -1,8 +1,13 @@ # 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 @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -42,11 +47,10 @@ This step will generate content and present choices: Before proceeding with this step, verify: -- Is `complexity_level` from step-02 equal to "high"? -- Does the domain have specific regulatory/compliance needs? +- 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 `./step-06-innovation.md`. +If NO to these questions, skip this step and load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`. ## YOUR TASK: @@ -58,7 +62,7 @@ Explore domain-specific requirements for complex domains that need specialized c Load domain-specific configuration for complex domains: -- Load `./domain-complexity.csv` completely +- Load `{project-root}/{bmad_folder}/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) @@ -176,13 +180,13 @@ Show the generated domain content and present choices: **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 to the document and move to next step" +[C] Continue - Save this and move to Innovation Focus (Step 6 of 11)" ### 8. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current domain content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -190,7 +194,7 @@ Show the generated domain content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current domain requirements +- Execute {project-root}/{bmad_folder}/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 @@ -198,9 +202,9 @@ Show the generated domain content and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/prd.md` +- Append the content to `{output_folder}/prd.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]` -- Load `./step-06-innovation.md` +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md` ## APPEND TO DOCUMENT: @@ -226,9 +230,13 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 `./step-06-innovation.md` if: +Skip this step and load `{project-root}/{bmad_folder}/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 @@ -236,6 +244,6 @@ Skip this step and load `./step-06-innovation.md` if: ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-06-innovation.md`. +After user selects 'C' and content is saved to document, load `{project-root}/{bmad_folder}/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-06-innovation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md index 9c77bc75..f4740d69 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/step-06-innovation.md @@ -1,8 +1,13 @@ # Step 6: Innovation Discovery +**Progress: Step 6 of 11** - Next: Project Type Analysis + ## 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 detecting and exploring innovative aspects of the product @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -57,7 +62,7 @@ Detect and explore innovation patterns in the product, focusing on what makes it Load innovation signals specific to this project type: -- Load `./project-types.csv` completely +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/project-types.csv` 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 @@ -154,13 +159,13 @@ Show the generated innovation content and present choices: **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 to the document and move to next step" +[C] Continue - Save this and move to Project Type Analysis (Step 7 of 11)" ### 7. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current innovation content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -168,7 +173,7 @@ Show the generated innovation content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current innovation content +- Execute {project-root}/{bmad_folder}/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 @@ -178,7 +183,7 @@ Show the generated innovation content and present choices: - Append the final content to `{output_folder}/prd.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]` -- Load `./step-07-project-type.md` +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` ## NO INNOVATION DETECTED: @@ -187,9 +192,9 @@ If no genuine innovation signals are found after exploration: **Options:** [A] Force innovation exploration - Let's try to find innovative angles -[C] Continue - Skip innovation section and move to next step" +[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 `./step-07-project-type.md`. +If user selects 'A', proceed with content generation anyway. If 'C', skip this step and load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`. ## APPEND TO DOCUMENT: @@ -215,9 +220,13 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 `./step-07-project-type.md` if: +Skip this step and load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` if: - No innovation signals detected in conversation - Product is incremental improvement rather than breakthrough @@ -226,6 +235,6 @@ Skip this step and load `./step-07-project-type.md` if: ## NEXT STEP: -After user selects 'C' and content is saved to document (or step is skipped), load `./step-07-project-type.md`. +After user selects 'C' and content is saved to document (or step is skipped), load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`. 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/step-07-project-type.md index 2f7b75f6..5f61bd04 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/step-07-project-type.md @@ -1,8 +1,13 @@ # Step 7: Project-Type Deep Dive +**Progress: Step 7 of 11** - Next: Scoping + ## 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 project-type specific requirements and technical considerations @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -48,7 +53,7 @@ Conduct project-type specific discovery using CSV-driven guidance to define tech Load project-type specific configuration: -- Load `./project-types.csv` completely +- Load `{project-root}/{bmad_folder}/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: - `key_questions` (semicolon-separated list of discovery questions) @@ -150,13 +155,13 @@ Show the generated project-type content and present choices: **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 to the document and move to next step" +[C] Continue - Save this and move to Scoping (Step 8 of 11)" ### 7. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current project-type content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -164,7 +169,7 @@ Show the generated project-type content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current project-type requirements +- Execute {project-root}/{bmad_folder}/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 @@ -174,7 +179,7 @@ Show the generated project-type content and present choices: - Append the final content to `{output_folder}/prd.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` -- Load `./step-08-functional.md` +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` ## APPEND TO DOCUMENT: @@ -200,6 +205,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## PROJECT-TYPE EXAMPLES: **For api_backend:** @@ -222,6 +231,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-08-functional.md` to synthesize functional requirements. +After user selects 'C' and content is saved to document, load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` to define project scope. -Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved! +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/step-08-scoping.md new file mode 100644 index 00000000..6daeb1f2 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md @@ -0,0 +1,280 @@ +# Step 8: Scoping Exercise - MVP & Future Features + +**Progress: Step 8 of 11** - Next: Functional 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 strategic scope decisions that keep projects viable +- 🎯 EMPHASIZE lean MVP thinking while preserving long-term vision + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 📚 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 +- 🚫 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_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- Complete PRD document built so far is available for review +- User journeys, success criteria, and domain requirements are documented +- Focus on strategic scope decisions, not feature details +- Balance between user value and implementation feasibility + +## YOUR TASK: + +Conduct comprehensive scoping exercise to define MVP boundaries and prioritize features across development phases. + +## SCOPING SEQUENCE: + +### 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?" + +### 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}}?**" + +### 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}}" + +**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.?**" + +### 4. Progressive Feature Roadmap + +Create phased development approach: + +"Let's map your features across development phases: + +**Phase 1: MVP** + +- Core user value delivery +- Essential user journeys +- Basic functionality that works reliably + +**Phase 2: Growth** + +- Additional user types +- Enhanced features +- Scale improvements + +**Phase 3: Expansion** + +- Advanced capabilities +- Platform features +- New markets or use cases + +**Where does your current vision fit in this development sequence?**" + +### 5. Risk-Based Scoping + +Identify and mitigate scoping risks: + +**Technical Risks:** +"Looking at your innovation and domain requirements: + +- What's the most technically challenging aspect? +- Could we simplify the initial implementation? +- What's the riskiest assumption about technology feasibility?" + +**Market Risks:** + +- What's the biggest market risk? +- How does the MVP address this? +- What learning do we need to de-risk this?" + +**Resource Risks:** + +- What if we have fewer resources than planned? +- What's the absolute minimum team size needed? +- Can we launch with a smaller feature set?" + +### 6. Generate Scoping Content + +Prepare comprehensive scoping section: + +#### Content Structure: + +```markdown +## Project Scoping & Phased Development + +### MVP Strategy & Philosophy + +**MVP Approach:** {{chosen_mvp_approach}} +**Resource Requirements:** {{mvp_team_size_and_skills}} + +### MVP Feature Set (Phase 1) + +**Core User Journeys Supported:** +{{essential_journeys_for_mvp}} + +**Must-Have Capabilities:** +{{list_of_essential_mvp_features}} + +### Post-MVP Features + +**Phase 2 (Post-MVP):** +{{planned_growth_features}} + +**Phase 3 (Expansion):** +{{planned_expansion_features}} + +### Risk Mitigation Strategy + +**Technical Risks:** {{mitigation_approach}} +**Market Risks:** {{validation_approach}} +**Resource Risks:** {{contingency_approach}} +``` + +### 7. Present Content and Menu + +Show the scoping decisions and present choices: + +"I've analyzed your complete PRD and created a strategic scoping plan 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 - 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_folder}/core/tasks/advanced-elicitation.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_folder}/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 `{output_folder}/prd.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` +- Load `./step-09-functional.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 6. + +## SUCCESS METRICS: + +✅ Complete PRD document analyzed for scope implications +✅ Strategic MVP approach defined and justified +✅ Clear MVP feature boundaries established +✅ Phased development roadmap created +✅ Key risks identified and mitigation strategies defined +✅ User explicitly agrees to scope decisions +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Not analyzing the complete PRD before making scoping decisions +❌ Making scope decisions without strategic rationale +❌ Not getting explicit user agreement on MVP boundaries +❌ Missing critical risk analysis +❌ Not creating clear phased development approach +❌ Not presenting A/P/C menu after content generation + +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-09-functional.md`. + +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-08-functional.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md similarity index 86% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-functional.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md index d11311cb..08806a12 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-functional.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md @@ -1,8 +1,13 @@ -# Step 8: Functional Requirements Synthesis +# Step 9: Functional Requirements Synthesis + +**Progress: Step 9 of 11** - Next: Non-Functional 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 creating comprehensive capability inventory for the product @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -180,13 +185,13 @@ Show the generated functional requirements and present choices: **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 to the document and move to next step" +[C] Continue - Save this and move to Non-Functional Requirements (Step 10 of 11)" ### 8. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current FR list +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -194,7 +199,7 @@ Show the generated functional requirements and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current FR list +- Execute {project-root}/{bmad_folder}/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 @@ -203,8 +208,8 @@ Show the generated functional requirements and present choices: #### If 'C' (Continue): - Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` -- Load `./step-09-nonfunctional.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` ## APPEND TO DOCUMENT: @@ -231,12 +236,16 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## CAPABILITY CONTRACT REMINDER: Emphasize to user: "This FR list is now binding. Any feature not listed here will not exist in the final product unless we explicitly add it. This is why it's critical to ensure completeness now." ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-09-nonfunctional.md` to define non-functional requirements. +After user selects 'C' and content is saved to document, load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` to define non-functional requirements. -Remember: Do NOT proceed to step-09 until user explicitly selects 'C' from the A/P/C menu and content is saved! +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-09-nonfunctional.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md similarity index 87% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-nonfunctional.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md index 8545e6f2..c4af4b9b 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-nonfunctional.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md @@ -1,8 +1,13 @@ -# Step 9: Non-Functional Requirements +# Step 10: Non-Functional Requirements + +**Progress: Step 10 of 11** - Next: Complete PRD ## 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 quality attributes that matter for THIS specific product @@ -27,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: - When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -180,13 +185,13 @@ Show the generated NFR content and present choices: **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 to the document and move to final step" +[C] Continue - Save this and move to Complete PRD (Step 11 of 11)" ### 7. Handle Menu Selection #### If 'A' (Advanced Elicitation): -- Execute advanced-elicitation.xml with the current NFR content +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.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 @@ -194,7 +199,7 @@ Show the generated NFR content and present choices: #### If 'P' (Party Mode): -- Execute party-mode workflow with the current NFR list +- Execute {project-root}/{bmad_folder}/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 @@ -203,8 +208,8 @@ Show the generated NFR content and present choices: #### If 'C' (Continue): - Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` -- Load `./step-10-complete.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]` +- Load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` ## APPEND TO DOCUMENT: @@ -230,6 +235,10 @@ When user selects 'C', append the content directly to the document using the str ❌ 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 + ## NFR CATEGORY GUIDANCE: **Include Performance When:** @@ -261,6 +270,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-10-complete.md` to finalize the PRD and complete the workflow. +After user selects 'C' and content is saved to document, load `{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` to finalize the PRD and complete the workflow. -Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved! +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/step-10-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md similarity index 88% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-complete.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md index 51c91d05..6c26261d 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-complete.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md @@ -1,8 +1,13 @@ -# Step 10: Workflow Completion +# 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 @@ -77,14 +82,14 @@ Provide guidance on logical next workflows: 1. `workflow create-ux-design` - UX Design (if UI exists) - User journey insights from step-04 will inform interaction design - - Functional requirements from step-08 define design scope + - 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-09 inform architecture choices + - Non-functional requirements from step-10 inform architecture choices 3. `workflow create-epics-and-stories` - Epic breakdown - - Functional requirements from step-08 become epics and stories + - Functional requirements from step-09 become epics and stories - Scope definition from step-03 guides sprint planning **Strategic Considerations:** @@ -151,6 +156,10 @@ The document contains everything needed to guide: ❌ 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: @@ -189,7 +198,7 @@ Consider team capacity and timeline constraints ## WORKFLOW FINALIZATION: -- Set `lastStep = 10` in document frontmatter +- Set `lastStep = 11` in document frontmatter - Update workflow status file with completion timestamp - Provide completion summary to user - Do NOT load any additional steps diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/architecture-decision-template.md b/src/modules/bmm/workflows/3-solutioning/architecture/architecture-decision-template.md new file mode 100644 index 00000000..d0d100f7 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/architecture-decision-template.md @@ -0,0 +1,13 @@ +--- +stepsCompleted: [] +inputDocuments: [] +workflowType: 'architecture' +lastStep: 0 +project_name: '{{project_name}}' +user_name: '{{user_name}}' +date: '{{date}}' +--- + +# Architecture Decision Document + +_This document builds collaboratively through step-by-step discovery. Sections are appended as we work through each architectural decision together._ diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml b/src/modules/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml deleted file mode 100644 index 5cd769bf..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml +++ /dev/null @@ -1,321 +0,0 @@ -# Architecture Patterns - Common patterns identified from requirements - -requirement_patterns: - realtime_collaboration: - triggers: - - "real-time" - - "collaborative" - - "live updates" - - "multi-user" - - "simultaneous editing" - decisions_needed: - - websocket_solution - - conflict_resolution - - state_synchronization - - presence_tracking - - optimistic_updates - suggested_stack: - - "Socket.io or WebSocket native" - - "Redis for pub/sub" - - "Operational Transforms or CRDTs for conflict resolution" - - "PostgreSQL for persistence" - - ecommerce: - triggers: - - "shopping cart" - - "checkout" - - "payments" - - "inventory" - - "product catalog" - decisions_needed: - - payment_processor - - cart_persistence - - inventory_management - - order_workflow - - tax_calculation - suggested_stack: - - "Stripe or PayPal for payments" - - "PostgreSQL for products and orders" - - "Redis for cart sessions" - - "BullMQ for order processing" - - saas_platform: - triggers: - - "multi-tenant" - - "subscription" - - "billing" - - "team management" - - "roles and permissions" - decisions_needed: - - tenancy_model - - subscription_billing - - permission_system - - team_collaboration - - usage_tracking - suggested_stack: - - "PostgreSQL with Row Level Security" - - "Stripe Billing for subscriptions" - - "RBAC or ABAC for permissions" - - "NextAuth or Clerk for auth" - - content_platform: - triggers: - - "CMS" - - "blog" - - "publishing" - - "content management" - - "editorial workflow" - decisions_needed: - - content_storage - - rich_text_editor - - media_handling - - version_control - - publishing_workflow - suggested_stack: - - "PostgreSQL for structured content" - - "S3 or Cloudinary for media" - - "Tiptap or Slate for rich text" - - "Algolia for search" - - data_analytics: - triggers: - - "dashboards" - - "reporting" - - "metrics" - - "analytics" - - "data visualization" - decisions_needed: - - data_warehouse - - etl_pipeline - - visualization_library - - query_optimization - - caching_strategy - suggested_stack: - - "PostgreSQL or ClickHouse" - - "Apache Airflow or Temporal for ETL" - - "Chart.js or D3 for visualization" - - "Redis for query caching" - - social_platform: - triggers: - - "social network" - - "feed" - - "following" - - "likes" - - "comments" - decisions_needed: - - graph_relationships - - feed_algorithm - - notification_system - - content_moderation - - privacy_controls - suggested_stack: - - "PostgreSQL with graph extensions or Neo4j" - - "Redis for feed caching" - - "Elasticsearch for user search" - - "WebSockets for notifications" - - marketplace: - triggers: - - "marketplace" - - "vendors" - - "buyers and sellers" - - "transactions" - - "escrow" - decisions_needed: - - payment_splitting - - escrow_handling - - vendor_management - - dispute_resolution - - commission_model - suggested_stack: - - "Stripe Connect for payments" - - "PostgreSQL for transactions" - - "BullMQ for async processing" - - "S3 for vendor assets" - - streaming_platform: - triggers: - - "video streaming" - - "live streaming" - - "media delivery" - - "broadcast" - decisions_needed: - - video_encoding - - cdn_strategy - - streaming_protocol - - bandwidth_optimization - - drm_protection - suggested_stack: - - "AWS MediaConvert or Mux" - - "CloudFront or Fastly CDN" - - "HLS or DASH protocol" - - "S3 for video storage" - - iot_platform: - triggers: - - "IoT" - - "sensors" - - "device management" - - "telemetry" - - "edge computing" - decisions_needed: - - message_protocol - - time_series_database - - device_authentication - - data_ingestion - - edge_processing - suggested_stack: - - "MQTT or CoAP protocol" - - "TimescaleDB or InfluxDB" - - "Apache Kafka for ingestion" - - "Grafana for monitoring" - - ai_application: - triggers: - - "machine learning" - - "AI features" - - "LLM integration" - - "computer vision" - - "NLP" - decisions_needed: - - model_serving - - vector_database - - prompt_management - - token_optimization - - fallback_strategy - suggested_stack: - - "OpenAI or Anthropic API" - - "Pinecone or pgvector for embeddings" - - "Redis for prompt caching" - - "Langchain or LlamaIndex" - -# Quality attribute patterns -quality_attributes: - high_availability: - triggers: - - "99.9% uptime" - - "high availability" - - "fault tolerance" - - "disaster recovery" - architectural_needs: - - load_balancing - - database_replication - - health_checks - - circuit_breakers - - graceful_degradation - - high_performance: - triggers: - - "millisecond response" - - "high throughput" - - "low latency" - - "performance critical" - architectural_needs: - - caching_layers - - database_optimization - - cdn_strategy - - code_splitting - - lazy_loading - - high_security: - triggers: - - "compliance" - - "HIPAA" - - "GDPR" - - "financial data" - - "PCI DSS" - architectural_needs: - - encryption_at_rest - - encryption_in_transit - - audit_logging - - access_controls - - data_isolation - - scalability: - triggers: - - "millions of users" - - "elastic scale" - - "global reach" - - "viral growth" - architectural_needs: - - horizontal_scaling - - database_sharding - - microservices - - queue_systems - - auto_scaling - -# Integration patterns -integration_requirements: - payment_processing: - common_choices: - - "Stripe - most developer friendly" - - "PayPal - widest consumer adoption" - - "Square - best for in-person + online" - considerations: - - transaction_fees - - international_support - - subscription_handling - - marketplace_capabilities - - email_service: - common_choices: - - "Resend - modern, developer friendly" - - "SendGrid - mature, scalable" - - "Amazon SES - cost effective at scale" - - "Postmark - transactional focus" - considerations: - - deliverability - - template_management - - analytics_needs - - cost_per_email - - sms_notifications: - common_choices: - - "Twilio - most comprehensive" - - "Amazon SNS - AWS integrated" - - "Vonage - competitive pricing" - considerations: - - international_coverage - - delivery_rates - - two_way_messaging - - cost_per_message - - authentication_providers: - social_providers: - - "Google - highest adoption" - - "GitHub - developer focused" - - "Microsoft - enterprise" - - "Apple - iOS users" - enterprise_providers: - - "SAML 2.0" - - "OAuth 2.0" - - "OpenID Connect" - - "Active Directory" - -# Decision heuristics -decision_rules: - database_selection: - if_requirements_include: - - complex_relationships: "PostgreSQL" - - flexible_schema: "MongoDB" - - time_series: "TimescaleDB" - - graph_data: "Neo4j or PostgreSQL with extensions" - - key_value: "Redis" - - wide_column: "Cassandra" - - api_pattern_selection: - if_requirements_include: - - simple_crud: "REST" - - complex_queries: "GraphQL" - - type_safety_critical: "tRPC" - - microservices: "gRPC" - - public_api: "REST with OpenAPI" - - deployment_selection: - if_requirements_include: - - nextjs_only: "Vercel" - - complex_infrastructure: "AWS" - - quick_prototype: "Railway" - - global_edge: "Fly.io" - - kubernetes_needed: "GCP or AWS EKS" diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/architecture-template.md b/src/modules/bmm/workflows/3-solutioning/architecture/architecture-template.md deleted file mode 100644 index 123c61af..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/architecture-template.md +++ /dev/null @@ -1,94 +0,0 @@ -# Architecture - -## Executive Summary - -{{executive_summary}} - -{{project_initialization_section}} - -## Decision Summary - -| Category | Decision | Version | Affects Epics | Rationale | -| -------- | -------- | ------- | ------------- | --------- | - -{{decision_table_rows}} - -## Project Structure - -{{source_tree}} - -## Epic to Architecture Mapping - -{{epic_mapping_table}} - -## Technology Stack Details - -### Core Technologies - -{{core_stack_details}} - -### Integration Points - -{{integration_details}} - -{{novel_pattern_designs_section}} - -## Implementation Patterns - -These patterns ensure consistent implementation across all AI agents: - -{{implementation_patterns}} - -## Consistency Rules - -### Naming Conventions - -{{naming_conventions}} - -### Code Organization - -{{code_organization_patterns}} - -### Error Handling - -{{error_handling_approach}} - -### Logging Strategy - -{{logging_approach}} - -## Data Architecture - -{{data_models_and_relationships}} - -## API Contracts - -{{api_specifications}} - -## Security Architecture - -{{security_approach}} - -## Performance Considerations - -{{performance_strategies}} - -## Deployment Architecture - -{{deployment_approach}} - -## Development Environment - -### Prerequisites - -{{development_prerequisites}} - -## Architecture Decision Records (ADRs) - -{{key_architecture_decisions}} - ---- - -_Generated by BMAD Decision Architecture Workflow v1.0_ -_Date: {{date}}_ -_For: {{user_name}}_ diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/checklist.md b/src/modules/bmm/workflows/3-solutioning/architecture/checklist.md deleted file mode 100644 index 67408846..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/checklist.md +++ /dev/null @@ -1,240 +0,0 @@ -# Architecture Document Validation Checklist - -**Purpose**: Validate the architecture document itself is complete, implementable, and provides clear guidance for AI agents. - -**Note**: This checklist validates the ARCHITECTURE DOCUMENT only. For cross-workflow validation (PRD → Architecture → Stories alignment), use the implementation-readiness workflow. - ---- - -## 1. Decision Completeness - -### All Decisions Made - -- [ ] Every critical decision category has been resolved -- [ ] All important decision categories addressed -- [ ] No placeholder text like "TBD", "[choose]", or "{TODO}" remains -- [ ] Optional decisions either resolved or explicitly deferred with rationale - -### Decision Coverage - -- [ ] Data persistence approach decided -- [ ] API pattern chosen -- [ ] Authentication/authorization strategy defined -- [ ] Deployment target selected -- [ ] All functional requirements have architectural support - ---- - -## 2. Version Specificity - -### Technology Versions - -- [ ] Every technology choice includes a specific version number -- [ ] Version numbers are current (verified via WebSearch, not hardcoded) -- [ ] Compatible versions selected (e.g., Node.js version supports chosen packages) -- [ ] Verification dates noted for version checks - -### Version Verification Process - -- [ ] WebSearch used during workflow to verify current versions -- [ ] No hardcoded versions from decision catalog trusted without verification -- [ ] LTS vs. latest versions considered and documented -- [ ] Breaking changes between versions noted if relevant - ---- - -## 3. Starter Template Integration (if applicable) - -### Template Selection - -- [ ] Starter template chosen (or "from scratch" decision documented) -- [ ] Project initialization command documented with exact flags -- [ ] Starter template version is current and specified -- [ ] Command search term provided for verification - -### Starter-Provided Decisions - -- [ ] Decisions provided by starter marked as "PROVIDED BY STARTER" -- [ ] List of what starter provides is complete -- [ ] Remaining decisions (not covered by starter) clearly identified -- [ ] No duplicate decisions that starter already makes - ---- - -## 4. Novel Pattern Design (if applicable) - -### Pattern Detection - -- [ ] All unique/novel concepts from PRD identified -- [ ] Patterns that don't have standard solutions documented -- [ ] Multi-epic workflows requiring custom design captured - -### Pattern Documentation Quality - -- [ ] Pattern name and purpose clearly defined -- [ ] Component interactions specified -- [ ] Data flow documented (with sequence diagrams if complex) -- [ ] Implementation guide provided for agents -- [ ] Edge cases and failure modes considered -- [ ] States and transitions clearly defined - -### Pattern Implementability - -- [ ] Pattern is implementable by AI agents with provided guidance -- [ ] No ambiguous decisions that could be interpreted differently -- [ ] Clear boundaries between components -- [ ] Explicit integration points with standard patterns - ---- - -## 5. Implementation Patterns - -### Pattern Categories Coverage - -- [ ] **Naming Patterns**: API routes, database tables, components, files -- [ ] **Structure Patterns**: Test organization, component organization, shared utilities -- [ ] **Format Patterns**: API responses, error formats, date handling -- [ ] **Communication Patterns**: Events, state updates, inter-component messaging -- [ ] **Lifecycle Patterns**: Loading states, error recovery, retry logic -- [ ] **Location Patterns**: URL structure, asset organization, config placement -- [ ] **Consistency Patterns**: UI date formats, logging, user-facing errors - -### Pattern Quality - -- [ ] Each pattern has concrete examples -- [ ] Conventions are unambiguous (agents can't interpret differently) -- [ ] Patterns cover all technologies in the stack -- [ ] No gaps where agents would have to guess -- [ ] Implementation patterns don't conflict with each other - ---- - -## 6. Technology Compatibility - -### Stack Coherence - -- [ ] Database choice compatible with ORM choice -- [ ] Frontend framework compatible with deployment target -- [ ] Authentication solution works with chosen frontend/backend -- [ ] All API patterns consistent (not mixing REST and GraphQL for same data) -- [ ] Starter template compatible with additional choices - -### Integration Compatibility - -- [ ] Third-party services compatible with chosen stack -- [ ] Real-time solutions (if any) work with deployment target -- [ ] File storage solution integrates with framework -- [ ] Background job system compatible with infrastructure - ---- - -## 7. Document Structure - -### Required Sections Present - -- [ ] Executive summary exists (2-3 sentences maximum) -- [ ] Project initialization section (if using starter template) -- [ ] Decision summary table with ALL required columns: - - Category - - Decision - - Version - - Rationale -- [ ] Project structure section shows complete source tree -- [ ] Implementation patterns section comprehensive -- [ ] Novel patterns section (if applicable) - -### Document Quality - -- [ ] Source tree reflects actual technology decisions (not generic) -- [ ] Technical language used consistently -- [ ] Tables used instead of prose where appropriate -- [ ] No unnecessary explanations or justifications -- [ ] Focused on WHAT and HOW, not WHY (rationale is brief) - ---- - -## 8. AI Agent Clarity - -### Clear Guidance for Agents - -- [ ] No ambiguous decisions that agents could interpret differently -- [ ] Clear boundaries between components/modules -- [ ] Explicit file organization patterns -- [ ] Defined patterns for common operations (CRUD, auth checks, etc.) -- [ ] Novel patterns have clear implementation guidance -- [ ] Document provides clear constraints for agents -- [ ] No conflicting guidance present - -### Implementation Readiness - -- [ ] Sufficient detail for agents to implement without guessing -- [ ] File paths and naming conventions explicit -- [ ] Integration points clearly defined -- [ ] Error handling patterns specified -- [ ] Testing patterns documented - ---- - -## 9. Practical Considerations - -### Technology Viability - -- [ ] Chosen stack has good documentation and community support -- [ ] Development environment can be set up with specified versions -- [ ] No experimental or alpha technologies for critical path -- [ ] Deployment target supports all chosen technologies -- [ ] Starter template (if used) is stable and well-maintained - -### Scalability - -- [ ] Architecture can handle expected user load -- [ ] Data model supports expected growth -- [ ] Caching strategy defined if performance is critical -- [ ] Background job processing defined if async work needed -- [ ] Novel patterns scalable for production use - ---- - -## 10. Common Issues to Check - -### Beginner Protection - -- [ ] Not overengineered for actual requirements -- [ ] Standard patterns used where possible (starter templates leveraged) -- [ ] Complex technologies justified by specific needs -- [ ] Maintenance complexity appropriate for team size - -### Expert Validation - -- [ ] No obvious anti-patterns present -- [ ] Performance bottlenecks addressed -- [ ] Security best practices followed -- [ ] Future migration paths not blocked -- [ ] Novel patterns follow architectural principles - ---- - -## Validation Summary - -### Document Quality Score - -- Architecture Completeness: [Complete / Mostly Complete / Partial / Incomplete] -- Version Specificity: [All Verified / Most Verified / Some Missing / Many Missing] -- Pattern Clarity: [Crystal Clear / Clear / Somewhat Ambiguous / Ambiguous] -- AI Agent Readiness: [Ready / Mostly Ready / Needs Work / Not Ready] - -### Critical Issues Found - - - -### Recommended Actions Before Implementation - - - ---- - -**Next Step**: Run the **implementation-readiness** workflow to validate alignment between PRD, UX, Architecture, and Stories before beginning implementation. - ---- - -_This checklist validates architecture document quality only. Use implementation-readiness for comprehensive readiness validation._ diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/data/domain-complexity.csv b/src/modules/bmm/workflows/3-solutioning/architecture/data/domain-complexity.csv new file mode 100644 index 00000000..0f1726a7 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/data/domain-complexity.csv @@ -0,0 +1,11 @@ +domain,signals,complexity_level,suggested_workflow,web_searches +e_commerce,"shopping,cart,checkout,payment,products,store",medium,standard,"ecommerce architecture patterns, payment processing, inventory management" +fintech,"banking,payment,trading,finance,money,investment",high,enhanced,"financial security, PCI compliance, trading algorithms, fraud detection" +healthcare,"medical,diagnostic,clinical,patient,hospital,health",high,enhanced,"HIPAA compliance, medical data security, FDA regulations, health tech" +social,"social network,community,users,friends,posts,sharing",high,advanced,"social graph algorithms, feed ranking, notification systems, privacy" +education,"learning,course,student,teacher,training,academic",medium,standard,"LMS architecture, progress tracking, assessment systems, video streaming" +productivity,"productivity,workflow,tasks,management,business,tools",medium,standard,"collaboration patterns, real-time editing, notification systems, integration" +media,"content,media,video,audio,streaming,broadcast",high,advanced,"CDN architecture, video encoding, streaming protocols, content delivery" +iot,"IoT,sensors,devices,embedded,smart,connected",high,advanced,"device communication, real-time data processing, edge computing, security" +government,"government,civic,public,admin,policy,regulation",high,enhanced,"accessibility standards, security clearance, data privacy, audit trails" +gaming,"game,gaming,multiplayer,real-time,interactive,entertainment",high,advanced,"real-time multiplayer, game engine architecture, matchmaking, leaderboards" \ No newline at end of file diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/data/project-types.csv b/src/modules/bmm/workflows/3-solutioning/architecture/data/project-types.csv new file mode 100644 index 00000000..3733748e --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/data/project-types.csv @@ -0,0 +1,7 @@ +project_type,detection_signals,description,typical_starters +web_app,"website,web application,browser,frontend,UI,interface",Web-based applications running in browsers,Next.js, Vite, Remix +mobile_app,"mobile,iOS,Android,app,smartphone,tablet",Native mobile applications,React Native, Expo, Flutter +api_backend,"API,REST,GraphQL,backend,service,microservice",Backend services and APIs,NestJS, Express, Fastify +full_stack,"full-stack,complete,web+mobile,frontend+backend",Applications with both frontend and backend,T3 App, RedwoodJS, Blitz +cli_tool,"CLI,command line,terminal,console,tool",Command-line interface tools,oclif, Commander, Caporal +desktop_app,"desktop,Electron,Tauri,native app,macOS,Windows",Desktop applications,Electron, Tauri, Flutter Desktop \ No newline at end of file diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml b/src/modules/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml deleted file mode 100644 index fe0b9c03..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml +++ /dev/null @@ -1,222 +0,0 @@ -# Decision Catalog - Composability knowledge for architectural decisions -# This provides RELATIONSHIPS and WORKFLOW LOGIC, not generic tech knowledge -# -# ⚠️ CRITICAL: All version/feature info MUST be verified via WebSearch during workflow -# This file only provides: triggers, relationships (pairs_with), and opinionated stacks - -decision_categories: - data_persistence: - triggers: ["database", "storage", "data model", "persistence", "state management"] - importance: "critical" - affects: "most epics" - options: - postgresql: - pairs_with: ["Prisma ORM", "TypeORM", "Drizzle", "node-postgres"] - mongodb: - pairs_with: ["Mongoose", "Prisma", "MongoDB driver"] - redis: - pairs_with: ["ioredis", "node-redis"] - supabase: - pairs_with: ["@supabase/supabase-js"] - firebase: - pairs_with: ["firebase-admin"] - - api_pattern: - triggers: ["API", "client communication", "frontend backend", "service communication"] - importance: "critical" - affects: "all client-facing epics" - options: - rest: - pairs_with: ["Express", "Fastify", "NestJS", "Hono"] - graphql: - pairs_with: ["Apollo Server", "GraphQL Yoga", "Mercurius"] - trpc: - pairs_with: ["Next.js", "React Query"] - grpc: - pairs_with: ["@grpc/grpc-js", "protobufjs"] - - authentication: - triggers: ["auth", "login", "user management", "security", "identity"] - importance: "critical" - affects: "security and user epics" - options: - nextauth: - pairs_with: ["Next.js", "Prisma"] - auth0: - pairs_with: ["@auth0/nextjs-auth0"] - clerk: - pairs_with: ["@clerk/nextjs"] - supabase_auth: - pairs_with: ["@supabase/supabase-js"] - firebase_auth: - pairs_with: ["firebase-admin"] - - real_time: - triggers: ["real-time", "websocket", "live updates", "chat", "collaboration"] - importance: "medium" - affects: "real-time features" - options: - socket_io: - pairs_with: ["Express", "socket.io-client"] - pusher: - pairs_with: ["pusher-js"] - ably: - pairs_with: ["ably"] - supabase_realtime: - pairs_with: ["@supabase/supabase-js"] - firebase_realtime: - pairs_with: ["firebase"] - - email: - triggers: ["email", "notifications", "transactional email"] - importance: "medium" - affects: "notification epics" - options: - resend: - pairs_with: ["resend", "react-email"] - sendgrid: - pairs_with: ["@sendgrid/mail"] - postmark: - pairs_with: ["postmark"] - ses: - pairs_with: ["@aws-sdk/client-ses"] - - file_storage: - triggers: ["upload", "file storage", "images", "media", "CDN"] - importance: "medium" - affects: "media handling epics" - options: - s3: - pairs_with: ["@aws-sdk/client-s3", "multer"] - cloudinary: - pairs_with: ["cloudinary"] - uploadthing: - pairs_with: ["uploadthing"] - supabase_storage: - pairs_with: ["@supabase/supabase-js"] - - search: - triggers: ["search", "full text", "elasticsearch", "algolia", "fuzzy"] - importance: "medium" - affects: "search and discovery epics" - options: - postgres_fts: - pairs_with: ["PostgreSQL"] - elasticsearch: - pairs_with: ["@elastic/elasticsearch"] - algolia: - pairs_with: ["algoliasearch"] - typesense: - pairs_with: ["typesense"] - - background_jobs: - triggers: ["queue", "jobs", "workers", "async", "background processing", "scheduled"] - importance: "medium" - affects: "async processing epics" - options: - bullmq: - pairs_with: ["Redis"] - sqs: - pairs_with: ["@aws-sdk/client-sqs"] - temporal: - pairs_with: ["@temporalio/client"] - inngest: - pairs_with: ["inngest"] - - deployment_target: - triggers: ["deployment", "hosting", "infrastructure", "cloud", "server"] - importance: "high" - affects: "all epics" - options: - vercel: - pairs_with: ["Next.js", "serverless functions"] - aws: - pairs_with: ["any stack"] - railway: - pairs_with: ["any stack", "managed databases"] - fly_io: - pairs_with: ["Docker containers"] - -# Opinionated stack combinations (BMM methodology) -common_stacks: - modern_fullstack: - name: "Modern Full-Stack" - components: ["Next.js", "PostgreSQL or Supabase", "Prisma ORM", "NextAuth.js", "Tailwind CSS", "TypeScript", "Vercel"] - good_for: "Most web applications" - - enterprise_stack: - name: "Enterprise Stack" - components: ["NestJS", "PostgreSQL", "TypeORM", "Auth0", "Redis", "Docker", "AWS"] - good_for: "Large-scale enterprise applications" - - rapid_prototype: - name: "Rapid Prototype" - components: ["Next.js", "Supabase", "shadcn/ui", "Vercel"] - good_for: "MVP and rapid development" - - real_time_app: - name: "Real-Time Application" - components: ["Next.js", "Supabase Realtime", "PostgreSQL", "Prisma", "Socket.io fallback"] - good_for: "Chat, collaboration, live updates" - - mobile_app: - name: "Mobile Application" - components: ["Expo", "React Native", "Supabase or Firebase", "React Query"] - good_for: "Cross-platform mobile apps" - -# Starter templates and what decisions they make -starter_templates: - create_next_app: - name: "Create Next App" - command_search: "npx create-next-app@latest" - decisions_provided: ["Next.js framework", "TypeScript option", "App Router vs Pages", "Tailwind CSS option", "ESLint"] - good_for: ["React web applications", "Full-stack apps", "SSR/SSG"] - - create_t3_app: - name: "Create T3 App" - command_search: "npm create t3-app@latest" - decisions_provided: ["Next.js", "TypeScript", "tRPC", "Prisma", "NextAuth", "Tailwind CSS"] - good_for: ["Type-safe full-stack apps"] - - create_vite: - name: "Create Vite" - command_search: "npm create vite@latest" - decisions_provided: ["Framework choice (React/Vue/Svelte)", "TypeScript option", "Vite bundler"] - good_for: ["Fast dev SPAs", "Library development"] - - create_remix: - name: "Create Remix" - command_search: "npx create-remix@latest" - decisions_provided: ["Remix framework", "TypeScript option", "Deployment target", "CSS solution"] - good_for: ["Web standards", "Nested routing", "Progressive enhancement"] - - nest_new: - name: "NestJS CLI" - command_search: "nest new project" - decisions_provided: ["TypeScript (always)", "Package manager", "Testing framework (Jest)", "Project structure"] - good_for: ["Enterprise APIs", "Microservices", "GraphQL APIs"] - - create_expo_app: - name: "Create Expo App" - command_search: "npx create-expo-app" - decisions_provided: ["React Native", "Expo SDK", "TypeScript option", "Navigation option"] - good_for: ["Cross-platform mobile", "React Native apps"] - -# Starter selection heuristics (workflow logic) -starter_selection_rules: - by_project_type: - web_application: - recommended: ["create_next_app", "create_t3_app", "create_vite"] - considerations: "SSR needs? → Next.js. Type safety critical? → T3. SPA only? → Vite" - - mobile_app: - recommended: ["create_expo_app"] - considerations: "Cross-platform → Expo. Native-heavy → React Native CLI" - - api_backend: - recommended: ["nest_new"] - considerations: "Enterprise → NestJS. Simple → Express starter. Performance → Fastify" - - full_stack: - recommended: ["create_t3_app", "create_remix"] - considerations: "Type safety → T3. Web standards → Remix. Monolith → RedwoodJS" diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md b/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md deleted file mode 100644 index 385c58ab..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +++ /dev/null @@ -1,784 +0,0 @@ -# Decision Architecture Workflow Instructions - - -- The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml -- You MUST have already loaded and processed: {installed_path}/workflow.yaml -- This workflow uses ADAPTIVE FACILITATION - adjust your communication style based on {user_skill_level} -- The goal is ARCHITECTURAL DECISIONS that prevent AI agent conflicts, not detailed implementation specs -- Communicate all responses in {communication_language} and tailor to {user_skill_level} -- Generate all documents in {document_output_language} -- This workflow replaces architecture with a conversation-driven approach -- Input documents specified in workflow.yaml input_file_patterns - workflow engine handles fuzzy matching, whole vs sharded document discovery automatically -- ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. - - ⚠️ CHECKPOINT PROTOCOL: After writing to a template-output tag, you must stop and offer a menu to the user to run the {advanced_elicitation} or {party-mode} workflow. - - YOU ARE FACILITATING A CONVERSATION With a user to produce a final document step by step. The whole process is meant to be collaborative helping the user flesh out their ideas - - - - - -Check if {output_folder}/bmm-workflow-status.yaml exists - - - No workflow status file found. Create Architecture can run standalone or as part of BMM workflow path. - **Recommended:** Run `workflow-init` first for project context tracking and workflow sequencing. - Continue in standalone mode or exit to run workflow-init? (continue/exit) - - Set standalone_mode = true - - - Exit workflow - - - - - Load the FULL file: {output_folder}/bmm-workflow-status.yaml - Parse workflow_status section - Check status of "create-architecture" workflow - Get project_level from YAML metadata - Find first non-completed workflow (next expected workflow) - - - - ⚠️ Architecture already completed: {{create-architecture status}} - Re-running will overwrite the existing architecture. Continue? (y/n) - - Exiting. Use workflow-status to see your next step. - Exit workflow - - - - - ⚠️ Next expected workflow: {{next_workflow}}. Architecture is out of sequence. - Continue with Architecture anyway? (y/n) - - Exiting. Run {{next_workflow}} instead. - Exit workflow - - - -Set standalone_mode = false - -Check for existing PRD file using fuzzy matching - -Fuzzy match PRD file: {prd_file} - -**PRD Not Found** - -Creation of an Architecture works from your Product Requirements Document (PRD), along with an optional UX Design and other assets. - -Looking for: _prd_.md, or prd/\* + files in {output_folder} - -Please talk to the PM Agent to run the Create PRD workflow first to define your requirements, or if I am mistaken and it does exist, provide the file now. - -Would you like to exit, or can you provide a PRD? -Exit workflow - PRD required -Proceed to Step 1 - - - - - - - -After discovery, these content variables are available: {prd_content}, {epics_content}, {ux_design_content}, {document_project_content} - - - - Review loaded PRD: {prd_content} (auto-loaded in Step 0.5 - handles both whole and sharded documents) - - - Review loaded epics: {epics_content} - - -Check for UX specification: - -Extract architectural implications from {ux_design_content}: - Component complexity (simple forms vs rich interactions) - Animation/transition requirements - Real-time update needs (live data, collaborative features) - Platform-specific UI requirements - Accessibility standards (WCAG compliance level) - Responsive design breakpoints - Offline capability requirements - Performance expectations (load times, interaction responsiveness) - - - - -Extract and understand from {prd_content}: - -- Functional Requirements (FRs) - the complete list of capabilities -- Non-Functional Requirements (performance, security, compliance, etc.) -- Any technical constraints mentioned - - - - Extract from {epics_content}: - - Epic structure and user stories - - Acceptance criteria - - - -Count and assess project scale: - - -- Number of epics: {{epic_count}} -- Number of stories: {{story_count}} - - -- Number of functional requirements: {{fr_count}} (from PRD) -- FR categories: {{fr_category_list}} (capability groups from PRD) - -- Complexity indicators (real-time, multi-tenant, regulated, etc.) -- UX complexity level (if UX spec exists) -- Novel features - - -Reflect understanding back to {user_name}: -"I'm reviewing your project documentation for {{project_name}}. - -I see {{epic_count}} epics with {{story_count}} total stories. - - -I found {{fr_count}} functional requirements organized into {{fr_category_list}}. - -{{if_ux_spec}}I also found your UX specification which defines the user experience requirements.{{/if_ux_spec}} - - Key aspects I notice: - - [Summarize core functionality] - - [Note critical NFRs] - {{if_ux_spec}}- [Note UX complexity and requirements]{{/if_ux_spec}} - - [Identify unique challenges] - - This will help me guide you through the architectural decisions needed - to ensure AI agents implement this consistently." - - - -Does this match your understanding of the project? -project_context_understanding - - - - Modern starter templates make many good architectural decisions by default - -Based on PRD analysis, identify the primary technology domain: - Web application → Look for Next.js, Vite, Remix starters - Mobile app → Look for React Native, Expo, Flutter starters - API/Backend → Look for NestJS, Express, Fastify starters - CLI tool → Look for CLI framework starters - Full-stack → Look for T3, RedwoodJS, Blitz starters - - - - Consider UX requirements when selecting starter: - - Rich animations → Framer Motion compatible starter - - Complex forms → React Hook Form included starter - - Real-time features → Socket.io or WebSocket ready starter - - Accessibility focus → WCAG-compliant component library starter - - Design system → Storybook-enabled starter - - - -Search for relevant starter templates with websearch, examples: -{{primary_technology}} starter template CLI create command latest {date} -{{primary_technology}} boilerplate generator latest options - - - - Investigate what each starter provides: - {{starter_name}} default setup technologies included latest - {{starter_name}} project structure file organization - - - - Present starter options concisely: - "Found {{starter_name}} which provides: - {{quick_decision_list}} - - This would establish our base architecture. Use it?" - - - - - Explain starter benefits: - "I found {{starter_name}}, which is like a pre-built foundation for your project. - - Think of it like buying a prefab house frame instead of cutting each board yourself. - - It makes these decisions for you: - {{friendly_decision_list}} - - This is a great starting point that follows best practices. Should we use it?" - - - - Use {{starter_name}} as the foundation? (recommended) [y/n] - - - Get current starter command and options: - {{starter_name}} CLI command options flags latest 2024 - - - Document the initialization command: - Store command: {{full_starter_command_with_options}} - Example: "npx create-next-app@latest my-app --typescript --tailwind --app" - - - Extract and document starter-provided decisions: - Starter provides these architectural decisions: - - Language/TypeScript: {{provided_or_not}} - - Styling solution: {{provided_or_not}} - - Testing framework: {{provided_or_not}} - - Linting/Formatting: {{provided_or_not}} - - Build tooling: {{provided_or_not}} - - Project structure: {{provided_pattern}} - - - Mark these decisions as "PROVIDED BY STARTER" in our decision tracking - - Note for first implementation story: - "Project initialization using {{starter_command}} should be the first implementation story" - - - - - Any specific reason to avoid the starter? (helps me understand constraints) - Note: Manual setup required, all decisions need to be made explicitly - - - - - - Note: No standard starter template found for this project type. - We will make all architectural decisions explicitly. - - -starter_template_decision - - - - Based on {user_skill_level} from config, set facilitation approach: - - - Set mode: EXPERT - - Use technical terminology freely - - Move quickly through decisions - - Assume familiarity with patterns and tools - - Focus on edge cases and advanced concerns - - - - Set mode: INTERMEDIATE - - Balance technical accuracy with clarity - - Explain complex patterns briefly - - Confirm understanding at key points - - Provide context for non-obvious choices - - - - Set mode: BEGINNER - - Use analogies and real-world examples - - Explain technical concepts in simple terms - - Provide education about why decisions matter - - Protect from complexity overload - - - -Load decision catalog: {decision_catalog} -Load architecture patterns: {architecture_patterns} - -Analyze PRD against patterns to identify needed decisions: - Match functional requirements to known patterns - Identify which categories of decisions are needed - Flag any novel/unique aspects requiring special attention - Consider which decisions the starter template already made (if applicable) - - -Create decision priority list: -CRITICAL (blocks everything): - {{list_of_critical_decisions}} - - IMPORTANT (shapes architecture): - - {{list_of_important_decisions}} - - NICE-TO-HAVE (can defer): - - {{list_of_optional_decisions}} - - - -Announce plan to {user_name} based on mode: - -"Based on your PRD, we need to make {{total_decision_count}} architectural decisions. -{{starter_covered_count}} are covered by the starter template. -Let's work through the remaining {{remaining_count}} decisions." - - - - "Great! I've analyzed your requirements and found {{total_decision_count}} technical - choices we need to make. Don't worry - I'll guide you through each one and explain - why it matters. {{if_starter}}The starter template handles {{starter_covered_count}} - of these automatically.{{/if_starter}}" - - - - -decision_identification - - - - Each decision must be made WITH the user, not FOR them - ALWAYS verify current versions using WebSearch - NEVER trust hardcoded versions - -For each decision in priority order: - -Present the decision based on mode: - -"{{Decision_Category}}: {{Specific_Decision}} - - Options: {{concise_option_list_with_tradeoffs}} - - Recommendation: {{recommendation}} for {{reason}}" - - - - - "Next decision: {{Human_Friendly_Category}} - - We need to choose {{Specific_Decision}}. - - Common options: - {{option_list_with_brief_explanations}} - - For your project, {{recommendation}} would work well because {{reason}}." - - - - - "Let's talk about {{Human_Friendly_Category}}. - - {{Educational_Context_About_Why_This_Matters}} - - Think of it like {{real_world_analogy}}. - - Your main options: - {{friendly_options_with_pros_cons}} - - My suggestion: {{recommendation}} - This is good for you because {{beginner_friendly_reason}}." - - - - - - - Verify current stable version: - {{technology}} latest stable version 2024 - {{technology}} current LTS version - - - Update decision record with verified version: - Technology: {{technology}} - Verified Version: {{version_from_search}} - Verification Date: {{today}} - - - - -What's your preference? (or 'explain more' for details) - - - Provide deeper explanation appropriate to skill level - - Consider using advanced elicitation: - "Would you like to explore innovative approaches to this decision? - I can help brainstorm unconventional solutions if you have specific goals." - - - - -Record decision: -Category: {{category}} -Decision: {{user_choice}} -Version: {{verified_version_if_applicable}} - -Affects Epics: {{list_of_affected_epics}} - - -Affects FR Categories: {{list_of_affected_fr_categories}} - -Rationale: {{user_reasoning_or_default}} -Provided by Starter: {{yes_if_from_starter}} - - -Check for cascading implications: -"This choice means we'll also need to {{related_decisions}}" - - -decision_record - - - - These decisions affect EVERY epic and story - -Facilitate decisions for consistency patterns: - Error handling strategy (How will all agents handle errors?) - Logging approach (Structured? Format? Levels?) - Date/time handling (Timezone? Format? Library?) - Authentication pattern (Where? How? Token format?) - API response format (Structure? Status codes? Errors?) - Testing strategy (Unit? Integration? E2E?) - - - - Explain why these matter why its critical to go through and decide these things now. - - -cross_cutting_decisions - - - - Based on all decisions made, define the project structure - -Create comprehensive source tree: - Root configuration files - Source code organization - Test file locations - Build/dist directories - Documentation structure - - - - Map epics to architectural boundaries: - "Epic: {{epic_name}} → Lives in {{module/directory/service}}" - - - - Map FR categories to architectural boundaries: - "FR Category: {{fr_category_name}} → Lives in {{module/directory/service}}" - - - -Define integration points: - Where do components communicate? - What are the API boundaries? - How do services interact? - - -project_structure - - - - Some projects require INVENTING new patterns, not just choosing existing ones - -Scan PRD for concepts that don't have standard solutions: - Novel interaction patterns (e.g., "swipe to match" before Tinder existed) - Unique multi-component workflows (e.g., "viral invitation system") - New data relationships (e.g., "social graph" before Facebook) - Unprecedented user experiences (e.g., "ephemeral messages" before Snapchat) - - -- Complex state machines crossing multiple epics - - -- Complex state machines crossing multiple FR categories - - - - - For each novel pattern identified: - - Engage user in design collaboration: - - "The {{pattern_name}} concept requires architectural innovation. - - Core challenge: {{challenge_description}} - - Let's design the component interaction model:" - - - - "Your idea about {{pattern_name}} is unique - there isn't a standard way to build this yet! - - This is exciting - we get to invent the architecture together. - - Let me help you think through how this should work:" - - - - - Facilitate pattern design: 1. Identify core components involved 2. Map data flow between components 3. Design state management approach 4. Create sequence diagrams for complex flows 5. Define API contracts for the pattern 6. Consider edge cases and failure modes - - - Use advanced elicitation for innovation: - "What if we approached this differently? - What would the ideal user experience look like? - Are there analogies from other domains we could apply? - What constraints can we challenge?" - - - Document the novel pattern: - Pattern Name: {{pattern_name}} - Purpose: {{what_problem_it_solves}} - Components: - {{component_list_with_responsibilities}} - Data Flow: - {{sequence_description_or_diagram}} - Implementation Guide: - {{how_agents_should_build_this}} - - - Affects Epics: - {{epics_that_use_this_pattern}} - - - Affects FR Categories: - {{fr_categories_that_use_this_pattern}} - - - - Validate pattern completeness: - - - "Does this {{pattern_name}} design cover all the use cases in your epics? - - - "Does this {{pattern_name}} design cover all the use cases in your requirements? - - - {{use_case_1}}: ✓ Handled by {{component}} - - {{use_case_2}}: ✓ Handled by {{component}} - ..." - - - - - - Note: All patterns in this project have established solutions. - Proceeding with standard architectural patterns. - - -novel_pattern_designs - - - - These patterns ensure multiple AI agents write compatible code - Focus on what agents could decide DIFFERENTLY if not specified - -Load pattern categories: {pattern_categories} - -Based on chosen technologies, identify potential conflict points: -"Given that we're using {{tech_stack}}, agents need consistency rules for:" - - -For each relevant pattern category, facilitate decisions: - - NAMING PATTERNS (How things are named): - - - REST endpoint naming: /users or /user? Plural or singular? - - Route parameter format: :id or {id}? - - - - Table naming: users or Users or user? - - Column naming: user_id or userId? - - Foreign key format: user_id or fk_user? - - - - Component naming: UserCard or user-card? - - File naming: UserCard.tsx or user-card.tsx? - - - STRUCTURE PATTERNS (How things are organized): - - Where do tests live? __tests__/ or *.test.ts co-located? - - How are components organized? By feature or by type? - - Where do shared utilities go? - - FORMAT PATTERNS (Data exchange formats): - - - API response wrapper? {data: ..., error: ...} or direct response? - - Error format? {message, code} or {error: {type, detail}}? - - Date format in JSON? ISO strings or timestamps? - - - COMMUNICATION PATTERNS (How components interact): - - - Event naming convention? - - Event payload structure? - - - - State update pattern? - - Action naming convention? - - - LIFECYCLE PATTERNS (State and flow): - - How are loading states handled? - - What's the error recovery pattern? - - How are retries implemented? - - LOCATION PATTERNS (Where things go): - - API route structure? - - Static asset organization? - - Config file locations? - - CONSISTENCY PATTERNS (Cross-cutting): - - How are dates formatted in the UI? - - What's the logging format? - - How are user-facing errors written? - - - - - Rapid-fire through patterns: - "Quick decisions on implementation patterns: - - {{pattern}}: {{suggested_convention}} OK? [y/n/specify]" - - - - - Explain each pattern's importance: - "Let me explain why this matters: - If one AI agent names database tables 'users' and another names them 'Users', - your app will crash. We need to pick one style and make sure everyone follows it." - - - -Document implementation patterns: -Category: {{pattern_category}} -Pattern: {{specific_pattern}} -Convention: {{decided_convention}} -Example: {{concrete_example}} -Enforcement: "All agents MUST follow this pattern" - - -implementation_patterns - - - - Run coherence checks: - -Check decision compatibility: - Do all decisions work together? - Are there any conflicting choices? - Do the versions align properly? - - - - Verify epic coverage: - Does every epic have architectural support? - Are all user stories implementable with these decisions? - Are there any gaps? - - - - Verify FR coverage: - Does every functional requirement have architectural support? - Are all capabilities implementable with these decisions? - Are there any gaps? - - - -Validate pattern completeness: - Are there any patterns we missed that agents would need? - Do novel patterns integrate with standard architecture? - Are implementation patterns comprehensive enough? - - - - Address issues with {user_name}: - "I notice {{issue_description}}. - We should {{suggested_resolution}}." - - How would you like to resolve this? - Update decisions based on resolution - - -coherence_validation - - - - The document must be complete, specific, and validation-ready - This is the consistency contract for all AI agents - -Load template: {architecture_template} - -Generate sections: 1. Executive Summary (2-3 sentences about the architecture approach) 2. Project Initialization (starter command if applicable) 3. Decision Summary Table (with verified versions and coverage mapping) 4. Complete Project Structure (full tree, no placeholders) - 5. Epic to Architecture Mapping (every epic placed) - - 5. FR Category to Architecture Mapping (every FR category placed) - 6. Technology Stack Details (versions, configurations) 7. Integration Points (how components connect) 8. Novel Pattern Designs (if any were created) 9. Implementation Patterns (all consistency rules) 10. Consistency Rules (naming, organization, formats) 11. Data Architecture (models and relationships) 12. API Contracts (request/response formats) 13. Security Architecture (auth, authorization, data protection) 14. Performance Considerations (from NFRs) 15. Deployment Architecture (where and how) 16. Development Environment (setup and prerequisites) 17. Architecture Decision Records (key decisions with rationale) - - -Fill template with all collected decisions and patterns - -Ensure starter command is first implementation story: - -"## Project Initialization - - First implementation story should execute: - ```bash - {{starter_command_with_options}} - ``` - - This establishes the base architecture with these decisions: - {{starter_provided_decisions}}" - - - - -architecture_document - - - - Load validation checklist: {installed_path}/checklist.md - -Run validation checklist from {installed_path}/checklist.md - -Verify MANDATORY items: - -- [] Decision table has Version column with specific versions - -- [] Every epic is mapped to architecture components - - -- [] Every FR category is mapped to architecture components - -- [] Source tree is complete, not generic -- [] No placeholder text remains -- [] All FRs from PRD have architectural support -- [] All NFRs from PRD are addressed -- [] Implementation patterns cover all potential conflicts -- [] Novel patterns are fully documented (if applicable) - - - - Fix missing items automatically - Regenerate document section - - -validation_results - - - - Present completion summary: - - - "Architecture complete. {{decision_count}} decisions documented. - Ready for implementation phase." - - - - "Excellent! Your architecture is complete. You made {{decision_count}} important - decisions that will keep AI agents consistent as they build your app. - - What happens next: - 1. AI agents will read this architecture before implementing each story - 2. They'll follow your technical choices exactly - 3. Your app will be built with consistent patterns throughout - - You're ready to move to the implementation phase!" - - - -Save document to {output_folder}/architecture.md - - - Load the FULL file: {output_folder}/bmm-workflow-status.yaml - Find workflow_status key "create-architecture" - ONLY write the file path as the status value - no other text, notes, or metadata - Update workflow_status["create-architecture"] = "{output_folder}/bmm-architecture-{{date}}.md" - Save file, preserving ALL comments and structure including STATUS DEFINITIONS - - Find first non-completed workflow in workflow_status (next workflow to do) - Determine next agent from path file based on next workflow - - - -✅ Decision Architecture workflow complete! - -**Deliverables Created:** - -- ✅ architecture.md - Complete architectural decisions document - {{if_novel_patterns}} -- ✅ Novel pattern designs for unique concepts - {{/if_novel_patterns}} - {{if_starter_template}} -- ✅ Project initialization command documented - {{/if_starter_template}} - -The architecture is ready to guide AI agents through consistent implementation. - -**Next Steps:** - -- **Next required:** {{next_workflow}} ({{next_agent}} agent) -- Review the architecture.md document before proceeding - -Check status anytime with: `workflow-status` - - -completion_summary - - - - - -- The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml -- You MUST have already loaded and processed: {installed_path}/workflow.yaml -- This workflow uses ADAPTIVE FACILITATION - adjust your communication style based on {user_skill_level} -- The goal is ARCHITECTURAL DECISIONS that prevent AI agent conflicts, not detailed implementation specs -- Communicate all responses in {communication_language} and tailor to {user_skill_level} -- Generate all documents in {document_output_language} -- This workflow replaces architecture with a conversation-driven approach -- Input documents specified in workflow.yaml input_file_patterns - workflow engine handles fuzzy matching, whole vs sharded document discovery automatically -- ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. - - ⚠️ CHECKPOINT PROTOCOL: After writing to a template-output tag, you must stop and offer a menu to the user to run the {advanced_elicitation} or {party-mode} workflow. - - YOU ARE FACILITATING A CONVERSATION With a user to produce a final document step by step. The whole process is meant to be collaborative helping the user flesh out their ideas - diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/pattern-categories.csv b/src/modules/bmm/workflows/3-solutioning/architecture/pattern-categories.csv deleted file mode 100644 index bad699b1..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/pattern-categories.csv +++ /dev/null @@ -1,13 +0,0 @@ -category,when_needed,what_to_define,why_critical -naming_patterns,Any technology with named entities,How things are named (format/case/structure),Agents will create different names for same concept -structure_patterns,Any technology with organization,How things are organized (folders/modules/layers),Agents will put things in different places -format_patterns,Any technology with data exchange,How data is formatted (JSON/XML/responses),Agents will use incompatible formats -communication_patterns,Any technology with inter-component communication,How components talk (protocols/events/messages),Agents will use different communication methods -lifecycle_patterns,Any technology with state or flow,How state changes and flows work,Agents will handle state transitions differently -location_patterns,Any technology with storage or routing,Where things go (URLs/paths/storage),Agents will put things in different locations -consistency_patterns,Always,Cross-cutting concerns (dates/errors/logs),Every agent will do these differently - -# PRINCIPLE FOR LLM: -# Any time multiple agents might make the SAME decision DIFFERENTLY, that's a pattern to capture. -# Think about: What could an agent encounter where they'd have to guess? -# If they'd guess, define the pattern. If it's obvious from the tech choice, skip it. \ No newline at end of file diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-01-init.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-01-init.md new file mode 100644 index 00000000..21940ca7 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-01-init.md @@ -0,0 +1,194 @@ +# Step 1: Architecture Workflow Initialization + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on initialization and setup only - don't look ahead to future steps +- 🚪 DETECT existing workflow state and handle continuation properly +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your 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 + +## YOUR TASK: + +Initialize the Architecture workflow by detecting continuation state, discovering input documents, and setting up the document for collaborative architectural decision making. + +## INITIALIZATION SEQUENCE: + +### 1. Check for Existing Workflow + +First, check if the output document already exists: + +- Look for file at `{output_folder}/architecture.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. Fresh Workflow Setup (If No Document) + +If no document exists or no `stepsCompleted` in frontmatter: + +#### A. Input Document Discovery + +Discover and load context documents using smart discovery: + +**PRD Document (Priority: Analysis → Main → Sharded → Whole):** + +1. Check analysis folder: `{output_folder}/*prd*.md` +2. If no main files: Check for sharded PRD folder: `{output_folder}/*prd*/**/*.md` +3. If sharded folder exists: Load EVERY file in that folder completely +4. Add discovered files to `inputDocuments` frontmatter + +**Epics/Stories Document (Priority: Analysis → Main → Sharded → Whole):** + +1. Check analysis folder: `{output_folder}/analysis/*epic*.md` +2. If no analysis files: Try main folder: `{output_folder}/*epic*.md` +3. If no main files: Check for sharded epics folder: `{output_folder}/*epic*/**/*.md` +4. If sharded folder exists: Load EVERY file in that folder completely +5. Add discovered files to `inputDocuments` frontmatter + +**UX Design Specification (Priority: Analysis → Main → Sharded → Whole):** + +1. Check folder: `{output_folder}/*ux*.md` +2. If no main files: Check for sharded UX folder: `{output_folder}/*ux*/**/*.md` +3. If sharded folder exists: Load EVERY file in that folder completely +4. Add discovered files to `inputDocuments` frontmatter + +**Research Documents (Priority: Analysis → Main):** + +1. Check folder: `{output_folder}/research/*research*.md` +2. If no files: Try folder: `{output_folder}/*research*.md` +3. Add discovered files to `inputDocuments` frontmatter + +**Project Documentation (Existing Projects):** + +1. Look for index file: `{output_folder/index.md` +2. CRITICAL: Load index.md to understand what project files are available +3. Read available files from index to understand existing project context +4. This provides essential context for extending existing project with new architecture +5. Add discovered files to `inputDocuments` frontmatter + +**Project Context Rules (Critical for AI Agents):** + +1. Check for project context file: `**/project_context.md` +2. If exists: Load COMPLETE file contents - this contains critical rules for AI agents +3. Add to frontmatter `hasProjectContext: true` and track file path +4. Report to user: "Found existing project context with {number_of_rules} agent rules" +5. This file contains language-specific patterns, testing rules, and implementation guidelines that must be followed + +**Loading Rules:** + +- Load ALL discovered files completely (no offset/limit) +- For sharded folders, load ALL files to get complete picture +- For existing projects, use index.md as guide to what's relevant +- Track all successfully loaded files in frontmatter `inputDocuments` array + +#### B. Validate Required Inputs + +Before proceeding, verify we have the essential inputs: + +**PRD Validation:** + +- If no PRD found: "Architecture requires a PRD to work from. Please run the PRD workflow first or provide the PRD file path." +- Do NOT proceed without PRD + +**Other Inputs:** + +- UX Spec: "Provides UI/UX architectural requirements" (Optional) + +#### C. Create Initial Document + +Copy the template from `{installed_path}/architecture-decision-template.md` to `{output_folder}/architecture.md` +Initialize frontmatter with: + +```yaml +--- +stepsCompleted: [] +inputDocuments: [] +workflowType: 'architecture' +lastStep: 0 +project_name: '{{project_name}}' +user_name: '{{user_name}}' +date: '{{date}}' +--- +``` + +#### D. Complete Initialization and Report + +Complete setup and report to user: + +**Document Setup:** + +- Created: `{output_folder}/architecture.md` from template +- Initialized frontmatter with workflow state + +**Input Documents Discovered:** +Report what was found: +"Welcome {{user_name}}! I've set up your Architecture workspace for {{project_name}}. + +**Documents Found:** + +- PRD: {number of PRD files loaded or "None found - REQUIRED"} +- Epics/Stories: {number of epic files loaded or "None found"} +- UX Design: {number of UX files loaded or "None found"} +- Research: {number of research files loaded or "None found"} +- Project docs: {number of project files loaded or "None found"} +- Project context: {project_context_rules count of rules for AI agents found} + +**Files loaded:** {list of specific file names or "No additional documents found"} + +Ready to begin architectural decision making. Do you have any other documents you'd like me to include? + +[C] Continue to project context analysis + +## SUCCESS METRICS: + +✅ Existing workflow detected and handed off to step-01b correctly +✅ Fresh workflow initialized with template and frontmatter +✅ Input documents discovered and loaded using sharded-first logic +✅ All discovered files tracked in frontmatter `inputDocuments` +✅ PRD requirement validated and communicated +✅ User confirmed document setup and can proceed + +## FAILURE MODES: + +❌ Proceeding with fresh initialization when existing workflow exists +❌ Not updating frontmatter with discovered input documents +❌ Creating document without proper template +❌ Not checking sharded folders first before whole files +❌ Not reporting what documents were found to user +❌ Proceeding without validating PRD requirement + +❌ **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 + +## NEXT STEP: + +After user selects [C] to continue, load `./step-02-context.md` to analyze the project context and begin architectural decision making. + +Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed! diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-01b-continue.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-01b-continue.md new file mode 100644 index 00000000..38f87d34 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-01b-continue.md @@ -0,0 +1,163 @@ +# Step 1b: Workflow Continuation Handler + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on understanding current state and getting user confirmation +- 🚪 HANDLE workflow resumption smoothly and transparently +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 📖 Read existing document completely to understand current state +- 💾 Update frontmatter to reflect continuation +- 🚫 FORBIDDEN to proceed to next step without user confirmation + +## CONTEXT BOUNDARIES: + +- Existing document and frontmatter are available +- Input documents already loaded should be in frontmatter `inputDocuments` +- Steps already completed are in `stepsCompleted` array +- Focus on understanding where we left off + +## YOUR TASK: + +Handle workflow continuation by analyzing existing work and guiding the user to resume at the appropriate step. + +## CONTINUATION SEQUENCE: + +### 1. Analyze Current Document State + +Read the existing architecture document completely and analyze: + +**Frontmatter Analysis:** + +- `stepsCompleted`: What steps have been done +- `inputDocuments`: What documents were loaded +- `lastStep`: Last step that was executed +- `project_name`, `user_name`, `date`: Basic context + +**Content Analysis:** + +- What sections exist in the document +- What architectural decisions have been made +- What appears incomplete or in progress +- Any TODOs or placeholders remaining + +### 2. Present Continuation Summary + +Show the user their current progress: + +"Welcome back {{user_name}}! I found your Architecture work for {{project_name}}. + +**Current Progress:** + +- Steps completed: {{stepsCompleted list}} +- Last step worked on: Step {{lastStep}} +- Input documents loaded: {{number of inputDocuments}} files + +**Document Sections Found:** +{list all H2/H3 sections found in the document} + +{if_incomplete_sections} +**Incomplete Areas:** + +- {areas that appear incomplete or have placeholders} + {/if_incomplete_sections} + +**What would you like to do?** +[R] Resume from where we left off +[C] Continue to next logical step +[O] Overview of all remaining steps +[X] Start over (will overwrite existing work) +" + +### 3. Handle User Choice + +#### If 'R' (Resume from where we left off): + +- Identify the next step based on `stepsCompleted` +- Load the appropriate step file to continue +- Example: If `stepsCompleted: [1, 2, 3]`, load `step-04-decisions.md` + +#### If 'C' (Continue to next logical step): + +- Analyze the document content to determine logical next step +- May need to review content quality and completeness +- If content seems complete for current step, advance to next +- If content seems incomplete, suggest staying on current step + +#### If 'O' (Overview of all remaining steps): + +- Provide brief description of all remaining steps +- Let user choose which step to work on +- Don't assume sequential progression is always best + +#### If 'X' (Start over): + +- Confirm: "This will delete all existing architectural decisions. Are you sure? (y/n)" +- If confirmed: Delete existing document and return to step-01-init.md +- If not confirmed: Return to continuation menu + +### 4. Navigate to Selected Step + +After user makes choice: + +**Load the selected step file:** + +- Update frontmatter `lastStep` to reflect current navigation +- Execute the selected step file +- Let that step handle the detailed continuation logic + +**State Preservation:** + +- Maintain all existing content in the document +- Keep `stepsCompleted` accurate +- Track the resumption in workflow status + +### 5. Special Continuation Cases + +#### If `stepsCompleted` is empty but document has content: + +- This suggests an interrupted workflow +- Ask user: "I see the document has content but no steps are marked as complete. Should I analyze what's here and set the appropriate step status?" + +#### If document appears corrupted or incomplete: + +- Ask user: "The document seems incomplete. Would you like me to try to recover what's here, or would you prefer to start fresh?" + +#### If document is complete but workflow not marked as done: + +- Ask user: "The architecture looks complete! Should I mark this workflow as finished, or is there more you'd like to work on?" + +## SUCCESS METRICS: + +✅ Existing document state properly analyzed and understood +✅ User presented with clear continuation options +✅ User choice handled appropriately and transparently +✅ Workflow state preserved and updated correctly +✅ Navigation to appropriate step handled smoothly + +## FAILURE MODES: + +❌ Not reading the complete existing document before making suggestions +❌ Losing track of what steps were actually completed +❌ Automatically proceeding without user confirmation of next steps +❌ Not checking for incomplete or placeholder content +❌ Losing existing document content during resumption + +❌ **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 + +## NEXT STEP: + +After user selects their continuation option, load the appropriate step file based on their choice. The step file will handle the detailed work from that point forward. + +Remember: The goal is smooth, transparent resumption that respects the work already done while giving the user control over how to proceed. diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-02-context.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-02-context.md new file mode 100644 index 00000000..b63132ae --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-02-context.md @@ -0,0 +1,223 @@ +# Step 2: Project Context Analysis + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on understanding project scope and requirements for architecture +- 🎯 ANALYZE loaded documents, don't assume or generate requirements +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- ⚠️ Present A/P/C menu after generating project context analysis +- 💾 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 project context and architectural implications +- **P (Party Mode)**: Bring multiple perspectives to analyze project requirements from different architectural angles +- **C (Continue)**: Save the content to the document and proceed to next step + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- Current document and frontmatter from step 1 are available +- Input documents already loaded are in memory (PRD, epics, UX spec, etc.) +- Focus on architectural implications of requirements +- No technology decisions yet - pure analysis phase + +## YOUR TASK: + +Fully read and Analyze the loaded project documents to understand architectural scope, requirements, and constraints before beginning decision making. + +## CONTEXT ANALYSIS SEQUENCE: + +### 1. Review Project Requirements + +**From PRD Analysis:** + +- Extract and analyze Functional Requirements (FRs) +- Identify Non-Functional Requirements (NFRs) like performance, security, compliance +- Note any technical constraints or dependencies mentioned +- Count and categorize requirements to understand project scale + +**From Epics/Stories (if available):** + +- Map epic structure and user stories to architectural components +- Extract acceptance criteria for technical implications +- Identify cross-cutting concerns that span multiple epics +- Estimate story complexity for architectural planning + +**From UX Design (if available):** + +- Extract architectural implications from UX requirements: + - Component complexity (simple forms vs rich interactions) + - Animation/transition requirements + - Real-time update needs (live data, collaborative features) + - Platform-specific UI requirements + - Accessibility standards (WCAG compliance level) + - Responsive design breakpoints + - Offline capability requirements + - Performance expectations (load times, interaction responsiveness) + +### 2. Project Scale Assessment + +Calculate and present project complexity: + +**Complexity Indicators:** + +- Real-time features requirements +- Multi-tenancy needs +- Regulatory compliance requirements +- Integration complexity +- User interaction complexity +- Data complexity and volume + +### 3. Reflect Understanding + +Present your analysis back to user for validation: + +"I'm reviewing your project documentation for {{project_name}}. + +{if_epics_loaded}I see {{epic_count}} epics with {{story_count}} total stories.{/if_epics_loaded} +{if_no_epics}I found {{fr_count}} functional requirements organized into {{fr_category_list}}.{/if_no_epics} +{if_ux_loaded}I also found your UX specification which defines the user experience requirements.{/if_ux_loaded} + +**Key architectural aspects I notice:** + +- [Summarize core functionality from FRs] +- [Note critical NFRs that will shape architecture] +- {if_ux_loaded}[Note UX complexity and technical requirements]{/if_ux_loaded} +- [Identify unique technical challenges or constraints] +- [Highlight any regulatory or compliance requirements] + +**Scale indicators:** + +- Project complexity appears to be: [low/medium/high/enterprise] +- Primary technical domain: [web/mobile/api/backend/full-stack/etc] +- Cross-cutting concerns identified: [list major ones] + +This analysis will help me guide you through the architectural decisions needed to ensure AI agents implement this consistently. + +Does this match your understanding of the project scope and requirements?" + +### 4. Generate Project Context Content + +Prepare the content to append to the document: + +#### Content Structure: + +```markdown +## Project Context Analysis + +### Requirements Overview + +**Functional Requirements:** +{{analysis of FRs and what they mean architecturally}} + +**Non-Functional Requirements:** +{{NFRs that will drive architectural decisions}} + +**Scale & Complexity:** +{{project_scale_assessment}} + +- Primary domain: {{technical_domain}} +- Complexity level: {{complexity_level}} +- Estimated architectural components: {{component_count}} + +### Technical Constraints & Dependencies + +{{known_constraints_dependencies}} + +### Cross-Cutting Concerns Identified + +{{concerns_that_will_affect_multiple_components}} +``` + +### 5. Present Content and Menu + +Show the generated content and present choices: + +"I've drafted the Project Context Analysis based on your requirements. This sets the foundation for our architectural decisions. + +**Here's what I'll add to the document:** + +[Show the complete markdown content from step 4] + +**What would you like to do?** +[A] Advanced Elicitation - Let's dive deeper into architectural implications +[P] Party Mode - Bring different perspectives to analyze requirements +[C] Continue - Save this analysis and begin architectural decisions" + +### 6. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with the current context analysis +- Process the enhanced architectural insights that come back +- Ask user: "Accept these enhancements to the project context 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_folder}/core/workflows/party-mode/workflow.md with the current project context +- Process the collaborative improvements to architectural understanding +- Ask user: "Accept these changes to the project context 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 `{output_folder}/architecture.md` +- Update frontmatter: `stepsCompleted: [1, 2]` +- Load `./step-03-starter.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 4. + +## SUCCESS METRICS: + +✅ All input documents thoroughly analyzed for architectural implications +✅ Project scope and complexity clearly assessed and validated +✅ Technical constraints and dependencies identified +✅ Cross-cutting concerns mapped for architectural planning +✅ User confirmation of project understanding +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Skimming documents without deep architectural analysis +❌ Missing or misinterpreting critical NFRs +❌ Not validating project understanding with user +❌ Underestimating complexity indicators +❌ Generating content without real analysis of loaded documents +❌ Not presenting A/P/C menu after content generation + +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-03-starter.md` to evaluate starter template options. + +Remember: Do NOT proceed to step-03 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-03-starter.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-03-starter.md new file mode 100644 index 00000000..8421851a --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-03-starter.md @@ -0,0 +1,330 @@ +# Step 3: Starter Template Evaluation + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without user input +- ✅ ALWAYS treat this as collaborative discovery between architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on evaluating starter template options with current versions +- 🌐 ALWAYS verify current versions using WebSearch - NEVER trust hardcoded versions +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete architecture +- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 🌐 Use WebSearch to verify current versions and options +- ⚠️ Present A/P/C menu after generating starter template analysis +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` 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 explore unconventional starter options or custom approaches +- **P (Party Mode)**: Bring multiple perspectives to evaluate starter trade-offs for different use cases +- **C (Continue)**: Save the content to the document and proceed to next step + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- Project context from step 2 is available and complete +- Project context file from step-01 may contain technical preferences +- No architectural decisions made yet - evaluating foundations +- Focus on technical preferences discovery and starter evaluation +- Consider project requirements and existing preferences when evaluating options + +## YOUR TASK: + +Discover technical preferences and evaluate starter template options, leveraging existing technical preferences and establishing solid architectural foundations. + +## STARTER EVALUATION SEQUENCE: + +### 0. Check Technical Preferences & Context + +**Check Project Context for Existing Technical Preferences:** +"Before we dive into starter templates, let me check if you have any technical preferences already documented. + +{{if_project_context_exists}} +I found some technical rules in your project context file: +{{extracted_technical_preferences_from_project_context}} + +**Project Context Technical Rules Found:** + +- Languages/Frameworks: {{languages_frameworks_from_context}} +- Tools & Libraries: {{tools_from_context}} +- Development Patterns: {{patterns_from_context}} +- Platform Preferences: {{platforms_from_context}} + +{{else}} +No existing technical preferences found in project context file. We'll establish your technical preferences now. +{{/if_project_context}}" + +**Discover User Technical Preferences:** +"Based on your project context, let's discuss your technical preferences: + +{{primary_technology_category}} Preferences: + +- **Languages**: Do you have preferences between TypeScript/JavaScript, Python, Go, Rust, etc.? +- **Frameworks**: Any existing familiarity or preferences (React, Vue, Angular, Next.js, etc.)? +- **Databases**: Any preferences or existing infrastructure (PostgreSQL, MongoDB, MySQL, etc.)? + +**Development Experience:** + +- What's your team's experience level with different technologies? +- Are there any technologies you want to learn vs. what you're comfortable with? + +**Platform/Deployment Preferences:** + +- Cloud provider preferences (AWS, Vercel, Railway, etc.)? +- Container preferences (Docker, Serverless, Traditional)? + +**Integrations:** + +- Any existing systems or APIs you need to integrate with? +- Third-party services you plan to use (payment, authentication, analytics, etc.)? + +These preferences will help me recommend the most suitable starter templates and guide our architectural decisions." + +### 1. Identify Primary Technology Domain + +Based on project context analysis and technical preferences, identify the primary technology stack: + +- **Web application** → Look for Next.js, Vite, Remix, SvelteKit starters +- **Mobile app** → Look for React Native, Expo, Flutter starters +- **API/Backend** → Look for NestJS, Express, Fastify, Supabase starters +- **CLI tool** → Look for CLI framework starters (oclif, commander, etc.) +- **Full-stack** → Look for T3, RedwoodJS, Blitz, Next.js starters +- **Desktop** → Look for Electron, Tauri starters + +### 2. UX Requirements Consideration + +If UX specification was loaded, consider UX requirements when selecting starter: + +- **Rich animations** → Framer Motion compatible starter +- **Complex forms** → React Hook Form included starter +- **Real-time features** → Socket.io or WebSocket ready starter +- **Design system** → Storybook-enabled starter +- **Offline capability** → Service worker or PWA configured starter + +### 3. Research Current Starter Options + +Use WebSearch to find current, maintained starter templates: + +``` +WebSearch: {{primary_technology}} starter template CLI create command latest 2024 +WebSearch: {{primary_technology}} boilerplate generator latest options 2024 +WebSearch: {{primary_technology}} production-ready starter best practices 2024 +``` + +### 4. Investigate Top Starter Options + +For each promising starter found, investigate details: + +``` +WebSearch: {{starter_name}} default setup technologies included latest +WebSearch: {{starter_name}} project structure file organization +WebSearch: {{starter_name}} production deployment capabilities +WebSearch: {{starter_name}} recent updates maintenance status 2024 +``` + +### 5. Analyze What Each Starter Provides + +For each viable starter option, document: + +**Technology Decisions Made:** + +- Language/TypeScript configuration +- Styling solution (CSS, Tailwind, Styled Components, etc.) +- Testing framework setup +- Linting/Formatting configuration +- Build tooling and optimization +- Project structure and organization + +**Architectural Patterns Established:** + +- Code organization patterns +- Component structure conventions +- API layering approach +- State management setup +- Routing patterns +- Environment configuration + +**Development Experience Features:** + +- Hot reloading and development server +- TypeScript configuration +- Debugging setup +- Testing infrastructure +- Documentation generation + +### 6. Present Starter Options + +Based on user skill level and project needs: + +**For Expert Users:** +"Found {{starter_name}} which provides: +{{quick_decision_list_of_key_decisions}} + +This would establish our base architecture with these technical decisions already made. Use it?" + +**For Intermediate Users:** +"I found {{starter_name}}, which is a well-maintained starter for {{project_type}} projects. + +It makes these architectural decisions for us: +{{decision_list_with_explanations}} + +This gives us a solid foundation following current best practices. Should we use it?" + +**For Beginner Users:** +"I found {{starter_name}}, which is like a pre-built foundation for your project. + +Think of it like buying a prefab house frame instead of cutting each board yourself. + +It makes these decisions for us: +{{friendly_explanation_of_decisions}} + +This is a great starting point that follows best practices and saves us from making dozens of small technical choices. Should we use it?" + +### 7. Get Current CLI Commands + +If user shows interest in a starter, get the exact current commands: + +``` +WebSearch: {{starter_name}} CLI command options flags latest 2024 +WebSearch: {{starter_name}} create new project command examples +``` + +### 8. Generate Starter Template Content + +Prepare the content to append to the document: + +#### Content Structure: + +````markdown +## Starter Template Evaluation + +### Primary Technology Domain + +{{identified_domain}} based on project requirements analysis + +### Starter Options Considered + +{{analysis_of_evaluated_starters}} + +### Selected Starter: {{starter_name}} + +**Rationale for Selection:** +{{why_this_starter_was_chosen}} + +**Initialization Command:** + +```bash +{{full_starter_command_with_options}} +``` +```` + +**Architectural Decisions Provided by Starter:** + +**Language & Runtime:** +{{language_typescript_setup}} + +**Styling Solution:** +{{styling_solution_configuration}} + +**Build Tooling:** +{{build_tools_and_optimization}} + +**Testing Framework:** +{{testing_setup_and_configuration}} + +**Code Organization:** +{{project_structure_and_patterns}} + +**Development Experience:** +{{development_tools_and_workflow}} + +**Note:** Project initialization using this command should be the first implementation story. + +``` + +### 9. Present Content and Menu + +Show the generated content and present choices: + +"I've analyzed starter template options for {{project_type}} projects. + +**Here's what I'll add to the document:** + +[Show the complete markdown content from step 8] + +**What would you like to do?** +[A] Advanced Elicitation - Explore custom approaches or unconventional starters +[P] Party Mode - Evaluate trade-offs from different perspectives +[C] Continue - Save this decision and move to architectural decisions" + +### 10. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with current starter analysis +- Process enhanced insights about starter options or custom approaches +- Ask user: "Accept these changes to the starter template evaluation? (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_folder}/core/workflows/party-mode/workflow.md with starter evaluation context +- Process collaborative insights about starter trade-offs +- Ask user: "Accept these changes to the starter template evaluation? (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 `{output_folder}/architecture.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3]` +- Load `./step-04-decisions.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 8. + +## SUCCESS METRICS: + +✅ Primary technology domain correctly identified from project context +✅ Current, maintained starter templates researched and evaluated +✅ All versions verified using WebSearch, not hardcoded +✅ Architectural implications of starter choice clearly documented +✅ User provided with clear rationale for starter selection +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Not verifying current versions with WebSearch +❌ Ignoring UX requirements when evaluating starters +❌ Not documenting what architectural decisions the starter makes +❌ Failing to consider maintenance status of starter templates +❌ Not providing clear rationale for starter selection +❌ Not presenting A/P/C menu after content generation +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-04-decisions.md` to begin making specific architectural decisions. + +Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved! +``` diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-04-decisions.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-04-decisions.md new file mode 100644 index 00000000..81eca7e0 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-04-decisions.md @@ -0,0 +1,317 @@ +# Step 4: Core Architectural Decisions + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on making critical architectural decisions collaboratively +- 🌐 ALWAYS verify current technology versions using WebSearch +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 🌐 Use WebSearch to verify technology versions and options +- ⚠️ Present A/P/C menu after each major decision category +- 💾 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 for each decision category: + +- **A (Advanced Elicitation)**: Use discovery protocols to explore innovative approaches to specific decisions +- **P (Party Mode)**: Bring multiple perspectives to evaluate decision trade-offs +- **C (Continue)**: Save the current decisions and proceed to next decision category + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- Project context from step 2 is available +- Starter template choice from step 3 is available +- Project context file may contain technical preferences and rules +- Technical preferences discovered in step 3 are available +- Focus on decisions not already made by starter template or existing preferences +- Collaborative decision making, not recommendations + +## YOUR TASK: + +Facilitate collaborative architectural decision making, leveraging existing technical preferences and starter template decisions, focusing on remaining choices critical to the project's success. + +## DECISION MAKING SEQUENCE: + +### 1. Load Decision Framework & Check Existing Preferences + +**Review Technical Preferences from Step 3:** +"Based on our technical preferences discussion in step 3, let's build on those foundations: + +**Your Technical Preferences:** +{{user_technical_preferences_from_step_3}} + +**Starter Template Decisions:** +{{starter_template_decisions}} + +**Project Context Technical Rules:** +{{project_context_technical_rules}}" + +**Identify Remaining Decisions:** +Based on technical preferences, starter template choice, and project context, identify remaining critical decisions: + +**Already Decided (Don't re-decide these):** + +- {{starter_template_decisions}} +- {{user_technology_preferences}} +- {{project_context_technical_rules}} + +**Critical Decisions:** Must be decided before implementation can proceed +**Important Decisions:** Shape the architecture significantly +**Nice-to-Have:** Can be deferred if needed + +### 2. Decision Categories by Priority + +#### Category 1: Data Architecture + +- Database choice (if not determined by starter) +- Data modeling approach +- Data validation strategy +- Migration approach +- Caching strategy + +#### Category 2: Authentication & Security + +- Authentication method +- Authorization patterns +- Security middleware +- Data encryption approach +- API security strategy + +#### Category 3: API & Communication + +- API design patterns (REST, GraphQL, etc.) +- API documentation approach +- Error handling standards +- Rate limiting strategy +- Communication between services + +#### Category 4: Frontend Architecture (if applicable) + +- State management approach +- Component architecture +- Routing strategy +- Performance optimization +- Bundle optimization + +#### Category 5: Infrastructure & Deployment + +- Hosting strategy +- CI/CD pipeline approach +- Environment configuration +- Monitoring and logging +- Scaling strategy + +### 3. Facilitate Each Decision Category + +For each category, facilitate collaborative decision making: + +**Present the Decision:** +Based on user skill level and project context: + +**Expert Mode:** +"{{Decision_Category}}: {{Specific_Decision}} + +Options: {{concise_option_list_with_tradeoffs}} + +What's your preference for this decision?" + +**Intermediate Mode:** +"Next decision: {{Human_Friendly_Category}} + +We need to choose {{Specific_Decision}}. + +Common options: +{{option_list_with_brief_explanations}} + +For your project, I'd lean toward {{recommendation}} because {{reason}}. What are your thoughts?" + +**Beginner Mode:** +"Let's talk about {{Human_Friendly_Category}}. + +{{Educational_Context_About_Why_This_Matters}} + +Think of it like {{real_world_analogy}}. + +Your main options: +{{friendly_options_with_pros_cons}} + +My suggestion: {{recommendation}} +This is good for you because {{beginner_friendly_reason}}. + +What feels right to you?" + +**Verify Technology Versions:** +If decision involves specific technology: + +``` +WebSearch: {{technology}} latest stable version 2024 +WebSearch: {{technology}} current LTS version +WebSearch: {{technology}} production readiness 2024 +``` + +**Get User Input:** +"What's your preference? (or 'explain more' for details)" + +**Handle User Response:** + +- If user wants more info: Provide deeper explanation +- If user has preference: Discuss implications and record decision +- If user wants alternatives: Explore other options + +**Record the Decision:** + +- Category: {{category}} +- Decision: {{user_choice}} +- Version: {{verified_version_if_applicable}} +- Rationale: {{user_reasoning_or_default}} +- Affects: {{components_or_epics}} +- Provided by Starter: {{yes_if_from_starter}} + +### 4. Check for Cascading Implications + +After each major decision, identify related decisions: + +"This choice means we'll also need to decide: + +- {{related_decision_1}} +- {{related_decision_2}}" + +### 5. Generate Decisions Content + +After facilitating all decision categories, prepare the content to append: + +#### Content Structure: + +```markdown +## Core Architectural Decisions + +### Decision Priority Analysis + +**Critical Decisions (Block Implementation):** +{{critical_decisions_made}} + +**Important Decisions (Shape Architecture):** +{{important_decisions_made}} + +**Deferred Decisions (Post-MVP):** +{{decisions_deferred_with_rationale}} + +### Data Architecture + +{{data_related_decisions_with_versions_and_rationale}} + +### Authentication & Security + +{{security_related_decisions_with_versions_and_rationale}} + +### API & Communication Patterns + +{{api_related_decisions_with_versions_and_rationale}} + +### Frontend Architecture + +{{frontend_related_decisions_with_versions_and_rationale}} + +### Infrastructure & Deployment + +{{infrastructure_related_decisions_with_versions_and_rationale}} + +### Decision Impact Analysis + +**Implementation Sequence:** +{{ordered_list_of_decisions_for_implementation}} + +**Cross-Component Dependencies:** +{{how_decisions_affect_each_other}} +``` + +### 6. Present Content and Menu + +Show the generated decisions content and present choices: + +"I've documented all the core architectural decisions we've made together. + +**Here's what I'll add to the document:** + +[Show the complete markdown content from step 5] + +**What would you like to do?** +[A] Advanced Elicitation - Explore innovative approaches to any specific decisions +[P] Party Mode - Review decisions from multiple perspectives +[C] Continue - Save these decisions and move to implementation patterns" + +### 7. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with specific decision categories +- Process enhanced insights about particular decisions +- Ask user: "Accept these enhancements to the architectural 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_folder}/core/workflows/party-mode/workflow.md with architectural decisions context +- Process collaborative insights about decision trade-offs +- Ask user: "Accept these changes to the architectural 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 `{output_folder}/architecture.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` +- Load `./step-05-patterns.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 5. + +## SUCCESS METRICS: + +✅ All critical architectural decisions made collaboratively +✅ Technology versions verified using WebSearch +✅ Decision rationale clearly documented +✅ Cascading implications identified and addressed +✅ User provided appropriate level of explanation for skill level +✅ A/P/C menu presented and handled correctly for each category +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Making recommendations instead of facilitating decisions +❌ Not verifying technology versions with WebSearch +❌ Missing cascading implications between decisions +❌ Not adapting explanations to user skill level +❌ Forgetting to document decisions made by starter template +❌ Not presenting A/P/C menu after content generation + +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-05-patterns.md` to define implementation patterns that ensure consistency across AI agents. + +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/3-solutioning/architecture/steps/step-05-patterns.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-05-patterns.md new file mode 100644 index 00000000..d58c67a6 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-05-patterns.md @@ -0,0 +1,358 @@ +# Step 5: Implementation Patterns & Consistency Rules + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on patterns that prevent AI agent implementation conflicts +- 🎯 EMPHASIZE what agents could decide DIFFERENTLY if not specified +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 🎯 Focus on consistency, not implementation details +- ⚠️ Present A/P/C menu after generating patterns 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 comprehensive consistency patterns +- **P (Party Mode)**: Bring multiple perspectives to identify potential conflict points +- **C (Continue)**: Save the patterns and proceed to project structure + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- Core architectural decisions from step 4 are complete +- Technology stack is decided and versions are verified +- Focus on HOW agents should implement, not WHAT they should implement +- Consider what could vary between different AI agents + +## YOUR TASK: + +Define implementation patterns and consistency rules that ensure multiple AI agents write compatible, consistent code that works together seamlessly. + +## PATTERNS DEFINITION SEQUENCE: + +### 1. Identify Potential Conflict Points + +Based on the chosen technology stack and decisions, identify where AI agents could make different choices: + +**Naming Conflicts:** + +- Database table/column naming conventions +- API endpoint naming patterns +- File and directory naming +- Component/function/variable naming +- Route parameter formats + +**Structural Conflicts:** + +- Where tests are located +- How components are organized +- Where utilities and helpers go +- Configuration file organization +- Static asset organization + +**Format Conflicts:** + +- API response wrapper formats +- Error response structures +- Date/time formats in APIs and UI +- JSON field naming conventions +- API status code usage + +**Communication Conflicts:** + +- Event naming conventions +- Event payload structures +- State update patterns +- Action naming conventions +- Logging formats and levels + +**Process Conflicts:** + +- Loading state handling +- Error recovery patterns +- Retry implementation approaches +- Authentication flow patterns +- Validation timing and methods + +### 2. Facilitate Pattern Decisions + +For each conflict category, facilitate collaborative pattern definition: + +**Present the Conflict Point:** +"Given that we're using {{tech_stack}}, different AI agents might handle {{conflict_area}} differently. + +For example, one agent might name database tables 'users' while another uses 'Users' - this would cause conflicts. + +We need to establish consistent patterns that all agents follow." + +**Show Options and Trade-offs:** +"Common approaches for {{pattern_category}}: + +1. {{option_1}} - {{pros_and_cons}} +2. {{option_2}} - {{pros_and_cons}} +3. {{option_3}} - {{pros_and_cons}} + +Which approach makes the most sense for our project?" + +**Get User Decision:** +"What's your preference for this pattern? (or discuss the trade-offs more)" + +### 3. Define Pattern Categories + +#### Naming Patterns + +**Database Naming:** + +- Table naming: users, Users, or user? +- Column naming: user_id or userId? +- Foreign key format: user_id or fk_user? +- Index naming: idx_users_email or users_email_index? + +**API Naming:** + +- REST endpoint naming: /users or /user? Plural or singular? +- Route parameter format: :id or {id}? +- Query parameter naming: user_id or userId? +- Header naming conventions: X-Custom-Header or Custom-Header? + +**Code Naming:** + +- Component naming: UserCard or user-card? +- File naming: UserCard.tsx or user-card.tsx? +- Function naming: getUserData or get_user_data? +- Variable naming: userId or user_id? + +#### Structure Patterns + +**Project Organization:** + +- Where do tests live? **tests**/ or \*.test.ts co-located? +- How are components organized? By feature or by type? +- Where do shared utilities go? +- How are services and repositories organized? + +**File Structure:** + +- Config file locations and naming +- Static asset organization +- Documentation placement +- Environment file organization + +#### Format Patterns + +**API Formats:** + +- API response wrapper? {data: ..., error: ...} or direct response? +- Error format? {message, code} or {error: {type, detail}}? +- Date format in JSON? ISO strings or timestamps? +- Success response structure? + +**Data Formats:** + +- JSON field naming: snake_case or camelCase? +- Boolean representations: true/false or 1/0? +- Null handling patterns +- Array vs object for single items + +#### Communication Patterns + +**Event Systems:** + +- Event naming convention: user.created or UserCreated? +- Event payload structure standards +- Event versioning approach +- Async event handling patterns + +**State Management:** + +- State update patterns: immutable updates or direct mutation? +- Action naming conventions +- Selector patterns +- State organization principles + +#### Process Patterns + +**Error Handling:** + +- Global error handling approach +- Error boundary patterns +- User-facing error message format +- Logging vs user error distinction + +**Loading States:** + +- Loading state naming conventions +- Global vs local loading states +- Loading state persistence +- Loading UI patterns + +### 4. Generate Patterns Content + +Prepare the content to append to the document: + +#### Content Structure: + +```markdown +## Implementation Patterns & Consistency Rules + +### Pattern Categories Defined + +**Critical Conflict Points Identified:** +{{number_of_potential_conflicts}} areas where AI agents could make different choices + +### Naming Patterns + +**Database Naming Conventions:** +{{database_naming_rules_with_examples}} + +**API Naming Conventions:** +{{api_naming_rules_with_examples}} + +**Code Naming Conventions:** +{{code_naming_rules_with_examples}} + +### Structure Patterns + +**Project Organization:** +{{project_structure_rules_with_examples}} + +**File Structure Patterns:** +{{file_organization_rules_with_examples}} + +### Format Patterns + +**API Response Formats:** +{{api_response_structure_rules}} + +**Data Exchange Formats:** +{{data_format_rules_with_examples}} + +### Communication Patterns + +**Event System Patterns:** +{{event_naming_and_structure_rules}} + +**State Management Patterns:** +{{state_update_and_organization_rules}} + +### Process Patterns + +**Error Handling Patterns:** +{{consistent_error_handling_approaches}} + +**Loading State Patterns:** +{{loading_state_management_rules}} + +### Enforcement Guidelines + +**All AI Agents MUST:** + +- {{mandatory_pattern_1}} +- {{mandatory_pattern_2}} +- {{mandatory_pattern_3}} + +**Pattern Enforcement:** + +- How to verify patterns are followed +- Where to document pattern violations +- Process for updating patterns + +### Pattern Examples + +**Good Examples:** +{{concrete_examples_of_correct_pattern_usage}} + +**Anti-Patterns:** +{{examples_of_what_to_avoid}} +``` + +### 5. Present Content and Menu + +Show the generated patterns content and present choices: + +"I've documented implementation patterns that will prevent conflicts between AI agents working on this project. + +**Here's what I'll add to the document:** + +[Show the complete markdown content from step 4] + +**What would you like to do?** +[A] Advanced Elicitation - Explore additional consistency patterns +[P] Party Mode - Review patterns from different implementation perspectives +[C] Continue - Save these patterns and move to project structure" + +### 6. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with current patterns +- Process enhanced consistency rules that come back +- Ask user: "Accept these additional pattern refinements? (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_folder}/core/workflows/party-mode/workflow.md with implementation patterns context +- Process collaborative insights about potential conflicts +- Ask user: "Accept these changes to the implementation patterns? (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 `{output_folder}/architecture.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]` +- Load `./step-06-structure.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 4. + +## SUCCESS METRICS: + +✅ All potential AI agent conflict points identified and addressed +✅ Comprehensive patterns defined for naming, structure, and communication +✅ Concrete examples provided for each pattern +✅ Enforcement guidelines clearly documented +✅ User collaborated on pattern decisions rather than receiving recommendations +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Missing potential conflict points that could cause agent conflicts +❌ Being too prescriptive about implementation details instead of focusing on consistency +❌ Not providing concrete examples for each pattern +❌ Failing to address cross-cutting concerns like error handling +❌ Not considering the chosen technology stack when defining patterns +❌ Not presenting A/P/C menu after content generation + +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-06-structure.md` to define the complete project structure. + +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/3-solutioning/architecture/steps/step-06-structure.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-06-structure.md new file mode 100644 index 00000000..44315a39 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-06-structure.md @@ -0,0 +1,378 @@ +# Step 6: Project Structure & Boundaries + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on defining complete project structure and clear boundaries +- 🗺️ MAP requirements/epics to architectural components +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 🗺️ Create complete project tree, not generic placeholders +- ⚠️ Present A/P/C menu after generating project structure +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` 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 explore innovative project organization approaches +- **P (Party Mode)**: Bring multiple perspectives to evaluate project structure trade-offs +- **C (Continue)**: Save the project structure and proceed to validation + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- All previous architectural decisions are complete +- Implementation patterns and consistency rules are defined +- Focus on physical project structure and component boundaries +- Map requirements to specific files and directories + +## YOUR TASK: + +Define the complete project structure and architectural boundaries based on all decisions made, creating a concrete implementation guide for AI agents. + +## PROJECT STRUCTURE SEQUENCE: + +### 1. Analyze Requirements Mapping + +Map project requirements to architectural components: + +**From Epics (if available):** +"Epic: {{epic_name}} → Lives in {{module/directory/service}}" + +- User stories within the epic +- Cross-epic dependencies +- Shared components needed + +**From FR Categories (if no epics):** +"FR Category: {{fr_category_name}} → Lives in {{module/directory/service}}" + +- Related functional requirements +- Shared functionality across categories +- Integration points between categories + +### 2. Define Project Directory Structure + +Based on technology stack and patterns, create the complete project structure: + +**Root Configuration Files:** + +- Package management files (package.json, requirements.txt, etc.) +- Build and development configuration +- Environment configuration files +- CI/CD pipeline files +- Documentation files + +**Source Code Organization:** + +- Application entry points +- Core application structure +- Feature/module organization +- Shared utilities and libraries +- Configuration and environment files + +**Test Organization:** + +- Unit test locations and structure +- Integration test organization +- End-to-end test structure +- Test utilities and fixtures + +**Build and Distribution:** + +- Build output directories +- Distribution files +- Static assets +- Documentation build + +### 3. Define Integration Boundaries + +Map how components communicate and where boundaries exist: + +**API Boundaries:** + +- External API endpoints +- Internal service boundaries +- Authentication and authorization boundaries +- Data access layer boundaries + +**Component Boundaries:** + +- Frontend component communication patterns +- State management boundaries +- Service communication patterns +- Event-driven integration points + +**Data Boundaries:** + +- Database schema boundaries +- Data access patterns +- Caching boundaries +- External data integration points + +### 4. Create Complete Project Tree + +Generate a comprehensive directory structure showing all files and directories: + +**Technology-Specific Structure Examples:** + +**Next.js Full-Stack:** + +``` +project-name/ +├── README.md +├── package.json +├── next.config.js +├── tailwind.config.js +├── tsconfig.json +├── .env.local +├── .env.example +├── .gitignore +├── .github/ +│ └── workflows/ +│ └── ci.yml +├── src/ +│ ├── app/ +│ │ ├── globals.css +│ │ ├── layout.tsx +│ │ └── page.tsx +│ ├── components/ +│ │ ├── ui/ +│ │ ├── forms/ +│ │ └── features/ +│ ├── lib/ +│ │ ├── db.ts +│ │ ├── auth.ts +│ │ └── utils.ts +│ ├── types/ +│ └── middleware.ts +├── prisma/ +│ ├── schema.prisma +│ └── migrations/ +├── tests/ +│ ├── __mocks__/ +│ ├── components/ +│ └── e2e/ +└── public/ + └── assets/ +``` + +**API Backend (NestJS):** + +``` +project-name/ +├── package.json +├── nest-cli.json +├── tsconfig.json +├── .env +├── .env.example +├── .gitignore +├── README.md +├── src/ +│ ├── main.ts +│ ├── app.module.ts +│ ├── config/ +│ ├── modules/ +│ │ ├── auth/ +│ │ ├── users/ +│ │ └── common/ +│ ├── services/ +│ ├── repositories/ +│ ├── decorators/ +│ ├── pipes/ +│ ├── guards/ +│ └── interceptors/ +├── test/ +│ ├── unit/ +│ ├── integration/ +│ └── e2e/ +├── prisma/ +│ ├── schema.prisma +│ └── migrations/ +└── docker-compose.yml +``` + +### 5. Map Requirements to Structure + +Create explicit mapping from project requirements to specific files/directories: + +**Epic/Feature Mapping:** +"Epic: User Management + +- Components: src/components/features/users/ +- Services: src/services/users/ +- API Routes: src/app/api/users/ +- Database: prisma/migrations/_*users*_ +- Tests: tests/features/users/" + +**Cross-Cutting Concerns:** +"Authentication System + +- Components: src/components/auth/ +- Services: src/services/auth/ +- Middleware: src/middleware/auth.ts +- Guards: src/guards/auth.guard.ts +- Tests: tests/auth/" + +### 6. Generate Structure Content + +Prepare the content to append to the document: + +#### Content Structure: + +```markdown +## Project Structure & Boundaries + +### Complete Project Directory Structure +``` + +{{complete_project_tree_with_all_files_and_directories}} + +``` + +### Architectural Boundaries + +**API Boundaries:** +{{api_boundary_definitions_and_endpoints}} + +**Component Boundaries:** +{{component_communication_patterns_and_boundaries}} + +**Service Boundaries:** +{{service_integration_patterns_and_boundaries}} + +**Data Boundaries:** +{{data_access_patterns_and_boundaries}} + +### Requirements to Structure Mapping + +**Feature/Epic Mapping:** +{{mapping_of_epics_or_features_to_specific_directories}} + +**Cross-Cutting Concerns:** +{{mapping_of_shared_functionality_to_locations}} + +### Integration Points + +**Internal Communication:** +{{how_components_within_the_project_communicate}} + +**External Integrations:** +{{third_party_service_integration_points}} + +**Data Flow:** +{{how_data_flows_through_the_architecture}} + +### File Organization Patterns + +**Configuration Files:** +{{where_and_how_config_files_are_organized}} + +**Source Organization:** +{{how_source_code_is_structured_and_organized}} + +**Test Organization:** +{{how_tests_are_structured_and_organized}} + +**Asset Organization:** +{{how_static_and_dynamic_assets_are_organized}} + +### Development Workflow Integration + +**Development Server Structure:** +{{how_the_project_is organized_for_development}} + +**Build Process Structure:** +{{how_the_build_process_uses_the_project_structure}} + +**Deployment Structure:** +{{how_the_project_structure_supports_deployment}} +``` + +### 7. Present Content and Menu + +Show the generated project structure content and present choices: + +"I've created a complete project structure based on all our architectural decisions. + +**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 - Explore innovative project organization approaches +[P] Party Mode - Review structure from different development perspectives +[C] Continue - Save this structure and move to architecture validation" + +### 8. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with current project structure +- Process enhanced organizational insights that come back +- Ask user: "Accept these changes to the project structure? (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_folder}/core/workflows/party-mode/workflow.md with project structure context +- Process collaborative insights about organization trade-offs +- Ask user: "Accept these changes to the project structure? (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 `{output_folder}/architecture.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]` +- Load `./step-07-validation.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 6. + +## SUCCESS METRICS: + +✅ Complete project tree defined with all files and directories +✅ All architectural boundaries clearly documented +✅ Requirements/epics mapped to specific locations +✅ Integration points and communication patterns defined +✅ Project structure aligned with chosen technology stack +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Creating generic placeholder structure instead of specific, complete tree +❌ Not mapping requirements to specific files and directories +❌ Missing important integration boundaries +❌ Not considering the chosen technology stack in structure design +❌ Not defining how components communicate across boundaries +❌ Not presenting A/P/C menu after content generation + +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-07-validation.md` to validate architectural coherence and completeness. + +Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-07-validation.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-07-validation.md new file mode 100644 index 00000000..0bdaf868 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-07-validation.md @@ -0,0 +1,358 @@ +# Step 7: Architecture Validation & Completion + +## 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 architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on validating architectural coherence and completeness +- ✅ VALIDATE all requirements are covered by architectural decisions +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- ✅ Run comprehensive validation checks on the complete architecture +- ⚠️ Present A/P/C menu after generating validation results +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` 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 address complex architectural issues found during validation +- **P (Party Mode)**: Bring multiple perspectives to resolve validation concerns +- **C (Continue)**: Save the validation results and complete the architecture + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/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: + +- Complete architecture document with all sections is available +- All architectural decisions, patterns, and structure are defined +- Focus on validation, gap analysis, and coherence checking +- Prepare for handoff to implementation phase + +## YOUR TASK: + +Validate the complete architecture for coherence, completeness, and readiness to guide AI agents through consistent implementation. + +## VALIDATION SEQUENCE: + +### 1. Coherence Validation + +Check that all architectural decisions work together: + +**Decision Compatibility:** + +- Do all technology choices work together without conflicts? +- Are all versions compatible with each other? +- Do patterns align with technology choices? +- Are there any contradictory decisions? + +**Pattern Consistency:** + +- Do implementation patterns support the architectural decisions? +- Are naming conventions consistent across all areas? +- Do structure patterns align with technology stack? +- Are communication patterns coherent? + +**Structure Alignment:** + +- Does the project structure support all architectural decisions? +- Are boundaries properly defined and respected? +- Does the structure enable the chosen patterns? +- Are integration points properly structured? + +### 2. Requirements Coverage Validation + +Verify all project requirements are architecturally supported: + +**From Epics (if available):** + +- Does every epic have architectural support? +- Are all user stories implementable with these decisions? +- Are cross-epic dependencies handled architecturally? +- Are there any gaps in epic coverage? + +**From FR Categories (if no epics):** + +- Does every functional requirement have architectural support? +- Are all FR categories fully covered by architectural decisions? +- Are cross-cutting FRs properly addressed? +- Are there any missing architectural capabilities? + +**Non-Functional Requirements:** + +- Are performance requirements addressed architecturally? +- Are security requirements fully covered? +- Are scalability considerations properly handled? +- Are compliance requirements architecturally supported? + +### 3. Implementation Readiness Validation + +Assess if AI agents can implement consistently: + +**Decision Completeness:** + +- Are all critical decisions documented with versions? +- Are implementation patterns comprehensive enough? +- Are consistency rules clear and enforceable? +- Are examples provided for all major patterns? + +**Structure Completeness:** + +- Is the project structure complete and specific? +- Are all files and directories defined? +- Are integration points clearly specified? +- Are component boundaries well-defined? + +**Pattern Completeness:** + +- Are all potential conflict points addressed? +- Are naming conventions comprehensive? +- Are communication patterns fully specified? +- Are process patterns (error handling, etc.) complete? + +### 4. Gap Analysis + +Identify and document any missing elements: + +**Critical Gaps:** + +- Missing architectural decisions that block implementation +- Incomplete patterns that could cause conflicts +- Missing structural elements needed for development +- Undefined integration points + +**Important Gaps:** + +- Areas that need more detailed specification +- Patterns that could be more comprehensive +- Documentation that would help implementation +- Examples that would clarify complex decisions + +**Nice-to-Have Gaps:** + +- Additional patterns that would be helpful +- Supplementary documentation +- Tooling recommendations +- Development workflow optimizations + +### 5. Address Validation Issues + +For any issues found, facilitate resolution: + +**Critical Issues:** +"I found some issues that need to be addressed before implementation: + +{{critical_issue_description}} + +These could cause implementation problems. How would you like to resolve this?" + +**Important Issues:** +"I noticed a few areas that could be improved: + +{{important_issue_description}} + +These aren't blocking, but addressing them would make implementation smoother. Should we work on these?" + +**Minor Issues:** +"Here are some minor suggestions for improvement: + +{{minor_issue_description}} + +These are optional refinements. Would you like to address any of these?" + +### 6. Generate Validation Content + +Prepare the content to append to the document: + +#### Content Structure: + +```markdown +## Architecture Validation Results + +### Coherence Validation ✅ + +**Decision Compatibility:** +{{assessment_of_how_all_decisions_work_together}} + +**Pattern Consistency:** +{{verification_that_patterns_support_decisions}} + +**Structure Alignment:** +{{confirmation_that_structure_supports_architecture}} + +### Requirements Coverage Validation ✅ + +**Epic/Feature Coverage:** +{{verification_that_all_epics_or_features_are_supported}} + +**Functional Requirements Coverage:** +{{confirmation_that_all_FRs_are_architecturally_supported}} + +**Non-Functional Requirements Coverage:** +{{verification_that_NFRs_are_addressed}} + +### Implementation Readiness Validation ✅ + +**Decision Completeness:** +{{assessment_of_decision_documentation_completeness}} + +**Structure Completeness:** +{{evaluation_of_project_structure_completeness}} + +**Pattern Completeness:** +{{verification_of_implementation_patterns_completeness}} + +### Gap Analysis Results + +{{gap_analysis_findings_with_priority_levels}} + +### Validation Issues Addressed + +{{description_of_any_issues_found_and_resolutions}} + +### Architecture Completeness Checklist + +**✅ Requirements Analysis** + +- [x] Project context thoroughly analyzed +- [x] Scale and complexity assessed +- [x] Technical constraints identified +- [x] Cross-cutting concerns mapped + +**✅ Architectural Decisions** + +- [x] Critical decisions documented with versions +- [x] Technology stack fully specified +- [x] Integration patterns defined +- [x] Performance considerations addressed + +**✅ Implementation Patterns** + +- [x] Naming conventions established +- [x] Structure patterns defined +- [x] Communication patterns specified +- [x] Process patterns documented + +**✅ Project Structure** + +- [x] Complete directory structure defined +- [x] Component boundaries established +- [x] Integration points mapped +- [x] Requirements to structure mapping complete + +### Architecture Readiness Assessment + +**Overall Status:** READY FOR IMPLEMENTATION + +**Confidence Level:** {{high/medium/low}} based on validation results + +**Key Strengths:** +{{list_of_architecture_strengths}} + +**Areas for Future Enhancement:** +{{areas_that_could_be_improved_later}} + +### Implementation Handoff + +**AI Agent Guidelines:** + +- Follow all architectural decisions exactly as documented +- Use implementation patterns consistently across all components +- Respect project structure and boundaries +- Refer to this document for all architectural questions + +**First Implementation Priority:** +{{starter_template_command_or_first_architectural_step}} +``` + +### 7. Present Content and Menu + +Show the validation results and present choices: + +"I've completed a comprehensive validation of your architecture. + +**Validation Summary:** + +- ✅ Coherence: All decisions work together +- ✅ Coverage: All requirements are supported +- ✅ Readiness: AI agents can implement consistently + +**Here's what I'll add to complete the architecture document:** + +[Show the complete markdown content from step 6] + +**What would you like to do?** +[A] Advanced Elicitation - Address any complex architectural concerns +[P] Party Mode - Review validation from different implementation perspectives +[C] Continue - Complete the architecture and finish workflow" + +### 8. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml with validation issues +- Process enhanced solutions for complex concerns +- Ask user: "Accept these architectural improvements? (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_folder}/core/workflows/party-mode/workflow.md with validation context +- Process collaborative insights on implementation readiness +- Ask user: "Accept these changes to the validation results? (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 `{output_folder}/architecture.md` +- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` +- Load `./step-08-complete.md` + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 6. + +## SUCCESS METRICS: + +✅ All architectural decisions validated for coherence +✅ Complete requirements coverage verified +✅ Implementation readiness confirmed +✅ All gaps identified and addressed +✅ Comprehensive validation checklist completed +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Skipping validation of decision compatibility +❌ Not verifying all requirements are architecturally supported +❌ Missing potential implementation conflicts +❌ Not addressing gaps found during validation +❌ Providing incomplete validation checklist +❌ Not presenting A/P/C menu after content generation + +❌ **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 + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-08-complete.md` to complete the workflow and provide implementation guidance. + +Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-08-complete.md b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-08-complete.md new file mode 100644 index 00000000..703b2573 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-08-complete.md @@ -0,0 +1,351 @@ +# Step 8: Architecture Completion & Handoff + +## 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 completion between architectural peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on successful workflow completion and implementation handoff +- 🎯 PROVIDE clear next steps for implementation phase +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 🎯 Present completion summary and implementation guidance +- 📖 Update frontmatter with final workflow state +- 🚫 NO MORE STEPS - this is the final step + +## CONTEXT BOUNDARIES: + +- Complete architecture document is finished and validated +- All architectural decisions, patterns, and structure are documented +- Focus on successful completion and implementation preparation +- Provide clear guidance for next steps in the development process + +## YOUR TASK: + +Complete the architecture workflow, provide a comprehensive completion summary, and guide the user to the next phase of their project development. + +## COMPLETION SEQUENCE: + +### 1. Present Architecture Completion Summary + +Based on user skill level, present the completion: + +**For Expert Users:** +"Architecture workflow complete. {{decision_count}} architectural decisions documented across {{step_count}} steps. + +Your architecture is ready for AI agent implementation. All decisions are documented with specific versions and implementation patterns. + +Key deliverables: + +- Complete architecture decision document +- Implementation patterns for agent consistency +- Project structure with all files and directories +- Validation confirming coherence and completeness + +Ready for implementation phase." + +**For Intermediate Users:** +"Excellent! Your architecture for {{project_name}} is now complete and ready for implementation. + +**What we accomplished:** + +- Made {{decision_count}} key architectural decisions together +- Established implementation patterns to ensure consistency +- Created a complete project structure with {{component_count}} main areas +- Validated that all your requirements are fully supported + +**Your architecture document includes:** + +- Technology choices with specific versions +- Clear implementation patterns for AI agents to follow +- Complete project directory structure +- Mapping of your requirements to specific files and folders + +The architecture is comprehensive and ready to guide consistent implementation." + +**For Beginner Users:** +"Congratulations! Your architecture for {{project_name}} is complete! 🎉 + +**What this means:** +Think of this as creating the complete blueprint for your house. We've made all the important decisions about how it will be built, what materials to use, and how everything fits together. + +**What we created together:** + +- {{decision_count}} architectural decisions (like choosing the foundation, framing, and systems) +- Clear rules so that multiple builders (AI agents) all work the same way +- A complete folder structure showing exactly where every file goes +- Confirmation that everything you want to build is supported by these decisions + +**What happens next:** +AI agents will read this architecture document before building anything. They'll follow all your decisions exactly, which means your app will be built with consistent patterns throughout. + +You're ready for the implementation phase!" + +### 2. Review Final Document State + +Confirm the architecture document is complete: + +**Document Structure Verification:** + +- Project Context Analysis ✅ +- Starter Template Evaluation ✅ +- Core Architectural Decisions ✅ +- Implementation Patterns & Consistency Rules ✅ +- Project Structure & Boundaries ✅ +- Architecture Validation Results ✅ + +**Frontmatter Update:** + +```yaml +stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8] +workflowType: 'architecture' +lastStep: 8 +status: 'complete' +completedAt: '{{current_date}}' +``` + +### 3. Implementation Guidance + +Provide specific next steps for implementation: + +**Immediate Next Steps:** + +1. **Review the complete architecture document** at `{output_folder}/architecture.md` +2. **Begin with project initialization** using the starter template command documented +3. **Create first implementation story** for project setup +4. **Start implementing user stories** following the architectural decisions + +**Development Workflow:** +"AI agents will: + +1. Read the architecture document before implementing each story +2. Follow your technology choices and patterns exactly +3. Use the project structure we defined +4. Maintain consistency across all components" + +**Quality Assurance:** +"Your architecture includes: + +- Specific technology versions to use +- Implementation patterns that prevent conflicts +- Clear project structure and boundaries +- Validation that all requirements are supported" + +### 4. Generate Completion Content + +Prepare the final content to append to the document: + +#### Content Structure: + +```markdown +## Architecture Completion Summary + +### Workflow Completion + +**Architecture Decision Workflow:** COMPLETED ✅ +**Total Steps Completed:** 8 +**Date Completed:** {{current_date}} +**Document Location:** {output_folder}/architecture.md + +### Final Architecture Deliverables + +**📋 Complete Architecture Document** + +- All architectural decisions documented with specific versions +- Implementation patterns ensuring AI agent consistency +- Complete project structure with all files and directories +- Requirements to architecture mapping +- Validation confirming coherence and completeness + +**🏗️ Implementation Ready Foundation** + +- {{decision_count}} architectural decisions made +- {{pattern_count}} implementation patterns defined +- {{component_count}} architectural components specified +- {{requirement_count}} requirements fully supported + +**📚 AI Agent Implementation Guide** + +- Technology stack with verified versions +- Consistency rules that prevent implementation conflicts +- Project structure with clear boundaries +- Integration patterns and communication standards + +### Implementation Handoff + +**For AI Agents:** +This architecture document is your complete guide for implementing {{project_name}}. Follow all decisions, patterns, and structures exactly as documented. + +**First Implementation Priority:** +{{starter_template_command_or_initialization_step}} + +**Development Sequence:** + +1. Initialize project using documented starter template +2. Set up development environment per architecture +3. Implement core architectural foundations +4. Build features following established patterns +5. Maintain consistency with documented rules + +### Quality Assurance Checklist + +**✅ Architecture Coherence** + +- [x] All decisions work together without conflicts +- [x] Technology choices are compatible +- [x] Patterns support the architectural decisions +- [x] Structure aligns with all choices + +**✅ Requirements Coverage** + +- [x] All functional requirements are supported +- [x] All non-functional requirements are addressed +- [x] Cross-cutting concerns are handled +- [x] Integration points are defined + +**✅ Implementation Readiness** + +- [x] Decisions are specific and actionable +- [x] Patterns prevent agent conflicts +- [x] Structure is complete and unambiguous +- [x] Examples are provided for clarity + +### Project Success Factors + +**🎯 Clear Decision Framework** +Every technology choice was made collaboratively with clear rationale, ensuring all stakeholders understand the architectural direction. + +**🔧 Consistency Guarantee** +Implementation patterns and rules ensure that multiple AI agents will produce compatible, consistent code that works together seamlessly. + +**📋 Complete Coverage** +All project requirements are architecturally supported, with clear mapping from business needs to technical implementation. + +**🏗️ Solid Foundation** +The chosen starter template and architectural patterns provide a production-ready foundation following current best practices. + +--- + +**Architecture Status:** READY FOR IMPLEMENTATION ✅ + +**Next Phase:** Begin implementation using the architectural decisions and patterns documented herein. + +**Document Maintenance:** Update this architecture when major technical decisions are made during implementation. +``` + +### 5. Complete Workflow Finalization + +**Save Final Document:** + +- Ensure all content is properly appended to `{output_folder}/architecture.md` +- Update frontmatter with completion status +- Verify document is complete and coherent + +**Workflow Status Update:** +If not in standalone mode, update workflow status: + +- Load `{output_folder}/bmm-workflow-status.yaml` +- Update workflow_status["create-architecture"] = "{output_folder}/architecture.md" +- Save file with all structure and comments preserved + +### 6. Present Completion to User + +"🎉 **Architecture Workflow Complete!** + +Your architecture for {{project_name}} is comprehensive, validated, and ready for implementation. + +**✅ What's been delivered:** + +- Complete architecture document with all decisions and patterns +- Project structure ready for AI agent implementation +- Validation confirming everything works together coherently +- Implementation guidance for the development phase + +**📍 Where to find it:** +`{output_folder}/architecture.md` + +**🚀 What's next:** + +1. Review your complete architecture document +2. Begin implementation using the starter template command +3. Create stories for AI agents to implement following your architectural decisions + +Your architecture will ensure consistent, high-quality implementation across all development work. Great job collaborating through these important architectural decisions! + +**💡 Optional Enhancement: Project Context File** + +Would you like to create a `project_context.md` file? This is a concise, optimized guide for AI agents that captures: + +- Critical language and framework rules they might miss +- Specific patterns and conventions for your project +- Testing and code quality requirements +- Anti-patterns and edge cases to avoid + +{if_existing_project_context} +I noticed you already have a project context file. Would you like to update it with your new architectural decisions? +{else} +This file helps ensure AI agents implement code consistently with your project's unique requirements and patterns. +{/if_existing_project_context} + +**Create/Update project context?** [Y/N] + +**Ready to move to the next phase of your project development?**" + +### 7. Handle Project Context Creation Choice + +If user responds 'Y' or 'yes' to creating/updating project context: + +"Excellent choice! Let me launch the Generate Project Context workflow to create a comprehensive guide for AI agents. + +This will help ensure consistent implementation by capturing: + +- Language-specific patterns and rules +- Framework conventions from your architecture +- Testing and quality standards +- Anti-patterns to avoid + +The workflow will collaborate with you to create an optimized `project_context.md` file that AI agents will read before implementing any code." + +**Execute the Generate Project Context workflow:** + +- Load and execute: `{project-root}/{bmad_folder}/bmm/workflows/generate-project-context/workflow.md` +- The workflow will handle discovery, generation, and completion of the project context file +- After completion, return here for final handoff + +If user responds 'N' or 'no': +"Understood! Your architecture is complete and ready for implementation. You can always create a project context file later using the Generate Project Context workflow if needed." + +## SUCCESS METRICS: + +✅ Complete architecture document delivered with all sections +✅ All architectural decisions documented and validated +✅ Implementation patterns and consistency rules finalized +✅ Project structure complete with all files and directories +✅ User provided with clear next steps and implementation guidance +✅ Workflow status properly updated +✅ User collaboration maintained throughout completion process + +## FAILURE MODES: + +❌ Not providing clear implementation guidance +❌ Missing final validation of document completeness +❌ Not updating workflow status appropriately +❌ Failing to celebrate the successful completion +❌ Not providing specific next steps for the user +❌ Rushing completion without proper summary + +❌ **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 COMPLETE: + +This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation. + +The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle. diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/workflow.md b/src/modules/bmm/workflows/3-solutioning/architecture/workflow.md new file mode 100644 index 00000000..b59b48e2 --- /dev/null +++ b/src/modules/bmm/workflows/3-solutioning/architecture/workflow.md @@ -0,0 +1,48 @@ +--- +name: Architecture Workflow +description: Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts. +--- + +# Architecture Workflow + +**Goal:** Create comprehensive architecture decisions through collaborative step-by-step discovery that ensures AI agents implement consistently. + +**Your Role:** You are an architectural facilitator collaborating with a peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and architectural knowledge, while the user brings domain expertise and product vision. Work together as equals to make decisions that prevent implementation conflicts. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **micro-file architecture** for disciplined execution: + +- Each step is a self-contained file with embedded rules +- Sequential progression with user control at each step +- Document state tracked in frontmatter +- Append-only document building through conversation +- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation. + +--- + +## INITIALIZATION + +### Configuration Loading + +Load config from `{project-root}/{bmad_folder}/bmm/config.yaml` and resolve: + +- `project_name`, `output_folder`, `user_name` +- `communication_language`, `document_output_language`, `user_skill_level` +- `date` as system-generated current datetime + +### Paths + +- `installed_path` = `{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture` +- `template_path` = `{installed_path}/architecture-decision-template.md` +- `data_files_path` = `{installed_path}/data/` + +--- + +## EXECUTION + +Load and execute `steps/step-01-init.md` to begin the workflow. + +**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md. diff --git a/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml b/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml deleted file mode 100644 index 21e49033..00000000 --- a/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml +++ /dev/null @@ -1,114 +0,0 @@ -# Architecture Workflow Configuration -name: architecture -description: "Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts." -author: "BMad" - -# Critical variables -config_source: "{project-root}/{bmad_folder}/bmm/config.yaml" -output_folder: "{config_source}:output_folder" -user_name: "{config_source}:user_name" -communication_language: "{config_source}:communication_language" -document_output_language: "{config_source}:document_output_language" -user_skill_level: "{config_source}:user_skill_level" -date: system-generated - -# Smart input file references - handles both whole docs and sharded docs -# Priority: Analysis folder first, then main folder, then sharded version -# Strategy: How to load sharded documents (FULL_LOAD, SELECTIVE_LOAD, INDEX_GUIDED) -input_file_patterns: - prd: - description: "Product requirements and features" - whole: ["{output_folder}/analysis/*prd*.md", "{output_folder}/*prd*.md"] - sharded: ["{output_folder}/*prd*/index.md"] - load_strategy: "FULL_LOAD" - epics: - description: "Epic and story breakdown (optional - uses PRD FRs if not present)" - whole: ["{output_folder}/analysis/*epic*.md", "{output_folder}/*epic*.md"] - sharded: ["{output_folder}/*epic*/index.md"] - load_strategy: "FULL_LOAD" - ux_design: - description: "UX design specification (optional)" - whole: ["{output_folder}/analysis/*ux*.md", "{output_folder}/*ux*.md"] - sharded: ["{output_folder}/*ux*/index.md"] - load_strategy: "FULL_LOAD" - product_brief: - description: "Product brief and brainstorming results (optional)" - whole: ["{output_folder}/analysis/*brief*.md", "{output_folder}/*brief*.md"] - sharded: ["{output_folder}/*brief*/index.md"] - load_strategy: "FULL_LOAD" - research: - description: "Research documents (optional)" - whole: ["{output_folder}/analysis/research/*research*.md", "{output_folder}/*research*.md"] - sharded: ["{output_folder}/*research*/index.md"] - load_strategy: "FULL_LOAD" - brainstorming: - description: "Brainstorming session results (optional)" - whole: ["{output_folder}/analysis/brainstorming/*brainstorming*.md", "{output_folder}/*brainstorming*.md"] - load_strategy: "FULL_LOAD" - document_project: - description: "Brownfield project documentation (optional)" - sharded: ["{output_folder}/index.md"] - load_strategy: "INDEX_GUIDED" - -# Module path and component files -installed_path: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture" -instructions: "{installed_path}/instructions.md" -validation: "{installed_path}/checklist.md" -template: "{installed_path}/architecture-template.md" - -# Knowledge bases for intelligent decision making -decision_catalog: "{installed_path}/decision-catalog.yaml" -architecture_patterns: "{installed_path}/architecture-patterns.yaml" -pattern_categories: "{installed_path}/pattern-categories.csv" - -# Output configuration -default_output_file: "{output_folder}/architecture.md" - -standalone: true - -# Web bundle configuration for standalone deployment -web_bundle: - name: "architecture" - description: "Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts." - author: "BMad" - - # Core workflow files ({bmad_folder}/-relative paths) - instructions: "{bmad_folder}/bmm/workflows/3-solutioning/architecture/instructions.md" - validation: "{bmad_folder}/bmm/workflows/3-solutioning/architecture/checklist.md" - template: "{bmad_folder}/bmm/workflows/3-solutioning/architecture/architecture-template.md" - - # Knowledge base files for decision making - decision_catalog: "{bmad_folder}/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml" - architecture_patterns: "{bmad_folder}/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml" - pattern_categories: "{bmad_folder}/bmm/workflows/3-solutioning/architecture/pattern-categories.csv" - - # Task dependencies - adv_elicit_task: "{bmad_folder}/core/tasks/advanced-elicitation.xml" - - # Default configuration values (can be overridden during bundle setup) - defaults: - user_name: "User" - communication_language: "English" - document_output_language: "English" - user_skill_level: "intermediate" - output_folder: "./output" - - # Input/output configuration for web deployment - default_output_file: "{output_folder}/architecture.md" - - # Complete file list - ALL files this workflow depends on - web_bundle_files: - # Core workflow files - - "{bmad_folder}/bmm/workflows/3-solutioning/architecture/instructions.md" - - "{bmad_folder}/bmm/workflows/3-solutioning/architecture/checklist.md" - - "{bmad_folder}/bmm/workflows/3-solutioning/architecture/architecture-template.md" - - # Knowledge base data files - - "{bmad_folder}/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml" - - "{bmad_folder}/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml" - - "{bmad_folder}/bmm/workflows/3-solutioning/architecture/pattern-categories.csv" - - # Task dependencies (referenced in instructions.md) - - "{bmad_folder}/core/tasks/workflow.xml" - - "{bmad_folder}/core/tasks/advanced-elicitation.xml" - - "{bmad_folder}/core/tasks/advanced-elicitation-methods.csv" diff --git a/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml b/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml index dc2d0c6e..25abf76d 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml +++ b/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml @@ -19,7 +19,7 @@ instructions: "{installed_path}/instructions.md" # Related workflows quick_dev_workflow: "{project-root}/{bmad_folder}/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml" -party_mode_workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" +party_mode_exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" advanced_elicitation: "{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml" standalone: true diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml index 9876172e..3f9ca77e 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml @@ -22,7 +22,7 @@ checklist: "{installed_path}/checklist.md" # Related workflows create_tech_spec_workflow: "{project-root}/{bmad_folder}/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml" -party_mode_workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" +party_mode_exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" advanced_elicitation: "{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml" standalone: true diff --git a/src/modules/bmm/workflows/generate-project-context/project-context-template.md b/src/modules/bmm/workflows/generate-project-context/project-context-template.md new file mode 100644 index 00000000..6b019779 --- /dev/null +++ b/src/modules/bmm/workflows/generate-project-context/project-context-template.md @@ -0,0 +1,20 @@ +--- +project_name: '{{project_name}}' +user_name: '{{user_name}}' +date: '{{date}}' +sections_completed: [] +--- + +# Project Context for AI Agents + +_This file contains critical rules and patterns that AI agents must follow when implementing code in this project. Focus on unobvious details that agents might otherwise miss._ + +--- + +## Technology Stack & Versions + +_Documented after discovery phase_ + +## Critical Implementation Rules + +_Documented after discovery phase_ diff --git a/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md b/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md new file mode 100644 index 00000000..eb5ca831 --- /dev/null +++ b/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md @@ -0,0 +1,193 @@ +# Step 1: Context Discovery & Initialization + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without user input +- ✅ ALWAYS treat this as collaborative discovery between technical peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on discovering existing project context and technology stack +- 🎯 IDENTIFY critical implementation rules that AI agents need +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 📖 Read existing project files to understand current context +- 💾 Initialize document and update frontmatter +- 🚫 FORBIDDEN to load next step until discovery is complete + +## CONTEXT BOUNDARIES: + +- Variables from workflow.md are available in memory +- Focus on existing project files and architecture decisions +- Look for patterns, conventions, and unique requirements +- Prioritize rules that prevent implementation mistakes + +## YOUR TASK: + +Discover the project's technology stack, existing patterns, and critical implementation rules that AI agents must follow when writing code. + +## DISCOVERY SEQUENCE: + +### 1. Check for Existing Project Context + +First, check if project context already exists: + +- Look for file at `{output_folder}/project_context.md` +- If exists: Read complete file to understand existing rules +- Present to user: "Found existing project context with {number_of_sections} sections. Would you like to update this or create a new one?" + +### 2. Discover Project Technology Stack + +Load and analyze project files to identify technologies: + +**Architecture Document:** + +- Look for `{output_folder}/architecture.md` +- Extract technology choices with specific versions +- Note architectural decisions that affect implementation + +**Package Files:** + +- Check for `package.json`, `requirements.txt`, `Cargo.toml`, etc. +- Extract exact versions of all dependencies +- Note development vs production dependencies + +**Configuration Files:** + +- Look for TypeScript config (`tsconfig.json`) +- Build tool configs (webpack, vite, next.config.js, etc.) +- Linting and formatting configs (.eslintrc, .prettierrc, etc.) +- Testing configurations (jest.config.js, vitest.config.ts, etc.) + +### 3. Identify Existing Code Patterns + +Search through existing codebase for patterns: + +**Naming Conventions:** + +- File naming patterns (PascalCase, kebab-case, etc.) +- Component/function naming conventions +- Variable naming patterns +- Test file naming patterns + +**Code Organization:** + +- How components are structured +- Where utilities and helpers are placed +- How services are organized +- Test organization patterns + +**Documentation Patterns:** + +- Comment styles and conventions +- Documentation requirements +- README and API doc patterns + +### 4. Extract Critical Implementation Rules + +Look for rules that AI agents might miss: + +**Language-Specific Rules:** + +- TypeScript strict mode requirements +- Import/export conventions +- Async/await vs Promise usage patterns +- Error handling patterns specific to the language + +**Framework-Specific Rules:** + +- React hooks usage patterns +- API route conventions +- Middleware usage patterns +- State management patterns + +**Testing Rules:** + +- Test structure requirements +- Mock usage conventions +- Integration vs unit test boundaries +- Coverage requirements + +**Development Workflow Rules:** + +- Branch naming conventions +- Commit message patterns +- PR review requirements +- Deployment procedures + +### 5. Initialize Project Context Document + +Based on discovery, create or update the context document: + +#### A. Fresh Document Setup (if no existing context) + +Copy template from `{installed_path}/project-context-template.md` to `{output_folder}/project_context.md` +Initialize frontmatter with: + +```yaml +--- +project_name: '{{project_name}}' +user_name: '{{user_name}}' +date: '{{date}}' +sections_completed: ['technology_stack'] +existing_patterns_found: { { number_of_patterns_discovered } } +--- +``` + +#### B. Existing Document Update + +Load existing context and prepare for updates +Set frontmatter `sections_completed` to track what will be updated + +### 6. Present Discovery Summary + +Report findings to user: + +"Welcome {{user_name}}! I've analyzed your project for {{project_name}} to discover the context that AI agents need. + +**Technology Stack Discovered:** +{{list_of_technologies_with_versions}} + +**Existing Patterns Found:** + +- {{number_of_patterns}} implementation patterns +- {{number_of_conventions}} coding conventions +- {{number_of_rules}} critical rules + +**Key Areas for Context Rules:** + +- {{area_1}} (e.g., TypeScript configuration) +- {{area_2}} (e.g., Testing patterns) +- {{area_3}} (e.g., Code organization) + +{if_existing_context} +**Existing Context:** Found {{sections}} sections already defined. We can update or add to these. +{/if_existing_context} + +Ready to create/update your project context. This will help AI agents implement code consistently with your project's standards. + +[C] Continue to context generation" + +## SUCCESS METRICS: + +✅ Existing project context properly detected and handled +✅ Technology stack accurately identified with versions +✅ Critical implementation patterns discovered +✅ Project context document properly initialized +✅ Discovery findings clearly presented to user +✅ User ready to proceed with context generation + +## FAILURE MODES: + +❌ Not checking for existing project context before creating new one +❌ Missing critical technology versions or configurations +❌ Overlooking important coding patterns or conventions +❌ Not initializing frontmatter properly +❌ Not presenting clear discovery summary to user + +## NEXT STEP: + +After user selects [C] to continue, load `./step-02-generate.md` to collaboratively generate the specific project context rules. + +Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and discovery is confirmed! diff --git a/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md b/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md new file mode 100644 index 00000000..84439c17 --- /dev/null +++ b/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md @@ -0,0 +1,317 @@ +# Step 2: Context Rules Generation + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without user input +- ✅ ALWAYS treat this as collaborative discovery between technical peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on unobvious rules that AI agents need to be reminded of +- 🎯 KEEP CONTENT LEAN - optimize for LLM context efficiency +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 📝 Focus on specific, actionable rules rather than general advice +- ⚠️ Present A/P/C menu after each major rule category +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update frontmatter with completed sections +- 🚫 FORBIDDEN to load next step until all sections are complete + +## COLLABORATION MENUS (A/P/C): + +This step will generate content and present choices for each rule category: + +- **A (Advanced Elicitation)**: Use discovery protocols to explore nuanced implementation rules +- **P (Party Mode)**: Bring multiple perspectives to identify critical edge cases +- **C (Continue)**: Save the current rules and proceed to next category + +## PROTOCOL INTEGRATION: + +- When 'A' selected: Execute {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml +- When 'P' selected: Execute {project-root}/{bmad_folder}/core/workflows/party-mode +- 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: + +- Discovery results from step-1 are available +- Technology stack and existing patterns are identified +- Focus on rules that prevent implementation mistakes +- Prioritize unobvious details that AI agents might miss + +## YOUR TASK: + +Collaboratively generate specific, critical rules that AI agents must follow when implementing code in this project. + +## CONTEXT GENERATION SEQUENCE: + +### 1. Technology Stack & Versions + +Document the exact technology stack from discovery: + +**Core Technologies:** +Based on user skill level, present findings: + +**Expert Mode:** +"Technology stack from your architecture and package files: +{{exact_technologies_with_versions}} + +Any critical version constraints I should document for agents?" + +**Intermediate Mode:** +"I found your technology stack: + +**Core Technologies:** +{{main_technologies_with_versions}} + +**Key Dependencies:** +{{important_dependencies_with_versions}} + +Are there any version constraints or compatibility notes agents should know about?" + +**Beginner Mode:** +"Here are the technologies you're using: + +**Main Technologies:** +{{friendly_description_of_tech_stack}} + +**Important Notes:** +{{key_things_agents_need_to_know_about_versions}} + +Should I document any special version rules or compatibility requirements?" + +### 2. Language-Specific Rules + +Focus on unobvious language patterns agents might miss: + +**TypeScript/JavaScript Rules:** +"Based on your codebase, I notice some specific patterns: + +**Configuration Requirements:** +{{typescript_config_rules}} + +**Import/Export Patterns:** +{{import_export_conventions}} + +**Error Handling Patterns:** +{{error_handling_requirements}} + +Are these patterns correct? Any other language-specific rules agents should follow?" + +**Python/Ruby/Other Language Rules:** +Adapt to the actual language in use with similar focused questions. + +### 3. Framework-Specific Rules + +Document framework-specific patterns: + +**React Rules (if applicable):** +"For React development, I see these patterns: + +**Hooks Usage:** +{{hooks_usage_patterns}} + +**Component Structure:** +{{component_organization_rules}} + +**State Management:** +{{state_management_patterns}} + +**Performance Rules:** +{{performance_optimization_requirements}} + +Should I add any other React-specific rules?" + +**Other Framework Rules:** +Adapt for Vue, Angular, Next.js, Express, etc. + +### 4. Testing Rules + +Focus on testing patterns that ensure consistency: + +**Test Structure Rules:** +"Your testing setup shows these patterns: + +**Test Organization:** +{{test_file_organization}} + +**Mock Usage:** +{{mock_patterns_and_conventions}} + +**Test Coverage Requirements:** +{{coverage_expectations}} + +**Integration vs Unit Test Rules:** +{{test_boundary_patterns}} + +Are there testing rules agents should always follow?" + +### 5. Code Quality & Style Rules + +Document critical style and quality rules: + +**Linting/Formatting:** +"Your code style configuration requires: + +**ESLint/Prettier Rules:** +{{specific_linting_rules}} + +**Code Organization:** +{{file_and_folder_structure_rules}} + +**Naming Conventions:** +{{naming_patterns_agents_must_follow}} + +**Documentation Requirements:** +{{comment_and_documentation_patterns}} + +Any additional code quality rules?" + +### 6. Development Workflow Rules + +Document workflow patterns that affect implementation: + +**Git/Repository Rules:** +"Your project uses these patterns: + +**Branch Naming:** +{{branch_naming_conventions}} + +**Commit Message Format:** +{{commit_message_patterns}} + +**PR Requirements:** +{{pull_request_checklist}} + +**Deployment Patterns:** +{{deployment_considerations}} + +Should I document any other workflow rules?" + +### 7. Critical Don't-Miss Rules + +Identify rules that prevent common mistakes: + +**Anti-Patterns to Avoid:** +"Based on your codebase, here are critical things agents must NOT do: + +{{critical_anti_patterns_with_examples}} + +**Edge Cases:** +{{specific_edge_cases_agents_should_handle}} + +**Security Rules:** +{{security_considerations_agents_must_follow}} + +**Performance Gotchas:** +{{performance_patterns_to_avoid}} + +Are there other 'gotchas' agents should know about?" + +### 8. Generate Context Content + +For each category, prepare lean content for the project context file: + +#### Content Structure: + +```markdown +## Technology Stack & Versions + +{{concise_technology_list_with_exact_versions}} + +## Critical Implementation Rules + +### Language-Specific Rules + +{{bullet_points_of_critical_language_rules}} + +### Framework-Specific Rules + +{{bullet_points_of_framework_patterns}} + +### Testing Rules + +{{bullet_points_of_testing_requirements}} + +### Code Quality & Style Rules + +{{bullet_points_of_style_and_quality_rules}} + +### Development Workflow Rules + +{{bullet_points_of_workflow_patterns}} + +### Critical Don't-Miss Rules + +{{bullet_points_of_anti_patterns_and_edge_cases}} +``` + +### 9. Present Content and Menu + +After each category, show the generated rules and present choices: + +"I've drafted the {{category_name}} rules for your project context. + +**Here's what I'll add:** + +[Show the complete markdown content for this category] + +**What would you like to do?** +[A] Advanced Elicitation - Explore nuanced rules for this category +[P] Party Mode - Review from different implementation perspectives +[C] Continue - Save these rules and move to next category" + +### 10. Handle Menu Selection + +#### If 'A' (Advanced Elicitation): + +- Execute advanced-elicitation.xml with current category rules +- Process enhanced rules that come back +- Ask user: "Accept these enhanced rules for {{category}}? (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 party-mode workflow with category rules context +- Process collaborative insights on implementation patterns +- Ask user: "Accept these changes to {{category}} rules? (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): + +- Save the current category content to project context file +- Update frontmatter: `sections_completed: [...]` +- Proceed to next category or step-03 if complete + +## APPEND TO PROJECT CONTEXT: + +When user selects 'C' for a category, append the content directly to `{output_folder}/project_context.md` using the structure from step 8. + +## SUCCESS METRICS: + +✅ All critical technology versions accurately documented +✅ Language-specific rules cover unobvious patterns +✅ Framework rules capture project-specific conventions +✅ Testing rules ensure consistent test quality +✅ Code quality rules maintain project standards +✅ Workflow rules prevent implementation conflicts +✅ Content is lean and optimized for LLM context +✅ A/P/C menu presented and handled correctly for each category + +## FAILURE MODES: + +❌ Including obvious rules that agents already know +❌ Making content too verbose for LLM context efficiency +❌ Missing critical anti-patterns or edge cases +❌ Not getting user validation for each rule category +❌ Not documenting exact versions and configurations +❌ Not presenting A/P/C menu after content generation + +## NEXT STEP: + +After completing all rule categories and user selects 'C' for the final category, load `./step-03-complete.md` to finalize the project context file. + +Remember: Do NOT proceed to step-03 until all categories are complete and user explicitly selects 'C' for each! diff --git a/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md b/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md new file mode 100644 index 00000000..32815118 --- /dev/null +++ b/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md @@ -0,0 +1,277 @@ +# Step 3: Context Completion & Finalization + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without user input +- ✅ ALWAYS treat this as collaborative completion between technical peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on finalizing a lean, LLM-optimized project context +- 🎯 ENSURE all critical rules are captured and actionable +- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 📝 Review and optimize content for LLM context efficiency +- 📖 Update frontmatter with completion status +- 🚫 NO MORE STEPS - this is the final step + +## CONTEXT BOUNDARIES: + +- All rule categories from step-2 are complete +- Technology stack and versions are documented +- Focus on final review, optimization, and completion +- Ensure the context file is ready for AI agent consumption + +## YOUR TASK: + +Complete the project context file, optimize it for LLM efficiency, and provide guidance for usage and maintenance. + +## COMPLETION SEQUENCE: + +### 1. Review Complete Context File + +Read the entire project context file and analyze: + +**Content Analysis:** + +- Total length and readability for LLMs +- Clarity and specificity of rules +- Coverage of all critical areas +- Actionability of each rule + +**Structure Analysis:** + +- Logical organization of sections +- Consistency of formatting +- Absence of redundant or obvious information +- Optimization for quick scanning + +### 2. Optimize for LLM Context + +Ensure the file is lean and efficient: + +**Content Optimization:** + +- Remove any redundant rules or obvious information +- Combine related rules into concise bullet points +- Use specific, actionable language +- Ensure each rule provides unique value + +**Formatting Optimization:** + +- Use consistent markdown formatting +- Implement clear section hierarchy +- Ensure scannability with strategic use of bolding +- Maintain readability while maximizing information density + +### 3. Final Content Structure + +Ensure the final structure follows this optimized format: + +```markdown +# Project Context for AI Agents + +_This file contains critical rules and patterns that AI agents must follow when implementing code in this project. Focus on unobvious details that agents might otherwise miss._ + +--- + +## Technology Stack & Versions + +{{concise_technology_list}} + +## Critical Implementation Rules + +### Language-Specific Rules + +{{specific_language_rules}} + +### Framework-Specific Rules + +{{framework_patterns}} + +### Testing Rules + +{{testing_requirements}} + +### Code Quality & Style Rules + +{{style_and_quality_patterns}} + +### Development Workflow Rules + +{{workflow_patterns}} + +### Critical Don't-Miss Rules + +{{anti_patterns_and_edge_cases}} + +--- + +## Usage Guidelines + +**For AI Agents:** + +- Read this file before implementing any code +- Follow ALL rules exactly as documented +- When in doubt, prefer the more restrictive option +- Update this file if new patterns emerge + +**For Humans:** + +- Keep this file lean and focused on agent needs +- Update when technology stack changes +- Review quarterly for outdated rules +- Remove rules that become obvious over time + +Last Updated: {{date}} +``` + +### 4. Present Completion Summary + +Based on user skill level, present the completion: + +**Expert Mode:** +"Project context complete. Optimized for LLM consumption with {{rule_count}} critical rules across {{section_count}} sections. + +File saved to: `{output_folder}/project_context.md` + +Ready for AI agent integration." + +**Intermediate Mode:** +"Your project context is complete and optimized for AI agents! + +**What we created:** + +- {{rule_count}} critical implementation rules +- Technology stack with exact versions +- Framework-specific patterns and conventions +- Testing and quality guidelines +- Workflow and anti-pattern rules + +**Key benefits:** + +- AI agents will implement consistently with your standards +- Reduced context switching and implementation errors +- Clear guidance for unobvious project requirements + +**Next steps:** + +- AI agents should read this file before implementing +- Update as your project evolves +- Review periodically for optimization" + +**Beginner Mode:** +"Excellent! Your project context guide is ready! 🎉 + +**What this does:** +Think of this as a 'rules of the road' guide for AI agents working on your project. It ensures they all follow the same patterns and avoid common mistakes. + +**What's included:** + +- Exact technology versions to use +- Critical coding rules they might miss +- Testing and quality standards +- Workflow patterns to follow + +**How AI agents use it:** +They read this file before writing any code, ensuring everything they create follows your project's standards perfectly. + +Your project context is saved and ready to help agents implement consistently!" + +### 5. Final File Updates + +Update the project context file with completion information: + +**Frontmatter Update:** + +```yaml +--- +project_name: '{{project_name}}' +user_name: '{{user_name}}' +date: '{{date}}' +sections_completed: + ['technology_stack', 'language_rules', 'framework_rules', 'testing_rules', 'quality_rules', 'workflow_rules', 'anti_patterns'] +status: 'complete' +rule_count: { { total_rules } } +optimized_for_llm: true +--- +``` + +**Add Usage Section:** +Append the usage guidelines from step 3 to complete the document. + +### 6. Completion Validation + +Final checks before completion: + +**Content Validation:** +✅ All critical technology versions documented +✅ Language-specific rules are specific and actionable +✅ Framework rules cover project conventions +✅ Testing rules ensure consistency +✅ Code quality rules maintain standards +✅ Workflow rules prevent conflicts +✅ Anti-pattern rules prevent common mistakes + +**Format Validation:** +✅ Content is lean and optimized for LLMs +✅ Structure is logical and scannable +✅ No redundant or obvious information +✅ Consistent formatting throughout + +### 7. Completion Message + +Present final completion to user: + +"✅ **Project Context Generation Complete!** + +Your optimized project context file is ready at: +`{output_folder}/project_context.md` + +**📊 Context Summary:** + +- {{rule_count}} critical rules for AI agents +- {{section_count}} comprehensive sections +- Optimized for LLM context efficiency +- Ready for immediate agent integration + +**🎯 Key Benefits:** + +- Consistent implementation across all AI agents +- Reduced common mistakes and edge cases +- Clear guidance for project-specific patterns +- Minimal LLM context usage + +**📋 Next Steps:** + +1. AI agents will automatically read this file when implementing +2. Update this file when your technology stack or patterns evolve +3. Review quarterly to optimize and remove outdated rules + +Your project context will help ensure high-quality, consistent implementation across all development work. Great work capturing your project's critical implementation requirements!" + +## SUCCESS METRICS: + +✅ Complete project context file with all critical rules +✅ Content optimized for LLM context efficiency +✅ All technology versions and patterns documented +✅ File structure is logical and scannable +✅ Usage guidelines included for agents and humans +✅ Frontmatter properly updated with completion status +✅ User provided with clear next steps and benefits + +## FAILURE MODES: + +❌ Final content is too verbose for LLM consumption +❌ Missing critical implementation rules or patterns +❌ Not optimizing content for agent readability +❌ Not providing clear usage guidelines +❌ Frontmatter not properly updated +❌ Not validating file completion before ending + +## WORKFLOW COMPLETE: + +This is the final step of the Generate Project Context workflow. The user now has a comprehensive, optimized project context file that will ensure consistent, high-quality implementation across all AI agents working on the project. + +The project context file serves as the critical "rules of the road" that agents need to implement code consistently with the project's standards and patterns. diff --git a/src/modules/bmm/workflows/generate-project-context/workflow.md b/src/modules/bmm/workflows/generate-project-context/workflow.md new file mode 100644 index 00000000..a9c463e9 --- /dev/null +++ b/src/modules/bmm/workflows/generate-project-context/workflow.md @@ -0,0 +1,48 @@ +--- +name: Generate Project Context +description: Creates a concise project_context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency. +--- + +# Generate Project Context Workflow + +**Goal:** Create a concise, optimized `project_context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of. + +**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **micro-file architecture** for disciplined execution: + +- Each step is a self-contained file with embedded rules +- Sequential progression with user control at each step +- Document state tracked in frontmatter +- Focus on lean, LLM-optimized content generation +- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation. + +--- + +## INITIALIZATION + +### Configuration Loading + +Load config from `{project-root}/{bmad_folder}/bmm/config.yaml` and resolve: + +- `project_name`, `output_folder`, `user_name` +- `communication_language`, `document_output_language`, `user_skill_level` +- `date` as system-generated current datetime + +### Paths + +- `installed_path` = `{project-root}/{bmad_folder}/bmm/workflows/generate-project-context` +- `template_path` = `{installed_path}/project-context-template.md` +- `output_file` = `{output_folder}/project_context.md` + +--- + +## EXECUTION + +Load and execute `steps/step-01-discover.md` to begin the workflow. + +**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md. diff --git a/src/modules/cis/agents/brainstorming-coach.agent.yaml b/src/modules/cis/agents/brainstorming-coach.agent.yaml index 549a166a..aeb9001c 100644 --- a/src/modules/cis/agents/brainstorming-coach.agent.yaml +++ b/src/modules/cis/agents/brainstorming-coach.agent.yaml @@ -20,7 +20,7 @@ agent: description: Guide me through Brainstorming any topic - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/cis/agents/creative-problem-solver.agent.yaml b/src/modules/cis/agents/creative-problem-solver.agent.yaml index c8288708..832e4c9e 100644 --- a/src/modules/cis/agents/creative-problem-solver.agent.yaml +++ b/src/modules/cis/agents/creative-problem-solver.agent.yaml @@ -20,7 +20,7 @@ agent: description: Apply systematic problem-solving methodologies - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/cis/agents/design-thinking-coach.agent.yaml b/src/modules/cis/agents/design-thinking-coach.agent.yaml index 91d2761a..05199ff2 100644 --- a/src/modules/cis/agents/design-thinking-coach.agent.yaml +++ b/src/modules/cis/agents/design-thinking-coach.agent.yaml @@ -20,7 +20,7 @@ agent: description: Guide human-centered design process - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/cis/agents/innovation-strategist.agent.yaml b/src/modules/cis/agents/innovation-strategist.agent.yaml index 0845e447..babfb8ce 100644 --- a/src/modules/cis/agents/innovation-strategist.agent.yaml +++ b/src/modules/cis/agents/innovation-strategist.agent.yaml @@ -20,7 +20,7 @@ agent: description: Identify disruption opportunities and business model innovation - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/cis/agents/presentation-master.agent.yaml b/src/modules/cis/agents/presentation-master.agent.yaml index c6fe1787..fef9b701 100644 --- a/src/modules/cis/agents/presentation-master.agent.yaml +++ b/src/modules/cis/agents/presentation-master.agent.yaml @@ -52,7 +52,7 @@ agent: description: Generate single expressive image that explains ideas creatively and memorably - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation diff --git a/src/modules/cis/agents/storyteller.agent.yaml b/src/modules/cis/agents/storyteller.agent.yaml index 5f46a001..cffc28a0 100644 --- a/src/modules/cis/agents/storyteller.agent.yaml +++ b/src/modules/cis/agents/storyteller.agent.yaml @@ -20,7 +20,7 @@ agent: description: Craft compelling narrative using proven frameworks - trigger: party-mode - workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml" + exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md" description: Consult with other expert agents from the party - trigger: advanced-elicitation