Initial commit: Data Analysis application with FastAPI backend and Next.js frontend
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
date: { system-date }
|
||||
author: { user }
|
||||
---
|
||||
|
||||
# Product Brief: {{project_name}}
|
||||
|
||||
<!-- Content will be appended sequentially through collaborative workflow steps -->
|
||||
@@ -0,0 +1,182 @@
|
||||
---
|
||||
name: 'step-01-init'
|
||||
description: 'Initialize the product brief workflow by detecting continuation state and setting up the document'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01-init.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-02-vision.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Template References
|
||||
productBriefTemplate: '{workflow_path}/product-brief.template.md'
|
||||
---
|
||||
|
||||
# Step 1: Product Brief Initialization
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Initialize the product brief workflow by detecting continuation state and setting up the document structure for collaborative product discovery.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative discovery tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on initialization and setup - no content generation yet
|
||||
- 🚫 FORBIDDEN to look ahead to future steps or assume knowledge from them
|
||||
- 💬 Approach: Systematic setup with clear reporting to user
|
||||
- 📋 Detect existing workflow state and handle continuation properly
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis of current state before taking any action
|
||||
- 💾 Initialize document structure and update frontmatter appropriately
|
||||
- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until user selects 'C' (Continue)
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Variables from workflow.md are available in memory
|
||||
- Focus: Workflow initialization and document setup only
|
||||
- Limits: Don't assume knowledge from other steps or create content yet
|
||||
- Dependencies: Configuration loaded from workflow.md initialization
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Check for Existing Workflow State
|
||||
|
||||
First, check if the output document already exists:
|
||||
|
||||
**Workflow State Detection:**
|
||||
|
||||
- Look for file `{outputFile}`
|
||||
- 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`:
|
||||
|
||||
**Continuation Protocol:**
|
||||
|
||||
- **STOP immediately** and load `{workflow_path}/steps/step-01b-continue.md`
|
||||
- Do not proceed with any initialization tasks
|
||||
- Let step-01b handle all continuation logic
|
||||
- This is an auto-proceed situation - no user choice needed
|
||||
|
||||
### 3. Fresh Workflow Setup (If No Document)
|
||||
|
||||
If no document exists or no `stepsCompleted` in frontmatter:
|
||||
|
||||
#### A. Input Document Discovery
|
||||
|
||||
load context documents using smart discovery. Documents can be in the following locations:
|
||||
- {planning_artifacts}/**
|
||||
- {output_folder}/**
|
||||
- {product_knowledge}/**
|
||||
- docs/**
|
||||
|
||||
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
||||
|
||||
Try to discover the following:
|
||||
- Brainstorming Reports (`*brainstorming*.md`)
|
||||
- Research Documents (`*research*.md`)
|
||||
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
||||
- Project Context (`**/project-context.md`)
|
||||
|
||||
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
||||
|
||||
**Loading Rules:**
|
||||
|
||||
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
||||
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
||||
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
||||
- index.md is a guide to what's relevant whenever available
|
||||
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
||||
|
||||
#### B. Create Initial Document
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Copy the template from `{productBriefTemplate}` to `{outputFile}`, and update the frontmatter fields
|
||||
|
||||
#### C. Present Initialization Results
|
||||
|
||||
**Setup Report to User:**
|
||||
"Welcome {{user_name}}! I've set up your product brief workspace for {{project_name}}.
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Created: `{outputFile}` from template
|
||||
- Initialized frontmatter with workflow state
|
||||
|
||||
**Input Documents Discovered:**
|
||||
|
||||
- Research: {number of research files loaded or "None found"}
|
||||
- Brainstorming: {number of brainstorming files loaded or "None found"}
|
||||
- Project docs: {number of project files loaded or "None found"}
|
||||
- Project Context: {number of project context files loaded or "None found"}
|
||||
|
||||
**Files loaded:** {list of specific file names or "No additional documents found"}
|
||||
|
||||
Do you have any other documents you'd like me to include, or shall we continue to the next step?"
|
||||
|
||||
### 4. Present MENU OPTIONS
|
||||
|
||||
Display: "**Proceeding to product vision discovery...**"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- After setup report is presented, immediately load, read entire file, then execute {nextStepFile}
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- This is an initialization step with auto-proceed after setup completion
|
||||
- Proceed directly to next step after document setup and reporting
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [setup completion is achieved and frontmatter properly updated], will you then load and read fully `{nextStepFile}` to execute and begin product vision discovery.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Existing workflow detected and properly handed off to step-01b
|
||||
- Fresh workflow initialized with template and proper frontmatter
|
||||
- Input documents discovered and loaded using sharded-first logic
|
||||
- All discovered files tracked in frontmatter `inputDocuments`
|
||||
- Menu presented and user input handled correctly
|
||||
- Frontmatter updated with `stepsCompleted: [1]` before proceeding
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Proceeding with fresh initialization when existing workflow exists
|
||||
- Not updating frontmatter with discovered input documents
|
||||
- Creating document without proper template structure
|
||||
- Not checking sharded folders first before whole files
|
||||
- Not reporting discovered documents to user clearly
|
||||
- Proceeding without user selecting 'C' (Continue)
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,166 @@
|
||||
---
|
||||
name: 'step-01b-continue'
|
||||
description: 'Resume the product brief workflow from where it was left off, ensuring smooth continuation'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
---
|
||||
|
||||
# Step 1B: Product Brief Continuation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Resume the product brief workflow from where it was left off, ensuring smooth continuation with full context restoration.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative continuation tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on understanding where we left off and continuing appropriately
|
||||
- 🚫 FORBIDDEN to modify content completed in previous steps
|
||||
- 💬 Approach: Systematic state analysis with clear progress reporting
|
||||
- 📋 Resume workflow from exact point where it was interrupted
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis of current state before taking any action
|
||||
- 💾 Keep existing frontmatter `stepsCompleted` values
|
||||
- 📖 Only load documents that were already tracked in `inputDocuments`
|
||||
- 🚫 FORBIDDEN to discover new input documents during continuation
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Current document and frontmatter are already loaded
|
||||
- Focus: Workflow state analysis and continuation logic only
|
||||
- Limits: Don't assume knowledge beyond what's in the document
|
||||
- Dependencies: Existing workflow state from previous session
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Analyze Current State
|
||||
|
||||
**State Assessment:**
|
||||
Review the frontmatter to understand:
|
||||
|
||||
- `stepsCompleted`: Which steps are already done
|
||||
- `lastStep`: The most recently completed step number
|
||||
- `inputDocuments`: What context was already loaded
|
||||
- All other frontmatter variables
|
||||
|
||||
### 2. Restore Context Documents
|
||||
|
||||
**Context Reloading:**
|
||||
|
||||
- For each document in `inputDocuments`, load the complete file
|
||||
- This ensures you have full context for continuation
|
||||
- Don't discover new documents - only reload what was previously processed
|
||||
- Maintain the same context as when workflow was interrupted
|
||||
|
||||
### 3. Present Current Progress
|
||||
|
||||
**Progress Report to User:**
|
||||
"Welcome back {{user_name}}! I'm resuming our product brief collaboration for {{project_name}}.
|
||||
|
||||
**Current Progress:**
|
||||
|
||||
- Steps completed: {stepsCompleted}
|
||||
- Last worked on: Step {lastStep}
|
||||
- Context documents available: {len(inputDocuments)} files
|
||||
|
||||
**Document Status:**
|
||||
|
||||
- Current product brief is ready with all completed sections
|
||||
- Ready to continue from where we left off
|
||||
|
||||
Does this look right, or do you want to make any adjustments before we proceed?"
|
||||
|
||||
### 4. Determine Continuation Path
|
||||
|
||||
**Next Step Logic:**
|
||||
Based on `lastStep` value, determine which step to load next:
|
||||
|
||||
- If `lastStep = 1` → Load `./step-02-vision.md`
|
||||
- If `lastStep = 2` → Load `./step-03-users.md`
|
||||
- If `lastStep = 3` → Load `./step-04-metrics.md`
|
||||
- Continue this pattern for all steps
|
||||
- If `lastStep = 6` → Workflow already complete
|
||||
|
||||
### 5. Handle Workflow Completion
|
||||
|
||||
**If workflow already complete (`lastStep = 6`):**
|
||||
"Great news! It looks like we've already completed the product brief workflow for {{project_name}}.
|
||||
|
||||
The final document is ready at `{outputFile}` with all sections completed through step 6.
|
||||
|
||||
Would you like me to:
|
||||
|
||||
- Review the completed product brief with you
|
||||
- Suggest next workflow steps (like PRD creation)
|
||||
- Start a new product brief revision
|
||||
|
||||
What would be most helpful?"
|
||||
|
||||
### 6. Present MENU OPTIONS
|
||||
|
||||
**If workflow not complete:**
|
||||
Display: "Ready to continue with Step {nextStepNumber}: {nextStepTitle}?
|
||||
|
||||
**Select an Option:** [C] Continue to Step {nextStepNumber}"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Load, read entire file, then execute the appropriate next step file based on `lastStep`
|
||||
- IF Any other comments or queries: respond and redisplay menu
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- User can chat or ask questions about current progress
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the appropriate next step file to resume the workflow.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All previous input documents successfully reloaded
|
||||
- Current workflow state accurately analyzed and presented
|
||||
- User confirms understanding of progress before continuation
|
||||
- Correct next step identified and prepared for loading
|
||||
- Proper continuation path determined based on `lastStep`
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Discovering new input documents instead of reloading existing ones
|
||||
- Modifying content from already completed steps
|
||||
- Loading wrong next step based on `lastStep` value
|
||||
- Proceeding without user confirmation of current state
|
||||
- Not maintaining context consistency from previous session
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,204 @@
|
||||
---
|
||||
name: 'step-02-vision'
|
||||
description: 'Discover and define the core product vision, problem statement, and unique value proposition'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-02-vision.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-03-users.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 2: Product Vision Discovery
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Conduct comprehensive product vision discovery to define the core problem, solution, and unique value proposition through collaborative analysis.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative discovery tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on product vision, problem, and solution discovery
|
||||
- 🚫 FORBIDDEN to generate vision without real user input and collaboration
|
||||
- 💬 Approach: Systematic discovery from problem to solution
|
||||
- 📋 COLLABORATIVE discovery, not assumption-based vision crafting
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Generate vision content collaboratively with user
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step
|
||||
- 🚫 FORBIDDEN to proceed without user confirmation through menu
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Current document and frontmatter from step 1, input documents already loaded in memory
|
||||
- Focus: This will be the first content section appended to the document
|
||||
- Limits: Focus on clear, compelling product vision and problem statement
|
||||
- Dependencies: Document initialization from step-01 must be complete
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Begin Vision Discovery
|
||||
|
||||
**Opening Conversation:**
|
||||
"As your PM peer, I'm excited to help you shape the vision for {{project_name}}. Let's start with the foundation.
|
||||
|
||||
**Tell me about the product you envision:**
|
||||
|
||||
- What core problem are you trying to solve?
|
||||
- Who experiences this problem most acutely?
|
||||
- What would success look like for the people you're helping?
|
||||
- What excites you most about this solution?
|
||||
|
||||
Let's start with the problem space before we get into solutions."
|
||||
|
||||
### 2. Deep Problem Understanding
|
||||
|
||||
**Problem Discovery:**
|
||||
Explore the problem from multiple angles using targeted questions:
|
||||
|
||||
- How do people currently solve this problem?
|
||||
- What's frustrating about current solutions?
|
||||
- What happens if this problem goes unsolved?
|
||||
- Who feels this pain most intensely?
|
||||
|
||||
### 3. Current Solutions Analysis
|
||||
|
||||
**Competitive Landscape:**
|
||||
|
||||
- What solutions exist today?
|
||||
- Where do they fall short?
|
||||
- What gaps are they leaving open?
|
||||
- Why haven't existing solutions solved this completely?
|
||||
|
||||
### 4. Solution Vision
|
||||
|
||||
**Collaborative Solution Crafting:**
|
||||
|
||||
- If we could solve this perfectly, what would that look like?
|
||||
- What's the simplest way we could make a meaningful difference?
|
||||
- What makes your approach different from what's out there?
|
||||
- What would make users say 'this is exactly what I needed'?
|
||||
|
||||
### 5. Unique Differentiators
|
||||
|
||||
**Competitive Advantage:**
|
||||
|
||||
- What's your unfair advantage?
|
||||
- What would be hard for competitors to copy?
|
||||
- What insight or approach is uniquely yours?
|
||||
- Why is now the right time for this solution?
|
||||
|
||||
### 6. Generate Executive Summary Content
|
||||
|
||||
**Content to Append:**
|
||||
Prepare the following structure for document append:
|
||||
|
||||
```markdown
|
||||
## Executive Summary
|
||||
|
||||
[Executive summary content based on conversation]
|
||||
|
||||
---
|
||||
|
||||
## Core Vision
|
||||
|
||||
### Problem Statement
|
||||
|
||||
[Problem statement content based on conversation]
|
||||
|
||||
### Problem Impact
|
||||
|
||||
[Problem impact content based on conversation]
|
||||
|
||||
### Why Existing Solutions Fall Short
|
||||
|
||||
[Analysis of existing solution gaps based on conversation]
|
||||
|
||||
### Proposed Solution
|
||||
|
||||
[Proposed solution description based on conversation]
|
||||
|
||||
### Key Differentiators
|
||||
|
||||
[Key differentiators based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present MENU OPTIONS
|
||||
|
||||
**Content Presentation:**
|
||||
"I've drafted the executive summary and core vision based on our conversation. This captures the essence of {{project_name}} and what makes it special.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF A: Execute {advancedElicitationTask} with current vision content to dive deeper and refine
|
||||
- IF P: Execute {partyModeWorkflow} to bring different perspectives to positioning and differentiation
|
||||
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2], then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- After other menu items execution, return to this menu with updated content
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [vision content finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and begin target user discovery.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Clear problem statement that resonates with target users
|
||||
- Compelling solution vision that addresses the core problem
|
||||
- Unique differentiators that provide competitive advantage
|
||||
- Executive summary that captures the product essence
|
||||
- A/P/C menu presented and handled correctly with proper task execution
|
||||
- Content properly appended to document when C selected
|
||||
- Frontmatter updated with stepsCompleted: [1, 2]
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Accepting vague problem statements without pushing for specificity
|
||||
- Creating solution vision without fully understanding the problem
|
||||
- Missing unique differentiators or competitive insights
|
||||
- Generating vision without real user input and collaboration
|
||||
- Not presenting standard A/P/C menu after content generation
|
||||
- Appending content without user selecting 'C'
|
||||
- Not updating frontmatter properly
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,207 @@
|
||||
---
|
||||
name: 'step-03-users'
|
||||
description: 'Define target users with rich personas and map their key interactions with the product'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-users.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-metrics.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 3: Target Users Discovery
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Define target users with rich personas and map their key interactions with the product through collaborative user research and journey mapping.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative discovery tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on defining who this product serves and how they interact with it
|
||||
- 🚫 FORBIDDEN to create generic user profiles without specific details
|
||||
- 💬 Approach: Systematic persona development with journey mapping
|
||||
- 📋 COLLABORATIVE persona development, not assumption-based user creation
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Generate user personas and journeys collaboratively with user
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step
|
||||
- 🚫 FORBIDDEN to proceed without user confirmation through menu
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Current document and frontmatter from previous steps, product vision and problem already defined
|
||||
- Focus: Creating vivid, actionable user personas that align with product vision
|
||||
- Limits: Focus on users who directly experience the problem or benefit from the solution
|
||||
- Dependencies: Product vision and problem statement from step-02 must be complete
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Begin User Discovery
|
||||
|
||||
**Opening Exploration:**
|
||||
"Now that we understand what {{project_name}} does, let's define who it's for.
|
||||
|
||||
**User Discovery:**
|
||||
|
||||
- Who experiences the problem we're solving?
|
||||
- Are there different types of users with different needs?
|
||||
- Who gets the most value from this solution?
|
||||
- Are there primary users and secondary users we should consider?
|
||||
|
||||
Let's start by identifying the main user groups."
|
||||
|
||||
### 2. Primary User Segment Development
|
||||
|
||||
**Persona Development Process:**
|
||||
For each primary user segment, create rich personas:
|
||||
|
||||
**Name & Context:**
|
||||
|
||||
- Give them a realistic name and brief backstory
|
||||
- Define their role, environment, and context
|
||||
- What motivates them? What are their goals?
|
||||
|
||||
**Problem Experience:**
|
||||
|
||||
- How do they currently experience the problem?
|
||||
- What workarounds are they using?
|
||||
- What are the emotional and practical impacts?
|
||||
|
||||
**Success Vision:**
|
||||
|
||||
- What would success look like for them?
|
||||
- What would make them say "this is exactly what I needed"?
|
||||
|
||||
**Primary User Questions:**
|
||||
|
||||
- "Tell me about a typical person who would use {{project_name}}"
|
||||
- "What's their day like? Where does our product fit in?"
|
||||
- "What are they trying to accomplish that's hard right now?"
|
||||
|
||||
### 3. Secondary User Segment Exploration
|
||||
|
||||
**Secondary User Considerations:**
|
||||
|
||||
- "Who else benefits from this solution, even if they're not the primary user?"
|
||||
- "Are there admin, support, or oversight roles we should consider?"
|
||||
- "Who influences the decision to adopt or purchase this product?"
|
||||
- "Are there partner or stakeholder users who matter?"
|
||||
|
||||
### 4. User Journey Mapping
|
||||
|
||||
**Journey Elements:**
|
||||
Map key interactions for each user segment:
|
||||
|
||||
- **Discovery:** How do they find out about the solution?
|
||||
- **Onboarding:** What's their first experience like?
|
||||
- **Core Usage:** How do they use the product day-to-day?
|
||||
- **Success Moment:** When do they realize the value?
|
||||
- **Long-term:** How does it become part of their routine?
|
||||
|
||||
**Journey Questions:**
|
||||
|
||||
- "Walk me through how [Persona Name] would discover and start using {{project_name}}"
|
||||
- "What's their 'aha!' moment?"
|
||||
- "How does this product change how they work or live?"
|
||||
|
||||
### 5. Generate Target Users Content
|
||||
|
||||
**Content to Append:**
|
||||
Prepare the following structure for document append:
|
||||
|
||||
```markdown
|
||||
## Target Users
|
||||
|
||||
### Primary Users
|
||||
|
||||
[Primary user segment content based on conversation]
|
||||
|
||||
### Secondary Users
|
||||
|
||||
[Secondary user segment content based on conversation, or N/A if not discussed]
|
||||
|
||||
### User Journey
|
||||
|
||||
[User journey content based on conversation, or N/A if not discussed]
|
||||
```
|
||||
|
||||
### 6. Present MENU OPTIONS
|
||||
|
||||
**Content Presentation:**
|
||||
"I've mapped out who {{project_name}} serves and how they'll interact with it. This helps us ensure we're building something that real people will love to use.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
[Show the complete markdown content from step 5]
|
||||
|
||||
**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF A: Execute {advancedElicitationTask} with current user content to dive deeper into personas and journeys
|
||||
- IF P: Execute {partyModeWorkflow} to bring different perspectives to validate user understanding
|
||||
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2, 3], then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options)
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- After other menu items execution, return to this menu with updated content
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [user personas finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and begin success metrics definition.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Rich, believable user personas with clear motivations
|
||||
- Clear distinction between primary and secondary users
|
||||
- User journeys that show key interaction points and value creation
|
||||
- User segments that align with product vision and problem statement
|
||||
- A/P/C menu presented and handled correctly with proper task execution
|
||||
- Content properly appended to document when C selected
|
||||
- Frontmatter updated with stepsCompleted: [1, 2, 3]
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Creating generic user profiles without specific details
|
||||
- Missing key user segments that are important to success
|
||||
- User journeys that don't show how the product creates value
|
||||
- Not connecting user needs back to the problem statement
|
||||
- Not presenting standard A/P/C menu after content generation
|
||||
- Appending content without user selecting 'C'
|
||||
- Not updating frontmatter properly
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,210 @@
|
||||
---
|
||||
name: 'step-04-metrics'
|
||||
description: 'Define comprehensive success metrics that include user success, business objectives, and key performance indicators'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-metrics.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-05-scope.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 4: Success Metrics Definition
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Define comprehensive success metrics that include user success, business objectives, and key performance indicators through collaborative metric definition aligned with product vision and user value.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative discovery tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on defining measurable success criteria and business objectives
|
||||
- 🚫 FORBIDDEN to create vague metrics that can't be measured or tracked
|
||||
- 💬 Approach: Systematic metric definition that connects user value to business success
|
||||
- 📋 COLLABORATIVE metric definition that drives actionable decisions
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Generate success metrics collaboratively with user
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
|
||||
- 🚫 FORBIDDEN to proceed without user confirmation through menu
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Current document and frontmatter from previous steps, product vision and target users already defined
|
||||
- Focus: Creating measurable, actionable success criteria that align with product strategy
|
||||
- Limits: Focus on metrics that drive decisions and demonstrate real value creation
|
||||
- Dependencies: Product vision and user personas from previous steps must be complete
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Begin Success Metrics Discovery
|
||||
|
||||
**Opening Exploration:**
|
||||
"Now that we know who {{project_name}} serves and what problem it solves, let's define what success looks like.
|
||||
|
||||
**Success Discovery:**
|
||||
|
||||
- How will we know we're succeeding for our users?
|
||||
- What would make users say 'this was worth it'?
|
||||
- What metrics show we're creating real value?
|
||||
|
||||
Let's start with the user perspective."
|
||||
|
||||
### 2. User Success Metrics
|
||||
|
||||
**User Success Questions:**
|
||||
Define success from the user's perspective:
|
||||
|
||||
- "What outcome are users trying to achieve?"
|
||||
- "How will they know the product is working for them?"
|
||||
- "What's the moment where they realize this is solving their problem?"
|
||||
- "What behaviors indicate users are getting value?"
|
||||
|
||||
**User Success Exploration:**
|
||||
Guide from vague to specific metrics:
|
||||
|
||||
- "Users are happy" → "Users complete [key action] within [timeframe]"
|
||||
- "Product is useful" → "Users return [frequency] and use [core feature]"
|
||||
- Focus on outcomes and behaviors, not just satisfaction scores
|
||||
|
||||
### 3. Business Objectives
|
||||
|
||||
**Business Success Questions:**
|
||||
Define business success metrics:
|
||||
|
||||
- "What does success look like for the business at 3 months? 12 months?"
|
||||
- "Are we measuring revenue, user growth, engagement, something else?"
|
||||
- "What business metrics would make you say 'this is working'?"
|
||||
- "How does this product contribute to broader company goals?"
|
||||
|
||||
**Business Success Categories:**
|
||||
|
||||
- **Growth Metrics:** User acquisition, market penetration
|
||||
- **Engagement Metrics:** Usage patterns, retention, satisfaction
|
||||
- **Financial Metrics:** Revenue, profitability, cost efficiency
|
||||
- **Strategic Metrics:** Market position, competitive advantage
|
||||
|
||||
### 4. Key Performance Indicators
|
||||
|
||||
**KPI Development Process:**
|
||||
Define specific, measurable KPIs:
|
||||
|
||||
- Transform objectives into measurable indicators
|
||||
- Ensure each KPI has a clear measurement method
|
||||
- Define targets and timeframes where appropriate
|
||||
- Include leading indicators that predict success
|
||||
|
||||
**KPI Examples:**
|
||||
|
||||
- User acquisition: "X new users per month"
|
||||
- Engagement: "Y% of users complete core journey weekly"
|
||||
- Business impact: "$Z in cost savings or revenue generation"
|
||||
|
||||
### 5. Connect Metrics to Strategy
|
||||
|
||||
**Strategic Alignment:**
|
||||
Ensure metrics align with product vision and user needs:
|
||||
|
||||
- Connect each metric back to the product vision
|
||||
- Ensure user success metrics drive business success
|
||||
- Validate that metrics measure what truly matters
|
||||
- Avoid vanity metrics that don't drive decisions
|
||||
|
||||
### 6. Generate Success Metrics Content
|
||||
|
||||
**Content to Append:**
|
||||
Prepare the following structure for document append:
|
||||
|
||||
```markdown
|
||||
## Success Metrics
|
||||
|
||||
[Success metrics content based on conversation]
|
||||
|
||||
### Business Objectives
|
||||
|
||||
[Business objectives content based on conversation, or N/A if not discussed]
|
||||
|
||||
### Key Performance Indicators
|
||||
|
||||
[Key performance indicators content based on conversation, or N/A if not discussed]
|
||||
```
|
||||
|
||||
### 7. Present MENU OPTIONS
|
||||
|
||||
**Content Presentation:**
|
||||
"I've defined success metrics that will help us track whether {{project_name}} is creating real value for users and achieving business objectives.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF A: Execute {advancedElicitationTask} with current metrics content to dive deeper into success metric insights
|
||||
- IF P: Execute {partyModeWorkflow} to bring different perspectives to validate comprehensive metrics
|
||||
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2, 3, 4], then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- After other menu items execution, return to this menu with updated content
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [success metrics finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and begin MVP scope definition.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- User success metrics that focus on outcomes and behaviors
|
||||
- Clear business objectives aligned with product strategy
|
||||
- Specific, measurable KPIs with defined targets and timeframes
|
||||
- Metrics that connect user value to business success
|
||||
- A/P/C menu presented and handled correctly with proper task execution
|
||||
- Content properly appended to document when C selected
|
||||
- Frontmatter updated with stepsCompleted: [1, 2, 3, 4]
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Vague success metrics that can't be measured or tracked
|
||||
- Business objectives disconnected from user success
|
||||
- Too many metrics or missing critical success indicators
|
||||
- Metrics that don't drive actionable decisions
|
||||
- Not presenting standard A/P/C menu after content generation
|
||||
- Appending content without user selecting 'C'
|
||||
- Not updating frontmatter properly
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,224 @@
|
||||
---
|
||||
name: 'step-05-scope'
|
||||
description: 'Define MVP scope with clear boundaries and outline future vision while managing scope creep'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-05-scope.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-06-complete.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 5: MVP Scope Definition
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Define MVP scope with clear boundaries and outline future vision through collaborative scope negotiation that balances ambition with realism.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative discovery tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on defining minimum viable scope and future vision
|
||||
- 🚫 FORBIDDEN to create MVP scope that's too large or includes non-essential features
|
||||
- 💬 Approach: Systematic scope negotiation with clear boundary setting
|
||||
- 📋 COLLABORATIVE scope definition that prevents scope creep
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Generate MVP scope collaboratively with user
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step
|
||||
- 🚫 FORBIDDEN to proceed without user confirmation through menu
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Current document and frontmatter from previous steps, product vision, users, and success metrics already defined
|
||||
- Focus: Defining what's essential for MVP vs. future enhancements
|
||||
- Limits: Balance user needs with implementation feasibility
|
||||
- Dependencies: Product vision, user personas, and success metrics from previous steps must be complete
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Begin Scope Definition
|
||||
|
||||
**Opening Exploration:**
|
||||
"Now that we understand what {{project_name}} does, who it serves, and how we'll measure success, let's define what we need to build first.
|
||||
|
||||
**Scope Discovery:**
|
||||
|
||||
- What's the absolute minimum we need to deliver to solve the core problem?
|
||||
- What features would make users say 'this solves my problem'?
|
||||
- How do we balance ambition with getting something valuable to users quickly?
|
||||
|
||||
Let's start with the MVP mindset: what's the smallest version that creates real value?"
|
||||
|
||||
### 2. MVP Core Features Definition
|
||||
|
||||
**MVP Feature Questions:**
|
||||
Define essential features for minimum viable product:
|
||||
|
||||
- "What's the core functionality that must work?"
|
||||
- "Which features directly address the main problem we're solving?"
|
||||
- "What would users consider 'incomplete' if it was missing?"
|
||||
- "What features create the 'aha!' moment we discussed earlier?"
|
||||
|
||||
**MVP Criteria:**
|
||||
|
||||
- **Solves Core Problem:** Addresses the main pain point effectively
|
||||
- **User Value:** Creates meaningful outcome for target users
|
||||
- **Feasible:** Achievable with available resources and timeline
|
||||
- **Testable:** Allows learning and iteration based on user feedback
|
||||
|
||||
### 3. Out of Scope Boundaries
|
||||
|
||||
**Out of Scope Exploration:**
|
||||
Define what explicitly won't be in MVP:
|
||||
|
||||
- "What features would be nice to have but aren't essential?"
|
||||
- "What functionality could wait for version 2.0?"
|
||||
- "What are we intentionally saying 'no' to for now?"
|
||||
- "How do we communicate these boundaries to stakeholders?"
|
||||
|
||||
**Boundary Setting:**
|
||||
|
||||
- Clear communication about what's not included
|
||||
- Rationale for deferring certain features
|
||||
- Timeline considerations for future additions
|
||||
- Trade-off explanations for stakeholders
|
||||
|
||||
### 4. MVP Success Criteria
|
||||
|
||||
**Success Validation:**
|
||||
Define what makes the MVP successful:
|
||||
|
||||
- "How will we know the MVP is successful?"
|
||||
- "What metrics will indicate we should proceed beyond MVP?"
|
||||
- "What user feedback signals validate our approach?"
|
||||
- "What's the decision point for scaling beyond MVP?"
|
||||
|
||||
**Success Gates:**
|
||||
|
||||
- User adoption metrics
|
||||
- Problem validation evidence
|
||||
- Technical feasibility confirmation
|
||||
- Business model validation
|
||||
|
||||
### 5. Future Vision Exploration
|
||||
|
||||
**Vision Questions:**
|
||||
Define the longer-term product vision:
|
||||
|
||||
- "If this is wildly successful, what does it become in 2-3 years?"
|
||||
- "What capabilities would we add with more resources?"
|
||||
- "How does the MVP evolve into the full product vision?"
|
||||
- "What markets or user segments could we expand to?"
|
||||
|
||||
**Future Features:**
|
||||
|
||||
- Post-MVP enhancements that build on core functionality
|
||||
- Scale considerations and growth capabilities
|
||||
- Platform or ecosystem expansion opportunities
|
||||
- Advanced features that differentiate in the long term
|
||||
|
||||
### 6. Generate MVP Scope Content
|
||||
|
||||
**Content to Append:**
|
||||
Prepare the following structure for document append:
|
||||
|
||||
```markdown
|
||||
## MVP Scope
|
||||
|
||||
### Core Features
|
||||
|
||||
[Core features content based on conversation]
|
||||
|
||||
### Out of Scope for MVP
|
||||
|
||||
[Out of scope content based on conversation, or N/A if not discussed]
|
||||
|
||||
### MVP Success Criteria
|
||||
|
||||
[MVP success criteria content based on conversation, or N/A if not discussed]
|
||||
|
||||
### Future Vision
|
||||
|
||||
[Future vision content based on conversation, or N/A if not discussed]
|
||||
```
|
||||
|
||||
### 7. Present MENU OPTIONS
|
||||
|
||||
**Content Presentation:**
|
||||
"I've defined the MVP scope for {{project_name}} that balances delivering real value with realistic boundaries. This gives us a clear path forward while keeping our options open for future growth.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF A: Execute {advancedElicitationTask} with current scope content to optimize scope definition
|
||||
- IF P: Execute {partyModeWorkflow} to bring different perspectives to validate MVP scope
|
||||
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2, 3, 4, 5], then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- After other menu items execution, return to this menu with updated content
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [MVP scope finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and complete the product brief workflow.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- MVP features that solve the core problem effectively
|
||||
- Clear out-of-scope boundaries that prevent scope creep
|
||||
- Success criteria that validate MVP approach and inform go/no-go decisions
|
||||
- Future vision that inspires while maintaining focus on MVP
|
||||
- A/P/C menu presented and handled correctly with proper task execution
|
||||
- Content properly appended to document when C selected
|
||||
- Frontmatter updated with stepsCompleted: [1, 2, 3, 4, 5]
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- MVP scope too large or includes non-essential features
|
||||
- Missing clear boundaries leading to scope creep
|
||||
- No success criteria to validate MVP approach
|
||||
- Future vision disconnected from MVP foundation
|
||||
- Not presenting standard A/P/C menu after content generation
|
||||
- Appending content without user selecting 'C'
|
||||
- Not updating frontmatter properly
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,199 @@
|
||||
---
|
||||
name: 'step-06-complete'
|
||||
description: 'Complete the product brief workflow, update status files, and suggest next steps for the project'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-06-complete.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
---
|
||||
|
||||
# Step 6: Product Brief Completion
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Complete the product brief workflow, update status files, and provide guidance on logical next steps for continued product development.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused Business Analyst facilitator
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
- ✅ Maintain collaborative completion tone throughout
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on completion, next steps, and project guidance
|
||||
- 🚫 FORBIDDEN to generate new content for the product brief
|
||||
- 💬 Approach: Systematic completion with quality validation and next step recommendations
|
||||
- 📋 FINALIZE document and update workflow status appropriately
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Update the main workflow status file with completion information
|
||||
- 📖 Suggest potential next workflow steps for the user
|
||||
- 🚫 DO NOT load additional steps after this one (this is final)
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Complete product brief document from all previous steps, workflow frontmatter shows all completed steps
|
||||
- Focus: Completion validation, status updates, and next step guidance
|
||||
- Limits: No new content generation, only completion and wrap-up activities
|
||||
- Dependencies: All previous steps must be completed with content saved to document
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Announce Workflow Completion
|
||||
|
||||
**Completion Announcement:**
|
||||
"🎉 **Product Brief Complete, {{user_name}}!**
|
||||
|
||||
I've successfully collaborated with you to create a comprehensive Product Brief for {{project_name}}.
|
||||
|
||||
**What we've accomplished:**
|
||||
|
||||
- ✅ Executive Summary with clear vision and problem statement
|
||||
- ✅ Core Vision with solution definition and unique differentiators
|
||||
- ✅ Target Users with rich personas and user journeys
|
||||
- ✅ Success Metrics with measurable outcomes and business objectives
|
||||
- ✅ MVP Scope with focused feature set and clear boundaries
|
||||
- ✅ Future Vision that inspires while maintaining current focus
|
||||
|
||||
**The complete Product Brief is now available at:** `{outputFile}`
|
||||
|
||||
This brief serves as the foundation for all subsequent product development activities and strategic decisions."
|
||||
|
||||
### 2. Workflow Status Update
|
||||
|
||||
**Status File Management:**
|
||||
Update the main workflow status file:
|
||||
|
||||
- Check if `{output_folder} or {planning_artifacts}/bmm-workflow-status.yaml` exists
|
||||
- If so, update workflow_status["product-brief"] = `{outputFile}`
|
||||
- Add completion timestamp and metadata
|
||||
- Save file, preserving all comments and structure
|
||||
|
||||
### 3. Document Quality Check
|
||||
|
||||
**Completeness Validation:**
|
||||
Perform final validation of the product brief:
|
||||
|
||||
- Does the executive summary clearly communicate the vision and problem?
|
||||
- Are target users well-defined with compelling personas?
|
||||
- Do success metrics connect user value to business objectives?
|
||||
- Is MVP scope focused and realistic?
|
||||
- Does the brief provide clear direction for next steps?
|
||||
|
||||
**Consistency Validation:**
|
||||
|
||||
- Do all sections align with the core problem statement?
|
||||
- Is user value consistently emphasized throughout?
|
||||
- Are success criteria traceable to user needs and business goals?
|
||||
- Does MVP scope align with the problem and solution?
|
||||
|
||||
### 4. Suggest Next Steps
|
||||
|
||||
**Recommended Next Workflow:**
|
||||
Provide guidance on logical next workflows:
|
||||
|
||||
1. `create-prd` - Create detailed Product Requirements Document
|
||||
- Brief provides foundation for detailed requirements
|
||||
- User personas inform journey mapping
|
||||
- Success metrics become specific acceptance criteria
|
||||
- MVP scope becomes detailed feature specifications
|
||||
|
||||
**Other Potential Next Steps:**
|
||||
|
||||
1. `create-ux-design` - UX research and design (can run parallel with PRD)
|
||||
2. `domain-research` - Deep market or domain research (if needed)
|
||||
|
||||
**Strategic Considerations:**
|
||||
|
||||
- The PRD workflow builds directly on this brief for detailed planning
|
||||
- Consider team capacity and immediate priorities
|
||||
- Use brief to validate concept before committing to detailed work
|
||||
- Brief can guide early technical feasibility discussions
|
||||
|
||||
### 5. Present MENU OPTIONS
|
||||
|
||||
**Completion Confirmation:**
|
||||
"**Your Product Brief for {{project_name}} is now complete and ready for the next phase!**
|
||||
|
||||
The brief captures everything needed to guide subsequent product development:
|
||||
|
||||
- Clear vision and problem definition
|
||||
- Deep understanding of target users
|
||||
- Measurable success criteria
|
||||
- Focused MVP scope with realistic boundaries
|
||||
- Inspiring long-term vision
|
||||
|
||||
**Suggested Next Steps**
|
||||
|
||||
- PRD workflow for detailed requirements?
|
||||
- UX design workflow for user experience planning?
|
||||
|
||||
**Product Brief Complete**"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- Since this is a completion step, no continuation to other workflow steps
|
||||
- User can ask questions or request review of the completed brief
|
||||
- Provide guidance on next workflow options when requested
|
||||
- End workflow session gracefully after completion confirmation
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- This is a final step with completion focus
|
||||
- No additional workflow steps to load after this
|
||||
- User can request review or clarification of completed brief
|
||||
- Provide clear guidance on next workflow options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [completion confirmation is provided and workflow status updated], will you then mark the workflow as complete and end the session gracefully. No additional steps are loaded after this final completion step.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Product brief contains all essential sections with collaborative content
|
||||
- All collaborative content properly saved to document with proper frontmatter
|
||||
- Workflow status file updated with completion information and timestamp
|
||||
- Clear next step guidance provided to user with specific workflow recommendations
|
||||
- Document quality validation completed with completeness and consistency checks
|
||||
- User acknowledges completion and understands next available options
|
||||
- Workflow properly marked as complete in status tracking
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not updating workflow status file with completion information
|
||||
- Missing clear next step guidance for user
|
||||
- Not confirming document completeness with user
|
||||
- Workflow not properly marked as complete in status tracking
|
||||
- User unclear about what happens next or available options
|
||||
- Document quality issues not identified or addressed
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
|
||||
## FINAL WORKFLOW COMPLETION
|
||||
|
||||
This product brief is now complete and serves as the strategic foundation for the entire product lifecycle. All subsequent design, architecture, and development work should trace back to the vision, user needs, and success criteria documented in this brief.
|
||||
|
||||
**Congratulations on completing the Product Brief for {{project_name}}!** 🎉
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
name: create-product-brief
|
||||
description: Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.
|
||||
web_bundle: true
|
||||
---
|
||||
|
||||
# Product Brief Workflow
|
||||
|
||||
**Goal:** Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.
|
||||
|
||||
**Your Role:** In addition to your name, communication_style, and persona, you are also a product-focused Business Analyst collaborating with an expert peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision. Work together as equals.
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **step-file architecture** for disciplined execution:
|
||||
|
||||
### Core Principles
|
||||
|
||||
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||
|
||||
### Step Processing Rules
|
||||
|
||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
|
||||
|
||||
### Critical Rules (NO EXCEPTIONS)
|
||||
|
||||
- 🛑 **NEVER** load multiple step files simultaneously
|
||||
- 📖 **ALWAYS** read entire step file before execution
|
||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||
- 📋 **NEVER** create mental todo lists from future steps
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION SEQUENCE
|
||||
|
||||
### 1. Configuration Loading
|
||||
|
||||
Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`, `communication_language`, `document_output_language`, `user_skill_level`
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
Load, read the full file and then execute `{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md` to begin the workflow.
|
||||
@@ -0,0 +1,137 @@
|
||||
# Domain Research Step 1: Domain Research Scope Confirmation
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present [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:
|
||||
|
||||
- Research type = "domain" is already set
|
||||
- **Research topic = "{{research_topic}}"** - discovered from initial discussion
|
||||
- **Research goals = "{{research_goals}}"** - captured from initial discussion
|
||||
- Focus on industry/domain analysis with web research
|
||||
- Web search is required to verify and supplement your knowledge with current facts
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Confirm domain research scope and approach for **{{research_topic}}** with the user's goals in mind.
|
||||
|
||||
## DOMAIN SCOPE CONFIRMATION:
|
||||
|
||||
### 1. Begin Scope Confirmation
|
||||
|
||||
Start with domain scope understanding:
|
||||
"I understand you want to conduct **domain research** for **{{research_topic}}** with these goals: {{research_goals}}
|
||||
|
||||
**Domain Research Scope:**
|
||||
|
||||
- **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
|
||||
|
||||
**Research Approach:**
|
||||
|
||||
- All claims verified against current public sources
|
||||
- Multi-source validation for critical domain claims
|
||||
- Confidence levels for uncertain domain information
|
||||
- Comprehensive domain coverage with industry-specific insights
|
||||
|
||||
### 2. Scope Confirmation
|
||||
|
||||
Present clear scope confirmation:
|
||||
"**Domain Research Scope Confirmation:**
|
||||
|
||||
For **{{research_topic}}**, I will research:
|
||||
|
||||
✅ **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
|
||||
|
||||
**All claims verified against current public sources.**
|
||||
|
||||
**Does this domain research scope and approach align with your goals?**
|
||||
[C] Continue - Begin domain research with this scope
|
||||
|
||||
### 3. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Document scope confirmation in research file
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Load: `./step-02-domain-analysis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
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:**
|
||||
|
||||
- All claims verified against current public sources
|
||||
- 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 confirmed with user
|
||||
✅ All domain analysis areas identified and explained
|
||||
✅ Research methodology emphasized
|
||||
✅ [C] continue option presented and handled correctly
|
||||
✅ Scope confirmation documented when user proceeds
|
||||
✅ Proper routing to next domain research step
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not clearly confirming domain research scope with user
|
||||
❌ Missing critical domain analysis areas
|
||||
❌ Not explaining that web search is required for current facts
|
||||
❌ Not presenting [C] continue option
|
||||
❌ Proceeding without user scope confirmation
|
||||
❌ Not routing to next domain research 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
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-02-domain-analysis.md` to begin industry analysis.
|
||||
|
||||
Remember: This is SCOPE CONFIRMATION ONLY - no actual domain research yet, just confirming the research approach and scope!
|
||||
@@ -0,0 +1,229 @@
|
||||
# Domain Research Step 2: Industry 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE AN INDUSTRY ANALYST, not content generator
|
||||
- 💬 FOCUS on market size, growth, and industry dynamics
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show web search analysis before presenting findings
|
||||
- ⚠️ 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 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 industry analysis focusing on market size, growth, and industry dynamics. Search the web to verify and supplement current facts.
|
||||
|
||||
## INDUSTRY ANALYSIS SEQUENCE:
|
||||
|
||||
### 1. Begin Industry Analysis
|
||||
|
||||
**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different industry areas simultaneously and thoroughly.
|
||||
|
||||
Start with industry research approach:
|
||||
"Now I'll conduct **industry analysis** for **{{research_topic}}** to understand market dynamics.
|
||||
|
||||
**Industry Analysis Focus:**
|
||||
|
||||
- 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 industry insights.**"
|
||||
|
||||
### 2. Parallel Industry Research Execution
|
||||
|
||||
**Execute multiple web searches simultaneously:**
|
||||
|
||||
Search the web: "{{research_topic}} market size value"
|
||||
Search the web: "{{research_topic}} market growth rate dynamics"
|
||||
Search the web: "{{research_topic}} market segmentation structure"
|
||||
Search the web: "{{research_topic}} industry trends evolution"
|
||||
|
||||
**Analysis approach:**
|
||||
|
||||
- Look for recent market research reports and industry analyses
|
||||
- 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 industry findings:
|
||||
|
||||
**Research Coverage:**
|
||||
|
||||
- Market size and valuation analysis
|
||||
- Growth rates and market dynamics
|
||||
- Market segmentation and structure
|
||||
- Industry trends and evolution patterns
|
||||
|
||||
**Cross-Industry Analysis:**
|
||||
[Identify patterns connecting market dynamics, segmentation, and trends]
|
||||
|
||||
**Quality Assessment:**
|
||||
[Overall confidence levels and research gaps identified]"
|
||||
|
||||
### 4. Generate Industry Analysis Content
|
||||
|
||||
**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 Analysis
|
||||
|
||||
### Market Size and Valuation
|
||||
|
||||
[Market size analysis with source citations]
|
||||
_Total Market Size: [Current market valuation]_
|
||||
_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]_
|
||||
|
||||
### Market Dynamics and Growth
|
||||
|
||||
[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]_
|
||||
|
||||
### Market Structure and Segmentation
|
||||
|
||||
[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]_
|
||||
|
||||
### Industry Trends and Evolution
|
||||
|
||||
[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]_
|
||||
|
||||
### Competitive Dynamics
|
||||
|
||||
[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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **industry analysis** for {{research_topic}}.
|
||||
|
||||
**Key Industry Findings:**
|
||||
|
||||
- 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):
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-03-competitive-landscape.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
Content is already written to document when generated in step 4. No additional append needed.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ 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
|
||||
✅ Proper routing to next step (competitive landscape)
|
||||
✅ Research goals alignment maintained
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying on training data instead of web search for current facts
|
||||
❌ 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
|
||||
❌ Not routing to competitive landscape 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
|
||||
|
||||
## INDUSTRY RESEARCH PROTOCOLS:
|
||||
|
||||
- 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
|
||||
- Search the web to verify facts
|
||||
- Present conflicting information when sources disagree
|
||||
- Apply confidence levels appropriately
|
||||
|
||||
## INDUSTRY ANALYSIS STANDARDS:
|
||||
|
||||
- Always cite URLs for web search results
|
||||
- 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', load `./step-03-competitive-landscape.md` to analyze competitive landscape, key players, and ecosystem analysis for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and search the web to verify facts!
|
||||
@@ -0,0 +1,238 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A COMPETITIVE ANALYST, not content generator
|
||||
- 💬 FOCUS on key players, market share, and competitive dynamics
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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. Search the web to verify and supplement current facts.
|
||||
|
||||
## 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}}** 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:**
|
||||
|
||||
Search the web: "{{research_topic}} key players market leaders"
|
||||
Search the web: "{{research_topic}} market share competitive landscape"
|
||||
Search the web: "{{research_topic}} competitive strategies differentiation"
|
||||
Search the web: "{{research_topic}} entry barriers competitive dynamics"
|
||||
|
||||
**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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **competitive landscape analysis** 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:
|
||||
|
||||
❌ Relying on training data instead of web search for current facts
|
||||
❌ 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
|
||||
- Search the web to verify facts
|
||||
- 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 search the web to verify facts!
|
||||
@@ -0,0 +1,206 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A REGULATORY ANALYST, not content generator
|
||||
- 💬 FOCUS on compliance requirements and regulatory landscape
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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, 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
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct focused regulatory and compliance analysis with emphasis on requirements that impact {{research_topic}}. Search the web to verify and supplement current facts.
|
||||
|
||||
## REGULATORY FOCUS SEQUENCE:
|
||||
|
||||
### 1. Begin Regulatory Analysis
|
||||
|
||||
Start with regulatory research approach:
|
||||
"Now I'll focus on **regulatory and compliance requirements** that impact **{{research_topic}}**.
|
||||
|
||||
**Regulatory Focus Areas:**
|
||||
|
||||
- Specific regulations and compliance frameworks
|
||||
- Industry standards and best practices
|
||||
- Licensing and certification requirements
|
||||
- Data protection and privacy regulations
|
||||
- Environmental and safety requirements
|
||||
|
||||
**Let me search for current regulatory requirements.**"
|
||||
|
||||
### 2. Web Search for Specific Regulations
|
||||
|
||||
Search for current regulatory information:
|
||||
Search the web: "{{research_topic}} regulations compliance requirements"
|
||||
|
||||
**Regulatory focus:**
|
||||
|
||||
- Specific regulations applicable to the domain
|
||||
- Compliance frameworks and standards
|
||||
- Recent regulatory changes or updates
|
||||
- Enforcement agencies and oversight bodies
|
||||
|
||||
### 3. Web Search for Industry Standards
|
||||
|
||||
Search for current industry standards:
|
||||
Search the web: "{{research_topic}} standards best practices"
|
||||
|
||||
**Standards focus:**
|
||||
|
||||
- Industry-specific technical standards
|
||||
- Best practices and guidelines
|
||||
- Certification requirements
|
||||
- Quality assurance frameworks
|
||||
|
||||
### 4. Web Search for Data Privacy Requirements
|
||||
|
||||
Search for current privacy regulations:
|
||||
Search the web: "data privacy regulations {{research_topic}}"
|
||||
|
||||
**Privacy focus:**
|
||||
|
||||
- GDPR, CCPA, and other data protection laws
|
||||
- Industry-specific privacy requirements
|
||||
- Data governance and security standards
|
||||
- User consent and data handling requirements
|
||||
|
||||
### 5. Generate Regulatory Analysis Content
|
||||
|
||||
Prepare regulatory content with source citations:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Regulatory Requirements
|
||||
|
||||
### Applicable Regulations
|
||||
|
||||
[Specific regulations analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Industry Standards and Best Practices
|
||||
|
||||
[Industry standards analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Compliance Frameworks
|
||||
|
||||
[Compliance frameworks analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Data Protection and Privacy
|
||||
|
||||
[Privacy requirements analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Licensing and Certification
|
||||
|
||||
[Licensing requirements analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Implementation Considerations
|
||||
|
||||
[Practical implementation considerations with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Risk Assessment
|
||||
|
||||
[Regulatory and compliance risk assessment]
|
||||
```
|
||||
|
||||
### 6. Present Analysis and Continue Option
|
||||
|
||||
Show the generated regulatory analysis and present continue option:
|
||||
"I've completed **regulatory requirements analysis** for {{research_topic}}.
|
||||
|
||||
**Key Regulatory Findings:**
|
||||
|
||||
- Specific regulations and frameworks identified
|
||||
- Industry standards and best practices mapped
|
||||
- Compliance requirements clearly documented
|
||||
- Implementation considerations provided
|
||||
- Risk assessment completed
|
||||
|
||||
**Ready to proceed to technical trends?**
|
||||
[C] Continue - Save this to the document and move to technical trends
|
||||
|
||||
### 7. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load: `./step-05-technical-trends.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
Content is already written to document when generated in step 5. No additional append needed.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Applicable regulations identified with current citations
|
||||
✅ Industry standards and best practices documented
|
||||
✅ Compliance frameworks clearly mapped
|
||||
✅ Data protection requirements analyzed
|
||||
✅ Implementation considerations provided
|
||||
✅ [C] continue option presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying on training data instead of web search for current facts
|
||||
❌ Missing critical regulatory requirements for the domain
|
||||
❌ Not providing implementation considerations for compliance
|
||||
❌ Not completing risk assessment for regulatory compliance
|
||||
❌ 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
|
||||
- Identify regulatory bodies and enforcement agencies
|
||||
- Research recent regulatory changes and updates
|
||||
- Map industry standards to regulatory requirements
|
||||
- Consider regional and jurisdictional differences
|
||||
|
||||
## SOURCE VERIFICATION:
|
||||
|
||||
- Always cite regulatory agency websites
|
||||
- Use official government and industry association sources
|
||||
- Note effective dates and implementation timelines
|
||||
- Present compliance requirement levels and obligations
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-technical-trends.md` to analyze technical trends and innovations in the domain.
|
||||
|
||||
Remember: Search the web to verify regulatory facts and provide practical implementation considerations!
|
||||
@@ -0,0 +1,234 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A TECHNOLOGY ANALYST, not content generator
|
||||
- 💬 FOCUS on emerging technologies and innovation patterns
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show web search analysis before presenting findings
|
||||
- ⚠️ 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
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct comprehensive technical trends analysis using current 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 conduct **technical trends and emerging technologies** analysis for **{{research_topic}}** using current data.
|
||||
|
||||
**Technical Trends Focus:**
|
||||
|
||||
- Emerging technologies and innovations
|
||||
- Digital transformation impacts
|
||||
- Automation and efficiency improvements
|
||||
- New business models enabled by technology
|
||||
- Future technology projections and roadmaps
|
||||
|
||||
**Let me search for current technology developments.**"
|
||||
|
||||
### 2. Web Search for Emerging Technologies
|
||||
|
||||
Search for current technology information:
|
||||
Search the web: "{{research_topic}} emerging technologies innovations"
|
||||
|
||||
**Technology focus:**
|
||||
|
||||
- AI, machine learning, and automation impacts
|
||||
- Digital transformation trends
|
||||
- New technologies disrupting the industry
|
||||
- Innovation patterns and breakthrough developments
|
||||
|
||||
### 3. Web Search for Digital Transformation
|
||||
|
||||
Search for current transformation trends:
|
||||
Search the web: "{{research_topic}} digital transformation trends"
|
||||
|
||||
**Transformation focus:**
|
||||
|
||||
- Digital adoption trends and rates
|
||||
- Business model evolution
|
||||
- Customer experience innovations
|
||||
- Operational efficiency improvements
|
||||
|
||||
### 4. Web Search for Future Outlook
|
||||
|
||||
Search for future projections:
|
||||
Search the web: "{{research_topic}} future outlook trends"
|
||||
|
||||
**Future focus:**
|
||||
|
||||
- Technology roadmaps and projections
|
||||
- Market evolution predictions
|
||||
- Innovation pipelines and R&D trends
|
||||
- Long-term industry transformation
|
||||
|
||||
### 5. Generate Technical Trends Content
|
||||
|
||||
**WRITE IMMEDIATELY TO DOCUMENT**
|
||||
|
||||
Prepare technical analysis with source citations:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Technical Trends and Innovation
|
||||
|
||||
### Emerging Technologies
|
||||
|
||||
[Emerging technologies analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Digital Transformation
|
||||
|
||||
[Digital transformation analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Innovation Patterns
|
||||
|
||||
[Innovation patterns analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Future Outlook
|
||||
|
||||
[Future outlook and projections with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Implementation Opportunities
|
||||
|
||||
[Implementation opportunity analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Challenges and Risks
|
||||
|
||||
[Challenges and risks assessment with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
## Recommendations
|
||||
|
||||
### Technology Adoption Strategy
|
||||
|
||||
[Technology adoption recommendations]
|
||||
|
||||
### Innovation Roadmap
|
||||
|
||||
[Innovation roadmap suggestions]
|
||||
|
||||
### Risk Mitigation
|
||||
|
||||
[Risk mitigation strategies]
|
||||
```
|
||||
|
||||
### 6. Present Analysis and Complete Option
|
||||
|
||||
Show the generated technical analysis and present complete option:
|
||||
"I've completed **technical trends and innovation analysis** for {{research_topic}}.
|
||||
|
||||
**Technical Highlights:**
|
||||
|
||||
- Emerging technologies and innovations identified
|
||||
- Digital transformation trends mapped
|
||||
- Future outlook and projections analyzed
|
||||
- Implementation opportunities and challenges documented
|
||||
- Practical recommendations provided
|
||||
|
||||
**Technical Trends Research Completed:**
|
||||
|
||||
- Emerging technologies and innovations identified
|
||||
- Digital transformation trends mapped
|
||||
- Future outlook and projections analyzed
|
||||
- Implementation opportunities and challenges documented
|
||||
|
||||
**Ready to proceed to research synthesis and recommendations?**
|
||||
[C] Continue - Save this to document and proceed to synthesis
|
||||
|
||||
### 7. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Load: `./step-06-research-synthesis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
Content is already written to document when generated in step 5. No additional append needed.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Emerging technologies identified with current data
|
||||
✅ Digital transformation trends clearly documented
|
||||
✅ Future outlook and projections analyzed
|
||||
✅ Implementation opportunities and challenges mapped
|
||||
✅ Strategic recommendations provided
|
||||
✅ 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:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
❌ Missing critical emerging technologies in the domain
|
||||
❌ Not providing practical implementation recommendations
|
||||
❌ Not completing strategic recommendations
|
||||
❌ 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
|
||||
- Identify disruption patterns and game-changers
|
||||
- Research technology adoption timelines and barriers
|
||||
- Consider regional technology variations
|
||||
- Analyze competitive technological advantages
|
||||
|
||||
## RESEARCH WORKFLOW COMPLETION:
|
||||
|
||||
When 'C' is selected:
|
||||
|
||||
- All domain research steps completed
|
||||
- Comprehensive research document generated
|
||||
- All sections appended with source citations
|
||||
- Research workflow status updated
|
||||
- Final recommendations provided to user
|
||||
|
||||
## NEXT STEPS:
|
||||
|
||||
Research workflow complete. User may:
|
||||
|
||||
- Use the domain research to inform other workflows (PRD, architecture, etc.)
|
||||
- Conduct additional research on specific topics if needed
|
||||
- Move forward with product development based on research insights
|
||||
|
||||
Congratulations on completing comprehensive domain research! 🎉
|
||||
@@ -0,0 +1,443 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A DOMAIN RESEARCH STRATEGIST, not content generator
|
||||
- 💬 FOCUS on comprehensive synthesis and authoritative conclusions
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📄 PRODUCE COMPREHENSIVE DOCUMENT with narrative intro, TOC, and summary
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 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, 6]` before completing workflow
|
||||
- 🚫 FORBIDDEN to complete workflow until C is selected
|
||||
- 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- **Research topic = "{{research_topic}}"** - comprehensive domain analysis
|
||||
- **Research goals = "{{research_goals}}"** - achieved through exhaustive research
|
||||
- All domain research sections have been completed (analysis, regulatory, technical)
|
||||
- Web search capabilities with source verification are enabled
|
||||
- This is the final synthesis step producing the complete research document
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Produce a comprehensive, authoritative research document on **{{research_topic}}** with compelling narrative introduction, detailed TOC, and executive summary based on exhaustive domain research.
|
||||
|
||||
## COMPREHENSIVE DOCUMENT SYNTHESIS:
|
||||
|
||||
### 1. Document Structure Planning
|
||||
|
||||
**Complete Research Document Structure:**
|
||||
|
||||
```markdown
|
||||
# [Compelling Title]: Comprehensive {{research_topic}} Research
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[Brief compelling overview of key findings and implications]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- Research Introduction and Methodology
|
||||
- Industry Overview and Market Dynamics
|
||||
- Technology Trends and Innovation Landscape
|
||||
- Regulatory Framework and Compliance Requirements
|
||||
- Competitive Landscape and Key Players
|
||||
- Strategic Insights and Recommendations
|
||||
- Implementation Considerations and Risk Assessment
|
||||
- Future Outlook and Strategic Opportunities
|
||||
- Research Methodology and Source Documentation
|
||||
- Appendices and Additional Resources
|
||||
```
|
||||
|
||||
### 2. Generate Compelling Narrative Introduction
|
||||
|
||||
**Introduction Requirements:**
|
||||
|
||||
- Hook reader with compelling opening about {{research_topic}}
|
||||
- Establish research significance and timeliness
|
||||
- Outline comprehensive research methodology
|
||||
- Preview key findings and strategic implications
|
||||
- Set professional, authoritative tone
|
||||
|
||||
**Web Search for Introduction Context:**
|
||||
Search the web: "{{research_topic}} significance importance"
|
||||
|
||||
### 3. Synthesize All Research Sections
|
||||
|
||||
**Section-by-Section Integration:**
|
||||
|
||||
- Combine industry analysis from step-02
|
||||
- Integrate regulatory focus from step-03
|
||||
- Incorporate technical trends from step-04
|
||||
- Add cross-sectional insights and connections
|
||||
- Ensure comprehensive coverage with no gaps
|
||||
|
||||
### 4. Generate Complete Document Content
|
||||
|
||||
#### Final Document Structure:
|
||||
|
||||
```markdown
|
||||
# [Compelling Title]: Comprehensive {{research_topic}} Domain Research
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[2-3 paragraph compelling summary of the most critical findings and strategic implications for {{research_topic}} based on comprehensive current research]
|
||||
|
||||
**Key Findings:**
|
||||
|
||||
- [Most significant market dynamics]
|
||||
- [Critical regulatory considerations]
|
||||
- [Important technology trends]
|
||||
- [Strategic implications]
|
||||
|
||||
**Strategic Recommendations:**
|
||||
|
||||
- [Top 3-5 actionable recommendations based on research]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. Research Introduction and Methodology
|
||||
2. {{research_topic}} Industry Overview and Market Dynamics
|
||||
3. Technology Landscape and Innovation Trends
|
||||
4. Regulatory Framework and Compliance Requirements
|
||||
5. Competitive Landscape and Ecosystem Analysis
|
||||
6. Strategic Insights and Domain Opportunities
|
||||
7. Implementation Considerations and Risk Assessment
|
||||
8. Future Outlook and Strategic Planning
|
||||
9. Research Methodology and Source Verification
|
||||
10. Appendices and Additional Resources
|
||||
|
||||
## 1. Research Introduction and Methodology
|
||||
|
||||
### Research Significance
|
||||
|
||||
[Compelling narrative about why {{research_topic}} research is critical right now]
|
||||
_Why this research matters now: [Strategic importance with current context]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Research Methodology
|
||||
|
||||
[Comprehensive description of research approach including:]
|
||||
|
||||
- **Research Scope**: [Comprehensive coverage areas]
|
||||
- **Data Sources**: [Authoritative sources and verification approach]
|
||||
- **Analysis Framework**: [Structured analysis methodology]
|
||||
- **Time Period**: [current focus and historical context]
|
||||
- **Geographic Coverage**: [Regional/global scope]
|
||||
|
||||
### Research Goals and Objectives
|
||||
|
||||
**Original Goals:** {{research_goals}}
|
||||
|
||||
**Achieved Objectives:**
|
||||
|
||||
- [Goal 1 achievement with supporting evidence]
|
||||
- [Goal 2 achievement with supporting evidence]
|
||||
- [Additional insights discovered during research]
|
||||
|
||||
## 2. {{research_topic}} Industry Overview and Market Dynamics
|
||||
|
||||
### Market Size and Growth Projections
|
||||
|
||||
[Comprehensive market analysis synthesized from step-02 with current data]
|
||||
_Market Size: [Current market valuation]_
|
||||
_Growth Rate: [CAGR and projections]_
|
||||
_Market Drivers: [Key growth factors]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Industry Structure and Value Chain
|
||||
|
||||
[Complete industry structure analysis]
|
||||
_Value Chain Components: [Detailed breakdown]_
|
||||
_Industry Segments: [Market segmentation analysis]_
|
||||
_Economic Impact: [Industry economic significance]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 3. Technology Landscape and Innovation Trends
|
||||
|
||||
### Current Technology Adoption
|
||||
|
||||
[Technology trends analysis from step-04 with current context]
|
||||
_Emerging Technologies: [Key technologies affecting {{research_topic}}]_
|
||||
_Adoption Patterns: [Technology adoption rates and patterns]_
|
||||
_Innovation Drivers: [Factors driving technology change]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Digital Transformation Impact
|
||||
|
||||
[Comprehensive analysis of technology's impact on {{research_topic}}]
|
||||
_Transformation Trends: [Major digital transformation patterns]_
|
||||
_Disruption Opportunities: [Technology-driven opportunities]_
|
||||
_Future Technology Outlook: [Emerging technologies and timelines]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 4. Regulatory Framework and Compliance Requirements
|
||||
|
||||
### Current Regulatory Landscape
|
||||
|
||||
[Regulatory analysis from step-03 with current updates]
|
||||
_Key Regulations: [Critical regulatory requirements]_
|
||||
_Compliance Standards: [Industry standards and best practices]_
|
||||
_Recent Changes: [current regulatory updates and implications]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Risk and Compliance Considerations
|
||||
|
||||
[Comprehensive risk assessment]
|
||||
_Compliance Risks: [Major regulatory and compliance risks]_
|
||||
_Risk Mitigation Strategies: [Approaches to manage regulatory risks]_
|
||||
_Future Regulatory Trends: [Anticipated regulatory developments]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 5. Competitive Landscape and Ecosystem Analysis
|
||||
|
||||
### Market Positioning and Key Players
|
||||
|
||||
[Competitive analysis with current market positioning]
|
||||
_Market Leaders: [Dominant players and strategies]_
|
||||
_Emerging Competitors: [New entrants and innovative approaches]_
|
||||
_Competitive Dynamics: [Market competition patterns and trends]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Ecosystem and Partnership Landscape
|
||||
|
||||
[Complete ecosystem analysis]
|
||||
_Ecosystem Players: [Key stakeholders and relationships]_
|
||||
_Partnership Opportunities: [Strategic collaboration potential]_
|
||||
_Supply Chain Dynamics: [Supply chain structure and risks]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 6. Strategic Insights and Domain Opportunities
|
||||
|
||||
### Cross-Domain Synthesis
|
||||
|
||||
[Strategic insights from integrating all research sections]
|
||||
_Market-Technology Convergence: [How technology and market forces interact]_
|
||||
_Regulatory-Strategic Alignment: [How regulatory environment shapes strategy]_
|
||||
_Competitive Positioning Opportunities: [Strategic advantages based on research]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Strategic Opportunities
|
||||
|
||||
[High-value opportunities identified through comprehensive research]
|
||||
_Market Opportunities: [Specific market entry or expansion opportunities]_
|
||||
_Technology Opportunities: [Technology adoption or innovation opportunities]_
|
||||
_Partnership Opportunities: [Strategic collaboration and partnership potential]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 7. Implementation Considerations and Risk Assessment
|
||||
|
||||
### Implementation Framework
|
||||
|
||||
[Practical implementation guidance based on research findings]
|
||||
_Implementation Timeline: [Recommended phased approach]_
|
||||
_Resource Requirements: [Key resources and capabilities needed]_
|
||||
_Success Factors: [Critical success factors for implementation]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Risk Management and Mitigation
|
||||
|
||||
[Comprehensive risk assessment and mitigation strategies]
|
||||
_Implementation Risks: [Major risks and mitigation approaches]_
|
||||
_Market Risks: [Market-related risks and contingency plans]_
|
||||
_Technology Risks: [Technology adoption and implementation risks]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 8. Future Outlook and Strategic Planning
|
||||
|
||||
### Future Trends and Projections
|
||||
|
||||
[Forward-looking analysis based on comprehensive research]
|
||||
_Near-term Outlook: [1-2 year projections and implications]_
|
||||
_Medium-term Trends: [3-5 year expected developments]_
|
||||
_Long-term Vision: [5+ year strategic outlook for {{research_topic}}]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Strategic Recommendations
|
||||
|
||||
[Comprehensive strategic recommendations]
|
||||
_Immediate Actions: [Priority actions for next 6 months]_
|
||||
_Strategic Initiatives: [Key strategic initiatives for 1-2 years]_
|
||||
_Long-term Strategy: [Strategic positioning for 3+ years]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 9. Research Methodology and Source Verification
|
||||
|
||||
### Comprehensive Source Documentation
|
||||
|
||||
[Complete documentation of all research sources]
|
||||
_Primary Sources: [Key authoritative sources used]_
|
||||
_Secondary Sources: [Supporting research and analysis]_
|
||||
_Web Search Queries: [Complete list of search queries used]_
|
||||
|
||||
### Research Quality Assurance
|
||||
|
||||
[Quality assurance and validation approach]
|
||||
_Source Verification: [All factual claims verified with multiple sources]_
|
||||
_Confidence Levels: [Confidence assessments for uncertain data]_
|
||||
_Limitations: [Research limitations and areas for further investigation]_
|
||||
_Methodology Transparency: [Complete transparency about research approach]_
|
||||
|
||||
## 10. Appendices and Additional Resources
|
||||
|
||||
### Detailed Data Tables
|
||||
|
||||
[Comprehensive data tables supporting research findings]
|
||||
_Market Data Tables: [Detailed market size, growth, and segmentation data]_
|
||||
_Technology Adoption Data: [Detailed technology adoption and trend data]_
|
||||
_Regulatory Reference Tables: [Complete regulatory requirements and compliance data]_
|
||||
|
||||
### Additional Resources
|
||||
|
||||
[Valuable resources for continued research and implementation]
|
||||
_Industry Associations: [Key industry organizations and resources]_
|
||||
_Research Organizations: [Authoritative research institutions and reports]_
|
||||
_Government Resources: [Regulatory agencies and official resources]_
|
||||
_Professional Networks: [Industry communities and knowledge sources]_
|
||||
|
||||
---
|
||||
|
||||
## Research Conclusion
|
||||
|
||||
### Summary of Key Findings
|
||||
|
||||
[Comprehensive summary of the most important research findings]
|
||||
|
||||
### Strategic Impact Assessment
|
||||
|
||||
[Assessment of strategic implications for {{research_topic}}]
|
||||
|
||||
### Next Steps Recommendations
|
||||
|
||||
[Specific next steps for leveraging this research]
|
||||
|
||||
---
|
||||
|
||||
**Research Completion Date:** {{date}}
|
||||
**Research Period:** Comprehensive analysis
|
||||
**Document Length:** As needed for comprehensive coverage
|
||||
**Source Verification:** All facts cited with sources
|
||||
**Confidence Level:** High - based on multiple authoritative sources
|
||||
|
||||
_This comprehensive research document serves as an authoritative reference on {{research_topic}} and provides strategic insights for informed decision-making._
|
||||
```
|
||||
|
||||
### 5. Present Complete Document and Final Option
|
||||
|
||||
**Document Completion Presentation:**
|
||||
|
||||
"I've completed the **comprehensive research document synthesis** for **{{research_topic}}**, producing an authoritative research document with:
|
||||
|
||||
**Document Features:**
|
||||
|
||||
- **Compelling Narrative Introduction**: Engaging opening that establishes research significance
|
||||
- **Comprehensive Table of Contents**: Complete navigation structure for easy reference
|
||||
- **Exhaustive Research Coverage**: All aspects of {{research_topic}} thoroughly analyzed
|
||||
- **Executive Summary**: Key findings and strategic implications highlighted
|
||||
- **Strategic Recommendations**: Actionable insights based on comprehensive research
|
||||
- **Complete Source Citations**: Every factual claim verified with sources
|
||||
|
||||
**Research Completeness:**
|
||||
|
||||
- Industry analysis and market dynamics fully documented
|
||||
- Technology trends and innovation landscape comprehensively covered
|
||||
- Regulatory framework and compliance requirements detailed
|
||||
- Competitive landscape and ecosystem analysis complete
|
||||
- Strategic insights and implementation guidance provided
|
||||
|
||||
**Document Standards Met:**
|
||||
|
||||
- Exhaustive research with no critical gaps
|
||||
- Professional structure and compelling narrative
|
||||
- As long as needed for comprehensive coverage
|
||||
- Multiple independent sources for all claims
|
||||
- Proper citations throughout
|
||||
|
||||
**Ready to complete this comprehensive research document?**
|
||||
[C] Complete Research - Save final comprehensive document
|
||||
|
||||
### 6. Handle Final Completion
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- Append the complete document to the research file
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Complete the domain research workflow
|
||||
- Provide final document delivery confirmation
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the complete comprehensive research document using the full structure above.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Compelling narrative introduction with research significance
|
||||
✅ Comprehensive table of contents with complete document structure
|
||||
✅ Exhaustive research coverage across all domain aspects
|
||||
✅ Executive summary with key findings and strategic implications
|
||||
✅ Strategic recommendations grounded in comprehensive research
|
||||
✅ Complete source verification with citations
|
||||
✅ Professional document structure and compelling narrative
|
||||
✅ [C] complete option presented and handled correctly
|
||||
✅ Domain research workflow completed with comprehensive document
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not producing compelling narrative introduction
|
||||
❌ Missing comprehensive table of contents
|
||||
❌ Incomplete research coverage across domain aspects
|
||||
❌ Not providing executive summary with key findings
|
||||
❌ Missing strategic recommendations based on research
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
❌ 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:
|
||||
|
||||
- Serves as an authoritative reference on {{research_topic}}
|
||||
- Provides compelling narrative and professional structure
|
||||
- Includes comprehensive coverage with no gaps
|
||||
- Maintains rigorous source verification standards
|
||||
- Delivers strategic insights and actionable recommendations
|
||||
- Meets professional research document quality standards
|
||||
|
||||
## DOMAIN RESEARCH WORKFLOW COMPLETION:
|
||||
|
||||
When 'C' is selected:
|
||||
|
||||
- All domain research steps completed (1-5)
|
||||
- Comprehensive domain research document generated
|
||||
- Professional document structure with intro, TOC, and summary
|
||||
- All sections appended with source citations
|
||||
- Domain research workflow status updated to complete
|
||||
- Final comprehensive research document delivered to user
|
||||
|
||||
## FINAL DELIVERABLE:
|
||||
|
||||
Complete authoritative research document on {{research_topic}} that:
|
||||
|
||||
- Establishes professional credibility through comprehensive research
|
||||
- Provides strategic insights for informed decision-making
|
||||
- Serves as reference document for continued use
|
||||
- Maintains highest research quality standards
|
||||
|
||||
Congratulations on completing comprehensive domain research! 🎉
|
||||
@@ -0,0 +1,182 @@
|
||||
# Market Research Step 1: Market Research Initialization
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 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
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from main workflow discovery are available
|
||||
- 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 scope clarification
|
||||
- Web search capabilities are enabled for later steps
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Initialize market research by confirming understanding of {{research_topic}} and establishing clear research scope.
|
||||
|
||||
## MARKET RESEARCH INITIALIZATION:
|
||||
|
||||
### 1. Confirm Research Understanding
|
||||
|
||||
**INITIALIZE - DO NOT RESEARCH YET**
|
||||
|
||||
Start with research confirmation:
|
||||
"I understand you want to conduct **market research** for **{{research_topic}}** with these goals: {{research_goals}}
|
||||
|
||||
**My Understanding of Your Research Needs:**
|
||||
|
||||
- **Research Topic**: {{research_topic}}
|
||||
- **Research Goals**: {{research_goals}}
|
||||
- **Research Type**: Market Research
|
||||
- **Approach**: Comprehensive market analysis with source verification
|
||||
|
||||
**Market Research Areas We'll Cover:**
|
||||
|
||||
- Market size, growth dynamics, and trends
|
||||
- Customer insights and behavior analysis
|
||||
- Competitive landscape and positioning
|
||||
- Strategic recommendations and implementation guidance
|
||||
|
||||
**Does this accurately capture what you're looking for?**"
|
||||
|
||||
### 2. Refine Research Scope
|
||||
|
||||
Gather any clarifications needed:
|
||||
|
||||
#### Scope Clarification Questions:
|
||||
|
||||
- "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?"
|
||||
|
||||
### 3. Document Initial Scope
|
||||
|
||||
**WRITE IMMEDIATELY TO DOCUMENT**
|
||||
|
||||
Write initial research scope to document:
|
||||
|
||||
```markdown
|
||||
# Market Research: {{research_topic}}
|
||||
|
||||
## Research Initialization
|
||||
|
||||
### Research Understanding Confirmed
|
||||
|
||||
**Topic**: {{research_topic}}
|
||||
**Goals**: {{research_goals}}
|
||||
**Research Type**: Market Research
|
||||
**Date**: {{date}}
|
||||
|
||||
### Research Scope
|
||||
|
||||
**Market Analysis Focus Areas:**
|
||||
|
||||
- Market size, growth projections, and dynamics
|
||||
- Customer segments, behavior patterns, and insights
|
||||
- Competitive landscape and positioning analysis
|
||||
- Strategic recommendations and implementation guidance
|
||||
|
||||
**Research Methodology:**
|
||||
|
||||
- Current web data with source verification
|
||||
- Multiple independent sources for critical claims
|
||||
- Confidence level assessment for uncertain data
|
||||
- Comprehensive coverage with no critical gaps
|
||||
|
||||
### Next Steps
|
||||
|
||||
**Research Workflow:**
|
||||
|
||||
1. ✅ Initialization and scope setting (current step)
|
||||
2. Customer Insights and Behavior Analysis
|
||||
3. Competitive Landscape Analysis
|
||||
4. Strategic Synthesis and Recommendations
|
||||
|
||||
**Research Status**: Scope confirmed, ready to proceed with detailed market analysis
|
||||
```
|
||||
|
||||
### 4. Present Confirmation and Continue Option
|
||||
|
||||
Show initial scope document and present continue option:
|
||||
"I've documented our understanding and initial scope for **{{research_topic}}** market research.
|
||||
|
||||
**What I've established:**
|
||||
|
||||
- Research topic and goals confirmed
|
||||
- Market analysis focus areas defined
|
||||
- Research methodology verification
|
||||
- Clear workflow progression
|
||||
|
||||
**Document Status:** Initial scope written to research file for your review
|
||||
|
||||
**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):
|
||||
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Add confirmation note to document: "Scope confirmed by user on {{date}}"
|
||||
- Load: `./step-02-customer-insights.md`
|
||||
|
||||
#### If 'Modify':
|
||||
|
||||
- Gather user changes to scope
|
||||
- Update document with modifications
|
||||
- Re-present updated scope for confirmation
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ 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
|
||||
✅ Document properly updated with scope confirmation
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ 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
|
||||
|
||||
## INITIALIZATION PRINCIPLES:
|
||||
|
||||
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 confirmation and scope finalization, load `./step-02-customer-insights.md` to begin detailed market research with customer insights analysis.
|
||||
|
||||
Remember: Init steps confirm understanding and scope, not generate research content!
|
||||
@@ -0,0 +1,237 @@
|
||||
# Market Research Step 2: Customer Behavior and Segments
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without web search verification
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A CUSTOMER BEHAVIOR ANALYST, not content generator
|
||||
- 💬 FOCUS on customer behavior patterns and demographic analysis
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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 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}}** 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:**
|
||||
|
||||
Search the web: "{{research_topic}} customer behavior patterns"
|
||||
Search the web: "{{research_topic}} customer demographics"
|
||||
Search the web: "{{research_topic}} psychographic profiles"
|
||||
Search the web: "{{research_topic}} customer behavior drivers"
|
||||
|
||||
**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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **customer behavior analysis** for {{research_topic}}, focusing on customer patterns.
|
||||
|
||||
**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 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:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ 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 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 customer data with rigorous source verification!
|
||||
@@ -0,0 +1,200 @@
|
||||
# Market Research Step 2: Customer Insights
|
||||
|
||||
## 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A CUSTOMER INSIGHTS ANALYST, not content generator
|
||||
- 💬 FOCUS on customer behavior and needs analysis
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show web search analysis before presenting findings
|
||||
- ⚠️ Present [C] continue option after customer insights content generation
|
||||
- 💾 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
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from step-01 are available
|
||||
- Focus on customer behavior and needs analysis
|
||||
- Web search capabilities with source verification are enabled
|
||||
- May need to search for current customer behavior trends
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct comprehensive customer insights analysis with emphasis on behavior patterns and needs.
|
||||
|
||||
## CUSTOMER INSIGHTS SEQUENCE:
|
||||
|
||||
### 1. Begin Customer Insights Analysis
|
||||
|
||||
**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different customer areas simultaneously and thoroughly
|
||||
|
||||
Start with customer research approach:
|
||||
"Now I'll conduct **customer insights analysis** to understand customer behavior and needs.
|
||||
|
||||
**Customer Insights Focus:**
|
||||
|
||||
- Customer behavior patterns and preferences
|
||||
- Pain points and challenges
|
||||
- Decision-making processes
|
||||
- Customer journey mapping
|
||||
- Customer satisfaction drivers
|
||||
- Demographic and psychographic profiles
|
||||
|
||||
**Let me search for current customer insights using parallel web searches for comprehensive coverage.**"
|
||||
|
||||
### 2. Parallel Customer Research Execution
|
||||
|
||||
**Execute multiple web searches simultaneously:**
|
||||
|
||||
Search the web: "[product/service/market] customer behavior patterns"
|
||||
Search the web: "[product/service/market] customer pain points challenges"
|
||||
Search the web: "[product/service/market] customer decision process"
|
||||
|
||||
**Analysis approach:**
|
||||
|
||||
- Look for customer behavior studies and surveys
|
||||
- Search for customer experience and interaction patterns
|
||||
- Research customer satisfaction methodologies
|
||||
- Note generational and cultural customer variations
|
||||
- Research customer pain points and frustrations
|
||||
- Analyze decision-making processes and criteria
|
||||
|
||||
### 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 customer insights:
|
||||
|
||||
**Research Coverage:**
|
||||
|
||||
- Customer behavior patterns and preferences
|
||||
- Pain points and challenges
|
||||
- Decision-making processes and journey mapping
|
||||
|
||||
**Cross-Customer Analysis:**
|
||||
[Identify patterns connecting behavior, pain points, and decisions]
|
||||
|
||||
**Quality Assessment:**
|
||||
[Overall confidence levels and research gaps identified]"
|
||||
|
||||
### 4. Generate Customer Insights Content
|
||||
|
||||
Prepare customer analysis with web search citations:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Customer Insights
|
||||
|
||||
### Customer Behavior Patterns
|
||||
|
||||
[Customer behavior analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Pain Points and Challenges
|
||||
|
||||
[Pain points analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Decision-Making Processes
|
||||
|
||||
[Decision-making analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Customer Journey Mapping
|
||||
|
||||
[Customer journey analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Customer Satisfaction Drivers
|
||||
|
||||
[Satisfaction drivers analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Demographic Profiles
|
||||
|
||||
[Demographic profiles analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Psychographic Profiles
|
||||
|
||||
[Psychographic profiles analysis with source citations]
|
||||
_Source: [URL]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
Show the generated customer insights and present continue option:
|
||||
"I've completed the **customer insights analysis** for customer behavior and needs.
|
||||
|
||||
**Key Customer Findings:**
|
||||
|
||||
- Customer behavior patterns clearly identified
|
||||
- Pain points and challenges thoroughly documented
|
||||
- Decision-making processes mapped
|
||||
- Customer journey insights captured
|
||||
- Satisfaction and profile data analyzed
|
||||
|
||||
**Ready to proceed to competitive analysis?**
|
||||
[C] Continue - Save this to the document and proceed to competitive analysis
|
||||
|
||||
### 6. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-05-competitive-analysis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 4.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Customer behavior patterns identified with current citations
|
||||
✅ Pain points and challenges clearly documented
|
||||
✅ Decision-making processes thoroughly analyzed
|
||||
✅ Customer journey insights captured and mapped
|
||||
✅ Customer satisfaction drivers identified
|
||||
✅ [C] continue option presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ Missing critical customer behavior patterns
|
||||
❌ Not identifying key pain points and challenges
|
||||
❌ Incomplete customer journey mapping
|
||||
❌ 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
|
||||
- Use market research firm and industry association sources
|
||||
- Research customer experience and interaction patterns
|
||||
- Note generational and cultural customer variations
|
||||
- Research customer satisfaction methodologies
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-competitive-analysis.md` to focus on competitive landscape analysis.
|
||||
|
||||
Remember: Always emphasize current customer data and rigorous source verification!
|
||||
@@ -0,0 +1,249 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A CUSTOMER NEEDS ANALYST, not content generator
|
||||
- 💬 FOCUS on customer pain points, challenges, and unmet needs
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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 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}}** 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:**
|
||||
|
||||
Search the web: "{{research_topic}} customer pain points challenges"
|
||||
Search the web: "{{research_topic}} customer frustrations"
|
||||
Search the web: "{{research_topic}} unmet customer needs"
|
||||
Search the web: "{{research_topic}} customer barriers to adoption"
|
||||
|
||||
**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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **customer pain points analysis** for {{research_topic}}, focusing on customer challenges.
|
||||
|
||||
**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:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ 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 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 customer pain points data with rigorous source verification!
|
||||
@@ -0,0 +1,259 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A CUSTOMER DECISION ANALYST, not content generator
|
||||
- 💬 FOCUS on customer decision processes and journey mapping
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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 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}}** 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:**
|
||||
|
||||
Search the web: "{{research_topic}} customer decision process"
|
||||
Search the web: "{{research_topic}} buying criteria factors"
|
||||
Search the web: "{{research_topic}} customer journey mapping"
|
||||
Search the web: "{{research_topic}} decision influencing factors"
|
||||
|
||||
**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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **customer decision processes analysis** for {{research_topic}}, focusing on customer decision-making.
|
||||
|
||||
**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:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ 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 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 customer decision data with rigorous source verification!
|
||||
@@ -0,0 +1,177 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A COMPETITIVE ANALYST, not content generator
|
||||
- 💬 FOCUS on competitive landscape and market positioning
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 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, 4, 5]` before completing workflow
|
||||
- 🚫 FORBIDDEN to complete workflow until C is selected
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Focus on competitive landscape and market positioning analysis
|
||||
- Web search capabilities with source verification are enabled
|
||||
- May need to search for specific competitor information
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct comprehensive competitive analysis with emphasis on market positioning.
|
||||
|
||||
## COMPETITIVE ANALYSIS SEQUENCE:
|
||||
|
||||
### 1. Begin Competitive Analysis
|
||||
|
||||
Start with competitive research approach:
|
||||
"Now I'll conduct **competitive analysis** to understand the competitive landscape.
|
||||
|
||||
**Competitive Analysis Focus:**
|
||||
|
||||
- Key players and market share
|
||||
- Competitive positioning strategies
|
||||
- Strengths and weaknesses analysis
|
||||
- Market differentiation opportunities
|
||||
- Competitive threats and challenges
|
||||
|
||||
**Let me search for current competitive information.**"
|
||||
|
||||
### 2. Generate Competitive Analysis Content
|
||||
|
||||
Prepare competitive analysis with web search citations:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Competitive Landscape
|
||||
|
||||
### Key Market Players
|
||||
|
||||
[Key players analysis with market share data]
|
||||
_Source: [URL]_
|
||||
|
||||
### Market Share Analysis
|
||||
|
||||
[Market share analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Competitive Positioning
|
||||
|
||||
[Positioning analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Strengths and Weaknesses
|
||||
|
||||
[SWOT analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Market Differentiation
|
||||
|
||||
[Differentiation analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Competitive Threats
|
||||
|
||||
[Threats analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Opportunities
|
||||
|
||||
[Competitive opportunities analysis with source citations]
|
||||
_Source: [URL]_
|
||||
```
|
||||
|
||||
### 3. Present Analysis and Complete Option
|
||||
|
||||
Show the generated competitive analysis and present complete option:
|
||||
"I've completed the **competitive analysis** for the competitive landscape.
|
||||
|
||||
**Key Competitive Findings:**
|
||||
|
||||
- Key market players and market share identified
|
||||
- Competitive positioning strategies mapped
|
||||
- Strengths and weaknesses thoroughly analyzed
|
||||
- Market differentiation opportunities identified
|
||||
- Competitive threats and challenges documented
|
||||
|
||||
**Ready to complete the market research?**
|
||||
[C] Complete Research - Save final document and conclude
|
||||
|
||||
### 4. Handle Complete Selection
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Complete the market research workflow
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 2.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Key market players identified
|
||||
✅ Market share analysis completed with source verification
|
||||
✅ Competitive positioning strategies clearly mapped
|
||||
✅ Strengths and weaknesses thoroughly analyzed
|
||||
✅ Market differentiation opportunities identified
|
||||
✅ [C] complete option presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
✅ Market research workflow completed successfully
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ Missing key market players or market share data
|
||||
❌ Incomplete competitive positioning analysis
|
||||
❌ Not identifying market differentiation opportunities
|
||||
❌ 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
|
||||
- Use competitor company websites and annual reports
|
||||
- Research market research firm competitive analyses
|
||||
- Note competitive advantages and disadvantages
|
||||
- Search for recent market developments and disruptions
|
||||
|
||||
## MARKET RESEARCH COMPLETION:
|
||||
|
||||
When 'C' is selected:
|
||||
|
||||
- All market research steps completed
|
||||
- Comprehensive market research document generated
|
||||
- All sections appended with source citations
|
||||
- Market research workflow status updated
|
||||
- Final recommendations provided to user
|
||||
|
||||
## NEXT STEPS:
|
||||
|
||||
Market research workflow complete. User may:
|
||||
|
||||
- Use market research to inform product development strategies
|
||||
- Conduct additional competitive research on specific companies
|
||||
- Combine market research with other research types for comprehensive insights
|
||||
|
||||
Congratulations on completing comprehensive market research! 🎉
|
||||
@@ -0,0 +1,475 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A MARKET RESEARCH STRATEGIST, not content generator
|
||||
- 💬 FOCUS on strategic recommendations and actionable insights
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 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, 5, 6]` before completing workflow
|
||||
- 🚫 FORBIDDEN to complete workflow until C is selected
|
||||
- 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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 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
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Produce a comprehensive, authoritative market research document on **{{research_topic}}** with compelling narrative introduction, detailed TOC, and executive summary based on exhaustive market research.
|
||||
|
||||
## MARKET RESEARCH COMPLETION SEQUENCE:
|
||||
|
||||
### 1. Begin Strategic Synthesis
|
||||
|
||||
Start with strategic synthesis approach:
|
||||
"Now I'll complete our market research with **strategic synthesis and recommendations** .
|
||||
|
||||
**Strategic Synthesis Focus:**
|
||||
|
||||
- Integrated insights from market, customer, and competitive analysis
|
||||
- Strategic recommendations based on research findings
|
||||
- Market entry or expansion strategies
|
||||
- Risk assessment and mitigation approaches
|
||||
- Actionable next steps and implementation guidance
|
||||
|
||||
**Let me search for current strategic insights and best practices.**"
|
||||
|
||||
### 2. Web Search for Market Entry Strategies
|
||||
|
||||
Search for current market strategies:
|
||||
Search the web: "market entry strategies best practices"
|
||||
|
||||
**Strategy focus:**
|
||||
|
||||
- Market entry timing and approaches
|
||||
- Go-to-market strategies and frameworks
|
||||
- Market positioning and differentiation tactics
|
||||
- Customer acquisition and growth strategies
|
||||
|
||||
### 3. Web Search for Risk Assessment
|
||||
|
||||
Search for current risk approaches:
|
||||
Search the web: "market research risk assessment frameworks"
|
||||
|
||||
**Risk focus:**
|
||||
|
||||
- Market risks and uncertainty management
|
||||
- Competitive threats and mitigation strategies
|
||||
- Regulatory and compliance risks
|
||||
- Economic and market volatility considerations
|
||||
|
||||
### 4. Generate Complete Market Research Document
|
||||
|
||||
Prepare comprehensive market research document with full structure:
|
||||
|
||||
#### Complete Document Structure:
|
||||
|
||||
```markdown
|
||||
# [Compelling Title]: Comprehensive {{research_topic}} Market Research
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[Brief compelling overview of key market findings and strategic implications]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- Market Research Introduction and Methodology
|
||||
- {{research_topic}} Market Analysis and Dynamics
|
||||
- Customer Insights and Behavior Analysis
|
||||
- Competitive Landscape and Positioning
|
||||
- Strategic Market Recommendations
|
||||
- Market Entry and Growth Strategies
|
||||
- Risk Assessment and Mitigation
|
||||
- Implementation Roadmap and Success Metrics
|
||||
- Future Market Outlook and Opportunities
|
||||
- Market Research Methodology and Source Documentation
|
||||
- Market Research Appendices and Additional Resources
|
||||
|
||||
## 1. Market Research Introduction and Methodology
|
||||
|
||||
### Market Research Significance
|
||||
|
||||
**Compelling market narrative about why {{research_topic}} research is critical now**
|
||||
_Market Importance: [Strategic market significance with up-to-date context]_
|
||||
_Business Impact: [Business implications of market research]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Market Research Methodology
|
||||
|
||||
[Comprehensive description of market research approach including:]
|
||||
|
||||
- **Market Scope**: [Comprehensive market coverage areas]
|
||||
- **Data Sources**: [Authoritative market sources and verification approach]
|
||||
- **Analysis Framework**: [Structured market analysis methodology]
|
||||
- **Time Period**: [current focus and market evolution context]
|
||||
- **Geographic Coverage**: [Regional/global market scope]
|
||||
|
||||
### Market Research Goals and Objectives
|
||||
|
||||
**Original Market Goals:** {{research_goals}}
|
||||
|
||||
**Achieved Market Objectives:**
|
||||
|
||||
- [Market Goal 1 achievement with supporting evidence]
|
||||
- [Market Goal 2 achievement with supporting evidence]
|
||||
- [Additional market insights discovered during research]
|
||||
|
||||
## 2. {{research_topic}} Market Analysis and Dynamics
|
||||
|
||||
### Market Size and Growth Projections
|
||||
|
||||
_[Comprehensive market analysis]_
|
||||
_Market Size: [Current market valuation and size]_
|
||||
_Growth Rate: [CAGR and market growth projections]_
|
||||
_Market Drivers: [Key factors driving market growth]_
|
||||
_Market Segments: [Detailed market segmentation analysis]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Market Trends and Dynamics
|
||||
|
||||
[Current market trends analysis]
|
||||
_Emerging Trends: [Key market trends and their implications]_
|
||||
_Market Dynamics: [Forces shaping market evolution]_
|
||||
_Consumer Behavior Shifts: [Changes in customer behavior and preferences]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Pricing and Business Model Analysis
|
||||
|
||||
[Comprehensive pricing and business model analysis]
|
||||
_Pricing Strategies: [Current pricing approaches and models]_
|
||||
_Business Model Evolution: [Emerging and successful business models]_
|
||||
_Value Proposition Analysis: [Customer value proposition assessment]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 3. Customer Insights and Behavior Analysis
|
||||
|
||||
### Customer Behavior Patterns
|
||||
|
||||
[Customer insights analysis with current context]
|
||||
_Behavior Patterns: [Key customer behavior trends and patterns]_
|
||||
_Customer Journey: [Complete customer journey mapping]_
|
||||
_Decision Factors: [Factors influencing customer decisions]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Customer Pain Points and Needs
|
||||
|
||||
[Comprehensive customer pain point analysis]
|
||||
_Pain Points: [Key customer challenges and frustrations]_
|
||||
_Unmet Needs: [Unsolved customer needs and opportunities]_
|
||||
_Customer Expectations: [Current customer expectations and requirements]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Customer Segmentation and Targeting
|
||||
|
||||
[Detailed customer segmentation analysis]
|
||||
_Customer Segments: [Detailed customer segment profiles]_
|
||||
_Target Market Analysis: [Most attractive customer segments]_
|
||||
_Segment-specific Strategies: [Tailored approaches for key segments]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 4. Competitive Landscape and Positioning
|
||||
|
||||
### Competitive Analysis
|
||||
|
||||
[Comprehensive competitive analysis]
|
||||
_Market Leaders: [Dominant competitors and their strategies]_
|
||||
_Emerging Competitors: [New entrants and innovative approaches]_
|
||||
_Competitive Advantages: [Key differentiators and competitive advantages]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Market Positioning Strategies
|
||||
|
||||
[Strategic positioning analysis]
|
||||
_Positioning Opportunities: [Opportunities for market differentiation]_
|
||||
_Competitive Gaps: [Unserved market needs and opportunities]_
|
||||
_Positioning Framework: [Recommended positioning approach]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 5. Strategic Market Recommendations
|
||||
|
||||
### Market Opportunity Assessment
|
||||
|
||||
[Strategic market opportunities analysis]
|
||||
_High-Value Opportunities: [Most attractive market opportunities]_
|
||||
_Market Entry Timing: [Optimal timing for market entry or expansion]_
|
||||
_Growth Strategies: [Recommended approaches for market growth]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Strategic Recommendations
|
||||
|
||||
[Comprehensive strategic recommendations]
|
||||
_Market Entry Strategy: [Recommended approach for market entry/expansion]_
|
||||
_Competitive Strategy: [Recommended competitive positioning and approach]_
|
||||
_Customer Acquisition Strategy: [Recommended customer acquisition approach]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 6. Market Entry and Growth Strategies
|
||||
|
||||
### Go-to-Market Strategy
|
||||
|
||||
[Comprehensive go-to-market approach]
|
||||
_Market Entry Approach: [Recommended market entry strategy and tactics]_
|
||||
_Channel Strategy: [Optimal channels for market reach and customer acquisition]_
|
||||
_Partnership Strategy: [Strategic partnership and collaboration opportunities]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Growth and Scaling Strategy
|
||||
|
||||
[Market growth and scaling analysis]
|
||||
_Growth Phases: [Recommended phased approach to market growth]_
|
||||
_Scaling Considerations: [Key factors for successful market scaling]_
|
||||
_Expansion Opportunities: [Opportunities for geographic or segment expansion]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 7. Risk Assessment and Mitigation
|
||||
|
||||
### Market Risk Analysis
|
||||
|
||||
[Comprehensive market risk assessment]
|
||||
_Market Risks: [Key market-related risks and uncertainties]_
|
||||
_Competitive Risks: [Competitive threats and mitigation strategies]_
|
||||
_Regulatory Risks: [Regulatory and compliance considerations]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Mitigation Strategies
|
||||
|
||||
[Risk mitigation and contingency planning]
|
||||
_Risk Mitigation Approaches: [Strategies for managing identified risks]_
|
||||
_Contingency Planning: [Backup plans and alternative approaches]_
|
||||
_Market Sensitivity Analysis: [Impact of market changes on strategy]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 8. Implementation Roadmap and Success Metrics
|
||||
|
||||
### Implementation Framework
|
||||
|
||||
[Comprehensive implementation guidance]
|
||||
_Implementation Timeline: [Recommended phased implementation approach]_
|
||||
_Required Resources: [Key resources and capabilities needed]_
|
||||
_Implementation Milestones: [Key milestones and success criteria]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Success Metrics and KPIs
|
||||
|
||||
[Comprehensive success measurement framework]
|
||||
_Key Performance Indicators: [Critical metrics for measuring success]_
|
||||
_Monitoring and Reporting: [Approach for tracking and reporting progress]_
|
||||
_Success Criteria: [Clear criteria for determining success]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 9. Future Market Outlook and Opportunities
|
||||
|
||||
### Future Market Trends
|
||||
|
||||
[Forward-looking market analysis]
|
||||
_Near-term Market Evolution: [1-2 year market development expectations]_
|
||||
_Medium-term Market Trends: [3-5 year expected market developments]_
|
||||
_Long-term Market Vision: [5+ year market outlook for {{research_topic}}]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Strategic Opportunities
|
||||
|
||||
[Market opportunity analysis and recommendations]
|
||||
_Emerging Opportunities: [New market opportunities and their potential]_
|
||||
_Innovation Opportunities: [Areas for market innovation and differentiation]_
|
||||
_Strategic Market Investments: [Recommended market investments and priorities]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 10. Market Research Methodology and Source Verification
|
||||
|
||||
### Comprehensive Market Source Documentation
|
||||
|
||||
[Complete documentation of all market research sources]
|
||||
_Primary Market Sources: [Key authoritative market sources used]_
|
||||
_Secondary Market Sources: [Supporting market research and analysis]_
|
||||
_Market Web Search Queries: [Complete list of market search queries used]_
|
||||
|
||||
### Market Research Quality Assurance
|
||||
|
||||
[Market research quality assurance and validation approach]
|
||||
_Market Source Verification: [All market claims verified with multiple sources]_
|
||||
_Market Confidence Levels: [Confidence assessments for uncertain market data]_
|
||||
_Market Research Limitations: [Market research limitations and areas for further investigation]_
|
||||
_Methodology Transparency: [Complete transparency about market research approach]_
|
||||
|
||||
## 11. Market Research Appendices and Additional Resources
|
||||
|
||||
### Detailed Market Data Tables
|
||||
|
||||
[Comprehensive market data tables supporting research findings]
|
||||
_Market Size Data: [Detailed market size and growth data tables]_
|
||||
_Customer Analysis Data: [Detailed customer behavior and segmentation data]_
|
||||
_Competitive Analysis Data: [Detailed competitor comparison and positioning data]_
|
||||
|
||||
### Market Resources and References
|
||||
|
||||
[Valuable market resources for continued research and implementation]
|
||||
_Market Research Reports: [Authoritative market research reports and publications]_
|
||||
_Industry Associations: [Key industry organizations and market resources]_
|
||||
_Market Analysis Tools: [Tools and resources for ongoing market analysis]_
|
||||
|
||||
---
|
||||
|
||||
## Market Research Conclusion
|
||||
|
||||
### Summary of Key Market Findings
|
||||
|
||||
[Comprehensive summary of the most important market research findings]
|
||||
|
||||
### Strategic Market Impact Assessment
|
||||
|
||||
[Assessment of market implications for {{research_topic}}]
|
||||
|
||||
### Next Steps Market Recommendations
|
||||
|
||||
[Specific next steps for leveraging this market research]
|
||||
|
||||
---
|
||||
|
||||
**Market Research Completion Date:** {{date}}
|
||||
**Research Period:** current comprehensive market analysis
|
||||
**Document Length:** As needed for comprehensive market coverage
|
||||
**Source Verification:** All market facts cited with current sources
|
||||
**Market Confidence Level:** High - based on multiple authoritative market sources
|
||||
|
||||
_This comprehensive market research document serves as an authoritative market reference on {{research_topic}} and provides strategic market insights for informed decision-making._
|
||||
```
|
||||
|
||||
### 5. Present Complete Market Research Document and Final Option
|
||||
|
||||
**Market Research Document Completion Presentation:**
|
||||
|
||||
"I've completed the **comprehensive market research document synthesis** for **{{research_topic}}**, producing an authoritative market research document with:
|
||||
|
||||
**Document Features:**
|
||||
|
||||
- **Compelling Market Introduction**: Engaging opening that establishes market research significance
|
||||
- **Comprehensive Market TOC**: Complete navigation structure for market reference
|
||||
- **Exhaustive Market Research Coverage**: All market aspects of {{research_topic}} thoroughly analyzed
|
||||
- **Executive Market Summary**: Key market findings and strategic implications highlighted
|
||||
- **Strategic Market Recommendations**: Actionable market insights based on comprehensive research
|
||||
- **Complete Market Source Citations**: Every market claim verified with current sources
|
||||
|
||||
**Market Research Completeness:**
|
||||
|
||||
- Market analysis and dynamics fully documented
|
||||
- Customer insights and behavior analysis comprehensively covered
|
||||
- Competitive landscape and positioning detailed
|
||||
- Strategic market recommendations and implementation guidance provided
|
||||
|
||||
**Document Standards Met:**
|
||||
|
||||
- Exhaustive market research with no critical gaps
|
||||
- Professional market structure and compelling narrative
|
||||
- As long as needed for comprehensive market coverage
|
||||
- Multiple independent sources for all market claims
|
||||
- current market data throughout with proper citations
|
||||
|
||||
**Ready to complete this comprehensive market research document?**
|
||||
[C] Complete Research - Save final comprehensive market research document
|
||||
|
||||
### 6. Handle Complete Selection
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Complete the market research workflow
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 4.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Compelling market introduction with research significance
|
||||
✅ Comprehensive market table of contents with complete document structure
|
||||
✅ Exhaustive market research coverage across all market aspects
|
||||
✅ Executive market summary with key findings and strategic implications
|
||||
✅ Strategic market recommendations grounded in comprehensive research
|
||||
✅ Complete market source verification with current citations
|
||||
✅ Professional market document structure and compelling narrative
|
||||
✅ [C] complete option presented and handled correctly
|
||||
✅ Market research workflow completed with comprehensive document
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not producing compelling market introduction
|
||||
❌ Missing comprehensive market table of contents
|
||||
❌ Incomplete market research coverage across market aspects
|
||||
❌ Not providing executive market summary with key findings
|
||||
❌ Missing strategic market recommendations based on research
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
❌ 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
|
||||
- Research successful market entry cases and approaches
|
||||
- Identify risk management methodologies and frameworks
|
||||
- Research implementation planning and execution strategies
|
||||
- Consider market timing and readiness factors
|
||||
|
||||
## COMPREHENSIVE MARKET DOCUMENT STANDARDS:
|
||||
|
||||
This step ensures the final market research document:
|
||||
|
||||
- Serves as an authoritative market reference on {{research_topic}}
|
||||
- Provides strategic market insights for informed decision-making
|
||||
- Includes comprehensive market coverage with no gaps
|
||||
- Maintains rigorous market source verification standards
|
||||
- Delivers strategic market insights and actionable recommendations
|
||||
- Meets professional market research document quality standards
|
||||
|
||||
## MARKET RESEARCH WORKFLOW COMPLETION:
|
||||
|
||||
When 'C' is selected:
|
||||
|
||||
- All market research steps completed (1-4)
|
||||
- Comprehensive market research document generated
|
||||
- Professional market document structure with intro, TOC, and summary
|
||||
- All market sections appended with source citations
|
||||
- Market research workflow status updated to complete
|
||||
- Final comprehensive market research document delivered to user
|
||||
|
||||
## FINAL MARKET DELIVERABLE:
|
||||
|
||||
Complete authoritative market research document on {{research_topic}} that:
|
||||
|
||||
- Establishes professional market credibility through comprehensive research
|
||||
- Provides strategic market insights for informed decision-making
|
||||
- Serves as market reference document for continued use
|
||||
- Maintains highest market research quality standards with current verification
|
||||
|
||||
## NEXT STEPS:
|
||||
|
||||
Comprehensive market research workflow complete. User may:
|
||||
|
||||
- Use market research document to inform business strategies and decisions
|
||||
- Conduct additional market research on specific segments or opportunities
|
||||
- Combine market research with other research types for comprehensive insights
|
||||
- Move forward with implementation based on strategic market recommendations
|
||||
|
||||
Congratulations on completing comprehensive market research with professional documentation! 🎉
|
||||
29
_bmad/bmm/workflows/1-analysis/research/research.template.md
Normal file
29
_bmad/bmm/workflows/1-analysis/research/research.template.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
workflowType: 'research'
|
||||
lastStep: 1
|
||||
research_type: '{{research_type}}'
|
||||
research_topic: '{{research_topic}}'
|
||||
research_goals: '{{research_goals}}'
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
web_research_enabled: true
|
||||
source_verification: true
|
||||
---
|
||||
|
||||
# Research Report: {{research_type}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
**Research Type:** {{research_type}}
|
||||
|
||||
---
|
||||
|
||||
## Research Overview
|
||||
|
||||
[Research overview and methodology will be appended here]
|
||||
|
||||
---
|
||||
|
||||
<!-- Content will be appended sequentially through research workflow steps -->
|
||||
@@ -0,0 +1,137 @@
|
||||
# Technical Research Step 1: Technical Research Scope Confirmation
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present [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:
|
||||
|
||||
- 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 architecture and implementation research
|
||||
- Web search is required to verify and supplement your knowledge with current facts
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Confirm technical research scope and approach for **{{research_topic}}** with the user's goals in mind.
|
||||
|
||||
## TECHNICAL SCOPE CONFIRMATION:
|
||||
|
||||
### 1. Begin Scope Confirmation
|
||||
|
||||
Start with technical scope understanding:
|
||||
"I understand you want to conduct **technical research** for **{{research_topic}}** with these goals: {{research_goals}}
|
||||
|
||||
**Technical Research Scope:**
|
||||
|
||||
- **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
|
||||
|
||||
**Research Approach:**
|
||||
|
||||
- Current 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. Scope Confirmation
|
||||
|
||||
Present clear scope confirmation:
|
||||
"**Technical Research Scope Confirmation:**
|
||||
|
||||
For **{{research_topic}}**, I will research:
|
||||
|
||||
✅ **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
|
||||
|
||||
**All claims verified against current public sources.**
|
||||
|
||||
**Does this technical research scope and approach align with your goals?**
|
||||
[C] Continue - Begin technical research with this scope
|
||||
|
||||
### 3. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Document scope confirmation in research file
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Load: `./step-02-technical-overview.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
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 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:
|
||||
|
||||
✅ Technical research scope clearly confirmed with user
|
||||
✅ All technical analysis areas identified and explained
|
||||
✅ Research methodology emphasized
|
||||
✅ [C] continue option presented and handled correctly
|
||||
✅ Scope confirmation documented when user proceeds
|
||||
✅ Proper routing to next technical research step
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not clearly confirming technical research scope with user
|
||||
❌ Missing critical technical analysis areas
|
||||
❌ Not explaining that web search is required for current facts
|
||||
❌ Not presenting [C] continue option
|
||||
❌ Proceeding without user scope confirmation
|
||||
❌ Not routing to next technical research 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
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-02-technical-overview.md` to begin technology stack analysis.
|
||||
|
||||
Remember: This is SCOPE CONFIRMATION ONLY - no actual technical research yet, just confirming the research approach and scope!
|
||||
@@ -0,0 +1,239 @@
|
||||
# Technical Research Step 2: Technology Stack 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A TECHNOLOGY STACK ANALYST, not content generator
|
||||
- 💬 FOCUS on languages, frameworks, tools, and platforms
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show web search analysis before presenting findings
|
||||
- ⚠️ 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
|
||||
- **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
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct technology stack analysis focusing on languages, frameworks, tools, and platforms. Search the web to verify and supplement current facts.
|
||||
|
||||
## TECHNOLOGY STACK ANALYSIS SEQUENCE:
|
||||
|
||||
### 1. Begin Technology Stack Analysis
|
||||
|
||||
**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 technology stack research approach:
|
||||
"Now I'll conduct **technology stack analysis** for **{{research_topic}}** to understand the technology landscape.
|
||||
|
||||
**Technology Stack Focus:**
|
||||
|
||||
- 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 technology stack insights.**"
|
||||
|
||||
### 2. Parallel Technology Stack Research Execution
|
||||
|
||||
**Execute multiple web searches simultaneously:**
|
||||
|
||||
Search the web: "{{research_topic}} programming languages frameworks"
|
||||
Search the web: "{{research_topic}} development tools platforms"
|
||||
Search the web: "{{research_topic}} database storage technologies"
|
||||
Search the web: "{{research_topic}} cloud infrastructure platforms"
|
||||
|
||||
**Analysis approach:**
|
||||
|
||||
- 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 technology stack findings:
|
||||
|
||||
**Research Coverage:**
|
||||
|
||||
- Programming languages and frameworks analysis
|
||||
- Development tools and platforms evaluation
|
||||
- Database and storage technologies assessment
|
||||
- Cloud infrastructure and deployment platform analysis
|
||||
|
||||
**Cross-Technology Analysis:**
|
||||
[Identify patterns connecting language choices, frameworks, and platform decisions]
|
||||
|
||||
**Quality Assessment:**
|
||||
[Overall confidence levels and research gaps identified]"
|
||||
|
||||
### 4. Generate Technology Stack Content
|
||||
|
||||
**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
|
||||
## Technology Stack Analysis
|
||||
|
||||
### Programming Languages
|
||||
|
||||
[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]_
|
||||
|
||||
### Development Frameworks and Libraries
|
||||
|
||||
[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]_
|
||||
|
||||
### Database and Storage Technologies
|
||||
|
||||
[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]_
|
||||
|
||||
### Development Tools and Platforms
|
||||
|
||||
[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]_
|
||||
|
||||
### Cloud Infrastructure and Deployment
|
||||
|
||||
[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]_
|
||||
|
||||
### Technology Adoption Trends
|
||||
|
||||
[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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **technology stack analysis** of the technology landscape for {{research_topic}}.
|
||||
|
||||
**Key Technology Stack Findings:**
|
||||
|
||||
- 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):
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-03-integration-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
Content is already written to document when generated in step 4. No additional append needed.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ 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
|
||||
✅ Proper routing to next step (integration patterns)
|
||||
✅ Research goals alignment maintained
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ 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
|
||||
❌ Not routing to integration 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
|
||||
|
||||
## 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 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', load `./step-03-integration-patterns.md` to analyze APIs, communication protocols, and system interoperability for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current technology data with rigorous source verification!
|
||||
@@ -0,0 +1,248 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE AN INTEGRATION ANALYST, not content generator
|
||||
- 💬 FOCUS on APIs, protocols, and system interoperability
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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. Search the web to verify and supplement current facts.
|
||||
|
||||
## 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}}** 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:**
|
||||
|
||||
Search the web: "{{research_topic}} API design patterns protocols"
|
||||
Search the web: "{{research_topic}} communication protocols data formats"
|
||||
Search the web: "{{research_topic}} system interoperability integration"
|
||||
Search the web: "{{research_topic}} microservices integration patterns"
|
||||
|
||||
**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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
|
||||
### 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]_
|
||||
```
|
||||
|
||||
### 5. Present Analysis and Continue Option
|
||||
|
||||
**Show analysis and present continue option:**
|
||||
|
||||
"I've completed **integration patterns analysis** of 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:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ 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 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 integration data with rigorous source verification!
|
||||
@@ -0,0 +1,202 @@
|
||||
# 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A SYSTEMS ARCHITECT, not content generator
|
||||
- 💬 FOCUS on architectural patterns and design decisions
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show web search analysis before presenting findings
|
||||
- ⚠️ Present [C] continue option after architectural patterns content generation
|
||||
- 📝 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
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct comprehensive architectural patterns analysis with emphasis on design decisions and implementation approaches for {{research_topic}}.
|
||||
|
||||
## ARCHITECTURAL PATTERNS SEQUENCE:
|
||||
|
||||
### 1. Begin Architectural Patterns Analysis
|
||||
|
||||
Start with architectural research approach:
|
||||
"Now I'll focus on **architectural patterns and design decisions** for effective architecture approaches for [technology/domain].
|
||||
|
||||
**Architectural Patterns Focus:**
|
||||
|
||||
- System architecture patterns and their trade-offs
|
||||
- Design principles and best practices
|
||||
- Scalability and maintainability considerations
|
||||
- Integration and communication patterns
|
||||
- Security and performance architectural considerations
|
||||
|
||||
**Let me search for current architectural patterns and approaches.**"
|
||||
|
||||
### 2. Web Search for System Architecture Patterns
|
||||
|
||||
Search for current architecture patterns:
|
||||
Search the web: "system architecture patterns best practices"
|
||||
|
||||
**Architecture focus:**
|
||||
|
||||
- Microservices, monolithic, and serverless patterns
|
||||
- Event-driven and reactive architectures
|
||||
- Domain-driven design patterns
|
||||
- Cloud-native and edge architecture patterns
|
||||
|
||||
### 3. Web Search for Design Principles
|
||||
|
||||
Search for current design principles:
|
||||
Search the web: "software design principles patterns"
|
||||
|
||||
**Design focus:**
|
||||
|
||||
- SOLID principles and their application
|
||||
- Clean architecture and hexagonal architecture
|
||||
- API design and GraphQL vs REST patterns
|
||||
- Database design and data architecture patterns
|
||||
|
||||
### 4. Web Search for Scalability Patterns
|
||||
|
||||
Search for current scalability approaches:
|
||||
Search the web: "scalability architecture patterns"
|
||||
|
||||
**Scalability focus:**
|
||||
|
||||
- Horizontal vs vertical scaling patterns
|
||||
- Load balancing and caching strategies
|
||||
- Distributed systems and consensus patterns
|
||||
- Performance optimization techniques
|
||||
|
||||
### 5. Generate Architectural Patterns Content
|
||||
|
||||
Prepare architectural analysis with web search citations:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Architectural Patterns and Design
|
||||
|
||||
### System Architecture Patterns
|
||||
|
||||
[System architecture patterns analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Design Principles and Best Practices
|
||||
|
||||
[Design principles analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Scalability and Performance Patterns
|
||||
|
||||
[Scalability patterns analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Integration and Communication Patterns
|
||||
|
||||
[Integration patterns analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Security Architecture Patterns
|
||||
|
||||
[Security patterns analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Data Architecture Patterns
|
||||
|
||||
[Data architecture analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Deployment and Operations Architecture
|
||||
|
||||
[Deployment architecture analysis with source citations]
|
||||
_Source: [URL]_
|
||||
```
|
||||
|
||||
### 6. Present Analysis and Continue Option
|
||||
|
||||
Show the generated architectural patterns and present continue option:
|
||||
"I've completed the **architectural patterns analysis** for effective architecture approaches.
|
||||
|
||||
**Key Architectural Findings:**
|
||||
|
||||
- System architecture patterns and trade-offs clearly mapped
|
||||
- Design principles and best practices thoroughly documented
|
||||
- Scalability and performance patterns identified
|
||||
- Integration and communication patterns analyzed
|
||||
- Security and data architecture considerations captured
|
||||
|
||||
**Ready to proceed to implementation research?**
|
||||
[C] Continue - Save this to the document and move to implementation research
|
||||
|
||||
### 7. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load: `./step-05-implementation-research.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 5.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ System architecture patterns identified with current citations
|
||||
✅ Design principles clearly documented and analyzed
|
||||
✅ Scalability and performance patterns thoroughly mapped
|
||||
✅ Integration and communication patterns captured
|
||||
✅ Security and data architecture considerations analyzed
|
||||
✅ [C] continue option presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
✅ Proper routing to implementation research step
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ Missing critical system architecture patterns
|
||||
❌ Not analyzing design trade-offs and considerations
|
||||
❌ Incomplete scalability or performance patterns analysis
|
||||
❌ 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
|
||||
- Use architectural conference proceedings and case studies
|
||||
- Research successful system architectures and their evolution
|
||||
- Note architectural decision records (ADRs) and rationales
|
||||
- Research architecture assessment and evaluation frameworks
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-implementation-research.md` to focus on implementation approaches and technology adoption.
|
||||
|
||||
Remember: Always emphasize current architectural data and rigorous source verification!
|
||||
@@ -0,0 +1,239 @@
|
||||
# Technical Research Step 4: Implementation Research
|
||||
|
||||
## 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE AN IMPLEMENTATION ENGINEER, not content generator
|
||||
- 💬 FOCUS on implementation approaches and technology adoption
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show web search analysis before presenting findings
|
||||
- ⚠️ Present [C] complete option after implementation research 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
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Focus on implementation approaches and technology adoption strategies
|
||||
- Web search capabilities with source verification are enabled
|
||||
- This is the final step in the technical research workflow
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct comprehensive implementation research with emphasis on practical implementation approaches and technology adoption.
|
||||
|
||||
## IMPLEMENTATION RESEARCH SEQUENCE:
|
||||
|
||||
### 1. Begin Implementation Research
|
||||
|
||||
Start with implementation research approach:
|
||||
"Now I'll complete our technical research with **implementation approaches and technology adoption** analysis.
|
||||
|
||||
**Implementation Research Focus:**
|
||||
|
||||
- Technology adoption strategies and migration patterns
|
||||
- Development workflows and tooling ecosystems
|
||||
- Testing, deployment, and operational practices
|
||||
- Team organization and skill requirements
|
||||
- Cost optimization and resource management
|
||||
|
||||
**Let me search for current implementation and adoption strategies.**"
|
||||
|
||||
### 2. Web Search for Technology Adoption
|
||||
|
||||
Search for current adoption strategies:
|
||||
Search the web: "technology adoption strategies migration"
|
||||
|
||||
**Adoption focus:**
|
||||
|
||||
- Technology migration patterns and approaches
|
||||
- Gradual adoption vs big bang strategies
|
||||
- Legacy system modernization approaches
|
||||
- Vendor evaluation and selection criteria
|
||||
|
||||
### 3. Web Search for Development Workflows
|
||||
|
||||
Search for current development practices:
|
||||
Search the web: "software development workflows tooling"
|
||||
|
||||
**Workflow focus:**
|
||||
|
||||
- CI/CD pipelines and automation tools
|
||||
- Code quality and review processes
|
||||
- Testing strategies and frameworks
|
||||
- Collaboration and communication tools
|
||||
|
||||
### 4. Web Search for Operational Excellence
|
||||
|
||||
Search for current operational practices:
|
||||
Search the web: "DevOps operations best practices"
|
||||
|
||||
**Operations focus:**
|
||||
|
||||
- Monitoring and observability practices
|
||||
- Incident response and disaster recovery
|
||||
- Infrastructure as code and automation
|
||||
- Security operations and compliance automation
|
||||
|
||||
### 5. Generate Implementation Research Content
|
||||
|
||||
Prepare implementation analysis with web search citations:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Implementation Approaches and Technology Adoption
|
||||
|
||||
### Technology Adoption Strategies
|
||||
|
||||
[Technology adoption analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Development Workflows and Tooling
|
||||
|
||||
[Development workflows analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Testing and Quality Assurance
|
||||
|
||||
[Testing approaches analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Deployment and Operations Practices
|
||||
|
||||
[Deployment practices analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Team Organization and Skills
|
||||
|
||||
[Team organization analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Cost Optimization and Resource Management
|
||||
|
||||
[Cost optimization analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
### Risk Assessment and Mitigation
|
||||
|
||||
[Risk mitigation analysis with source citations]
|
||||
_Source: [URL]_
|
||||
|
||||
## Technical Research Recommendations
|
||||
|
||||
### Implementation Roadmap
|
||||
|
||||
[Implementation roadmap recommendations]
|
||||
|
||||
### Technology Stack Recommendations
|
||||
|
||||
[Technology stack suggestions]
|
||||
|
||||
### Skill Development Requirements
|
||||
|
||||
[Skill development recommendations]
|
||||
|
||||
### Success Metrics and KPIs
|
||||
|
||||
[Success measurement framework]
|
||||
```
|
||||
|
||||
### 6. Present Analysis and Complete Option
|
||||
|
||||
Show the generated implementation research and present complete option:
|
||||
"I've completed the **implementation research and technology adoption** analysis, finalizing our comprehensive technical research.
|
||||
|
||||
**Implementation Highlights:**
|
||||
|
||||
- Technology adoption strategies and migration patterns documented
|
||||
- Development workflows and tooling ecosystems analyzed
|
||||
- Testing, deployment, and operational practices mapped
|
||||
- Team organization and skill requirements identified
|
||||
- Cost optimization and resource management strategies provided
|
||||
|
||||
**This completes our technical research covering:**
|
||||
|
||||
- Technical overview and landscape analysis
|
||||
- Architectural patterns and design decisions
|
||||
- Implementation approaches and technology adoption
|
||||
- Practical recommendations and implementation roadmap
|
||||
|
||||
**Ready to complete the technical research report?**
|
||||
[C] Complete Research - Save final document and conclude
|
||||
|
||||
### 7. Handle Complete Selection
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Complete the technical research workflow
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 5.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Technology adoption strategies identified with current citations
|
||||
✅ Development workflows and tooling thoroughly analyzed
|
||||
✅ Testing and deployment practices clearly documented
|
||||
✅ Team organization and skill requirements mapped
|
||||
✅ Cost optimization and risk mitigation strategies provided
|
||||
✅ [C] complete option presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
✅ Technical research workflow completed successfully
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
|
||||
❌ Missing critical technology adoption strategies
|
||||
❌ Not providing practical implementation guidance
|
||||
❌ Incomplete development workflows or operational practices analysis
|
||||
❌ 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
|
||||
- Research technology migration patterns and lessons learned
|
||||
- Identify common implementation challenges and solutions
|
||||
- Research development tooling ecosystem evaluations
|
||||
- Analyze operational excellence frameworks and maturity models
|
||||
|
||||
## TECHNICAL RESEARCH WORKFLOW COMPLETION:
|
||||
|
||||
When 'C' is selected:
|
||||
|
||||
- All technical research steps completed
|
||||
- Comprehensive technical research document generated
|
||||
- All sections appended with source citations
|
||||
- Technical research workflow status updated
|
||||
- Final implementation recommendations provided to user
|
||||
|
||||
## NEXT STEPS:
|
||||
|
||||
Technical research workflow complete. User may:
|
||||
|
||||
- Use technical research to inform architecture decisions
|
||||
- Conduct additional research on specific technologies
|
||||
- Combine technical research with other research types for comprehensive insights
|
||||
- Move forward with implementation based on technical insights
|
||||
|
||||
Congratulations on completing comprehensive technical research! 🎉
|
||||
@@ -0,0 +1,486 @@
|
||||
# Technical Research Step 5: Technical 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
|
||||
- ✅ Search the web to verify and supplement your knowledge with current facts
|
||||
- 📋 YOU ARE A TECHNICAL RESEARCH STRATEGIST, not content generator
|
||||
- 💬 FOCUS on comprehensive technical synthesis and authoritative conclusions
|
||||
- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
|
||||
- 📄 PRODUCE COMPREHENSIVE DOCUMENT with narrative intro, TOC, and summary
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 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
|
||||
- 🚫 FORBIDDEN to complete workflow until C is selected
|
||||
- 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- **Research topic = "{{research_topic}}"** - comprehensive technical analysis
|
||||
- **Research goals = "{{research_goals}}"** - achieved through exhaustive technical research
|
||||
- All technical research sections have been completed (overview, architecture, implementation)
|
||||
- Web search capabilities with source verification are enabled
|
||||
- This is the final synthesis step producing the complete technical research document
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Produce a comprehensive, authoritative technical research document on **{{research_topic}}** with compelling narrative introduction, detailed TOC, and executive summary based on exhaustive technical research.
|
||||
|
||||
## COMPREHENSIVE TECHNICAL DOCUMENT SYNTHESIS:
|
||||
|
||||
### 1. Technical Document Structure Planning
|
||||
|
||||
**Complete Technical Research Document Structure:**
|
||||
|
||||
```markdown
|
||||
# [Compelling Technical Title]: Comprehensive {{research_topic}} Technical Research
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[Brief compelling overview of key technical findings and strategic implications]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- Technical Research Introduction and Methodology
|
||||
- Technical Landscape and Architecture Analysis
|
||||
- Implementation Approaches and Best Practices
|
||||
- Technology Stack Evolution and Trends
|
||||
- Integration and Interoperability Patterns
|
||||
- Performance and Scalability Analysis
|
||||
- Security and Compliance Considerations
|
||||
- Strategic Technical Recommendations
|
||||
- Implementation Roadmap and Risk Assessment
|
||||
- Future Technical Outlook and Innovation Opportunities
|
||||
- Technical Research Methodology and Source Documentation
|
||||
- Technical Appendices and Reference Materials
|
||||
```
|
||||
|
||||
### 2. Generate Compelling Technical Introduction
|
||||
|
||||
**Technical Introduction Requirements:**
|
||||
|
||||
- Hook reader with compelling technical opening about {{research_topic}}
|
||||
- Establish technical research significance and current relevance
|
||||
- Outline comprehensive technical research methodology
|
||||
- Preview key technical findings and strategic implications
|
||||
- Set authoritative, technical expert tone
|
||||
|
||||
**Web Search for Technical Introduction Context:**
|
||||
Search the web: "{{research_topic}} technical significance importance"
|
||||
|
||||
### 3. Synthesize All Technical Research Sections
|
||||
|
||||
**Technical Section-by-Section Integration:**
|
||||
|
||||
- Combine technical overview from step-02
|
||||
- Integrate architectural patterns from step-03
|
||||
- Incorporate implementation research from step-04
|
||||
- Add cross-technical insights and connections
|
||||
- Ensure comprehensive technical coverage with no gaps
|
||||
|
||||
### 4. Generate Complete Technical Document Content
|
||||
|
||||
#### Final Technical Document Structure:
|
||||
|
||||
```markdown
|
||||
# [Compelling Title]: Comprehensive {{research_topic}} Technical Research
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[2-3 paragraph compelling summary of the most critical technical findings and strategic implications for {{research_topic}} based on comprehensive current technical research]
|
||||
|
||||
**Key Technical Findings:**
|
||||
|
||||
- [Most significant architectural insights]
|
||||
- [Critical implementation considerations]
|
||||
- [Important technology trends]
|
||||
- [Strategic technical implications]
|
||||
|
||||
**Technical Recommendations:**
|
||||
|
||||
- [Top 3-5 actionable technical recommendations based on research]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. Technical Research Introduction and Methodology
|
||||
2. {{research_topic}} Technical Landscape and Architecture Analysis
|
||||
3. Implementation Approaches and Best Practices
|
||||
4. Technology Stack Evolution and Current Trends
|
||||
5. Integration and Interoperability Patterns
|
||||
6. Performance and Scalability Analysis
|
||||
7. Security and Compliance Considerations
|
||||
8. Strategic Technical Recommendations
|
||||
9. Implementation Roadmap and Risk Assessment
|
||||
10. Future Technical Outlook and Innovation Opportunities
|
||||
11. Technical Research Methodology and Source Verification
|
||||
12. Technical Appendices and Reference Materials
|
||||
|
||||
## 1. Technical Research Introduction and Methodology
|
||||
|
||||
### Technical Research Significance
|
||||
|
||||
[Compelling technical narrative about why {{research_topic}} research is critical right now]
|
||||
_Technical Importance: [Strategic technical significance with current context]_
|
||||
_Business Impact: [Business implications of technical research]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Technical Research Methodology
|
||||
|
||||
[Comprehensive description of technical research approach including:]
|
||||
|
||||
- **Technical Scope**: [Comprehensive technical coverage areas]
|
||||
- **Data Sources**: [Authoritative technical sources and verification approach]
|
||||
- **Analysis Framework**: [Structured technical analysis methodology]
|
||||
- **Time Period**: [current focus and technical evolution context]
|
||||
- **Technical Depth**: [Level of technical detail and analysis]
|
||||
|
||||
### Technical Research Goals and Objectives
|
||||
|
||||
**Original Technical Goals:** {{research_goals}}
|
||||
|
||||
**Achieved Technical Objectives:**
|
||||
|
||||
- [Technical Goal 1 achievement with supporting evidence]
|
||||
- [Technical Goal 2 achievement with supporting evidence]
|
||||
- [Additional technical insights discovered during research]
|
||||
|
||||
## 2. {{research_topic}} Technical Landscape and Architecture Analysis
|
||||
|
||||
### Current Technical Architecture Patterns
|
||||
|
||||
[Comprehensive architectural analysis synthesized from step-03 with current context]
|
||||
_Dominant Patterns: [Current architectural approaches]_
|
||||
_Architectural Evolution: [Historical and current evolution patterns]_
|
||||
_Architectural Trade-offs: [Key architectural decisions and implications]_
|
||||
_Source: [URL]_
|
||||
|
||||
### System Design Principles and Best Practices
|
||||
|
||||
[Complete system design analysis]
|
||||
_Design Principles: [Core principles guiding {{research_topic}} implementations]_
|
||||
_Best Practice Patterns: [Industry-standard approaches and methodologies]_
|
||||
_Architectural Quality Attributes: [Performance, scalability, maintainability considerations]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 3. Implementation Approaches and Best Practices
|
||||
|
||||
### Current Implementation Methodologies
|
||||
|
||||
[Implementation analysis from step-04 with current context]
|
||||
_Development Approaches: [Current development methodologies and approaches]_
|
||||
_Code Organization Patterns: [Structural patterns and organization strategies]_
|
||||
_Quality Assurance Practices: [Testing, validation, and quality approaches]_
|
||||
_Deployment Strategies: [Current deployment and operations practices]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Implementation Framework and Tooling
|
||||
|
||||
[Comprehensive implementation framework analysis]
|
||||
_Development Frameworks: [Popular frameworks and their characteristics]_
|
||||
_Tool Ecosystem: [Development tools and platform considerations]_
|
||||
_Build and Deployment Systems: [CI/CD and automation approaches]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 4. Technology Stack Evolution and Current Trends
|
||||
|
||||
### Current Technology Stack Landscape
|
||||
|
||||
[Technology stack analysis from step-02 with current updates]
|
||||
_Programming Languages: [Current language trends and adoption patterns]_
|
||||
_Frameworks and Libraries: [Popular frameworks and their use cases]_
|
||||
_Database and Storage Technologies: [Current data storage and management trends]_
|
||||
_API and Communication Technologies: [Integration and communication patterns]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Technology Adoption Patterns
|
||||
|
||||
[Comprehensive technology adoption analysis]
|
||||
_Adoption Trends: [Technology adoption rates and patterns]_
|
||||
_Migration Patterns: [Technology migration and evolution trends]_
|
||||
_Emerging Technologies: [New technologies and their potential impact]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 5. Integration and Interoperability Patterns
|
||||
|
||||
### Current Integration Approaches
|
||||
|
||||
[Integration patterns analysis with current context]
|
||||
_API Design Patterns: [Current API design and implementation patterns]_
|
||||
_Service Integration: [Microservices and service integration approaches]_
|
||||
_Data Integration: [Data exchange and integration patterns]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Interoperability Standards and Protocols
|
||||
|
||||
[Comprehensive interoperability analysis]
|
||||
_Standards Compliance: [Industry standards and compliance requirements]_
|
||||
_Protocol Selection: [Communication protocols and selection criteria]_
|
||||
_Integration Challenges: [Common integration challenges and solutions]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 6. Performance and Scalability Analysis
|
||||
|
||||
### Performance Characteristics and Optimization
|
||||
|
||||
[Performance analysis based on research findings]
|
||||
_Performance Benchmarks: [Current performance characteristics and benchmarks]_
|
||||
_Optimization Strategies: [Performance optimization approaches and techniques]_
|
||||
_Monitoring and Measurement: [Performance monitoring and measurement practices]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Scalability Patterns and Approaches
|
||||
|
||||
[Comprehensive scalability analysis]
|
||||
_Scalability Patterns: [Architectural and design patterns for scalability]_
|
||||
_Capacity Planning: [Capacity planning and resource management approaches]_
|
||||
_Elasticity and Auto-scaling: [Dynamic scaling approaches and implementations]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 7. Security and Compliance Considerations
|
||||
|
||||
### Security Best Practices and Frameworks
|
||||
|
||||
[Security analysis with current context]
|
||||
_Security Frameworks: [Current security frameworks and best practices]_
|
||||
_Threat Landscape: [Current security threats and mitigation approaches]_
|
||||
_Secure Development Practices: [Secure coding and development lifecycle]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Compliance and Regulatory Considerations
|
||||
|
||||
[Comprehensive compliance analysis]
|
||||
_Industry Standards: [Relevant industry standards and compliance requirements]_
|
||||
_Regulatory Compliance: [Legal and regulatory considerations for {{research_topic}}]_
|
||||
_Audit and Governance: [Technical audit and governance practices]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 8. Strategic Technical Recommendations
|
||||
|
||||
### Technical Strategy and Decision Framework
|
||||
|
||||
[Strategic technical recommendations based on comprehensive research]
|
||||
_Architecture Recommendations: [Recommended architectural approaches and patterns]_
|
||||
_Technology Selection: [Recommended technology stack and selection criteria]_
|
||||
_Implementation Strategy: [Recommended implementation approaches and methodologies]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Competitive Technical Advantage
|
||||
|
||||
[Analysis of technical competitive positioning]
|
||||
_Technology Differentiation: [Technical approaches that provide competitive advantage]_
|
||||
_Innovation Opportunities: [Areas for technical innovation and differentiation]_
|
||||
_Strategic Technology Investments: [Recommended technology investments and priorities]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 9. Implementation Roadmap and Risk Assessment
|
||||
|
||||
### Technical Implementation Framework
|
||||
|
||||
[Comprehensive implementation guidance based on research findings]
|
||||
_Implementation Phases: [Recommended phased implementation approach]_
|
||||
_Technology Migration Strategy: [Approach for technology adoption and migration]_
|
||||
_Resource Planning: [Technical resources and capabilities planning]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Technical Risk Management
|
||||
|
||||
[Comprehensive technical risk assessment]
|
||||
_Technical Risks: [Major technical risks and mitigation strategies]_
|
||||
_Implementation Risks: [Risks associated with implementation and deployment]_
|
||||
_Business Impact Risks: [Technical risks and their business implications]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 10. Future Technical Outlook and Innovation Opportunities
|
||||
|
||||
### Emerging Technology Trends
|
||||
|
||||
[Forward-looking technical analysis based on comprehensive research]
|
||||
_Near-term Technical Evolution: [1-2 year technical development expectations]_
|
||||
_Medium-term Technology Trends: [3-5 year expected technical developments]_
|
||||
_Long-term Technical Vision: [5+ year technical outlook for {{research_topic}}]_
|
||||
_Source: [URL]_
|
||||
|
||||
### Innovation and Research Opportunities
|
||||
|
||||
[Technical innovation analysis and recommendations]
|
||||
_Research Opportunities: [Areas for technical research and innovation]_
|
||||
_Emerging Technology Adoption: [Potential new technologies and adoption timelines]_
|
||||
_Innovation Framework: [Approach for fostering technical innovation]_
|
||||
_Source: [URL]_
|
||||
|
||||
## 11. Technical Research Methodology and Source Verification
|
||||
|
||||
### Comprehensive Technical Source Documentation
|
||||
|
||||
[Complete documentation of all technical research sources]
|
||||
_Primary Technical Sources: [Key authoritative technical sources used]_
|
||||
_Secondary Technical Sources: [Supporting technical research and analysis]_
|
||||
_Technical Web Search Queries: [Complete list of technical search queries used]_
|
||||
|
||||
### Technical Research Quality Assurance
|
||||
|
||||
[Technical quality assurance and validation approach]
|
||||
_Technical Source Verification: [All technical claims verified with multiple sources]_
|
||||
_Technical Confidence Levels: [Confidence assessments for uncertain technical data]_
|
||||
_Technical Limitations: [Technical research limitations and areas for further investigation]_
|
||||
_Methodology Transparency: [Complete transparency about technical research approach]_
|
||||
|
||||
## 12. Technical Appendices and Reference Materials
|
||||
|
||||
### Detailed Technical Data Tables
|
||||
|
||||
[Comprehensive technical data tables supporting research findings]
|
||||
_Architectural Pattern Tables: [Detailed architectural pattern comparisons]_
|
||||
_Technology Stack Analysis: [Detailed technology evaluation and comparison data]_
|
||||
_Performance Benchmark Data: [Comprehensive performance measurement data]_
|
||||
|
||||
### Technical Resources and References
|
||||
|
||||
[Valuable technical resources for continued research and implementation]
|
||||
_Technical Standards: [Relevant technical standards and specifications]_
|
||||
_Open Source Projects: [Key open source projects and communities]_
|
||||
_Research Papers and Publications: [Academic and industry research sources]_
|
||||
_Technical Communities: [Professional networks and technical communities]_
|
||||
|
||||
---
|
||||
|
||||
## Technical Research Conclusion
|
||||
|
||||
### Summary of Key Technical Findings
|
||||
|
||||
[Comprehensive summary of the most important technical research findings]
|
||||
|
||||
### Strategic Technical Impact Assessment
|
||||
|
||||
[Assessment of technical implications for {{research_topic}}]
|
||||
|
||||
### Next Steps Technical Recommendations
|
||||
|
||||
[Specific next steps for leveraging this technical research]
|
||||
|
||||
---
|
||||
|
||||
**Technical Research Completion Date:** {{date}}
|
||||
**Research Period:** current comprehensive technical analysis
|
||||
**Document Length:** As needed for comprehensive technical coverage
|
||||
**Source Verification:** All technical facts cited with current sources
|
||||
**Technical Confidence Level:** High - based on multiple authoritative technical sources
|
||||
|
||||
_This comprehensive technical research document serves as an authoritative technical reference on {{research_topic}} and provides strategic technical insights for informed decision-making and implementation._
|
||||
```
|
||||
|
||||
### 5. Present Complete Technical Document and Final Option
|
||||
|
||||
**Technical Document Completion Presentation:**
|
||||
|
||||
"I've completed the **comprehensive technical research document synthesis** for **{{research_topic}}**, producing an authoritative technical research document with:
|
||||
|
||||
**Technical Document Features:**
|
||||
|
||||
- **Compelling Technical Introduction**: Engaging technical opening that establishes research significance
|
||||
- **Comprehensive Technical TOC**: Complete navigation structure for technical reference
|
||||
- **Exhaustive Technical Research Coverage**: All technical aspects of {{research_topic}} thoroughly analyzed
|
||||
- **Executive Technical Summary**: Key technical findings and strategic implications highlighted
|
||||
- **Strategic Technical Recommendations**: Actionable technical insights based on comprehensive research
|
||||
- **Complete Technical Source Citations**: Every technical claim verified with current sources
|
||||
|
||||
**Technical Research Completeness:**
|
||||
|
||||
- Technical landscape and architecture analysis fully documented
|
||||
- Implementation approaches and best practices comprehensively covered
|
||||
- Technology stack evolution and trends detailed
|
||||
- Integration, performance, and security analysis complete
|
||||
- Strategic technical insights and implementation guidance provided
|
||||
|
||||
**Technical Document Standards Met:**
|
||||
|
||||
- Exhaustive technical research with no critical gaps
|
||||
- Professional technical structure and compelling narrative
|
||||
- As long as needed for comprehensive technical coverage
|
||||
- Multiple independent technical sources for all claims
|
||||
- current technical data throughout with proper citations
|
||||
|
||||
**Ready to complete this comprehensive technical research document?**
|
||||
[C] Complete Research - Save final comprehensive technical document
|
||||
|
||||
### 6. Handle Final Technical Completion
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- Append the complete technical document to the research file
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Complete the technical research workflow
|
||||
- Provide final technical document delivery confirmation
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the complete comprehensive technical research document using the full structure above.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Compelling technical introduction with research significance
|
||||
✅ Comprehensive technical table of contents with complete document structure
|
||||
✅ Exhaustive technical research coverage across all technical aspects
|
||||
✅ Executive technical summary with key findings and strategic implications
|
||||
✅ Strategic technical recommendations grounded in comprehensive research
|
||||
✅ Complete technical source verification with current citations
|
||||
✅ Professional technical document structure and compelling narrative
|
||||
✅ [C] complete option presented and handled correctly
|
||||
✅ Technical research workflow completed with comprehensive document
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not producing compelling technical introduction
|
||||
❌ Missing comprehensive technical table of contents
|
||||
❌ Incomplete technical research coverage across technical aspects
|
||||
❌ Not providing executive technical summary with key findings
|
||||
❌ Missing strategic technical recommendations based on research
|
||||
❌ Relying solely on training data without web verification for current facts
|
||||
❌ 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:
|
||||
|
||||
- Serves as an authoritative technical reference on {{research_topic}}
|
||||
- Provides strategic technical insights for informed decision-making
|
||||
- Includes comprehensive technical coverage with no gaps
|
||||
- Maintains rigorous technical source verification standards
|
||||
- Delivers strategic technical insights and actionable recommendations
|
||||
- Meets professional technical research document quality standards
|
||||
|
||||
## TECHNICAL RESEARCH WORKFLOW COMPLETION:
|
||||
|
||||
When 'C' is selected:
|
||||
|
||||
- All technical research steps completed (1-5)
|
||||
- Comprehensive technical research document generated
|
||||
- Professional technical document structure with intro, TOC, and summary
|
||||
- All technical sections appended with source citations
|
||||
- Technical research workflow status updated to complete
|
||||
- Final comprehensive technical research document delivered to user
|
||||
|
||||
## FINAL TECHNICAL DELIVERABLE:
|
||||
|
||||
Complete authoritative technical research document on {{research_topic}} that:
|
||||
|
||||
- Establishes technical credibility through comprehensive research
|
||||
- Provides strategic technical insights for informed decision-making
|
||||
- Serves as technical reference document for continued use
|
||||
- Maintains highest technical research quality standards with current verification
|
||||
|
||||
Congratulations on completing comprehensive technical research with professional documentation! 🎉
|
||||
173
_bmad/bmm/workflows/1-analysis/research/workflow.md
Normal file
173
_bmad/bmm/workflows/1-analysis/research/workflow.md
Normal file
@@ -0,0 +1,173 @@
|
||||
---
|
||||
name: research
|
||||
description: Conduct comprehensive research across multiple domains using current web data and verified sources - Market, Technical, Domain and other research types.
|
||||
web_bundle: true
|
||||
---
|
||||
|
||||
# Research Workflow
|
||||
|
||||
**Goal:** Conduct comprehensive, exhaustive research across multiple domains using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||
|
||||
**Document Standards:**
|
||||
|
||||
- **Comprehensive Coverage**: Exhaustive research with no critical gaps
|
||||
- **Source Verification**: Every factual claim backed by web sources with URL citations
|
||||
- **Document Length**: As long as needed to fully cover the research topic
|
||||
- **Professional Structure**: Compelling narrative introduction, detailed TOC, and comprehensive summary
|
||||
- **Authoritative Sources**: Multiple independent sources for all critical claims
|
||||
|
||||
**Your Role:** You are a research facilitator and web data analyst working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
||||
|
||||
**Final Deliverable**: A complete research document that serves as an authoritative reference on the research topic with:
|
||||
|
||||
- Compelling narrative introduction
|
||||
- Comprehensive table of contents
|
||||
- Detailed research sections with proper citations
|
||||
- Executive summary and conclusions
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **micro-file architecture** with **routing-based discovery**:
|
||||
|
||||
- Each research type has its own step folder
|
||||
- Step 01 discovers research type and routes to appropriate sub-workflow
|
||||
- Sequential progression within each research type
|
||||
- Document state tracked in output frontmatter
|
||||
|
||||
## INITIALIZATION
|
||||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, , `planning_artifacts`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as a system-generated value
|
||||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/_bmad/bmm/workflows/1-analysis/research`
|
||||
- `template_path` = `{installed_path}/research.template.md`
|
||||
- `default_output_file` = `{planning_artifacts}/research/{{research_type}}-{{topic}}-research-{{date}}.md` (dynamic based on research type)
|
||||
|
||||
## PREREQUISITE
|
||||
|
||||
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||
|
||||
## RESEARCH BEHAVIOR
|
||||
|
||||
### Web Research Standards
|
||||
|
||||
- **Current Data Only**: Search the web to verify and supplement your knowledge with current facts
|
||||
- **Source Verification**: Require citations for all factual claims
|
||||
- **Anti-Hallucination Protocol**: Never present information without verified sources
|
||||
- **Multiple Sources**: Require at least 2 independent sources for critical claims
|
||||
- **Conflict Resolution**: Present conflicting views and note discrepancies
|
||||
- **Confidence Levels**: Flag uncertain data with [High/Medium/Low Confidence]
|
||||
|
||||
### Source Quality Standards
|
||||
|
||||
- **Distinguish Clearly**: Facts (from sources) vs Analysis (interpretation) vs Speculation
|
||||
- **URL Citation**: Always include source URLs when presenting web search data
|
||||
- **Critical Claims**: Market size, growth rates, competitive data need verification
|
||||
- **Fact Checking**: Apply fact-checking to critical data points
|
||||
|
||||
## Implementation Instructions
|
||||
|
||||
Execute research type discovery and routing:
|
||||
|
||||
### Research Type Discovery
|
||||
|
||||
**Your Role:** You are a research facilitator and web data analyst working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
||||
|
||||
**Research Standards:**
|
||||
|
||||
- **Anti-Hallucination Protocol**: Never present information without verified sources
|
||||
- **Current Data Only**: Search the web to verify and supplement your knowledge with current facts
|
||||
- **Source Citation**: Always include URLs for factual claims from web searches
|
||||
- **Multiple Sources**: Require 2+ independent sources for critical claims
|
||||
- **Conflict Resolution**: Present conflicting views and note discrepancies
|
||||
- **Confidence Levels**: Flag uncertain data with [High/Medium/Low Confidence]
|
||||
|
||||
### Collaborative Research Discovery
|
||||
|
||||
"Welcome {{user_name}}! I'm excited to work with you as your research partner. I bring web research capabilities with rigorous source verification, while you bring the domain expertise and research direction.
|
||||
|
||||
**Let me help you clarify what you'd like to research.**
|
||||
|
||||
**First, tell me: What specific topic, problem, or area do you want to research?**
|
||||
|
||||
For example:
|
||||
|
||||
- 'The electric vehicle market in Europe'
|
||||
- 'Cloud migration strategies for healthcare'
|
||||
- 'AI implementation in financial services'
|
||||
- 'Sustainable packaging regulations'
|
||||
- 'Or anything else you have in mind...'
|
||||
|
||||
### Topic Exploration and Clarification
|
||||
|
||||
Based on the user's initial topic, explore and refine the research scope:
|
||||
|
||||
#### Topic Clarification Questions:
|
||||
|
||||
1. **Core Topic**: "What exactly about [topic] are you most interested in?"
|
||||
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||
4. **Timeline**: "Are you looking at current state, historical context, or future trends?"
|
||||
5. **Application**: "How will you use this research? (product development, strategy, academic, etc.)"
|
||||
|
||||
#### Context Building:
|
||||
|
||||
- **Initial Input**: User provides topic or research interest
|
||||
- **Collaborative Refinement**: Work together to clarify scope and objectives
|
||||
- **Goal Alignment**: Ensure research direction matches user needs
|
||||
- **Research Boundaries**: Establish clear focus areas and deliverables
|
||||
|
||||
### Research Type Identification
|
||||
|
||||
After understanding the research topic and goals, identify the most appropriate research approach:
|
||||
|
||||
**Research Type Options:**
|
||||
|
||||
1. **Market Research** - Market size, growth, competition, customer insights
|
||||
_Best for: Understanding market dynamics, customer behavior, competitive landscape_
|
||||
|
||||
2. **Domain Research** - Industry analysis, regulations, technology trends in specific domain
|
||||
_Best for: Understanding industry context, regulatory environment, ecosystem_
|
||||
|
||||
3. **Technical Research** - Technology evaluation, architecture decisions, implementation approaches
|
||||
_Best for: Technical feasibility, technology selection, implementation strategies_
|
||||
|
||||
**Recommendation**: Based on [topic] and [goals], I recommend [suggested research type] because [specific rationale].
|
||||
|
||||
**What type of research would work best for your needs?**
|
||||
|
||||
### Research Type Routing
|
||||
|
||||
<critical>Based on user selection, route to appropriate sub-workflow with the discovered topic using the following IF block sets of instructions. YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`</critical>
|
||||
|
||||
#### If Market Research:
|
||||
|
||||
- Set `research_type = "market"`
|
||||
- Set `research_topic = [discovered topic from discussion]`
|
||||
- Create the starter output file: `{planning_artifacts}/research/market-{{research_topic}}-research-{{date}}.md` with exact copy of the ./research.template.md contents
|
||||
- Load: `./market-steps/step-01-init.md` with topic context
|
||||
|
||||
#### If Domain Research:
|
||||
|
||||
- Set `research_type = "domain"`
|
||||
- Set `research_topic = [discovered topic from discussion]`
|
||||
- Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic}}-research-{{date}}.md` with exact copy of the ./research.template.md contents
|
||||
- Load: `./domain-steps/step-01-init.md` with topic context
|
||||
|
||||
#### If Technical Research:
|
||||
|
||||
- Set `research_type = "technical"`
|
||||
- Set `research_topic = [discovered topic from discussion]`
|
||||
- Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic}}-research-{{date}}.md` with exact copy of the ./research.template.md contents
|
||||
- Load: `./technical-steps/step-01-init.md` with topic context
|
||||
|
||||
**Important**: The discovered topic from the collaborative discussion should be passed to the research initialization steps, so they don't need to ask "What do you want to research?" again - they can focus on refining the scope for their specific research type.
|
||||
|
||||
**Note:** All research workflows require web search for current data and source verification.
|
||||
@@ -0,0 +1,135 @@
|
||||
# Step 1: UX Design 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 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
|
||||
- 🚪 DETECT existing workflow state and handle continuation properly
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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 UX design workflow by detecting continuation state and setting up the design specification document.
|
||||
|
||||
## INITIALIZATION SEQUENCE:
|
||||
|
||||
### 1. Check for Existing Workflow
|
||||
|
||||
First, check if the output document already exists:
|
||||
|
||||
- Look for file at `{planning_artifacts}/*ux-design-specification*.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. Documents can be in the following locations:
|
||||
- {planning_artifacts}/**
|
||||
- {output_folder}/**
|
||||
- {product_knowledge}/**
|
||||
- docs/**
|
||||
|
||||
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
||||
|
||||
Try to discover the following:
|
||||
- Product Brief (`*brief*.md`)
|
||||
- Research Documents (`*prd*.md`)
|
||||
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
||||
- Project Context (`**/project-context.md`)
|
||||
|
||||
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
||||
|
||||
**Loading Rules:**
|
||||
|
||||
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
||||
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
||||
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
||||
- index.md is a guide to what's relevant whenever available
|
||||
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
||||
|
||||
#### B. Create Initial Document
|
||||
|
||||
Copy the template from `{installed_path}/ux-design-template.md` to `{planning_artifacts}/ux-design-specification.md`
|
||||
Initialize frontmatter in the template.
|
||||
|
||||
#### C. Complete Initialization and Report
|
||||
|
||||
Complete setup and report to user:
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Created: `{planning_artifacts}/ux-design-specification.md` from template
|
||||
- Initialized frontmatter with workflow state
|
||||
|
||||
**Input Documents Discovered:**
|
||||
Report what was found:
|
||||
"Welcome {{user_name}}! I've set up your UX design workspace for {{project_name}}.
|
||||
|
||||
**Documents Found:**
|
||||
|
||||
- PRD: {number of PRD files loaded or "None found"}
|
||||
- Product brief: {number of brief files loaded or "None found"}
|
||||
- Other context: {number of other files loaded or "None found"}
|
||||
|
||||
**Files loaded:** {list of specific file names or "No additional documents found"}
|
||||
|
||||
Do you have any other documents you'd like me to include, or shall we continue to the next step?
|
||||
|
||||
[C] Continue to UX discovery"
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `./step-02-discovery.md` to begin the UX discovery phase.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until output file has been updated and user explicitly selects [C] to continue!
|
||||
|
||||
## 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`
|
||||
✅ 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
|
||||
|
||||
❌ **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
|
||||
@@ -0,0 +1,127 @@
|
||||
# Step 1B: UX Design Workflow Continuation
|
||||
|
||||
## 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
|
||||
- 🚪 RESUME workflow from exact point where it was interrupted
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis of current state before taking action
|
||||
- 💾 Keep existing frontmatter `stepsCompleted` values
|
||||
- 📖 Only load documents that were already tracked in `inputDocuments`
|
||||
- 🚫 FORBIDDEN to modify content completed in previous steps
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter are already loaded
|
||||
- Previous context = complete document + existing frontmatter
|
||||
- Input documents listed in frontmatter were already processed
|
||||
- Last completed step = `lastStep` value from frontmatter
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Resume the UX design workflow from where it was left off, ensuring smooth continuation.
|
||||
|
||||
## CONTINUATION SEQUENCE:
|
||||
|
||||
### 1. Analyze Current State
|
||||
|
||||
Review the frontmatter to understand:
|
||||
|
||||
- `stepsCompleted`: Which steps are already done
|
||||
- `lastStep`: The most recently completed step number
|
||||
- `inputDocuments`: What context was already loaded
|
||||
- All other frontmatter variables
|
||||
|
||||
### 2. Load All Input Documents
|
||||
|
||||
Reload the context documents listed in `inputDocuments`:
|
||||
|
||||
- For each document in `inputDocuments`, load the complete file
|
||||
- This ensures you have full context for continuation
|
||||
- Don't discover new documents - only reload what was previously processed
|
||||
|
||||
### 3. Summarize Current Progress
|
||||
|
||||
Welcome the user back and provide context:
|
||||
"Welcome back {{user_name}}! I'm resuming our UX design collaboration for {{project_name}}.
|
||||
|
||||
**Current Progress:**
|
||||
|
||||
- Steps completed: {stepsCompleted}
|
||||
- Last worked on: Step {lastStep}
|
||||
- Context documents available: {len(inputDocuments)} files
|
||||
- Current UX design specification is ready with all completed sections
|
||||
|
||||
**Document Status:**
|
||||
|
||||
- Current UX design document is ready with all completed sections
|
||||
- Ready to continue from where we left off
|
||||
|
||||
Does this look right, or do you want to make any adjustments before we proceed?"
|
||||
|
||||
### 4. Determine Next Step
|
||||
|
||||
Based on `lastStep` value, determine which step to load next:
|
||||
|
||||
- If `lastStep = 1` → Load `./step-02-discovery.md`
|
||||
- If `lastStep = 2` → Load `./step-03-core-experience.md`
|
||||
- If `lastStep = 3` → Load `./step-04-emotional-response.md`
|
||||
- Continue this pattern for all steps
|
||||
- If `lastStep` indicates final step → Workflow already complete
|
||||
|
||||
### 5. Present Continuation Options
|
||||
|
||||
After presenting current progress, ask:
|
||||
"Ready to continue with Step {nextStepNumber}: {nextStepTitle}?
|
||||
|
||||
[C] Continue to Step {nextStepNumber}"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All previous input documents successfully reloaded
|
||||
✅ Current workflow state accurately analyzed and presented
|
||||
✅ User confirms understanding of progress
|
||||
✅ Correct next step identified and prepared for loading
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Discovering new input documents instead of reloading existing ones
|
||||
❌ Modifying content from already completed steps
|
||||
❌ 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:
|
||||
"Great news! It looks like we've already completed the UX design workflow for {{project_name}}.
|
||||
|
||||
The final UX design specification is ready at {output_folder}/ux-design-specification.md with all sections completed through step {finalStepNumber}.
|
||||
|
||||
The complete UX design includes visual foundations, user flows, and design specifications ready for implementation.
|
||||
|
||||
Would you like me to:
|
||||
|
||||
- Review the completed UX design specification with you
|
||||
- Suggest next workflow steps (like wireframe generation or architecture)
|
||||
- Start a new UX design revision
|
||||
|
||||
What would be most helpful?"
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user confirms they're ready to continue, load the appropriate next step file based on the `lastStep` value from frontmatter.
|
||||
|
||||
Remember: Do NOT load the next step until user explicitly selects [C] to continue!
|
||||
@@ -0,0 +1,190 @@
|
||||
# Step 2: Project Understanding
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating project understanding content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper project insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to understand project context
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from step 1 are available
|
||||
- Input documents (PRD, briefs, epics) already loaded are in memory
|
||||
- No additional data files needed for this step
|
||||
- Focus on project and user understanding
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Understand the project context, target users, and what makes this product special from a UX perspective.
|
||||
|
||||
## PROJECT DISCOVERY SEQUENCE:
|
||||
|
||||
### 1. Review Loaded Context
|
||||
|
||||
Start by analyzing what we know from the loaded documents:
|
||||
"Based on the project documentation we have loaded, let me confirm what I'm understanding about {{project_name}}.
|
||||
|
||||
**From the documents:**
|
||||
{summary of key insights from loaded PRD, briefs, and other context documents}
|
||||
|
||||
**Target Users:**
|
||||
{summary of user information from loaded documents}
|
||||
|
||||
**Key Features/Goals:**
|
||||
{summary of main features and goals from loaded documents}
|
||||
|
||||
Does this match your understanding? Are there any corrections or additions you'd like to make?"
|
||||
|
||||
### 2. Fill Context Gaps (If no documents or gaps exist)
|
||||
|
||||
If no documents were loaded or key information is missing:
|
||||
"Since we don't have complete documentation, let's start with the essentials:
|
||||
|
||||
**What are you building?** (Describe your product in 1-2 sentences)
|
||||
|
||||
**Who is this for?** (Describe your ideal user or target audience)
|
||||
|
||||
**What makes this special or different?** (What's the unique value proposition?)
|
||||
|
||||
**What's the main thing users will do with this?** (Core user action or goal)"
|
||||
|
||||
### 3. Explore User Context Deeper
|
||||
|
||||
Dive into user understanding:
|
||||
"Let me understand your users better to inform the UX design:
|
||||
|
||||
**User Context Questions:**
|
||||
|
||||
- What problem are users trying to solve?
|
||||
- What frustrates them with current solutions?
|
||||
- What would make them say 'this is exactly what I needed'?
|
||||
- How tech-savvy are your target users?
|
||||
- What devices will they use most?
|
||||
- When/where will they use this product?"
|
||||
|
||||
### 4. Identify UX Design Challenges
|
||||
|
||||
Surface the key UX challenges to address:
|
||||
"From what we've discussed, I'm seeing some key UX design considerations:
|
||||
|
||||
**Design Challenges:**
|
||||
|
||||
- [Identify 2-3 key UX challenges based on project type and user needs]
|
||||
- [Note any platform-specific considerations]
|
||||
- [Highlight any complex user flows or interactions]
|
||||
|
||||
**Design Opportunities:**
|
||||
|
||||
- [Identify 2-3 areas where great UX could create competitive advantage]
|
||||
- [Note any opportunities for innovative UX patterns]
|
||||
|
||||
Does this capture the key UX considerations we need to address?"
|
||||
|
||||
### 5. Generate Project Understanding Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Executive Summary
|
||||
|
||||
### Project Vision
|
||||
|
||||
[Project vision summary based on conversation]
|
||||
|
||||
### Target Users
|
||||
|
||||
[Target user descriptions based on conversation]
|
||||
|
||||
### Key Design Challenges
|
||||
|
||||
[Key UX challenges identified based on conversation]
|
||||
|
||||
### Design Opportunities
|
||||
|
||||
[Design opportunities identified based on conversation]
|
||||
```
|
||||
|
||||
### 6. Present Content and Menu
|
||||
|
||||
Show the generated project understanding content and present choices:
|
||||
"I've documented our understanding of {{project_name}} from a UX perspective. This will guide all our design decisions moving forward.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 5]
|
||||
|
||||
**What would you like to do?**
|
||||
[C] Continue - Save this to the document and move to core experience definition"
|
||||
|
||||
### 7. Handle Menu Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load `./step-03-core-experience.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document. Only after the content is saved to document, load `./step-03-core-experience.md` and execute the instructions.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All available context documents reviewed and synthesized
|
||||
✅ Project vision clearly articulated
|
||||
✅ Target users well understood
|
||||
✅ Key UX challenges identified
|
||||
✅ Design opportunities surfaced
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not reviewing loaded context documents thoroughly
|
||||
❌ Making assumptions about users without asking
|
||||
❌ Missing key UX challenges that will impact design
|
||||
❌ Not identifying design opportunities
|
||||
❌ Generating generic content without real project insight
|
||||
❌ 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:
|
||||
|
||||
Remember: Do NOT proceed to step-03 until user explicitly selects 'C' from the menu and content is saved!
|
||||
@@ -0,0 +1,216 @@
|
||||
# Step 3: Core Experience 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 UX facilitator and stakeholder
|
||||
- 📋 YOU ARE A UX FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on defining the core user experience and platform
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating core experience content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper experience insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define optimal user experience
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Project understanding from step 2 informs this step
|
||||
- No additional data files needed for this step
|
||||
- Focus on core experience and platform decisions
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define the core user experience, platform requirements, and what makes the interaction effortless.
|
||||
|
||||
## CORE EXPERIENCE DISCOVERY SEQUENCE:
|
||||
|
||||
### 1. Define Core User Action
|
||||
|
||||
Start by identifying the most important user interaction:
|
||||
"Now let's dig into the heart of the user experience for {{project_name}}.
|
||||
|
||||
**Core Experience Questions:**
|
||||
|
||||
- What's the ONE thing users will do most frequently?
|
||||
- What user action is absolutely critical to get right?
|
||||
- What should be completely effortless for users?
|
||||
- If we nail one interaction, everything else follows - what is it?
|
||||
|
||||
Think about the core loop or primary action that defines your product's value."
|
||||
|
||||
### 2. Explore Platform Requirements
|
||||
|
||||
Determine where and how users will interact:
|
||||
"Let's define the platform context for {{project_name}}:
|
||||
|
||||
**Platform Questions:**
|
||||
|
||||
- Web, mobile app, desktop, or multiple platforms?
|
||||
- Will this be primarily touch-based or mouse/keyboard?
|
||||
- Any specific platform requirements or constraints?
|
||||
- Do we need to consider offline functionality?
|
||||
- Any device-specific capabilities we should leverage?"
|
||||
|
||||
### 3. Identify Effortless Interactions
|
||||
|
||||
Surface what should feel magical or completely seamless:
|
||||
"**Effortless Experience Design:**
|
||||
|
||||
- What user actions should feel completely natural and require zero thought?
|
||||
- Where do users currently struggle with similar products?
|
||||
- What interaction, if made effortless, would create delight?
|
||||
- What should happen automatically without user intervention?
|
||||
- Where can we eliminate steps that competitors require?"
|
||||
|
||||
### 4. Define Critical Success Moments
|
||||
|
||||
Identify the moments that determine success or failure:
|
||||
"**Critical Success Moments:**
|
||||
|
||||
- What's the moment where users realize 'this is better'?
|
||||
- When does the user feel successful or accomplished?
|
||||
- What interaction, if failed, would ruin the experience?
|
||||
- What are the make-or-break user flows?
|
||||
- Where does first-time user success happen?"
|
||||
|
||||
### 5. Synthesize Experience Principles
|
||||
|
||||
Extract guiding principles from the conversation:
|
||||
"Based on our discussion, I'm hearing these core experience principles for {{project_name}}:
|
||||
|
||||
**Experience Principles:**
|
||||
|
||||
- [Principle 1 based on core action focus]
|
||||
- [Principle 2 based on effortless interactions]
|
||||
- [Principle 3 based on platform considerations]
|
||||
- [Principle 4 based on critical success moments]
|
||||
|
||||
These principles will guide all our UX decisions. Do these capture what's most important?"
|
||||
|
||||
### 6. Generate Core Experience Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Core User Experience
|
||||
|
||||
### Defining Experience
|
||||
|
||||
[Core experience definition based on conversation]
|
||||
|
||||
### Platform Strategy
|
||||
|
||||
[Platform requirements and decisions based on conversation]
|
||||
|
||||
### Effortless Interactions
|
||||
|
||||
[Effortless interaction areas identified based on conversation]
|
||||
|
||||
### Critical Success Moments
|
||||
|
||||
[Critical success moments defined based on conversation]
|
||||
|
||||
### Experience Principles
|
||||
|
||||
[Guiding principles for UX decisions based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated core experience content and present choices:
|
||||
"I've defined the core user experience for {{project_name}} based on our conversation. This establishes the foundation for all our UX design 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 - Let's refine the core experience definition
|
||||
[P] Party Mode - Bring different perspectives on the user experience
|
||||
[C] Continue - Save this to the document and move to emotional response definition"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-04-emotional-response.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Core user action clearly identified and defined
|
||||
✅ Platform requirements thoroughly explored
|
||||
✅ Effortless interaction areas identified
|
||||
✅ Critical success moments mapped out
|
||||
✅ Experience principles established as guiding framework
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Missing the core user action that defines the product
|
||||
❌ Not properly considering platform requirements
|
||||
❌ Overlooking what should be effortless for users
|
||||
❌ Not identifying critical make-or-break interactions
|
||||
❌ Experience principles too generic or not actionable
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,219 @@
|
||||
# Step 4: Desired Emotional Response
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating emotional response content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper emotional insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define optimal emotional responses
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Core experience definition from step 3 informs emotional response
|
||||
- No additional data files needed for this step
|
||||
- Focus on user feelings and emotional design goals
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define the desired emotional responses users should feel when using the product.
|
||||
|
||||
## EMOTIONAL RESPONSE DISCOVERY SEQUENCE:
|
||||
|
||||
### 1. Explore Core Emotional Goals
|
||||
|
||||
Start by understanding the emotional objectives:
|
||||
"Now let's think about how {{project_name}} should make users feel.
|
||||
|
||||
**Emotional Response Questions:**
|
||||
|
||||
- What should users FEEL when using this product?
|
||||
- What emotion would make them tell a friend about this?
|
||||
- How should users feel after accomplishing their primary goal?
|
||||
- What feeling differentiates this from competitors?
|
||||
|
||||
Common emotional goals: Empowered and in control? Delighted and surprised? Efficient and productive? Creative and inspired? Calm and focused? Connected and engaged?"
|
||||
|
||||
### 2. Identify Emotional Journey Mapping
|
||||
|
||||
Explore feelings at different stages:
|
||||
"**Emotional Journey Considerations:**
|
||||
|
||||
- How should users feel when they first discover the product?
|
||||
- What emotion during the core experience/action?
|
||||
- How should they feel after completing their task?
|
||||
- What if something goes wrong - what emotional response do we want?
|
||||
- How should they feel when returning to use it again?"
|
||||
|
||||
### 3. Define Micro-Emotions
|
||||
|
||||
Surface subtle but important emotional states:
|
||||
"**Micro-Emotions to Consider:**
|
||||
|
||||
- Confidence vs. Confusion
|
||||
- Trust vs. Skepticism
|
||||
- Excitement vs. Anxiety
|
||||
- Accomplishment vs. Frustration
|
||||
- Delight vs. Satisfaction
|
||||
- Belonging vs. Isolation
|
||||
|
||||
Which of these emotional states are most critical for your product's success?"
|
||||
|
||||
### 4. Connect Emotions to UX Decisions
|
||||
|
||||
Link feelings to design implications:
|
||||
"**Design Implications:**
|
||||
|
||||
- If we want users to feel [emotional state], what UX choices support this?
|
||||
- What interactions might create negative emotions we want to avoid?
|
||||
- Where can we add moments of delight or surprise?
|
||||
- How do we build trust and confidence through design?
|
||||
|
||||
**Emotion-Design Connections:**
|
||||
|
||||
- [Emotion 1] → [UX design approach]
|
||||
- [Emotion 2] → [UX design approach]
|
||||
- [Emotion 3] → [UX design approach]"
|
||||
|
||||
### 5. Validate Emotional Goals
|
||||
|
||||
Check if emotional goals align with product vision:
|
||||
"Let me make sure I understand the emotional vision for {{project_name}}:
|
||||
|
||||
**Primary Emotional Goal:** [Summarize main emotional response]
|
||||
**Secondary Feelings:** [List supporting emotional states]
|
||||
**Emotions to Avoid:** [List negative emotions to prevent]
|
||||
|
||||
Does this capture the emotional experience you want to create? Any adjustments needed?"
|
||||
|
||||
### 6. Generate Emotional Response Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Desired Emotional Response
|
||||
|
||||
### Primary Emotional Goals
|
||||
|
||||
[Primary emotional goals based on conversation]
|
||||
|
||||
### Emotional Journey Mapping
|
||||
|
||||
[Emotional journey mapping based on conversation]
|
||||
|
||||
### Micro-Emotions
|
||||
|
||||
[Micro-emotions identified based on conversation]
|
||||
|
||||
### Design Implications
|
||||
|
||||
[UX design implications for emotional responses based on conversation]
|
||||
|
||||
### Emotional Design Principles
|
||||
|
||||
[Guiding principles for emotional design based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated emotional response content and present choices:
|
||||
"I've defined the desired emotional responses for {{project_name}}. These emotional goals will guide our design decisions to create the right user experience.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine the emotional response definition
|
||||
[P] Party Mode - Bring different perspectives on user emotional needs
|
||||
[C] Continue - Save this to the document and move to inspiration analysis"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-05-inspiration.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Primary emotional goals clearly defined
|
||||
✅ Emotional journey mapped across user experience
|
||||
✅ Micro-emotions identified and addressed
|
||||
✅ Design implications connected to emotional responses
|
||||
✅ Emotional design principles established
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Missing core emotional goals or being too generic
|
||||
❌ Not considering emotional journey across different stages
|
||||
❌ Overlooking micro-emotions that impact user satisfaction
|
||||
❌ Not connecting emotional goals to specific UX design choices
|
||||
❌ Emotional principles too vague or not actionable
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,234 @@
|
||||
# Step 5: UX Pattern Analysis & Inspiration
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating inspiration analysis content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper pattern insights
|
||||
- **P ( Party Mode)**: Bring multiple perspectives to analyze UX patterns
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Emotional response goals from step 4 inform pattern analysis
|
||||
- No additional data files needed for this step
|
||||
- Focus on analyzing existing UX patterns and extracting lessons
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Analyze inspiring products and UX patterns to inform design decisions for the current project.
|
||||
|
||||
## INSPIRATION ANALYSIS SEQUENCE:
|
||||
|
||||
### 1. Identify User's Favorite Apps
|
||||
|
||||
Start by gathering inspiration sources:
|
||||
"Let's learn from products your users already love and use regularly.
|
||||
|
||||
**Inspiration Questions:**
|
||||
|
||||
- Name 2-3 apps your target users already love and USE frequently
|
||||
- For each one, what do they do well from a UX perspective?
|
||||
- What makes the experience compelling or delightful?
|
||||
- What keeps users coming back to these apps?
|
||||
|
||||
Think about apps in your category or even unrelated products that have great UX."
|
||||
|
||||
### 2. Analyze UX Patterns and Principles
|
||||
|
||||
Break down what makes these apps successful:
|
||||
"For each inspiring app, let's analyze their UX success:
|
||||
|
||||
**For [App Name]:**
|
||||
|
||||
- What core problem does it solve elegantly?
|
||||
- What makes the onboarding experience effective?
|
||||
- How do they handle navigation and information hierarchy?
|
||||
- What are their most innovative or delightful interactions?
|
||||
- What visual design choices support the user experience?
|
||||
- How do they handle errors or edge cases?"
|
||||
|
||||
### 3. Extract Transferable Patterns
|
||||
|
||||
Identify patterns that could apply to your project:
|
||||
"**Transferable UX Patterns:**
|
||||
Looking across these inspiring apps, I see patterns we could adapt:
|
||||
|
||||
**Navigation Patterns:**
|
||||
|
||||
- [Pattern 1] - could work for your [specific use case]
|
||||
- [Pattern 2] - might solve your [specific challenge]
|
||||
|
||||
**Interaction Patterns:**
|
||||
|
||||
- [Pattern 1] - excellent for [your user goal]
|
||||
- [Pattern 2] - addresses [your user pain point]
|
||||
|
||||
**Visual Patterns:**
|
||||
|
||||
- [Pattern 1] - supports your [emotional goal]
|
||||
- [Pattern 2] - aligns with your [platform requirements]
|
||||
|
||||
Which of these patterns resonate most for your product?"
|
||||
|
||||
### 4. Identify Anti-Patterns to Avoid
|
||||
|
||||
Surface what not to do based on analysis:
|
||||
"**UX Anti-Patterns to Avoid:**
|
||||
From analyzing both successes and failures in your space, here are patterns to avoid:
|
||||
|
||||
- [Anti-pattern 1] - users find this confusing/frustrating
|
||||
- [Anti-pattern 2] - this creates unnecessary friction
|
||||
- [Anti-pattern 3] - doesn't align with your [emotional goals]
|
||||
|
||||
Learning from others' mistakes is as important as learning from their successes."
|
||||
|
||||
### 5. Define Design Inspiration Strategy
|
||||
|
||||
Create a clear strategy for using this inspiration:
|
||||
"**Design Inspiration Strategy:**
|
||||
|
||||
**What to Adopt:**
|
||||
|
||||
- [Specific pattern] - because it supports [your core experience]
|
||||
- [Specific pattern] - because it aligns with [user needs]
|
||||
|
||||
**What to Adapt:**
|
||||
|
||||
- [Specific pattern] - modify for [your unique requirements]
|
||||
- [Specific pattern] - simplify for [your user skill level]
|
||||
|
||||
**What to Avoid:**
|
||||
|
||||
- [Specific anti-pattern] - conflicts with [your goals]
|
||||
- [Specific anti-pattern] - doesn't fit [your platform]
|
||||
|
||||
This strategy will guide our design decisions while keeping {{project_name}} unique."
|
||||
|
||||
### 6. Generate Inspiration Analysis Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## UX Pattern Analysis & Inspiration
|
||||
|
||||
### Inspiring Products Analysis
|
||||
|
||||
[Analysis of inspiring products based on conversation]
|
||||
|
||||
### Transferable UX Patterns
|
||||
|
||||
[Transferable patterns identified based on conversation]
|
||||
|
||||
### Anti-Patterns to Avoid
|
||||
|
||||
[Anti-patterns to avoid based on conversation]
|
||||
|
||||
### Design Inspiration Strategy
|
||||
|
||||
[Strategy for using inspiration based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated inspiration analysis content and present choices:
|
||||
"I've analyzed inspiring UX patterns and products to inform our design strategy for {{project_name}}. This gives us a solid foundation of proven patterns to build upon.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's deepen our UX pattern analysis
|
||||
[P] Party Mode - Bring different perspectives on inspiration sources
|
||||
[C] Continue - Save this to the document and move to design system choice"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load and execute`./step-06-design-system.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Inspiring products identified and analyzed thoroughly
|
||||
✅ UX patterns extracted and categorized effectively
|
||||
✅ Transferable patterns identified for current project
|
||||
✅ Anti-patterns identified to avoid common mistakes
|
||||
✅ Clear design inspiration strategy established
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not getting specific examples of inspiring products
|
||||
❌ Surface-level analysis without deep pattern extraction
|
||||
❌ Missing opportunities for pattern adaptation
|
||||
❌ Not identifying relevant anti-patterns to avoid
|
||||
❌ Strategy too generic or not actionable
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,252 @@
|
||||
# Step 6: Design System Choice
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE decision-making, not recommendation-only
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating design system decision content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper design system insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to evaluate design system options
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Platform requirements from step 3 inform design system choice
|
||||
- Inspiration patterns from step 5 guide design system selection
|
||||
- Focus on choosing foundation for consistent design
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Choose appropriate design system approach based on project requirements and constraints.
|
||||
|
||||
## DESIGN SYSTEM CHOICE SEQUENCE:
|
||||
|
||||
### 1. Present Design System Options
|
||||
|
||||
Educate about design system approaches:
|
||||
"For {{project_name}}, we need to choose a design system foundation. Think of design systems like LEGO blocks for UI - they provide proven components and patterns, ensuring consistency and speeding development.
|
||||
|
||||
**Design System Approaches:**
|
||||
|
||||
**1. Custom Design System**
|
||||
|
||||
- Complete visual uniqueness
|
||||
- Full control over every component
|
||||
- Higher initial investment
|
||||
- Perfect for established brands with unique needs
|
||||
|
||||
**2. Established System (Material Design, Ant Design, etc.)**
|
||||
|
||||
- Fast development with proven patterns
|
||||
- Great defaults and accessibility built-in
|
||||
- Less visual differentiation
|
||||
- Ideal for startups or internal tools
|
||||
|
||||
**3. Themeable System (MUI, Chakra UI, Tailwind UI)**
|
||||
|
||||
- Customizable with strong foundation
|
||||
- Brand flexibility with proven components
|
||||
- Moderate learning curve
|
||||
- Good balance of speed and uniqueness
|
||||
|
||||
Which direction feels right for your project?"
|
||||
|
||||
### 2. Analyze Project Requirements
|
||||
|
||||
Guide decision based on project context:
|
||||
"**Let's consider your specific needs:**
|
||||
|
||||
**Based on our previous conversations:**
|
||||
|
||||
- Platform: [platform from step 3]
|
||||
- Timeline: [inferred from user conversation]
|
||||
- Team Size: [inferred from user conversation]
|
||||
- Brand Requirements: [inferred from user conversation]
|
||||
- Technical Constraints: [inferred from user conversation]
|
||||
|
||||
**Decision Factors:**
|
||||
|
||||
- Need for speed vs. need for uniqueness
|
||||
- Brand guidelines or existing visual identity
|
||||
- Team's design expertise
|
||||
- Long-term maintenance considerations
|
||||
- Integration requirements with existing systems"
|
||||
|
||||
### 3. Explore Specific Design System Options
|
||||
|
||||
Dive deeper into relevant options:
|
||||
"**Recommended Options Based on Your Needs:**
|
||||
|
||||
**For [Your Platform Type]:**
|
||||
|
||||
- [Option 1] - [Key benefit] - [Best for scenario]
|
||||
- [Option 2] - [Key benefit] - [Best for scenario]
|
||||
- [Option 3] - [Key benefit] - [Best for scenario]
|
||||
|
||||
**Considerations:**
|
||||
|
||||
- Component library size and quality
|
||||
- Documentation and community support
|
||||
- Customization capabilities
|
||||
- Accessibility compliance
|
||||
- Performance characteristics
|
||||
- Learning curve for your team"
|
||||
|
||||
### 4. Facilitate Decision Process
|
||||
|
||||
Help user make informed choice:
|
||||
"**Decision Framework:**
|
||||
|
||||
1. What's most important: Speed, uniqueness, or balance?
|
||||
2. How much design expertise does your team have?
|
||||
3. Are there existing brand guidelines to follow?
|
||||
4. What's your timeline and budget?
|
||||
5. Long-term maintenance needs?
|
||||
|
||||
Let's evaluate options based on your answers to these questions."
|
||||
|
||||
### 5. Finalize Design System Choice
|
||||
|
||||
Confirm and document the decision:
|
||||
"Based on our analysis, I recommend [Design System Choice] for {{project_name}}.
|
||||
|
||||
**Rationale:**
|
||||
|
||||
- [Reason 1 based on project needs]
|
||||
- [Reason 2 based on constraints]
|
||||
- [Reason 3 based on team considerations]
|
||||
|
||||
**Next Steps:**
|
||||
|
||||
- We'll customize this system to match your brand and needs
|
||||
- Define component strategy for custom components needed
|
||||
- Establish design tokens and patterns
|
||||
|
||||
Does this design system choice feel right to you?"
|
||||
|
||||
### 6. Generate Design System Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Design System Foundation
|
||||
|
||||
### 1.1 Design System Choice
|
||||
|
||||
[Design system choice based on conversation]
|
||||
|
||||
### Rationale for Selection
|
||||
|
||||
[Rationale for design system selection based on conversation]
|
||||
|
||||
### Implementation Approach
|
||||
|
||||
[Implementation approach based on chosen system]
|
||||
|
||||
### Customization Strategy
|
||||
|
||||
[Customization strategy based on project needs]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated design system content and present choices:
|
||||
"I've documented our design system choice for {{project_name}}. This foundation will ensure consistency and speed up development.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our design system decision
|
||||
[P] Party Mode - Bring technical perspectives on design systems
|
||||
[C] Continue - Save this to the document and move to defining experience
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-07-defining-experience.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Design system options clearly presented and explained
|
||||
✅ Decision framework applied to project requirements
|
||||
✅ Specific design system chosen with clear rationale
|
||||
✅ Implementation approach planned
|
||||
✅ Customization strategy defined
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not explaining design system concepts clearly
|
||||
❌ Rushing to recommendation without understanding requirements
|
||||
❌ Not considering technical constraints or team capabilities
|
||||
❌ Choosing design system without clear rationale
|
||||
❌ Not planning implementation approach
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,254 @@
|
||||
# Step 7: Defining Core Experience
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating defining experience content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper experience insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define optimal core experience
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Core experience from step 3 provides foundation
|
||||
- Design system choice from step 6 informs implementation
|
||||
- Focus on the defining interaction that makes the product special
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define the core interaction that, if nailed, makes everything else follow in the user experience.
|
||||
|
||||
## DEFINING EXPERIENCE SEQUENCE:
|
||||
|
||||
### 1. Identify the Defining Experience
|
||||
|
||||
Focus on the core interaction:
|
||||
"Every successful product has a defining experience - the core interaction that, if we nail it, everything else follows.
|
||||
|
||||
**Think about these famous examples:**
|
||||
|
||||
- Tinder: "Swipe to match with people"
|
||||
- Snapchat: "Share photos that disappear"
|
||||
- Instagram: "Share perfect moments with filters"
|
||||
- Spotify: "Discover and play any song instantly"
|
||||
|
||||
**For {{project_name}}:**
|
||||
What's the core action that users will describe to their friends?
|
||||
What's the interaction that makes users feel successful?
|
||||
If we get ONE thing perfectly right, what should it be?"
|
||||
|
||||
### 2. Explore the User's Mental Model
|
||||
|
||||
Understand how users think about the core task:
|
||||
"**User Mental Model Questions:**
|
||||
|
||||
- How do users currently solve this problem?
|
||||
- What mental model do they bring to this task?
|
||||
- What's their expectation for how this should work?
|
||||
- Where are they likely to get confused or frustrated?
|
||||
|
||||
**Current Solutions:**
|
||||
|
||||
- What do users love/hate about existing approaches?
|
||||
- What shortcuts or workarounds do they use?
|
||||
- What makes existing solutions feel magical or terrible?"
|
||||
|
||||
### 3. Define Success Criteria for Core Experience
|
||||
|
||||
Establish what makes the core interaction successful:
|
||||
"**Core Experience Success Criteria:**
|
||||
|
||||
- What makes users say 'this just works'?
|
||||
- When do they feel smart or accomplished?
|
||||
- What feedback tells them they're doing it right?
|
||||
- How fast should it feel?
|
||||
- What should happen automatically?
|
||||
|
||||
**Success Indicators:**
|
||||
|
||||
- [Success indicator 1]
|
||||
- [Success indicator 2]
|
||||
- [Success indicator 3]"
|
||||
|
||||
### 4. Identify Novel vs. Established Patterns
|
||||
|
||||
Determine if we need to innovate or can use proven patterns:
|
||||
"**Pattern Analysis:**
|
||||
Looking at your core experience, does this:
|
||||
|
||||
- Use established UX patterns that users already understand?
|
||||
- Require novel interaction design that needs user education?
|
||||
- Combine familiar patterns in innovative ways?
|
||||
|
||||
**If Novel:**
|
||||
|
||||
- What makes this different from existing approaches?
|
||||
- How will we teach users this new pattern?
|
||||
- What familiar metaphors can we use?
|
||||
|
||||
**If Established:**
|
||||
|
||||
- Which proven patterns should we adopt?
|
||||
- How can we innovate within familiar patterns?
|
||||
- What's our unique twist on established interactions?"
|
||||
|
||||
### 5. Define Experience Mechanics
|
||||
|
||||
Break down the core interaction into details:
|
||||
"**Core Experience Mechanics:**
|
||||
Let's design the step-by-step flow for [defining experience]:
|
||||
|
||||
**1. Initiation:**
|
||||
|
||||
- How does the user start this action?
|
||||
- What triggers or invites them to begin?
|
||||
|
||||
**2. Interaction:**
|
||||
|
||||
- What does the user actually do?
|
||||
- What controls or inputs do they use?
|
||||
- How does the system respond?
|
||||
|
||||
**3. Feedback:**
|
||||
|
||||
- What tells users they're succeeding?
|
||||
- How do they know when it's working?
|
||||
- What happens if they make a mistake?
|
||||
|
||||
**4. Completion:**
|
||||
|
||||
- How do users know they're done?
|
||||
- What's the successful outcome?
|
||||
- What's next?"
|
||||
|
||||
### 6. Generate Defining Experience Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## 2. Core User Experience
|
||||
|
||||
### 2.1 Defining Experience
|
||||
|
||||
[Defining experience description based on conversation]
|
||||
|
||||
### 2.2 User Mental Model
|
||||
|
||||
[User mental model analysis based on conversation]
|
||||
|
||||
### 2.3 Success Criteria
|
||||
|
||||
[Success criteria for core experience based on conversation]
|
||||
|
||||
### 2.4 Novel UX Patterns
|
||||
|
||||
[Novel UX patterns analysis based on conversation]
|
||||
|
||||
### 2.5 Experience Mechanics
|
||||
|
||||
[Detailed mechanics for core experience based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated defining experience content and present choices:
|
||||
"I've defined the core experience for {{project_name}} - the interaction that will make users love this product.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine the core experience definition
|
||||
[P] Party Mode - Bring different perspectives on the defining interaction
|
||||
[C] Continue - Save this to the document and move to visual foundation
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-08-visual-foundation.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Defining experience clearly articulated
|
||||
✅ User mental model thoroughly analyzed
|
||||
✅ Success criteria established for core interaction
|
||||
✅ Novel vs. established patterns properly evaluated
|
||||
✅ Experience mechanics designed in detail
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not identifying the true core interaction
|
||||
❌ Missing user's mental model and expectations
|
||||
❌ Not establishing clear success criteria
|
||||
❌ Not properly evaluating novel vs. established patterns
|
||||
❌ Experience mechanics too vague or incomplete
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,224 @@
|
||||
# Step 8: Visual Foundation
|
||||
|
||||
## 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)
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating visual foundation content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper visual insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define visual foundation
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Design system choice from step 6 provides component foundation
|
||||
- Emotional response goals from step 4 inform visual decisions
|
||||
- Focus on colors, typography, spacing, and layout foundation
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Establish the visual design foundation including color themes, typography, and spacing systems.
|
||||
|
||||
## VISUAL FOUNDATION SEQUENCE:
|
||||
|
||||
### 1. Brand Guidelines Assessment
|
||||
|
||||
Check for existing brand requirements:
|
||||
"Do you have existing brand guidelines or a specific color palette I should follow? (y/n)
|
||||
|
||||
If yes, I'll extract and document your brand colors and create semantic color mappings.
|
||||
If no, I'll generate theme options based on your project's personality and emotional goals from our earlier discussion."
|
||||
|
||||
### 2. Generate Color Theme Options (If no brand guidelines)
|
||||
|
||||
Create visual exploration opportunities:
|
||||
"If no existing brand guidelines, I'll create a color theme visualizer to help you explore options.
|
||||
|
||||
🎨 I can generate comprehensive HTML color theme visualizers with multiple theme options, complete UI examples, and the ability to see how colors work in real interface contexts.
|
||||
|
||||
This will help you make an informed decision about the visual direction for {{project_name}}."
|
||||
|
||||
### 3. Define Typography System
|
||||
|
||||
Establish the typographic foundation:
|
||||
"**Typography Questions:**
|
||||
|
||||
- What should the overall tone feel like? (Professional, friendly, modern, classic?)
|
||||
- How much text content will users read? (Headings only? Long-form content?)
|
||||
- Any accessibility requirements for font sizes or contrast?
|
||||
- Any brand fonts we must use?
|
||||
|
||||
**Typography Strategy:**
|
||||
|
||||
- Choose primary and secondary typefaces
|
||||
- Establish type scale (h1, h2, h3, body, etc.)
|
||||
- Define line heights and spacing relationships
|
||||
- Consider readability and accessibility"
|
||||
|
||||
### 4. Establish Spacing and Layout Foundation
|
||||
|
||||
Define the structural foundation:
|
||||
"**Spacing and Layout Foundation:**
|
||||
|
||||
- How should the overall layout feel? (Dense and efficient? Airy and spacious?)
|
||||
- What spacing unit should we use? (4px, 8px, 12px base?)
|
||||
- How much white space should be between elements?
|
||||
- Should we use a grid system? If so, what column structure?
|
||||
|
||||
**Layout Principles:**
|
||||
|
||||
- [Layout principle 1 based on product type]
|
||||
- [Layout principle 2 based on user needs]
|
||||
- [Layout principle 3 based on platform requirements]"
|
||||
|
||||
### 5. Create Visual Foundation Strategy
|
||||
|
||||
Synthesize all visual decisions:
|
||||
"**Visual Foundation Strategy:**
|
||||
|
||||
**Color System:**
|
||||
|
||||
- [Color strategy based on brand guidelines or generated themes]
|
||||
- Semantic color mapping (primary, secondary, success, warning, error, etc.)
|
||||
- Accessibility compliance (contrast ratios)
|
||||
|
||||
**Typography System:**
|
||||
|
||||
- [Typography strategy based on content needs and tone]
|
||||
- Type scale and hierarchy
|
||||
- Font pairing rationale
|
||||
|
||||
**Spacing & Layout:**
|
||||
|
||||
- [Spacing strategy based on content density and platform]
|
||||
- Grid system approach
|
||||
- Component spacing relationships
|
||||
|
||||
This foundation will ensure consistency across all our design decisions."
|
||||
|
||||
### 6. Generate Visual Foundation Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Visual Design Foundation
|
||||
|
||||
### Color System
|
||||
|
||||
[Color system strategy based on conversation]
|
||||
|
||||
### Typography System
|
||||
|
||||
[Typography system strategy based on conversation]
|
||||
|
||||
### Spacing & Layout Foundation
|
||||
|
||||
[Spacing and layout foundation based on conversation]
|
||||
|
||||
### Accessibility Considerations
|
||||
|
||||
[Accessibility considerations based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated visual foundation content and present choices:
|
||||
"I've established the visual design foundation for {{project_name}}. This provides the building blocks for consistent, beautiful design.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our visual foundation
|
||||
[P] Party Mode - Bring design perspectives on visual choices
|
||||
[C] Continue - Save this to the document and move to design directions
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-09-design-directions.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Brand guidelines assessed and incorporated if available
|
||||
✅ Color system established with accessibility consideration
|
||||
✅ Typography system defined with appropriate hierarchy
|
||||
✅ Spacing and layout foundation created
|
||||
✅ Visual foundation strategy documented
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not checking for existing brand guidelines first
|
||||
❌ Color palette not aligned with emotional goals
|
||||
❌ Typography not suitable for content type or readability needs
|
||||
❌ Spacing system not appropriate for content density
|
||||
❌ Missing accessibility considerations
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-09 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,224 @@
|
||||
# Step 9: Design Direction Mockups
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE exploration, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating design direction content
|
||||
- 💾 Generate HTML visualizer for design directions
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper design insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to evaluate design directions
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Visual foundation from step 8 provides design tokens
|
||||
- Core experience from step 7 informs layout and interaction design
|
||||
- Focus on exploring different visual design directions
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Generate comprehensive design direction mockups showing different visual approaches for the product.
|
||||
|
||||
## DESIGN DIRECTIONS SEQUENCE:
|
||||
|
||||
### 1. Generate Design Direction Variations
|
||||
|
||||
Create diverse visual explorations:
|
||||
"I'll generate 6-8 different design direction variations exploring:
|
||||
|
||||
- Different layout approaches and information hierarchy
|
||||
- Various interaction patterns and visual weights
|
||||
- Alternative color applications from our foundation
|
||||
- Different density and spacing approaches
|
||||
- Various navigation and component arrangements
|
||||
|
||||
Each mockup will show a complete vision for {{project_name}} with all our design decisions applied."
|
||||
|
||||
### 2. Create HTML Design Direction Showcase
|
||||
|
||||
Generate interactive visual exploration:
|
||||
"🎨 Design Direction Mockups Generated!
|
||||
|
||||
I'm creating a comprehensive HTML design direction showcase at `{planning_artifacts}/ux-design-directions.html`
|
||||
|
||||
**What you'll see:**
|
||||
|
||||
- 6-8 full-screen mockup variations
|
||||
- Interactive states and hover effects
|
||||
- Side-by-side comparison tools
|
||||
- Complete UI examples with real content
|
||||
- Responsive behavior demonstrations
|
||||
|
||||
Each mockup represents a complete visual direction for your app's look and feel."
|
||||
|
||||
### 3. Present Design Exploration Framework
|
||||
|
||||
Guide evaluation criteria:
|
||||
"As you explore the design directions, look for:
|
||||
|
||||
✅ **Layout Intuitiveness** - Which information hierarchy matches your priorities?
|
||||
✅ **Interaction Style** - Which interaction style fits your core experience?
|
||||
✅ **Visual Weight** - Which visual density feels right for your brand?
|
||||
✅ **Navigation Approach** - Which navigation pattern matches user expectations?
|
||||
✅ **Component Usage** - How well do the components support your user journeys?
|
||||
✅ **Brand Alignment** - Which direction best supports your emotional goals?
|
||||
|
||||
Take your time exploring - this is a crucial decision that will guide all our design work!"
|
||||
|
||||
### 4. Facilitate Design Direction Selection
|
||||
|
||||
Help user choose or combine elements:
|
||||
"After exploring all the design directions:
|
||||
|
||||
**Which approach resonates most with you?**
|
||||
|
||||
- Pick a favorite direction as-is
|
||||
- Combine elements from multiple directions
|
||||
- Request modifications to any direction
|
||||
- Use one direction as a base and iterate
|
||||
|
||||
**Tell me:**
|
||||
|
||||
- Which layout feels most intuitive for your users?
|
||||
- Which visual weight matches your brand personality?
|
||||
- Which interaction style supports your core experience?
|
||||
- Are there elements from different directions you'd like to combine?"
|
||||
|
||||
### 5. Document Design Direction Decision
|
||||
|
||||
Capture the chosen approach:
|
||||
"Based on your exploration, I'm understanding your design direction preference:
|
||||
|
||||
**Chosen Direction:** [Direction number or combination]
|
||||
**Key Elements:** [Specific elements you liked]
|
||||
**Modifications Needed:** [Any changes requested]
|
||||
**Rationale:** [Why this direction works for your product]
|
||||
|
||||
This will become our design foundation moving forward. Are we ready to lock this in, or do you want to explore variations?"
|
||||
|
||||
### 6. Generate Design Direction Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Design Direction Decision
|
||||
|
||||
### Design Directions Explored
|
||||
|
||||
[Summary of design directions explored based on conversation]
|
||||
|
||||
### Chosen Direction
|
||||
|
||||
[Chosen design direction based on conversation]
|
||||
|
||||
### Design Rationale
|
||||
|
||||
[Rationale for design direction choice based on conversation]
|
||||
|
||||
### Implementation Approach
|
||||
|
||||
[Implementation approach based on chosen direction]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated design direction content and present choices:
|
||||
"I've documented our design direction decision for {{project_name}}. This visual approach will guide all our detailed design work.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our design direction
|
||||
[P] Party Mode - Bring different perspectives on visual choices
|
||||
[C] Continue - Save this to the document and move to user journey flows
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-10-user-journeys.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Multiple design direction variations generated
|
||||
✅ HTML showcase created with interactive elements
|
||||
✅ Design evaluation criteria clearly established
|
||||
✅ User able to explore and compare directions effectively
|
||||
✅ Design direction decision made with clear rationale
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not creating enough variation in design directions
|
||||
❌ Design directions not aligned with established foundation
|
||||
❌ Missing interactive elements in HTML showcase
|
||||
❌ Not providing clear evaluation criteria
|
||||
❌ Rushing decision without thorough exploration
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,241 @@
|
||||
# Step 10: User Journey Flows
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE flow design, not assumption-based layouts
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating user journey content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper journey insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to design user flows
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Design direction from step 9 informs flow layout and visual design
|
||||
- Core experience from step 7 defines key journey interactions
|
||||
- Focus on designing detailed user flows with Mermaid diagrams
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Design detailed user journey flows for critical user interactions.
|
||||
|
||||
## USER JOURNEY FLOWS SEQUENCE:
|
||||
|
||||
### 1. Load PRD User Journeys as Foundation
|
||||
|
||||
Start with user journeys already defined in the PRD:
|
||||
"Great! Since we have the PRD available, let's build on the user journeys already documented there.
|
||||
|
||||
**Existing User Journeys from PRD:**
|
||||
I've already loaded these user journeys from your PRD:
|
||||
[Journey narratives from PRD input documents]
|
||||
|
||||
These journeys tell us **who** users are and **why** they take certain actions. Now we need to design **how** those journeys work in detail.
|
||||
|
||||
**Critical Journeys to Design Flows For:**
|
||||
Looking at the PRD journeys, I need to design detailed interaction flows for:
|
||||
|
||||
- [Critical journey 1 identified from PRD narratives]
|
||||
- [Critical journey 2 identified from PRD narratives]
|
||||
- [Critical journey 3 identified from PRD narratives]
|
||||
|
||||
The PRD gave us the stories - now we design the mechanics!"
|
||||
|
||||
### 2. Design Each Journey Flow
|
||||
|
||||
For each critical journey, design detailed flow:
|
||||
|
||||
**For [Journey Name]:**
|
||||
"Let's design the flow for users accomplishing [journey goal].
|
||||
|
||||
**Flow Design Questions:**
|
||||
|
||||
- How do users start this journey? (entry point)
|
||||
- What information do they need at each step?
|
||||
- What decisions do they need to make?
|
||||
- How do they know they're progressing successfully?
|
||||
- What does success look like for this journey?
|
||||
- Where might they get confused or stuck?
|
||||
- How do they recover from errors?"
|
||||
|
||||
### 3. Create Flow Diagrams
|
||||
|
||||
Visualize each journey with Mermaid diagrams:
|
||||
"I'll create detailed flow diagrams for each journey showing:
|
||||
|
||||
**[Journey Name] Flow:**
|
||||
|
||||
- Entry points and triggers
|
||||
- Decision points and branches
|
||||
- Success and failure paths
|
||||
- Error recovery mechanisms
|
||||
- Progressive disclosure of information
|
||||
|
||||
Each diagram will map the complete user experience from start to finish."
|
||||
|
||||
### 4. Optimize for Efficiency and Delight
|
||||
|
||||
Refine flows for optimal user experience:
|
||||
"**Flow Optimization:**
|
||||
For each journey, let's ensure we're:
|
||||
|
||||
- Minimizing steps to value (getting users to success quickly)
|
||||
- Reducing cognitive load at each decision point
|
||||
- Providing clear feedback and progress indicators
|
||||
- Creating moments of delight or accomplishment
|
||||
- Handling edge cases and error recovery gracefully
|
||||
|
||||
**Specific Optimizations:**
|
||||
|
||||
- [Optimization 1 for journey efficiency]
|
||||
- [Optimization 2 for user delight]
|
||||
- [Optimization 3 for error handling]"
|
||||
|
||||
### 5. Document Journey Patterns
|
||||
|
||||
Extract reusable patterns across journeys:
|
||||
"**Journey Patterns:**
|
||||
Across these flows, I'm seeing some common patterns we can standardize:
|
||||
|
||||
**Navigation Patterns:**
|
||||
|
||||
- [Navigation pattern 1]
|
||||
- [Navigation pattern 2]
|
||||
|
||||
**Decision Patterns:**
|
||||
|
||||
- [Decision pattern 1]
|
||||
- [Decision pattern 2]
|
||||
|
||||
**Feedback Patterns:**
|
||||
|
||||
- [Feedback pattern 1]
|
||||
- [Feedback pattern 2]
|
||||
|
||||
These patterns will ensure consistency across all user experiences."
|
||||
|
||||
### 6. Generate User Journey Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## User Journey Flows
|
||||
|
||||
### [Journey 1 Name]
|
||||
|
||||
[Journey 1 description and Mermaid diagram]
|
||||
|
||||
### [Journey 2 Name]
|
||||
|
||||
[Journey 2 description and Mermaid diagram]
|
||||
|
||||
### Journey Patterns
|
||||
|
||||
[Journey patterns identified based on conversation]
|
||||
|
||||
### Flow Optimization Principles
|
||||
|
||||
[Flow optimization principles based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated user journey content and present choices:
|
||||
"I've designed detailed user journey flows for {{project_name}}. These flows will guide the detailed design of each user interaction.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our user journey designs
|
||||
[P] Party Mode - Bring different perspectives on user flows
|
||||
[C] Continue - Save this to the document and move to component strategy
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-11-component-strategy.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Critical user journeys identified and designed
|
||||
✅ Detailed flow diagrams created for each journey
|
||||
✅ Flows optimized for efficiency and user delight
|
||||
✅ Common journey patterns extracted and documented
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not identifying all critical user journeys
|
||||
❌ Flows too complex or not optimized for user success
|
||||
❌ Missing error recovery paths
|
||||
❌ Not extracting reusable patterns across journeys
|
||||
❌ Flow diagrams unclear or incomplete
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,248 @@
|
||||
# Step 11: Component Strategy
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE component planning, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating component strategy content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper component insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define component strategy
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Design system choice from step 6 determines available components
|
||||
- User journeys from step 10 identify component needs
|
||||
- Focus on defining custom components and implementation strategy
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define component library strategy and design custom components not covered by the design system.
|
||||
|
||||
## COMPONENT STRATEGY SEQUENCE:
|
||||
|
||||
### 1. Analyze Design System Coverage
|
||||
|
||||
Review what components are available vs. needed:
|
||||
"Based on our chosen design system [design system from step 6], let's identify what components are already available and what we need to create custom.
|
||||
|
||||
**Available from Design System:**
|
||||
[List of components available in chosen design system]
|
||||
|
||||
**Components Needed for {{project_name}}:**
|
||||
Looking at our user journeys and design direction, we need:
|
||||
|
||||
- [Component need 1 from journey analysis]
|
||||
- [Component need 2 from design requirements]
|
||||
- [Component need 3 from core experience]
|
||||
|
||||
**Gap Analysis:**
|
||||
|
||||
- [Gap 1 - needed but not available]
|
||||
- [Gap 2 - needed but not available]"
|
||||
|
||||
### 2. Design Custom Components
|
||||
|
||||
For each custom component needed, design thoroughly:
|
||||
|
||||
**For each custom component:**
|
||||
"**[Component Name] Design:**
|
||||
|
||||
**Purpose:** What does this component do for users?
|
||||
**Content:** What information or data does it display?
|
||||
**Actions:** What can users do with this component?
|
||||
**States:** What different states does it have? (default, hover, active, disabled, error, etc.)
|
||||
**Variants:** Are there different sizes or styles needed?
|
||||
**Accessibility:** What ARIA labels and keyboard support needed?
|
||||
|
||||
Let's walk through each custom component systematically."
|
||||
|
||||
### 3. Document Component Specifications
|
||||
|
||||
Create detailed specifications for each component:
|
||||
|
||||
**Component Specification Template:**
|
||||
|
||||
```markdown
|
||||
### [Component Name]
|
||||
|
||||
**Purpose:** [Clear purpose statement]
|
||||
**Usage:** [When and how to use]
|
||||
**Anatomy:** [Visual breakdown of parts]
|
||||
**States:** [All possible states with descriptions]
|
||||
**Variants:** [Different sizes/styles if applicable]
|
||||
**Accessibility:** [ARIA labels, keyboard navigation]
|
||||
**Content Guidelines:** [What content works best]
|
||||
**Interaction Behavior:** [How users interact]
|
||||
```
|
||||
|
||||
### 4. Define Component Strategy
|
||||
|
||||
Establish overall component library approach:
|
||||
"**Component Strategy:**
|
||||
|
||||
**Foundation Components:** (from design system)
|
||||
|
||||
- [Foundation component 1]
|
||||
- [Foundation component 2]
|
||||
|
||||
**Custom Components:** (designed in this step)
|
||||
|
||||
- [Custom component 1 with rationale]
|
||||
- [Custom component 2 with rationale]
|
||||
|
||||
**Implementation Approach:**
|
||||
|
||||
- Build custom components using design system tokens
|
||||
- Ensure consistency with established patterns
|
||||
- Follow accessibility best practices
|
||||
- Create reusable patterns for common use cases"
|
||||
|
||||
### 5. Plan Implementation Roadmap
|
||||
|
||||
Define how and when to build components:
|
||||
"**Implementation Roadmap:**
|
||||
|
||||
**Phase 1 - Core Components:**
|
||||
|
||||
- [Component 1] - needed for [critical flow]
|
||||
- [Component 2] - needed for [critical flow]
|
||||
|
||||
**Phase 2 - Supporting Components:**
|
||||
|
||||
- [Component 3] - enhances [user experience]
|
||||
- [Component 4] - supports [design pattern]
|
||||
|
||||
**Phase 3 - Enhancement Components:**
|
||||
|
||||
- [Component 5] - optimizes [user journey]
|
||||
- [Component 6] - adds [special feature]
|
||||
|
||||
This roadmap helps prioritize development based on user journey criticality."
|
||||
|
||||
### 6. Generate Component Strategy Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Component Strategy
|
||||
|
||||
### Design System Components
|
||||
|
||||
[Analysis of available design system components based on conversation]
|
||||
|
||||
### Custom Components
|
||||
|
||||
[Custom component specifications based on conversation]
|
||||
|
||||
### Component Implementation Strategy
|
||||
|
||||
[Component implementation strategy based on conversation]
|
||||
|
||||
### Implementation Roadmap
|
||||
|
||||
[Implementation roadmap based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated component strategy content and present choices:
|
||||
"I've defined the component strategy for {{project_name}}. This balances using proven design system components with custom components for your unique needs.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our component strategy
|
||||
[P] Party Mode - Bring technical perspectives on component design
|
||||
[C] Continue - Save this to the document and move to UX patterns
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-12-ux-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Design system coverage properly analyzed
|
||||
✅ All custom components thoroughly specified
|
||||
✅ Component strategy clearly defined
|
||||
✅ Implementation roadmap prioritized by user need
|
||||
✅ Accessibility considered for all components
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not analyzing design system coverage properly
|
||||
❌ Custom components not thoroughly specified
|
||||
❌ Missing accessibility considerations
|
||||
❌ Component strategy not aligned with user journeys
|
||||
❌ Implementation roadmap not prioritized effectively
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,237 @@
|
||||
# Step 12: UX Consistency Patterns
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE pattern definition, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating UX patterns content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper pattern insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define UX patterns
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Component strategy from step 11 informs pattern decisions
|
||||
- User journeys from step 10 identify common pattern needs
|
||||
- Focus on consistency patterns for common UX situations
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Establish UX consistency patterns for common situations like buttons, forms, navigation, and feedback.
|
||||
|
||||
## UX PATTERNS SEQUENCE:
|
||||
|
||||
### 1. Identify Pattern Categories
|
||||
|
||||
Determine which patterns need definition for your product:
|
||||
"Let's establish consistency patterns for how {{project_name}} behaves in common situations.
|
||||
|
||||
**Pattern Categories to Define:**
|
||||
|
||||
- Button hierarchy and actions
|
||||
- Feedback patterns (success, error, warning, info)
|
||||
- Form patterns and validation
|
||||
- Navigation patterns
|
||||
- Modal and overlay patterns
|
||||
- Empty states and loading states
|
||||
- Search and filtering patterns
|
||||
|
||||
Which categories are most critical for your product? We can go through each thoroughly or focus on the most important ones."
|
||||
|
||||
### 2. Define Critical Patterns First
|
||||
|
||||
Focus on patterns most relevant to your product:
|
||||
|
||||
**For [Critical Pattern Category]:**
|
||||
"**[Pattern Type] Patterns:**
|
||||
What should users see/do when they need to [pattern action]?
|
||||
|
||||
**Considerations:**
|
||||
|
||||
- Visual hierarchy (primary vs. secondary actions)
|
||||
- Feedback mechanisms
|
||||
- Error recovery
|
||||
- Accessibility requirements
|
||||
- Mobile vs. desktop considerations
|
||||
|
||||
**Examples:**
|
||||
|
||||
- [Example 1 for this pattern type]
|
||||
- [Example 2 for this pattern type]
|
||||
|
||||
How should {{project_name}} handle [pattern type] interactions?"
|
||||
|
||||
### 3. Establish Pattern Guidelines
|
||||
|
||||
Document specific design decisions:
|
||||
|
||||
**Pattern Guidelines Template:**
|
||||
|
||||
```markdown
|
||||
### [Pattern Type]
|
||||
|
||||
**When to Use:** [Clear usage guidelines]
|
||||
**Visual Design:** [How it should look]
|
||||
**Behavior:** [How it should interact]
|
||||
**Accessibility:** [A11y requirements]
|
||||
**Mobile Considerations:** [Mobile-specific needs]
|
||||
**Variants:** [Different states or styles if applicable]
|
||||
```
|
||||
|
||||
### 4. Design System Integration
|
||||
|
||||
Ensure patterns work with chosen design system:
|
||||
"**Integration with [Design System]:**
|
||||
|
||||
- How do these patterns complement our design system components?
|
||||
- What customizations are needed?
|
||||
- How do we maintain consistency while meeting unique needs?
|
||||
|
||||
**Custom Pattern Rules:**
|
||||
|
||||
- [Custom rule 1]
|
||||
- [Custom rule 2]
|
||||
- [Custom rule 3]"
|
||||
|
||||
### 5. Create Pattern Documentation
|
||||
|
||||
Generate comprehensive pattern library:
|
||||
|
||||
**Pattern Library Structure:**
|
||||
|
||||
- Clear usage guidelines for each pattern
|
||||
- Visual examples and specifications
|
||||
- Implementation notes for developers
|
||||
- Accessibility checklists
|
||||
- Mobile-first considerations
|
||||
|
||||
### 6. Generate UX Patterns Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## UX Consistency Patterns
|
||||
|
||||
### Button Hierarchy
|
||||
|
||||
[Button hierarchy patterns based on conversation]
|
||||
|
||||
### Feedback Patterns
|
||||
|
||||
[Feedback patterns based on conversation]
|
||||
|
||||
### Form Patterns
|
||||
|
||||
[Form patterns based on conversation]
|
||||
|
||||
### Navigation Patterns
|
||||
|
||||
[Navigation patterns based on conversation]
|
||||
|
||||
### Additional Patterns
|
||||
|
||||
[Additional patterns based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated UX patterns content and present choices:
|
||||
"I've established UX consistency patterns for {{project_name}}. These patterns ensure users have a consistent, predictable experience across all interactions.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our UX patterns
|
||||
[P] Party Mode - Bring different perspectives on consistency patterns
|
||||
[C] Continue - Save this to the document and move to responsive design
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-13-responsive-accessibility.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Critical pattern categories identified and prioritized
|
||||
✅ Consistency patterns clearly defined and documented
|
||||
✅ Patterns integrated with chosen design system
|
||||
✅ Accessibility considerations included for all patterns
|
||||
✅ Mobile-first approach incorporated
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not identifying the most critical pattern categories
|
||||
❌ Patterns too generic or not actionable
|
||||
❌ Missing accessibility considerations
|
||||
❌ Patterns not aligned with design system
|
||||
❌ Not considering mobile differences
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-13 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,264 @@
|
||||
# Step 13: Responsive Design & Accessibility
|
||||
|
||||
## 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
|
||||
- 🎯 COLLABORATIVE strategy definition, not assumption-based design
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating responsive/accessibility content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper responsive/accessibility insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define responsive/accessibility strategy
|
||||
- **C (Continue)**: Save the content to the document and proceed to final step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Platform requirements from step 3 inform responsive design
|
||||
- Design direction from step 9 influences responsive layout choices
|
||||
- Focus on cross-device adaptation and accessibility compliance
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define responsive design strategy and accessibility requirements for the product.
|
||||
|
||||
## RESPONSIVE & ACCESSIBILITY SEQUENCE:
|
||||
|
||||
### 1. Define Responsive Strategy
|
||||
|
||||
Establish how the design adapts across devices:
|
||||
"Let's define how {{project_name}} adapts across different screen sizes and devices.
|
||||
|
||||
**Responsive Design Questions:**
|
||||
|
||||
**Desktop Strategy:**
|
||||
|
||||
- How should we use extra screen real estate?
|
||||
- Multi-column layouts, side navigation, or content density?
|
||||
- What desktop-specific features can we include?
|
||||
|
||||
**Tablet Strategy:**
|
||||
|
||||
- Should we use simplified layouts or touch-optimized interfaces?
|
||||
- How do gestures and touch interactions work on tablets?
|
||||
- What's the optimal information density for tablet screens?
|
||||
|
||||
**Mobile Strategy:**
|
||||
|
||||
- Bottom navigation or hamburger menu?
|
||||
- How do layouts collapse on small screens?
|
||||
- What's the most critical information to show mobile-first?"
|
||||
|
||||
### 2. Establish Breakpoint Strategy
|
||||
|
||||
Define when and how layouts change:
|
||||
"**Breakpoint Strategy:**
|
||||
We need to define screen size breakpoints where layouts adapt.
|
||||
|
||||
**Common Breakpoints:**
|
||||
|
||||
- Mobile: 320px - 767px
|
||||
- Tablet: 768px - 1023px
|
||||
- Desktop: 1024px+
|
||||
|
||||
**For {{project_name}}, should we:**
|
||||
|
||||
- Use standard breakpoints or custom ones?
|
||||
- Focus on mobile-first or desktop-first design?
|
||||
- Have specific breakpoints for your key use cases?"
|
||||
|
||||
### 3. Design Accessibility Strategy
|
||||
|
||||
Define accessibility requirements and compliance level:
|
||||
"**Accessibility Strategy:**
|
||||
What level of WCAG compliance does {{project_name}} need?
|
||||
|
||||
**WCAG Levels:**
|
||||
|
||||
- **Level A (Basic)** - Essential accessibility for legal compliance
|
||||
- **Level AA (Recommended)** - Industry standard for good UX
|
||||
- **Level AAA (Highest)** - Exceptional accessibility (rarely needed)
|
||||
|
||||
**Based on your product:**
|
||||
|
||||
- [Recommendation based on user base, legal requirements, etc.]
|
||||
|
||||
**Key Accessibility Considerations:**
|
||||
|
||||
- Color contrast ratios (4.5:1 for normal text)
|
||||
- Keyboard navigation support
|
||||
- Screen reader compatibility
|
||||
- Touch target sizes (minimum 44x44px)
|
||||
- Focus indicators and skip links"
|
||||
|
||||
### 4. Define Testing Strategy
|
||||
|
||||
Plan how to ensure responsive design and accessibility:
|
||||
"**Testing Strategy:**
|
||||
|
||||
**Responsive Testing:**
|
||||
|
||||
- Device testing on actual phones/tablets
|
||||
- Browser testing across Chrome, Firefox, Safari, Edge
|
||||
- Real device network performance testing
|
||||
|
||||
**Accessibility Testing:**
|
||||
|
||||
- Automated accessibility testing tools
|
||||
- Screen reader testing (VoiceOver, NVDA, JAWS)
|
||||
- Keyboard-only navigation testing
|
||||
- Color blindness simulation testing
|
||||
|
||||
**User Testing:**
|
||||
|
||||
- Include users with disabilities in testing
|
||||
- Test with diverse assistive technologies
|
||||
- Validate with actual target devices"
|
||||
|
||||
### 5. Document Implementation Guidelines
|
||||
|
||||
Create specific guidelines for developers:
|
||||
"**Implementation Guidelines:**
|
||||
|
||||
**Responsive Development:**
|
||||
|
||||
- Use relative units (rem, %, vw, vh) over fixed pixels
|
||||
- Implement mobile-first media queries
|
||||
- Test touch targets and gesture areas
|
||||
- Optimize images and assets for different devices
|
||||
|
||||
**Accessibility Development:**
|
||||
|
||||
- Semantic HTML structure
|
||||
- ARIA labels and roles
|
||||
- Keyboard navigation implementation
|
||||
- Focus management and skip links
|
||||
- High contrast mode support"
|
||||
|
||||
### 6. Generate Responsive & Accessibility Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Responsive Design & Accessibility
|
||||
|
||||
### Responsive Strategy
|
||||
|
||||
[Responsive strategy based on conversation]
|
||||
|
||||
### Breakpoint Strategy
|
||||
|
||||
[Breakpoint strategy based on conversation]
|
||||
|
||||
### Accessibility Strategy
|
||||
|
||||
[Accessibility strategy based on conversation]
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
[Testing strategy based on conversation]
|
||||
|
||||
### Implementation Guidelines
|
||||
|
||||
[Implementation guidelines based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated responsive and accessibility content and present choices:
|
||||
"I've defined the responsive design and accessibility strategy for {{project_name}}. This ensures your product works beautifully across all devices and is accessible to all users.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's refine our responsive/accessibility strategy
|
||||
[P] Party Mode - Bring different perspectives on inclusive design
|
||||
[C] Continue - Save this to the document and complete the workflow
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current 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
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-14-complete.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Responsive strategy clearly defined for all device types
|
||||
✅ Appropriate breakpoint strategy established
|
||||
✅ Accessibility requirements determined and documented
|
||||
✅ Comprehensive testing strategy planned
|
||||
✅ Implementation guidelines provided for development team
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not considering all device types and screen sizes
|
||||
❌ Accessibility requirements not properly researched
|
||||
❌ Testing strategy not comprehensive enough
|
||||
❌ Implementation guidelines too generic or unclear
|
||||
❌ Not addressing specific accessibility challenges for your product
|
||||
❌ 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.
|
||||
|
||||
Remember: Do NOT proceed to step-14 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,228 @@
|
||||
# Step 14: Workflow Completion
|
||||
|
||||
## 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
|
||||
- 🎯 UPDATE workflow status files with completion information
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Update the main workflow status file with completion information
|
||||
- 📖 Suggest potential next workflow steps for the user
|
||||
- 🚫 DO NOT load additional steps after this one
|
||||
|
||||
## TERMINATION STEP PROTOCOLS:
|
||||
|
||||
- This is a FINAL step - workflow completion required
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted to indicate all is finished..
|
||||
- Output completion summary and next step guidance
|
||||
- Update the main workflow status file with finalized document
|
||||
- Suggest potential next workflow steps for the user
|
||||
- Mark workflow as complete in status tracking
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Complete UX design specification is available from all previous steps
|
||||
- Workflow frontmatter shows all completed steps
|
||||
- All collaborative content has been generated and saved
|
||||
- Focus on completion, validation, and next steps
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Complete the UX design workflow, update status files, and suggest next steps for the project.
|
||||
|
||||
## WORKFLOW COMPLETION SEQUENCE:
|
||||
|
||||
### 1. Announce Workflow Completion
|
||||
|
||||
Inform user that the UX design is complete:
|
||||
"🎉 **UX Design Complete, {{user_name}}!**
|
||||
|
||||
I've successfully collaborated with you to create a comprehensive UX design specification for {{project_name}}.
|
||||
|
||||
**What we've accomplished:**
|
||||
|
||||
- ✅ Project understanding and user insights
|
||||
- ✅ Core experience and emotional response definition
|
||||
- ✅ UX pattern analysis and inspiration
|
||||
- ✅ Design system choice and implementation strategy
|
||||
- ✅ Core interaction definition and experience mechanics
|
||||
- ✅ Visual design foundation (colors, typography, spacing)
|
||||
- ✅ Design direction mockups and visual explorations
|
||||
- ✅ User journey flows and interaction design
|
||||
- ✅ Component strategy and custom component specifications
|
||||
- ✅ UX consistency patterns for common interactions
|
||||
- ✅ Responsive design and accessibility strategy
|
||||
|
||||
**The complete UX design specification is now available at:** `{planning_artifacts}/ux-design-specification.md`
|
||||
|
||||
**Supporting Visual Assets:**
|
||||
|
||||
- Color themes visualizer: `{planning_artifacts}/ux-color-themes.html`
|
||||
- Design directions mockups: `{planning_artifacts}/ux-design-directions.html`
|
||||
|
||||
This specification is now ready to guide visual design, implementation, and development."
|
||||
|
||||
### 2. Workflow Status Update
|
||||
|
||||
Update the main workflow status file:
|
||||
|
||||
- Load `{status_file}` from workflow configuration (if exists)
|
||||
- Update workflow_status["create-ux-design"] = "{default_output_file}"
|
||||
- Save file, preserving all comments and structure
|
||||
- Mark current timestamp as completion time
|
||||
|
||||
### 3. Suggest Next Steps
|
||||
|
||||
Provide guidance on logical next workflows:
|
||||
|
||||
**Typical Next Workflows:**
|
||||
|
||||
**Immediate Next Steps:**
|
||||
|
||||
1. **Wireframe Generation** - Create detailed wireframes based on UX specification
|
||||
2. **Interactive Prototype** - Build clickable prototypes for user testing
|
||||
3. **Solution Architecture** - Technical architecture design with UX context
|
||||
4. **Figma Design** - High-fidelity visual design implementation
|
||||
|
||||
**Visual Design Workflows:**
|
||||
|
||||
- Wireframe Generation → Interactive Prototype → Figma Design
|
||||
- Component Showcase → AI Frontend Prompt → Design System Implementation
|
||||
|
||||
**Development Workflows:**
|
||||
|
||||
- Solution Architecture → Epic Creation → Development Sprints
|
||||
|
||||
**What would be most valuable to tackle next?**
|
||||
|
||||
### 4. Document Quality Check
|
||||
|
||||
Perform final validation of the UX design:
|
||||
|
||||
**Completeness Check:**
|
||||
|
||||
- Does the specification clearly communicate the design vision?
|
||||
- Are user journeys thoroughly documented?
|
||||
- Are all critical components specified?
|
||||
- Are responsive and accessibility requirements comprehensive?
|
||||
- Is there clear guidance for implementation?
|
||||
|
||||
**Consistency Check:**
|
||||
|
||||
- Do all sections align with the emotional goals?
|
||||
- Is design system integration clearly defined?
|
||||
- Are patterns consistent across all user flows?
|
||||
- Does visual direction match established foundation?
|
||||
|
||||
### 5. Final Completion Confirmation
|
||||
|
||||
Confirm completion with user:
|
||||
"**Your UX Design Specification for {{project_name}} is now complete and ready for implementation!**
|
||||
|
||||
**The specification contains everything needed to:**
|
||||
|
||||
- Guide visual designers in creating the final interfaces
|
||||
- Inform developers of all UX requirements and patterns
|
||||
- Ensure consistency across all user interactions
|
||||
- Maintain accessibility and responsive design standards
|
||||
- Provide a foundation for user testing and iteration
|
||||
|
||||
**Ready to continue with:**
|
||||
|
||||
- Wireframe generation for detailed layouts?
|
||||
- Interactive prototype for user testing?
|
||||
- Solution architecture for technical planning?
|
||||
- Visual design implementation?
|
||||
|
||||
**Or would you like to review the complete specification first?**
|
||||
|
||||
[UX Design Workflow Complete]"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ UX design specification contains all required sections
|
||||
✅ All collaborative content properly saved to document
|
||||
✅ Workflow status file updated with completion information
|
||||
✅ Clear next step guidance provided to user
|
||||
✅ Document quality validation completed
|
||||
✅ User acknowledges completion and understands next options
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not updating workflow status file with completion information
|
||||
❌ Missing clear next step guidance for user
|
||||
❌ Not confirming document completeness with user
|
||||
❌ Workflow not properly marked as complete in status tracking
|
||||
❌ User unclear about what happens next
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## WORKFLOW COMPLETION CHECKLIST:
|
||||
|
||||
### Design Specification Complete:
|
||||
|
||||
- [ ] Executive summary and project understanding
|
||||
- [ ] Core experience and emotional response definition
|
||||
- [ ] UX pattern analysis and inspiration
|
||||
- [ ] Design system choice and strategy
|
||||
- [ ] Core interaction mechanics definition
|
||||
- [ ] Visual design foundation (colors, typography, spacing)
|
||||
- [ ] Design direction decisions and mockups
|
||||
- [ ] User journey flows and interaction design
|
||||
- [ ] Component strategy and specifications
|
||||
- [ ] UX consistency patterns documentation
|
||||
- [ ] Responsive design and accessibility strategy
|
||||
|
||||
### Process Complete:
|
||||
|
||||
- [ ] All steps completed with user confirmation
|
||||
- [ ] All content saved to specification document
|
||||
- [ ] Frontmatter properly updated with all steps
|
||||
- [ ] Workflow status file updated with completion
|
||||
- [ ] Next steps clearly communicated
|
||||
|
||||
## NEXT STEPS GUIDANCE:
|
||||
|
||||
**Immediate Options:**
|
||||
|
||||
1. **Wireframe Generation** - Create low-fidelity layouts based on UX spec
|
||||
2. **Interactive Prototype** - Build clickable prototypes for testing
|
||||
3. **Solution Architecture** - Technical design with UX context
|
||||
4. **Figma Visual Design** - High-fidelity UI implementation
|
||||
5. **Epic Creation** - Break down UX requirements for development
|
||||
|
||||
**Recommended Sequence:**
|
||||
For design-focused teams: Wireframes → Prototypes → Figma Design → Development
|
||||
For technical teams: Architecture → Epic Creation → Development
|
||||
|
||||
Consider team capacity, timeline, and whether user validation is needed before implementation.
|
||||
|
||||
## WORKFLOW FINALIZATION:
|
||||
|
||||
- Set `lastStep = 14` in document frontmatter
|
||||
- Update workflow status file with completion timestamp
|
||||
- Provide completion summary to user
|
||||
- Do NOT load any additional steps
|
||||
|
||||
## FINAL REMINDER:
|
||||
|
||||
This UX design workflow is now complete. The specification serves as the foundation for all visual and development work. All design decisions, patterns, and requirements are documented to ensure consistent, accessible, and user-centered implementation.
|
||||
|
||||
**Congratulations on completing the UX Design Specification for {{project_name}}!** 🎉
|
||||
|
||||
**Core Deliverables:**
|
||||
|
||||
- ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md`
|
||||
- ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html`
|
||||
- ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html`
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
---
|
||||
|
||||
# UX Design Specification {{project_name}}
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
|
||||
---
|
||||
|
||||
<!-- UX design content will be appended sequentially through collaborative workflow steps -->
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: create-ux-design
|
||||
description: Work with a peer UX Design expert to plan your applications UX patterns, look and feel.
|
||||
web_bundle: true
|
||||
---
|
||||
|
||||
# Create UX Design Workflow
|
||||
|
||||
**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION
|
||||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as system-generated current datetime
|
||||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design`
|
||||
- `template_path` = `{installed_path}/ux-design-template.md`
|
||||
- `default_output_file` = `{planning_artifacts}/ux-design-specification.md`
|
||||
|
||||
## EXECUTION
|
||||
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
- Load and execute `steps/step-01-init.md` to begin the UX design workflow.
|
||||
@@ -0,0 +1,13 @@
|
||||
domain,signals,complexity,key_concerns,required_knowledge,suggested_workflow,web_searches,special_sections
|
||||
healthcare,"medical,diagnostic,clinical,FDA,patient,treatment,HIPAA,therapy,pharma,drug",high,"FDA approval;Clinical validation;HIPAA compliance;Patient safety;Medical device classification;Liability","Regulatory pathways;Clinical trial design;Medical standards;Data privacy;Integration requirements","domain-research","FDA software medical device guidance {date};HIPAA compliance software requirements;Medical software standards {date};Clinical validation software","clinical_requirements;regulatory_pathway;validation_methodology;safety_measures"
|
||||
fintech,"payment,banking,trading,investment,crypto,wallet,transaction,KYC,AML,funds,fintech",high,"Regional compliance;Security standards;Audit requirements;Fraud prevention;Data protection","KYC/AML requirements;PCI DSS;Open banking;Regional laws (US/EU/APAC);Crypto regulations","domain-research","fintech regulations {date};payment processing compliance {date};open banking API standards;cryptocurrency regulations {date}","compliance_matrix;security_architecture;audit_requirements;fraud_prevention"
|
||||
govtech,"government,federal,civic,public sector,citizen,municipal,voting",high,"Procurement rules;Security clearance;Accessibility (508);FedRAMP;Privacy;Transparency","Government procurement;Security frameworks;Accessibility standards;Privacy laws;Open data requirements","domain-research","government software procurement {date};FedRAMP compliance requirements;section 508 accessibility;government security standards","procurement_compliance;security_clearance;accessibility_standards;transparency_requirements"
|
||||
edtech,"education,learning,student,teacher,curriculum,assessment,K-12,university,LMS",medium,"Student privacy (COPPA/FERPA);Accessibility;Content moderation;Age verification;Curriculum standards","Educational privacy laws;Learning standards;Accessibility requirements;Content guidelines;Assessment validity","domain-research","educational software privacy {date};COPPA FERPA compliance;WCAG education requirements;learning management standards","privacy_compliance;content_guidelines;accessibility_features;curriculum_alignment"
|
||||
aerospace,"aircraft,spacecraft,aviation,drone,satellite,propulsion,flight,radar,navigation",high,"Safety certification;DO-178C compliance;Performance validation;Simulation accuracy;Export controls","Aviation standards;Safety analysis;Simulation validation;ITAR/export controls;Performance requirements","domain-research + technical-model","DO-178C software certification;aerospace simulation standards {date};ITAR export controls software;aviation safety requirements","safety_certification;simulation_validation;performance_requirements;export_compliance"
|
||||
automotive,"vehicle,car,autonomous,ADAS,automotive,driving,EV,charging",high,"Safety standards;ISO 26262;V2X communication;Real-time requirements;Certification","Automotive standards;Functional safety;V2X protocols;Real-time systems;Testing requirements","domain-research","ISO 26262 automotive software;automotive safety standards {date};V2X communication protocols;EV charging standards","safety_standards;functional_safety;communication_protocols;certification_requirements"
|
||||
scientific,"research,algorithm,simulation,modeling,computational,analysis,data science,ML,AI",medium,"Reproducibility;Validation methodology;Peer review;Performance;Accuracy;Computational resources","Scientific method;Statistical validity;Computational requirements;Domain expertise;Publication standards","technical-model","scientific computing best practices {date};research reproducibility standards;computational modeling validation;peer review software","validation_methodology;accuracy_metrics;reproducibility_plan;computational_requirements"
|
||||
legaltech,"legal,law,contract,compliance,litigation,patent,attorney,court",high,"Legal ethics;Bar regulations;Data retention;Attorney-client privilege;Court system integration","Legal practice rules;Ethics requirements;Court filing systems;Document standards;Confidentiality","domain-research","legal technology ethics {date};law practice management software requirements;court filing system standards;attorney client privilege technology","ethics_compliance;data_retention;confidentiality_measures;court_integration"
|
||||
insuretech,"insurance,claims,underwriting,actuarial,policy,risk,premium",high,"Insurance regulations;Actuarial standards;Data privacy;Fraud detection;State compliance","Insurance regulations by state;Actuarial methods;Risk modeling;Claims processing;Regulatory reporting","domain-research","insurance software regulations {date};actuarial standards software;insurance fraud detection;state insurance compliance","regulatory_requirements;risk_modeling;fraud_detection;reporting_compliance"
|
||||
energy,"energy,utility,grid,solar,wind,power,electricity,oil,gas",high,"Grid compliance;NERC standards;Environmental regulations;Safety requirements;Real-time operations","Energy regulations;Grid standards;Environmental compliance;Safety protocols;SCADA systems","domain-research","energy sector software compliance {date};NERC CIP standards;smart grid requirements;renewable energy software standards","grid_compliance;safety_protocols;environmental_compliance;operational_requirements"
|
||||
gaming,"game,player,gameplay,level,character,multiplayer,quest",redirect,"REDIRECT TO GAME WORKFLOWS","Game design","game-brief","NA","NA"
|
||||
general,"",low,"Standard requirements;Basic security;User experience;Performance","General software practices","continue","software development best practices {date}","standard_requirements"
|
||||
|
11
_bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md
Normal file
11
_bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
workflowType: 'prd'
|
||||
lastStep: 0
|
||||
---
|
||||
|
||||
# Product Requirements Document - {{project_name}}
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
11
_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv
Normal file
11
_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv
Normal file
@@ -0,0 +1,11 @@
|
||||
project_type,detection_signals,key_questions,required_sections,skip_sections,web_search_triggers,innovation_signals
|
||||
api_backend,"API,REST,GraphQL,backend,service,endpoints","Endpoints needed?;Authentication method?;Data formats?;Rate limits?;Versioning?;SDK needed?","endpoint_specs;auth_model;data_schemas;error_codes;rate_limits;api_docs","ux_ui;visual_design;user_journeys","framework best practices;OpenAPI standards","API composition;New protocol"
|
||||
mobile_app,"iOS,Android,app,mobile,iPhone,iPad","Native or cross-platform?;Offline needed?;Push notifications?;Device features?;Store compliance?","platform_reqs;device_permissions;offline_mode;push_strategy;store_compliance","desktop_features;cli_commands","app store guidelines;platform requirements","Gesture innovation;AR/VR features"
|
||||
saas_b2b,"SaaS,B2B,platform,dashboard,teams,enterprise","Multi-tenant?;Permission model?;Subscription tiers?;Integrations?;Compliance?","tenant_model;rbac_matrix;subscription_tiers;integration_list;compliance_reqs","cli_interface;mobile_first","compliance requirements;integration guides","Workflow automation;AI agents"
|
||||
developer_tool,"SDK,library,package,npm,pip,framework","Language support?;Package managers?;IDE integration?;Documentation?;Examples?","language_matrix;installation_methods;api_surface;code_examples;migration_guide","visual_design;store_compliance","package manager best practices;API design patterns","New paradigm;DSL creation"
|
||||
cli_tool,"CLI,command,terminal,bash,script","Interactive or scriptable?;Output formats?;Config method?;Shell completion?","command_structure;output_formats;config_schema;scripting_support","visual_design;ux_principles;touch_interactions","CLI design patterns;shell integration","Natural language CLI;AI commands"
|
||||
web_app,"website,webapp,browser,SPA,PWA","SPA or MPA?;Browser support?;SEO needed?;Real-time?;Accessibility?","browser_matrix;responsive_design;performance_targets;seo_strategy;accessibility_level","native_features;cli_commands","web standards;WCAG guidelines","New interaction;WebAssembly use"
|
||||
game,"game,player,gameplay,level,character","REDIRECT TO USE THE BMad Method Game Module Agent and Workflows - HALT","game-brief;GDD","most_sections","game design patterns","Novel mechanics;Genre mixing"
|
||||
desktop_app,"desktop,Windows,Mac,Linux,native","Cross-platform?;Auto-update?;System integration?;Offline?","platform_support;system_integration;update_strategy;offline_capabilities","web_seo;mobile_features","desktop guidelines;platform requirements","Desktop AI;System automation"
|
||||
iot_embedded,"IoT,embedded,device,sensor,hardware","Hardware specs?;Connectivity?;Power constraints?;Security?;OTA updates?","hardware_reqs;connectivity_protocol;power_profile;security_model;update_mechanism","visual_ui;browser_support","IoT standards;protocol specs","Edge AI;New sensors"
|
||||
blockchain_web3,"blockchain,crypto,DeFi,NFT,smart contract","Chain selection?;Wallet integration?;Gas optimization?;Security audit?","chain_specs;wallet_support;smart_contracts;security_audit;gas_optimization","traditional_auth;centralized_db","blockchain standards;security patterns","Novel tokenomics;DAO structure"
|
||||
|
197
_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md
Normal file
197
_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md
Normal file
@@ -0,0 +1,197 @@
|
||||
---
|
||||
name: 'step-01-init'
|
||||
description: 'Initialize the PRD workflow by detecting continuation state and setting up the document'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01-init.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-02-discovery.md'
|
||||
continueStepFile: '{workflow_path}/steps/step-01b-continue.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
|
||||
# Template References
|
||||
prdTemplate: '{workflow_path}/prd-template.md'
|
||||
---
|
||||
|
||||
# Step 1: Workflow Initialization
|
||||
|
||||
**Progress: Step 1 of 11** - Next: Project Discovery
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Initialize the PRD workflow by detecting continuation state, discovering input documents, and setting up the document structure for collaborative product requirement discovery.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused PM facilitator collaborating with an expert peer
|
||||
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on initialization and setup - no content generation yet
|
||||
- 🚫 FORBIDDEN to look ahead to future steps or assume knowledge from them
|
||||
- 💬 Approach: Systematic setup with clear reporting to user
|
||||
- 🚪 Detect existing workflow state and handle continuation properly
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis of current state before taking any action
|
||||
- 💾 Initialize document structure and update frontmatter appropriately
|
||||
- Update frontmatter: add this step name to the end of the steps completed array (it should be the first entry in the steps array since this is step 1)
|
||||
- 🚫 FORBIDDEN to load next step until user selects 'C' (Continue)
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Variables from workflow.md are available in memory
|
||||
- Focus: Workflow initialization and document setup only
|
||||
- Limits: Don't assume knowledge from other steps or create content yet
|
||||
- Dependencies: Configuration loaded from workflow.md initialization
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Check for Existing Workflow State
|
||||
|
||||
First, check if the output document already exists:
|
||||
|
||||
**Workflow State Detection:**
|
||||
|
||||
- Look for file at `{outputFile}`
|
||||
- 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` BUT `step-11-complete` is NOT in the list, follow the Continuation Protocol since the document is incomplete:
|
||||
|
||||
**Continuation Protocol:**
|
||||
|
||||
- **STOP immediately** and load `{continueStepFile}`
|
||||
- Do not proceed with any initialization tasks
|
||||
- Let step-01b handle all continuation logic
|
||||
- This is an auto-proceed situation - no user choice needed
|
||||
|
||||
### 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. Documents can be in the following locations:
|
||||
- {planning_artifacts}/**
|
||||
- {output_folder}/**
|
||||
- {product_knowledge}/**
|
||||
- docs/**
|
||||
|
||||
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
||||
|
||||
Try to discover the following:
|
||||
- Product Brief (`*brief*.md`)
|
||||
- Research Documents (`/*research*.md`)
|
||||
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
||||
- Project Context (`**/project-context.md`)
|
||||
|
||||
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
||||
|
||||
**Loading Rules:**
|
||||
|
||||
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
||||
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
||||
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
||||
- index.md is a guide to what's relevant whenever available
|
||||
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
||||
|
||||
#### B. Create Initial Document
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Copy the template from `{prdTemplate}` to `{outputFile}`
|
||||
- Initialize frontmatter with proper structure including inputDocuments array.
|
||||
|
||||
#### C. Present Initialization Results
|
||||
|
||||
**Setup Report to User:**
|
||||
|
||||
"Welcome {{user_name}}! I've set up your PRD workspace for {{project_name}}.
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Created: `{outputFile}` from template
|
||||
- Initialized frontmatter with workflow state
|
||||
|
||||
**Input Documents Discovered:**
|
||||
|
||||
- Product briefs: {{briefCount}} files {if briefCount > 0}✓ loaded{else}(none found){/if}
|
||||
- Research: {{researchCount}} files {if researchCount > 0}✓ loaded{else}(none found){/if}
|
||||
- Brainstorming: {{brainstormingCount}} files {if brainstormingCount > 0}✓ loaded{else}(none found){/if}
|
||||
- Project docs: {{projectDocsCount}} files {if projectDocsCount > 0}✓ loaded (brownfield project){else}(none found - greenfield project){/if}
|
||||
|
||||
**Files loaded:** {list of specific file names or "No additional documents found"}
|
||||
|
||||
{if projectDocsCount > 0}
|
||||
📋 **Note:** This is a **brownfield project**. Your existing project documentation has been loaded. In the next step, I'll ask specifically about what new features or changes you want to add to your existing system.
|
||||
{/if}
|
||||
|
||||
Do you have any other documents you'd like me to include, or shall we continue to the next step?"
|
||||
|
||||
### 4. Present MENU OPTIONS
|
||||
|
||||
Display menu after setup report:
|
||||
|
||||
"[C] Continue - Save this and move to Project Discovery (Step 2 of 11)"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Update frontmatter with `stepsCompleted: [1]`, then load, read entire {nextStepFile}, then execute {nextStepFile}
|
||||
- IF user provides additional files: Load them, update inputDocuments and documentCounts, redisplay report
|
||||
- IF user asks questions: Answer and redisplay menu
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [frontmatter properly updated with stepsCompleted: [1] and documentCounts], will you then load and read fully `{nextStepFile}` to execute and begin project discovery.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Existing workflow detected and properly handed off to step-01b
|
||||
- Fresh workflow initialized with template and proper frontmatter
|
||||
- Input documents discovered and loaded using sharded-first logic
|
||||
- All discovered files tracked in frontmatter `inputDocuments`
|
||||
- User clearly informed of brownfield vs greenfield status
|
||||
- Menu presented and user input handled correctly
|
||||
- Frontmatter updated with `stepsCompleted: [1]` before proceeding
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Proceeding with fresh initialization when existing workflow exists
|
||||
- Not updating frontmatter with discovered input documents
|
||||
- **Not storing document counts in frontmatter**
|
||||
- Creating document without proper template structure
|
||||
- Not checking sharded folders first before whole files
|
||||
- Not reporting discovered documents to user clearly
|
||||
- Proceeding without user selecting 'C' (Continue)
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,166 @@
|
||||
---
|
||||
name: 'step-01b-continue'
|
||||
description: 'Resume an interrupted PRD workflow from the last completed step'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
---
|
||||
|
||||
# Step 1B: Workflow Continuation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Resume the PRD workflow from where it was left off, ensuring smooth continuation with full context restoration.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused PM facilitator collaborating with an expert peer
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ Resume workflow from exact point where it was interrupted
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 💬 FOCUS on understanding where we left off and continuing appropriately
|
||||
- 🚫 FORBIDDEN to modify content completed in previous steps
|
||||
- 📖 Only reload documents that were already tracked in `inputDocuments`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis of current state before taking action
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- 📖 Only load documents that were already tracked in `inputDocuments`
|
||||
- 🚫 FORBIDDEN to discover new input documents during continuation
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Current document and frontmatter are already loaded
|
||||
- Focus: Workflow state analysis and continuation logic only
|
||||
- Limits: Don't assume knowledge beyond what's in the document
|
||||
- Dependencies: Existing workflow state from previous session
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Analyze Current State
|
||||
|
||||
**State Assessment:**
|
||||
Review the frontmatter to understand:
|
||||
|
||||
- `stepsCompleted`: Which steps are already done
|
||||
- `lastStep`: The most recently completed step number
|
||||
- `inputDocuments`: What context was already loaded
|
||||
- `documentCounts`: briefs, research, brainstorming, projectDocs counts
|
||||
- All other frontmatter variables
|
||||
|
||||
### 2. Restore Context Documents
|
||||
|
||||
**Context Reloading:**
|
||||
|
||||
- For each document in `inputDocuments`, load the complete file
|
||||
- This ensures you have full context for continuation
|
||||
- Don't discover new documents - only reload what was previously processed
|
||||
|
||||
### 3. Present Current Progress
|
||||
|
||||
**Progress Report to User:**
|
||||
"Welcome back {{user_name}}! I'm resuming our PRD collaboration for {{project_name}}.
|
||||
|
||||
**Current Progress:**
|
||||
|
||||
- Steps completed: {stepsCompleted}
|
||||
- Last worked on: Step {lastStep}
|
||||
- Context documents available: {len(inputDocuments)} files
|
||||
|
||||
**Document Status:**
|
||||
|
||||
- Current PRD document is ready with all completed sections
|
||||
- Ready to continue from where we left off
|
||||
|
||||
Does this look right, or do you want to make any adjustments before we proceed?"
|
||||
|
||||
### 4. Determine Continuation Path
|
||||
|
||||
**Next Step Logic:**
|
||||
Based on `lastStep` value, determine which step to load next:
|
||||
|
||||
- If `lastStep = 1` → Load `./step-02-discovery.md`
|
||||
- If `lastStep = 2` → Load `./step-03-success.md`
|
||||
- If `lastStep = 3` → Load `./step-04-journeys.md`
|
||||
- If `lastStep = 4` → Load `./step-05-domain.md`
|
||||
- If `lastStep = 5` → Load `./step-06-innovation.md`
|
||||
- If `lastStep = 6` → Load `./step-07-project-type.md`
|
||||
- If `lastStep = 7` → Load `./step-08-scoping.md`
|
||||
- If `lastStep = 8` → Load `./step-09-functional.md`
|
||||
- If `lastStep = 9` → Load `./step-10-nonfunctional.md`
|
||||
- If `lastStep = 10` → Load `./step-11-complete.md`
|
||||
- If `lastStep = 11` → Workflow already complete
|
||||
|
||||
### 5. Handle Workflow Completion
|
||||
|
||||
**If workflow already complete (`lastStep = 11`):**
|
||||
"Great news! It looks like we've already completed the PRD workflow for {{project_name}}.
|
||||
|
||||
The final document is ready at `{outputFile}` with all sections completed through step 11.
|
||||
|
||||
Would you like me to:
|
||||
|
||||
- Review the completed PRD with you
|
||||
- Suggest next workflow steps (like architecture or epic creation)
|
||||
- Start a new PRD revision
|
||||
|
||||
What would be most helpful?"
|
||||
|
||||
### 6. Present MENU OPTIONS
|
||||
|
||||
**If workflow not complete:**
|
||||
Display: "Ready to continue with Step {nextStepNumber}?
|
||||
|
||||
**Select an Option:** [C] Continue to next step"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Load, read entire file, then execute the appropriate next step file based on `lastStep`
|
||||
- IF Any other comments or queries: respond and redisplay menu
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the appropriate next step file to resume the workflow.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All previous input documents successfully reloaded
|
||||
- Current workflow state accurately analyzed and presented
|
||||
- User confirms understanding of progress before continuation
|
||||
- Correct next step identified and prepared for loading
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Discovering new input documents instead of reloading existing ones
|
||||
- Modifying content from already completed steps
|
||||
- Loading wrong next step based on `lastStep` value
|
||||
- Proceeding without user confirmation of current state
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,421 @@
|
||||
---
|
||||
name: 'step-02-discovery'
|
||||
description: 'Conduct project and domain discovery with data-driven classification'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-02-discovery.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-03-success.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
projectTypesCSV: '{workflow_path}/project-types.csv'
|
||||
domainComplexityCSV: '{workflow_path}/domain-complexity.csv'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 2: Project & Domain Discovery
|
||||
|
||||
**Progress: Step 2 of 11** - Next: Success Criteria Definition
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Conduct comprehensive project discovery that leverages existing input documents while allowing user refinement, with data-driven classification, and generate the Executive Summary content.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product-focused PM facilitator collaborating with an expert peer
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus on project classification and vision alignment only
|
||||
- 🚫 FORBIDDEN to generate content without real user input
|
||||
- 💬 APPROACH: Adapt questions based on document context (brownfield vs greenfield)
|
||||
- 🎯 LOAD classification data BEFORE starting discovery conversation
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating executive summary content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper insights about the generated content
|
||||
- **P (Party Mode)**: Bring multiple perspectives to discuss and improve the generated content
|
||||
- **C (Continue)**: Append and save the content to the `{outputFile}` and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {advancedElicitationTask}
|
||||
- When 'P' selected: Execute {partyModeWorkflow}
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from step 1 are available
|
||||
- Input documents already loaded are in memory (product briefs, research, brainstorming, project docs)
|
||||
- **Document counts available in frontmatter `documentCounts`**
|
||||
- Classification CSV data will be loaded in this step only
|
||||
- This will be the first content section appended to the document
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Read Document State from Frontmatter
|
||||
|
||||
**CRITICAL FIRST ACTION:** Read the frontmatter from `{outputFile}` to get document counts.
|
||||
|
||||
```
|
||||
Read documentCounts from prd.md frontmatter:
|
||||
- briefCount = documentCounts.briefs
|
||||
- researchCount = documentCounts.research
|
||||
- brainstormingCount = documentCounts.brainstorming
|
||||
- projectDocsCount = documentCounts.projectDocs
|
||||
```
|
||||
|
||||
**ANNOUNCE your understanding:**
|
||||
|
||||
"From step 1, I have loaded:
|
||||
|
||||
- Product briefs: {{briefCount}} files
|
||||
- Research: {{researchCount}} files
|
||||
- Brainstorming: {{brainstormingCount}} files
|
||||
- Project docs: {{projectDocsCount}} files
|
||||
|
||||
{if projectDocsCount > 0}This is a **brownfield project** - I'll focus on understanding what you want to add or change.{else}This is a **greenfield project** - I'll help you define the full product vision.{/if}"
|
||||
|
||||
### 2. Load Classification Data
|
||||
|
||||
Load and prepare CSV data for intelligent classification:
|
||||
|
||||
- Load `{projectTypesCSV}` completely
|
||||
- Load `{domainComplexityCSV}` completely
|
||||
- Parse column structures and store in memory for this step only
|
||||
|
||||
### 3. Begin Discovery Conversation
|
||||
|
||||
**SELECT EXACTLY ONE DISCOVERY PATH based on document state:**
|
||||
|
||||
---
|
||||
|
||||
#### PATH A: Has Product Brief (briefCount > 0)
|
||||
|
||||
**Use this path when:** `briefCount > 0`
|
||||
|
||||
"As your PM peer, I've reviewed your product brief and have a great starting point for our discovery. Let me share what I understand and you can refine or correct as needed.
|
||||
|
||||
**Based on your product brief:**
|
||||
|
||||
**What you're building:**
|
||||
{{extracted_vision_from_brief}}
|
||||
|
||||
**Problem it solves:**
|
||||
{{extracted_problem_from_brief}}
|
||||
|
||||
**Target users:**
|
||||
{{extracted_users_from_brief}}
|
||||
|
||||
**What makes it special:**
|
||||
{{extracted_differentiator_from_brief}}
|
||||
|
||||
{if projectDocsCount > 0}I also see you have existing project documentation. This PRD will define how new features integrate with your existing system architecture.{/if}
|
||||
|
||||
**How does this align with your vision?** Should we refine any of these points or are there important aspects I'm missing?"
|
||||
|
||||
**AFTER this message, SKIP to Section 4.**
|
||||
|
||||
---
|
||||
|
||||
#### PATH B: No Brief but Has Project Docs - Brownfield (briefCount == 0 AND projectDocsCount > 0)
|
||||
|
||||
**Use this path when:** `briefCount == 0 AND projectDocsCount > 0`
|
||||
|
||||
**NOTE:** Extract the following from loaded project documentation (index.md, architecture.md, project-overview.md, etc.):
|
||||
|
||||
"As your PM peer, I've reviewed your existing project documentation from document-project.
|
||||
|
||||
**Your existing system includes:**
|
||||
|
||||
- **Tech Stack:** {analyze index.md and architecture.md for technologies used}
|
||||
- **Architecture:** {summarize architecture patterns from architecture.md}
|
||||
- **Key Components:** {list main components from source-tree-analysis.md or project-overview.md}
|
||||
|
||||
This PRD will define **new features or changes** to add to this existing codebase.
|
||||
|
||||
**Tell me about what you want to add or change:**
|
||||
|
||||
- What new capability or feature do you want to build?
|
||||
- What problem will this solve for your users?
|
||||
- How should it integrate with the existing system?
|
||||
- Is this adding new functionality, improving existing features, or fixing issues?
|
||||
|
||||
I'll help you create a PRD focused on these additions while respecting your existing patterns and architecture."
|
||||
|
||||
**AFTER this message, SKIP to Section 4.**
|
||||
|
||||
---
|
||||
|
||||
#### PATH C: No Documents - Greenfield (briefCount == 0 AND projectDocsCount == 0)
|
||||
|
||||
**Use this path when:** `briefCount == 0 AND projectDocsCount == 0`
|
||||
|
||||
"As your PM peer, I'm excited to help you shape {{project_name}}. Let me start by understanding what you want to build.
|
||||
|
||||
**Tell me about what you want to create:**
|
||||
|
||||
- What problem does it solve?
|
||||
- Who are you building this for?
|
||||
- What excites you most about this product?
|
||||
|
||||
I'll be listening for signals to help us classify the project and domain so we can ask the right questions throughout our process."
|
||||
|
||||
**AFTER this message, continue to Section 4.**
|
||||
|
||||
---
|
||||
|
||||
### 4. Listen for Classification Signals
|
||||
|
||||
As the user describes their product/feature, listen for and match against:
|
||||
|
||||
#### Project Type Signals
|
||||
|
||||
Compare user description against `detection_signals` from `project-types.csv`:
|
||||
|
||||
- Look for keyword matches from semicolon-separated signals
|
||||
- Examples: "API,REST,GraphQL" → api_backend
|
||||
- Examples: "iOS,Android,app,mobile" → mobile_app
|
||||
- Store the best matching `project_type`
|
||||
|
||||
#### Domain Signals
|
||||
|
||||
Compare user description against `signals` from `domain-complexity.csv`:
|
||||
|
||||
- Look for domain keyword matches
|
||||
- Examples: "medical,diagnostic,clinical" → healthcare
|
||||
- Examples: "payment,banking,trading" → fintech
|
||||
- Store the matched `domain` and `complexity_level`
|
||||
|
||||
### 5. Present Classification for Validation
|
||||
|
||||
**SELECT EXACTLY ONE CLASSIFICATION PRESENTATION based on document state:**
|
||||
|
||||
---
|
||||
|
||||
#### IF PATH A was used (briefCount > 0):
|
||||
|
||||
"Based on your product brief and our discussion, I'm classifying this as:
|
||||
|
||||
- **Project Type:** {project_type_from_brief_or_conversation}
|
||||
- **Domain:** {domain_from_brief_or_conversation}
|
||||
- **Complexity:** {complexity_from_brief_or_conversation}
|
||||
|
||||
From your brief, I detected these classification signals:
|
||||
{{classification_signals_from_brief}}
|
||||
|
||||
{if projectDocsCount > 0}Your existing project documentation also indicates:
|
||||
|
||||
- **Existing Tech Stack:** {from architecture.md or index.md}
|
||||
- **Architecture Pattern:** {from architecture.md}
|
||||
|
||||
I'll ensure the new features align with your existing system.{/if}
|
||||
|
||||
Combined with our conversation, this suggests the above classification. Does this sound right?"
|
||||
|
||||
---
|
||||
|
||||
#### IF PATH B was used (briefCount == 0 AND projectDocsCount > 0):
|
||||
|
||||
"Based on your existing project documentation and our discussion about new features:
|
||||
|
||||
- **Existing Project Type:** {detected from project docs - e.g., web_app, api_backend}
|
||||
- **Tech Stack:** {from architecture.md or index.md}
|
||||
- **New Feature Type:** {from user's description of what they want to add}
|
||||
- **Domain:** {detected_domain}
|
||||
- **Complexity:** {complexity_level}
|
||||
|
||||
I'll ensure the PRD aligns with your existing architecture patterns. Does this classification sound right?"
|
||||
|
||||
---
|
||||
|
||||
#### IF PATH C was used (briefCount == 0 AND projectDocsCount == 0):
|
||||
|
||||
"Based on our conversation, I'm hearing this as:
|
||||
|
||||
- **Project Type:** {detected_project_type}
|
||||
- **Domain:** {detected_domain}
|
||||
- **Complexity:** {complexity_level}
|
||||
|
||||
Does this sound right to you? I want to make sure we're on the same page before diving deeper."
|
||||
|
||||
---
|
||||
|
||||
### 6. Identify What Makes It Special
|
||||
|
||||
**SELECT EXACTLY ONE DIFFERENTIATOR DISCOVERY based on document state:**
|
||||
|
||||
---
|
||||
|
||||
#### IF PATH A was used (briefCount > 0):
|
||||
|
||||
"From your product brief, I understand that what makes this special is:
|
||||
{{extracted_differentiator_from_brief}}
|
||||
|
||||
Let's explore this deeper:
|
||||
|
||||
- **Refinement needed:** Does this capture the essence correctly, or should we adjust it?
|
||||
- **Missing aspects:** Are there other differentiators that aren't captured in your brief?
|
||||
- **Evolution:** How has your thinking on this evolved since you wrote the brief?"
|
||||
|
||||
---
|
||||
|
||||
#### IF PATH B was used (briefCount == 0 AND projectDocsCount > 0):
|
||||
|
||||
"Your existing system already provides certain capabilities. Now let's define what makes these **new additions** special:
|
||||
|
||||
- What gap in your current system will this fill?
|
||||
- How will this improve the experience for your existing users?
|
||||
- What's the key insight that led you to prioritize this addition?
|
||||
- What would make users say 'finally, this is what we needed'?"
|
||||
|
||||
---
|
||||
|
||||
#### IF PATH C was used (briefCount == 0 AND projectDocsCount == 0):
|
||||
|
||||
Ask focused questions to capture the product's unique value:
|
||||
|
||||
- "What would make users say 'this is exactly what I needed'?"
|
||||
- "What's the moment where users realize this is different/better?"
|
||||
- "What assumption about [problem space] are you challenging?"
|
||||
- "If this succeeds wildly, what changed for your users?"
|
||||
|
||||
---
|
||||
|
||||
### 7. Generate Executive Summary Content
|
||||
|
||||
Based on the conversation, prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Executive Summary
|
||||
|
||||
{vision_alignment_content}
|
||||
|
||||
### What Makes This Special
|
||||
|
||||
{product_differentiator_content}
|
||||
|
||||
## Project Classification
|
||||
|
||||
**Technical Type:** {project_type}
|
||||
**Domain:** {domain}
|
||||
**Complexity:** {complexity_level}
|
||||
{if projectDocsCount > 0}**Project Context:** Brownfield - extending existing system{else}**Project Context:** Greenfield - new project{/if}
|
||||
|
||||
{project_classification_content}
|
||||
```
|
||||
|
||||
### 8. Present Content and Menu
|
||||
|
||||
Show the generated content to the user and present:
|
||||
|
||||
"I've drafted our Executive Summary based on our conversation. This will be the first section of your PRD.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 7]
|
||||
|
||||
**Select an Option:**
|
||||
[A] Advanced Elicitation - Let's dive deeper and refine this content
|
||||
[P] Party Mode - Bring in different perspectives to improve this
|
||||
[C] Continue - Save this and move to Success Criteria Definition (Step 3 of 11)"
|
||||
|
||||
### 9. Handle Menu Selection
|
||||
|
||||
#### IF A (Advanced Elicitation):
|
||||
|
||||
- Execute {advancedElicitationTask} with the current content
|
||||
- Process the enhanced content that comes back
|
||||
- Ask user: "Accept these changes to the Executive Summary? (y/n)"
|
||||
- If yes: Update the content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### IF P (Party Mode):
|
||||
|
||||
- Execute {partyModeWorkflow} with the current content
|
||||
- Process the collaborative improvements that come back
|
||||
- Ask user: "Accept these changes to the Executive Summary? (y/n)"
|
||||
- If yes: Update the content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### IF C (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{nextStepFile}`
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [executive summary content finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and begin success criteria definition.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Document counts read from frontmatter and announced
|
||||
- Classification data loaded and used effectively
|
||||
- **Correct discovery path selected based on document counts**
|
||||
- Input documents analyzed and leveraged for head start
|
||||
- User classifications validated and confirmed
|
||||
- Product differentiator clearly identified and refined
|
||||
- Executive summary content generated collaboratively with document context
|
||||
- A/P/C menu presented and handled correctly
|
||||
- Content properly appended to document when C selected
|
||||
- Frontmatter updated with stepsCompleted: [1, 2]
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- **Not reading documentCounts from frontmatter first**
|
||||
- **Executing multiple discovery paths instead of exactly one**
|
||||
- Skipping classification data loading and guessing classifications
|
||||
- Not leveraging existing input documents to accelerate discovery
|
||||
- Not validating classifications with user before proceeding
|
||||
- Generating executive summary without real user input
|
||||
- Missing the "what makes it special" discovery and refinement
|
||||
- Not presenting A/P/C menu after content generation
|
||||
- Appending content without user selecting 'C'
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
|
||||
## COMPLEXITY HANDLING:
|
||||
|
||||
If `complexity_level = "high"`:
|
||||
|
||||
- Note the `suggested_workflow` and `web_searches` from domain CSV
|
||||
- Consider mentioning domain research needs in classification section
|
||||
- Document complexity implications in project classification
|
||||
@@ -0,0 +1,290 @@
|
||||
---
|
||||
name: 'step-03-success'
|
||||
description: 'Define comprehensive success criteria covering user, business, and technical success'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-success.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-journeys.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 3: Success Criteria Definition
|
||||
|
||||
**Progress: Step 3 of 11** - 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
|
||||
- 🎯 COLLABORATIVE discovery, not assumption-based goal setting
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating success criteria content
|
||||
- 💾 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 develop deeper insights about success metrics
|
||||
- **P (Party Mode)**: Bring multiple perspectives to define comprehensive success criteria
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- 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, 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.
|
||||
|
||||
**User Success First:**
|
||||
|
||||
- What would make a user say 'this was worth it'?
|
||||
- What's the moment where they realize this solved their problem?
|
||||
- After using {{project_name}}, what outcome are they walking away with?
|
||||
|
||||
Let's start with the user experience of success."
|
||||
|
||||
### 2. Explore User Success Metrics
|
||||
|
||||
Listen for specific user outcomes and help make them measurable:
|
||||
|
||||
- Guide from vague to specific: NOT "users are happy" → "users complete [key action] within [timeframe]"
|
||||
- Ask about emotional success: "When do they feel delighted/relieved/empowered?"
|
||||
- Identify success moments: "What's the 'aha!' moment?"
|
||||
- Define completion scenarios: "What does 'done' look like for the user?"
|
||||
|
||||
### 3. Define Business Success
|
||||
|
||||
Transition to business metrics:
|
||||
"Now let's look at success from the business perspective.
|
||||
|
||||
**Business Success:**
|
||||
|
||||
- What does success look like at 3 months? 12 months?
|
||||
- Are we measuring revenue, user growth, engagement, something else?
|
||||
- What metric would make you say 'this is working'?
|
||||
|
||||
Help me understand what success means for your business."
|
||||
|
||||
### 4. Challenge Vague Metrics
|
||||
|
||||
Push for specificity on business metrics:
|
||||
|
||||
- "10,000 users" → "What kind of users? Doing what?"
|
||||
- "99.9% uptime" → "What's the real concern - data loss? Failed payments?"
|
||||
- "Fast" → "How fast, and what specifically needs to be fast?"
|
||||
- "Good adoption" → "What percentage adoption by when?"
|
||||
|
||||
### 5. Connect to Product Differentiator
|
||||
|
||||
Tie success metrics back to what makes the product special:
|
||||
"So success means users experience [differentiator] and achieve [outcome]. Does that capture it?"
|
||||
|
||||
Adapt success criteria to context:
|
||||
|
||||
- Consumer: User love, engagement, retention
|
||||
- B2B: ROI, efficiency, adoption
|
||||
- Developer tools: Developer experience, community
|
||||
- Regulated: Compliance, safety, validation
|
||||
- GovTech: Government compliance, accessibility, procurement
|
||||
|
||||
### 6. Smart Scope Negotiation
|
||||
|
||||
Guide scope definition through success lens:
|
||||
"The Scoping Game:
|
||||
|
||||
1. What must work for this to be useful? → MVP
|
||||
2. What makes it competitive? → Growth
|
||||
3. What's the dream version? → Vision
|
||||
|
||||
Challenge scope creep conversationally:
|
||||
|
||||
- Could that wait until after launch?
|
||||
- Is that essential for proving the concept?
|
||||
|
||||
For complex domains, include compliance minimums in MVP."
|
||||
|
||||
### 7. Generate Success Criteria Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Success Criteria
|
||||
|
||||
### User Success
|
||||
|
||||
[Content about user success criteria based on conversation]
|
||||
|
||||
### Business Success
|
||||
|
||||
[Content about business success metrics based on conversation]
|
||||
|
||||
### Technical Success
|
||||
|
||||
[Content about technical success requirements based on conversation]
|
||||
|
||||
### Measurable Outcomes
|
||||
|
||||
[Content about specific measurable outcomes based on conversation]
|
||||
|
||||
## Product Scope
|
||||
|
||||
### MVP - Minimum Viable Product
|
||||
|
||||
[Content about MVP scope based on conversation]
|
||||
|
||||
### Growth Features (Post-MVP)
|
||||
|
||||
[Content about growth features based on conversation]
|
||||
|
||||
### Vision (Future)
|
||||
|
||||
[Content about future vision based on conversation]
|
||||
```
|
||||
|
||||
### 8. Present Content and Menu
|
||||
|
||||
Show the generated content and present choices:
|
||||
"I've drafted our success criteria and scope definition based on our conversation.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 7]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's dive deeper and refine these success metrics
|
||||
[P] Party Mode - Bring in different perspectives on success criteria
|
||||
[C] Continue - Save success criteria and move to User Journey Mapping (Step 4 of 11)"
|
||||
|
||||
### 9. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current success criteria content
|
||||
- Process the enhanced success metrics that come back
|
||||
- Ask user: "Accept these improvements to the success criteria? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current success criteria
|
||||
- Process the collaborative improvements to metrics and scope
|
||||
- Ask user: "Accept these changes to the success criteria? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step to the end of the steps completed array
|
||||
- Load `./step-04-journeys.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 7.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ User success criteria clearly identified and made measurable
|
||||
✅ Business success metrics defined with specific targets
|
||||
✅ Success criteria connected to product differentiator
|
||||
✅ Scope properly negotiated (MVP, Growth, Vision)
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Accepting vague success metrics without pushing for specificity
|
||||
❌ Not connecting success criteria back to product differentiator
|
||||
❌ Missing scope negotiation and leaving it undefined
|
||||
❌ Generating content without real user input on what success looks like
|
||||
❌ 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):
|
||||
|
||||
- Include compliance milestones in success criteria
|
||||
- Add regulatory approval timelines to MVP scope
|
||||
- Consider audit requirements as technical success metrics
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-04-journeys.md` to map user journeys.
|
||||
|
||||
Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,291 @@
|
||||
---
|
||||
name: 'step-04-journeys'
|
||||
description: 'Map ALL user types that interact with the system with narrative story-based journeys'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-journeys.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-05-domain.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 4: User Journey Mapping
|
||||
|
||||
**Progress: Step 4 of 11** - Next: Domain Requirements
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between PM peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on mapping ALL user types that interact with the system
|
||||
- 🎯 CRITICAL: No journey = no functional requirements = product doesn't exist
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating journey content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper journey insights
|
||||
- **P (Party Mode)**: Bring multiple perspectives to map comprehensive user journeys
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Success criteria and scope already defined
|
||||
- Input documents from step-01 are available (product briefs with user personas)
|
||||
- Every human interaction with the system needs a journey
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Create compelling narrative user journeys that leverage existing personas from product briefs and identify additional user types needed for comprehensive coverage.
|
||||
|
||||
## JOURNEY MAPPING SEQUENCE:
|
||||
|
||||
### 1. Leverage Existing Users & Identify Additional Types
|
||||
|
||||
**Check Input Documents for Existing Personas:**
|
||||
Analyze product brief, research, and brainstorming documents for user personas already defined.
|
||||
|
||||
**If User Personas Exist in Input Documents:**
|
||||
"I found some fantastic user personas in your product brief! Let me introduce them and see if we need to expand our cast of characters.
|
||||
|
||||
**From your brief:**
|
||||
{{extracted_personas_from_brief_with_details}}
|
||||
|
||||
These are great starting points! Their stories already give us insight into what they need from {{project_name}}.
|
||||
|
||||
**Beyond your identified users, who else touches this system?**
|
||||
Based on your product type and scope, we might need:
|
||||
|
||||
{{suggest_additional_user_types_based_on_project_context}}
|
||||
|
||||
What additional user types should we consider for this product?"
|
||||
|
||||
**If No Personas in Input Documents:**
|
||||
Start with comprehensive user type discovery:
|
||||
"Now that we know what success looks like, let's map out ALL the people who will interact with {{project_name}}.
|
||||
|
||||
**Beyond primary users, who else touches this system?**
|
||||
Consider:
|
||||
|
||||
- End users (the primary focus)
|
||||
- Admins - manage users, settings, content
|
||||
- Moderators - review flagged content, enforce rules
|
||||
- Support staff - help users, investigate issues
|
||||
- API consumers - if dev tool or platform
|
||||
- Internal ops - analytics, monitoring, billing
|
||||
|
||||
What user types should we map for this product?"
|
||||
|
||||
### 2. Create Narrative Story-Based Journeys
|
||||
|
||||
For each user type, create compelling narrative journeys that tell their story:
|
||||
|
||||
#### Narrative Journey Creation Process:
|
||||
|
||||
**If Using Existing Persona from Input Documents:**
|
||||
"Let's tell {{persona_name}}'s story with {{project_name}}.
|
||||
|
||||
**Their Story So Far:**
|
||||
{{persona_backstory_from_brief}}
|
||||
|
||||
**How {{project_name}} Changes Their Life:**
|
||||
{{how_product_helps_them}}
|
||||
|
||||
Let's craft their journey narrative - where do we meet them in their story, and how does {{project_name}} help them write their next chapter?"
|
||||
|
||||
**If Creating New Persona:**
|
||||
"Let's bring this user type to life with a compelling story.
|
||||
|
||||
**Creating Their Character:**
|
||||
|
||||
- **Name**: Give them a realistic name and personality
|
||||
- **Situation**: What's happening in their life/work that creates the need?
|
||||
- **Goal**: What do they desperately want to achieve?
|
||||
- **Obstacle**: What's standing in their way right now?
|
||||
|
||||
**How {{project_name}} Becomes Their Solution:**
|
||||
{{how_product_solves_their_story}}
|
||||
|
||||
Now let's map their journey narrative."
|
||||
|
||||
**Story-Based Journey Mapping:**
|
||||
|
||||
"Let's craft this as a story with our hero (the user) facing challenges and finding solutions through {{project_name}}:
|
||||
|
||||
**Story Structure:**
|
||||
|
||||
- **Opening Scene**: Where and how do we meet them? What's their current pain?
|
||||
- **Rising Action**: What steps do they take? What do they discover?
|
||||
- **Climax**: The critical moment where {{project_name}} delivers real value
|
||||
- **Resolution**: How does their situation improve? What's their new reality?
|
||||
|
||||
**Use This Narrative Format such as this example:**
|
||||
|
||||
```markdown
|
||||
**Journey 1: Maria Santos - Reclaiming Her Creative Time**
|
||||
Maria is a freelance graphic designer who loves creating beautiful logos but spends hours every week managing client projects, sending invoices, and chasing payments. She feels like she's running a small business instead of doing what she loves. Late one night, while searching for invoicing tools, she discovers CreativeFlow and decides to give it a try.
|
||||
|
||||
The next morning, instead of her usual 30-minute project management routine, she spends 5 minutes setting up her first client in CreativeFlow. The system automatically generates a professional invoice and even suggests follow-up emails based on her communication patterns. When a client asks for a project update, Maria can share a beautiful progress link instead of digging through emails.
|
||||
|
||||
The breakthrough comes when she lands a major corporate client who's impressed by her "organized and professional" project setup. Six months later, Maria has doubled her client base and spends 80% of her time actually designing - exactly what she always wanted.
|
||||
```
|
||||
|
||||
### 3. Guide Journey Exploration
|
||||
|
||||
For each journey, facilitate detailed exploration:
|
||||
|
||||
- "What happens at each step specifically?"
|
||||
- "What could go wrong here? What's the recovery path?"
|
||||
- "What information do they need to see/hear?"
|
||||
- "What's their emotional state at each point?"
|
||||
- "Where does this journey succeed or fail?"
|
||||
|
||||
### 4. Connect Journeys to Requirements
|
||||
|
||||
After each journey, explicitly state:
|
||||
"This journey reveals requirements for:
|
||||
|
||||
- List specific capability areas (e.g., onboarding, meal planning, admin dashboard)
|
||||
- Help user see how different journeys create different feature sets"
|
||||
|
||||
### 5. Aim for Comprehensive Coverage
|
||||
|
||||
Guide toward complete journey set:
|
||||
|
||||
- **Primary user** - happy path (core experience)
|
||||
- **Primary user** - edge case (different goal, error recovery)
|
||||
- **Secondary user** (admin, moderator, support, etc.)
|
||||
- **API consumer** (if applicable)
|
||||
|
||||
Ask: "Another journey? We should cover [suggest uncovered user type]"
|
||||
|
||||
### 6. Generate User Journey Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## User Journeys
|
||||
|
||||
[All journey narratives based on conversation]
|
||||
|
||||
### Journey Requirements Summary
|
||||
|
||||
[Summary of capabilities revealed by journeys based on conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated journey content and present choices:
|
||||
"I've mapped out the user journeys based on our conversation. Each journey reveals different capabilities needed for {{project_name}}.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's dive deeper into these user journeys
|
||||
[P] Party Mode - Bring different perspectives to ensure we have all journeys
|
||||
[C] Continue - Save this and move to Domain Requirements (Step 5 of 11)"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current journey content
|
||||
- Process the enhanced journey insights that come back
|
||||
- Ask user: "Accept these improvements to the user journeys? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current journeys
|
||||
- Process the collaborative journey improvements and additions
|
||||
- Ask user: "Accept these changes to the user journeys? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md` (or determine if step is optional based on domain complexity)
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Existing personas from product briefs leveraged when available
|
||||
✅ All user types identified (not just primary users)
|
||||
✅ Rich narrative storytelling for each persona and journey
|
||||
✅ Complete story-based journey mapping with emotional arc
|
||||
✅ Journey requirements clearly connected to capabilities needed
|
||||
✅ Minimum 3-4 compelling narrative journeys covering different user types
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Ignoring existing personas from product briefs
|
||||
❌ Only mapping primary user journeys and missing secondary users
|
||||
❌ Creating generic journeys without rich persona details and narrative
|
||||
❌ Missing emotional storytelling elements that make journeys compelling
|
||||
❌ Missing critical decision points and failure scenarios
|
||||
❌ Not connecting journeys to required capabilities
|
||||
❌ Not having enough journey diversity (admin, support, API, etc.)
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
❌ Appending content without user selecting 'C'
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## JOURNEY TYPES TO ENSURE:
|
||||
|
||||
**Minimum Coverage:**
|
||||
|
||||
1. **Primary User - Success Path**: Core experience journey
|
||||
2. **Primary User - Edge Case**: Error recovery, alternative goals
|
||||
3. **Admin/Operations User**: Management, configuration, monitoring
|
||||
4. **Support/Troubleshooting**: Help, investigation, issue resolution
|
||||
5. **API/Integration** (if applicable): Developer/technical user journey
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-domain.md`.
|
||||
|
||||
Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
271
_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md
Normal file
271
_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md
Normal file
@@ -0,0 +1,271 @@
|
||||
---
|
||||
name: 'step-05-domain'
|
||||
description: 'Explore domain-specific requirements for complex domains (optional step)'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-05-domain.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-06-innovation.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
domainComplexityCSV: '{workflow_path}/domain-complexity.csv'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 5: Domain-Specific Exploration
|
||||
|
||||
**Progress: Step 5 of 11** - Next: Innovation Focus
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative discovery between PM peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on domain-specific requirements and compliance needs
|
||||
- 🎯 OPTIONAL STEP: Only proceed if complexity_level = "high" from step-02
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating domain content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper domain insights
|
||||
- **P (Party Mode)**: Bring domain expertise perspectives to explore requirements
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Domain complexity from step-02 should be "high" to justify this step
|
||||
- Domain-specific CSV data will be loaded in this step
|
||||
- Focus on compliance, regulations, and domain-specific constraints
|
||||
|
||||
## OPTIONAL STEP CHECK:
|
||||
|
||||
Before proceeding with this step, verify:
|
||||
|
||||
- Is `complexity_level` from step-02 equal to "high" and/or does the domain have specific regulatory/compliance needs?
|
||||
- Would domain exploration significantly impact the product requirements?
|
||||
|
||||
If NO to these questions, skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`.
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Explore domain-specific requirements for complex domains that need specialized compliance, regulatory, or industry-specific considerations.
|
||||
|
||||
## DOMAIN EXPLORATION SEQUENCE:
|
||||
|
||||
### 1. Load Domain Configuration Data
|
||||
|
||||
Load domain-specific configuration for complex domains:
|
||||
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv` completely
|
||||
- Find the row where `domain` matches the detected domain from step-02
|
||||
- Extract these columns:
|
||||
- `key_concerns` (semicolon-separated list)
|
||||
- `required_knowledge` (domain expertise needed)
|
||||
- `web_searches` (suggested research queries)
|
||||
- `special_sections` (domain-specific sections to document)
|
||||
|
||||
### 2. Present Domain Complexity Context
|
||||
|
||||
Start by explaining why this step is needed:
|
||||
"Since {{project_name}} is in the {domain} domain with high complexity, we need to explore domain-specific requirements.
|
||||
|
||||
**Key Concerns for {domain}:**
|
||||
[List the key_concerns from CSV]
|
||||
|
||||
This step will help us understand regulatory requirements, compliance needs, and industry-specific constraints that will shape our product."
|
||||
|
||||
### 3. Explore Domain-Specific Requirements
|
||||
|
||||
For each concern in `key_concerns` from the CSV:
|
||||
|
||||
#### Domain Concern Exploration:
|
||||
|
||||
- Ask the user about their approach to this concern
|
||||
- Discuss implications for the product design and requirements
|
||||
- Document specific requirements, constraints, and compliance needs
|
||||
|
||||
**Example for Healthcare Domain:**
|
||||
If key_concerns = "FDA approval;Clinical validation;HIPAA compliance;Patient safety;Medical device classification;Liability"
|
||||
|
||||
Ask about each:
|
||||
|
||||
- "Will this product require FDA approval? What classification?"
|
||||
- "How will you validate clinical accuracy and safety?"
|
||||
- "What HIPAA compliance measures are needed?"
|
||||
- "What patient safety protocols must be in place?"
|
||||
- "What liability considerations affect the design?"
|
||||
|
||||
### 4. Synthesize Domain Requirements
|
||||
|
||||
Based on the conversation, synthesize domain requirements that will shape everything:
|
||||
|
||||
#### Categories to Document:
|
||||
|
||||
- **Regulatory requirements** (from key_concerns)
|
||||
- **Compliance needs** (from key_concerns)
|
||||
- **Industry standards** (from required_knowledge)
|
||||
- **Safety/risk factors** (from key_concerns)
|
||||
- **Required validations** (from key_concerns)
|
||||
- **Special expertise needed** (from required_knowledge)
|
||||
|
||||
Explain how these inform:
|
||||
|
||||
- What features are mandatory
|
||||
- What NFRs are critical
|
||||
- How to sequence development
|
||||
- What validation is required
|
||||
|
||||
### 5. Generate Domain-Specific Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Domain-Specific Requirements
|
||||
|
||||
### [Domain Name] Compliance & Regulatory Overview
|
||||
|
||||
[Domain context summary based on conversation]
|
||||
|
||||
### Key Domain Concerns
|
||||
|
||||
[Key concerns addressed based on conversation]
|
||||
|
||||
### Compliance Requirements
|
||||
|
||||
[Compliance requirements based on conversation]
|
||||
|
||||
### Industry Standards & Best Practices
|
||||
|
||||
[Industry standards based on conversation]
|
||||
|
||||
### Required Expertise & Validation
|
||||
|
||||
[Required knowledge and validation based on conversation]
|
||||
|
||||
### Implementation Considerations
|
||||
|
||||
[Implementation implications based on conversation]
|
||||
```
|
||||
|
||||
### 6. Handle Special Sections
|
||||
|
||||
Parse `special_sections` list from the matched CSV row. For each section name, generate corresponding subsections:
|
||||
|
||||
**Example mappings from CSV:**
|
||||
|
||||
- "clinical_requirements" → Add clinical validation requirements
|
||||
- "regulatory_pathway" → Document approval pathway timeline
|
||||
- "safety_measures" → Specify safety protocols and monitoring
|
||||
- "compliance_matrix" → Create compliance tracking matrix
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated domain content and present choices:
|
||||
"I've documented the {domain}-specific requirements that will shape {{project_name}}. These constraints are critical for success in this complex domain.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete markdown content from step 6]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's dive deeper into these domain requirements
|
||||
[P] Party Mode - Bring domain expertise perspectives to validate requirements
|
||||
[C] Continue - Save this and move to Innovation Focus (Step 6 of 11)"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current domain content
|
||||
- Process the enhanced domain insights that come back
|
||||
- Ask user: "Accept these domain requirement improvements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current domain requirements
|
||||
- Process the collaborative domain expertise and validation
|
||||
- Ask user: "Accept these changes to domain requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Domain complexity properly validated as high before proceeding
|
||||
✅ All key concerns from CSV explored with user input
|
||||
✅ Compliance requirements clearly documented
|
||||
✅ Domain expertise needs identified and documented
|
||||
✅ Special sections generated per CSV configuration
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Proceeding with domain exploration when complexity is not high
|
||||
❌ Not loading or using CSV domain configuration properly
|
||||
❌ Missing critical domain concerns from the key_concerns list
|
||||
❌ Not connecting domain requirements to product implications
|
||||
❌ Generating generic content without domain-specific details
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
❌ Appending content without user selecting 'C'
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## SKIP CONDITIONS:
|
||||
|
||||
Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md` if:
|
||||
|
||||
- `complexity_level` from step-02 is not "high"
|
||||
- Domain has no specific regulatory/compliance requirements
|
||||
- User confirms domain exploration is not needed
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`.
|
||||
|
||||
Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,262 @@
|
||||
---
|
||||
name: 'step-06-innovation'
|
||||
description: 'Detect and explore innovative aspects of the product (optional step)'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-06-innovation.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-07-project-type.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
projectTypesCSV: '{workflow_path}/project-types.csv'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# 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
|
||||
- 🎯 OPTIONAL STEP: Only proceed if innovation signals are detected
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating innovation content
|
||||
- 💾 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 develop deeper innovation insights
|
||||
- **P (Party Mode)**: Bring creative perspectives to explore innovation opportunities
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Project type from step-02 is available for innovation signal matching
|
||||
- Project-type CSV data will be loaded in this step
|
||||
- Focus on detecting genuine innovation, not forced creativity
|
||||
|
||||
## OPTIONAL STEP CHECK:
|
||||
|
||||
Before proceeding with this step, scan for innovation signals:
|
||||
|
||||
- Listen for language like "nothing like this exists", "rethinking how X works"
|
||||
- Check for project-type innovation signals from CSV
|
||||
- Look for novel approaches or unique combinations
|
||||
- If no innovation detected, skip this step
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Detect and explore innovation patterns in the product, focusing on what makes it truly novel and how to validate the innovative aspects.
|
||||
|
||||
## INNOVATION DISCOVERY SEQUENCE:
|
||||
|
||||
### 1. Load Project-Type Innovation Data
|
||||
|
||||
Load innovation signals specific to this project type:
|
||||
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv` completely
|
||||
- Find the row where `project_type` matches detected type from step-02
|
||||
- Extract `innovation_signals` (semicolon-separated list)
|
||||
- Extract `web_search_triggers` for potential innovation research
|
||||
|
||||
### 2. Listen for Innovation Indicators
|
||||
|
||||
Monitor conversation for both general and project-type-specific innovation signals:
|
||||
|
||||
#### General Innovation Language:
|
||||
|
||||
- "Nothing like this exists"
|
||||
- "We're rethinking how [X] works"
|
||||
- "Combining [A] with [B] for the first time"
|
||||
- "Novel approach to [problem]"
|
||||
- "No one has done [concept] before"
|
||||
|
||||
#### Project-Type-Specific Signals (from CSV):
|
||||
|
||||
Match user descriptions against innovation_signals for their project_type:
|
||||
|
||||
- **api_backend**: "API composition;New protocol"
|
||||
- **mobile_app**: "Gesture innovation;AR/VR features"
|
||||
- **saas_b2b**: "Workflow automation;AI agents"
|
||||
- **developer_tool**: "New paradigm;DSL creation"
|
||||
|
||||
### 3. Initial Innovation Screening
|
||||
|
||||
Ask targeted innovation discovery questions:
|
||||
"As we explore {{project_name}}, I'm listening for what makes it innovative.
|
||||
|
||||
**Innovation Indicators:**
|
||||
|
||||
- Are you challenging any existing assumptions about how things work?
|
||||
- Are you combining technologies or approaches in new ways?
|
||||
- Is there something about this that hasn't been done before?
|
||||
|
||||
What aspects of {{project_name}} feel most innovative to you?"
|
||||
|
||||
### 4. Deep Innovation Exploration (If Detected)
|
||||
|
||||
If innovation signals are found, explore deeply:
|
||||
|
||||
#### Innovation Discovery Questions:
|
||||
|
||||
- "What makes it unique compared to existing solutions?"
|
||||
- "What assumption are you challenging?"
|
||||
- "How do we validate it works?"
|
||||
- "What's the fallback if it doesn't?"
|
||||
- "Has anyone tried this before?"
|
||||
|
||||
#### Market Context Research:
|
||||
|
||||
If relevant innovation detected, consider web search for context:
|
||||
Use `web_search_triggers` from project-type CSV:
|
||||
`[web_search_triggers] {concept} innovations {date}`
|
||||
|
||||
### 5. Generate Innovation Content (If Innovation Detected)
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Innovation & Novel Patterns
|
||||
|
||||
### Detected Innovation Areas
|
||||
|
||||
[Innovation patterns identified based on conversation]
|
||||
|
||||
### Market Context & Competitive Landscape
|
||||
|
||||
[Market context and research based on conversation]
|
||||
|
||||
### Validation Approach
|
||||
|
||||
[Validation methodology based on conversation]
|
||||
|
||||
### Risk Mitigation
|
||||
|
||||
[Innovation risks and fallbacks based on conversation]
|
||||
```
|
||||
|
||||
### 6. Present Content and Menu (Only if Innovation Detected)
|
||||
|
||||
Show the generated innovation content and present choices:
|
||||
"I've identified some innovative aspects of {{project_name}} that differentiate it from existing solutions.
|
||||
|
||||
**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 - Let's dive deeper into these innovation opportunities
|
||||
[P] Party Mode - Bring creative perspectives to explore innovation further
|
||||
[C] Continue - Save this and move to Project Type Analysis (Step 7 of 11)"
|
||||
|
||||
### 7. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current innovation content
|
||||
- Process the enhanced innovation insights that come back
|
||||
- Ask user: "Accept these improvements to the innovation analysis? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current innovation content
|
||||
- Process the collaborative innovation exploration and ideation
|
||||
- Ask user: "Accept these changes to the innovation analysis? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`
|
||||
|
||||
## NO INNOVATION DETECTED:
|
||||
|
||||
If no genuine innovation signals are found after exploration:
|
||||
"After exploring {{project_name}}, I don't see clear innovation signals that warrant a dedicated innovation section. This is perfectly fine - many successful products are excellent executions of existing concepts rather than breakthrough innovations.
|
||||
|
||||
**Options:**
|
||||
[A] Force innovation exploration - Let's try to find innovative angles
|
||||
[C] Continue - Skip innovation section and move to Project Type Analysis (Step 7 of 11)"
|
||||
|
||||
If user selects 'A', proceed with content generation anyway. If 'C', skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`.
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 5.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Innovation signals properly detected from user conversation
|
||||
✅ Project-type innovation signals used to guide discovery
|
||||
✅ Genuine innovation explored (not forced creativity)
|
||||
✅ Validation approach clearly defined for innovative aspects
|
||||
✅ Risk mitigation strategies identified
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Forced innovation when none genuinely exists
|
||||
❌ Not using project-type innovation signals from CSV
|
||||
❌ Missing market context research for novel concepts
|
||||
❌ Not addressing validation approach for innovative features
|
||||
❌ Creating innovation theater without real innovative aspects
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
❌ Appending content without user selecting 'C'
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## SKIP CONDITIONS:
|
||||
|
||||
Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` if:
|
||||
|
||||
- No innovation signals detected in conversation
|
||||
- Product is incremental improvement rather than breakthrough
|
||||
- User confirms innovation exploration is not needed
|
||||
- Project-type CSV has no innovation signals for this type
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document (or step is skipped), load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`.
|
||||
|
||||
Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu (or confirms step skip)!
|
||||
@@ -0,0 +1,258 @@
|
||||
---
|
||||
name: 'step-07-project-type'
|
||||
description: 'Conduct project-type specific discovery using CSV-driven guidance'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-07-project-type.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-08-scoping.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
projectTypesCSV: '{workflow_path}/project-types.csv'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# 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
|
||||
- 🎯 DATA-DRIVEN: Use CSV configuration to guide discovery
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating project-type content
|
||||
- 💾 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 develop deeper project-type insights
|
||||
- **P (Party Mode)**: Bring technical perspectives to explore project-specific requirements
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Project type from step-02 is available for configuration loading
|
||||
- Project-type CSV data will be loaded in this step
|
||||
- Focus on technical and functional requirements specific to this project type
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Conduct project-type specific discovery using CSV-driven guidance to define technical requirements.
|
||||
|
||||
## PROJECT-TYPE DISCOVERY SEQUENCE:
|
||||
|
||||
### 1. Load Project-Type Configuration Data
|
||||
|
||||
Load project-type specific configuration:
|
||||
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv` completely
|
||||
- Find the row where `project_type` matches detected type from step-02
|
||||
- Extract these columns:
|
||||
- `key_questions` (semicolon-separated list of discovery questions)
|
||||
- `required_sections` (semicolon-separated list of sections to document)
|
||||
- `skip_sections` (semicolon-separated list of sections to skip)
|
||||
- `innovation_signals` (already explored in step-6)
|
||||
|
||||
### 2. Conduct Guided Discovery Using Key Questions
|
||||
|
||||
Parse `key_questions` from CSV and explore each:
|
||||
|
||||
#### Question-Based Discovery:
|
||||
|
||||
For each question in `key_questions` from CSV:
|
||||
|
||||
- Ask the user naturally in conversational style
|
||||
- Listen for their response and ask clarifying follow-ups
|
||||
- Connect answers to product value proposition
|
||||
|
||||
**Example Flow:**
|
||||
If key_questions = "Endpoints needed?;Authentication method?;Data formats?;Rate limits?;Versioning?;SDK needed?"
|
||||
|
||||
Ask naturally:
|
||||
|
||||
- "What are the main endpoints your API needs to expose?"
|
||||
- "How will you handle authentication and authorization?"
|
||||
- "What data formats will you support for requests and responses?"
|
||||
|
||||
### 3. Document Project-Type Specific Requirements
|
||||
|
||||
Based on user answers to key_questions, synthesize comprehensive requirements:
|
||||
|
||||
#### Requirement Categories:
|
||||
|
||||
Cover the areas indicated by `required_sections` from CSV:
|
||||
|
||||
- Synthesize what was discovered for each required section
|
||||
- Document specific requirements, constraints, and decisions
|
||||
- Connect to product differentiator when relevant
|
||||
|
||||
#### Skip Irrelevant Sections:
|
||||
|
||||
Skip areas indicated by `skip_sections` from CSV to avoid wasting time on irrelevant aspects.
|
||||
|
||||
### 4. Generate Dynamic Content Sections
|
||||
|
||||
Parse `required_sections` list from the matched CSV row. For each section name, generate corresponding content:
|
||||
|
||||
#### Common CSV Section Mappings:
|
||||
|
||||
- "endpoint_specs" or "endpoint_specification" → API endpoints documentation
|
||||
- "auth_model" or "authentication_model" → Authentication approach
|
||||
- "platform_reqs" or "platform_requirements" → Platform support needs
|
||||
- "device_permissions" or "device_features" → Device capabilities
|
||||
- "tenant_model" → Multi-tenancy approach
|
||||
- "rbac_matrix" or "permission_matrix" → Permission structure
|
||||
|
||||
#### Template Variable Strategy:
|
||||
|
||||
- For sections matching common template variables: generate specific content
|
||||
- For sections without template matches: include in main project_type_requirements
|
||||
- Hybrid approach balances template structure with CSV-driven flexibility
|
||||
|
||||
### 5. Generate Project-Type Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## [Project Type] Specific Requirements
|
||||
|
||||
### Project-Type Overview
|
||||
|
||||
[Project type summary based on conversation]
|
||||
|
||||
### Technical Architecture Considerations
|
||||
|
||||
[Technical architecture requirements based on conversation]
|
||||
|
||||
[Dynamic sections based on CSV and conversation]
|
||||
|
||||
### Implementation Considerations
|
||||
|
||||
[Implementation specific requirements based on conversation]
|
||||
```
|
||||
|
||||
### 6. Present Content and Menu
|
||||
|
||||
Show the generated project-type content and present choices:
|
||||
"I've documented the {project_type}-specific requirements for {{project_name}} based on our conversation and best practices for this type of product.
|
||||
|
||||
**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 - Let's dive deeper into these technical requirements
|
||||
[P] Party Mode - Bring technical expertise perspectives to validate requirements
|
||||
[C] Continue - Save this and move to Scoping (Step 8 of 11)"
|
||||
|
||||
### 7. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current project-type content
|
||||
- Process the enhanced technical insights that come back
|
||||
- Ask user: "Accept these improvements to the technical requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current project-type requirements
|
||||
- Process the collaborative technical expertise and validation
|
||||
- Ask user: "Accept these changes to the technical requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 5.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Project-type configuration loaded and used effectively
|
||||
✅ All key questions from CSV explored with user input
|
||||
✅ Required sections generated per CSV configuration
|
||||
✅ Skip sections properly avoided to save time
|
||||
✅ Technical requirements connected to product value
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not loading or using project-type CSV configuration
|
||||
❌ Missing key questions from CSV in discovery process
|
||||
❌ Not generating required sections per CSV configuration
|
||||
❌ Documenting sections that should be skipped per CSV
|
||||
❌ Creating generic content without project-type specificity
|
||||
❌ 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:**
|
||||
|
||||
- Focus on endpoints, authentication, data schemas, rate limiting
|
||||
- Skip visual design and user journey sections
|
||||
- Generate API specification documentation
|
||||
|
||||
**For mobile_app:**
|
||||
|
||||
- Focus on platform requirements, device permissions, offline mode
|
||||
- Skip API endpoint documentation unless needed
|
||||
- Generate mobile-specific technical requirements
|
||||
|
||||
**For saas_b2b:**
|
||||
|
||||
- Focus on multi-tenancy, permissions, integrations
|
||||
- Skip mobile-first considerations unless relevant
|
||||
- Generate enterprise-specific requirements
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` to define project scope.
|
||||
|
||||
Remember: Do NOT proceed to step-08 (Scoping) until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,299 @@
|
||||
---
|
||||
name: 'step-08-scoping'
|
||||
description: 'Define MVP boundaries and prioritize features across development phases'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-08-scoping.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-09-functional.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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/core/workflows/advanced-elicitation/workflow.xml with current scoping analysis
|
||||
- Process enhanced scoping insights that come back
|
||||
- Ask user: "Accept these improvements to the scoping decisions? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with scoping context
|
||||
- Process collaborative insights on MVP and roadmap decisions
|
||||
- Ask user: "Accept these changes to the scoping decisions? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `./step-09-functional.md`
|
||||
|
||||
## 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!
|
||||
@@ -0,0 +1,270 @@
|
||||
---
|
||||
name: 'step-09-functional'
|
||||
description: 'Synthesize all discovery into comprehensive functional requirements'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-09-functional.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-10-nonfunctional.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 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
|
||||
- 🎯 CRITICAL: This is THE CAPABILITY CONTRACT for all downstream work
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating functional requirements
|
||||
- 💾 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 ensure comprehensive requirement coverage
|
||||
- **P (Party Mode)**: Bring multiple perspectives to validate complete requirement set
|
||||
- **C (Continue)**: Save the content to the document and proceed to next step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- ALL previous content (executive summary, success criteria, journeys, domain, innovation, project-type) must be referenced
|
||||
- No additional data files needed for this step
|
||||
- Focus on capabilities, not implementation details
|
||||
|
||||
## CRITICAL IMPORTANCE:
|
||||
|
||||
**This section defines THE CAPABILITY CONTRACT for the entire product:**
|
||||
|
||||
- UX designers will ONLY design what's listed here
|
||||
- Architects will ONLY support what's listed here
|
||||
- Epic breakdown will ONLY implement what's listed here
|
||||
- If a capability is missing from FRs, it will NOT exist in the final product
|
||||
|
||||
## FUNCTIONAL REQUIREMENTS SYNTHESIS SEQUENCE:
|
||||
|
||||
### 1. Understand FR Purpose and Usage
|
||||
|
||||
Start by explaining the critical role of functional requirements:
|
||||
|
||||
**Purpose:**
|
||||
FRs define WHAT capabilities the product must have. They are the complete inventory of user-facing and system capabilities that deliver the product vision.
|
||||
|
||||
**Critical Properties:**
|
||||
✅ Each FR is a testable capability
|
||||
✅ Each FR is implementation-agnostic (could be built many ways)
|
||||
✅ Each FR specifies WHO and WHAT, not HOW
|
||||
✅ No UI details, no performance numbers, no technology choices
|
||||
✅ Comprehensive coverage of capability areas
|
||||
|
||||
**How They Will Be Used:**
|
||||
|
||||
1. UX Designer reads FRs → designs interactions for each capability
|
||||
2. Architect reads FRs → designs systems to support each capability
|
||||
3. PM reads FRs → creates epics and stories to implement each capability
|
||||
|
||||
### 2. Review Existing Content for Capability Extraction
|
||||
|
||||
Systematically review all previous sections to extract capabilities:
|
||||
|
||||
**Extract From:**
|
||||
|
||||
- Executive Summary → Core product differentiator capabilities
|
||||
- Success Criteria → Success-enabling capabilities
|
||||
- User Journeys → Journey-revealed capabilities
|
||||
- Domain Requirements → Compliance and regulatory capabilities
|
||||
- Innovation Patterns → Innovative feature capabilities
|
||||
- Project-Type Requirements → Technical capability needs
|
||||
|
||||
### 3. Organize Requirements by Capability Area
|
||||
|
||||
Group FRs by logical capability areas (NOT by technology or layer):
|
||||
|
||||
**Good Grouping Examples:**
|
||||
|
||||
- ✅ "User Management" (not "Authentication System")
|
||||
- ✅ "Content Discovery" (not "Search Algorithm")
|
||||
- ✅ "Team Collaboration" (not "WebSocket Infrastructure")
|
||||
|
||||
**Target 5-8 Capability Areas** for typical projects.
|
||||
|
||||
### 4. Generate Comprehensive FR List
|
||||
|
||||
Create complete functional requirements using this format:
|
||||
|
||||
**Format:**
|
||||
|
||||
- FR#: [Actor] can [capability] [context/constraint if needed]
|
||||
- Number sequentially (FR1, FR2, FR3...)
|
||||
- Aim for 20-50 FRs for typical projects
|
||||
|
||||
**Altitude Check:**
|
||||
Each FR should answer "WHAT capability exists?" NOT "HOW it's implemented?"
|
||||
|
||||
**Examples:**
|
||||
|
||||
- ✅ "Users can customize appearance settings"
|
||||
- ❌ "Users can toggle light/dark theme with 3 font size options stored in LocalStorage"
|
||||
|
||||
### 5. Self-Validation Process
|
||||
|
||||
Before presenting to user, validate the FR list:
|
||||
|
||||
**Completeness Check:**
|
||||
|
||||
1. "Did I cover EVERY capability mentioned in the MVP scope section?"
|
||||
2. "Did I include domain-specific requirements as FRs?"
|
||||
3. "Did I cover the project-type specific needs?"
|
||||
4. "Could a UX designer read ONLY the FRs and know what to design?"
|
||||
5. "Could an Architect read ONLY the FRs and know what to support?"
|
||||
6. "Are there any user actions or system behaviors we discussed that have no FR?"
|
||||
|
||||
**Altitude Check:**
|
||||
|
||||
1. "Am I stating capabilities (WHAT) or implementation (HOW)?"
|
||||
2. "Am I listing acceptance criteria or UI specifics?" (Remove if yes)
|
||||
3. "Could this FR be implemented 5 different ways?" (Good - means it's not prescriptive)
|
||||
|
||||
**Quality Check:**
|
||||
|
||||
1. "Is each FR clear enough that someone could test whether it exists?"
|
||||
2. "Is each FR independent (not dependent on reading other FRs to understand)?"
|
||||
3. "Did I avoid vague terms like 'good', 'fast', 'easy'?" (Use NFRs for quality attributes)
|
||||
|
||||
### 6. Generate Functional Requirements Content
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections:
|
||||
|
||||
```markdown
|
||||
## Functional Requirements
|
||||
|
||||
### [Capability Area Name]
|
||||
|
||||
- FR1: [Specific Actor] can [specific capability]
|
||||
- FR2: [Specific Actor] can [specific capability]
|
||||
- FR3: [Specific Actor] can [specific capability]
|
||||
|
||||
### [Another Capability Area]
|
||||
|
||||
- FR4: [Specific Actor] can [specific capability]
|
||||
- FR5: [Specific Actor] can [specific capability]
|
||||
|
||||
[Continue for all capability areas discovered in conversation]
|
||||
```
|
||||
|
||||
### 7. Present Content and Menu
|
||||
|
||||
Show the generated functional requirements and present choices:
|
||||
"I've synthesized all our discussions into comprehensive functional requirements. This becomes the capability contract that UX designers, architects, and developers will all work from.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete FR list from step 6]
|
||||
|
||||
**This is critical because:**
|
||||
|
||||
- Every feature we build must trace back to one of these requirements
|
||||
- UX designers will ONLY design interactions for these capabilities
|
||||
- Architects will ONLY build systems to support these capabilities
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's ensure we haven't missed any capabilities
|
||||
[P] Party Mode - Bring different perspectives to validate complete coverage
|
||||
[C] Continue - Save this and move to Non-Functional Requirements (Step 10 of 11)"
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current FR list
|
||||
- Process the enhanced capability coverage that comes back
|
||||
- Ask user: "Accept these additions to the functional requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current FR list
|
||||
- Process the collaborative capability validation and additions
|
||||
- Ask user: "Accept these changes to the functional requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 6.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All previous discovery content synthesized into FRs
|
||||
✅ FRs organized by capability areas (not technology)
|
||||
✅ Each FR states WHAT capability exists, not HOW to implement
|
||||
✅ Comprehensive coverage with 20-50 FRs typical
|
||||
✅ Altitude validation ensures implementation-agnostic requirements
|
||||
✅ Completeness check validates coverage of all discussed capabilities
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Missing capabilities from previous discovery sections
|
||||
❌ Organizing FRs by technology instead of capability areas
|
||||
❌ Including implementation details or UI specifics in FRs
|
||||
❌ Not achieving comprehensive coverage of discussed capabilities
|
||||
❌ Using vague terms instead of testable capabilities
|
||||
❌ 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 `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` to define non-functional requirements.
|
||||
|
||||
Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,294 @@
|
||||
---
|
||||
name: 'step-10-nonfunctional'
|
||||
description: 'Define quality attributes that matter for this specific product'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-10-nonfunctional.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-11-complete.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
---
|
||||
|
||||
# Step 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
|
||||
- 🎯 SELECTIVE: Only document NFRs that actually apply to the product
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating NFR content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive quality attributes
|
||||
- **P (Party Mode)**: Bring technical perspectives to validate NFR completeness
|
||||
- **C (Continue)**: Save the content to the document and proceed to final step
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to this step's A/P/C menu
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Current document and frontmatter from previous steps are available
|
||||
- Functional requirements already defined and will inform NFRs
|
||||
- Domain and project-type context will guide which NFRs matter
|
||||
- Focus on specific, measurable quality criteria
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Define non-functional requirements that specify quality attributes for the product, focusing only on what matters for THIS specific product.
|
||||
|
||||
## NON-FUNCTIONAL REQUIREMENTS SEQUENCE:
|
||||
|
||||
### 1. Explain NFR Purpose and Scope
|
||||
|
||||
Start by clarifying what NFRs are and why we're selective:
|
||||
|
||||
**NFR Purpose:**
|
||||
NFRs define HOW WELL the system must perform, not WHAT it must do. They specify quality attributes like performance, security, scalability, etc.
|
||||
|
||||
**Selective Approach:**
|
||||
We only document NFRs that matter for THIS product. If a category doesn't apply, we skip it entirely. This prevents requirement bloat and focuses on what's actually important.
|
||||
|
||||
### 2. Assess Product Context for NFR Relevance
|
||||
|
||||
Evaluate which NFR categories matter based on product context:
|
||||
|
||||
**Quick Assessment Questions:**
|
||||
|
||||
- **Performance**: Is there user-facing impact of speed?
|
||||
- **Security**: Are we handling sensitive data or payments?
|
||||
- **Scalability**: Do we expect rapid user growth?
|
||||
- **Accessibility**: Are we serving broad public audiences?
|
||||
- **Integration**: Do we need to connect with other systems?
|
||||
- **Reliability**: Would downtime cause significant problems?
|
||||
|
||||
### 3. Explore Relevant NFR Categories
|
||||
|
||||
For each relevant category, conduct targeted discovery:
|
||||
|
||||
#### Performance NFRs (If relevant):
|
||||
|
||||
"Let's talk about performance requirements for {{project_name}}.
|
||||
|
||||
**Performance Questions:**
|
||||
|
||||
- What parts of the system need to be fast for users to be successful?
|
||||
- Are there specific response time expectations?
|
||||
- What happens if performance is slower than expected?
|
||||
- Are there concurrent user scenarios we need to support?"
|
||||
|
||||
#### Security NFRs (If relevant):
|
||||
|
||||
"Security is critical for products that handle sensitive information.
|
||||
|
||||
**Security Questions:**
|
||||
|
||||
- What data needs to be protected?
|
||||
- Who should have access to what?
|
||||
- What are the security risks we need to mitigate?
|
||||
- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)?"
|
||||
|
||||
#### Scalability NFRs (If relevant):
|
||||
|
||||
"Scalability matters if we expect growth or have variable demand.
|
||||
|
||||
**Scalability Questions:**
|
||||
|
||||
- How many users do we expect initially? Long-term?
|
||||
- Are there seasonal or event-based traffic spikes?
|
||||
- What happens if we exceed our capacity?"
|
||||
- What growth scenarios should we plan for?"
|
||||
|
||||
#### Accessibility NFRs (If relevant):
|
||||
|
||||
"Accessibility ensures the product works for users with disabilities.
|
||||
|
||||
**Accessibility Questions:**
|
||||
|
||||
- Are we serving users with visual, hearing, or motor impairments?
|
||||
- Are there legal accessibility requirements (WCAG, Section 508)?
|
||||
- What accessibility features are most important for our users?"
|
||||
|
||||
#### Integration NFRs (If relevant):
|
||||
|
||||
"Integration requirements matter for products that connect to other systems.
|
||||
|
||||
**Integration Questions:**
|
||||
|
||||
- What external systems do we need to connect with?
|
||||
- Are there APIs or data formats we must support?
|
||||
- How reliable do these integrations need to be?"
|
||||
|
||||
### 4. Make NFRs Specific and Measurable
|
||||
|
||||
For each relevant NFR category, ensure criteria are testable:
|
||||
|
||||
**From Vague to Specific:**
|
||||
|
||||
- NOT: "The system should be fast" → "User actions complete within 2 seconds"
|
||||
- NOT: "The system should be secure" → "All data is encrypted at rest and in transit"
|
||||
- NOT: "The system should scale" → "System supports 10x user growth with <10% performance degradation"
|
||||
|
||||
### 5. Generate NFR Content (Only Relevant Categories)
|
||||
|
||||
Prepare the content to append to the document:
|
||||
|
||||
#### Content Structure (Dynamic based on relevance):
|
||||
|
||||
When saving to document, append these Level 2 and Level 3 sections (only include sections that are relevant):
|
||||
|
||||
```markdown
|
||||
## Non-Functional Requirements
|
||||
|
||||
### Performance
|
||||
|
||||
[Performance requirements based on conversation - only include if relevant]
|
||||
|
||||
### Security
|
||||
|
||||
[Security requirements based on conversation - only include if relevant]
|
||||
|
||||
### Scalability
|
||||
|
||||
[Scalability requirements based on conversation - only include if relevant]
|
||||
|
||||
### Accessibility
|
||||
|
||||
[Accessibility requirements based on conversation - only include if relevant]
|
||||
|
||||
### Integration
|
||||
|
||||
[Integration requirements based on conversation - only include if relevant]
|
||||
```
|
||||
|
||||
### 6. Present Content and Menu
|
||||
|
||||
Show the generated NFR content and present choices:
|
||||
"I've defined the non-functional requirements that specify how well {{project_name}} needs to perform. I've only included categories that actually matter for this product.
|
||||
|
||||
**Here's what I'll add to the document:**
|
||||
|
||||
[Show the complete NFR content from step 5]
|
||||
|
||||
**Note:** We've skipped categories that don't apply to avoid unnecessary requirements.
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Let's ensure we haven't missed critical quality attributes
|
||||
[P] Party Mode - Bring technical perspectives to validate NFR specifications
|
||||
[C] Continue - Save this and move to Complete PRD (Step 11 of 11)"
|
||||
|
||||
### 7. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current NFR content
|
||||
- Process the enhanced quality attribute insights that come back
|
||||
- Ask user: "Accept these improvements to the non-functional requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current NFR list
|
||||
- Process the collaborative technical validation and additions
|
||||
- Ask user: "Accept these changes to the non-functional requirements? (y/n)"
|
||||
- If yes: Update content with improvements, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{outputFile}`
|
||||
- Update frontmatter: add this step name to the end of the steps completed array
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document using the structure from step 5.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Only relevant NFR categories documented (no requirement bloat)
|
||||
✅ Each NFR is specific and measurable
|
||||
✅ NFRs connected to actual user needs and business context
|
||||
✅ Vague requirements converted to testable criteria
|
||||
✅ Domain-specific compliance requirements included if relevant
|
||||
✅ A/P/C menu presented and handled correctly
|
||||
✅ Content properly appended to document when C selected
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Documenting NFR categories that don't apply to the product
|
||||
❌ Leaving requirements vague and unmeasurable
|
||||
❌ Not connecting NFRs to actual user or business needs
|
||||
❌ Missing domain-specific compliance requirements
|
||||
❌ Creating overly prescriptive technical requirements
|
||||
❌ 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:**
|
||||
|
||||
- User-facing response times impact success
|
||||
- Real-time interactions are critical
|
||||
- Performance is a competitive differentiator
|
||||
|
||||
**Include Security When:**
|
||||
|
||||
- Handling sensitive user data
|
||||
- Processing payments or financial information
|
||||
- Subject to compliance regulations
|
||||
- Protecting intellectual property
|
||||
|
||||
**Include Scalability When:**
|
||||
|
||||
- Expecting rapid user growth
|
||||
- Handling variable traffic patterns
|
||||
- Supporting enterprise-scale usage
|
||||
- Planning for market expansion
|
||||
|
||||
**Include Accessibility When:**
|
||||
|
||||
- Serving broad public audiences
|
||||
- Subject to accessibility regulations
|
||||
- Targeting users with disabilities
|
||||
- B2B customers with accessibility requirements
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` to finalize the PRD and complete the workflow.
|
||||
|
||||
Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
@@ -0,0 +1,186 @@
|
||||
---
|
||||
name: 'step-11-complete'
|
||||
description: 'Complete the PRD workflow, update status files, and suggest next steps'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-11-complete.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
---
|
||||
|
||||
# Step 11: Workflow Completion
|
||||
|
||||
**Final Step - Complete the PRD**
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ THIS IS A FINAL STEP - Workflow completion required
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- 🛑 NO content generation - this is a wrap-up step
|
||||
- 📋 FINALIZE document and update workflow status
|
||||
- 💬 FOCUS on completion, next steps, and suggestions
|
||||
- 🎯 UPDATE workflow status files with completion information
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Update the main workflow status file with completion information
|
||||
- 📖 Suggest potential next workflow steps for the user
|
||||
- 🚫 DO NOT load additional steps after this one
|
||||
|
||||
## TERMINATION STEP PROTOCOLS:
|
||||
|
||||
- This is a FINAL step - workflow completion required
|
||||
- Output any remaining content if needed (none for this step)
|
||||
- Update the main workflow status file with finalized document
|
||||
- Suggest potential next steps for the user
|
||||
- Mark workflow as complete in status tracking
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Complete PRD document is available from all previous steps
|
||||
- Workflow frontmatter shows all completed steps
|
||||
- All collaborative content has been generated and saved
|
||||
- Focus on completion, validation, and next steps
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Complete the PRD workflow, update status files, and suggest next steps for the project.
|
||||
|
||||
## WORKFLOW COMPLETION SEQUENCE:
|
||||
|
||||
### 1. Announce Workflow Completion
|
||||
|
||||
Inform user that the PRD is complete:
|
||||
"🎉 **PRD Complete, {{user_name}}!**
|
||||
|
||||
I've successfully collaborated with you to create a comprehensive Product Requirements Document for {{project_name}}.
|
||||
|
||||
**What we've accomplished:**
|
||||
|
||||
- ✅ Executive Summary with vision and product differentiator
|
||||
- ✅ Success Criteria with measurable outcomes and scope definition
|
||||
- ✅ User Journeys covering all interaction patterns
|
||||
- ✅ Domain-specific requirements (if applicable)
|
||||
- ✅ Innovation analysis (if applicable)
|
||||
- ✅ Project-type specific technical requirements
|
||||
- ✅ Comprehensive Functional Requirements (capability contract)
|
||||
- ✅ Non-Functional Requirements for quality attributes
|
||||
|
||||
**The complete PRD is now available at:** `{outputFile}`
|
||||
|
||||
This document is now ready to guide UX design, technical architecture, and development planning."
|
||||
|
||||
### 2. Workflow Status Update
|
||||
|
||||
Update the main workflow status file if there is one:
|
||||
|
||||
- Load `{status_file}` from workflow configuration (if exists)
|
||||
- Update workflow_status["prd"] = "{default_output_file}"
|
||||
- Save file, preserving all comments and structure
|
||||
- Mark current timestamp as completion time
|
||||
|
||||
### 3. Suggest Next Steps
|
||||
|
||||
Provide guidance on logical next workflows:
|
||||
|
||||
**Typical Next Workflows:**
|
||||
|
||||
**Immediate Next Steps:**
|
||||
|
||||
1. `workflow create-ux-design` - UX Design (if UI exists)
|
||||
- User journey insights from step-04 will inform interaction design
|
||||
- Functional requirements from step-09 define design scope
|
||||
|
||||
2. `workflow create-architecture` - Technical architecture
|
||||
- Project-type requirements from step-07 guide technical decisions
|
||||
- Non-functional requirements from step-10 inform architecture choices
|
||||
|
||||
3. `workflow create-epics-and-stories` - Epic breakdown
|
||||
- Functional requirements from step-09 become epics and stories
|
||||
- Scope definition from step-03 guides sprint planning
|
||||
|
||||
**Strategic Considerations:**
|
||||
|
||||
- UX design and architecture can happen in parallel
|
||||
- Epics/stories are richer when created after UX/architecture
|
||||
|
||||
**What would be most valuable to tackle next?**
|
||||
|
||||
### 4. Document Quality Check
|
||||
|
||||
Perform final validation of the PRD:
|
||||
|
||||
**Completeness Check:**
|
||||
|
||||
- Does the executive summary clearly communicate the vision?
|
||||
- Are success criteria specific and measurable?
|
||||
- Do user journeys cover all major user types?
|
||||
- Are functional requirements comprehensive and testable?
|
||||
- Are non-functional requirements relevant and specific?
|
||||
|
||||
**Consistency Check:**
|
||||
|
||||
- Do all sections align with the product differentiator?
|
||||
- Is scope consistent across all sections?
|
||||
- Are requirements traceable to user needs and success criteria?
|
||||
|
||||
### 5. Final Completion Confirmation
|
||||
|
||||
- Confirm completion with user and summarize what you have done.
|
||||
- Update frontmatter: add this final step name to the end of the steps completed array.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ PRD document contains all required sections
|
||||
✅ All collaborative content properly saved to document
|
||||
✅ Workflow status file updated with completion information
|
||||
✅ Clear next step guidance provided to user
|
||||
✅ Document quality validation completed
|
||||
✅ User acknowledges completion and understands next options
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not updating workflow status file with completion information
|
||||
❌ Missing clear next step guidance for user
|
||||
❌ Not confirming document completeness with user
|
||||
❌ Workflow not properly marked as complete in status tracking
|
||||
❌ User unclear about what happens next
|
||||
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## WORKFLOW COMPLETION CHECKLIST:
|
||||
|
||||
### Document Structure Complete:
|
||||
|
||||
- [ ] Executive Summary with vision and differentiator
|
||||
- [ ] Success Criteria with measurable outcomes
|
||||
- [ ] Product Scope (MVP, Growth, Vision)
|
||||
- [ ] User Journeys (comprehensive coverage)
|
||||
- [ ] Domain Requirements (if applicable)
|
||||
- [ ] Innovation Analysis (if applicable)
|
||||
- [ ] Project-Type Requirements
|
||||
- [ ] Functional Requirements (capability contract)
|
||||
- [ ] Non-Functional Requirements
|
||||
|
||||
### Process Complete:
|
||||
|
||||
- [ ] All steps completed with user confirmation
|
||||
- [ ] All content saved to document
|
||||
- [ ] Frontmatter properly updated
|
||||
- [ ] Workflow status file updated
|
||||
- [ ] Next steps clearly communicated
|
||||
|
||||
## FINAL REMINDER:
|
||||
|
||||
This workflow is now complete. The PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD.
|
||||
|
||||
**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉
|
||||
63
_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md
Normal file
63
_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
name: create-prd
|
||||
description: Creates a comprehensive PRD through collaborative step-by-step discovery between two product managers working as peers.
|
||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||
web_bundle: true
|
||||
---
|
||||
|
||||
# PRD Workflow
|
||||
|
||||
**Goal:** Create comprehensive PRDs through collaborative step-by-step discovery between two product managers working as peers.
|
||||
|
||||
**Your Role:** You are a product-focused PM facilitator collaborating with an expert peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision. Work together as equals. You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **step-file architecture** for disciplined execution:
|
||||
|
||||
### Core Principles
|
||||
|
||||
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||
|
||||
### Step Processing Rules
|
||||
|
||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
|
||||
|
||||
### Critical Rules (NO EXCEPTIONS)
|
||||
|
||||
- 🛑 **NEVER** load multiple step files simultaneously
|
||||
- 📖 **ALWAYS** read entire step file before execution
|
||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||
- 📋 **NEVER** create mental todo lists from future steps
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION SEQUENCE
|
||||
|
||||
### 1. Configuration Loading
|
||||
|
||||
Load and read full config from {main_config} and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as system-generated current datetime
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
|
||||
YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`.
|
||||
Load, read the full file and then execute `steps/step-01-init.md` to begin the workflow.
|
||||
@@ -0,0 +1,190 @@
|
||||
---
|
||||
name: 'step-01-document-discovery'
|
||||
description: 'Discover and inventory all project documents, handling duplicates and organizing file structure'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01-document-discovery.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-02-prd-analysis.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||
templateFile: '{workflow_path}/templates/readiness-report-template.md'
|
||||
---
|
||||
|
||||
# Step 1: Document Discovery
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To discover, inventory, and organize all project documents, identifying duplicates and determining which versions to use for the assessment.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are an expert Product Manager and Scrum Master
|
||||
- ✅ Your focus is on finding organizing and documenting what exists
|
||||
- ✅ You identify ambiguities and ask for clarification
|
||||
- ✅ Success is measured in clear file inventory and conflict resolution
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus ONLY on finding and organizing files
|
||||
- 🚫 Don't read or analyze file contents
|
||||
- 💬 Identify duplicate documents clearly
|
||||
- 🚪 Get user confirmation on file selections
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Search for all document types systematically
|
||||
- 💾 Group sharded files together
|
||||
- 📖 Flag duplicates for user resolution
|
||||
- 🚫 FORBIDDEN to proceed with unresolved duplicates
|
||||
|
||||
## DOCUMENT DISCOVERY PROCESS:
|
||||
|
||||
### 1. Initialize Document Discovery
|
||||
|
||||
"Beginning **Document Discovery** to inventory all project files.
|
||||
|
||||
I will:
|
||||
|
||||
1. Search for all required documents (PRD, Architecture, Epics, UX)
|
||||
2. Group sharded documents together
|
||||
3. Identify any duplicates (whole + sharded versions)
|
||||
4. Present findings for your confirmation"
|
||||
|
||||
### 2. Document Search Patterns
|
||||
|
||||
Search for each document type using these patterns:
|
||||
|
||||
#### A. PRD Documents
|
||||
|
||||
- Whole: `{planning_artifacts}/*prd*.md`
|
||||
- Sharded: `{planning_artifacts}/*prd*/index.md` and related files
|
||||
|
||||
#### B. Architecture Documents
|
||||
|
||||
- Whole: `{planning_artifacts}/*architecture*.md`
|
||||
- Sharded: `{planning_artifacts}/*architecture*/index.md` and related files
|
||||
|
||||
#### C. Epics & Stories Documents
|
||||
|
||||
- Whole: `{planning_artifacts}/*epic*.md`
|
||||
- Sharded: `{planning_artifacts}/*epic*/index.md` and related files
|
||||
|
||||
#### D. UX Design Documents
|
||||
|
||||
- Whole: `{planning_artifacts}/*ux*.md`
|
||||
- Sharded: `{planning_artifacts}/*ux*/index.md` and related files
|
||||
|
||||
### 3. Organize Findings
|
||||
|
||||
For each document type found:
|
||||
|
||||
```
|
||||
## [Document Type] Files Found
|
||||
|
||||
**Whole Documents:**
|
||||
- [filename.md] ([size], [modified date])
|
||||
|
||||
**Sharded Documents:**
|
||||
- Folder: [foldername]/
|
||||
- index.md
|
||||
- [other files in folder]
|
||||
```
|
||||
|
||||
### 4. Identify Critical Issues
|
||||
|
||||
#### Duplicates (CRITICAL)
|
||||
|
||||
If both whole and sharded versions exist:
|
||||
|
||||
```
|
||||
⚠️ CRITICAL ISSUE: Duplicate document formats found
|
||||
- PRD exists as both whole.md AND prd/ folder
|
||||
- YOU MUST choose which version to use
|
||||
- Remove or rename the other version to avoid confusion
|
||||
```
|
||||
|
||||
#### Missing Documents (WARNING)
|
||||
|
||||
If required documents not found:
|
||||
|
||||
```
|
||||
⚠️ WARNING: Required document not found
|
||||
- Architecture document not found
|
||||
- Will impact assessment completeness
|
||||
```
|
||||
|
||||
### 5. Add Initial Report Section
|
||||
|
||||
Initialize {outputFile} with {templateFile}.
|
||||
|
||||
### 6. Present Findings and Get Confirmation
|
||||
|
||||
Display findings and ask:
|
||||
"**Document Discovery Complete**
|
||||
|
||||
[Show organized file list]
|
||||
|
||||
**Issues Found:**
|
||||
|
||||
- [List any duplicates requiring resolution]
|
||||
- [List any missing documents]
|
||||
|
||||
**Required Actions:**
|
||||
|
||||
- If duplicates exist: Please remove/rename one version
|
||||
- Confirm which documents to use for assessment
|
||||
|
||||
**Ready to proceed?** [C] Continue after resolving issues"
|
||||
|
||||
### 7. Present MENU OPTIONS
|
||||
|
||||
Display: **Select an Option:** [C] Continue to File Validation
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed with 'C' selection
|
||||
- If duplicates identified, insist on resolution first
|
||||
- User can clarify file locations or request additional searches
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save document inventory to {outputFile}, update frontmatter with completed step and files being included, and only then load read fully and execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then redisplay menu
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and document inventory is saved will you load {nextStepFile} to begin file validation.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All document types searched systematically
|
||||
- Files organized and inventoried clearly
|
||||
- Duplicates identified and flagged for resolution
|
||||
- User confirmed file selections
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not searching all document types
|
||||
- Ignoring duplicate document conflicts
|
||||
- Proceeding without resolving critical issues
|
||||
- Not saving document inventory
|
||||
|
||||
**Master Rule:** Clear file identification is essential for accurate assessment.
|
||||
@@ -0,0 +1,178 @@
|
||||
---
|
||||
name: 'step-02-prd-analysis'
|
||||
description: 'Read and analyze PRD to extract all FRs and NFRs for coverage validation'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-02-prd-analysis.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||
epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file
|
||||
---
|
||||
|
||||
# Step 2: PRD Analysis
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To fully read and analyze the PRD document (whole or sharded) to extract all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for validation against epics coverage.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are an expert Product Manager and Scrum Master
|
||||
- ✅ Your expertise is in requirements analysis and traceability
|
||||
- ✅ You think critically about requirement completeness
|
||||
- ✅ Success is measured in thorough requirement extraction
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus ONLY on reading and extracting from PRD
|
||||
- 🚫 Don't validate files (done in step 1)
|
||||
- 💬 Read PRD completely - whole or all sharded files
|
||||
- 🚪 Extract every FR and NFR with numbering
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load and completely read the PRD
|
||||
- 💾 Extract all requirements systematically
|
||||
- 📖 Document findings in the report
|
||||
- 🚫 FORBIDDEN to skip or summarize PRD content
|
||||
|
||||
## PRD ANALYSIS PROCESS:
|
||||
|
||||
### 1. Initialize PRD Analysis
|
||||
|
||||
"Beginning **PRD Analysis** to extract all requirements.
|
||||
|
||||
I will:
|
||||
|
||||
1. Load the PRD document (whole or sharded)
|
||||
2. Read it completely and thoroughly
|
||||
3. Extract ALL Functional Requirements (FRs)
|
||||
4. Extract ALL Non-Functional Requirements (NFRs)
|
||||
5. Document findings for coverage validation"
|
||||
|
||||
### 2. Load and Read PRD
|
||||
|
||||
From the document inventory in step 1:
|
||||
|
||||
- If whole PRD file exists: Load and read it completely
|
||||
- If sharded PRD exists: Load and read ALL files in the PRD folder
|
||||
- Ensure complete coverage - no files skipped
|
||||
|
||||
### 3. Extract Functional Requirements (FRs)
|
||||
|
||||
Search for and extract:
|
||||
|
||||
- Numbered FRs (FR1, FR2, FR3, etc.)
|
||||
- Requirements labeled "Functional Requirement"
|
||||
- User stories or use cases that represent functional needs
|
||||
- Business rules that must be implemented
|
||||
|
||||
Format findings as:
|
||||
|
||||
```
|
||||
## Functional Requirements Extracted
|
||||
|
||||
FR1: [Complete requirement text]
|
||||
FR2: [Complete requirement text]
|
||||
FR3: [Complete requirement text]
|
||||
...
|
||||
Total FRs: [count]
|
||||
```
|
||||
|
||||
### 4. Extract Non-Functional Requirements (NFRs)
|
||||
|
||||
Search for and extract:
|
||||
|
||||
- Performance requirements (response times, throughput)
|
||||
- Security requirements (authentication, encryption, etc.)
|
||||
- Usability requirements (accessibility, ease of use)
|
||||
- Reliability requirements (uptime, error rates)
|
||||
- Scalability requirements (concurrent users, data growth)
|
||||
- Compliance requirements (standards, regulations)
|
||||
|
||||
Format findings as:
|
||||
|
||||
```
|
||||
## Non-Functional Requirements Extracted
|
||||
|
||||
NFR1: [Performance requirement]
|
||||
NFR2: [Security requirement]
|
||||
NFR3: [Usability requirement]
|
||||
...
|
||||
Total NFRs: [count]
|
||||
```
|
||||
|
||||
### 5. Document Additional Requirements
|
||||
|
||||
Look for:
|
||||
|
||||
- Constraints or assumptions
|
||||
- Technical requirements not labeled as FR/NFR
|
||||
- Business constraints
|
||||
- Integration requirements
|
||||
|
||||
### 6. Add to Assessment Report
|
||||
|
||||
Append to {outputFile}:
|
||||
|
||||
```markdown
|
||||
## PRD Analysis
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
[Complete FR list from section 3]
|
||||
|
||||
### Non-Functional Requirements
|
||||
|
||||
[Complete NFR list from section 4]
|
||||
|
||||
### Additional Requirements
|
||||
|
||||
[Any other requirements or constraints found]
|
||||
|
||||
### PRD Completeness Assessment
|
||||
|
||||
[Initial assessment of PRD completeness and clarity]
|
||||
```
|
||||
|
||||
### 7. Auto-Proceed to Next Step
|
||||
|
||||
After PRD analysis complete, immediately load next step for epic coverage validation.
|
||||
|
||||
## PROCEEDING TO EPIC COVERAGE VALIDATION
|
||||
|
||||
PRD analysis complete. Loading next step to validate epic coverage.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- PRD loaded and read completely
|
||||
- All FRs extracted with full text
|
||||
- All NFRs identified and documented
|
||||
- Findings added to assessment report
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not reading complete PRD (especially sharded versions)
|
||||
- Missing requirements in extraction
|
||||
- Summarizing instead of extracting full text
|
||||
- Not documenting findings in report
|
||||
|
||||
**Master Rule:** Complete requirement extraction is essential for traceability validation.
|
||||
@@ -0,0 +1,179 @@
|
||||
---
|
||||
name: 'step-03-epic-coverage-validation'
|
||||
description: 'Validate that all PRD FRs are covered in epics and stories'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-ux-alignment.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||
---
|
||||
|
||||
# Step 3: Epic Coverage Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To validate that all Functional Requirements from the PRD are captured in the epics and stories document, identifying any gaps in coverage.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are an expert Product Manager and Scrum Master
|
||||
- ✅ Your expertise is in requirements traceability
|
||||
- ✅ You ensure no requirements fall through the cracks
|
||||
- ✅ Success is measured in complete FR coverage
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus ONLY on FR coverage validation
|
||||
- 🚫 Don't analyze story quality (that's later)
|
||||
- 💬 Compare PRD FRs against epic coverage list
|
||||
- 🚪 Document every missing FR
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load epics document completely
|
||||
- 💾 Extract FR coverage from epics
|
||||
- 📖 Compare against PRD FR list
|
||||
- 🚫 FORBIDDEN to proceed without documenting gaps
|
||||
|
||||
## EPIC COVERAGE VALIDATION PROCESS:
|
||||
|
||||
### 1. Initialize Coverage Validation
|
||||
|
||||
"Beginning **Epic Coverage Validation**.
|
||||
|
||||
I will:
|
||||
|
||||
1. Load the epics and stories document
|
||||
2. Extract FR coverage information
|
||||
3. Compare against PRD FRs from previous step
|
||||
4. Identify any FRs not covered in epics"
|
||||
|
||||
### 2. Load Epics Document
|
||||
|
||||
From the document inventory in step 1:
|
||||
|
||||
- Load the epics and stories document (whole or sharded)
|
||||
- Read it completely to find FR coverage information
|
||||
- Look for sections like "FR Coverage Map" or similar
|
||||
|
||||
### 3. Extract Epic FR Coverage
|
||||
|
||||
From the epics document:
|
||||
|
||||
- Find FR coverage mapping or list
|
||||
- Extract which FR numbers are claimed to be covered
|
||||
- Document which epics cover which FRs
|
||||
|
||||
Format as:
|
||||
|
||||
```
|
||||
## Epic FR Coverage Extracted
|
||||
|
||||
FR1: Covered in Epic X
|
||||
FR2: Covered in Epic Y
|
||||
FR3: Covered in Epic Z
|
||||
...
|
||||
Total FRs in epics: [count]
|
||||
```
|
||||
|
||||
### 4. Compare Coverage Against PRD
|
||||
|
||||
Using the PRD FR list from step 2:
|
||||
|
||||
- Check each PRD FR against epic coverage
|
||||
- Identify FRs NOT covered in epics
|
||||
- Note any FRs in epics but NOT in PRD
|
||||
|
||||
Create coverage matrix:
|
||||
|
||||
```
|
||||
## FR Coverage Analysis
|
||||
|
||||
| FR Number | PRD Requirement | Epic Coverage | Status |
|
||||
| --------- | --------------- | -------------- | --------- |
|
||||
| FR1 | [PRD text] | Epic X Story Y | ✓ Covered |
|
||||
| FR2 | [PRD text] | **NOT FOUND** | ❌ MISSING |
|
||||
| FR3 | [PRD text] | Epic Z Story A | ✓ Covered |
|
||||
```
|
||||
|
||||
### 5. Document Missing Coverage
|
||||
|
||||
List all FRs not covered:
|
||||
|
||||
```
|
||||
## Missing FR Coverage
|
||||
|
||||
### Critical Missing FRs
|
||||
|
||||
FR#: [Full requirement text from PRD]
|
||||
- Impact: [Why this is critical]
|
||||
- Recommendation: [Which epic should include this]
|
||||
|
||||
### High Priority Missing FRs
|
||||
|
||||
[List any other uncovered FRs]
|
||||
```
|
||||
|
||||
### 6. Add to Assessment Report
|
||||
|
||||
Append to {outputFile}:
|
||||
|
||||
```markdown
|
||||
## Epic Coverage Validation
|
||||
|
||||
### Coverage Matrix
|
||||
|
||||
[Complete coverage matrix from section 4]
|
||||
|
||||
### Missing Requirements
|
||||
|
||||
[List of uncovered FRs from section 5]
|
||||
|
||||
### Coverage Statistics
|
||||
|
||||
- Total PRD FRs: [count]
|
||||
- FRs covered in epics: [count]
|
||||
- Coverage percentage: [percentage]
|
||||
```
|
||||
|
||||
### 7. Auto-Proceed to Next Step
|
||||
|
||||
After coverage validation complete, immediately load next step.
|
||||
|
||||
## PROCEEDING TO UX ALIGNMENT
|
||||
|
||||
Epic coverage validation complete. Loading next step for UX alignment.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Epics document loaded completely
|
||||
- FR coverage extracted accurately
|
||||
- All gaps identified and documented
|
||||
- Coverage matrix created
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not reading complete epics document
|
||||
- Missing FRs in comparison
|
||||
- Not documenting uncovered requirements
|
||||
- Incomplete coverage analysis
|
||||
|
||||
**Master Rule:** Every FR must have a traceable implementation path.
|
||||
@@ -0,0 +1,139 @@
|
||||
---
|
||||
name: 'step-04-ux-alignment'
|
||||
description: 'Check for UX document and validate alignment with PRD and Architecture'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-ux-alignment.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||
---
|
||||
|
||||
# Step 4: UX Alignment
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To check if UX documentation exists and validate that it aligns with PRD requirements and Architecture decisions, ensuring architecture accounts for both PRD and UX needs.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a UX VALIDATOR ensuring user experience is properly addressed
|
||||
- ✅ UX requirements must be supported by architecture
|
||||
- ✅ Missing UX documentation is a warning if UI is implied
|
||||
- ✅ Alignment gaps must be documented
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Check for UX document existence first
|
||||
- 🚫 Don't assume UX is not needed
|
||||
- 💬 Validate alignment between UX, PRD, and Architecture
|
||||
- 🚪 Add findings to the output report
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Search for UX documentation
|
||||
- 💾 If found, validate alignment
|
||||
- 📖 If not found, assess if UX is implied
|
||||
- 🚫 FORBIDDEN to proceed without completing assessment
|
||||
|
||||
## UX ALIGNMENT PROCESS:
|
||||
|
||||
### 1. Initialize UX Validation
|
||||
|
||||
"Beginning **UX Alignment** validation.
|
||||
|
||||
I will:
|
||||
|
||||
1. Check if UX documentation exists
|
||||
2. If UX exists: validate alignment with PRD and Architecture
|
||||
3. If no UX: determine if UX is implied and document warning"
|
||||
|
||||
### 2. Search for UX Documentation
|
||||
|
||||
Search patterns:
|
||||
|
||||
- `{planning_artifacts}/*ux*.md` (whole document)
|
||||
- `{planning_artifacts}/*ux*/index.md` (sharded)
|
||||
- Look for UI-related terms in other documents
|
||||
|
||||
### 3. If UX Document Exists
|
||||
|
||||
#### A. UX ↔ PRD Alignment
|
||||
|
||||
- Check UX requirements reflected in PRD
|
||||
- Verify user journeys in UX match PRD use cases
|
||||
- Identify UX requirements not in PRD
|
||||
|
||||
#### B. UX ↔ Architecture Alignment
|
||||
|
||||
- Verify architecture supports UX requirements
|
||||
- Check performance needs (responsiveness, load times)
|
||||
- Identify UI components not supported by architecture
|
||||
|
||||
### 4. If No UX Document
|
||||
|
||||
Assess if UX/UI is implied:
|
||||
|
||||
- Does PRD mention user interface?
|
||||
- Are there web/mobile components implied?
|
||||
- Is this a user-facing application?
|
||||
|
||||
If UX implied but missing: Add warning to report
|
||||
|
||||
### 5. Add Findings to Report
|
||||
|
||||
Append to {outputFile}:
|
||||
|
||||
```markdown
|
||||
## UX Alignment Assessment
|
||||
|
||||
### UX Document Status
|
||||
|
||||
[Found/Not Found]
|
||||
|
||||
### Alignment Issues
|
||||
|
||||
[List any misalignments between UX, PRD, and Architecture]
|
||||
|
||||
### Warnings
|
||||
|
||||
[Any warnings about missing UX or architectural gaps]
|
||||
```
|
||||
|
||||
### 6. Auto-Proceed to Next Step
|
||||
|
||||
After UX assessment complete, immediately load next step.
|
||||
|
||||
## PROCEEDING TO EPIC QUALITY REVIEW
|
||||
|
||||
UX alignment assessment complete. Loading next step for epic quality review.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- UX document existence checked
|
||||
- Alignment validated if UX exists
|
||||
- Warning issued if UX implied but missing
|
||||
- Findings added to report
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not checking for UX document
|
||||
- Ignoring alignment issues
|
||||
- Not documenting warnings
|
||||
@@ -0,0 +1,252 @@
|
||||
---
|
||||
name: 'step-05-epic-quality-review'
|
||||
description: 'Validate epics and stories against create-epics-and-stories best practices'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-06-final-assessment.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||
epicsBestPractices: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories'
|
||||
---
|
||||
|
||||
# Step 5: Epic Quality Review
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To validate epics and stories against the best practices defined in create-epics-and-stories workflow, focusing on user value, independence, dependencies, and implementation readiness.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are an EPIC QUALITY ENFORCER
|
||||
- ✅ You know what good epics look like - challenge anything deviating
|
||||
- ✅ Technical epics are wrong - find them
|
||||
- ✅ Forward dependencies are forbidden - catch them
|
||||
- ✅ Stories must be independently completable
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Apply create-epics-and-stories standards rigorously
|
||||
- 🚫 Don't accept "technical milestones" as epics
|
||||
- 💬 Challenge every dependency on future work
|
||||
- 🚪 Verify proper story sizing and structure
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Systematically validate each epic and story
|
||||
- 💾 Document all violations of best practices
|
||||
- 📖 Check every dependency relationship
|
||||
- 🚫 FORBIDDEN to accept structural problems
|
||||
|
||||
## EPIC QUALITY REVIEW PROCESS:
|
||||
|
||||
### 1. Initialize Best Practices Validation
|
||||
|
||||
"Beginning **Epic Quality Review** against create-epics-and-stories standards.
|
||||
|
||||
I will rigorously validate:
|
||||
|
||||
- Epics deliver user value (not technical milestones)
|
||||
- Epic independence (Epic 2 doesn't need Epic 3)
|
||||
- Story dependencies (no forward references)
|
||||
- Proper story sizing and completeness
|
||||
|
||||
Any deviation from best practices will be flagged as a defect."
|
||||
|
||||
### 2. Epic Structure Validation
|
||||
|
||||
#### A. User Value Focus Check
|
||||
|
||||
For each epic:
|
||||
|
||||
- **Epic Title:** Is it user-centric (what user can do)?
|
||||
- **Epic Goal:** Does it describe user outcome?
|
||||
- **Value Proposition:** Can users benefit from this epic alone?
|
||||
|
||||
**Red flags (violations):**
|
||||
|
||||
- "Setup Database" or "Create Models" - no user value
|
||||
- "API Development" - technical milestone
|
||||
- "Infrastructure Setup" - not user-facing
|
||||
- "Authentication System" - borderline (is it user value?)
|
||||
|
||||
#### B. Epic Independence Validation
|
||||
|
||||
Test epic independence:
|
||||
|
||||
- **Epic 1:** Must stand alone completely
|
||||
- **Epic 2:** Can function using only Epic 1 output
|
||||
- **Epic 3:** Can function using Epic 1 & 2 outputs
|
||||
- **Rule:** Epic N cannot require Epic N+1 to work
|
||||
|
||||
**Document failures:**
|
||||
|
||||
- "Epic 2 requires Epic 3 features to function"
|
||||
- Stories in Epic 2 referencing Epic 3 components
|
||||
- Circular dependencies between epics
|
||||
|
||||
### 3. Story Quality Assessment
|
||||
|
||||
#### A. Story Sizing Validation
|
||||
|
||||
Check each story:
|
||||
|
||||
- **Clear User Value:** Does the story deliver something meaningful?
|
||||
- **Independent:** Can it be completed without future stories?
|
||||
|
||||
**Common violations:**
|
||||
|
||||
- "Setup all models" - not a USER story
|
||||
- "Create login UI (depends on Story 1.3)" - forward dependency
|
||||
|
||||
#### B. Acceptance Criteria Review
|
||||
|
||||
For each story's ACs:
|
||||
|
||||
- **Given/When/Then Format:** Proper BDD structure?
|
||||
- **Testable:** Each AC can be verified independently?
|
||||
- **Complete:** Covers all scenarios including errors?
|
||||
- **Specific:** Clear expected outcomes?
|
||||
|
||||
**Issues to find:**
|
||||
|
||||
- Vague criteria like "user can login"
|
||||
- Missing error conditions
|
||||
- Incomplete happy path
|
||||
- Non-measurable outcomes
|
||||
|
||||
### 4. Dependency Analysis
|
||||
|
||||
#### A. Within-Epic Dependencies
|
||||
|
||||
Map story dependencies within each epic:
|
||||
|
||||
- Story 1.1 must be completable alone
|
||||
- Story 1.2 can use Story 1.1 output
|
||||
- Story 1.3 can use Story 1.1 & 1.2 outputs
|
||||
|
||||
**Critical violations:**
|
||||
|
||||
- "This story depends on Story 1.4"
|
||||
- "Wait for future story to work"
|
||||
- Stories referencing features not yet implemented
|
||||
|
||||
#### B. Database/Entity Creation Timing
|
||||
|
||||
Validate database creation approach:
|
||||
|
||||
- **Wrong:** Epic 1 Story 1 creates all tables upfront
|
||||
- **Right:** Each story creates tables it needs
|
||||
- **Check:** Are tables created only when first needed?
|
||||
|
||||
### 5. Special Implementation Checks
|
||||
|
||||
#### A. Starter Template Requirement
|
||||
|
||||
Check if Architecture specifies starter template:
|
||||
|
||||
- If YES: Epic 1 Story 1 must be "Set up initial project from starter template"
|
||||
- Verify story includes cloning, dependencies, initial configuration
|
||||
|
||||
#### B. Greenfield vs Brownfield Indicators
|
||||
|
||||
Greenfield projects should have:
|
||||
|
||||
- Initial project setup story
|
||||
- Development environment configuration
|
||||
- CI/CD pipeline setup early
|
||||
|
||||
Brownfield projects should have:
|
||||
|
||||
- Integration points with existing systems
|
||||
- Migration or compatibility stories
|
||||
|
||||
### 6. Best Practices Compliance Checklist
|
||||
|
||||
For each epic, verify:
|
||||
|
||||
- [ ] Epic delivers user value
|
||||
- [ ] Epic can function independently
|
||||
- [ ] Stories appropriately sized
|
||||
- [ ] No forward dependencies
|
||||
- [ ] Database tables created when needed
|
||||
- [ ] Clear acceptance criteria
|
||||
- [ ] Traceability to FRs maintained
|
||||
|
||||
### 7. Quality Assessment Documentation
|
||||
|
||||
Document all findings by severity:
|
||||
|
||||
#### 🔴 Critical Violations
|
||||
|
||||
- Technical epics with no user value
|
||||
- Forward dependencies breaking independence
|
||||
- Epic-sized stories that cannot be completed
|
||||
|
||||
#### 🟠 Major Issues
|
||||
|
||||
- Vague acceptance criteria
|
||||
- Stories requiring future stories
|
||||
- Database creation violations
|
||||
|
||||
#### 🟡 Minor Concerns
|
||||
|
||||
- Formatting inconsistencies
|
||||
- Minor structure deviations
|
||||
- Documentation gaps
|
||||
|
||||
### 8. Autonomous Review Execution
|
||||
|
||||
This review runs autonomously to maintain standards:
|
||||
|
||||
- Apply best practices without compromise
|
||||
- Document every violation with specific examples
|
||||
- Provide clear remediation guidance
|
||||
- Prepare recommendations for each issue
|
||||
|
||||
## REVIEW COMPLETION:
|
||||
|
||||
After completing epic quality review:
|
||||
|
||||
- Update {outputFile} with all quality findings
|
||||
- Document specific best practices violations
|
||||
- Provide actionable recommendations
|
||||
- Load {nextStepFile} for final readiness assessment
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
This step executes autonomously. Load {nextStepFile} only after complete epic quality review is documented.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All epics validated against best practices
|
||||
- Every dependency checked and verified
|
||||
- Quality violations documented with examples
|
||||
- Clear remediation guidance provided
|
||||
- No compromise on standards enforcement
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Accepting technical epics as valid
|
||||
- Ignoring forward dependencies
|
||||
- Not verifying story sizing
|
||||
- Overlooking obvious violations
|
||||
|
||||
**Master Rule:** Enforce best practices rigorously. Find all violations.
|
||||
@@ -0,0 +1,133 @@
|
||||
---
|
||||
name: 'step-06-final-assessment'
|
||||
description: 'Compile final assessment and polish the readiness report'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-06-final-assessment.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||
---
|
||||
|
||||
# Step 6: Final Assessment
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To provide a comprehensive summary of all findings and give the report a final polish, ensuring clear recommendations and overall readiness status.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📖 You are at the final step - complete the assessment
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are delivering the FINAL ASSESSMENT
|
||||
- ✅ Your findings are objective and backed by evidence
|
||||
- ✅ Provide clear, actionable recommendations
|
||||
- ✅ Success is measured by value of findings
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Compile and summarize all findings
|
||||
- 🚫 Don't soften the message - be direct
|
||||
- 💬 Provide specific examples for problems
|
||||
- 🚪 Add final section to the report
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Review all findings from previous steps
|
||||
- 💾 Add summary and recommendations
|
||||
- 📖 Determine overall readiness status
|
||||
- 🚫 Complete and present final report
|
||||
|
||||
## FINAL ASSESSMENT PROCESS:
|
||||
|
||||
### 1. Initialize Final Assessment
|
||||
|
||||
"Completing **Final Assessment**.
|
||||
|
||||
I will now:
|
||||
|
||||
1. Review all findings from previous steps
|
||||
2. Provide a comprehensive summary
|
||||
3. Add specific recommendations
|
||||
4. Determine overall readiness status"
|
||||
|
||||
### 2. Review Previous Findings
|
||||
|
||||
Check the {outputFile} for sections added by previous steps:
|
||||
|
||||
- File and FR Validation findings
|
||||
- UX Alignment issues
|
||||
- Epic Quality violations
|
||||
|
||||
### 3. Add Final Assessment Section
|
||||
|
||||
Append to {outputFile}:
|
||||
|
||||
```markdown
|
||||
## Summary and Recommendations
|
||||
|
||||
### Overall Readiness Status
|
||||
|
||||
[READY/NEEDS WORK/NOT READY]
|
||||
|
||||
### Critical Issues Requiring Immediate Action
|
||||
|
||||
[List most critical issues that must be addressed]
|
||||
|
||||
### Recommended Next Steps
|
||||
|
||||
1. [Specific action item 1]
|
||||
2. [Specific action item 2]
|
||||
3. [Specific action item 3]
|
||||
|
||||
### Final Note
|
||||
|
||||
This assessment identified [X] issues across [Y] categories. Address the critical issues before proceeding to implementation. These findings can be used to improve the artifacts or you may choose to proceed as-is.
|
||||
```
|
||||
|
||||
### 4. Complete the Report
|
||||
|
||||
- Ensure all findings are clearly documented
|
||||
- Verify recommendations are actionable
|
||||
- Add date and assessor information
|
||||
- Save the final report
|
||||
|
||||
### 5. Present Completion
|
||||
|
||||
Display:
|
||||
"**Implementation Readiness Assessment Complete**
|
||||
|
||||
Report generated: {outputFile}
|
||||
|
||||
The assessment found [number] issues requiring attention. Review the detailed report for specific findings and recommendations."
|
||||
|
||||
## WORKFLOW COMPLETE
|
||||
|
||||
The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All findings compiled and summarized
|
||||
- Clear recommendations provided
|
||||
- Readiness status determined
|
||||
- Final report saved
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not reviewing previous findings
|
||||
- Incomplete summary
|
||||
- No clear recommendations
|
||||
@@ -0,0 +1,4 @@
|
||||
# Implementation Readiness Assessment Report
|
||||
|
||||
**Date:** {{date}}
|
||||
**Project:** {{project_name}}
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
name: check-implementation-readiness
|
||||
description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.'
|
||||
web_bundle: false
|
||||
---
|
||||
|
||||
# Implementation Readiness
|
||||
|
||||
**Goal:** Validate that PRD, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning.
|
||||
|
||||
**Your Role:** You are an expert Product Manager and Scrum Master, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the users product vision.
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
### Core Principles
|
||||
|
||||
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
|
||||
- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
|
||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||
|
||||
### Step Processing Rules
|
||||
|
||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
|
||||
|
||||
### Critical Rules (NO EXCEPTIONS)
|
||||
|
||||
- 🛑 **NEVER** load multiple step files simultaneously
|
||||
- 📖 **ALWAYS** read entire step file before execution
|
||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||
- 📋 **NEVER** create mental todo lists from future steps
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION SEQUENCE
|
||||
|
||||
### 1. Module Configuration Loading
|
||||
|
||||
Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`, `communication_language`, `document_output_language`
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
Load, read the full file and then execute `{workflow_path}/steps/step-01-document-discovery.md` to begin the workflow.
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
workflowType: 'architecture'
|
||||
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._
|
||||
@@ -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"
|
||||
|
@@ -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
|
||||
|
@@ -0,0 +1,153 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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 existing {planning_artifacts}/`*architecture*.md`
|
||||
- If exists, read the complete file(s) 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. Documents can be in the following locations:
|
||||
- {planning_artifacts}/**
|
||||
- {output_folder}/**
|
||||
- {product_knowledge}/**
|
||||
- docs/**
|
||||
|
||||
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
||||
|
||||
Try to discover the following:
|
||||
- Product Brief (`*brief*.md`)
|
||||
- Product Requirements Document (`*prd*.md`)
|
||||
- UX Design (`*ux-design*.md`) and other
|
||||
- Research Documents (`*research*.md`)
|
||||
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
||||
- Project Context (`**/project-context.md`)
|
||||
|
||||
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
||||
|
||||
**Loading Rules:**
|
||||
|
||||
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
||||
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
||||
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
||||
- index.md is a guide to what's relevant whenever available
|
||||
- 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 Input that might exist:**
|
||||
|
||||
- UX Spec: "Provides UI/UX architectural requirements"
|
||||
|
||||
#### C. Create Initial Document
|
||||
|
||||
Copy the template from `{installed_path}/architecture-decision-template.md` to `{planning_artifacts}/architecture.md`
|
||||
|
||||
#### D. Complete Initialization and Report
|
||||
|
||||
Complete setup and report to user:
|
||||
|
||||
**Document Setup:**
|
||||
|
||||
- Created: `{planning_artifacts}/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"}
|
||||
- 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, only after ensuring all the template output has been created, then 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!
|
||||
@@ -0,0 +1,164 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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.
|
||||
@@ -0,0 +1,224 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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/core/workflows/advanced-elicitation/workflow.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/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 `{planning_artifacts}/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!
|
||||
@@ -0,0 +1,331 @@
|
||||
# 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 search the web to verify current versions - 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🌐 Search the web 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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
|
||||
|
||||
Search the web to find current, maintained starter templates:
|
||||
|
||||
```
|
||||
Search the web: "{{primary_technology}} starter template CLI create command latest"
|
||||
Search the web: "{{primary_technology}} boilerplate generator latest options"
|
||||
Search the web: "{{primary_technology}} production-ready starter best practices"
|
||||
```
|
||||
|
||||
### 4. Investigate Top Starter Options
|
||||
|
||||
For each promising starter found, investigate details:
|
||||
|
||||
```
|
||||
Search the web: "{{starter_name}} default setup technologies included latest"
|
||||
Search the web: "{{starter_name}} project structure file organization"
|
||||
Search the web: "{{starter_name}} production deployment capabilities"
|
||||
Search the web: "{{starter_name}} recent updates maintenance status"
|
||||
```
|
||||
|
||||
### 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:
|
||||
|
||||
```
|
||||
Search the web: "{{starter_name}} CLI command options flags latest"
|
||||
Search the web: "{{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/core/workflows/advanced-elicitation/workflow.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/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 `{planning_artifacts}/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 web search, 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 web search
|
||||
❌ 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!
|
||||
```
|
||||
@@ -0,0 +1,318 @@
|
||||
# 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 search the web to verify current technology versions
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🌐 Search the web 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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:
|
||||
|
||||
```
|
||||
Search the web: "{{technology}} latest stable version"
|
||||
Search the web: "{{technology}} current LTS version"
|
||||
Search the web: "{{technology}} production readiness"
|
||||
```
|
||||
|
||||
**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/core/workflows/advanced-elicitation/workflow.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/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 `{planning_artifacts}/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 web search
|
||||
✅ 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 web search
|
||||
❌ 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!
|
||||
@@ -0,0 +1,359 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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/core/workflows/advanced-elicitation/workflow.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/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 `{planning_artifacts}/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!
|
||||
@@ -0,0 +1,379 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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/core/workflows/advanced-elicitation/workflow.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/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 `{planning_artifacts}/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!
|
||||
@@ -0,0 +1,359 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## 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/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- 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/core/workflows/advanced-elicitation/workflow.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/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 `{planning_artifacts}/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!
|
||||
@@ -0,0 +1,352 @@
|
||||
# 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
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🎯 Present 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 `{planning_artifacts}/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:** {planning_artifacts}/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 `{planning_artifacts}/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 `{planning_artifacts}/bmm-workflow-status.yaml`
|
||||
- Update workflow_status["create-architecture"] = "{planning_artifacts}/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:**
|
||||
`{planning_artifacts}/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/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.
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
name: create-architecture
|
||||
description: Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.
|
||||
web_bundle: true
|
||||
---
|
||||
|
||||
# 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/bmm/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as system-generated current datetime
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/_bmad/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.
|
||||
@@ -0,0 +1,259 @@
|
||||
---
|
||||
name: 'step-01-validate-prerequisites'
|
||||
description: 'Validate required documents exist and extract all requirements for epic and story creation'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01-validate-prerequisites.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-02-design-epics.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/epics.md'
|
||||
epicsTemplate: '{workflow_path}/templates/epics-template.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
|
||||
# Template References
|
||||
epicsTemplate: '{workflow_path}/templates/epics-template.md'
|
||||
---
|
||||
|
||||
# Step 1: Validate Prerequisites and Extract Requirements
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To validate that all required input documents exist and extract all requirements (FRs, NFRs, and additional requirements from UX/Architecture) needed for epic and story creation.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product strategist and technical specifications writer
|
||||
- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring requirements extraction expertise
|
||||
- ✅ User brings their product vision and context
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus ONLY on extracting and organizing requirements
|
||||
- 🚫 FORBIDDEN to start creating epics or stories in this step
|
||||
- 💬 Extract requirements from ALL available documents
|
||||
- 🚪 POPULATE the template sections exactly as needed
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Extract requirements systematically from all documents
|
||||
- 💾 Populate {outputFile} with extracted requirements
|
||||
- 📖 Update frontmatter with extraction progress
|
||||
- 🚫 FORBIDDEN to load next step until user selects 'C' and requirements are extracted
|
||||
|
||||
## REQUIREMENTS EXTRACTION PROCESS:
|
||||
|
||||
### 1. Welcome and Overview
|
||||
|
||||
Welcome {user_name} to comprehensive epic and story creation!
|
||||
|
||||
**CRITICAL PREREQUISITE VALIDATION:**
|
||||
|
||||
Verify required documents exist and are complete:
|
||||
|
||||
1. **PRD.md** - Contains requirements (FRs and NFRs) and product scope
|
||||
2. **Architecture.md** - Contains technical decisions, API contracts, data models
|
||||
3. **UX Design.md** (if UI exists) - Contains interaction patterns, mockups, user flows
|
||||
|
||||
### 2. Document Discovery and Validation
|
||||
|
||||
Search for required documents using these patterns (sharded means a large document was split into multiple small files with an index.md into a folder) - if the whole document is found, use that instead of the sharded version:
|
||||
|
||||
**PRD Document Search Priority:**
|
||||
|
||||
1. `{planning_artifacts}/*prd*.md` (whole document)
|
||||
2. `{planning_artifacts}/*prd*/index.md` (sharded version)
|
||||
|
||||
**Architecture Document Search Priority:**
|
||||
|
||||
1. `{planning_artifacts}/*architecture*.md` (whole document)
|
||||
2. `{planning_artifacts}/*architecture*/index.md` (sharded version)
|
||||
|
||||
**UX Design Document Search (Optional):**
|
||||
|
||||
1. `{planning_artifacts}/*ux*.md` (whole document)
|
||||
2. `{planning_artifacts}/*ux*/index.md` (sharded version)
|
||||
|
||||
Before proceeding, Ask the user if there are any other documents to include for analysis, and if anything found should be excluded. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
|
||||
|
||||
### 3. Extract Functional Requirements (FRs)
|
||||
|
||||
From the PRD document (full or sharded), read then entire document and extract ALL functional requirements:
|
||||
|
||||
**Extraction Method:**
|
||||
|
||||
- Look for numbered items like "FR1:", "Functional Requirement 1:", or similar
|
||||
- Identify requirement statements that describe what the system must DO
|
||||
- Include user actions, system behaviors, and business rules
|
||||
|
||||
**Format the FR list as:**
|
||||
|
||||
```
|
||||
FR1: [Clear, testable requirement description]
|
||||
FR2: [Clear, testable requirement description]
|
||||
...
|
||||
```
|
||||
|
||||
### 4. Extract Non-Functional Requirements (NFRs)
|
||||
|
||||
From the PRD document, extract ALL non-functional requirements:
|
||||
|
||||
**Extraction Method:**
|
||||
|
||||
- Look for performance, security, usability, reliability requirements
|
||||
- Identify constraints and quality attributes
|
||||
- Include technical standards and compliance requirements
|
||||
|
||||
**Format the NFR list as:**
|
||||
|
||||
```
|
||||
NFR1: [Performance/Security/Usability requirement]
|
||||
NFR2: [Performance/Security/Usability requirement]
|
||||
...
|
||||
```
|
||||
|
||||
### 5. Extract Additional Requirements from Architecture
|
||||
|
||||
Review the Architecture document for technical requirements that impact epic and story creation:
|
||||
|
||||
**Look for:**
|
||||
|
||||
- **Starter Template**: Does Architecture specify a starter/greenfield template? If YES, document this for Epic 1 Story 1
|
||||
- Infrastructure and deployment requirements
|
||||
- Integration requirements with external systems
|
||||
- Data migration or setup requirements
|
||||
- Monitoring and logging requirements
|
||||
- API versioning or compatibility requirements
|
||||
- Security implementation requirements
|
||||
|
||||
**IMPORTANT**: If a starter template is mentioned in Architecture, note it prominently. This will impact Epic 1 Story 1.
|
||||
|
||||
**Format Additional Requirements as:**
|
||||
|
||||
```
|
||||
- [Technical requirement from Architecture that affects implementation]
|
||||
- [Infrastructure setup requirement]
|
||||
- [Integration requirement]
|
||||
...
|
||||
```
|
||||
|
||||
### 6. Extract Additional Requirements from UX (if exists)
|
||||
|
||||
Review the UX document for requirements that affect epic and story creation:
|
||||
|
||||
**Look for:**
|
||||
|
||||
- Responsive design requirements
|
||||
- Accessibility requirements
|
||||
- Browser/device compatibility
|
||||
- User interaction patterns that need implementation
|
||||
- Animation or transition requirements
|
||||
- Error handling UX requirements
|
||||
|
||||
**Add these to Additional Requirements list.**
|
||||
|
||||
### 7. Load and Initialize Template
|
||||
|
||||
Load {epicsTemplate} and initialize {outputFile}:
|
||||
|
||||
1. Copy the entire template to {outputFile}
|
||||
2. Replace {{project_name}} with the actual project name
|
||||
3. Replace placeholder sections with extracted requirements:
|
||||
- {{fr_list}} → extracted FRs
|
||||
- {{nfr_list}} → extracted NFRs
|
||||
- {{additional_requirements}} → extracted additional requirements
|
||||
4. Leave {{requirements_coverage_map}} and {{epics_list}} as placeholders for now
|
||||
|
||||
### 8. Present Extracted Requirements
|
||||
|
||||
Display to user:
|
||||
|
||||
**Functional Requirements Extracted:**
|
||||
|
||||
- Show count of FRs found
|
||||
- Display the first few FRs as examples
|
||||
- Ask if any FRs are missing or incorrectly captured
|
||||
|
||||
**Non-Functional Requirements Extracted:**
|
||||
|
||||
- Show count of NFRs found
|
||||
- Display key NFRs
|
||||
- Ask if any constraints were missed
|
||||
|
||||
**Additional Requirements:**
|
||||
|
||||
- Summarize technical requirements from Architecture
|
||||
- Summarize UX requirements (if applicable)
|
||||
- Verify completeness
|
||||
|
||||
### 9. Get User Confirmation
|
||||
|
||||
Ask: "Do these extracted requirements accurately represent what needs to be built? Any additions or corrections?"
|
||||
|
||||
Update the requirements based on user feedback until confirmation is received.
|
||||
|
||||
## CONTENT TO SAVE TO DOCUMENT:
|
||||
|
||||
After extraction and confirmation, update {outputFile} with:
|
||||
|
||||
- Complete FR list in {{fr_list}} section
|
||||
- Complete NFR list in {{nfr_list}} section
|
||||
- All additional requirements in {{additional_requirements}} section
|
||||
|
||||
### 10. Present MENU OPTIONS
|
||||
|
||||
Display: `**Confirm the Requirements are complete and correct to [C] continue:**`
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu option
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save all to {outputFile}, update frontmatter, only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options)
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and all requirements are saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin epic design step.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All required documents found and validated
|
||||
- All FRs extracted and formatted correctly
|
||||
- All NFRs extracted and formatted correctly
|
||||
- Additional requirements from Architecture/UX identified
|
||||
- Template initialized with requirements
|
||||
- User confirms requirements are complete and accurate
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Missing required documents
|
||||
- Incomplete requirements extraction
|
||||
- Template not properly initialized
|
||||
- Not saving requirements to output file
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,233 @@
|
||||
---
|
||||
name: 'step-02-design-epics'
|
||||
description: 'Design and approve the epics_list that will organize all requirements into user-value-focused epics'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-02-design-epics.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-03-create-stories.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/epics.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
|
||||
# Template References
|
||||
epicsTemplate: '{workflow_path}/templates/epics-template.md'
|
||||
---
|
||||
|
||||
# Step 2: Design Epic List
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To design and get approval for the epics_list that will organize all requirements into user-value-focused epics.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product strategist and technical specifications writer
|
||||
- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring product strategy and epic design expertise
|
||||
- ✅ User brings their product vision and priorities
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus ONLY on creating the epics_list
|
||||
- 🚫 FORBIDDEN to create individual stories in this step
|
||||
- 💬 Organize epics around user value, not technical layers
|
||||
- 🚪 GET explicit approval for the epics_list
|
||||
- 🔗 **CRITICAL: Each epic must be standalone and enable future epics without requiring future epics to function**
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Design epics collaboratively based on extracted requirements
|
||||
- 💾 Update {{epics_list}} in {outputFile}
|
||||
- 📖 Document the FR coverage mapping
|
||||
- 🚫 FORBIDDEN to load next step until user approves epics_list
|
||||
|
||||
## EPIC DESIGN PROCESS:
|
||||
|
||||
### 1. Review Extracted Requirements
|
||||
|
||||
Load {outputFile} and review:
|
||||
|
||||
- **Functional Requirements:** Count and review FRs from Step 1
|
||||
- **Non-Functional Requirements:** Review NFRs that need to be addressed
|
||||
- **Additional Requirements:** Review technical and UX requirements
|
||||
|
||||
### 2. Explain Epic Design Principles
|
||||
|
||||
**EPIC DESIGN PRINCIPLES:**
|
||||
|
||||
1. **User-Value First**: Each epic must enable users to accomplish something meaningful
|
||||
2. **Requirements Grouping**: Group related FRs that deliver cohesive user outcomes
|
||||
3. **Incremental Delivery**: Each epic should deliver value independently
|
||||
4. **Logical Flow**: Natural progression from user's perspective
|
||||
5. **🔗 Dependency-Free Within Epic**: Stories within an epic must NOT depend on future stories
|
||||
|
||||
**⚠️ CRITICAL PRINCIPLE:**
|
||||
Organize by USER VALUE, not technical layers:
|
||||
|
||||
**✅ CORRECT Epic Examples (Standalone & Enable Future Epics):**
|
||||
|
||||
- Epic 1: User Authentication & Profiles (users can register, login, manage profiles) - **Standalone: Complete auth system**
|
||||
- Epic 2: Content Creation (users can create, edit, publish content) - **Standalone: Uses auth, creates content**
|
||||
- Epic 3: Social Interaction (users can follow, comment, like content) - **Standalone: Uses auth + content**
|
||||
- Epic 4: Search & Discovery (users can find content and other users) - **Standalone: Uses all previous**
|
||||
|
||||
**❌ WRONG Epic Examples (Technical Layers or Dependencies):**
|
||||
|
||||
- Epic 1: Database Setup (creates all tables upfront) - **No user value**
|
||||
- Epic 2: API Development (builds all endpoints) - **No user value**
|
||||
- Epic 3: Frontend Components (creates reusable components) - **No user value**
|
||||
- Epic 4: Deployment Pipeline (CI/CD setup) - **No user value**
|
||||
|
||||
**🔗 DEPENDENCY RULES:**
|
||||
|
||||
- Each epic must deliver COMPLETE functionality for its domain
|
||||
- Epic 2 must not require Epic 3 to function
|
||||
- Epic 3 can build upon Epic 1 & 2 but must stand alone
|
||||
|
||||
### 3. Design Epic Structure Collaboratively
|
||||
|
||||
**Step A: Identify User Value Themes**
|
||||
|
||||
- Look for natural groupings in the FRs
|
||||
- Identify user journeys or workflows
|
||||
- Consider user types and their goals
|
||||
|
||||
**Step B: Propose Epic Structure**
|
||||
For each proposed epic:
|
||||
|
||||
1. **Epic Title**: User-centric, value-focused
|
||||
2. **User Outcome**: What users can accomplish after this epic
|
||||
3. **FR Coverage**: Which FR numbers this epic addresses
|
||||
4. **Implementation Notes**: Any technical or UX considerations
|
||||
|
||||
**Step C: Create the epics_list**
|
||||
|
||||
Format the epics_list as:
|
||||
|
||||
```
|
||||
## Epic List
|
||||
|
||||
### Epic 1: [Epic Title]
|
||||
[Epic goal statement - what users can accomplish]
|
||||
**FRs covered:** FR1, FR2, FR3, etc.
|
||||
|
||||
### Epic 2: [Epic Title]
|
||||
[Epic goal statement - what users can accomplish]
|
||||
**FRs covered:** FR4, FR5, FR6, etc.
|
||||
|
||||
[Continue for all epics]
|
||||
```
|
||||
|
||||
### 4. Present Epic List for Review
|
||||
|
||||
Display the complete epics_list to user with:
|
||||
|
||||
- Total number of epics
|
||||
- FR coverage per epic
|
||||
- User value delivered by each epic
|
||||
- Any natural dependencies
|
||||
|
||||
### 5. Create Requirements Coverage Map
|
||||
|
||||
Create {{requirements_coverage_map}} showing how each FR maps to an epic:
|
||||
|
||||
```
|
||||
### FR Coverage Map
|
||||
|
||||
FR1: Epic 1 - [Brief description]
|
||||
FR2: Epic 1 - [Brief description]
|
||||
FR3: Epic 2 - [Brief description]
|
||||
...
|
||||
```
|
||||
|
||||
This ensures no FRs are missed.
|
||||
|
||||
### 6. Collaborative Refinement
|
||||
|
||||
Ask user:
|
||||
|
||||
- "Does this epic structure align with your product vision?"
|
||||
- "Are all user outcomes properly captured?"
|
||||
- "Should we adjust any epic groupings?"
|
||||
- "Are there natural dependencies we've missed?"
|
||||
|
||||
### 7. Get Final Approval
|
||||
|
||||
**CRITICAL:** Must get explicit user approval:
|
||||
"Do you approve this epic structure for proceeding to story creation?"
|
||||
|
||||
If user wants changes:
|
||||
|
||||
- Make the requested adjustments
|
||||
- Update the epics_list
|
||||
- Re-present for approval
|
||||
- Repeat until approval is received
|
||||
|
||||
## CONTENT TO UPDATE IN DOCUMENT:
|
||||
|
||||
After approval, update {outputFile}:
|
||||
|
||||
1. Replace {{epics_list}} placeholder with the approved epic list
|
||||
2. Replace {{requirements_coverage_map}} with the coverage map
|
||||
3. Ensure all FRs are mapped to epics
|
||||
|
||||
### 8. Present MENU OPTIONS
|
||||
|
||||
Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF A: Execute {advancedElicitationTask}
|
||||
- IF P: Execute {partyModeWorkflow}
|
||||
- IF C: Save approved epics_list to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options)
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- After other menu items execution completes, redisplay the menu
|
||||
- User can chat or ask questions - always respond when conversation ends, redisplay the menu options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and the approved epics_list is saved to document, will you then load, read entire file, then execute {nextStepFile} to execute and begin story creation step.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Epics designed around user value
|
||||
- All FRs mapped to specific epics
|
||||
- epics_list created and formatted correctly
|
||||
- Requirements coverage map completed
|
||||
- User gives explicit approval for epic structure
|
||||
- Document updated with approved epics
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Epics organized by technical layers
|
||||
- Missing FRs in coverage map
|
||||
- No user approval obtained
|
||||
- epics_list not saved to document
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,272 @@
|
||||
---
|
||||
name: 'step-03-create-stories'
|
||||
description: 'Generate all epics with their stories following the template structure'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-create-stories.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-final-validation.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/epics.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
|
||||
# Template References
|
||||
epicsTemplate: '{workflow_path}/templates/epics-template.md'
|
||||
---
|
||||
|
||||
# Step 3: Generate Epics and Stories
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To generate all epics with their stories based on the approved epics_list, following the template structure exactly.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: Process epics sequentially
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product strategist and technical specifications writer
|
||||
- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring story creation and acceptance criteria expertise
|
||||
- ✅ User brings their implementation priorities and constraints
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Generate stories for each epic following the template exactly
|
||||
- 🚫 FORBIDDEN to deviate from template structure
|
||||
- 💬 Each story must have clear acceptance criteria
|
||||
- 🚪 ENSURE each story is completable by a single dev agent
|
||||
- 🔗 **CRITICAL: Stories MUST NOT depend on future stories within the same epic**
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Generate stories collaboratively with user input
|
||||
- 💾 Append epics and stories to {outputFile} following template
|
||||
- 📖 Process epics one at a time in sequence
|
||||
- 🚫 FORBIDDEN to skip any epic or rush through stories
|
||||
|
||||
## STORY GENERATION PROCESS:
|
||||
|
||||
### 1. Load Approved Epic Structure
|
||||
|
||||
Load {outputFile} and review:
|
||||
|
||||
- Approved epics_list from Step 2
|
||||
- FR coverage map
|
||||
- All requirements (FRs, NFRs, additional)
|
||||
- Template structure at the end of the document
|
||||
|
||||
### 2. Explain Story Creation Approach
|
||||
|
||||
**STORY CREATION GUIDELINES:**
|
||||
|
||||
For each epic, create stories that:
|
||||
|
||||
- Follow the exact template structure
|
||||
- Are sized for single dev agent completion
|
||||
- Have clear user value
|
||||
- Include specific acceptance criteria
|
||||
- Reference requirements being fulfilled
|
||||
|
||||
**🚨 DATABASE/ENTITY CREATION PRINCIPLE:**
|
||||
Create tables/entities ONLY when needed by the story:
|
||||
|
||||
- ❌ WRONG: Epic 1 Story 1 creates all 50 database tables
|
||||
- ✅ RIGHT: Each story creates/alters ONLY the tables it needs
|
||||
|
||||
**🔗 STORY DEPENDENCY PRINCIPLE:**
|
||||
Stories must be independently completable in sequence:
|
||||
|
||||
- ❌ WRONG: Story 1.2 requires Story 1.3 to be completed first
|
||||
- ✅ RIGHT: Each story can be completed based only on previous stories
|
||||
- ❌ WRONG: "Wait for Story 1.4 to be implemented before this works"
|
||||
- ✅ RIGHT: "This story works independently and enables future stories"
|
||||
|
||||
**STORY FORMAT (from template):**
|
||||
|
||||
```
|
||||
### Story {N}.{M}: {story_title}
|
||||
|
||||
As a {user_type},
|
||||
I want {capability},
|
||||
So that {value_benefit}.
|
||||
|
||||
**Acceptance Criteria:**
|
||||
|
||||
**Given** {precondition}
|
||||
**When** {action}
|
||||
**Then** {expected_outcome}
|
||||
**And** {additional_criteria}
|
||||
```
|
||||
|
||||
**✅ GOOD STORY EXAMPLES:**
|
||||
|
||||
_Epic 1: User Authentication_
|
||||
|
||||
- Story 1.1: User Registration with Email
|
||||
- Story 1.2: User Login with Password
|
||||
- Story 1.3: Password Reset via Email
|
||||
|
||||
_Epic 2: Content Creation_
|
||||
|
||||
- Story 2.1: Create New Blog Post
|
||||
- Story 2.2: Edit Existing Blog Post
|
||||
- Story 2.3: Publish Blog Post
|
||||
|
||||
**❌ BAD STORY EXAMPLES:**
|
||||
|
||||
- Story: "Set up database" (no user value)
|
||||
- Story: "Create all models" (too large, no user value)
|
||||
- Story: "Build authentication system" (too large)
|
||||
- Story: "Login UI (depends on Story 1.3 API endpoint)" (future dependency!)
|
||||
- Story: "Edit post (requires Story 1.4 to be implemented first)" (wrong order!)
|
||||
|
||||
### 3. Process Epics Sequentially
|
||||
|
||||
For each epic in the approved epics_list:
|
||||
|
||||
#### A. Epic Overview
|
||||
|
||||
Display:
|
||||
|
||||
- Epic number and title
|
||||
- Epic goal statement
|
||||
- FRs covered by this epic
|
||||
- Any NFRs or additional requirements relevant
|
||||
|
||||
#### B. Story Breakdown
|
||||
|
||||
Work with user to break down the epic into stories:
|
||||
|
||||
- Identify distinct user capabilities
|
||||
- Ensure logical flow within the epic
|
||||
- Size stories appropriately
|
||||
|
||||
#### C. Generate Each Story
|
||||
|
||||
For each story in the epic:
|
||||
|
||||
1. **Story Title**: Clear, action-oriented
|
||||
2. **User Story**: Complete the As a/I want/So that format
|
||||
3. **Acceptance Criteria**: Write specific, testable criteria
|
||||
|
||||
**AC Writing Guidelines:**
|
||||
|
||||
- Use Given/When/Then format
|
||||
- Each AC should be independently testable
|
||||
- Include edge cases and error conditions
|
||||
- Reference specific requirements when applicable
|
||||
|
||||
#### D. Collaborative Review
|
||||
|
||||
After writing each story:
|
||||
|
||||
- Present the story to user
|
||||
- Ask: "Does this story capture the requirement correctly?"
|
||||
- "Is the scope appropriate for a single dev session?"
|
||||
- "Are the acceptance criteria complete and testable?"
|
||||
|
||||
#### E. Append to Document
|
||||
|
||||
When story is approved:
|
||||
|
||||
- Append it to {outputFile} following template structure
|
||||
- Use correct numbering (Epic N, Story M)
|
||||
- Maintain proper markdown formatting
|
||||
|
||||
### 4. Epic Completion
|
||||
|
||||
After all stories for an epic are complete:
|
||||
|
||||
- Display epic summary
|
||||
- Show count of stories created
|
||||
- Verify all FRs for the epic are covered
|
||||
- Get user confirmation to proceed to next epic
|
||||
|
||||
### 5. Repeat for All Epics
|
||||
|
||||
Continue the process for each epic in the approved list, processing them in order (Epic 1, Epic 2, etc.).
|
||||
|
||||
### 6. Final Document Completion
|
||||
|
||||
After all epics and stories are generated:
|
||||
|
||||
- Verify the document follows template structure exactly
|
||||
- Ensure all placeholders are replaced
|
||||
- Confirm all FRs are covered
|
||||
- Check formatting consistency
|
||||
|
||||
## TEMPLATE STRUCTURE COMPLIANCE:
|
||||
|
||||
The final {outputFile} must follow this structure exactly:
|
||||
|
||||
1. **Overview** section with project name
|
||||
2. **Requirements Inventory** with all three subsections populated
|
||||
3. **FR Coverage Map** showing requirement to epic mapping
|
||||
4. **Epic List** with approved epic structure
|
||||
5. **Epic sections** for each epic (N = 1, 2, 3...)
|
||||
- Epic title and goal
|
||||
- All stories for that epic (M = 1, 2, 3...)
|
||||
- Story title and user story
|
||||
- Acceptance Criteria using Given/When/Then format
|
||||
|
||||
### 7. Present FINAL MENU OPTIONS
|
||||
|
||||
After all epics and stories are complete:
|
||||
|
||||
Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF A: Execute {advancedElicitationTask}
|
||||
- IF P: Execute {partyModeWorkflow}
|
||||
- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-final-menu-options)
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- ONLY proceed to next step when user selects 'C'
|
||||
- After other menu items execution, return to this menu
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [C continue option] is selected and [all epics and stories saved to document following the template structure exactly], will you then load and read fully `{nextStepFile}` to execute and begin final validation phase.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- All epics processed in sequence
|
||||
- Stories created for each epic
|
||||
- Template structure followed exactly
|
||||
- All FRs covered by stories
|
||||
- Stories appropriately sized
|
||||
- Acceptance criteria are specific and testable
|
||||
- Document is complete and ready for development
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Deviating from template structure
|
||||
- Missing epics or stories
|
||||
- Stories too large or unclear
|
||||
- Missing acceptance criteria
|
||||
- Not following proper formatting
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -0,0 +1,145 @@
|
||||
---
|
||||
name: 'step-04-final-validation'
|
||||
description: 'Validate complete coverage of all requirements and ensure implementation readiness'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-final-validation.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
outputFile: '{planning_artifacts}/epics.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
|
||||
|
||||
# Template References
|
||||
epicsTemplate: '{workflow_path}/templates/epics-template.md'
|
||||
---
|
||||
|
||||
# Step 4: Final Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
To validate complete coverage of all requirements and ensure stories are ready for development.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 🔄 CRITICAL: Process validation sequentially without skipping
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a product strategist and technical specifications writer
|
||||
- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring validation expertise and quality assurance
|
||||
- ✅ User brings their implementation priorities and final review
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus ONLY on validating complete requirements coverage
|
||||
- 🚫 FORBIDDEN to skip any validation checks
|
||||
- 💬 Validate FR coverage, story completeness, and dependencies
|
||||
- 🚪 ENSURE all stories are ready for development
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Validate every requirement has story coverage
|
||||
- 💾 Check story dependencies and flow
|
||||
- 📖 Verify architecture compliance
|
||||
- 🚫 FORBIDDEN to approve incomplete coverage
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Complete epic and story breakdown from previous steps
|
||||
- Focus: Final validation of requirements coverage and story readiness
|
||||
- Limits: Validation only, no new content creation
|
||||
- Dependencies: Completed story generation from Step 3
|
||||
|
||||
## VALIDATION PROCESS:
|
||||
|
||||
### 1. FR Coverage Validation
|
||||
|
||||
Review the complete epic and story breakdown to ensure EVERY FR is covered:
|
||||
|
||||
**CRITICAL CHECK:**
|
||||
|
||||
- Go through each FR from the Requirements Inventory
|
||||
- Verify it appears in at least one story
|
||||
- Check that acceptance criteria fully address the FR
|
||||
- No FRs should be left uncovered
|
||||
|
||||
### 2. Architecture Implementation Validation
|
||||
|
||||
**Check for Starter Template Setup:**
|
||||
|
||||
- Does Architecture document specify a starter template?
|
||||
- If YES: Epic 1 Story 1 must be "Set up initial project from starter template"
|
||||
- This includes cloning, installing dependencies, initial configuration
|
||||
|
||||
**Database/Entity Creation Validation:**
|
||||
|
||||
- Are database tables/entities created ONLY when needed by stories?
|
||||
- ❌ WRONG: Epic 1 creates all tables upfront
|
||||
- ✅ RIGHT: Tables created as part of the first story that needs them
|
||||
- Each story should create/modify ONLY what it needs
|
||||
|
||||
### 3. Story Quality Validation
|
||||
|
||||
**Each story must:**
|
||||
|
||||
- Be completable by a single dev agent
|
||||
- Have clear acceptance criteria
|
||||
- Reference specific FRs it implements
|
||||
- Include necessary technical details
|
||||
- **Not have forward dependencies** (can only depend on PREVIOUS stories)
|
||||
- Be implementable without waiting for future stories
|
||||
|
||||
### 4. Epic Structure Validation
|
||||
|
||||
**Check that:**
|
||||
|
||||
- Epics deliver user value, not technical milestones
|
||||
- Dependencies flow naturally
|
||||
- Foundation stories only setup what's needed
|
||||
- No big upfront technical work
|
||||
|
||||
### 5. Dependency Validation (CRITICAL)
|
||||
|
||||
**Epic Independence Check:**
|
||||
|
||||
- Does each epic deliver COMPLETE functionality for its domain?
|
||||
- Can Epic 2 function without Epic 3 being implemented?
|
||||
- Can Epic 3 function standalone using Epic 1 & 2 outputs?
|
||||
- ❌ WRONG: Epic 2 requires Epic 3 features to work
|
||||
- ✅ RIGHT: Each epic is independently valuable
|
||||
|
||||
**Within-Epic Story Dependency Check:**
|
||||
For each epic, review stories in order:
|
||||
|
||||
- Can Story N.1 be completed without Stories N.2, N.3, etc.?
|
||||
- Can Story N.2 be completed using only Story N.1 output?
|
||||
- Can Story N.3 be completed using only Stories N.1 & N.2 outputs?
|
||||
- ❌ WRONG: "This story depends on a future story"
|
||||
- ❌ WRONG: Story references features not yet implemented
|
||||
- ✅ RIGHT: Each story builds only on previous stories
|
||||
|
||||
### 6. Complete and Save
|
||||
|
||||
If all validations pass:
|
||||
|
||||
- Update any remaining placeholders in the document
|
||||
- Ensure proper formatting
|
||||
- Save the final epics.md
|
||||
|
||||
**Present Final Menu:**
|
||||
**All validations complete!** [C] Complete Workflow
|
||||
|
||||
When C is selected, the workflow is complete and the epics.md is ready for development.
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
---
|
||||
|
||||
# {{project_name}} - Epic Breakdown
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides the complete epic and story breakdown for {{project_name}}, decomposing the requirements from the PRD, UX Design if it exists, and Architecture requirements into implementable stories.
|
||||
|
||||
## Requirements Inventory
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
{{fr_list}}
|
||||
|
||||
### NonFunctional Requirements
|
||||
|
||||
{{nfr_list}}
|
||||
|
||||
### Additional Requirements
|
||||
|
||||
{{additional_requirements}}
|
||||
|
||||
### FR Coverage Map
|
||||
|
||||
{{requirements_coverage_map}}
|
||||
|
||||
## Epic List
|
||||
|
||||
{{epics_list}}
|
||||
|
||||
<!-- Repeat for each epic in epics_list (N = 1, 2, 3...) -->
|
||||
|
||||
## Epic {{N}}: {{epic_title_N}}
|
||||
|
||||
{{epic_goal_N}}
|
||||
|
||||
<!-- Repeat for each story (M = 1, 2, 3...) within epic N -->
|
||||
|
||||
### Story {{N}}.{{M}}: {{story_title_N_M}}
|
||||
|
||||
As a {{user_type}},
|
||||
I want {{capability}},
|
||||
So that {{value_benefit}}.
|
||||
|
||||
**Acceptance Criteria:**
|
||||
|
||||
<!-- for each AC on this story -->
|
||||
|
||||
**Given** {{precondition}}
|
||||
**When** {{action}}
|
||||
**Then** {{expected_outcome}}
|
||||
**And** {{additional_criteria}}
|
||||
|
||||
<!-- End story repeat -->
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
name: create-epics-and-stories
|
||||
description: 'Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.'
|
||||
web_bundle: true
|
||||
---
|
||||
|
||||
# Create Epics and Stories
|
||||
|
||||
**Goal:** Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value, creating detailed, actionable stories with complete acceptance criteria for development teams.
|
||||
|
||||
**Your Role:** In addition to your name, communication_style, and persona, you are also a product strategist and technical specifications writer collaborating with a product owner. This is a partnership, not a client-vendor relationship. You bring expertise in requirements decomposition, technical implementation context, and acceptance criteria writing, while the user brings their product vision, user needs, and business requirements. Work together as equals.
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **step-file architecture** for disciplined execution:
|
||||
|
||||
### Core Principles
|
||||
|
||||
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
|
||||
- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
|
||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||
|
||||
### Step Processing Rules
|
||||
|
||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
|
||||
|
||||
### Critical Rules (NO EXCEPTIONS)
|
||||
|
||||
- 🛑 **NEVER** load multiple step files simultaneously
|
||||
- 📖 **ALWAYS** read entire step file before execution
|
||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||
- 📋 **NEVER** create mental todo lists from future steps
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION SEQUENCE
|
||||
|
||||
### 1. Configuration Loading
|
||||
|
||||
Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`, `communication_language`, `document_output_language`
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
Load, read the full file and then execute `{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md` to begin the workflow.
|
||||
@@ -0,0 +1,23 @@
|
||||
# Senior Developer Review - Validation Checklist
|
||||
|
||||
- [ ] Story file loaded from `{{story_path}}`
|
||||
- [ ] Story Status verified as reviewable (review)
|
||||
- [ ] Epic and Story IDs resolved ({{epic_num}}.{{story_num}})
|
||||
- [ ] Story Context located or warning recorded
|
||||
- [ ] Epic Tech Spec located or warning recorded
|
||||
- [ ] Architecture/standards docs loaded (as available)
|
||||
- [ ] Tech stack detected and documented
|
||||
- [ ] MCP doc search performed (or web fallback) and references captured
|
||||
- [ ] Acceptance Criteria cross-checked against implementation
|
||||
- [ ] File List reviewed and validated for completeness
|
||||
- [ ] Tests identified and mapped to ACs; gaps noted
|
||||
- [ ] Code quality review performed on changed files
|
||||
- [ ] Security review performed on changed files and dependencies
|
||||
- [ ] Outcome decided (Approve/Changes Requested/Blocked)
|
||||
- [ ] Review notes appended under "Senior Developer Review (AI)"
|
||||
- [ ] Change Log updated with review entry
|
||||
- [ ] Status updated according to settings (if enabled)
|
||||
- [ ] Sprint status synced (if sprint tracking enabled)
|
||||
- [ ] Story saved successfully
|
||||
|
||||
_Reviewer: {{user_name}} on {{date}}_
|
||||
@@ -0,0 +1,225 @@
|
||||
<workflow>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
|
||||
<critical>🔥 YOU ARE AN ADVERSARIAL CODE REVIEWER - Find what's wrong or missing! 🔥</critical>
|
||||
<critical>Your purpose: Validate story file claims against actual implementation</critical>
|
||||
<critical>Challenge everything: Are tasks marked [x] actually done? Are ACs really implemented?</critical>
|
||||
<critical>Find 3-10 specific issues in every review minimum - no lazy "looks good" reviews - YOU are so much better than the dev agent
|
||||
that wrote this slop</critical>
|
||||
<critical>Read EVERY file in the File List - verify implementation against story requirements</critical>
|
||||
<critical>Tasks marked complete but not done = CRITICAL finding</critical>
|
||||
<critical>Acceptance Criteria not implemented = HIGH severity finding</critical>
|
||||
|
||||
<step n="1" goal="Load story and discover changes">
|
||||
<action>Use provided {{story_path}} or ask user which story file to review</action>
|
||||
<action>Read COMPLETE story file</action>
|
||||
<action>Set {{story_key}} = extracted key from filename (e.g., "1-2-user-authentication.md" → "1-2-user-authentication") or story
|
||||
metadata</action>
|
||||
<action>Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Agent Record → File List, Change Log</action>
|
||||
|
||||
<!-- Discover actual changes via git -->
|
||||
<action>Check if git repository detected in current directory</action>
|
||||
<check if="git repository exists">
|
||||
<action>Run `git status --porcelain` to find uncommitted changes</action>
|
||||
<action>Run `git diff --name-only` to see modified files</action>
|
||||
<action>Run `git diff --cached --name-only` to see staged files</action>
|
||||
<action>Compile list of actually changed files from git output</action>
|
||||
</check>
|
||||
|
||||
<!-- Cross-reference story File List vs git reality -->
|
||||
<action>Compare story's Dev Agent Record → File List with actual git changes</action>
|
||||
<action>Note discrepancies:
|
||||
- Files in git but not in story File List
|
||||
- Files in story File List but no git changes
|
||||
- Missing documentation of what was actually changed
|
||||
</action>
|
||||
|
||||
<invoke-protocol name="discover_inputs" />
|
||||
<action>Load {project_context} for coding standards (if exists)</action>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Build review attack plan">
|
||||
<action>Extract ALL Acceptance Criteria from story</action>
|
||||
<action>Extract ALL Tasks/Subtasks with completion status ([x] vs [ ])</action>
|
||||
<action>From Dev Agent Record → File List, compile list of claimed changes</action>
|
||||
|
||||
<action>Create review plan:
|
||||
1. **AC Validation**: Verify each AC is actually implemented
|
||||
2. **Task Audit**: Verify each [x] task is really done
|
||||
3. **Code Quality**: Security, performance, maintainability
|
||||
4. **Test Quality**: Real tests vs placeholder bullshit
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Execute adversarial review">
|
||||
<critical>VALIDATE EVERY CLAIM - Check git reality vs story claims</critical>
|
||||
|
||||
<!-- Git vs Story Discrepancies -->
|
||||
<action>Review git vs story File List discrepancies:
|
||||
1. **Files changed but not in story File List** → MEDIUM finding (incomplete documentation)
|
||||
2. **Story lists files but no git changes** → HIGH finding (false claims)
|
||||
3. **Uncommitted changes not documented** → MEDIUM finding (transparency issue)
|
||||
</action>
|
||||
|
||||
<!-- Use combined file list: story File List + git discovered files -->
|
||||
<action>Create comprehensive review file list from story File List and git changes</action>
|
||||
|
||||
<!-- AC Validation -->
|
||||
<action>For EACH Acceptance Criterion:
|
||||
1. Read the AC requirement
|
||||
2. Search implementation files for evidence
|
||||
3. Determine: IMPLEMENTED, PARTIAL, or MISSING
|
||||
4. If MISSING/PARTIAL → HIGH SEVERITY finding
|
||||
</action>
|
||||
|
||||
<!-- Task Completion Audit -->
|
||||
<action>For EACH task marked [x]:
|
||||
1. Read the task description
|
||||
2. Search files for evidence it was actually done
|
||||
3. **CRITICAL**: If marked [x] but NOT DONE → CRITICAL finding
|
||||
4. Record specific proof (file:line)
|
||||
</action>
|
||||
|
||||
<!-- Code Quality Deep Dive -->
|
||||
<action>For EACH file in comprehensive review list:
|
||||
1. **Security**: Look for injection risks, missing validation, auth issues
|
||||
2. **Performance**: N+1 queries, inefficient loops, missing caching
|
||||
3. **Error Handling**: Missing try/catch, poor error messages
|
||||
4. **Code Quality**: Complex functions, magic numbers, poor naming
|
||||
5. **Test Quality**: Are tests real assertions or placeholders?
|
||||
</action>
|
||||
|
||||
<check if="total_issues_found lt 3">
|
||||
<critical>NOT LOOKING HARD ENOUGH - Find more problems!</critical>
|
||||
<action>Re-examine code for:
|
||||
- Edge cases and null handling
|
||||
- Architecture violations
|
||||
- Documentation gaps
|
||||
- Integration issues
|
||||
- Dependency problems
|
||||
- Git commit message quality (if applicable)
|
||||
</action>
|
||||
<action>Find at least 3 more specific, actionable issues</action>
|
||||
</check>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Present findings and fix them">
|
||||
<action>Categorize findings: HIGH (must fix), MEDIUM (should fix), LOW (nice to fix)</action>
|
||||
<action>Set {{fixed_count}} = 0</action>
|
||||
<action>Set {{action_count}} = 0</action>
|
||||
|
||||
<output>**🔥 CODE REVIEW FINDINGS, {user_name}!**
|
||||
|
||||
**Story:** {{story_file}}
|
||||
**Git vs Story Discrepancies:** {{git_discrepancy_count}} found
|
||||
**Issues Found:** {{high_count}} High, {{medium_count}} Medium, {{low_count}} Low
|
||||
|
||||
## 🔴 CRITICAL ISSUES
|
||||
- Tasks marked [x] but not actually implemented
|
||||
- Acceptance Criteria not implemented
|
||||
- Story claims files changed but no git evidence
|
||||
- Security vulnerabilities
|
||||
|
||||
## 🟡 MEDIUM ISSUES
|
||||
- Files changed but not documented in story File List
|
||||
- Uncommitted changes not tracked
|
||||
- Performance problems
|
||||
- Poor test coverage/quality
|
||||
- Code maintainability issues
|
||||
|
||||
## 🟢 LOW ISSUES
|
||||
- Code style improvements
|
||||
- Documentation gaps
|
||||
- Git commit message quality
|
||||
</output>
|
||||
|
||||
<ask>What should I do with these issues?
|
||||
|
||||
1. **Fix them automatically** - I'll update the code and tests
|
||||
2. **Create action items** - Add to story Tasks/Subtasks for later
|
||||
3. **Show me details** - Deep dive into specific issues
|
||||
|
||||
Choose [1], [2], or specify which issue to examine:</ask>
|
||||
|
||||
<check if="user chooses 1">
|
||||
<action>Fix all HIGH and MEDIUM issues in the code</action>
|
||||
<action>Add/update tests as needed</action>
|
||||
<action>Update File List in story if files changed</action>
|
||||
<action>Update story Dev Agent Record with fixes applied</action>
|
||||
<action>Set {{fixed_count}} = number of HIGH and MEDIUM issues fixed</action>
|
||||
<action>Set {{action_count}} = 0</action>
|
||||
</check>
|
||||
|
||||
<check if="user chooses 2">
|
||||
<action>Add "Review Follow-ups (AI)" subsection to Tasks/Subtasks</action>
|
||||
<action>For each issue: `- [ ] [AI-Review][Severity] Description [file:line]`</action>
|
||||
<action>Set {{action_count}} = number of action items created</action>
|
||||
<action>Set {{fixed_count}} = 0</action>
|
||||
</check>
|
||||
|
||||
<check if="user chooses 3">
|
||||
<action>Show detailed explanation with code examples</action>
|
||||
<action>Return to fix decision</action>
|
||||
</check>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Update story status and sync sprint tracking">
|
||||
<!-- Determine new status based on review outcome -->
|
||||
<check if="all HIGH and MEDIUM issues fixed AND all ACs implemented">
|
||||
<action>Set {{new_status}} = "done"</action>
|
||||
<action>Update story Status field to "done"</action>
|
||||
</check>
|
||||
<check if="HIGH or MEDIUM issues remain OR ACs not fully implemented">
|
||||
<action>Set {{new_status}} = "in-progress"</action>
|
||||
<action>Update story Status field to "in-progress"</action>
|
||||
</check>
|
||||
<action>Save story file</action>
|
||||
|
||||
<!-- Determine sprint tracking status -->
|
||||
<check if="{sprint_status} file exists">
|
||||
<action>Set {{current_sprint_status}} = "enabled"</action>
|
||||
</check>
|
||||
<check if="{sprint_status} file does NOT exist">
|
||||
<action>Set {{current_sprint_status}} = "no-sprint-tracking"</action>
|
||||
</check>
|
||||
|
||||
<!-- Sync sprint-status.yaml when story status changes (only if sprint tracking enabled) -->
|
||||
<check if="{{current_sprint_status}} != 'no-sprint-tracking'">
|
||||
<action>Load the FULL file: {sprint_status}</action>
|
||||
<action>Find development_status key matching {{story_key}}</action>
|
||||
|
||||
<check if="{{new_status}} == 'done'">
|
||||
<action>Update development_status[{{story_key}}] = "done"</action>
|
||||
<action>Save file, preserving ALL comments and structure</action>
|
||||
<output>✅ Sprint status synced: {{story_key}} → done</output>
|
||||
</check>
|
||||
|
||||
<check if="{{new_status}} == 'in-progress'">
|
||||
<action>Update development_status[{{story_key}}] = "in-progress"</action>
|
||||
<action>Save file, preserving ALL comments and structure</action>
|
||||
<output>🔄 Sprint status synced: {{story_key}} → in-progress</output>
|
||||
</check>
|
||||
|
||||
<check if="story key not found in sprint status">
|
||||
<output>⚠️ Story file updated, but sprint-status sync failed: {{story_key}} not found in sprint-status.yaml</output>
|
||||
</check>
|
||||
</check>
|
||||
|
||||
<check if="{{current_sprint_status}} == 'no-sprint-tracking'">
|
||||
<output>ℹ️ Story status updated (no sprint tracking configured)</output>
|
||||
</check>
|
||||
|
||||
<output>**✅ Review Complete!**
|
||||
|
||||
**Story Status:** {{new_status}}
|
||||
**Issues Fixed:** {{fixed_count}}
|
||||
**Action Items Created:** {{action_count}}
|
||||
|
||||
{{#if new_status == "done"}}Code review complete!{{else}}Address the action items and continue development.{{/if}}
|
||||
</output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -0,0 +1,50 @@
|
||||
# Review Story Workflow
|
||||
name: code-review
|
||||
description: "Perform an ADVERSARIAL Senior Developer code review that finds 3-10 specific problems in every story. Challenges everything: code quality, test coverage, architecture compliance, security, performance. NEVER accepts `looks good` - must find minimum issues and can auto-fix with user approval."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_skill_level: "{config_source}:user_skill_level"
|
||||
document_output_language: "{config_source}:document_output_language"
|
||||
date: system-generated
|
||||
planning_artifacts: "{config_source}:planning_artifacts"
|
||||
implementation_artifacts: "{config_source}:implementation_artifacts"
|
||||
output_folder: "{implementation_artifacts}"
|
||||
sprint_status: "{implementation_artifacts}/sprint-status.yaml"
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review"
|
||||
instructions: "{installed_path}/instructions.xml"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
template: false
|
||||
|
||||
variables:
|
||||
# Project context
|
||||
project_context: "**/project-context.md"
|
||||
story_dir: "{implementation_artifacts}"
|
||||
|
||||
# Smart input file references - handles both whole docs and sharded docs
|
||||
# Priority: Whole document first, then sharded version
|
||||
# Strategy: SELECTIVE LOAD - only load the specific epic needed for this story review
|
||||
input_file_patterns:
|
||||
architecture:
|
||||
description: "System architecture for review context"
|
||||
whole: "{planning_artifacts}/*architecture*.md"
|
||||
sharded: "{planning_artifacts}/*architecture*/*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
ux_design:
|
||||
description: "UX design specification (if UI review)"
|
||||
whole: "{planning_artifacts}/*ux*.md"
|
||||
sharded: "{planning_artifacts}/*ux*/*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
epics:
|
||||
description: "Epic containing story being reviewed"
|
||||
whole: "{planning_artifacts}/*epic*.md"
|
||||
sharded_index: "{planning_artifacts}/*epic*/index.md"
|
||||
sharded_single: "{planning_artifacts}/*epic*/epic-{{epic_num}}.md"
|
||||
load_strategy: "SELECTIVE_LOAD"
|
||||
|
||||
standalone: true
|
||||
279
_bmad/bmm/workflows/4-implementation/correct-course/checklist.md
Normal file
279
_bmad/bmm/workflows/4-implementation/correct-course/checklist.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Change Navigation Checklist
|
||||
|
||||
<critical>This checklist is executed as part of: {project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml</critical>
|
||||
<critical>Work through each section systematically with the user, recording findings and impacts</critical>
|
||||
|
||||
<checklist>
|
||||
|
||||
<section n="1" title="Understand the Trigger and Context">
|
||||
|
||||
<check-item id="1.1">
|
||||
<prompt>Identify the triggering story that revealed this issue</prompt>
|
||||
<action>Document story ID and brief description</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="1.2">
|
||||
<prompt>Define the core problem precisely</prompt>
|
||||
<action>Categorize issue type:</action>
|
||||
- Technical limitation discovered during implementation
|
||||
- New requirement emerged from stakeholders
|
||||
- Misunderstanding of original requirements
|
||||
- Strategic pivot or market change
|
||||
- Failed approach requiring different solution
|
||||
<action>Write clear problem statement</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="1.3">
|
||||
<prompt>Assess initial impact and gather supporting evidence</prompt>
|
||||
<action>Collect concrete examples, error messages, stakeholder feedback, or technical constraints</action>
|
||||
<action>Document evidence for later reference</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<halt-condition>
|
||||
<action if="trigger is unclear">HALT: "Cannot proceed without understanding what caused the need for change"</action>
|
||||
<action if="no evidence provided">HALT: "Need concrete evidence or examples of the issue before analyzing impact"</action>
|
||||
</halt-condition>
|
||||
|
||||
</section>
|
||||
|
||||
<section n="2" title="Epic Impact Assessment">
|
||||
|
||||
<check-item id="2.1">
|
||||
<prompt>Evaluate current epic containing the trigger story</prompt>
|
||||
<action>Can this epic still be completed as originally planned?</action>
|
||||
<action>If no, what modifications are needed?</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="2.2">
|
||||
<prompt>Determine required epic-level changes</prompt>
|
||||
<action>Check each scenario:</action>
|
||||
- Modify existing epic scope or acceptance criteria
|
||||
- Add new epic to address the issue
|
||||
- Remove or defer epic that's no longer viable
|
||||
- Completely redefine epic based on new understanding
|
||||
<action>Document specific epic changes needed</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="2.3">
|
||||
<prompt>Review all remaining planned epics for required changes</prompt>
|
||||
<action>Check each future epic for impact</action>
|
||||
<action>Identify dependencies that may be affected</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="2.4">
|
||||
<prompt>Check if issue invalidates future epics or necessitates new ones</prompt>
|
||||
<action>Does this change make any planned epics obsolete?</action>
|
||||
<action>Are new epics needed to address gaps created by this change?</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="2.5">
|
||||
<prompt>Consider if epic order or priority should change</prompt>
|
||||
<action>Should epics be resequenced based on this issue?</action>
|
||||
<action>Do priorities need adjustment?</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
</section>
|
||||
|
||||
<section n="3" title="Artifact Conflict and Impact Analysis">
|
||||
|
||||
<check-item id="3.1">
|
||||
<prompt>Check PRD for conflicts</prompt>
|
||||
<action>Does issue conflict with core PRD goals or objectives?</action>
|
||||
<action>Do requirements need modification, addition, or removal?</action>
|
||||
<action>Is the defined MVP still achievable or does scope need adjustment?</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="3.2">
|
||||
<prompt>Review Architecture document for conflicts</prompt>
|
||||
<action>Check each area for impact:</action>
|
||||
- System components and their interactions
|
||||
- Architectural patterns and design decisions
|
||||
- Technology stack choices
|
||||
- Data models and schemas
|
||||
- API designs and contracts
|
||||
- Integration points
|
||||
<action>Document specific architecture sections requiring updates</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="3.3">
|
||||
<prompt>Examine UI/UX specifications for conflicts</prompt>
|
||||
<action>Check for impact on:</action>
|
||||
- User interface components
|
||||
- User flows and journeys
|
||||
- Wireframes or mockups
|
||||
- Interaction patterns
|
||||
- Accessibility considerations
|
||||
<action>Note specific UI/UX sections needing revision</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="3.4">
|
||||
<prompt>Consider impact on other artifacts</prompt>
|
||||
<action>Review additional artifacts for impact:</action>
|
||||
- Deployment scripts
|
||||
- Infrastructure as Code (IaC)
|
||||
- Monitoring and observability setup
|
||||
- Testing strategies
|
||||
- Documentation
|
||||
- CI/CD pipelines
|
||||
<action>Document any secondary artifacts requiring updates</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
</section>
|
||||
|
||||
<section n="4" title="Path Forward Evaluation">
|
||||
|
||||
<check-item id="4.1">
|
||||
<prompt>Evaluate Option 1: Direct Adjustment</prompt>
|
||||
<action>Can the issue be addressed by modifying existing stories?</action>
|
||||
<action>Can new stories be added within the current epic structure?</action>
|
||||
<action>Would this approach maintain project timeline and scope?</action>
|
||||
<action>Effort estimate: [High/Medium/Low]</action>
|
||||
<action>Risk level: [High/Medium/Low]</action>
|
||||
<status>[ ] Viable / [ ] Not viable</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="4.2">
|
||||
<prompt>Evaluate Option 2: Potential Rollback</prompt>
|
||||
<action>Would reverting recently completed stories simplify addressing this issue?</action>
|
||||
<action>Which stories would need to be rolled back?</action>
|
||||
<action>Is the rollback effort justified by the simplification gained?</action>
|
||||
<action>Effort estimate: [High/Medium/Low]</action>
|
||||
<action>Risk level: [High/Medium/Low]</action>
|
||||
<status>[ ] Viable / [ ] Not viable</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="4.3">
|
||||
<prompt>Evaluate Option 3: PRD MVP Review</prompt>
|
||||
<action>Is the original PRD MVP still achievable with this issue?</action>
|
||||
<action>Does MVP scope need to be reduced or redefined?</action>
|
||||
<action>Do core goals need modification based on new constraints?</action>
|
||||
<action>What would be deferred to post-MVP if scope is reduced?</action>
|
||||
<action>Effort estimate: [High/Medium/Low]</action>
|
||||
<action>Risk level: [High/Medium/Low]</action>
|
||||
<status>[ ] Viable / [ ] Not viable</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="4.4">
|
||||
<prompt>Select recommended path forward</prompt>
|
||||
<action>Based on analysis of all options, choose the best path</action>
|
||||
<action>Provide clear rationale considering:</action>
|
||||
- Implementation effort and timeline impact
|
||||
- Technical risk and complexity
|
||||
- Impact on team morale and momentum
|
||||
- Long-term sustainability and maintainability
|
||||
- Stakeholder expectations and business value
|
||||
<action>Selected approach: [Option 1 / Option 2 / Option 3 / Hybrid]</action>
|
||||
<action>Justification: [Document reasoning]</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
</section>
|
||||
|
||||
<section n="5" title="Sprint Change Proposal Components">
|
||||
|
||||
<check-item id="5.1">
|
||||
<prompt>Create identified issue summary</prompt>
|
||||
<action>Write clear, concise problem statement</action>
|
||||
<action>Include context about discovery and impact</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="5.2">
|
||||
<prompt>Document epic impact and artifact adjustment needs</prompt>
|
||||
<action>Summarize findings from Epic Impact Assessment (Section 2)</action>
|
||||
<action>Summarize findings from Artifact Conflict Analysis (Section 3)</action>
|
||||
<action>Be specific about what changes are needed and why</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="5.3">
|
||||
<prompt>Present recommended path forward with rationale</prompt>
|
||||
<action>Include selected approach from Section 4</action>
|
||||
<action>Provide complete justification for recommendation</action>
|
||||
<action>Address trade-offs and alternatives considered</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="5.4">
|
||||
<prompt>Define PRD MVP impact and high-level action plan</prompt>
|
||||
<action>State clearly if MVP is affected</action>
|
||||
<action>Outline major action items needed for implementation</action>
|
||||
<action>Identify dependencies and sequencing</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="5.5">
|
||||
<prompt>Establish agent handoff plan</prompt>
|
||||
<action>Identify which roles/agents will execute the changes:</action>
|
||||
- Development team (for implementation)
|
||||
- Product Owner / Scrum Master (for backlog changes)
|
||||
- Product Manager / Architect (for strategic changes)
|
||||
<action>Define responsibilities for each role</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
</section>
|
||||
|
||||
<section n="6" title="Final Review and Handoff">
|
||||
|
||||
<check-item id="6.1">
|
||||
<prompt>Review checklist completion</prompt>
|
||||
<action>Verify all applicable sections have been addressed</action>
|
||||
<action>Confirm all [Action-needed] items have been documented</action>
|
||||
<action>Ensure analysis is comprehensive and actionable</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="6.2">
|
||||
<prompt>Verify Sprint Change Proposal accuracy</prompt>
|
||||
<action>Review complete proposal for consistency and clarity</action>
|
||||
<action>Ensure all recommendations are well-supported by analysis</action>
|
||||
<action>Check that proposal is actionable and specific</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="6.3">
|
||||
<prompt>Obtain explicit user approval</prompt>
|
||||
<action>Present complete proposal to user</action>
|
||||
<action>Get clear yes/no approval for proceeding</action>
|
||||
<action>Document approval and any conditions</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<check-item id="6.4">
|
||||
<prompt>Confirm next steps and handoff plan</prompt>
|
||||
<action>Review handoff responsibilities with user</action>
|
||||
<action>Ensure all stakeholders understand their roles</action>
|
||||
<action>Confirm timeline and success criteria</action>
|
||||
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
|
||||
</check-item>
|
||||
|
||||
<halt-condition>
|
||||
<action if="any critical section cannot be completed">HALT: "Cannot proceed to proposal without complete impact analysis"</action>
|
||||
<action if="user approval not obtained">HALT: "Must have explicit approval before implementing changes"</action>
|
||||
<action if="handoff responsibilities unclear">HALT: "Must clearly define who will execute the proposed changes"</action>
|
||||
</halt-condition>
|
||||
|
||||
</section>
|
||||
|
||||
</checklist>
|
||||
|
||||
<execution-notes>
|
||||
<note>This checklist is for SIGNIFICANT changes affecting project direction</note>
|
||||
<note>Work interactively with user - they make final decisions</note>
|
||||
<note>Be factual, not blame-oriented when analyzing issues</note>
|
||||
<note>Handle changes professionally as opportunities to improve the project</note>
|
||||
<note>Maintain conversation context throughout - this is collaborative work</note>
|
||||
</execution-notes>
|
||||
@@ -0,0 +1,206 @@
|
||||
# Correct Course - Sprint Change Management Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
|
||||
<critical>DOCUMENT OUTPUT: Updated epics, stories, or PRD sections. Clear, actionable changes. User skill level ({user_skill_level}) affects conversation style ONLY, not document updates.</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Initialize Change Navigation">
|
||||
<action>Confirm change trigger and gather user description of the issue</action>
|
||||
<action>Ask: "What specific issue or change has been identified that requires navigation?"</action>
|
||||
<action>Verify access to required project documents:</action>
|
||||
- PRD (Product Requirements Document)
|
||||
- Current Epics and Stories
|
||||
- Architecture documentation
|
||||
- UI/UX specifications
|
||||
<action>Ask user for mode preference:</action>
|
||||
- **Incremental** (recommended): Refine each edit collaboratively
|
||||
- **Batch**: Present all changes at once for review
|
||||
<action>Store mode selection for use throughout workflow</action>
|
||||
|
||||
<action if="change trigger is unclear">HALT: "Cannot navigate change without clear understanding of the triggering issue. Please provide specific details about what needs to change and why."</action>
|
||||
|
||||
<action if="core documents are unavailable">HALT: "Need access to project documents (PRD, Epics, Architecture, UI/UX) to assess change impact. Please ensure these documents are accessible."</action>
|
||||
</step>
|
||||
|
||||
<step n="0.5" goal="Discover and load project documents">
|
||||
<invoke-protocol name="discover_inputs" />
|
||||
<note>After discovery, these content variables are available: {prd_content}, {epics_content}, {architecture_content}, {ux_design_content}, {tech_spec_content}, {document_project_content}</note>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Execute Change Analysis Checklist">
|
||||
<action>Load and execute the systematic analysis from: {checklist}</action>
|
||||
<action>Work through each checklist section interactively with the user</action>
|
||||
<action>Record status for each checklist item:</action>
|
||||
- [x] Done - Item completed successfully
|
||||
- [N/A] Skip - Item not applicable to this change
|
||||
- [!] Action-needed - Item requires attention or follow-up
|
||||
<action>Maintain running notes of findings and impacts discovered</action>
|
||||
<action>Present checklist progress after each major section</action>
|
||||
|
||||
<action if="checklist cannot be completed">Identify blocking issues and work with user to resolve before continuing</action>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Draft Specific Change Proposals">
|
||||
<action>Based on checklist findings, create explicit edit proposals for each identified artifact</action>
|
||||
|
||||
<action>For Story changes:</action>
|
||||
|
||||
- Show old → new text format
|
||||
- Include story ID and section being modified
|
||||
- Provide rationale for each change
|
||||
- Example format:
|
||||
|
||||
```
|
||||
Story: [STORY-123] User Authentication
|
||||
Section: Acceptance Criteria
|
||||
|
||||
OLD:
|
||||
- User can log in with email/password
|
||||
|
||||
NEW:
|
||||
- User can log in with email/password
|
||||
- User can enable 2FA via authenticator app
|
||||
|
||||
Rationale: Security requirement identified during implementation
|
||||
```
|
||||
|
||||
<action>For PRD modifications:</action>
|
||||
|
||||
- Specify exact sections to update
|
||||
- Show current content and proposed changes
|
||||
- Explain impact on MVP scope and requirements
|
||||
|
||||
<action>For Architecture changes:</action>
|
||||
|
||||
- Identify affected components, patterns, or technology choices
|
||||
- Describe diagram updates needed
|
||||
- Note any ripple effects on other components
|
||||
|
||||
<action>For UI/UX specification updates:</action>
|
||||
|
||||
- Reference specific screens or components
|
||||
- Show wireframe or flow changes needed
|
||||
- Connect changes to user experience impact
|
||||
|
||||
<check if="mode is Incremental">
|
||||
<action>Present each edit proposal individually</action>
|
||||
<ask>Review and refine this change? Options: Approve [a], Edit [e], Skip [s]</ask>
|
||||
<action>Iterate on each proposal based on user feedback</action>
|
||||
</check>
|
||||
|
||||
<action if="mode is Batch">Collect all edit proposals and present together at end of step</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Generate Sprint Change Proposal">
|
||||
<action>Compile comprehensive Sprint Change Proposal document with following sections:</action>
|
||||
|
||||
<action>Section 1: Issue Summary</action>
|
||||
|
||||
- Clear problem statement describing what triggered the change
|
||||
- Context about when/how the issue was discovered
|
||||
- Evidence or examples demonstrating the issue
|
||||
|
||||
<action>Section 2: Impact Analysis</action>
|
||||
|
||||
- Epic Impact: Which epics are affected and how
|
||||
- Story Impact: Current and future stories requiring changes
|
||||
- Artifact Conflicts: PRD, Architecture, UI/UX documents needing updates
|
||||
- Technical Impact: Code, infrastructure, or deployment implications
|
||||
|
||||
<action>Section 3: Recommended Approach</action>
|
||||
|
||||
- Present chosen path forward from checklist evaluation:
|
||||
- Direct Adjustment: Modify/add stories within existing plan
|
||||
- Potential Rollback: Revert completed work to simplify resolution
|
||||
- MVP Review: Reduce scope or modify goals
|
||||
- Provide clear rationale for recommendation
|
||||
- Include effort estimate, risk assessment, and timeline impact
|
||||
|
||||
<action>Section 4: Detailed Change Proposals</action>
|
||||
|
||||
- Include all refined edit proposals from Step 3
|
||||
- Group by artifact type (Stories, PRD, Architecture, UI/UX)
|
||||
- Ensure each change includes before/after and justification
|
||||
|
||||
<action>Section 5: Implementation Handoff</action>
|
||||
|
||||
- Categorize change scope:
|
||||
- Minor: Direct implementation by dev team
|
||||
- Moderate: Backlog reorganization needed (PO/SM)
|
||||
- Major: Fundamental replan required (PM/Architect)
|
||||
- Specify handoff recipients and their responsibilities
|
||||
- Define success criteria for implementation
|
||||
|
||||
<action>Present complete Sprint Change Proposal to user</action>
|
||||
<action>Write Sprint Change Proposal document to {default_output_file}</action>
|
||||
<ask>Review complete proposal. Continue [c] or Edit [e]?</ask>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Finalize and Route for Implementation">
|
||||
<action>Get explicit user approval for complete proposal</action>
|
||||
<ask>Do you approve this Sprint Change Proposal for implementation? (yes/no/revise)</ask>
|
||||
|
||||
<check if="no or revise">
|
||||
<action>Gather specific feedback on what needs adjustment</action>
|
||||
<action>Return to appropriate step to address concerns</action>
|
||||
<goto step="3">If changes needed to edit proposals</goto>
|
||||
<goto step="4">If changes needed to overall proposal structure</goto>
|
||||
|
||||
</check>
|
||||
|
||||
<check if="yes the proposal is approved by the user">
|
||||
<action>Finalize Sprint Change Proposal document</action>
|
||||
<action>Determine change scope classification:</action>
|
||||
|
||||
- **Minor**: Can be implemented directly by development team
|
||||
- **Moderate**: Requires backlog reorganization and PO/SM coordination
|
||||
- **Major**: Needs fundamental replan with PM/Architect involvement
|
||||
|
||||
<action>Provide appropriate handoff based on scope:</action>
|
||||
|
||||
</check>
|
||||
|
||||
<check if="Minor scope">
|
||||
<action>Route to: Development team for direct implementation</action>
|
||||
<action>Deliverables: Finalized edit proposals and implementation tasks</action>
|
||||
</check>
|
||||
|
||||
<check if="Moderate scope">
|
||||
<action>Route to: Product Owner / Scrum Master agents</action>
|
||||
<action>Deliverables: Sprint Change Proposal + backlog reorganization plan</action>
|
||||
</check>
|
||||
|
||||
<check if="Major scope">
|
||||
<action>Route to: Product Manager / Solution Architect</action>
|
||||
<action>Deliverables: Complete Sprint Change Proposal + escalation notice</action>
|
||||
|
||||
<action>Confirm handoff completion and next steps with user</action>
|
||||
<action>Document handoff in workflow execution log</action>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Workflow Completion">
|
||||
<action>Summarize workflow execution:</action>
|
||||
- Issue addressed: {{change_trigger}}
|
||||
- Change scope: {{scope_classification}}
|
||||
- Artifacts modified: {{list_of_artifacts}}
|
||||
- Routed to: {{handoff_recipients}}
|
||||
|
||||
<action>Confirm all deliverables produced:</action>
|
||||
|
||||
- Sprint Change Proposal document
|
||||
- Specific edit proposals with before/after
|
||||
- Implementation handoff plan
|
||||
|
||||
<action>Report workflow completion to user with personalized message: "✅ Correct Course workflow complete, {user_name}!"</action>
|
||||
<action>Remind user of success criteria and next steps for implementation team</action>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -0,0 +1,58 @@
|
||||
# Correct Course - Sprint Change Management Workflow
|
||||
name: "correct-course"
|
||||
description: "Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation"
|
||||
author: "BMad Method"
|
||||
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_skill_level: "{config_source}:user_skill_level"
|
||||
document_output_language: "{config_source}:document_output_language"
|
||||
date: system-generated
|
||||
implementation_artifacts: "{config_source}:implementation_artifacts"
|
||||
planning_artifacts: "{config_source}:planning_artifacts"
|
||||
project_knowledge: "{config_source}:project_knowledge"
|
||||
output_folder: "{implementation_artifacts}"
|
||||
sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml"
|
||||
|
||||
# Smart input file references - handles both whole docs and sharded docs
|
||||
# Priority: Whole document first, then sharded version
|
||||
# Strategy: Load project context for impact analysis
|
||||
input_file_patterns:
|
||||
prd:
|
||||
description: "Product requirements for impact analysis"
|
||||
whole: "{planning_artifacts}/*prd*.md"
|
||||
sharded: "{planning_artifacts}/*prd*/*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
epics:
|
||||
description: "All epics to analyze change impact"
|
||||
whole: "{planning_artifacts}/*epic*.md"
|
||||
sharded: "{planning_artifacts}/*epic*/*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
architecture:
|
||||
description: "System architecture and decisions"
|
||||
whole: "{planning_artifacts}/*architecture*.md"
|
||||
sharded: "{planning_artifacts}/*architecture*/*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
ux_design:
|
||||
description: "UX design specification (if UI impacts)"
|
||||
whole: "{planning_artifacts}/*ux*.md"
|
||||
sharded: "{planning_artifacts}/*ux*/*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
tech_spec:
|
||||
description: "Technical specification"
|
||||
whole: "{planning_artifacts}/*tech-spec*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
document_project:
|
||||
description: "Brownfield project documentation (optional)"
|
||||
sharded: "{project_knowledge}/index.md"
|
||||
load_strategy: "INDEX_GUIDED"
|
||||
|
||||
installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/correct-course"
|
||||
template: false
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
checklist: "{installed_path}/checklist.md"
|
||||
default_output_file: "{planning_artifacts}/sprint-change-proposal-{date}.md"
|
||||
|
||||
standalone: true
|
||||
358
_bmad/bmm/workflows/4-implementation/create-story/checklist.md
Normal file
358
_bmad/bmm/workflows/4-implementation/create-story/checklist.md
Normal file
@@ -0,0 +1,358 @@
|
||||
# 🎯 Story Context Quality Competition Prompt
|
||||
|
||||
## **🔥 CRITICAL MISSION: Outperform and Fix the Original Create-Story LLM**
|
||||
|
||||
You are an independent quality validator in a **FRESH CONTEXT**. Your mission is to **thoroughly review** a story file that was generated by the create-story workflow and **systematically identify any mistakes, omissions, or disasters** that the original LLM missed.
|
||||
|
||||
**Your purpose is NOT just to validate - it's to FIX and PREVENT LLM developer mistakes, omissions, or disasters!**
|
||||
|
||||
### **🚨 CRITICAL MISTAKES TO PREVENT:**
|
||||
|
||||
- **Reinventing wheels** - Creating duplicate functionality instead of reusing existing
|
||||
- **Wrong libraries** - Using incorrect frameworks, versions, or dependencies
|
||||
- **Wrong file locations** - Violating project structure and organization
|
||||
- **Breaking regressions** - Implementing changes that break existing functionality
|
||||
- **Ignoring UX** - Not following user experience design requirements
|
||||
- **Vague implementations** - Creating unclear, ambiguous implementations
|
||||
- **Lying about completion** - Implementing incorrectly or incompletely
|
||||
- **Not learning from past work** - Ignoring previous story learnings and patterns
|
||||
|
||||
### **🚨 EXHAUSTIVE ANALYSIS REQUIRED:**
|
||||
|
||||
You must thoroughly analyze **ALL artifacts** to extract critical context - do NOT be lazy or skim! This is the most important quality control function in the entire development process!
|
||||
|
||||
### **🔬 UTILIZE SUBPROCESSES AND SUBAGENTS:**
|
||||
|
||||
Use research subagents, subprocesses, or parallel processing if available to thoroughly analyze different artifacts **simultaneously and thoroughly**. Leave no stone unturned!
|
||||
|
||||
### **🎯 COMPETITIVE EXCELLENCE:**
|
||||
|
||||
This is a COMPETITION to create the **ULTIMATE story context** that makes LLM developer mistakes **IMPOSSIBLE**!
|
||||
|
||||
## **🚀 HOW TO USE THIS CHECKLIST**
|
||||
|
||||
### **When Running from Create-Story Workflow:**
|
||||
|
||||
- The `{project_root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically:
|
||||
- Load this checklist file
|
||||
- Load the newly created story file (`{story_file_path}`)
|
||||
- Load workflow variables from `{installed_path}/workflow.yaml`
|
||||
- Execute the validation process
|
||||
|
||||
### **When Running in Fresh Context:**
|
||||
|
||||
- User should provide the story file path being reviewed
|
||||
- Load the story file directly
|
||||
- Load the corresponding workflow.yaml for variable context
|
||||
- Proceed with systematic analysis
|
||||
|
||||
### **Required Inputs:**
|
||||
|
||||
- **Story file**: The story file to review and improve
|
||||
- **Workflow variables**: From workflow.yaml (story_dir, output_folder, epics_file, etc.)
|
||||
- **Source documents**: Epics, architecture, etc. (discovered or provided)
|
||||
- **Validation framework**: `validate-workflow.xml` (handles checklist execution)
|
||||
|
||||
---
|
||||
|
||||
## **🔬 SYSTEMATIC RE-ANALYSIS APPROACH**
|
||||
|
||||
You will systematically re-do the entire story creation process, but with a critical eye for what the original LLM might have missed:
|
||||
|
||||
### **Step 1: Load and Understand the Target**
|
||||
|
||||
1. **Load the workflow configuration**: `{installed_path}/workflow.yaml` for variable inclusion
|
||||
2. **Load the story file**: `{story_file_path}` (provided by user or discovered)
|
||||
3. **Load validation framework**: `{project_root}/_bmad/core/tasks/validate-workflow.xml`
|
||||
4. **Extract metadata**: epic_num, story_num, story_key, story_title from story file
|
||||
5. **Resolve all workflow variables**: story_dir, output_folder, epics_file, architecture_file, etc.
|
||||
6. **Understand current status**: What story implementation guidance is currently provided?
|
||||
|
||||
**Note:** If running in fresh context, user should provide the story file path being reviewed. If running from create-story workflow, the validation framework will automatically discover the checklist and story file.
|
||||
|
||||
### **Step 2: Exhaustive Source Document Analysis**
|
||||
|
||||
**🔥 CRITICAL: Treat this like YOU are creating the story from scratch to PREVENT DISASTERS!**
|
||||
**Discover everything the original LLM missed that could cause developer mistakes, omissions, or disasters!**
|
||||
|
||||
#### **2.1 Epics and Stories Analysis**
|
||||
|
||||
- Load `{epics_file}` (or sharded equivalents)
|
||||
- Extract **COMPLETE Epic {{epic_num}} context**:
|
||||
- Epic objectives and business value
|
||||
- ALL stories in this epic (for cross-story context)
|
||||
- Our specific story's requirements, acceptance criteria
|
||||
- Technical requirements and constraints
|
||||
- Cross-story dependencies and prerequisites
|
||||
|
||||
#### **2.2 Architecture Deep-Dive**
|
||||
|
||||
- Load `{architecture_file}` (single or sharded)
|
||||
- **Systematically scan for ANYTHING relevant to this story:**
|
||||
- Technical stack with versions (languages, frameworks, libraries)
|
||||
- Code structure and organization patterns
|
||||
- API design patterns and contracts
|
||||
- Database schemas and relationships
|
||||
- Security requirements and patterns
|
||||
- Performance requirements and optimization strategies
|
||||
- Testing standards and frameworks
|
||||
- Deployment and environment patterns
|
||||
- Integration patterns and external services
|
||||
|
||||
#### **2.3 Previous Story Intelligence (if applicable)**
|
||||
|
||||
- If `story_num > 1`, load the previous story file
|
||||
- Extract **actionable intelligence**:
|
||||
- Dev notes and learnings
|
||||
- Review feedback and corrections needed
|
||||
- Files created/modified and their patterns
|
||||
- Testing approaches that worked/didn't work
|
||||
- Problems encountered and solutions found
|
||||
- Code patterns and conventions established
|
||||
|
||||
#### **2.4 Git History Analysis (if available)**
|
||||
|
||||
- Analyze recent commits for patterns:
|
||||
- Files created/modified in previous work
|
||||
- Code patterns and conventions used
|
||||
- Library dependencies added/changed
|
||||
- Architecture decisions implemented
|
||||
- Testing approaches used
|
||||
|
||||
#### **2.5 Latest Technical Research**
|
||||
|
||||
- Identify any libraries/frameworks mentioned
|
||||
- Research latest versions and critical information:
|
||||
- Breaking changes or security updates
|
||||
- Performance improvements or deprecations
|
||||
- Best practices for current versions
|
||||
|
||||
### **Step 3: Disaster Prevention Gap Analysis**
|
||||
|
||||
**🚨 CRITICAL: Identify every mistake the original LLM missed that could cause DISASTERS!**
|
||||
|
||||
#### **3.1 Reinvention Prevention Gaps**
|
||||
|
||||
- **Wheel reinvention:** Areas where developer might create duplicate functionality
|
||||
- **Code reuse opportunities** not identified that could prevent redundant work
|
||||
- **Existing solutions** not mentioned that developer should extend instead of replace
|
||||
|
||||
#### **3.2 Technical Specification DISASTERS**
|
||||
|
||||
- **Wrong libraries/frameworks:** Missing version requirements that could cause compatibility issues
|
||||
- **API contract violations:** Missing endpoint specifications that could break integrations
|
||||
- **Database schema conflicts:** Missing requirements that could corrupt data
|
||||
- **Security vulnerabilities:** Missing security requirements that could expose the system
|
||||
- **Performance disasters:** Missing requirements that could cause system failures
|
||||
|
||||
#### **3.3 File Structure DISASTERS**
|
||||
|
||||
- **Wrong file locations:** Missing organization requirements that could break build processes
|
||||
- **Coding standard violations:** Missing conventions that could create inconsistent codebase
|
||||
- **Integration pattern breaks:** Missing data flow requirements that could cause system failures
|
||||
- **Deployment failures:** Missing environment requirements that could prevent deployment
|
||||
|
||||
#### **3.4 Regression DISASTERS**
|
||||
|
||||
- **Breaking changes:** Missing requirements that could break existing functionality
|
||||
- **Test failures:** Missing test requirements that could allow bugs to reach production
|
||||
- **UX violations:** Missing user experience requirements that could ruin the product
|
||||
- **Learning failures:** Missing previous story context that could repeat same mistakes
|
||||
|
||||
#### **3.5 Implementation DISASTERS**
|
||||
|
||||
- **Vague implementations:** Missing details that could lead to incorrect or incomplete work
|
||||
- **Completion lies:** Missing acceptance criteria that could allow fake implementations
|
||||
- **Scope creep:** Missing boundaries that could cause unnecessary work
|
||||
- **Quality failures:** Missing quality requirements that could deliver broken features
|
||||
|
||||
### **Step 4: LLM-Dev-Agent Optimization Analysis**
|
||||
|
||||
**CRITICAL STEP: Optimize story context for LLM developer agent consumption**
|
||||
|
||||
**Analyze current story for LLM optimization issues:**
|
||||
|
||||
- **Verbosity problems:** Excessive detail that wastes tokens without adding value
|
||||
- **Ambiguity issues:** Vague instructions that could lead to multiple interpretations
|
||||
- **Context overload:** Too much information not directly relevant to implementation
|
||||
- **Missing critical signals:** Key requirements buried in verbose text
|
||||
- **Poor structure:** Information not organized for efficient LLM processing
|
||||
|
||||
**Apply LLM Optimization Principles:**
|
||||
|
||||
- **Clarity over verbosity:** Be precise and direct, eliminate fluff
|
||||
- **Actionable instructions:** Every sentence should guide implementation
|
||||
- **Scannable structure:** Use clear headings, bullet points, and emphasis
|
||||
- **Token efficiency:** Pack maximum information into minimum text
|
||||
- **Unambiguous language:** Clear requirements with no room for interpretation
|
||||
|
||||
### **Step 5: Improvement Recommendations**
|
||||
|
||||
**For each gap identified, provide specific, actionable improvements:**
|
||||
|
||||
#### **5.1 Critical Misses (Must Fix)**
|
||||
|
||||
- Missing essential technical requirements
|
||||
- Missing previous story context that could cause errors
|
||||
- Missing anti-pattern prevention that could lead to duplicate code
|
||||
- Missing security or performance requirements
|
||||
|
||||
#### **5.2 Enhancement Opportunities (Should Add)**
|
||||
|
||||
- Additional architectural guidance that would help developer
|
||||
- More detailed technical specifications
|
||||
- Better code reuse opportunities
|
||||
- Enhanced testing guidance
|
||||
|
||||
#### **5.3 Optimization Suggestions (Nice to Have)**
|
||||
|
||||
- Performance optimization hints
|
||||
- Additional context for complex scenarios
|
||||
- Enhanced debugging or development tips
|
||||
|
||||
#### **5.4 LLM Optimization Improvements**
|
||||
|
||||
- Token-efficient phrasing of existing content
|
||||
- Clearer structure for LLM processing
|
||||
- More actionable and direct instructions
|
||||
- Reduced verbosity while maintaining completeness
|
||||
|
||||
---
|
||||
|
||||
## **🎯 COMPETITION SUCCESS METRICS**
|
||||
|
||||
**You WIN against the original LLM if you identify:**
|
||||
|
||||
### **Category 1: Critical Misses (Blockers)**
|
||||
|
||||
- Essential technical requirements the developer needs but aren't provided
|
||||
- Previous story learnings that would prevent errors if ignored
|
||||
- Anti-pattern prevention that would prevent code duplication
|
||||
- Security or performance requirements that must be followed
|
||||
|
||||
### **Category 2: Enhancement Opportunities**
|
||||
|
||||
- Architecture guidance that would significantly help implementation
|
||||
- Technical specifications that would prevent wrong approaches
|
||||
- Code reuse opportunities the developer should know about
|
||||
- Testing guidance that would improve quality
|
||||
|
||||
### **Category 3: Optimization Insights**
|
||||
|
||||
- Performance or efficiency improvements
|
||||
- Development workflow optimizations
|
||||
- Additional context for complex scenarios
|
||||
|
||||
---
|
||||
|
||||
## **📋 INTERACTIVE IMPROVEMENT PROCESS**
|
||||
|
||||
After completing your systematic analysis, present your findings to the user interactively:
|
||||
|
||||
### **Step 5: Present Improvement Suggestions**
|
||||
|
||||
```
|
||||
🎯 **STORY CONTEXT QUALITY REVIEW COMPLETE**
|
||||
|
||||
**Story:** {{story_key}} - {{story_title}}
|
||||
|
||||
I found {{critical_count}} critical issues, {{enhancement_count}} enhancements, and {{optimization_count}} optimizations.
|
||||
|
||||
## **🚨 CRITICAL ISSUES (Must Fix)**
|
||||
|
||||
{{list each critical issue with clear, actionable description}}
|
||||
|
||||
## **⚡ ENHANCEMENT OPPORTUNITIES (Should Add)**
|
||||
|
||||
{{list each enhancement with clear benefit description}}
|
||||
|
||||
## **✨ OPTIMIZATIONS (Nice to Have)**
|
||||
|
||||
{{list each optimization with benefit description}}
|
||||
|
||||
## **🤖 LLM OPTIMIZATION (Token Efficiency & Clarity)**
|
||||
|
||||
{{list each LLM optimization that will improve dev agent performance:
|
||||
- Reduce verbosity while maintaining completeness
|
||||
- Improve structure for better LLM processing
|
||||
- Make instructions more actionable and direct
|
||||
- Enhance clarity and reduce ambiguity}}
|
||||
```
|
||||
|
||||
### **Step 6: Interactive User Selection**
|
||||
|
||||
After presenting the suggestions, ask the user:
|
||||
|
||||
```
|
||||
**IMPROVEMENT OPTIONS:**
|
||||
|
||||
Which improvements would you like me to apply to the story?
|
||||
|
||||
**Select from the numbered list above, or choose:**
|
||||
- **all** - Apply all suggested improvements
|
||||
- **critical** - Apply only critical issues
|
||||
- **select** - I'll choose specific numbers
|
||||
- **none** - Keep story as-is
|
||||
- **details** - Show me more details about any suggestion
|
||||
|
||||
Your choice:
|
||||
```
|
||||
|
||||
### **Step 7: Apply Selected Improvements**
|
||||
|
||||
When user accepts improvements:
|
||||
|
||||
- **Load the story file**
|
||||
- **Apply accepted changes** (make them look natural, as if they were always there)
|
||||
- **DO NOT reference** the review process, original LLM, or that changes were "added" or "enhanced"
|
||||
- **Ensure clean, coherent final story** that reads as if it was created perfectly the first time
|
||||
|
||||
### **Step 8: Confirmation**
|
||||
|
||||
After applying changes:
|
||||
|
||||
```
|
||||
✅ **STORY IMPROVEMENTS APPLIED**
|
||||
|
||||
Updated {{count}} sections in the story file.
|
||||
|
||||
The story now includes comprehensive developer guidance to prevent common implementation issues and ensure flawless execution.
|
||||
|
||||
**Next Steps:**
|
||||
1. Review the updated story
|
||||
2. Run `dev-story` for implementation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## **💪 COMPETITIVE EXCELLENCE MINDSET**
|
||||
|
||||
**Your goal:** Improve the story file with dev agent needed context that makes flawless implementation inevitable while being optimized for LLM developer agent consumption. Remember the dev agent will ONLY have this file to use.
|
||||
|
||||
**Success Criteria:** The LLM developer agent that processes your improved story will have:
|
||||
|
||||
- ✅ Clear technical requirements they must follow
|
||||
- ✅ Previous work context they can build upon
|
||||
- ✅ Anti-pattern prevention to avoid common mistakes
|
||||
- ✅ Comprehensive guidance for efficient implementation
|
||||
- ✅ **Optimized content structure** for maximum clarity and minimum token waste
|
||||
- ✅ **Actionable instructions** with no ambiguity or verbosity
|
||||
- ✅ **Efficient information density** - maximum guidance in minimum text
|
||||
|
||||
**Every improvement should make it IMPOSSIBLE for the developer to:**
|
||||
|
||||
- Reinvent existing solutions
|
||||
- Use wrong approaches or libraries
|
||||
- Create duplicate functionality
|
||||
- Miss critical requirements
|
||||
- Make implementation errors
|
||||
|
||||
**LLM Optimization Should Make it IMPOSSIBLE for the developer agent to:**
|
||||
|
||||
- Misinterpret requirements due to ambiguity
|
||||
- Waste tokens on verbose, non-actionable content
|
||||
- Struggle to find critical information buried in text
|
||||
- Get confused by poor structure or organization
|
||||
- Miss key implementation signals due to inefficient communication
|
||||
|
||||
**Go create the ultimate developer implementation guide! 🚀**
|
||||
@@ -0,0 +1,344 @@
|
||||
<workflow>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and generate all documents in {document_output_language}</critical>
|
||||
|
||||
<critical>🔥 CRITICAL MISSION: You are creating the ULTIMATE story context engine that prevents LLM developer mistakes, omissions or
|
||||
disasters! 🔥</critical>
|
||||
<critical>Your purpose is NOT to copy from epics - it's to create a comprehensive, optimized story file that gives the DEV agent
|
||||
EVERYTHING needed for flawless implementation</critical>
|
||||
<critical>COMMON LLM MISTAKES TO PREVENT: reinventing wheels, wrong libraries, wrong file locations, breaking regressions, ignoring UX,
|
||||
vague implementations, lying about completion, not learning from past work</critical>
|
||||
<critical>🚨 EXHAUSTIVE ANALYSIS REQUIRED: You must thoroughly analyze ALL artifacts to extract critical context - do NOT be lazy or skim!
|
||||
This is the most important function in the entire development process!</critical>
|
||||
<critical>🔬 UTILIZE SUBPROCESSES AND SUBAGENTS: Use research subagents, subprocesses or parallel processing if available to thoroughly
|
||||
analyze different artifacts simultaneously and thoroughly</critical>
|
||||
<critical>❓ SAVE QUESTIONS: If you think of questions or clarifications during analysis, save them for the end after the complete story is
|
||||
written</critical>
|
||||
<critical>🎯 ZERO USER INTERVENTION: Process should be fully automated except for initial epic/story selection or missing documents</critical>
|
||||
|
||||
<step n="1" goal="Determine target story">
|
||||
<check if="{{story_path}} is provided by user or user provided the epic and story number such as 2-4 or 1.6 or epic 1 story 5">
|
||||
<action>Parse user-provided story path: extract epic_num, story_num, story_title from format like "1-2-user-auth"</action>
|
||||
<action>Set {{epic_num}}, {{story_num}}, {{story_key}} from user input</action>
|
||||
<action>GOTO step 2a</action>
|
||||
</check>
|
||||
|
||||
<action>Check if {{sprint_status}} file exists for auto discover</action>
|
||||
<check if="sprint status file does NOT exist">
|
||||
<output>🚫 No sprint status file found and no story specified</output>
|
||||
<output>
|
||||
**Required Options:**
|
||||
1. Run `sprint-planning` to initialize sprint tracking (recommended)
|
||||
2. Provide specific epic-story number to create (e.g., "1-2-user-auth")
|
||||
3. Provide path to story documents if sprint status doesn't exist yet
|
||||
</output>
|
||||
<ask>Choose option [1], provide epic-story number, path to story docs, or [q] to quit:</ask>
|
||||
|
||||
<check if="user chooses 'q'">
|
||||
<action>HALT - No work needed</action>
|
||||
</check>
|
||||
|
||||
<check if="user chooses '1'">
|
||||
<output>Run sprint-planning workflow first to create sprint-status.yaml</output>
|
||||
<action>HALT - User needs to run sprint-planning</action>
|
||||
</check>
|
||||
|
||||
<check if="user provides epic-story number">
|
||||
<action>Parse user input: extract epic_num, story_num, story_title</action>
|
||||
<action>Set {{epic_num}}, {{story_num}}, {{story_key}} from user input</action>
|
||||
<action>GOTO step 2a</action>
|
||||
</check>
|
||||
|
||||
<check if="user provides story docs path">
|
||||
<action>Use user-provided path for story documents</action>
|
||||
<action>GOTO step 2a</action>
|
||||
</check>
|
||||
</check>
|
||||
|
||||
<!-- Auto-discover from sprint status only if no user input -->
|
||||
<check if="no user input provided">
|
||||
<critical>MUST read COMPLETE {sprint_status} file from start to end to preserve order</critical>
|
||||
<action>Load the FULL file: {{sprint_status}}</action>
|
||||
<action>Read ALL lines from beginning to end - do not skip any content</action>
|
||||
<action>Parse the development_status section completely</action>
|
||||
|
||||
<action>Find the FIRST story (by reading in order from top to bottom) where:
|
||||
- Key matches pattern: number-number-name (e.g., "1-2-user-auth")
|
||||
- NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
|
||||
- Status value equals "backlog"
|
||||
</action>
|
||||
|
||||
<check if="no backlog story found">
|
||||
<output>📋 No backlog stories found in sprint-status.yaml
|
||||
|
||||
All stories are either already created, in progress, or done.
|
||||
|
||||
**Options:**
|
||||
1. Run sprint-planning to refresh story tracking
|
||||
2. Load PM agent and run correct-course to add more stories
|
||||
3. Check if current sprint is complete and run retrospective
|
||||
</output>
|
||||
<action>HALT</action>
|
||||
</check>
|
||||
|
||||
<action>Extract from found story key (e.g., "1-2-user-authentication"):
|
||||
- epic_num: first number before dash (e.g., "1")
|
||||
- story_num: second number after first dash (e.g., "2")
|
||||
- story_title: remainder after second dash (e.g., "user-authentication")
|
||||
</action>
|
||||
<action>Set {{story_id}} = "{{epic_num}}.{{story_num}}"</action>
|
||||
<action>Store story_key for later use (e.g., "1-2-user-authentication")</action>
|
||||
|
||||
<!-- Mark epic as in-progress if this is first story -->
|
||||
<action>Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern</action>
|
||||
<check if="this is first story in epic {{epic_num}}">
|
||||
<action>Load {{sprint_status}} and check epic-{{epic_num}} status</action>
|
||||
<action>If epic status is "backlog" → update to "in-progress"</action>
|
||||
<action>If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility)</action>
|
||||
<action>If epic status is "in-progress" → no change needed</action>
|
||||
<check if="epic status is 'done'">
|
||||
<output>🚫 ERROR: Cannot create story in completed epic</output>
|
||||
<output>Epic {{epic_num}} is marked as 'done'. All stories are complete.</output>
|
||||
<output>If you need to add more work, either:</output>
|
||||
<output>1. Manually change epic status back to 'in-progress' in sprint-status.yaml</output>
|
||||
<output>2. Create a new epic for additional work</output>
|
||||
<action>HALT - Cannot proceed</action>
|
||||
</check>
|
||||
<check if="epic status is not one of: backlog, contexted, in-progress, done">
|
||||
<output>🚫 ERROR: Invalid epic status '{{epic_status}}'</output>
|
||||
<output>Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done</output>
|
||||
<output>Please fix sprint-status.yaml manually or run sprint-planning to regenerate</output>
|
||||
<action>HALT - Cannot proceed</action>
|
||||
</check>
|
||||
<output>📊 Epic {{epic_num}} status updated to in-progress</output>
|
||||
</check>
|
||||
|
||||
<action>GOTO step 2a</action>
|
||||
</check>
|
||||
<action>Load the FULL file: {{sprint_status}}</action>
|
||||
<action>Read ALL lines from beginning to end - do not skip any content</action>
|
||||
<action>Parse the development_status section completely</action>
|
||||
|
||||
<action>Find the FIRST story (by reading in order from top to bottom) where:
|
||||
- Key matches pattern: number-number-name (e.g., "1-2-user-auth")
|
||||
- NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
|
||||
- Status value equals "backlog"
|
||||
</action>
|
||||
|
||||
<check if="no backlog story found">
|
||||
<output>📋 No backlog stories found in sprint-status.yaml
|
||||
|
||||
All stories are either already created, in progress, or done.
|
||||
|
||||
**Options:**
|
||||
1. Run sprint-planning to refresh story tracking
|
||||
2. Load PM agent and run correct-course to add more stories
|
||||
3. Check if current sprint is complete and run retrospective
|
||||
</output>
|
||||
<action>HALT</action>
|
||||
</check>
|
||||
|
||||
<action>Extract from found story key (e.g., "1-2-user-authentication"):
|
||||
- epic_num: first number before dash (e.g., "1")
|
||||
- story_num: second number after first dash (e.g., "2")
|
||||
- story_title: remainder after second dash (e.g., "user-authentication")
|
||||
</action>
|
||||
<action>Set {{story_id}} = "{{epic_num}}.{{story_num}}"</action>
|
||||
<action>Store story_key for later use (e.g., "1-2-user-authentication")</action>
|
||||
|
||||
<!-- Mark epic as in-progress if this is first story -->
|
||||
<action>Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern</action>
|
||||
<check if="this is first story in epic {{epic_num}}">
|
||||
<action>Load {{sprint_status}} and check epic-{{epic_num}} status</action>
|
||||
<action>If epic status is "backlog" → update to "in-progress"</action>
|
||||
<action>If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility)</action>
|
||||
<action>If epic status is "in-progress" → no change needed</action>
|
||||
<check if="epic status is 'done'">
|
||||
<output>🚫 ERROR: Cannot create story in completed epic</output>
|
||||
<output>Epic {{epic_num}} is marked as 'done'. All stories are complete.</output>
|
||||
<output>If you need to add more work, either:</output>
|
||||
<output>1. Manually change epic status back to 'in-progress' in sprint-status.yaml</output>
|
||||
<output>2. Create a new epic for additional work</output>
|
||||
<action>HALT - Cannot proceed</action>
|
||||
</check>
|
||||
<check if="epic status is not one of: backlog, contexted, in-progress, done">
|
||||
<output>🚫 ERROR: Invalid epic status '{{epic_status}}'</output>
|
||||
<output>Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done</output>
|
||||
<output>Please fix sprint-status.yaml manually or run sprint-planning to regenerate</output>
|
||||
<action>HALT - Cannot proceed</action>
|
||||
</check>
|
||||
<output>📊 Epic {{epic_num}} status updated to in-progress</output>
|
||||
</check>
|
||||
|
||||
<action>GOTO step 2a</action>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Load and analyze core artifacts">
|
||||
<critical>🔬 EXHAUSTIVE ARTIFACT ANALYSIS - This is where you prevent future developer fuckups!</critical>
|
||||
|
||||
<!-- Load all available content through discovery protocol -->
|
||||
<invoke-protocol
|
||||
name="discover_inputs" />
|
||||
<note>Available content: {epics_content}, {prd_content}, {architecture_content}, {ux_content},
|
||||
{project_context}</note>
|
||||
|
||||
<!-- Analyze epics file for story foundation -->
|
||||
<action>From {epics_content}, extract Epic {{epic_num}} complete context:</action> **EPIC ANALYSIS:** - Epic
|
||||
objectives and business value - ALL stories in this epic for cross-story context - Our specific story's requirements, user story
|
||||
statement, acceptance criteria - Technical requirements and constraints - Dependencies on other stories/epics - Source hints pointing to
|
||||
original documents <!-- Extract specific story requirements -->
|
||||
<action>Extract our story ({{epic_num}}-{{story_num}}) details:</action> **STORY FOUNDATION:** - User story statement
|
||||
(As a, I want, so that) - Detailed acceptance criteria (already BDD formatted) - Technical requirements specific to this story -
|
||||
Business context and value - Success criteria <!-- Previous story analysis for context continuity -->
|
||||
<check if="story_num > 1">
|
||||
<action>Load previous story file: {{story_dir}}/{{epic_num}}-{{previous_story_num}}-*.md</action> **PREVIOUS STORY INTELLIGENCE:** -
|
||||
Dev notes and learnings from previous story - Review feedback and corrections needed - Files that were created/modified and their
|
||||
patterns - Testing approaches that worked/didn't work - Problems encountered and solutions found - Code patterns established <action>Extract
|
||||
all learnings that could impact current story implementation</action>
|
||||
</check>
|
||||
|
||||
<!-- Git intelligence for previous work patterns -->
|
||||
<check
|
||||
if="previous story exists AND git repository detected">
|
||||
<action>Get last 5 commit titles to understand recent work patterns</action>
|
||||
<action>Analyze 1-5 most recent commits for relevance to current story:
|
||||
- Files created/modified
|
||||
- Code patterns and conventions used
|
||||
- Library dependencies added/changed
|
||||
- Architecture decisions implemented
|
||||
- Testing approaches used
|
||||
</action>
|
||||
<action>Extract actionable insights for current story implementation</action>
|
||||
</check>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Architecture analysis for developer guardrails">
|
||||
<critical>🏗️ ARCHITECTURE INTELLIGENCE - Extract everything the developer MUST follow!</critical> **ARCHITECTURE DOCUMENT ANALYSIS:** <action>Systematically
|
||||
analyze architecture content for story-relevant requirements:</action>
|
||||
|
||||
<!-- Load architecture - single file or sharded -->
|
||||
<check if="architecture file is single file">
|
||||
<action>Load complete {architecture_content}</action>
|
||||
</check>
|
||||
<check if="architecture is sharded to folder">
|
||||
<action>Load architecture index and scan all architecture files</action>
|
||||
</check> **CRITICAL ARCHITECTURE EXTRACTION:** <action>For
|
||||
each architecture section, determine if relevant to this story:</action> - **Technical Stack:** Languages, frameworks, libraries with
|
||||
versions - **Code Structure:** Folder organization, naming conventions, file patterns - **API Patterns:** Service structure, endpoint
|
||||
patterns, data contracts - **Database Schemas:** Tables, relationships, constraints relevant to story - **Security Requirements:**
|
||||
Authentication patterns, authorization rules - **Performance Requirements:** Caching strategies, optimization patterns - **Testing
|
||||
Standards:** Testing frameworks, coverage expectations, test patterns - **Deployment Patterns:** Environment configurations, build
|
||||
processes - **Integration Patterns:** External service integrations, data flows <action>Extract any story-specific requirements that the
|
||||
developer MUST follow</action>
|
||||
<action>Identify any architectural decisions that override previous patterns</action>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Web research for latest technical specifics">
|
||||
<critical>🌐 ENSURE LATEST TECH KNOWLEDGE - Prevent outdated implementations!</critical> **WEB INTELLIGENCE:** <action>Identify specific
|
||||
technical areas that require latest version knowledge:</action>
|
||||
|
||||
<!-- Check for libraries/frameworks mentioned in architecture -->
|
||||
<action>From architecture analysis, identify specific libraries, APIs, or
|
||||
frameworks</action>
|
||||
<action>For each critical technology, research latest stable version and key changes:
|
||||
- Latest API documentation and breaking changes
|
||||
- Security vulnerabilities or updates
|
||||
- Performance improvements or deprecations
|
||||
- Best practices for current version
|
||||
</action>
|
||||
**EXTERNAL CONTEXT INCLUSION:** <action>Include in story any critical latest information the developer needs:
|
||||
- Specific library versions and why chosen
|
||||
- API endpoints with parameters and authentication
|
||||
- Recent security patches or considerations
|
||||
- Performance optimization techniques
|
||||
- Migration considerations if upgrading
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Create comprehensive story file">
|
||||
<critical>📝 CREATE ULTIMATE STORY FILE - The developer's master implementation guide!</critical>
|
||||
|
||||
<action>Initialize from template.md:
|
||||
{default_output_file}</action>
|
||||
<template-output file="{default_output_file}">story_header</template-output>
|
||||
|
||||
<!-- Story foundation from epics analysis -->
|
||||
<template-output
|
||||
file="{default_output_file}">story_requirements</template-output>
|
||||
|
||||
<!-- Developer context section - MOST IMPORTANT PART -->
|
||||
<template-output file="{default_output_file}">
|
||||
developer_context_section</template-output> **DEV AGENT GUARDRAILS:** <template-output file="{default_output_file}">
|
||||
technical_requirements</template-output>
|
||||
<template-output file="{default_output_file}">architecture_compliance</template-output>
|
||||
<template-output
|
||||
file="{default_output_file}">library_framework_requirements</template-output>
|
||||
<template-output file="{default_output_file}">
|
||||
file_structure_requirements</template-output>
|
||||
<template-output file="{default_output_file}">testing_requirements</template-output>
|
||||
|
||||
<!-- Previous story intelligence -->
|
||||
<check
|
||||
if="previous story learnings available">
|
||||
<template-output file="{default_output_file}">previous_story_intelligence</template-output>
|
||||
</check>
|
||||
|
||||
<!-- Git intelligence -->
|
||||
<check
|
||||
if="git analysis completed">
|
||||
<template-output file="{default_output_file}">git_intelligence_summary</template-output>
|
||||
</check>
|
||||
|
||||
<!-- Latest technical specifics -->
|
||||
<check if="web research completed">
|
||||
<template-output file="{default_output_file}">latest_tech_information</template-output>
|
||||
</check>
|
||||
|
||||
<!-- Project context reference -->
|
||||
<template-output
|
||||
file="{default_output_file}">project_context_reference</template-output>
|
||||
|
||||
<!-- Final status update -->
|
||||
<template-output file="{default_output_file}">
|
||||
story_completion_status</template-output>
|
||||
|
||||
<!-- CRITICAL: Set status to ready-for-dev -->
|
||||
<action>Set story Status to: "ready-for-dev"</action>
|
||||
<action>Add completion note: "Ultimate
|
||||
context engine analysis completed - comprehensive developer guide created"</action>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Update sprint status and finalize">
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using _bmad/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<action>Save story document unconditionally</action>
|
||||
|
||||
<!-- Update sprint status -->
|
||||
<check if="sprint status file exists">
|
||||
<action>Update {{sprint_status}}</action>
|
||||
<action>Load the FULL file and read all development_status entries</action>
|
||||
<action>Find development_status key matching {{story_key}}</action>
|
||||
<action>Verify current status is "backlog" (expected previous state)</action>
|
||||
<action>Update development_status[{{story_key}}] = "ready-for-dev"</action>
|
||||
<action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
|
||||
</check>
|
||||
|
||||
<action>Report completion</action>
|
||||
<output>**🎯 ULTIMATE BMad Method STORY CONTEXT CREATED, {user_name}!**
|
||||
|
||||
**Story Details:**
|
||||
- Story ID: {{story_id}}
|
||||
- Story Key: {{story_key}}
|
||||
- File: {{story_file}}
|
||||
- Status: ready-for-dev
|
||||
|
||||
**Next Steps:**
|
||||
1. Review the comprehensive story in {{story_file}}
|
||||
2. Run dev agents `dev-story` for optimized implementation
|
||||
3. Run `code-review` when complete (auto-marks done)
|
||||
|
||||
**The developer now has everything needed for flawless implementation!**
|
||||
</output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -0,0 +1,49 @@
|
||||
# Story {{epic_num}}.{{story_num}}: {{story_title}}
|
||||
|
||||
Status: ready-for-dev
|
||||
|
||||
<!-- Note: Validation is optional. Run validate-create-story for quality check before dev-story. -->
|
||||
|
||||
## Story
|
||||
|
||||
As a {{role}},
|
||||
I want {{action}},
|
||||
so that {{benefit}}.
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
1. [Add acceptance criteria from epics/PRD]
|
||||
|
||||
## Tasks / Subtasks
|
||||
|
||||
- [ ] Task 1 (AC: #)
|
||||
- [ ] Subtask 1.1
|
||||
- [ ] Task 2 (AC: #)
|
||||
- [ ] Subtask 2.1
|
||||
|
||||
## Dev Notes
|
||||
|
||||
- Relevant architecture patterns and constraints
|
||||
- Source tree components to touch
|
||||
- Testing standards summary
|
||||
|
||||
### Project Structure Notes
|
||||
|
||||
- Alignment with unified project structure (paths, modules, naming)
|
||||
- Detected conflicts or variances (with rationale)
|
||||
|
||||
### References
|
||||
|
||||
- Cite all technical details with source paths and sections, e.g. [Source: docs/<file>.md#Section]
|
||||
|
||||
## Dev Agent Record
|
||||
|
||||
### Agent Model Used
|
||||
|
||||
{{agent_model_name_version}}
|
||||
|
||||
### Debug Log References
|
||||
|
||||
### Completion Notes List
|
||||
|
||||
### File List
|
||||
@@ -0,0 +1,59 @@
|
||||
name: create-story
|
||||
description: "Create the next user story from epics+stories with enhanced context analysis and direct ready-for-dev marking"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
planning_artifacts: "{config_source}:planning_artifacts"
|
||||
implementation_artifacts: "{config_source}:implementation_artifacts"
|
||||
output_folder: "{implementation_artifacts}"
|
||||
story_dir: "{implementation_artifacts}"
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/create-story"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.xml"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Variables and inputs
|
||||
variables:
|
||||
sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" # Primary source for story tracking
|
||||
epics_file: "{planning_artifacts}/epics.md" # Enhanced epics+stories with BDD and source hints
|
||||
prd_file: "{planning_artifacts}/prd.md" # Fallback for requirements (if not in epics file)
|
||||
architecture_file: "{planning_artifacts}/architecture.md" # Fallback for constraints (if not in epics file)
|
||||
ux_file: "{planning_artifacts}/*ux*.md" # Fallback for UX requirements (if not in epics file)
|
||||
story_title: "" # Will be elicited if not derivable
|
||||
|
||||
# Project context
|
||||
project_context: "**/project-context.md"
|
||||
|
||||
default_output_file: "{story_dir}/{{story_key}}.md"
|
||||
|
||||
# Smart input file references - Simplified for enhanced approach
|
||||
# The epics+stories file should contain everything needed with source hints
|
||||
input_file_patterns:
|
||||
prd:
|
||||
description: "PRD (fallback - epics file should have most content)"
|
||||
whole: "{planning_artifacts}/*prd*.md"
|
||||
sharded: "{planning_artifacts}/*prd*/*.md"
|
||||
load_strategy: "SELECTIVE_LOAD" # Only load if needed
|
||||
architecture:
|
||||
description: "Architecture (fallback - epics file should have relevant sections)"
|
||||
whole: "{planning_artifacts}/*architecture*.md"
|
||||
sharded: "{planning_artifacts}/*architecture*/*.md"
|
||||
load_strategy: "SELECTIVE_LOAD" # Only load if needed
|
||||
ux:
|
||||
description: "UX design (fallback - epics file should have relevant sections)"
|
||||
whole: "{planning_artifacts}/*ux*.md"
|
||||
sharded: "{planning_artifacts}/*ux*/*.md"
|
||||
load_strategy: "SELECTIVE_LOAD" # Only load if needed
|
||||
epics:
|
||||
description: "Enhanced epics+stories file with BDD and source hints"
|
||||
whole: "{planning_artifacts}/*epic*.md"
|
||||
sharded: "{planning_artifacts}/*epic*/*.md"
|
||||
load_strategy: "SELECTIVE_LOAD" # Only load needed epic
|
||||
|
||||
standalone: true
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user