feat: add GSD-style step workflows and complete src/bmm consolidation

New workflow directories added to src/bmm/workflows/:

**Phase 1 - Analysis:**
- create-product-brief: 6-step workflow for product brief creation
- research: Domain, market, and technical research with 18 step files

**Phase 2 - Planning:**
- create-ux-design: 14-step UX design workflow with templates

**Phase 4 - Implementation:**
- code-review: Adversarial code review workflow
- correct-course: Course correction for sprint issues
- dev-story: Basic story development pipeline
- retrospective: Post-epic review workflow
- sprint-planning: Sprint status initialization
- sprint-status: Sprint progress tracking

**Quick Flow:**
- quick-dev: 6-step rapid development workflow
- quick-spec: 4-step specification workflow

**Support Workflows:**
- document-project: Codebase documentation generation
- excalidraw-diagrams: Diagram creation (flowchart, dataflow, wireframe)
- testarch: Test architecture suite (atdd, automate, ci, framework, nfr, test-design, test-review, trace)

**Cleanup:**
- Removed deprecated src/modules/bmgd workflows (migrated to src/bmm)
- Updated documentation and tooling references
This commit is contained in:
Jonah Schulte 2026-01-28 20:09:22 -05:00
parent fa004bd4a6
commit f1d81c8972
152 changed files with 32247 additions and 1608 deletions

View File

@ -260,7 +260,7 @@ More documentation updates coming soon.
**Workflow & Variable Fixes:** **Workflow & Variable Fixes:**
- **Variable Naming**: Standardized from {project_root} to {project-root} across CIS, BMGD, and BMM modules - **Variable Naming**: Standardized from {project_root} to {project-root} across CIS and BMM modules
- **Workflow References**: Fixed broken .yaml → .md workflow references - **Workflow References**: Fixed broken .yaml → .md workflow references
- **Advanced Elicitation Variables**: Fixed undefined variables in brainstorming - **Advanced Elicitation Variables**: Fixed undefined variables in brainstorming
- **Dependency Format**: Corrected dependency format and added missing frontmatter - **Dependency Format**: Corrected dependency format and added missing frontmatter
@ -357,7 +357,6 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **260+ Files Updated**: Comprehensive language integration across: - **260+ Files Updated**: Comprehensive language integration across:
- Core workflows (brainstorming, party mode, advanced elicitation) - Core workflows (brainstorming, party mode, advanced elicitation)
- BMB workflows (create-agent, create-module, create-workflow, edit-workflow, etc.) - BMB workflows (create-agent, create-module, create-workflow, edit-workflow, etc.)
- BMGD workflows (game-brief, gdd, narrative, game-architecture, etc.)
- BMM workflows (research, create-ux-design, prd, create-architecture, etc.) - BMM workflows (research, create-ux-design, prd, create-architecture, etc.)
- **Tested Languages**: Verified working with Spanish and Pirate Speak - **Tested Languages**: Verified working with Spanish and Pirate Speak
- **Natural Conversations**: AI agents respond in configured language throughout workflow - **Natural Conversations**: AI agents respond in configured language throughout workflow
@ -392,7 +391,7 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **index.md** - Core concepts introduction - **index.md** - Core concepts introduction
- **agents.md** (93 lines) - Understanding agents in BMAD - **agents.md** (93 lines) - Understanding agents in BMAD
- **workflows.md** (89 lines) - Understanding workflows in BMAD - **workflows.md** (89 lines) - Understanding workflows in BMAD
- **modules.md** (76 lines) - Understanding modules (BMM, BMGD, CIS, BMB, Core) - **modules.md** (76 lines) - Understanding modules (BMM, CIS, BMB, Core)
- **installing/index.md** (77 lines) - Installation guide - **installing/index.md** (77 lines) - Installation guide
- **installing/upgrading.md** (144 lines) - Upgrading guide - **installing/upgrading.md** (144 lines) - Upgrading guide
- **bmad-customization/index.md** - Customization overview - **bmad-customization/index.md** - Customization overview
@ -467,13 +466,12 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **Compound Menu Triggers**: All agents now use consistent 2-letter compound trigger format (e.g., `bmm-rd`, `bmm-ca`) - **Compound Menu Triggers**: All agents now use consistent 2-letter compound trigger format (e.g., `bmm-rd`, `bmm-ca`)
- **Improved UX**: Shorter, more memorable command shortcuts across all modules - **Improved UX**: Shorter, more memorable command shortcuts across all modules
- **Module Prefixing**: Menu items properly scoped by module prefix (bmm-, bmgd-, cis-, bmb-) - **Module Prefixing**: Menu items properly scoped by module prefix (bmm-, cis-, bmb-)
- **Universal Pattern**: All 22 agents updated to follow the same menu structure - **Universal Pattern**: All 22 agents updated to follow the same menu structure
**Agent Updates:** **Agent Updates:**
- **BMM Module**: 9 agents with standardized menus (pm, analyst, architect, dev, ux-designer, tech-writer, sm, tea, quick-flow-solo-dev) - **BMM Module**: 9 agents with standardized menus (pm, analyst, architect, dev, ux-designer, tech-writer, sm, tea, quick-flow-solo-dev)
- **BMGD Module**: 6 agents with standardized menus (game-architect, game-designer, game-dev, game-qa, game-scrum-master, game-solo-dev)
- **CIS Module**: 6 agents with standardized menus (innovation-strategist, design-thinking-coach, creative-problem-solver, brainstorming-coach, presentation-master, storyteller) - **CIS Module**: 6 agents with standardized menus (innovation-strategist, design-thinking-coach, creative-problem-solver, brainstorming-coach, presentation-master, storyteller)
- **BMB Module**: 3 agents with standardized menus (bmad-builder, agent-builder, module-builder, workflow-builder) - **BMB Module**: 3 agents with standardized menus (bmad-builder, agent-builder, module-builder, workflow-builder)
- **Core Module**: BMAD Master agent updated with consistent menu patterns - **Core Module**: BMAD Master agent updated with consistent menu patterns
@ -497,7 +495,7 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **Planning Artifacts**: Ephemeral planning documents (prd.md, product-brief.md, ux-design.md, architecture.md) - **Planning Artifacts**: Ephemeral planning documents (prd.md, product-brief.md, ux-design.md, architecture.md)
- **Documentation**: Long-term project documentation (separate from planning) - **Documentation**: Long-term project documentation (separate from planning)
- **Module Configuration**: BMM and BMGD modules updated with proper default paths - **Module Configuration**: BMM modules updated with proper default paths
### 🪟 Windows Installer Fixes ### 🪟 Windows Installer Fixes
@ -569,7 +567,7 @@ Located in `src/modules/bmb/workflows/agent/data/`:
**Revolutionary Content Organization:** **Revolutionary Content Organization:**
- **Phase 1-4 Path Segregation**: Implemented new BM paths across all BMM and BMGD workflows - **Phase 1-4 Path Segregation**: Implemented new BM paths across all BMM workflows
- **Planning vs Implementation Artifacts**: Separated ephemeral Phase 4 artifacts from permanent documentation - **Planning vs Implementation Artifacts**: Separated ephemeral Phase 4 artifacts from permanent documentation
- **Optimized File Organization**: Better structure differentiating planning artifacts from long-term project documentation - **Optimized File Organization**: Better structure differentiating planning artifacts from long-term project documentation
- **Backward Compatible**: Existing installations continue working while preparing for optimized content organization - **Backward Compatible**: Existing installations continue working while preparing for optimized content organization
@ -615,12 +613,6 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **Enhanced Quality Assurance**: 6-step process with mode detection, context gathering, execution, self-check, review, and resolution - **Enhanced Quality Assurance**: 6-step process with mode detection, context gathering, execution, self-check, review, and resolution
- **578 New Lines Added**: Significant expansion of quick-dev capabilities - **578 New Lines Added**: Significant expansion of quick-dev capabilities
**BMGD Workflow Fixes:**
- **workflow-status Filename Correction**: Fixed incorrect filename references (PR #1172)
- **sprint-planning Update**: Added workflow-status update to game-architecture completion
- **Path Corrections**: Resolved dead references and syntax errors (PR #1164)
### 🎨 Code Quality & Refactoring ### 🎨 Code Quality & Refactoring
**Persona Streamlining (PR #1167):** **Persona Streamlining (PR #1167):**
@ -692,50 +684,6 @@ Located in `src/modules/bmb/workflows/agent/data/`:
**Release: December 18, 2025** **Release: December 18, 2025**
### 🎮 BMGD Module - Complete Game Development Module Updated
**Massive BMGD Overhaul:**
- **New Game QA Agent (GLaDOS)**: Elite Game QA Architect with test automation specialization
- Engine-specific expertise: Unity, Unreal, Godot testing frameworks
- Comprehensive knowledge base with 15+ testing topics
- Complete testing workflows: test-framework, test-design, automate, playtest-plan, performance-test, test-review
- **New Game Solo Dev Agent (Indie)**: Rapid prototyping and iteration specialist
- Quick-flow workflows optimized for solo/small team development
- Streamlined development process for indie game creators
- **Production Workflow Alignment**: BMGD 4-production now fully aligned with BMM 4-implementation
- Removed obsolete workflows: story-done, story-ready, story-context, epic-tech-context
- Added sprint-status workflow for project tracking
- All workflows updated as standalone with proper XML instructions
**Game Testing Architecture:**
- **Complete Testing Knowledge Base**: 15 comprehensive testing guides covering:
- Engine-specific: Unity (TF 1.6.0), Unreal, Godot testing
- Game-specific: Playtesting, balance, save systems, multiplayer
- Platform: Certification (TRC/XR), localization, input systems
- QA Fundamentals: Automation, performance, regression, smoke testing
**New Workflows & Features:**
- **workflow-status**: Multi-mode status checker for game projects
- Game-specific project levels (Game Jam → AAA)
- Support for gamedev and quickflow paths
- Project initialization workflow
- **create-tech-spec**: Game-focused technical specification workflow
- Engine-aware (Unity/Unreal/Godot) specifications
- Performance and gameplay feel considerations
- **Enhanced Documentation**: Complete documentation suite with 9 guides
- agents-guide.md: Reference for all 6 agents
- workflows-guide.md: Complete workflow documentation
- game-types-guide.md: 24 game type templates
- quick-flow-guide.md: Rapid development guide
- Comprehensive troubleshooting and glossary
### 🤖 Agent Management Improved ### 🤖 Agent Management Improved
**Agent Recompile Feature:** **Agent Recompile Feature:**
@ -769,19 +717,15 @@ Located in `src/modules/bmb/workflows/agent/data/`:
### 📊 Statistics ### 📊 Statistics
- **178 files changed** with massive BMGD expansion - **28,350+ lines added** across documentation and workflows
- **28,350+ lines added** across testing documentation and workflows
- **2 new agents** added to BMGD module
- **15 comprehensive testing guides** created
- **Complete alignment** between BMGD and BMM production workflows
### 🌟 Key Highlights ### 🌟 Key Highlights
1. **BMGD Module Revolution**: Complete overhaul with professional game development workflows 1. **Agent Management**: New recompile feature allows quick agent updates without full reinstall
2. **Game Testing Excellence**: Comprehensive testing architecture for all major game engines 2. **Full Customization Support**: All agent fields now customizable via YAML
3. **Agent Management**: New recompile feature allows quick agent updates without full reinstall 3. **Custom Module Management**: Enhanced handling for custom module installation and updates
4. **Full Customization Support**: All agent fields now customizable via YAML 4. **Installation Improvements**: Better manifest tracking and customization integration
5. **Industry-Ready Documentation**: Professional-grade guides for game development teams 5. **Documentation Updates**: All documentation updated to reflect new features
--- ---
@ -1161,7 +1105,6 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **3-Track System**: Simplified from 5 levels to 3 intuitive tracks - **3-Track System**: Simplified from 5 levels to 3 intuitive tracks
- **Web Bundles Guide**: Comprehensive documentation with 60-80% cost savings strategies - **Web Bundles Guide**: Comprehensive documentation with 60-80% cost savings strategies
- **Unified Output Structure**: Eliminated .ephemeral/ folders - single configurable output folder - **Unified Output Structure**: Eliminated .ephemeral/ folders - single configurable output folder
- **BMGD Phase 4**: Added 10 game development workflows with BMM patterns
## [6.0.0-alpha.8] ## [6.0.0-alpha.8]
@ -1171,14 +1114,13 @@ Located in `src/modules/bmb/workflows/agent/data/`:
- **Optimized Agent Loading**: CLI loads from installed files, eliminating duplication - **Optimized Agent Loading**: CLI loads from installed files, eliminating duplication
- **Party Mode Everywhere**: All web bundles include multi-agent collaboration - **Party Mode Everywhere**: All web bundles include multi-agent collaboration
- **Phase 4 Artifact Separation**: Stories, code reviews, sprint plans configurable outside docs - **Phase 4 Artifact Separation**: Stories, code reviews, sprint plans configurable outside docs
- **Expanded Web Bundles**: All BMM, BMGD, CIS agents bundled with elicitation integration - **Expanded Web Bundles**: All BMM and CIS agents bundled with elicitation integration
## [6.0.0-alpha.7] ## [6.0.0-alpha.7]
**Release: November 7, 2025** **Release: November 7, 2025**
- **Workflow Vendoring**: Web bundler performs automatic cross-module dependency vendoring - **Workflow Vendoring**: Web bundler performs automatic cross-module dependency vendoring
- **BMGD Module Extraction**: Game development split into standalone 4-phase structure
- **Enhanced Dependency Resolution**: Better handling of web_bundle: false workflows - **Enhanced Dependency Resolution**: Better handling of web_bundle: false workflows
- **Advanced Elicitation Fix**: Added missing CSV files to workflow bundles - **Advanced Elicitation Fix**: Added missing CSV files to workflow bundles
- **Claude Code Fix**: Resolved README slash command installation regression - **Claude Code Fix**: Resolved README slash command installation regression

View File

@ -118,7 +118,7 @@ Two feature branches implementing comprehensive quality automation for BMAD-METH
- Files: 36 modified/created - Files: 36 modified/created
- Lines: +8,079 insertions, -93 deletions - Lines: +8,079 insertions, -93 deletions
- Commits: 11 well-formed conventional commits - Commits: 11 well-formed conventional commits
- Modules: BMM and BMGD (both fully supported) - Modules: BMM (fully supported)
**Validation:** **Validation:**
- ✅ All schema validation passing - ✅ All schema validation passing

View File

@ -31,5 +31,5 @@ Gap analysis detects existing code and proposes task refinements (extend vs crea
**Changes:** 3 workflows, 4 new docs, 16 files total **Changes:** 3 workflows, 4 new docs, 16 files total
**Lines:** ~2,740 additions **Lines:** ~2,740 additions
**Modules:** BMM and BMGD **Modules:** BMM
**Breaking:** None - fully backwards compatible **Breaking:** None - fully backwards compatible

View File

@ -241,10 +241,6 @@ This fork is published to npm under the `@jonahschulte` scope for independent in
- Modified `create-story` workflow for requirements-focused planning - Modified `create-story` workflow for requirements-focused planning
- Enhanced `dev-story` workflow with gap analysis integration - Enhanced `dev-story` workflow with gap analysis integration
### BMGD (BMAD Game Dev)
- Added parallel workflows for game development context
- Enhanced `game-dev.agent.yaml` and `game-scrum-master.agent.yaml`
--- ---
## Installation ## Installation

View File

@ -69,7 +69,6 @@ BMad Method extends with official modules for specialized domains. Modules are a
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases | | **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules | | **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving | | **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release! * More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!

View File

@ -224,7 +224,7 @@ your-project/
| **Deep-Dive** | `document-project.md` | | **Deep-Dive** | `document-project.md` |
| **Configuration** | `core-tasks.md` | | **Configuration** | `core-tasks.md` |
| **Glossary** | `glossary/index.md` | | **Glossary** | `glossary/index.md` |
| **Comprehensive** | `bmgd-workflows.md` | | **Comprehensive** | `bmm-workflows.md` |
### Reference Index Pages ### Reference Index Pages
@ -324,7 +324,6 @@ Add italic context at definition start for limited-scope terms:
- `*Quick Flow only.*` - `*Quick Flow only.*`
- `*BMad Method/Enterprise.*` - `*BMad Method/Enterprise.*`
- `*Phase N.*` - `*Phase N.*`
- `*BMGD.*`
- `*Brownfield.*` - `*Brownfield.*`
### Glossary Checklist ### Glossary Checklist

View File

@ -164,7 +164,6 @@ When dev-story prompts for gap analysis approval:
```bash ```bash
# In BMAD-METHOD repo # In BMAD-METHOD repo
git checkout v6.0.0-alpha.21 -- src/modules/bmm/workflows/4-implementation/ git checkout v6.0.0-alpha.21 -- src/modules/bmm/workflows/4-implementation/
git checkout v6.0.0-alpha.21 -- src/modules/bmgd/workflows/4-production/
# Reinstall in your project # Reinstall in your project
cd ~/git/your-project cd ~/git/your-project

View File

@ -109,9 +109,6 @@ your-project/
| v4 Module | v6 Status | | v4 Module | v6 Status |
|-----------|-----------| |-----------|-----------|
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon | | `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon | | `_bmad-creative-writing` | Not adapted — new v6 module coming soon |

View File

@ -30,8 +30,6 @@ Terminology reference for the BMad Method.
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Architecture Document** | *BMad Method/Enterprise.* System-wide design document defining structure, components, data models, integration patterns, security, and deployment. | | **Architecture Document** | *BMad Method/Enterprise.* System-wide design document defining structure, components, data models, integration patterns, security, and deployment. |
| **Epics** | High-level feature groupings containing multiple related stories. Typically 5-15 stories each representing cohesive functionality. | | **Epics** | High-level feature groupings containing multiple related stories. Typically 5-15 stories each representing cohesive functionality. |
| **Game Brief** | *BMGD.* Document capturing game's core vision, pillars, target audience, and scope. Foundation for the GDD. |
| **GDD** | *BMGD.* Game Design Document — comprehensive document detailing all aspects of game design: mechanics, systems, content, and more. |
| **PRD** | *BMad Method/Enterprise.* Product Requirements Document containing vision, goals, FRs, NFRs, and success criteria. Focuses on WHAT to build. | | **PRD** | *BMad Method/Enterprise.* Product Requirements Document containing vision, goals, FRs, NFRs, and success criteria. Focuses on WHAT to build. |
| **Product Brief** | *Phase 1.* Optional strategic document capturing product vision, market context, and high-level requirements before detailed planning. | | **Product Brief** | *Phase 1.* Optional strategic document capturing product vision, market context, and high-level requirements before detailed planning. |
| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. | | **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. |
@ -57,8 +55,6 @@ Terminology reference for the BMad Method.
| **Architect** | Agent designing system architecture, creating architecture documents, and validating designs. Primary agent for Phase 3. | | **Architect** | Agent designing system architecture, creating architecture documents, and validating designs. Primary agent for Phase 3. |
| **BMad Master** | Meta-level orchestrator from BMad Core facilitating party mode and providing high-level guidance across all modules. | | **BMad Master** | Meta-level orchestrator from BMad Core facilitating party mode and providing high-level guidance across all modules. |
| **DEV** | Developer agent implementing stories, writing code, running tests, and performing code reviews. Primary implementer in Phase 4. | | **DEV** | Developer agent implementing stories, writing code, running tests, and performing code reviews. Primary implementer in Phase 4. |
| **Game Architect** | *BMGD.* Agent designing game system architecture and validating game-specific technical designs. |
| **Game Designer** | *BMGD.* Agent creating game design documents (GDD) and running game-specific workflows. |
| **Party Mode** | Multi-agent collaboration feature where agents discuss challenges together. BMad Master orchestrates, selecting 2-3 relevant agents per message. | | **Party Mode** | Multi-agent collaboration feature where agents discuss challenges together. BMad Master orchestrates, selecting 2-3 relevant agents per message. |
| **PM** | Product Manager agent creating PRDs and tech-specs. Primary agent for Phase 2 planning. | | **PM** | Product Manager agent creating PRDs and tech-specs. Primary agent for Phase 2 planning. |
| **SM** | Scrum Master agent managing sprints, creating stories, and coordinating implementation. Primary orchestrator for Phase 4. | | **SM** | Scrum Master agent managing sprints, creating stories, and coordinating implementation. Primary orchestrator for Phase 4. |
@ -103,24 +99,6 @@ Terminology reference for the BMad Method.
| **Story File** | Markdown file containing story description, acceptance criteria, technical notes, and testing requirements. | | **Story File** | Markdown file containing story description, acceptance criteria, technical notes, and testing requirements. |
| **Track Selection** | Automatic analysis by `bmad-help` suggesting appropriate track based on complexity indicators. User can override. | | **Track Selection** | Automatic analysis by `bmad-help` suggesting appropriate track based on complexity indicators. User can override. |
## Game Development Terms
| Term | Definition |
| ------------------------------ | ---------------------------------------------------------------------------------------------------- |
| **Core Fantasy** | *BMGD.* The emotional experience players seek from your game — what they want to FEEL. |
| **Core Loop** | *BMGD.* Fundamental cycle of actions players repeat throughout gameplay. The heart of your game. |
| **Design Pillar** | *BMGD.* Core principle guiding all design decisions. Typically 3-5 pillars define a game's identity. |
| **Environmental Storytelling** | *BMGD.* Narrative communicated through the game world itself rather than explicit dialogue. |
| **Game Type** | *BMGD.* Genre classification determining which specialized GDD sections are included. |
| **MDA Framework** | *BMGD.* Mechanics → Dynamics → Aesthetics — framework for analyzing and designing games. |
| **Meta-Progression** | *BMGD.* Persistent progression carrying between individual runs or sessions. |
| **Metroidvania** | *BMGD.* Genre featuring interconnected world exploration with ability-gated progression. |
| **Narrative Complexity** | *BMGD.* How central story is to the game: Critical, Heavy, Moderate, or Light. |
| **Permadeath** | *BMGD.* Game mechanic where character death is permanent, typically requiring a new run. |
| **Player Agency** | *BMGD.* Degree to which players can make meaningful choices affecting outcomes. |
| **Procedural Generation** | *BMGD.* Algorithmic creation of game content (levels, items, characters) rather than hand-crafted. |
| **Roguelike** | *BMGD.* Genre featuring procedural generation, permadeath, and run-based progression. |
## Test Architect (TEA) Concepts ## Test Architect (TEA) Concepts
| Term | Definition | | Term | Definition |

View File

@ -0,0 +1,10 @@
---
stepsCompleted: []
inputDocuments: []
date: { system-date }
author: { user }
---
# Product Brief: {{project_name}}
<!-- Content will be appended sequentially through collaborative workflow steps -->

View File

@ -0,0 +1,177 @@
---
name: 'step-01-init'
description: 'Initialize the product brief workflow by detecting continuation state and setting up the document'
# File References
nextStepFile: './step-02-vision.md'
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
# Template References
productBriefTemplate: '../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 `./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, without delay, read fully and follow: {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 read fully and follow: `{nextStepFile}` to 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.

View File

@ -0,0 +1,161 @@
---
name: 'step-01b-continue'
description: 'Resume the product brief workflow from where it was left off, ensuring smooth continuation'
# File References
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: Read fully and follow 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 read fully and follow 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.

View File

@ -0,0 +1,199 @@
---
name: 'step-02-vision'
description: 'Discover and define the core product vision, problem statement, and unique value proposition'
# File References
nextStepFile: './step-03-users.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: Read fully and follow: {advancedElicitationTask} with current vision content to dive deeper and refine
- IF P: Read fully and follow: {partyModeWorkflow} to bring different perspectives to positioning and differentiation
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2], then read fully and follow: {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 read fully and follow: `{nextStepFile}` to 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.

View File

@ -0,0 +1,202 @@
---
name: 'step-03-users'
description: 'Define target users with rich personas and map their key interactions with the product'
# File References
nextStepFile: './step-04-metrics.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: Read fully and follow: {advancedElicitationTask} with current user content to dive deeper into personas and journeys
- IF P: Read fully and follow: {partyModeWorkflow} to bring different perspectives to validate user understanding
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2, 3], then read fully and follow: {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 read fully and follow: `{nextStepFile}` to 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.

View File

@ -0,0 +1,205 @@
---
name: 'step-04-metrics'
description: 'Define comprehensive success metrics that include user success, business objectives, and key performance indicators'
# File References
nextStepFile: './step-05-scope.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: Read fully and follow: {advancedElicitationTask} with current metrics content to dive deeper into success metric insights
- IF P: Read fully and follow: {partyModeWorkflow} to bring different perspectives to validate comprehensive metrics
- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2, 3, 4], then read fully and follow: {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 read fully and follow: `{nextStepFile}` to 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.

View File

@ -0,0 +1,219 @@
---
name: 'step-05-scope'
description: 'Define MVP scope with clear boundaries and outline future vision while managing scope creep'
# File References
nextStepFile: './step-06-complete.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: Read fully and follow: {advancedElicitationTask} with current scope content to optimize scope definition
- IF P: Read fully and follow: {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 read fully and follow: {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 read fully and follow: `{nextStepFile}` to 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.

View File

@ -0,0 +1,162 @@
---
name: 'step-06-complete'
description: 'Complete the product brief workflow, update status files, and suggest next steps for the project'
# File References
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. 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?
### 3. 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
### 4. Congrats to the user
"**Your Product Brief for {{project_name}} is now complete and ready for the next phase!**"
Recap that 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
### 5. Suggest next steps
Product Brief complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Validate PRD`.
---
## 🚨 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}}!** 🎉

View File

@ -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, read fully and follow 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
Read fully and follow: `{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md` to begin the workflow.

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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! 🎉

View File

@ -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! 🎉

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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! 🎉

View File

@ -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! 🎉

View 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 -->

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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!

View File

@ -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! 🎉

View File

@ -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! 🎉

View 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.

View File

@ -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

View File

@ -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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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, read fully and follow: `./step-03-core-experience.md`.
## 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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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
- Read fully and follow: `./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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -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: Read fully and follow: {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
- When 'P' selected: Read fully and follow: {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):
- Read fully and follow: {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):
- Read fully and follow: {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!

View File

@ -0,0 +1,171 @@
# 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
UX Design complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Create UX`.
### 5. Final Completion Confirmation
Congratulate the user on the completion you both completed together of the UX.
## 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`

View File

@ -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 -->

View File

@ -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}`
- Read fully and follow: `steps/step-01-init.md` to begin the UX design workflow.

View File

@ -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}}_

View File

@ -0,0 +1,227 @@
<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>
<critical>Do not review files that are not part of the application's source code. Always exclude the _bmad/ and _bmad-output/ folders from the review. Always exclude IDE and CLI configuration folders like .cursor/ and .windsurf/ and .claude/</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>

View File

@ -0,0 +1,51 @@
# 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
web_bundle: false

View File

@ -0,0 +1,288 @@
# 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>Update sprint-status.yaml to reflect approved epic changes</prompt>
<action>If epics were added: Add new epic entries with status 'backlog'</action>
<action>If epics were removed: Remove corresponding entries</action>
<action>If epics were renumbered: Update epic IDs and story references</action>
<action>If stories were added/removed: Update story entries within affected epics</action>
<status>[ ] Done / [ ] N/A / [ ] Action-needed</status>
</check-item>
<check-item id="6.5">
<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>

View File

@ -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>Read fully and follow 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>

View File

@ -0,0 +1,60 @@
# 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"
# 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
web_bundle: false

View File

@ -0,0 +1,80 @@
---
title: 'Enhanced Dev Story Definition of Done Checklist'
validation-target: 'Story markdown ({{story_path}})'
validation-criticality: 'HIGHEST'
required-inputs:
- 'Story markdown file with enhanced Dev Notes containing comprehensive implementation context'
- 'Completed Tasks/Subtasks section with all items marked [x]'
- 'Updated File List section with all changed files'
- 'Updated Dev Agent Record with implementation notes'
optional-inputs:
- 'Test results output'
- 'CI logs'
- 'Linting reports'
validation-rules:
- 'Only permitted story sections modified: Tasks/Subtasks checkboxes, Dev Agent Record, File List, Change Log, Status'
- 'All implementation requirements from story Dev Notes must be satisfied'
- 'Definition of Done checklist must pass completely'
- 'Enhanced story context must contain sufficient technical guidance'
---
# 🎯 Enhanced Definition of Done Checklist
**Critical validation:** Story is truly ready for review only when ALL items below are satisfied
## 📋 Context & Requirements Validation
- [ ] **Story Context Completeness:** Dev Notes contains ALL necessary technical requirements, architecture patterns, and implementation guidance
- [ ] **Architecture Compliance:** Implementation follows all architectural requirements specified in Dev Notes
- [ ] **Technical Specifications:** All technical specifications (libraries, frameworks, versions) from Dev Notes are implemented correctly
- [ ] **Previous Story Learnings:** Previous story insights incorporated (if applicable) and build upon appropriately
## ✅ Implementation Completion
- [ ] **All Tasks Complete:** Every task and subtask marked complete with [x]
- [ ] **Acceptance Criteria Satisfaction:** Implementation satisfies EVERY Acceptance Criterion in the story
- [ ] **No Ambiguous Implementation:** Clear, unambiguous implementation that meets story requirements
- [ ] **Edge Cases Handled:** Error conditions and edge cases appropriately addressed
- [ ] **Dependencies Within Scope:** Only uses dependencies specified in story or project-context.md
## 🧪 Testing & Quality Assurance
- [ ] **Unit Tests:** Unit tests added/updated for ALL core functionality introduced/changed by this story
- [ ] **Integration Tests:** Integration tests added/updated for component interactions when story requirements demand them
- [ ] **End-to-End Tests:** End-to-end tests created for critical user flows when story requirements specify them
- [ ] **Test Coverage:** Tests cover acceptance criteria and edge cases from story Dev Notes
- [ ] **Regression Prevention:** ALL existing tests pass (no regressions introduced)
- [ ] **Code Quality:** Linting and static checks pass when configured in project
- [ ] **Test Framework Compliance:** Tests use project's testing frameworks and patterns from Dev Notes
## 📝 Documentation & Tracking
- [ ] **File List Complete:** File List includes EVERY new, modified, or deleted file (paths relative to repo root)
- [ ] **Dev Agent Record Updated:** Contains relevant Implementation Notes and/or Debug Log for this work
- [ ] **Change Log Updated:** Change Log includes clear summary of what changed and why
- [ ] **Review Follow-ups:** All review follow-up tasks (marked [AI-Review]) completed and corresponding review items marked resolved (if applicable)
- [ ] **Story Structure Compliance:** Only permitted sections of story file were modified
## 🔚 Final Status Verification
- [ ] **Story Status Updated:** Story Status set to "review"
- [ ] **Sprint Status Updated:** Sprint status updated to "review" (when sprint tracking is used)
- [ ] **Quality Gates Passed:** All quality checks and validations completed successfully
- [ ] **No HALT Conditions:** No blocking issues or incomplete work remaining
- [ ] **User Communication Ready:** Implementation summary prepared for user review
## 🎯 Final Validation Output
```
Definition of Done: {{PASS/FAIL}}
**Story Ready for Review:** {{story_key}}
📊 **Completion Score:** {{completed_items}}/{{total_items}} items passed
🔍 **Quality Gates:** {{quality_gates_status}}
📋 **Test Results:** {{test_results_summary}}
📝 **Documentation:** {{documentation_status}}
```
**If FAIL:** List specific failures and required actions before story can be marked Ready for Review
**If PASS:** Story is fully ready for code review and production consideration

View File

@ -0,0 +1,410 @@
<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>Only modify the story file in these areas: Tasks/Subtasks checkboxes, Dev Agent Record (Debug Log, Completion Notes), File List,
Change Log, and Status</critical>
<critical>Execute ALL steps in exact order; do NOT skip steps</critical>
<critical>Absolutely DO NOT stop because of "milestones", "significant progress", or "session boundaries". Continue in a single execution
until the story is COMPLETE (all ACs satisfied and all tasks/subtasks checked) UNLESS a HALT condition is triggered or the USER gives
other instruction.</critical>
<critical>Do NOT schedule a "next session" or request review pauses unless a HALT condition applies. Only Step 6 decides completion.</critical>
<critical>User skill level ({user_skill_level}) affects conversation style ONLY, not code updates.</critical>
<step n="1" goal="Find next ready story and load it" tag="sprint-status">
<check if="{{story_path}} is provided">
<action>Use {{story_path}} directly</action>
<action>Read COMPLETE story file</action>
<action>Extract story_key from filename or metadata</action>
<goto anchor="task_check" />
</check>
<!-- Sprint-based story discovery -->
<check if="{{sprint_status}} file exists">
<critical>MUST read COMPLETE sprint-status.yaml 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 to understand story order</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 "ready-for-dev"
</action>
<check if="no ready-for-dev or in-progress story found">
<output>📋 No ready-for-dev stories found in sprint-status.yaml
**Current Sprint Status:** {{sprint_status_summary}}
**What would you like to do?**
1. Run `create-story` to create next story from epics with comprehensive context
2. Run `*validate-create-story` to improve existing stories before development (recommended quality check)
3. Specify a particular story file to develop (provide full path)
4. Check {{sprint_status}} file to see current sprint status
💡 **Tip:** Stories in `ready-for-dev` may not have been validated. Consider running `validate-create-story` first for a quality
check.
</output>
<ask>Choose option [1], [2], [3], or [4], or specify story file path:</ask>
<check if="user chooses '1'">
<action>HALT - Run create-story to create next story</action>
</check>
<check if="user chooses '2'">
<action>HALT - Run validate-create-story to improve existing stories</action>
</check>
<check if="user chooses '3'">
<ask>Provide the story file path to develop:</ask>
<action>Store user-provided story path as {{story_path}}</action>
<goto anchor="task_check" />
</check>
<check if="user chooses '4'">
<output>Loading {{sprint_status}} for detailed status review...</output>
<action>Display detailed sprint status analysis</action>
<action>HALT - User can review sprint status and provide story path</action>
</check>
<check if="user provides story file path">
<action>Store user-provided story path as {{story_path}}</action>
<goto anchor="task_check" />
</check>
</check>
</check>
<!-- Non-sprint story discovery -->
<check if="{{sprint_status}} file does NOT exist">
<action>Search {story_dir} for stories directly</action>
<action>Find stories with "ready-for-dev" status in files</action>
<action>Look for story files matching pattern: *-*-*.md</action>
<action>Read each candidate story file to check Status section</action>
<check if="no ready-for-dev stories found in story files">
<output>📋 No ready-for-dev stories found
**Available Options:**
1. Run `create-story` to create next story from epics with comprehensive context
2. Run `*validate-create-story` to improve existing stories
3. Specify which story to develop
</output>
<ask>What would you like to do? Choose option [1], [2], or [3]:</ask>
<check if="user chooses '1'">
<action>HALT - Run create-story to create next story</action>
</check>
<check if="user chooses '2'">
<action>HALT - Run validate-create-story to improve existing stories</action>
</check>
<check if="user chooses '3'">
<ask>It's unclear what story you want developed. Please provide the full path to the story file:</ask>
<action>Store user-provided story path as {{story_path}}</action>
<action>Continue with provided story file</action>
</check>
</check>
<check if="ready-for-dev story found in files">
<action>Use discovered story file and extract story_key</action>
</check>
</check>
<action>Store the found story_key (e.g., "1-2-user-authentication") for later status updates</action>
<action>Find matching story file in {story_dir} using story_key pattern: {{story_key}}.md</action>
<action>Read COMPLETE story file from discovered path</action>
<anchor id="task_check" />
<action>Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Dev Agent Record, File List, Change Log, Status</action>
<action>Load comprehensive context from story file's Dev Notes section</action>
<action>Extract developer guidance from Dev Notes: architecture requirements, previous learnings, technical specifications</action>
<action>Use enhanced story context to inform implementation decisions and approaches</action>
<action>Identify first incomplete task (unchecked [ ]) in Tasks/Subtasks</action>
<action if="no incomplete tasks">
<goto step="6">Completion sequence</goto>
</action>
<action if="story file inaccessible">HALT: "Cannot develop story without access to story file"</action>
<action if="incomplete task or subtask requirements ambiguous">ASK user to clarify or HALT</action>
</step>
<step n="2" goal="Load project context and story information">
<critical>Load all available context to inform implementation</critical>
<action>Load {project_context} for coding standards and project-wide patterns (if exists)</action>
<action>Parse sections: Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Dev Agent Record, File List, Change Log, Status</action>
<action>Load comprehensive context from story file's Dev Notes section</action>
<action>Extract developer guidance from Dev Notes: architecture requirements, previous learnings, technical specifications</action>
<action>Use enhanced story context to inform implementation decisions and approaches</action>
<output>✅ **Context Loaded**
Story and project context available for implementation
</output>
</step>
<step n="3" goal="Detect review continuation and extract review context">
<critical>Determine if this is a fresh start or continuation after code review</critical>
<action>Check if "Senior Developer Review (AI)" section exists in the story file</action>
<action>Check if "Review Follow-ups (AI)" subsection exists under Tasks/Subtasks</action>
<check if="Senior Developer Review section exists">
<action>Set review_continuation = true</action>
<action>Extract from "Senior Developer Review (AI)" section:
- Review outcome (Approve/Changes Requested/Blocked)
- Review date
- Total action items with checkboxes (count checked vs unchecked)
- Severity breakdown (High/Med/Low counts)
</action>
<action>Count unchecked [ ] review follow-up tasks in "Review Follow-ups (AI)" subsection</action>
<action>Store list of unchecked review items as {{pending_review_items}}</action>
<output>⏯️ **Resuming Story After Code Review** ({{review_date}})
**Review Outcome:** {{review_outcome}}
**Action Items:** {{unchecked_review_count}} remaining to address
**Priorities:** {{high_count}} High, {{med_count}} Medium, {{low_count}} Low
**Strategy:** Will prioritize review follow-up tasks (marked [AI-Review]) before continuing with regular tasks.
</output>
</check>
<check if="Senior Developer Review section does NOT exist">
<action>Set review_continuation = false</action>
<action>Set {{pending_review_items}} = empty</action>
<output>🚀 **Starting Fresh Implementation**
Story: {{story_key}}
Story Status: {{current_status}}
First incomplete task: {{first_task_description}}
</output>
</check>
</step>
<step n="4" goal="Mark story in-progress" tag="sprint-status">
<check if="{{sprint_status}} file exists">
<action>Load the FULL file: {{sprint_status}}</action>
<action>Read all development_status entries to find {{story_key}}</action>
<action>Get current status value for development_status[{{story_key}}]</action>
<check if="current status == 'ready-for-dev' OR review_continuation == true">
<action>Update the story in the sprint status report to = "in-progress"</action>
<output>🚀 Starting work on story {{story_key}}
Status updated: ready-for-dev → in-progress
</output>
</check>
<check if="current status == 'in-progress'">
<output>⏯️ Resuming work on story {{story_key}}
Story is already marked in-progress
</output>
</check>
<check if="current status is neither ready-for-dev nor in-progress">
<output>⚠️ Unexpected story status: {{current_status}}
Expected ready-for-dev or in-progress. Continuing anyway...
</output>
</check>
<action>Store {{current_sprint_status}} for later use</action>
</check>
<check if="{{sprint_status}} file does NOT exist">
<output> No sprint status file exists - story progress will be tracked in story file only</output>
<action>Set {{current_sprint_status}} = "no-sprint-tracking"</action>
</check>
</step>
<step n="5" goal="Implement task following red-green-refactor cycle">
<critical>FOLLOW THE STORY FILE TASKS/SUBTASKS SEQUENCE EXACTLY AS WRITTEN - NO DEVIATION</critical>
<action>Review the current task/subtask from the story file - this is your authoritative implementation guide</action>
<action>Plan implementation following red-green-refactor cycle</action>
<!-- RED PHASE -->
<action>Write FAILING tests first for the task/subtask functionality</action>
<action>Confirm tests fail before implementation - this validates test correctness</action>
<!-- GREEN PHASE -->
<action>Implement MINIMAL code to make tests pass</action>
<action>Run tests to confirm they now pass</action>
<action>Handle error conditions and edge cases as specified in task/subtask</action>
<!-- REFACTOR PHASE -->
<action>Improve code structure while keeping tests green</action>
<action>Ensure code follows architecture patterns and coding standards from Dev Notes</action>
<action>Document technical approach and decisions in Dev Agent Record → Implementation Plan</action>
<action if="new dependencies required beyond story specifications">HALT: "Additional dependencies need user approval"</action>
<action if="3 consecutive implementation failures occur">HALT and request guidance</action>
<action if="required configuration is missing">HALT: "Cannot proceed without necessary configuration files"</action>
<critical>NEVER implement anything not mapped to a specific task/subtask in the story file</critical>
<critical>NEVER proceed to next task until current task/subtask is complete AND tests pass</critical>
<critical>Execute continuously without pausing until all tasks/subtasks are complete or explicit HALT condition</critical>
<critical>Do NOT propose to pause for review until Step 9 completion gates are satisfied</critical>
</step>
<step n="6" goal="Author comprehensive tests">
<action>Create unit tests for business logic and core functionality introduced/changed by the task</action>
<action>Add integration tests for component interactions specified in story requirements</action>
<action>Include end-to-end tests for critical user flows when story requirements demand them</action>
<action>Cover edge cases and error handling scenarios identified in story Dev Notes</action>
</step>
<step n="7" goal="Run validations and tests">
<action>Determine how to run tests for this repo (infer test framework from project structure)</action>
<action>Run all existing tests to ensure no regressions</action>
<action>Run the new tests to verify implementation correctness</action>
<action>Run linting and code quality checks if configured in project</action>
<action>Validate implementation meets ALL story acceptance criteria; enforce quantitative thresholds explicitly</action>
<action if="regression tests fail">STOP and fix before continuing - identify breaking changes immediately</action>
<action if="new tests fail">STOP and fix before continuing - ensure implementation correctness</action>
</step>
<step n="8" goal="Validate and mark task complete ONLY when fully done">
<critical>NEVER mark a task complete unless ALL conditions are met - NO LYING OR CHEATING</critical>
<!-- VALIDATION GATES -->
<action>Verify ALL tests for this task/subtask ACTUALLY EXIST and PASS 100%</action>
<action>Confirm implementation matches EXACTLY what the task/subtask specifies - no extra features</action>
<action>Validate that ALL acceptance criteria related to this task are satisfied</action>
<action>Run full test suite to ensure NO regressions introduced</action>
<!-- REVIEW FOLLOW-UP HANDLING -->
<check if="task is review follow-up (has [AI-Review] prefix)">
<action>Extract review item details (severity, description, related AC/file)</action>
<action>Add to resolution tracking list: {{resolved_review_items}}</action>
<!-- Mark task in Review Follow-ups section -->
<action>Mark task checkbox [x] in "Tasks/Subtasks → Review Follow-ups (AI)" section</action>
<!-- CRITICAL: Also mark corresponding action item in review section -->
<action>Find matching action item in "Senior Developer Review (AI) → Action Items" section by matching description</action>
<action>Mark that action item checkbox [x] as resolved</action>
<action>Add to Dev Agent Record → Completion Notes: "✅ Resolved review finding [{{severity}}]: {{description}}"</action>
</check>
<!-- ONLY MARK COMPLETE IF ALL VALIDATION PASS -->
<check if="ALL validation gates pass AND tests ACTUALLY exist and pass">
<action>ONLY THEN mark the task (and subtasks) checkbox with [x]</action>
<action>Update File List section with ALL new, modified, or deleted files (paths relative to repo root)</action>
<action>Add completion notes to Dev Agent Record summarizing what was ACTUALLY implemented and tested</action>
</check>
<check if="ANY validation fails">
<action>DO NOT mark task complete - fix issues first</action>
<action>HALT if unable to fix validation failures</action>
</check>
<check if="review_continuation == true and {{resolved_review_items}} is not empty">
<action>Count total resolved review items in this session</action>
<action>Add Change Log entry: "Addressed code review findings - {{resolved_count}} items resolved (Date: {{date}})"</action>
</check>
<action>Save the story file</action>
<action>Determine if more incomplete tasks remain</action>
<action if="more tasks remain">
<goto step="5">Next task</goto>
</action>
<action if="no tasks remain">
<goto step="9">Completion</goto>
</action>
</step>
<step n="9" goal="Story completion and mark for review" tag="sprint-status">
<action>Verify ALL tasks and subtasks are marked [x] (re-scan the story document now)</action>
<action>Run the full regression suite (do not skip)</action>
<action>Confirm File List includes every changed file</action>
<action>Execute enhanced definition-of-done validation</action>
<action>Update the story Status to: "review"</action>
<!-- Enhanced Definition of Done Validation -->
<action>Validate definition-of-done checklist with essential requirements:
- All tasks/subtasks marked complete with [x]
- Implementation satisfies every Acceptance Criterion
- Unit tests for core functionality added/updated
- Integration tests for component interactions added when required
- End-to-end tests for critical flows added when story demands them
- All tests pass (no regressions, new tests successful)
- Code quality checks pass (linting, static analysis if configured)
- File List includes every new/modified/deleted file (relative paths)
- Dev Agent Record contains implementation notes
- Change Log includes summary of changes
- Only permitted story sections were modified
</action>
<!-- Mark story ready for review - sprint status conditional -->
<check if="{sprint_status} file exists AND {{current_sprint_status}} != 'no-sprint-tracking'">
<action>Load the FULL file: {sprint_status}</action>
<action>Find development_status key matching {{story_key}}</action>
<action>Verify current status is "in-progress" (expected previous state)</action>
<action>Update development_status[{{story_key}}] = "review"</action>
<action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
<output>✅ Story status updated to "review" in sprint-status.yaml</output>
</check>
<check if="{sprint_status} file does NOT exist OR {{current_sprint_status}} == 'no-sprint-tracking'">
<output> Story status updated to "review" in story file (no sprint tracking configured)</output>
</check>
<check if="story key not found in sprint status">
<output>⚠️ Story file updated, but sprint-status update failed: {{story_key}} not found
Story status is set to "review" in file, but sprint-status.yaml may be out of sync.
</output>
</check>
<!-- Final validation gates -->
<action if="any task is incomplete">HALT - Complete remaining tasks before marking ready for review</action>
<action if="regression failures exist">HALT - Fix regression issues before completing</action>
<action if="File List is incomplete">HALT - Update File List with all changed files</action>
<action if="definition-of-done validation fails">HALT - Address DoD failures before completing</action>
</step>
<step n="10" goal="Completion communication and user support">
<action>Execute the enhanced definition-of-done checklist using the validation framework</action>
<action>Prepare a concise summary in Dev Agent Record → Completion Notes</action>
<action>Communicate to {user_name} that story implementation is complete and ready for review</action>
<action>Summarize key accomplishments: story ID, story key, title, key changes made, tests added, files modified</action>
<action>Provide the story file path and current status (now "review")</action>
<action>Based on {user_skill_level}, ask if user needs any explanations about:
- What was implemented and how it works
- Why certain technical decisions were made
- How to test or verify the changes
- Any patterns, libraries, or approaches used
- Anything else they'd like clarified
</action>
<check if="user asks for explanations">
<action>Provide clear, contextual explanations tailored to {user_skill_level}</action>
<action>Use examples and references to specific code when helpful</action>
</check>
<action>Once explanations are complete (or user indicates no questions), suggest logical next steps</action>
<action>Recommended next steps (flexible based on project setup):
- Review the implemented story and test the changes
- Verify all acceptance criteria are met
- Ensure deployment readiness if applicable
- Run `code-review` workflow for peer review
- Optional: Run TEA `*automate` to expand guardrail tests
</action>
<output>💡 **Tip:** For best results, run `code-review` using a **different** LLM than the one that implemented this story.</output>
<check if="{sprint_status} file exists">
<action>Suggest checking {sprint_status} to see project progress</action>
</check>
<action>Remain flexible - allow user to choose their own path or ask for other assistance</action>
</step>
</workflow>

View File

@ -1,9 +1,9 @@
name: super-dev-story name: dev-story
description: "Enhanced story development with post-implementation validation and automated code review - ensures stories are truly complete before marking done" description: "Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria"
author: "BMad" author: "BMad"
# Critical variables from config # Critical variables from config
config_source: "{project-root}/_bmad/bmgd/config.yaml" config_source: "{project-root}/_bmad/bmm/config.yaml"
output_folder: "{config_source}:output_folder" output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name" user_name: "{config_source}:user_name"
communication_language: "{config_source}:communication_language" communication_language: "{config_source}:communication_language"
@ -13,7 +13,7 @@ story_dir: "{config_source}:implementation_artifacts"
date: system-generated date: system-generated
# Workflow components # Workflow components
installed_path: "{project-root}/_bmad/bmgd/workflows/4-production/super-dev-story" installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/dev-story"
instructions: "{installed_path}/instructions.xml" instructions: "{installed_path}/instructions.xml"
validation: "{installed_path}/checklist.md" validation: "{installed_path}/checklist.md"
@ -22,13 +22,6 @@ implementation_artifacts: "{config_source}:implementation_artifacts"
sprint_status: "{implementation_artifacts}/sprint-status.yaml" sprint_status: "{implementation_artifacts}/sprint-status.yaml"
project_context: "**/project-context.md" project_context: "**/project-context.md"
# Super-dev specific settings
super_dev_settings:
post_dev_gap_analysis: true
auto_code_review: true
fail_on_critical_issues: true
max_fix_iterations: 3
standalone: true standalone: true
web_bundle: false web_bundle: false

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,58 @@
# Retrospective - Epic Completion Review Workflow
name: "retrospective"
description: "Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic"
author: "BMad"
config_source: "{project-root}/_bmad/bmm/config.yaml"
output_folder: "{config_source}:implementation_artifacts}"
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"
installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/retrospective"
template: false
instructions: "{installed_path}/instructions.md"
required_inputs:
- agent_manifest: "{project-root}/_bmad/_config/agent-manifest.csv"
# Smart input file references - handles both whole docs and sharded docs
# Priority: Whole document first, then sharded version
# Strategy: SELECTIVE LOAD - only load the completed epic and relevant retrospectives
input_file_patterns:
epics:
description: "The completed epic for retrospective"
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"
previous_retrospective:
description: "Previous epic's retrospective (optional)"
pattern: "{implementation_artifacts}/**/epic-{{prev_epic_num}}-retro-*.md"
load_strategy: "SELECTIVE_LOAD"
architecture:
description: "System architecture for context"
whole: "{planning_artifacts}/*architecture*.md"
sharded: "{planning_artifacts}/*architecture*/*.md"
load_strategy: "FULL_LOAD"
prd:
description: "Product requirements for context"
whole: "{planning_artifacts}/*prd*.md"
sharded: "{planning_artifacts}/*prd*/*.md"
load_strategy: "FULL_LOAD"
document_project:
description: "Brownfield project documentation (optional)"
sharded: "{planning_artifacts}/*.md"
load_strategy: "INDEX_GUIDED"
# Required files
sprint_status_file: "{implementation_artifacts}/sprint-status.yaml"
story_directory: "{implementation_artifacts}"
retrospectives_folder: "{implementation_artifacts}"
standalone: true
web_bundle: false

View File

@ -0,0 +1,33 @@
# Sprint Planning Validation Checklist
## Core Validation
### Complete Coverage Check
- [ ] Every epic found in epic\*.md files appears in sprint-status.yaml
- [ ] Every story found in epic\*.md files appears in sprint-status.yaml
- [ ] Every epic has a corresponding retrospective entry
- [ ] No items in sprint-status.yaml that don't exist in epic files
### Parsing Verification
Compare epic files against generated sprint-status.yaml:
```
Epic Files Contains: Sprint Status Contains:
✓ Epic 1 ✓ epic-1: [status]
✓ Story 1.1: User Auth ✓ 1-1-user-auth: [status]
✓ Story 1.2: Account Mgmt ✓ 1-2-account-mgmt: [status]
✓ Story 1.3: Plant Naming ✓ 1-3-plant-naming: [status]
✓ epic-1-retrospective: [status]
✓ Epic 2 ✓ epic-2: [status]
✓ Story 2.1: Personality Model ✓ 2-1-personality-model: [status]
✓ Story 2.2: Chat Interface ✓ 2-2-chat-interface: [status]
✓ epic-2-retrospective: [status]
```
### Final Check
- [ ] Total count of epics matches
- [ ] Total count of stories matches
- [ ] All items are in the expected order (epic, stories, retrospective)

View File

@ -0,0 +1,225 @@
# Sprint Planning - Sprint Status Generator
<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/sprint-planning/workflow.yaml</critical>
## 📚 Document Discovery - Full Epic Loading
**Strategy**: Sprint planning needs ALL epics and stories to build complete status tracking.
**Epic Discovery Process:**
1. **Search for whole document first** - Look for `epics.md`, `bmm-epics.md`, or any `*epic*.md` file
2. **Check for sharded version** - If whole document not found, look for `epics/index.md`
3. **If sharded version found**:
- Read `index.md` to understand the document structure
- Read ALL epic section files listed in the index (e.g., `epic-1.md`, `epic-2.md`, etc.)
- Process all epics and their stories from the combined content
- This ensures complete sprint status coverage
4. **Priority**: If both whole and sharded versions exist, use the whole document
**Fuzzy matching**: Be flexible with document names - users may use variations like `epics.md`, `bmm-epics.md`, `user-stories.md`, etc.
<workflow>
<step n="1" goal="Parse epic files and extract all work items">
<action>Communicate in {communication_language} with {user_name}</action>
<action>Look for all files matching `{epics_pattern}` in {epics_location}</action>
<action>Could be a single `epics.md` file or multiple `epic-1.md`, `epic-2.md` files</action>
<action>For each epic file found, extract:</action>
- Epic numbers from headers like `## Epic 1:` or `## Epic 2:`
- Story IDs and titles from patterns like `### Story 1.1: User Authentication`
- Convert story format from `Epic.Story: Title` to kebab-case key: `epic-story-title`
**Story ID Conversion Rules:**
- Original: `### Story 1.1: User Authentication`
- Replace period with dash: `1-1`
- Convert title to kebab-case: `user-authentication`
- Final key: `1-1-user-authentication`
<action>Build complete inventory of all epics and stories from all epic files</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: {epics_content} (all epics loaded - uses FULL_LOAD strategy)</note>
</step>
<step n="2" goal="Build sprint status structure">
<action>For each epic found, create entries in this order:</action>
1. **Epic entry** - Key: `epic-{num}`, Default status: `backlog`
2. **Story entries** - Key: `{epic}-{story}-{title}`, Default status: `backlog`
3. **Retrospective entry** - Key: `epic-{num}-retrospective`, Default status: `optional`
**Example structure:**
```yaml
development_status:
epic-1: backlog
1-1-user-authentication: backlog
1-2-account-management: backlog
epic-1-retrospective: optional
```
</step>
<step n="3" goal="Apply intelligent status detection">
<action>For each story, detect current status by checking files:</action>
**Story file detection:**
- Check: `{story_location_absolute}/{story-key}.md` (e.g., `stories/1-1-user-authentication.md`)
- If exists → upgrade status to at least `ready-for-dev`
**Preservation rule:**
- If existing `{status_file}` exists and has more advanced status, preserve it
- Never downgrade status (e.g., don't change `done` to `ready-for-dev`)
**Status Flow Reference:**
- Epic: `backlog``in-progress``done`
- Story: `backlog``ready-for-dev``in-progress``review``done`
- Retrospective: `optional``done`
</step>
<step n="4" goal="Generate sprint status file">
<action>Create or update {status_file} with:</action>
**File Structure:**
```yaml
# generated: {date}
# project: {project_name}
# project_key: {project_key}
# tracking_system: {tracking_system}
# story_location: {story_location}
# STATUS DEFINITIONS:
# ==================
# Epic Status:
# - backlog: Epic not yet started
# - in-progress: Epic actively being worked on
# - done: All stories in epic completed
#
# Epic Status Transitions:
# - backlog → in-progress: Automatically when first story is created (via create-story)
# - in-progress → done: Manually when all stories reach 'done' status
#
# Story Status:
# - backlog: Story only exists in epic file
# - ready-for-dev: Story file created in stories folder
# - in-progress: Developer actively working on implementation
# - review: Ready for code review (via Dev's code-review workflow)
# - done: Story completed
#
# Retrospective Status:
# - optional: Can be completed but not required
# - done: Retrospective has been completed
#
# WORKFLOW NOTES:
# ===============
# - Epic transitions to 'in-progress' automatically when first story is created
# - Stories can be worked in parallel if team capacity allows
# - SM typically creates next story after previous one is 'done' to incorporate learnings
# - Dev moves story to 'review', then runs code-review (fresh context, different LLM recommended)
generated: { date }
project: { project_name }
project_key: { project_key }
tracking_system: { tracking_system }
story_location: { story_location }
development_status:
# All epics, stories, and retrospectives in order
```
<action>Write the complete sprint status YAML to {status_file}</action>
<action>CRITICAL: Metadata appears TWICE - once as comments (#) for documentation, once as YAML key:value fields for parsing</action>
<action>Ensure all items are ordered: epic, its stories, its retrospective, next epic...</action>
</step>
<step n="5" goal="Validate and report">
<action>Perform validation checks:</action>
- [ ] Every epic in epic files appears in {status_file}
- [ ] Every story in epic files appears in {status_file}
- [ ] Every epic has a corresponding retrospective entry
- [ ] No items in {status_file} that don't exist in epic files
- [ ] All status values are legal (match state machine definitions)
- [ ] File is valid YAML syntax
<action>Count totals:</action>
- Total epics: {{epic_count}}
- Total stories: {{story_count}}
- Epics in-progress: {{in_progress_count}}
- Stories done: {{done_count}}
<action>Display completion summary to {user_name} in {communication_language}:</action>
**Sprint Status Generated Successfully**
- **File Location:** {status_file}
- **Total Epics:** {{epic_count}}
- **Total Stories:** {{story_count}}
- **Epics In Progress:** {{epics_in_progress_count}}
- **Stories Completed:** {{done_count}}
**Next Steps:**
1. Review the generated {status_file}
2. Use this file to track development progress
3. Agents will update statuses as they work
4. Re-run this workflow to refresh auto-detected statuses
</step>
</workflow>
## Additional Documentation
### Status State Machine
**Epic Status Flow:**
```
backlog → in-progress → done
```
- **backlog**: Epic not yet started
- **in-progress**: Epic actively being worked on (stories being created/implemented)
- **done**: All stories in epic completed
**Story Status Flow:**
```
backlog → ready-for-dev → in-progress → review → done
```
- **backlog**: Story only exists in epic file
- **ready-for-dev**: Story file created (e.g., `stories/1-3-plant-naming.md`)
- **in-progress**: Developer actively working
- **review**: Ready for code review (via Dev's code-review workflow)
- **done**: Completed
**Retrospective Status:**
```
optional ↔ done
```
- **optional**: Ready to be conducted but not required
- **done**: Finished
### Guidelines
1. **Epic Activation**: Mark epic as `in-progress` when starting work on its first story
2. **Sequential Default**: Stories are typically worked in order, but parallel work is supported
3. **Parallel Work Supported**: Multiple stories can be `in-progress` if team capacity allows
4. **Review Before Done**: Stories should pass through `review` before `done`
5. **Learning Transfer**: SM typically creates next story after previous one is `done` to incorporate learnings

View File

@ -0,0 +1,55 @@
# Sprint Status Template
# This is an EXAMPLE showing the expected format
# The actual file will be generated with all epics/stories from your epic files
# generated: {date}
# project: {project_name}
# project_key: {project_key}
# tracking_system: {tracking_system}
# story_location: {story_location}
# STATUS DEFINITIONS:
# ==================
# Epic Status:
# - backlog: Epic not yet started
# - in-progress: Epic actively being worked on
# - done: All stories in epic completed
#
# Story Status:
# - backlog: Story only exists in epic file
# - ready-for-dev: Story file created, ready for development
# - in-progress: Developer actively working on implementation
# - review: Implementation complete, ready for review
# - done: Story completed
#
# Retrospective Status:
# - optional: Can be completed but not required
# - done: Retrospective has been completed
#
# WORKFLOW NOTES:
# ===============
# - Mark epic as 'in-progress' when starting work on its first story
# - SM typically creates next story ONLY after previous one is 'done' to incorporate learnings
# - Dev moves story to 'review', then Dev runs code-review (fresh context, ideally different LLM)
# EXAMPLE STRUCTURE (your actual epics/stories will replace these):
generated: 05-06-2-2025 21:30
project: My Awesome Project
project_key: jira-1234
tracking_system: file-system
story_location: "{story_location}"
development_status:
epic-1: backlog
1-1-user-authentication: done
1-2-account-management: ready-for-dev
1-3-plant-data-model: backlog
1-4-add-plant-manual: backlog
epic-1-retrospective: optional
epic-2: backlog
2-1-personality-system: backlog
2-2-chat-interface: backlog
2-3-llm-integration: backlog
epic-2-retrospective: optional

View File

@ -0,0 +1,54 @@
name: sprint-planning
description: "Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle"
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
implementation_artifacts: "{config_source}:implementation_artifacts"
planning_artifacts: "{config_source}:planning_artifacts"
output_folder: "{implementation_artifacts}"
# Workflow components
installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning"
instructions: "{installed_path}/instructions.md"
template: "{installed_path}/sprint-status-template.yaml"
validation: "{installed_path}/checklist.md"
# Variables and inputs
variables:
# Project context
project_context: "**/project-context.md"
# Project identification
project_name: "{config_source}:project_name"
# Tracking system configuration
tracking_system: "file-system" # Options: file-system, Future will support other options from config of mcp such as jira, linear, trello
story_location: "{config_source}:implementation_artifacts" # Relative path for file-system, Future will support URL for Jira/Linear/Trello
story_location_absolute: "{config_source}:implementation_artifacts" # Absolute path for file operations
# Source files (file-system only)
epics_location: "{planning_artifacts}" # Directory containing epic*.md files
epics_pattern: "epic*.md" # Pattern to find epic files
# Output configuration
status_file: "{implementation_artifacts}/sprint-status.yaml"
# Smart input file references - handles both whole docs and sharded docs
# Priority: Whole document first, then sharded version
# Strategy: FULL LOAD - sprint planning needs ALL epics to build complete status
input_file_patterns:
epics:
description: "All epics with user stories"
whole: "{output_folder}/*epic*.md"
sharded: "{output_folder}/*epic*/*.md"
load_strategy: "FULL_LOAD"
# Output configuration
default_output_file: "{status_file}"
standalone: true
web_bundle: false

View File

@ -0,0 +1,229 @@
# Sprint Status - Multi-Mode Service
<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/sprint-status/workflow.yaml</critical>
<critical>Modes: interactive (default), validate, data</critical>
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES. Do NOT mention hours, days, weeks, or timelines.</critical>
<workflow>
<step n="0" goal="Determine execution mode">
<action>Set mode = {{mode}} if provided by caller; otherwise mode = "interactive"</action>
<check if="mode == data">
<action>Jump to Step 20</action>
</check>
<check if="mode == validate">
<action>Jump to Step 30</action>
</check>
<check if="mode == interactive">
<action>Continue to Step 1</action>
</check>
</step>
<step n="1" goal="Locate sprint status file">
<action>Try {sprint_status_file}</action>
<check if="file not found">
<output>❌ sprint-status.yaml not found.
Run `/bmad:bmm:workflows:sprint-planning` to generate it, then rerun sprint-status.</output>
<action>Exit workflow</action>
</check>
<action>Continue to Step 2</action>
</step>
<step n="2" goal="Read and parse sprint-status.yaml">
<action>Read the FULL file: {sprint_status_file}</action>
<action>Parse fields: generated, project, project_key, tracking_system, story_location</action>
<action>Parse development_status map. Classify keys:</action>
- Epics: keys starting with "epic-" (and not ending with "-retrospective")
- Retrospectives: keys ending with "-retrospective"
- Stories: everything else (e.g., 1-2-login-form)
<action>Map legacy story status "drafted" → "ready-for-dev"</action>
<action>Count story statuses: backlog, ready-for-dev, in-progress, review, done</action>
<action>Map legacy epic status "contexted" → "in-progress"</action>
<action>Count epic statuses: backlog, in-progress, done</action>
<action>Count retrospective statuses: optional, done</action>
<action>Validate all statuses against known values:</action>
- Valid story statuses: backlog, ready-for-dev, in-progress, review, done, drafted (legacy)
- Valid epic statuses: backlog, in-progress, done, contexted (legacy)
- Valid retrospective statuses: optional, done
<check if="any status is unrecognized">
<output>
⚠️ **Unknown status detected:**
{{#each invalid_entries}}
- `{{key}}`: "{{status}}" (not recognized)
{{/each}}
**Valid statuses:**
- Stories: backlog, ready-for-dev, in-progress, review, done
- Epics: backlog, in-progress, done
- Retrospectives: optional, done
</output>
<ask>How should these be corrected?
{{#each invalid_entries}}
{{@index}}. {{key}}: "{{status}}" → [select valid status]
{{/each}}
Enter corrections (e.g., "1=in-progress, 2=backlog") or "skip" to continue without fixing:</ask>
<check if="user provided corrections">
<action>Update sprint-status.yaml with corrected values</action>
<action>Re-parse the file with corrected statuses</action>
</check>
</check>
<action>Detect risks:</action>
- IF any story has status "review": suggest `/bmad:bmm:workflows:code-review`
- IF any story has status "in-progress" AND no stories have status "ready-for-dev": recommend staying focused on active story
- IF all epics have status "backlog" AND no stories have status "ready-for-dev": prompt `/bmad:bmm:workflows:create-story`
- IF `generated` timestamp is more than 7 days old: warn "sprint-status.yaml may be stale"
- IF any story key doesn't match an epic pattern (e.g., story "5-1-..." but no "epic-5"): warn "orphaned story detected"
- IF any epic has status in-progress but has no associated stories: warn "in-progress epic has no stories"
</step>
<step n="3" goal="Select next action recommendation">
<action>Pick the next recommended workflow using priority:</action>
<note>When selecting "first" story: sort by epic number, then story number (e.g., 1-1 before 1-2 before 2-1)</note>
1. If any story status == in-progress → recommend `dev-story` for the first in-progress story
2. Else if any story status == review → recommend `code-review` for the first review story
3. Else if any story status == ready-for-dev → recommend `dev-story`
4. Else if any story status == backlog → recommend `create-story`
5. Else if any retrospective status == optional → recommend `retrospective`
6. Else → All implementation items done; congratulate the user - you both did amazing work together!
<action>Store selected recommendation as: next_story_id, next_workflow_id, next_agent (SM/DEV as appropriate)</action>
</step>
<step n="4" goal="Display summary">
<output>
## 📊 Sprint Status
- Project: {{project}} ({{project_key}})
- Tracking: {{tracking_system}}
- Status file: {sprint_status_file}
**Stories:** backlog {{count_backlog}}, ready-for-dev {{count_ready}}, in-progress {{count_in_progress}}, review {{count_review}}, done {{count_done}}
**Epics:** backlog {{epic_backlog}}, in-progress {{epic_in_progress}}, done {{epic_done}}
**Next Recommendation:** /bmad:bmm:workflows:{{next_workflow_id}} ({{next_story_id}})
{{#if risks}}
**Risks:**
{{#each risks}}
- {{this}}
{{/each}}
{{/if}}
</output>
</step>
<step n="5" goal="Offer actions">
<ask>Pick an option:
1) Run recommended workflow now
2) Show all stories grouped by status
3) Show raw sprint-status.yaml
4) Exit
Choice:</ask>
<check if="choice == 1">
<output>Run `/bmad:bmm:workflows:{{next_workflow_id}}`.
If the command targets a story, set `story_key={{next_story_id}}` when prompted.</output>
</check>
<check if="choice == 2">
<output>
### Stories by Status
- In Progress: {{stories_in_progress}}
- Review: {{stories_in_review}}
- Ready for Dev: {{stories_ready_for_dev}}
- Backlog: {{stories_backlog}}
- Done: {{stories_done}}
</output>
</check>
<check if="choice == 3">
<action>Display the full contents of {sprint_status_file}</action>
</check>
<check if="choice == 4">
<action>Exit workflow</action>
</check>
</step>
<!-- ========================= -->
<!-- Data mode for other flows -->
<!-- ========================= -->
<step n="20" goal="Data mode output">
<action>Load and parse {sprint_status_file} same as Step 2</action>
<action>Compute recommendation same as Step 3</action>
<template-output>next_workflow_id = {{next_workflow_id}}</template-output>
<template-output>next_story_id = {{next_story_id}}</template-output>
<template-output>count_backlog = {{count_backlog}}</template-output>
<template-output>count_ready = {{count_ready}}</template-output>
<template-output>count_in_progress = {{count_in_progress}}</template-output>
<template-output>count_review = {{count_review}}</template-output>
<template-output>count_done = {{count_done}}</template-output>
<template-output>epic_backlog = {{epic_backlog}}</template-output>
<template-output>epic_in_progress = {{epic_in_progress}}</template-output>
<template-output>epic_done = {{epic_done}}</template-output>
<template-output>risks = {{risks}}</template-output>
<action>Return to caller</action>
</step>
<!-- ========================= -->
<!-- Validate mode -->
<!-- ========================= -->
<step n="30" goal="Validate sprint-status file">
<action>Check that {sprint_status_file} exists</action>
<check if="missing">
<template-output>is_valid = false</template-output>
<template-output>error = "sprint-status.yaml missing"</template-output>
<template-output>suggestion = "Run sprint-planning to create it"</template-output>
<action>Return</action>
</check>
<action>Read and parse {sprint_status_file}</action>
<action>Validate required metadata fields exist: generated, project, project_key, tracking_system, story_location</action>
<check if="any required field missing">
<template-output>is_valid = false</template-output>
<template-output>error = "Missing required field(s): {{missing_fields}}"</template-output>
<template-output>suggestion = "Re-run sprint-planning or add missing fields manually"</template-output>
<action>Return</action>
</check>
<action>Verify development_status section exists with at least one entry</action>
<check if="development_status missing or empty">
<template-output>is_valid = false</template-output>
<template-output>error = "development_status missing or empty"</template-output>
<template-output>suggestion = "Re-run sprint-planning or repair the file manually"</template-output>
<action>Return</action>
</check>
<action>Validate all status values against known valid statuses:</action>
- Stories: backlog, ready-for-dev, in-progress, review, done (legacy: drafted)
- Epics: backlog, in-progress, done (legacy: contexted)
- Retrospectives: optional, done
<check if="any invalid status found">
<template-output>is_valid = false</template-output>
<template-output>error = "Invalid status values: {{invalid_entries}}"</template-output>
<template-output>suggestion = "Fix invalid statuses in sprint-status.yaml"</template-output>
<action>Return</action>
</check>
<template-output>is_valid = true</template-output>
<template-output>message = "sprint-status.yaml valid: metadata complete, all statuses recognized"</template-output>
</step>
</workflow>

View File

@ -0,0 +1,36 @@
# Sprint Status - Implementation Tracker
name: sprint-status
description: "Summarize sprint-status.yaml, surface risks, and route to the right implementation workflow."
author: "BMad"
# Critical variables from config
config_source: "{project-root}/_bmad/bmm/config.yaml"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
communication_language: "{config_source}:communication_language"
document_output_language: "{config_source}:document_output_language"
date: system-generated
implementation_artifacts: "{config_source}:implementation_artifacts"
planning_artifacts: "{config_source}:planning_artifacts"
# Workflow components
installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-status"
instructions: "{installed_path}/instructions.md"
# Inputs
variables:
sprint_status_file: "{implementation_artifacts}/sprint-status.yaml"
tracking_system: "file-system"
# Smart input file references
input_file_patterns:
sprint_status:
description: "Sprint status file generated by sprint-planning"
whole: "{implementation_artifacts}/sprint-status.yaml"
load_strategy: "FULL_LOAD"
# Standalone so IDE commands get generated
standalone: true
# No web bundle needed
web_bundle: false

View File

@ -0,0 +1,176 @@
---
name: 'step-01-mode-detection'
description: 'Determine execution mode (tech-spec vs direct), handle escalation, set state variables'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
thisStepFile: './step-01-mode-detection.md'
nextStepFile_modeA: './step-03-execute.md'
nextStepFile_modeB: './step-02-context-gathering.md'
---
# Step 1: Mode Detection
**Goal:** Determine execution mode, capture baseline, handle escalation if needed.
---
## STATE VARIABLES (capture now, persist throughout)
These variables MUST be set in this step and available to all subsequent steps:
- `{baseline_commit}` - Git HEAD at workflow start (or "NO_GIT" if not a git repo)
- `{execution_mode}` - "tech-spec" or "direct"
- `{tech_spec_path}` - Path to tech-spec file (if Mode A)
---
## EXECUTION SEQUENCE
### 1. Capture Baseline
First, check if the project uses Git version control:
**If Git repo exists** (`.git` directory present or `git rev-parse --is-inside-work-tree` succeeds):
- Run `git rev-parse HEAD` and store result as `{baseline_commit}`
**If NOT a Git repo:**
- Set `{baseline_commit}` = "NO_GIT"
### 2. Load Project Context
Check if `{project_context}` exists (`**/project-context.md`). If found, load it as a foundational reference for ALL implementation decisions.
### 3. Parse User Input
Analyze the user's input to determine mode:
**Mode A: Tech-Spec**
- User provided a path to a tech-spec file (e.g., `quick-dev tech-spec-auth.md`)
- Load the spec, extract tasks/context/AC
- Set `{execution_mode}` = "tech-spec"
- Set `{tech_spec_path}` = provided path
- **NEXT:** Read fully and follow: `step-03-execute.md`
**Mode B: Direct Instructions**
- User provided task description directly (e.g., `refactor src/foo.ts...`)
- Set `{execution_mode}` = "direct"
- **NEXT:** Evaluate escalation threshold, then proceed
---
## ESCALATION THRESHOLD (Mode B only)
Evaluate user input with minimal token usage (no file loading):
**Triggers escalation (if 2+ signals present):**
- Multiple components mentioned (dashboard + api + database)
- System-level language (platform, integration, architecture)
- Uncertainty about approach ("how should I", "best way to")
- Multi-layer scope (UI + backend + data together)
- Extended timeframe ("this week", "over the next few days")
**Reduces signal:**
- Simplicity markers ("just", "quickly", "fix", "bug", "typo", "simple")
- Single file/component focus
- Confident, specific request
Use holistic judgment, not mechanical keyword matching.
---
## ESCALATION HANDLING
### No Escalation (simple request)
Display: "**Select:** [P] Plan first (tech-spec) [E] Execute directly"
#### Menu Handling Logic:
- IF P: Direct user to `{quick_spec_workflow}`. **EXIT Quick Dev.**
- IF E: Ask for any additional guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed when user makes a selection
---
### Escalation Triggered - Level 0-2
Present: "This looks like a focused feature with multiple components."
Display:
**[P] Plan first (tech-spec)** (recommended)
**[W] Seems bigger than quick-dev** - Recommend the Full BMad Flow PRD Process
**[E] Execute directly**
#### Menu Handling Logic:
- IF P: Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
- IF W: Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed when user makes a selection
---
### Escalation Triggered - Level 3+
Present: "This sounds like platform/system work."
Display:
**[W] Start BMad Method** (recommended)
**[P] Plan first (tech-spec)** (lighter planning)
**[E] Execute directly** - feeling lucky
#### Menu Handling Logic:
- IF P: Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
- IF W: Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed when user makes a selection
---
## NEXT STEP DIRECTIVE
**CRITICAL:** When this step completes, explicitly state which step to load:
- Mode A (tech-spec): "**NEXT:** read fully and follow: `step-03-execute.md`"
- Mode B (direct, [E] selected): "**NEXT:** Read fully and follow: `step-02-context-gathering.md`"
- Escalation ([P] or [W]): "**EXITING Quick Dev.** Follow the directed workflow."
---
## SUCCESS METRICS
- `{baseline_commit}` captured and stored
- `{execution_mode}` determined ("tech-spec" or "direct")
- `{tech_spec_path}` set if Mode A
- Project context loaded if exists
- Escalation evaluated appropriately (Mode B)
- Explicit NEXT directive provided
## FAILURE MODES
- Proceeding without capturing baseline commit
- Not setting execution_mode variable
- Loading step-02 when Mode A (tech-spec provided)
- Attempting to "return" after escalation instead of EXIT
- No explicit NEXT directive at step completion

View File

@ -0,0 +1,120 @@
---
name: 'step-02-context-gathering'
description: 'Quick context gathering for direct mode - identify files, patterns, dependencies'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
thisStepFile: './step-02-context-gathering.md'
nextStepFile: './step-03-execute.md'
---
# Step 2: Context Gathering (Direct Mode)
**Goal:** Quickly gather context for direct instructions - files, patterns, dependencies.
**Note:** This step only runs for Mode B (direct instructions). If `{execution_mode}` is "tech-spec", this step was skipped.
---
## AVAILABLE STATE
From step-01:
- `{baseline_commit}` - Git HEAD at workflow start
- `{execution_mode}` - Should be "direct"
- `{project_context}` - Loaded if exists
---
## EXECUTION SEQUENCE
### 1. Identify Files to Modify
Based on user's direct instructions:
- Search for relevant files using glob/grep
- Identify the specific files that need changes
- Note file locations and purposes
### 2. Find Relevant Patterns
Examine the identified files and their surroundings:
- Code style and conventions used
- Existing patterns for similar functionality
- Import/export patterns
- Error handling approaches
- Test patterns (if tests exist nearby)
### 3. Note Dependencies
Identify:
- External libraries used
- Internal module dependencies
- Configuration files that may need updates
- Related files that might be affected
### 4. Create Mental Plan
Synthesize gathered context into:
- List of tasks to complete
- Acceptance criteria (inferred from user request)
- Order of operations
- Files to touch
---
## PRESENT PLAN
Display to user:
```
**Context Gathered:**
**Files to modify:**
- {list files}
**Patterns identified:**
- {key patterns}
**Plan:**
1. {task 1}
2. {task 2}
...
**Inferred AC:**
- {acceptance criteria}
Ready to execute? (y/n/adjust)
```
- **y:** Proceed to execution
- **n:** Gather more context or clarify
- **adjust:** Modify the plan based on feedback
---
## NEXT STEP DIRECTIVE
**CRITICAL:** When user confirms ready, explicitly state:
- **y:** "**NEXT:** Read fully and follow: `step-03-execute.md`"
- **n/adjust:** Continue gathering context, then re-present plan
---
## SUCCESS METRICS
- Files to modify identified
- Relevant patterns documented
- Dependencies noted
- Mental plan created with tasks and AC
- User confirmed readiness to proceed
## FAILURE MODES
- Executing this step when Mode A (tech-spec)
- Proceeding without identifying files to modify
- Not presenting plan for user confirmation
- Missing obvious patterns in existing code

View File

@ -0,0 +1,113 @@
---
name: 'step-03-execute'
description: 'Execute implementation - iterate through tasks, write code, run tests'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
thisStepFile: './step-03-execute.md'
nextStepFile: './step-04-self-check.md'
---
# Step 3: Execute Implementation
**Goal:** Implement all tasks, write tests, follow patterns, handle errors.
**Critical:** Continue through ALL tasks without stopping for milestones.
---
## AVAILABLE STATE
From previous steps:
- `{baseline_commit}` - Git HEAD at workflow start
- `{execution_mode}` - "tech-spec" or "direct"
- `{tech_spec_path}` - Tech-spec file (if Mode A)
- `{project_context}` - Project patterns (if exists)
From context:
- Mode A: Tasks and AC extracted from tech-spec
- Mode B: Tasks and AC from step-02 mental plan
---
## EXECUTION LOOP
For each task:
### 1. Load Context
- Read files relevant to this task
- Review patterns from project-context or observed code
- Understand dependencies
### 2. Implement
- Write code following existing patterns
- Handle errors appropriately
- Follow conventions observed in codebase
- Add appropriate comments where non-obvious
### 3. Test
- Write tests if appropriate for the change
- Run existing tests to catch regressions
- Verify the specific AC for this task
### 4. Mark Complete
- Check off task: `- [x] Task N`
- Continue to next task immediately
---
## HALT CONDITIONS
**HALT and request guidance if:**
- 3 consecutive failures on same task
- Tests fail and fix is not obvious
- Blocking dependency discovered
- Ambiguity that requires user decision
**Do NOT halt for:**
- Minor issues that can be noted and continued
- Warnings that don't block functionality
- Style preferences (follow existing patterns)
---
## CONTINUOUS EXECUTION
**Critical:** Do not stop between tasks for approval.
- Execute all tasks in sequence
- Only halt for blocking issues
- Tests failing = fix before continuing
- Track all completed work for self-check
---
## NEXT STEP
When ALL tasks are complete (or halted on blocker), read fully and follow: `step-04-self-check.md`.
---
## SUCCESS METRICS
- All tasks attempted
- Code follows existing patterns
- Error handling appropriate
- Tests written where appropriate
- Tests passing
- No unnecessary halts
## FAILURE MODES
- Stopping for approval between tasks
- Ignoring existing patterns
- Not running tests after changes
- Giving up after first failure
- Not following project-context rules (if exists)

View File

@ -0,0 +1,113 @@
---
name: 'step-04-self-check'
description: 'Self-audit implementation against tasks, tests, AC, and patterns'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
thisStepFile: './step-04-self-check.md'
nextStepFile: './step-05-adversarial-review.md'
---
# Step 4: Self-Check
**Goal:** Audit completed work against tasks, tests, AC, and patterns before external review.
---
## AVAILABLE STATE
From previous steps:
- `{baseline_commit}` - Git HEAD at workflow start
- `{execution_mode}` - "tech-spec" or "direct"
- `{tech_spec_path}` - Tech-spec file (if Mode A)
- `{project_context}` - Project patterns (if exists)
---
## SELF-CHECK AUDIT
### 1. Tasks Complete
Verify all tasks are marked complete:
- [ ] All tasks from tech-spec or mental plan marked `[x]`
- [ ] No tasks skipped without documented reason
- [ ] Any blocked tasks have clear explanation
### 2. Tests Passing
Verify test status:
- [ ] All existing tests still pass
- [ ] New tests written for new functionality
- [ ] No test warnings or skipped tests without reason
### 3. Acceptance Criteria Satisfied
For each AC:
- [ ] AC is demonstrably met
- [ ] Can explain how implementation satisfies AC
- [ ] Edge cases considered
### 4. Patterns Followed
Verify code quality:
- [ ] Follows existing code patterns in codebase
- [ ] Follows project-context rules (if exists)
- [ ] Error handling consistent with codebase
- [ ] No obvious code smells introduced
---
## UPDATE TECH-SPEC (Mode A only)
If `{execution_mode}` is "tech-spec":
1. Load `{tech_spec_path}`
2. Mark all tasks as `[x]` complete
3. Update status to "Implementation Complete"
4. Save changes
---
## IMPLEMENTATION SUMMARY
Present summary to transition to review:
```
**Implementation Complete!**
**Summary:** {what was implemented}
**Files Modified:** {list of files}
**Tests:** {test summary - passed/added/etc}
**AC Status:** {all satisfied / issues noted}
Proceeding to adversarial code review...
```
---
## NEXT STEP
Proceed immediately to `step-05-adversarial-review.md`.
---
## SUCCESS METRICS
- All tasks verified complete
- All tests passing
- All AC satisfied
- Patterns followed
- Tech-spec updated (if Mode A)
- Summary presented
## FAILURE MODES
- Claiming tasks complete when they're not
- Not running tests before proceeding
- Missing AC verification
- Ignoring pattern violations
- Not updating tech-spec status (Mode A)

View File

@ -0,0 +1,106 @@
---
name: 'step-05-adversarial-review'
description: 'Construct diff and invoke adversarial review task'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
thisStepFile: './step-05-adversarial-review.md'
nextStepFile: './step-06-resolve-findings.md'
---
# Step 5: Adversarial Code Review
**Goal:** Construct diff of all changes, invoke adversarial review task, present findings.
---
## AVAILABLE STATE
From previous steps:
- `{baseline_commit}` - Git HEAD at workflow start (CRITICAL for diff)
- `{execution_mode}` - "tech-spec" or "direct"
- `{tech_spec_path}` - Tech-spec file (if Mode A)
---
### 1. Construct Diff
Build complete diff of all changes since workflow started.
### If `{baseline_commit}` is a Git commit hash:
**Tracked File Changes:**
```bash
git diff {baseline_commit}
```
**New Untracked Files:**
Only include untracked files that YOU created during this workflow (steps 2-4).
Do not include pre-existing untracked files.
For each new file created, include its full content as a "new file" addition.
### If `{baseline_commit}` is "NO_GIT":
Use best-effort diff construction:
- List all files you modified during steps 2-4
- For each file, show the changes you made (before/after if you recall, or just current state)
- Include any new files you created with their full content
- Note: This is less precise than Git diff but still enables meaningful review
### Capture as {diff_output}
Merge all changes into `{diff_output}`.
**Note:** Do NOT `git add` anything - this is read-only inspection.
---
### 2. Invoke Adversarial Review
With `{diff_output}` constructed, invoke the review task. If possible, use information asymmetry: run this step, and only it, in a separate subagent or process with read access to the project, but no context except the `{diff_output}`.
```xml
<invoke-task>Review {diff_output} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
```
**Platform fallback:** If task invocation not available, load the task file and follow its instructions inline, passing `{diff_output}` as the content.
The task should: review `{diff_output}` and return a list of findings.
---
### 3. Process Findings
Capture the findings from the task output.
**If zero findings:** HALT - this is suspicious. Re-analyze or request user guidance.
Evaluate severity (Critical, High, Medium, Low) and validity (real, noise, undecided).
DO NOT exclude findings based on severity or validity unless explicitly asked to do so.
Order findings by severity.
Number the ordered findings (F1, F2, F3, etc.).
If TodoWrite or similar tool is available, turn each finding into a TODO, include ID, severity, validity, and description in the TODO; otherwise present findings as a table with columns: ID, Severity, Validity, Description
---
## NEXT STEP
With findings in hand, read fully and follow: `step-06-resolve-findings.md` for user to choose resolution approach.
---
## SUCCESS METRICS
- Diff constructed from baseline_commit
- New files included in diff
- Task invoked with diff as input
- Findings received
- Findings processed into TODOs or table and presented to user
## FAILURE MODES
- Missing baseline_commit (can't construct accurate diff)
- Not including new untracked files in diff
- Invoking task without providing diff input
- Accepting zero findings without questioning
- Presenting fewer findings than the review task returned without explicit instruction to do so

View File

@ -0,0 +1,149 @@
---
name: 'step-06-resolve-findings'
description: 'Handle review findings interactively, apply fixes, update tech-spec with final status'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
thisStepFile: './step-06-resolve-findings.md'
---
# Step 6: Resolve Findings
**Goal:** Handle adversarial review findings interactively, apply fixes, finalize tech-spec.
---
## AVAILABLE STATE
From previous steps:
- `{baseline_commit}` - Git HEAD at workflow start
- `{execution_mode}` - "tech-spec" or "direct"
- `{tech_spec_path}` - Tech-spec file (if Mode A)
- Findings table from step-05
---
## RESOLUTION OPTIONS
Present: "How would you like to handle these findings?"
Display:
**[W] Walk through** - Discuss each finding individually
**[F] Fix automatically** - Automatically fix issues classified as "real"
**[S] Skip** - Acknowledge and proceed to commit
### Menu Handling Logic:
- IF W: Execute WALK THROUGH section below
- IF F: Execute FIX AUTOMATICALLY section below
- IF S: Execute SKIP section below
### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed when user makes a selection
---
## WALK THROUGH [W]
For each finding in order:
1. Present the finding with context
2. Ask: **fix now / skip / discuss**
3. If fix: Apply the fix immediately
4. If skip: Note as acknowledged, continue
5. If discuss: Provide more context, re-ask
6. Move to next finding
After all findings processed, summarize what was fixed/skipped.
---
## FIX AUTOMATICALLY [F]
1. Filter findings to only those classified as "real"
2. Apply fixes for each real finding
3. Report what was fixed:
```
**Auto-fix Applied:**
- F1: {description of fix}
- F3: {description of fix}
...
Skipped (noise/uncertain): F2, F4
```
---
## SKIP [S]
1. Acknowledge all findings were reviewed
2. Note that user chose to proceed without fixes
3. Continue to completion
---
## UPDATE TECH-SPEC (Mode A only)
If `{execution_mode}` is "tech-spec":
1. Load `{tech_spec_path}`
2. Update status to "Completed"
3. Add review notes:
```
## Review Notes
- Adversarial review completed
- Findings: {count} total, {fixed} fixed, {skipped} skipped
- Resolution approach: {walk-through/auto-fix/skip}
```
4. Save changes
---
## COMPLETION OUTPUT
```
**Review complete. Ready to commit.**
**Implementation Summary:**
- {what was implemented}
- Files modified: {count}
- Tests: {status}
- Review findings: {X} addressed, {Y} skipped
{Explain what was implemented based on user_skill_level}
```
---
## WORKFLOW COMPLETE
This is the final step. The Quick Dev workflow is now complete.
User can:
- Commit changes
- Run additional tests
- Start new Quick Dev session
---
## SUCCESS METRICS
- User presented with resolution options
- Chosen approach executed correctly
- Fixes applied cleanly (if applicable)
- Tech-spec updated with final status (Mode A)
- Completion summary provided
- User understands what was implemented
## FAILURE MODES
- Not presenting resolution options
- Auto-fixing "noise" or "uncertain" findings
- Not updating tech-spec after resolution (Mode A)
- No completion summary
- Leaving user unclear on next steps

View File

@ -0,0 +1,50 @@
---
name: quick-dev
description: 'Flexible development - execute tech-specs OR direct instructions with optional planning.'
---
# Quick Dev Workflow
**Goal:** Execute implementation tasks efficiently, either from a tech-spec or direct user instructions.
**Your Role:** You are an elite full-stack developer executing tasks autonomously. Follow patterns, ship code, run tests. Every response moves the project forward.
---
## WORKFLOW ARCHITECTURE
This uses **step-file architecture** for focused execution:
- Each step loads fresh to combat "lost in the middle"
- State persists via variables: `{baseline_commit}`, `{execution_mode}`, `{tech_spec_path}`
- Sequential progression through implementation phases
---
## INITIALIZATION
### Configuration Loading
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
- `user_name`, `communication_language`, `user_skill_level`
- `output_folder`, `planning_artifacts`, `implementation_artifacts`
- `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/bmad-quick-flow/quick-dev`
- `project_context` = `**/project-context.md` (load if exists)
### Related Workflows
- `quick_spec_workflow` = `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md`
- `party_mode_exec` = `{project-root}/_bmad/core/workflows/party-mode/workflow.md`
- `advanced_elicitation` = `{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml`
---
## EXECUTION
Read fully and follow: `steps/step-01-mode-detection.md` to begin the workflow.

View File

@ -0,0 +1,192 @@
---
name: 'step-01-understand'
description: 'Analyze the requirement delta between current state and what user wants to build'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
nextStepFile: './step-02-investigate.md'
skipToStepFile: './step-03-generate.md'
templateFile: '{workflow_path}/tech-spec-template.md'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
# Step 1: Analyze Requirement Delta
**Progress: Step 1 of 4** - Next: Deep Investigation
## RULES:
- MUST NOT skip steps.
- MUST NOT optimize sequence.
- MUST follow exact instructions.
- MUST NOT look ahead to future steps.
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
## CONTEXT:
- Variables from `workflow.md` are available in memory.
- Focus: Define the technical requirement delta and scope.
- Investigation: Perform surface-level code scans ONLY to verify the delta. Reserve deep dives into implementation consequences for Step 2.
- Objective: Establish a verifiable delta between current state and target state.
## SEQUENCE OF INSTRUCTIONS
### 0. Check for Work in Progress
a) **Before anything else, check if `{wipFile}` exists:**
b) **IF WIP FILE EXISTS:**
1. Read the frontmatter and extract: `title`, `slug`, `stepsCompleted`
2. Calculate progress: `lastStep = max(stepsCompleted)`
3. Present to user:
```
Hey {user_name}! Found a tech-spec in progress:
**{title}** - Step {lastStep} of 4 complete
Is this what you're here to continue?
[Y] Yes, pick up where I left off
[N] No, archive it and start something new
```
4. **HALT and wait for user selection.**
a) **Menu Handling:**
- **[Y] Continue existing:**
- Jump directly to the appropriate step based on `stepsCompleted`:
- `[1]` → Load `{nextStepFile}` (Step 2)
- `[1, 2]` → Load `{skipToStepFile}` (Step 3)
- `[1, 2, 3]` → Load `./step-04-review.md` (Step 4)
- **[N] Archive and start fresh:**
- Rename `{wipFile}` to `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md`
### 1. Greet and Ask for Initial Request
a) **Greet the user briefly:**
"Hey {user_name}! What are we building today?"
b) **Get their initial description.** Don't ask detailed questions yet - just understand enough to know where to look.
### 2. Quick Orient Scan
a) **Before asking detailed questions, do a rapid scan to understand the landscape:**
b) **Check for existing context docs:**
- Check `{output_folder}` and `{planning_artifacts}`for planning documents (PRD, architecture, epics, research)
- Check for `**/project-context.md` - if it exists, skim for patterns and conventions
- Check for any existing stories or specs related to user's request
c) **If user mentioned specific code/features, do a quick scan:**
- Search for relevant files/classes/functions they mentioned
- Skim the structure (don't deep-dive yet - that's Step 2)
- Note: tech stack, obvious patterns, file locations
d) **Build mental model:**
- What's the likely landscape for this feature?
- What's the likely scope based on what you found?
- What questions do you NOW have, informed by the code?
**This scan should take < 30 seconds. Just enough to ask smart questions.**
### 3. Ask Informed Questions
a) **Now ask clarifying questions - but make them INFORMED by what you found:**
Instead of generic questions like "What's the scope?", ask specific ones like:
- "`AuthService` handles validation in the controller — should the new field follow that pattern or move it to a dedicated validator?"
- "`NavigationSidebar` component uses local state for the 'collapsed' toggle — should we stick with that or move it to the global store?"
- "The epics doc mentions X - is this related?"
**Adapt to {user_skill_level}.** Technical users want technical questions. Non-technical users need translation.
b) **If no existing code is found:**
- Ask about intended architecture, patterns, constraints
- Ask what similar systems they'd like to emulate
### 4. Capture Core Understanding
a) **From the conversation, extract and confirm:**
- **Title**: A clear, concise name for this work
- **Slug**: URL-safe version of title (lowercase, hyphens, no spaces)
- **Problem Statement**: What problem are we solving?
- **Solution**: High-level approach (1-2 sentences)
- **In Scope**: What's included
- **Out of Scope**: What's explicitly NOT included
b) **Ask the user to confirm the captured understanding before proceeding.**
### 5. Initialize WIP File
a) **Create the tech-spec WIP file:**
1. Copy template from `{templateFile}`
2. Write to `{wipFile}`
3. Update frontmatter with captured values:
```yaml
---
title: '{title}'
slug: '{slug}'
created: '{date}'
status: 'in-progress'
stepsCompleted: [1]
tech_stack: []
files_to_modify: []
code_patterns: []
test_patterns: []
---
```
4. Fill in Overview section with Problem Statement, Solution, and Scope
5. Fill in Context for Development section with any technical preferences or constraints gathered during informed discovery.
6. Write the file
b) **Report to user:**
"Created: `{wipFile}`
**Captured:**
- Title: {title}
- Problem: {problem_statement_summary}
- Scope: {scope_summary}"
### 6. Present Checkpoint Menu
a) **Display menu:**
Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Deep Investigation (Step 2 of 4)"
b) **HALT and wait for user selection.**
#### Menu Handling Logic:
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF C: Verify `{wipFile}` has `stepsCompleted: [1]`, then read fully and follow: `{nextStepFile}`
- IF Any other comments or queries: respond helpfully then redisplay menu
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to next step when user selects 'C'
- After A or P execution, return to this menu
---
## REQUIRED OUTPUTS:
- MUST initialize WIP file with captured metadata.
## VERIFICATION CHECKLIST:
- [ ] WIP check performed FIRST before any greeting.
- [ ] `{wipFile}` created with correct frontmatter, Overview, Context for Development, and `stepsCompleted: [1]`.
- [ ] User selected [C] to continue.

View File

@ -0,0 +1,145 @@
---
name: 'step-02-investigate'
description: 'Map technical constraints and anchor points within the codebase'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
nextStepFile: './step-03-generate.md'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
# Step 2: Map Technical Constraints & Anchor Points
**Progress: Step 2 of 4** - Next: Generate Plan
## RULES:
- MUST NOT skip steps.
- MUST NOT optimize sequence.
- MUST follow exact instructions.
- MUST NOT generate the full spec yet (that's Step 3).
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
## CONTEXT:
- Requires `{wipFile}` from Step 1 with the "Problem Statement" defined.
- Focus: Map the problem statement to specific anchor points in the codebase.
- Output: Exact files to touch, classes/patterns to extend, and technical constraints identified.
- Objective: Provide the implementation-ready ground truth for the plan.
## SEQUENCE OF INSTRUCTIONS
### 1. Load Current State
**Read `{wipFile}` and extract:**
- Problem statement and scope from Overview section
- Any context gathered in Step 1
### 2. Execute Investigation Path
**Universal Code Investigation:**
_Isolate deep exploration in sub-agents/tasks where available. Return distilled summaries only to prevent context snowballing._
a) **Build on Step 1's Quick Scan**
Review what was found in Step 1's orient scan. Then ask:
"Based on my quick look, I see [files/patterns found]. Are there other files or directories I should investigate deeply?"
b) **Read and Analyze Code**
For each file/directory provided:
- Read the complete file(s)
- Identify patterns, conventions, coding style
- Note dependencies and imports
- Find related test files
**If NO relevant code is found (Clean Slate):**
- Identify the target directory where the feature should live.
- Scan parent directories for architectural context.
- Identify standard project utilities or boilerplate that SHOULD be used.
- Document this as "Confirmed Clean Slate" - establishing that no legacy constraints exist.
c) **Document Technical Context**
Capture and confirm with user:
- **Tech Stack**: Languages, frameworks, libraries
- **Code Patterns**: Architecture patterns, naming conventions, file structure
- **Files to Modify/Create**: Specific files that will need changes or new files to be created
- **Test Patterns**: How tests are structured, test frameworks used
d) **Look for project-context.md**
If `**/project-context.md` exists and wasn't loaded in Step 1:
- Load it now
- Extract patterns and conventions
- Note any rules that must be followed
### 3. Update WIP File
**Update `{wipFile}` frontmatter:**
```yaml
---
# ... existing frontmatter ...
stepsCompleted: [1, 2]
tech_stack: ['{captured_tech_stack}']
files_to_modify: ['{captured_files}']
code_patterns: ['{captured_patterns}']
test_patterns: ['{captured_test_patterns}']
---
```
**Update the Context for Development section:**
Fill in:
- Codebase Patterns (from investigation)
- Files to Reference table (files reviewed)
- Technical Decisions (any decisions made during investigation)
**Report to user:**
"**Context Gathered:**
- Tech Stack: {tech_stack_summary}
- Files to Modify: {files_count} files identified
- Patterns: {patterns_summary}
- Tests: {test_patterns_summary}"
### 4. Present Checkpoint Menu
Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Generate Spec (Step 3 of 4)"
**HALT and wait for user selection.**
#### Menu Handling Logic:
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF C: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{nextStepFile}`
- IF Any other comments or queries: respond helpfully then redisplay menu
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to next step when user selects 'C'
- After A or P execution, return to this menu
---
## REQUIRED OUTPUTS:
- MUST document technical context (stack, patterns, files identified).
- MUST update `{wipFile}` with functional context.
## VERIFICATION CHECKLIST:
- [ ] Technical mapping performed and documented.
- [ ] `stepsCompleted: [1, 2]` set in frontmatter.

View File

@ -0,0 +1,128 @@
---
name: 'step-03-generate'
description: 'Build the implementation plan based on the technical mapping of constraints'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
nextStepFile: './step-04-review.md'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
# Step 3: Generate Implementation Plan
**Progress: Step 3 of 4** - Next: Review & Finalize
## RULES:
- MUST NOT skip steps.
- MUST NOT optimize sequence.
- MUST follow exact instructions.
- MUST NOT implement anything - just document.
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
## CONTEXT:
- Requires `{wipFile}` with defined "Overview" and "Context for Development" sections.
- Focus: Create the implementation sequence that addresses the requirement delta using the captured technical context.
- Output: Implementation-ready tasks with specific files and instructions.
- Target: Meet the **READY FOR DEVELOPMENT** standard defined in `workflow.md`.
## SEQUENCE OF INSTRUCTIONS
### 1. Load Current State
**Read `{wipFile}` completely and extract:**
- All frontmatter values
- Overview section (Problem, Solution, Scope)
- Context for Development section (Patterns, Files, Decisions)
### 2. Generate Implementation Plan
Generate specific implementation tasks:
a) **Task Breakdown**
- Each task should be a discrete, completable unit of work
- Tasks should be ordered logically (dependencies first)
- Include the specific files to modify in each task
- Be explicit about what changes to make
b) **Task Format**
```markdown
- [ ] Task N: Clear action description
- File: `path/to/file.ext`
- Action: Specific change to make
- Notes: Any implementation details
```
### 3. Generate Acceptance Criteria
**Create testable acceptance criteria:**
Each AC should follow Given/When/Then format:
```markdown
- [ ] AC N: Given [precondition], when [action], then [expected result]
```
**Ensure ACs cover:**
- Happy path functionality
- Error handling
- Edge cases (if relevant)
- Integration points (if relevant)
### 4. Complete Additional Context
**Fill in remaining sections:**
a) **Dependencies**
- External libraries or services needed
- Other tasks or features this depends on
- API or data dependencies
b) **Testing Strategy**
- Unit tests needed
- Integration tests needed
- Manual testing steps
c) **Notes**
- High-risk items from pre-mortem analysis
- Known limitations
- Future considerations (out of scope but worth noting)
### 5. Write Complete Spec
a) **Update `{wipFile}` with all generated content:**
- Ensure all template sections are filled in
- No placeholder text remaining
- All frontmatter values current
- Update status to 'review' (NOT 'ready-for-dev' - that happens after user review in Step 4)
b) **Update frontmatter:**
```yaml
---
# ... existing values ...
status: 'review'
stepsCompleted: [1, 2, 3]
---
```
c) **Read fully and follow: `{nextStepFile}` (Step 4)**
## REQUIRED OUTPUTS:
- Tasks MUST be specific, actionable, ordered logically, with files to modify.
- ACs MUST be testable, using Given/When/Then format.
- Status MUST be updated to 'review'.
## VERIFICATION CHECKLIST:
- [ ] `stepsCompleted: [1, 2, 3]` set in frontmatter.
- [ ] Spec meets the **READY FOR DEVELOPMENT** standard.

View File

@ -0,0 +1,201 @@
---
name: 'step-04-review'
description: 'Review and finalize the tech-spec'
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
# Step 4: Review & Finalize
**Progress: Step 4 of 4** - Final Step
## RULES:
- MUST NOT skip steps.
- MUST NOT optimize sequence.
- MUST follow exact instructions.
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
## CONTEXT:
- Requires `{wipFile}` from Step 3.
- MUST present COMPLETE spec content. Iterate until user is satisfied.
- **Criteria**: The spec MUST meet the **READY FOR DEVELOPMENT** standard defined in `workflow.md`.
## SEQUENCE OF INSTRUCTIONS
### 1. Load and Present Complete Spec
**Read `{wipFile}` completely and extract `slug` from frontmatter for later use.**
**Present to user:**
"Here's your complete tech-spec. Please review:"
[Display the complete spec content - all sections]
"**Quick Summary:**
- {task_count} tasks to implement
- {ac_count} acceptance criteria to verify
- {files_count} files to modify"
**Present review menu:**
Display: "**Select:** [C] Continue [E] Edit [Q] Questions [A] Advanced Elicitation [P] Party Mode"
**HALT and wait for user selection.**
#### Menu Handling Logic:
- IF C: Proceed to Section 3 (Finalize the Spec)
- IF E: Proceed to Section 2 (Handle Review Feedback), then return here and redisplay menu
- IF Q: Answer questions, then redisplay this menu
- IF A: Read fully and follow: `{advanced_elicitation}` with current spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
- IF P: Read fully and follow: `{party_mode_exec}` with current spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
- IF Any other comments or queries: respond helpfully then redisplay menu
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to finalize when user selects 'C'
- After other menu items execution, return to this menu
### 2. Handle Review Feedback
a) **If user requests changes:**
- Make the requested edits to `{wipFile}`
- Re-present the affected sections
- Ask if there are more changes
- Loop until user is satisfied
b) **If the spec does NOT meet the "Ready for Development" standard:**
- Point out the missing/weak sections (e.g., non-actionable tasks, missing ACs).
- Propose specific improvements to reach the standard.
- Make the edits once the user agrees.
c) **If user has questions:**
- Answer questions about the spec
- Clarify any confusing sections
- Make clarifying edits if needed
### 3. Finalize the Spec
**When user confirms the spec is good AND it meets the "Ready for Development" standard:**
a) Update `{wipFile}` frontmatter:
```yaml
---
# ... existing values ...
status: 'ready-for-dev'
stepsCompleted: [1, 2, 3, 4]
---
```
b) **Rename WIP file to final filename:**
- Using the `slug` extracted in Section 1
- Rename `{wipFile}``{implementation_artifacts}/tech-spec-{slug}.md`
- Store this as `finalFile` for use in menus below
### 4. Present Final Menu
a) **Display completion message and menu:**
```
**Tech-Spec Complete!**
Saved to: {finalFile}
---
**Next Steps:**
[A] Advanced Elicitation - refine further
[R] Adversarial Review - critique of the spec (highly recommended)
[B] Begin Development - start implementing now (not recommended)
[D] Done - exit workflow
[P] Party Mode - get expert feedback before dev
---
Once you are fully satisfied with the spec (ideally after **Adversarial Review** and maybe a few rounds of **Advanced Elicitation**), it is recommended to run implementation in a FRESH CONTEXT for best results.
Copy this prompt to start dev:
\`\`\`
quick-dev {finalFile}
\`\`\`
This ensures the dev agent has clean context focused solely on implementation.
```
b) **HALT and wait for user selection.**
#### Menu Handling Logic:
- IF A: Read fully and follow: `{advanced_elicitation}` with current spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
- IF B: Read the entire workflow file at `{quick_dev_workflow}` and follow the instructions with the final spec file (warn: fresh context is better)
- IF D: Exit workflow - display final confirmation and path to spec
- IF P: Read fully and follow: `{party_mode_exec}` with current spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
- IF R: Execute Adversarial Review (see below)
- IF Any other comments or queries: respond helpfully then redisplay menu
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- After A, P, or R execution, return to this menu
#### Adversarial Review [R] Process:
1. **Invoke Adversarial Review Task**:
> With `{finalFile}` constructed, invoke the review task. If possible, use information asymmetry: run this task, and only it, in a separate subagent or process with read access to the project, but no context except the `{finalFile}`.
<invoke-task>Review {finalFile} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
> **Platform fallback:** If task invocation not available, load the task file and follow its instructions inline, passing `{finalFile}` as the content.
> The task should: review `{finalFile}` and return a list of findings.
2. **Process Findings**:
> Capture the findings from the task output.
> **If zero findings:** HALT - this is suspicious. Re-analyze or request user guidance.
> Evaluate severity (Critical, High, Medium, Low) and validity (real, noise, undecided).
> DO NOT exclude findings based on severity or validity unless explicitly asked to do so.
> Order findings by severity.
> Number the ordered findings (F1, F2, F3, etc.).
> If TodoWrite or similar tool is available, turn each finding into a TODO, include ID, severity, validity, and description in the TODO; otherwise present findings as a table with columns: ID, Severity, Validity, Description
3. Return here and redisplay menu.
### 5. Exit Workflow
**When user selects [D]:**
"**All done!** Your tech-spec is ready at:
`{finalFile}`
When you're ready to implement, run:
```
quick-dev {finalFile}
```
Ship it!"
---
## REQUIRED OUTPUTS:
- MUST update status to 'ready-for-dev'.
- MUST rename file to `tech-spec-{slug}.md`.
- MUST provide clear next-step guidance and recommend fresh context for dev.
## VERIFICATION CHECKLIST:
- [ ] Complete spec presented for review.
- [ ] Requested changes implemented.
- [ ] Spec verified against **READY FOR DEVELOPMENT** standard.
- [ ] `stepsCompleted: [1, 2, 3, 4]` set and file renamed.

View File

@ -0,0 +1,74 @@
---
title: '{title}'
slug: '{slug}'
created: '{date}'
status: 'in-progress'
stepsCompleted: []
tech_stack: []
files_to_modify: []
code_patterns: []
test_patterns: []
---
# Tech-Spec: {title}
**Created:** {date}
## Overview
### Problem Statement
{problem_statement}
### Solution
{solution}
### Scope
**In Scope:**
{in_scope}
**Out of Scope:**
{out_of_scope}
## Context for Development
### Codebase Patterns
{codebase_patterns}
### Files to Reference
| File | Purpose |
| ---- | ------- |
{files_table}
### Technical Decisions
{technical_decisions}
## Implementation Plan
### Tasks
{tasks}
### Acceptance Criteria
{acceptance_criteria}
## Additional Context
### Dependencies
{dependencies}
### Testing Strategy
{testing_strategy}
### Notes
{notes}

View File

@ -0,0 +1,79 @@
---
name: quick-spec
description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.
main_config: '{project-root}/_bmad/bmm/config.yaml'
web_bundle: true
# Checkpoint handler paths
advanced_elicitation: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
party_mode_exec: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
quick_dev_workflow: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md'
---
# Quick-Spec Workflow
**Goal:** Create implementation-ready technical specifications through conversational discovery, code investigation, and structured documentation.
**READY FOR DEVELOPMENT STANDARD:**
A specification is considered "Ready for Development" ONLY if it meets the following:
- **Actionable**: Every task has a clear file path and specific action.
- **Logical**: Tasks are ordered by dependency (lowest level first).
- **Testable**: All ACs follow Given/When/Then and cover happy path and edge cases.
- **Complete**: All investigation results from Step 2 are inlined; no placeholders or "TBD".
- **Self-Contained**: A fresh agent can implement the feature without reading the workflow history.
---
**Your Role:** You are an elite developer and spec engineer. You ask sharp questions, investigate existing code thoroughly, and produce specs that contain ALL context a fresh dev agent needs to implement the feature. No handoffs, no missing context - just complete, actionable specs.
---
## WORKFLOW ARCHITECTURE
This uses **step-file architecture** for disciplined execution:
### Core Principles
- **Micro-file Design**: Each step is a self-contained instruction file that must be followed exactly
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until directed
- **Sequential Enforcement**: Sequence within step files must be completed in order, no skipping or optimization
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array
- **Append-Only Building**: Build the tech-spec by updating content as directed
### 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**: 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, read fully and follow 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 file when completing a 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`, `implementation_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}`
### 2. First Step Execution
Read fully and follow: `steps/step-01-understand.md` to begin the workflow.

View File

@ -0,0 +1,245 @@
# Document Project Workflow - Validation Checklist
## Scan Level and Resumability
- [ ] Scan level selection offered (quick/deep/exhaustive) for initial_scan and full_rescan modes
- [ ] Deep-dive mode automatically uses exhaustive scan (no choice given)
- [ ] Quick scan does NOT read source files (only patterns, configs, manifests)
- [ ] Deep scan reads files in critical directories per project type
- [ ] Exhaustive scan reads ALL source files (excluding node_modules, dist, build)
- [ ] State file (project-scan-report.json) created at workflow start
- [ ] State file updated after each step completion
- [ ] State file contains all required fields per schema
- [ ] Resumability prompt shown if state file exists and is <24 hours old
- [ ] Old state files (>24 hours) automatically archived
- [ ] Resume functionality loads previous state correctly
- [ ] Workflow can jump to correct step when resuming
## Write-as-you-go Architecture
- [ ] Each document written to disk IMMEDIATELY after generation
- [ ] Document validation performed right after writing (section-level)
- [ ] State file updated after each document is written
- [ ] Detailed findings purged from context after writing (only summaries kept)
- [ ] Context contains only high-level summaries (1-2 sentences per section)
- [ ] No accumulation of full project analysis in memory
## Batching Strategy (Deep/Exhaustive Scans)
- [ ] Batching applied for deep and exhaustive scan levels
- [ ] Batches organized by SUBFOLDER (not arbitrary file count)
- [ ] Large files (>5000 LOC) handled with appropriate judgment
- [ ] Each batch: read files, extract info, write output, validate, purge context
- [ ] Batch completion tracked in state file (batches_completed array)
- [ ] Batch summaries kept in context (1-2 sentences max)
## Project Detection and Classification
- [ ] Project type correctly identified and matches actual technology stack
- [ ] Multi-part vs single-part structure accurately detected
- [ ] All project parts identified if multi-part (no missing client/server/etc.)
- [ ] Documentation requirements loaded for each part type
- [ ] Architecture registry match is appropriate for detected stack
## Technology Stack Analysis
- [ ] All major technologies identified (framework, language, database, etc.)
- [ ] Versions captured where available
- [ ] Technology decision table is complete and accurate
- [ ] Dependencies and libraries documented
- [ ] Build tools and package managers identified
## Codebase Scanning Completeness
- [ ] All critical directories scanned based on project type
- [ ] API endpoints documented (if requires_api_scan = true)
- [ ] Data models captured (if requires_data_models = true)
- [ ] State management patterns identified (if requires_state_management = true)
- [ ] UI components inventoried (if requires_ui_components = true)
- [ ] Configuration files located and documented
- [ ] Authentication/security patterns identified
- [ ] Entry points correctly identified
- [ ] Integration points mapped (for multi-part projects)
- [ ] Test files and patterns documented
## Source Tree Analysis
- [ ] Complete directory tree generated with no major omissions
- [ ] Critical folders highlighted and described
- [ ] Entry points clearly marked
- [ ] Integration paths noted (for multi-part)
- [ ] Asset locations identified (if applicable)
- [ ] File organization patterns explained
## Architecture Documentation Quality
- [ ] Architecture document uses appropriate template from registry
- [ ] All template sections filled with relevant information (no placeholders)
- [ ] Technology stack section is comprehensive
- [ ] Architecture pattern clearly explained
- [ ] Data architecture documented (if applicable)
- [ ] API design documented (if applicable)
- [ ] Component structure explained (if applicable)
- [ ] Source tree included and annotated
- [ ] Testing strategy documented
- [ ] Deployment architecture captured (if config found)
## Development and Operations Documentation
- [ ] Prerequisites clearly listed
- [ ] Installation steps documented
- [ ] Environment setup instructions provided
- [ ] Local run commands specified
- [ ] Build process documented
- [ ] Test commands and approach explained
- [ ] Deployment process documented (if applicable)
- [ ] CI/CD pipeline details captured (if found)
- [ ] Contribution guidelines extracted (if found)
## Multi-Part Project Specific (if applicable)
- [ ] Each part documented separately
- [ ] Part-specific architecture files created (architecture-{part_id}.md)
- [ ] Part-specific component inventories created (if applicable)
- [ ] Part-specific development guides created
- [ ] Integration architecture document created
- [ ] Integration points clearly defined with type and details
- [ ] Data flow between parts explained
- [ ] project-parts.json metadata file created
## Index and Navigation
- [ ] index.md created as master entry point
- [ ] Project structure clearly summarized in index
- [ ] Quick reference section complete and accurate
- [ ] All generated docs linked from index
- [ ] All existing docs linked from index (if found)
- [ ] Getting started section provides clear next steps
- [ ] AI-assisted development guidance included
- [ ] Navigation structure matches project complexity (simple for single-part, detailed for multi-part)
## File Completeness
- [ ] index.md generated
- [ ] project-overview.md generated
- [ ] source-tree-analysis.md generated
- [ ] architecture.md (or per-part) generated
- [ ] component-inventory.md (or per-part) generated if UI components exist
- [ ] development-guide.md (or per-part) generated
- [ ] api-contracts.md (or per-part) generated if APIs documented
- [ ] data-models.md (or per-part) generated if data models found
- [ ] deployment-guide.md generated if deployment config found
- [ ] contribution-guide.md generated if guidelines found
- [ ] integration-architecture.md generated if multi-part
- [ ] project-parts.json generated if multi-part
## Content Quality
- [ ] Technical information is accurate and specific
- [ ] No generic placeholders or "TODO" items remain
- [ ] Examples and code snippets are relevant to actual project
- [ ] File paths and directory references are correct
- [ ] Technology names and versions are accurate
- [ ] Terminology is consistent across all documents
- [ ] Descriptions are clear and actionable
## Brownfield PRD Readiness
- [ ] Documentation provides enough context for AI to understand existing system
- [ ] Integration points are clear for planning new features
- [ ] Reusable components are identified for leveraging in new work
- [ ] Data models are documented for schema extension planning
- [ ] API contracts are documented for endpoint expansion
- [ ] Code conventions and patterns are captured for consistency
- [ ] Architecture constraints are clear for informed decision-making
## Output Validation
- [ ] All files saved to correct output folder
- [ ] File naming follows convention (no part suffix for single-part, with suffix for multi-part)
- [ ] No broken internal links between documents
- [ ] Markdown formatting is correct and renders properly
- [ ] JSON files are valid (project-parts.json if applicable)
## Final Validation
- [ ] User confirmed project classification is accurate
- [ ] User provided any additional context needed
- [ ] All requested areas of focus addressed
- [ ] Documentation is immediately usable for brownfield PRD workflow
- [ ] No critical information gaps identified
## Issues Found
### Critical Issues (must fix before completion)
-
### Minor Issues (can be addressed later)
-
### Missing Information (to note for user)
-
## Deep-Dive Mode Validation (if deep-dive was performed)
- [ ] Deep-dive target area correctly identified and scoped
- [ ] All files in target area read completely (no skipped files)
- [ ] File inventory includes all exports with complete signatures
- [ ] Dependencies mapped for all files
- [ ] Dependents identified (who imports each file)
- [ ] Code snippets included for key implementation details
- [ ] Patterns and design approaches documented
- [ ] State management strategy explained
- [ ] Side effects documented (API calls, DB queries, etc.)
- [ ] Error handling approaches captured
- [ ] Testing files and coverage documented
- [ ] TODOs and comments extracted
- [ ] Dependency graph created showing relationships
- [ ] Data flow traced through the scanned area
- [ ] Integration points with rest of codebase identified
- [ ] Related code and similar patterns found outside scanned area
- [ ] Reuse opportunities documented
- [ ] Implementation guidance provided
- [ ] Modification instructions clear
- [ ] Index.md updated with deep-dive link
- [ ] Deep-dive documentation is immediately useful for implementation
---
## State File Quality
- [ ] State file is valid JSON (no syntax errors)
- [ ] State file is optimized (no pretty-printing, minimal whitespace)
- [ ] State file contains all completed steps with timestamps
- [ ] State file outputs_generated list is accurate and complete
- [ ] State file resume_instructions are clear and actionable
- [ ] State file findings contain only high-level summaries (not detailed data)
- [ ] State file can be successfully loaded for resumption
## Completion Criteria
All items in the following sections must be checked:
- ✓ Scan Level and Resumability
- ✓ Write-as-you-go Architecture
- ✓ Batching Strategy (if deep/exhaustive scan)
- ✓ Project Detection and Classification
- ✓ Technology Stack Analysis
- ✓ Architecture Documentation Quality
- ✓ Index and Navigation
- ✓ File Completeness
- ✓ Brownfield PRD Readiness
- ✓ State File Quality
- ✓ Deep-Dive Mode Validation (if applicable)
The workflow is complete when:
1. All critical checklist items are satisfied
2. No critical issues remain
3. User has reviewed and approved the documentation
4. Generated docs are ready for use in brownfield PRD workflow
5. Deep-dive docs (if any) are comprehensive and implementation-ready
6. State file is valid and can enable resumption if interrupted

View File

@ -0,0 +1,12 @@
project_type_id,requires_api_scan,requires_data_models,requires_state_management,requires_ui_components,requires_deployment_config,key_file_patterns,critical_directories,integration_scan_patterns,test_file_patterns,config_patterns,auth_security_patterns,schema_migration_patterns,entry_point_patterns,shared_code_patterns,monorepo_workspace_patterns,async_event_patterns,ci_cd_patterns,asset_patterns,hardware_interface_patterns,protocol_schema_patterns,localization_patterns,requires_hardware_docs,requires_asset_inventory
web,true,true,true,true,true,package.json;tsconfig.json;*.config.js;*.config.ts;vite.config.*;webpack.config.*;next.config.*;nuxt.config.*,src/;app/;pages/;components/;api/;lib/;styles/;public/;static/,*client.ts;*service.ts;*api.ts;fetch*.ts;axios*.ts;*http*.ts,*.test.ts;*.spec.ts;*.test.tsx;*.spec.tsx;**/__tests__/**;**/*.test.*;**/*.spec.*,.env*;config/*;*.config.*;.config/;settings/,*auth*.ts;*session*.ts;middleware/auth*;*.guard.ts;*authenticat*;*permission*;guards/,migrations/**;prisma/**;*.prisma;alembic/**;knex/**;*migration*.sql;*migration*.ts,main.ts;index.ts;app.ts;server.ts;_app.tsx;_app.ts;layout.tsx,shared/**;common/**;utils/**;lib/**;helpers/**;@*/**;packages/**,pnpm-workspace.yaml;lerna.json;nx.json;turbo.json;workspace.json;rush.json,*event*.ts;*queue*.ts;*subscriber*.ts;*consumer*.ts;*producer*.ts;*worker*.ts;jobs/**,.github/workflows/**;.gitlab-ci.yml;Jenkinsfile;.circleci/**;azure-pipelines.yml;bitbucket-pipelines.yml,.drone.yml,public/**;static/**;assets/**;images/**;media/**,N/A,*.proto;*.graphql;graphql/**;schema.graphql;*.avro;openapi.*;swagger.*,i18n/**;locales/**;lang/**;translations/**;messages/**;*.po;*.pot,false,false
mobile,true,true,true,true,true,package.json;pubspec.yaml;Podfile;build.gradle;app.json;capacitor.config.*;ionic.config.json,src/;app/;screens/;components/;services/;models/;assets/;ios/;android/,*client.ts;*service.ts;*api.ts;fetch*.ts;axios*.ts;*http*.ts,*.test.ts;*.test.tsx;*_test.dart;*.test.dart;**/__tests__/**,.env*;config/*;app.json;capacitor.config.*;google-services.json;GoogleService-Info.plist,*auth*.ts;*session*.ts;*authenticat*;*permission*;*biometric*;secure-store*,migrations/**;realm/**;*.realm;watermelondb/**;sqlite/**,main.ts;index.ts;App.tsx;App.ts;main.dart,shared/**;common/**;utils/**;lib/**;components/shared/**;@*/**,pnpm-workspace.yaml;lerna.json;nx.json;turbo.json,*event*.ts;*notification*.ts;*push*.ts;background-fetch*,fastlane/**;.github/workflows/**;.gitlab-ci.yml;bitbucket-pipelines.yml;appcenter-*,assets/**;Resources/**;res/**;*.xcassets;drawable*/;mipmap*/;images/**,N/A,*.proto;graphql/**;*.graphql,i18n/**;locales/**;translations/**;*.strings;*.xml,false,true
backend,true,true,false,false,true,package.json;requirements.txt;go.mod;Gemfile;pom.xml;build.gradle;Cargo.toml;*.csproj,src/;api/;services/;models/;routes/;controllers/;middleware/;handlers/;repositories/;domain/,*client.ts;*repository.ts;*service.ts;*connector*.ts;*adapter*.ts,*.test.ts;*.spec.ts;*_test.go;test_*.py;*Test.java;*_test.rs,.env*;config/*;*.config.*;application*.yml;application*.yaml;appsettings*.json;settings.py,*auth*.ts;*session*.ts;*authenticat*;*authorization*;middleware/auth*;guards/;*jwt*;*oauth*,migrations/**;alembic/**;flyway/**;liquibase/**;prisma/**;*.prisma;*migration*.sql;*migration*.ts;db/migrate,main.ts;index.ts;server.ts;app.ts;main.go;main.py;Program.cs;__init__.py,shared/**;common/**;utils/**;lib/**;core/**;@*/**;pkg/**,pnpm-workspace.yaml;lerna.json;nx.json;go.work,*event*.ts;*queue*.ts;*subscriber*.ts;*consumer*.ts;*producer*.ts;*worker*.ts;*handler*.ts;jobs/**;workers/**,.github/workflows/**;.gitlab-ci.yml;Jenkinsfile;.circleci/**;azure-pipelines.yml;.drone.yml,N/A,N/A,*.proto;*.graphql;graphql/**;*.avro;*.thrift;openapi.*;swagger.*;schema/**,N/A,false,false
cli,false,false,false,false,false,package.json;go.mod;Cargo.toml;setup.py;pyproject.toml;*.gemspec,src/;cmd/;cli/;bin/;lib/;commands/,N/A,*.test.ts;*_test.go;test_*.py;*.spec.ts;*_spec.rb,.env*;config/*;*.config.*;.*.rc;.*rc,N/A,N/A,main.ts;index.ts;cli.ts;main.go;main.py;__main__.py;bin/*,shared/**;common/**;utils/**;lib/**;helpers/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;goreleaser.yml,N/A,N/A,N/A,N/A,false,false
library,false,false,false,false,false,package.json;setup.py;Cargo.toml;go.mod;*.gemspec;*.csproj;pom.xml,src/;lib/;dist/;pkg/;build/;target/,N/A,*.test.ts;*_test.go;test_*.py;*.spec.ts;*Test.java;*_test.rs,.*.rc;tsconfig.json;rollup.config.*;vite.config.*;webpack.config.*,N/A,N/A,index.ts;index.js;lib.rs;main.go;__init__.py,src/**;lib/**;core/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;.circleci/**,N/A,N/A,N/A,N/A,false,false
desktop,false,false,true,true,true,package.json;Cargo.toml;*.csproj;CMakeLists.txt;tauri.conf.json;electron-builder.yml;wails.json,src/;app/;components/;main/;renderer/;resources/;assets/;build/,*service.ts;ipc*.ts;*bridge*.ts;*native*.ts;invoke*,*.test.ts;*.spec.ts;*_test.rs;*.spec.tsx,.env*;config/*;*.config.*;app.config.*;forge.config.*;builder.config.*,*auth*.ts;*session*.ts;keychain*;secure-storage*,N/A,main.ts;index.ts;main.js;src-tauri/main.rs;electron.ts,shared/**;common/**;utils/**;lib/**;components/shared/**,N/A,*event*.ts;*ipc*.ts;*message*.ts,.github/workflows/**;.gitlab-ci.yml;.circleci/**,resources/**;assets/**;icons/**;static/**;build/resources,N/A,N/A,i18n/**;locales/**;translations/**;lang/**,false,true
game,false,false,true,false,false,*.unity;*.godot;*.uproject;package.json;project.godot,Assets/;Scenes/;Scripts/;Prefabs/;Resources/;Content/;Source/;src/;scenes/;scripts/,N/A,*Test.cs;*_test.gd;*Test.cpp;*.test.ts,.env*;config/*;*.ini;settings/;GameSettings/,N/A,N/A,main.gd;Main.cs;GameManager.cs;main.cpp;index.ts,shared/**;common/**;utils/**;Core/**;Framework/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml,Assets/**;Scenes/**;Prefabs/**;Materials/**;Textures/**;Audio/**;Models/**;*.fbx;*.blend;*.shader;*.hlsl;*.glsl;Shaders/**;VFX/**,N/A,N/A,Localization/**;Languages/**;i18n/**,false,true
data,false,true,false,false,true,requirements.txt;pyproject.toml;dbt_project.yml;airflow.cfg;setup.py;Pipfile,dags/;pipelines/;models/;transformations/;notebooks/;sql/;etl/;jobs/,N/A,test_*.py;*_test.py;tests/**,.env*;config/*;profiles.yml;dbt_project.yml;airflow.cfg,N/A,migrations/**;dbt/models/**;*.sql;schemas/**,main.py;__init__.py;pipeline.py;dag.py,shared/**;common/**;utils/**;lib/**;helpers/**,N/A,*event*.py;*consumer*.py;*producer*.py;*worker*.py;jobs/**;tasks/**,.github/workflows/**;.gitlab-ci.yml;airflow/dags/**,N/A,N/A,*.proto;*.avro;schemas/**;*.parquet,N/A,false,false
extension,true,false,true,true,false,manifest.json;package.json;wxt.config.ts,src/;popup/;content/;background/;assets/;components/,*message.ts;*runtime.ts;*storage.ts;*tabs.ts,*.test.ts;*.spec.ts;*.test.tsx,.env*;wxt.config.*;webpack.config.*;vite.config.*,*auth*.ts;*session*.ts;*permission*,N/A,index.ts;popup.ts;background.ts;content.ts,shared/**;common/**;utils/**;lib/**,N/A,*message*.ts;*event*.ts;chrome.runtime*;browser.runtime*,.github/workflows/**,assets/**;icons/**;images/**;static/**,N/A,N/A,_locales/**;locales/**;i18n/**,false,false
infra,false,false,false,false,true,*.tf;*.tfvars;pulumi.yaml;cdk.json;*.yml;*.yaml;Dockerfile;docker-compose*.yml,terraform/;modules/;k8s/;charts/;playbooks/;roles/;policies/;stacks/,N/A,*_test.go;test_*.py;*_test.tf;*_spec.rb,.env*;*.tfvars;config/*;vars/;group_vars/;host_vars/,N/A,N/A,main.tf;index.ts;__main__.py;playbook.yml,modules/**;shared/**;common/**;lib/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;.circleci/**,N/A,N/A,N/A,N/A,false,false
embedded,false,false,false,false,false,platformio.ini;CMakeLists.txt;*.ino;Makefile;*.ioc;mbed-os.lib,src/;lib/;include/;firmware/;drivers/;hal/;bsp/;components/,N/A,test_*.c;*_test.cpp;*_test.c;tests/**,.env*;config/*;sdkconfig;*.json;settings/,N/A,N/A,main.c;main.cpp;main.ino;app_main.c,lib/**;shared/**;common/**;drivers/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml,N/A,*.h;*.hpp;drivers/**;hal/**;bsp/**;pinout.*;peripheral*;gpio*;*.fzz;schematics/**,*.proto;mqtt*;coap*;modbus*,N/A,true,false
1 project_type_id,requires_api_scan,requires_data_models,requires_state_management,requires_ui_components,requires_deployment_config,key_file_patterns,critical_directories,integration_scan_patterns,test_file_patterns,config_patterns,auth_security_patterns,schema_migration_patterns,entry_point_patterns,shared_code_patterns,monorepo_workspace_patterns,async_event_patterns,ci_cd_patterns,asset_patterns,hardware_interface_patterns,protocol_schema_patterns,localization_patterns,requires_hardware_docs,requires_asset_inventory
2 web,true,true,true,true,true,package.json;tsconfig.json;*.config.js;*.config.ts;vite.config.*;webpack.config.*;next.config.*;nuxt.config.*,src/;app/;pages/;components/;api/;lib/;styles/;public/;static/,*client.ts;*service.ts;*api.ts;fetch*.ts;axios*.ts;*http*.ts,*.test.ts;*.spec.ts;*.test.tsx;*.spec.tsx;**/__tests__/**;**/*.test.*;**/*.spec.*,.env*;config/*;*.config.*;.config/;settings/,*auth*.ts;*session*.ts;middleware/auth*;*.guard.ts;*authenticat*;*permission*;guards/,migrations/**;prisma/**;*.prisma;alembic/**;knex/**;*migration*.sql;*migration*.ts,main.ts;index.ts;app.ts;server.ts;_app.tsx;_app.ts;layout.tsx,shared/**;common/**;utils/**;lib/**;helpers/**;@*/**;packages/**,pnpm-workspace.yaml;lerna.json;nx.json;turbo.json;workspace.json;rush.json,*event*.ts;*queue*.ts;*subscriber*.ts;*consumer*.ts;*producer*.ts;*worker*.ts;jobs/**,.github/workflows/**;.gitlab-ci.yml;Jenkinsfile;.circleci/**;azure-pipelines.yml;bitbucket-pipelines.yml,.drone.yml,public/**;static/**;assets/**;images/**;media/**,N/A,*.proto;*.graphql;graphql/**;schema.graphql;*.avro;openapi.*;swagger.*,i18n/**;locales/**;lang/**;translations/**;messages/**;*.po;*.pot,false,false
3 mobile,true,true,true,true,true,package.json;pubspec.yaml;Podfile;build.gradle;app.json;capacitor.config.*;ionic.config.json,src/;app/;screens/;components/;services/;models/;assets/;ios/;android/,*client.ts;*service.ts;*api.ts;fetch*.ts;axios*.ts;*http*.ts,*.test.ts;*.test.tsx;*_test.dart;*.test.dart;**/__tests__/**,.env*;config/*;app.json;capacitor.config.*;google-services.json;GoogleService-Info.plist,*auth*.ts;*session*.ts;*authenticat*;*permission*;*biometric*;secure-store*,migrations/**;realm/**;*.realm;watermelondb/**;sqlite/**,main.ts;index.ts;App.tsx;App.ts;main.dart,shared/**;common/**;utils/**;lib/**;components/shared/**;@*/**,pnpm-workspace.yaml;lerna.json;nx.json;turbo.json,*event*.ts;*notification*.ts;*push*.ts;background-fetch*,fastlane/**;.github/workflows/**;.gitlab-ci.yml;bitbucket-pipelines.yml;appcenter-*,assets/**;Resources/**;res/**;*.xcassets;drawable*/;mipmap*/;images/**,N/A,*.proto;graphql/**;*.graphql,i18n/**;locales/**;translations/**;*.strings;*.xml,false,true
4 backend,true,true,false,false,true,package.json;requirements.txt;go.mod;Gemfile;pom.xml;build.gradle;Cargo.toml;*.csproj,src/;api/;services/;models/;routes/;controllers/;middleware/;handlers/;repositories/;domain/,*client.ts;*repository.ts;*service.ts;*connector*.ts;*adapter*.ts,*.test.ts;*.spec.ts;*_test.go;test_*.py;*Test.java;*_test.rs,.env*;config/*;*.config.*;application*.yml;application*.yaml;appsettings*.json;settings.py,*auth*.ts;*session*.ts;*authenticat*;*authorization*;middleware/auth*;guards/;*jwt*;*oauth*,migrations/**;alembic/**;flyway/**;liquibase/**;prisma/**;*.prisma;*migration*.sql;*migration*.ts;db/migrate,main.ts;index.ts;server.ts;app.ts;main.go;main.py;Program.cs;__init__.py,shared/**;common/**;utils/**;lib/**;core/**;@*/**;pkg/**,pnpm-workspace.yaml;lerna.json;nx.json;go.work,*event*.ts;*queue*.ts;*subscriber*.ts;*consumer*.ts;*producer*.ts;*worker*.ts;*handler*.ts;jobs/**;workers/**,.github/workflows/**;.gitlab-ci.yml;Jenkinsfile;.circleci/**;azure-pipelines.yml;.drone.yml,N/A,N/A,*.proto;*.graphql;graphql/**;*.avro;*.thrift;openapi.*;swagger.*;schema/**,N/A,false,false
5 cli,false,false,false,false,false,package.json;go.mod;Cargo.toml;setup.py;pyproject.toml;*.gemspec,src/;cmd/;cli/;bin/;lib/;commands/,N/A,*.test.ts;*_test.go;test_*.py;*.spec.ts;*_spec.rb,.env*;config/*;*.config.*;.*.rc;.*rc,N/A,N/A,main.ts;index.ts;cli.ts;main.go;main.py;__main__.py;bin/*,shared/**;common/**;utils/**;lib/**;helpers/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;goreleaser.yml,N/A,N/A,N/A,N/A,false,false
6 library,false,false,false,false,false,package.json;setup.py;Cargo.toml;go.mod;*.gemspec;*.csproj;pom.xml,src/;lib/;dist/;pkg/;build/;target/,N/A,*.test.ts;*_test.go;test_*.py;*.spec.ts;*Test.java;*_test.rs,.*.rc;tsconfig.json;rollup.config.*;vite.config.*;webpack.config.*,N/A,N/A,index.ts;index.js;lib.rs;main.go;__init__.py,src/**;lib/**;core/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;.circleci/**,N/A,N/A,N/A,N/A,false,false
7 desktop,false,false,true,true,true,package.json;Cargo.toml;*.csproj;CMakeLists.txt;tauri.conf.json;electron-builder.yml;wails.json,src/;app/;components/;main/;renderer/;resources/;assets/;build/,*service.ts;ipc*.ts;*bridge*.ts;*native*.ts;invoke*,*.test.ts;*.spec.ts;*_test.rs;*.spec.tsx,.env*;config/*;*.config.*;app.config.*;forge.config.*;builder.config.*,*auth*.ts;*session*.ts;keychain*;secure-storage*,N/A,main.ts;index.ts;main.js;src-tauri/main.rs;electron.ts,shared/**;common/**;utils/**;lib/**;components/shared/**,N/A,*event*.ts;*ipc*.ts;*message*.ts,.github/workflows/**;.gitlab-ci.yml;.circleci/**,resources/**;assets/**;icons/**;static/**;build/resources,N/A,N/A,i18n/**;locales/**;translations/**;lang/**,false,true
8 game,false,false,true,false,false,*.unity;*.godot;*.uproject;package.json;project.godot,Assets/;Scenes/;Scripts/;Prefabs/;Resources/;Content/;Source/;src/;scenes/;scripts/,N/A,*Test.cs;*_test.gd;*Test.cpp;*.test.ts,.env*;config/*;*.ini;settings/;GameSettings/,N/A,N/A,main.gd;Main.cs;GameManager.cs;main.cpp;index.ts,shared/**;common/**;utils/**;Core/**;Framework/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml,Assets/**;Scenes/**;Prefabs/**;Materials/**;Textures/**;Audio/**;Models/**;*.fbx;*.blend;*.shader;*.hlsl;*.glsl;Shaders/**;VFX/**,N/A,N/A,Localization/**;Languages/**;i18n/**,false,true
9 data,false,true,false,false,true,requirements.txt;pyproject.toml;dbt_project.yml;airflow.cfg;setup.py;Pipfile,dags/;pipelines/;models/;transformations/;notebooks/;sql/;etl/;jobs/,N/A,test_*.py;*_test.py;tests/**,.env*;config/*;profiles.yml;dbt_project.yml;airflow.cfg,N/A,migrations/**;dbt/models/**;*.sql;schemas/**,main.py;__init__.py;pipeline.py;dag.py,shared/**;common/**;utils/**;lib/**;helpers/**,N/A,*event*.py;*consumer*.py;*producer*.py;*worker*.py;jobs/**;tasks/**,.github/workflows/**;.gitlab-ci.yml;airflow/dags/**,N/A,N/A,*.proto;*.avro;schemas/**;*.parquet,N/A,false,false
10 extension,true,false,true,true,false,manifest.json;package.json;wxt.config.ts,src/;popup/;content/;background/;assets/;components/,*message.ts;*runtime.ts;*storage.ts;*tabs.ts,*.test.ts;*.spec.ts;*.test.tsx,.env*;wxt.config.*;webpack.config.*;vite.config.*,*auth*.ts;*session*.ts;*permission*,N/A,index.ts;popup.ts;background.ts;content.ts,shared/**;common/**;utils/**;lib/**,N/A,*message*.ts;*event*.ts;chrome.runtime*;browser.runtime*,.github/workflows/**,assets/**;icons/**;images/**;static/**,N/A,N/A,_locales/**;locales/**;i18n/**,false,false
11 infra,false,false,false,false,true,*.tf;*.tfvars;pulumi.yaml;cdk.json;*.yml;*.yaml;Dockerfile;docker-compose*.yml,terraform/;modules/;k8s/;charts/;playbooks/;roles/;policies/;stacks/,N/A,*_test.go;test_*.py;*_test.tf;*_spec.rb,.env*;*.tfvars;config/*;vars/;group_vars/;host_vars/,N/A,N/A,main.tf;index.ts;__main__.py;playbook.yml,modules/**;shared/**;common/**;lib/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml;.circleci/**,N/A,N/A,N/A,N/A,false,false
12 embedded,false,false,false,false,false,platformio.ini;CMakeLists.txt;*.ino;Makefile;*.ioc;mbed-os.lib,src/;lib/;include/;firmware/;drivers/;hal/;bsp/;components/,N/A,test_*.c;*_test.cpp;*_test.c;tests/**,.env*;config/*;sdkconfig;*.json;settings/,N/A,N/A,main.c;main.cpp;main.ino;app_main.c,lib/**;shared/**;common/**;drivers/**,N/A,N/A,.github/workflows/**;.gitlab-ci.yml,N/A,*.h;*.hpp;drivers/**;hal/**;bsp/**;pinout.*;peripheral*;gpio*;*.fzz;schematics/**,*.proto;mqtt*;coap*;modbus*,N/A,true,false

View File

@ -0,0 +1,221 @@
# Document Project Workflow Router
<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/document-project/workflow.yaml</critical>
<critical>Communicate all responses in {communication_language}</critical>
<workflow>
<critical>This router determines workflow mode and delegates to specialized sub-workflows</critical>
<step n="1" goal="Validate workflow and get project info">
<invoke-workflow path="{project-root}/_bmad/bmm/workflows/workflow-status">
<param>mode: data</param>
<param>data_request: project_config</param>
</invoke-workflow>
<check if="status_exists == false">
<output>{{suggestion}}</output>
<output>Note: Documentation workflow can run standalone. Continuing without progress tracking.</output>
<action>Set standalone_mode = true</action>
<action>Set status_file_found = false</action>
</check>
<check if="status_exists == true">
<action>Store {{status_file_path}} for later updates</action>
<action>Set status_file_found = true</action>
<!-- Extract brownfield/greenfield from status data -->
<check if="field_type == 'greenfield'">
<output>Note: This is a greenfield project. Documentation workflow is typically for brownfield projects.</output>
<ask>Continue anyway to document planning artifacts? (y/n)</ask>
<check if="n">
<action>Exit workflow</action>
</check>
</check>
<!-- Now validate sequencing -->
<invoke-workflow path="{project-root}/_bmad/bmm/workflows/workflow-status">
<param>mode: validate</param>
<param>calling_workflow: document-project</param>
</invoke-workflow>
<check if="warning != ''">
<output>{{warning}}</output>
<output>Note: This may be auto-invoked by prd for brownfield documentation.</output>
<ask>Continue with documentation? (y/n)</ask>
<check if="n">
<output>{{suggestion}}</output>
<action>Exit workflow</action>
</check>
</check>
</check>
</step>
<step n="2" goal="Check for resumability and determine workflow mode">
<critical>SMART LOADING STRATEGY: Check state file FIRST before loading any CSV files</critical>
<action>Check for existing state file at: {output_folder}/project-scan-report.json</action>
<check if="project-scan-report.json exists">
<action>Read state file and extract: timestamps, mode, scan_level, current_step, completed_steps, project_classification</action>
<action>Extract cached project_type_id(s) from state file if present</action>
<action>Calculate age of state file (current time - last_updated)</action>
<ask>I found an in-progress workflow state from {{last_updated}}.
**Current Progress:**
- Mode: {{mode}}
- Scan Level: {{scan_level}}
- Completed Steps: {{completed_steps_count}}/{{total_steps}}
- Last Step: {{current_step}}
- Project Type(s): {{cached_project_types}}
Would you like to:
1. **Resume from where we left off** - Continue from step {{current_step}}
2. **Start fresh** - Archive old state and begin new scan
3. **Cancel** - Exit without changes
Your choice [1/2/3]:
</ask>
<check if="user selects 1">
<action>Set resume_mode = true</action>
<action>Set workflow_mode = {{mode}}</action>
<action>Load findings summaries from state file</action>
<action>Load cached project_type_id(s) from state file</action>
<critical>CONDITIONAL CSV LOADING FOR RESUME:</critical>
<action>For each cached project_type_id, load ONLY the corresponding row from: {documentation_requirements_csv}</action>
<action>Skip loading project-types.csv and architecture_registry.csv (not needed on resume)</action>
<action>Store loaded doc requirements for use in remaining steps</action>
<action>Display: "Resuming {{workflow_mode}} from {{current_step}} with cached project type(s): {{cached_project_types}}"</action>
<check if="workflow_mode == deep_dive">
<action>Read fully and follow: {installed_path}/workflows/deep-dive-instructions.md with resume context</action>
</check>
<check if="workflow_mode == initial_scan OR workflow_mode == full_rescan">
<action>Read fully and follow: {installed_path}/workflows/full-scan-instructions.md with resume context</action>
</check>
</check>
<check if="user selects 2">
<action>Create archive directory: {output_folder}/.archive/</action>
<action>Move old state file to: {output_folder}/.archive/project-scan-report-{{timestamp}}.json</action>
<action>Set resume_mode = false</action>
<action>Continue to Step 0.5</action>
</check>
<check if="user selects 3">
<action>Display: "Exiting workflow without changes."</action>
<action>Exit workflow</action>
</check>
<check if="state file age >= 24 hours">
<action>Display: "Found old state file (>24 hours). Starting fresh scan."</action>
<action>Archive old state file to: {output_folder}/.archive/project-scan-report-{{timestamp}}.json</action>
<action>Set resume_mode = false</action>
<action>Continue to Step 0.5</action>
</check>
</step>
<step n="3" goal="Check for existing documentation and determine workflow mode" if="resume_mode == false">
<action>Check if {output_folder}/index.md exists</action>
<check if="index.md exists">
<action>Read existing index.md to extract metadata (date, project structure, parts count)</action>
<action>Store as {{existing_doc_date}}, {{existing_structure}}</action>
<ask>I found existing documentation generated on {{existing_doc_date}}.
What would you like to do?
1. **Re-scan entire project** - Update all documentation with latest changes
2. **Deep-dive into specific area** - Generate detailed documentation for a particular feature/module/folder
3. **Cancel** - Keep existing documentation as-is
Your choice [1/2/3]:
</ask>
<check if="user selects 1">
<action>Set workflow_mode = "full_rescan"</action>
<action>Display: "Starting full project rescan..."</action>
<action>Read fully and follow: {installed_path}/workflows/full-scan-instructions.md</action>
<action>After sub-workflow completes, continue to Step 4</action>
</check>
<check if="user selects 2">
<action>Set workflow_mode = "deep_dive"</action>
<action>Set scan_level = "exhaustive"</action>
<action>Display: "Starting deep-dive documentation mode..."</action>
<action>Read fully and follow: {installed_path}/workflows/deep-dive-instructions.md</action>
<action>After sub-workflow completes, continue to Step 4</action>
</check>
<check if="user selects 3">
<action>Display message: "Keeping existing documentation. Exiting workflow."</action>
<action>Exit workflow</action>
</check>
</check>
<check if="index.md does not exist">
<action>Set workflow_mode = "initial_scan"</action>
<action>Display: "No existing documentation found. Starting initial project scan..."</action>
<action>Read fully and follow: {installed_path}/workflows/full-scan-instructions.md</action>
<action>After sub-workflow completes, continue to Step 4</action>
</check>
</step>
<step n="4" goal="Update status and complete">
<check if="status_file_found == true">
<invoke-workflow path="{project-root}/_bmad/bmm/workflows/workflow-status">
<param>mode: update</param>
<param>action: complete_workflow</param>
<param>workflow_name: document-project</param>
</invoke-workflow>
<check if="success == true">
<output>Status updated!</output>
</check>
</check>
<output>**✅ Document Project Workflow Complete, {user_name}!**
**Documentation Generated:**
- Mode: {{workflow_mode}}
- Scan Level: {{scan_level}}
- Output: {output_folder}/index.md and related files
{{#if status_file_found}}
**Status Updated:**
- Progress tracking updated
**Next Steps:**
- **Next required:** {{next_workflow}} ({{next_agent}} agent)
Check status anytime with: `workflow-status`
{{else}}
**Next Steps:**
Since no workflow is in progress:
- Refer to the BMM workflow guide if unsure what to do next
- Or run `workflow-init` to create a workflow path and get guided next steps
{{/if}}
</output>
</step>
</workflow>

View File

@ -0,0 +1,345 @@
# {{target_name}} - Deep Dive Documentation
**Generated:** {{date}}
**Scope:** {{target_path}}
**Files Analyzed:** {{file_count}}
**Lines of Code:** {{total_loc}}
**Workflow Mode:** Exhaustive Deep-Dive
## Overview
{{target_description}}
**Purpose:** {{target_purpose}}
**Key Responsibilities:** {{responsibilities}}
**Integration Points:** {{integration_summary}}
## Complete File Inventory
{{#each files_in_inventory}}
### {{file_path}}
**Purpose:** {{purpose}}
**Lines of Code:** {{loc}}
**File Type:** {{file_type}}
**What Future Contributors Must Know:** {{contributor_note}}
**Exports:**
{{#each exports}}
- `{{signature}}` - {{description}}
{{/each}}
**Dependencies:**
{{#each imports}}
- `{{import_path}}` - {{reason}}
{{/each}}
**Used By:**
{{#each dependents}}
- `{{dependent_path}}`
{{/each}}
**Key Implementation Details:**
```{{language}}
{{key_code_snippet}}
```
{{implementation_notes}}
**Patterns Used:**
{{#each patterns}}
- {{pattern_name}}: {{pattern_description}}
{{/each}}
**State Management:** {{state_approach}}
**Side Effects:**
{{#each side_effects}}
- {{effect_type}}: {{effect_description}}
{{/each}}
**Error Handling:** {{error_handling_approach}}
**Testing:**
- Test File: {{test_file_path}}
- Coverage: {{coverage_percentage}}%
- Test Approach: {{test_approach}}
**Comments/TODOs:**
{{#each todos}}
- Line {{line_number}}: {{todo_text}}
{{/each}}
---
{{/each}}
## Contributor Checklist
- **Risks & Gotchas:** {{risks_notes}}
- **Pre-change Verification Steps:** {{verification_steps}}
- **Suggested Tests Before PR:** {{suggested_tests}}
## Architecture & Design Patterns
### Code Organization
{{organization_approach}}
### Design Patterns
{{#each design_patterns}}
- **{{pattern_name}}**: {{usage_description}}
{{/each}}
### State Management Strategy
{{state_management_details}}
### Error Handling Philosophy
{{error_handling_philosophy}}
### Testing Strategy
{{testing_strategy}}
## Data Flow
{{data_flow_diagram}}
### Data Entry Points
{{#each entry_points}}
- **{{entry_name}}**: {{entry_description}}
{{/each}}
### Data Transformations
{{#each transformations}}
- **{{transformation_name}}**: {{transformation_description}}
{{/each}}
### Data Exit Points
{{#each exit_points}}
- **{{exit_name}}**: {{exit_description}}
{{/each}}
## Integration Points
### APIs Consumed
{{#each apis_consumed}}
- **{{api_endpoint}}**: {{api_description}}
- Method: {{method}}
- Authentication: {{auth_requirement}}
- Response: {{response_schema}}
{{/each}}
### APIs Exposed
{{#each apis_exposed}}
- **{{api_endpoint}}**: {{api_description}}
- Method: {{method}}
- Request: {{request_schema}}
- Response: {{response_schema}}
{{/each}}
### Shared State
{{#each shared_state}}
- **{{state_name}}**: {{state_description}}
- Type: {{state_type}}
- Accessed By: {{accessors}}
{{/each}}
### Events
{{#each events}}
- **{{event_name}}**: {{event_description}}
- Type: {{publish_or_subscribe}}
- Payload: {{payload_schema}}
{{/each}}
### Database Access
{{#each database_operations}}
- **{{table_name}}**: {{operation_type}}
- Queries: {{query_patterns}}
- Indexes Used: {{indexes}}
{{/each}}
## Dependency Graph
{{dependency_graph_visualization}}
### Entry Points (Not Imported by Others in Scope)
{{#each entry_point_files}}
- {{file_path}}
{{/each}}
### Leaf Nodes (Don't Import Others in Scope)
{{#each leaf_files}}
- {{file_path}}
{{/each}}
### Circular Dependencies
{{#if has_circular_dependencies}}
⚠️ Circular dependencies detected:
{{#each circular_deps}}
- {{cycle_description}}
{{/each}}
{{else}}
✓ No circular dependencies detected
{{/if}}
## Testing Analysis
### Test Coverage Summary
- **Statements:** {{statements_coverage}}%
- **Branches:** {{branches_coverage}}%
- **Functions:** {{functions_coverage}}%
- **Lines:** {{lines_coverage}}%
### Test Files
{{#each test_files}}
- **{{test_file_path}}**
- Tests: {{test_count}}
- Approach: {{test_approach}}
- Mocking Strategy: {{mocking_strategy}}
{{/each}}
### Test Utilities Available
{{#each test_utilities}}
- `{{utility_name}}`: {{utility_description}}
{{/each}}
### Testing Gaps
{{#each testing_gaps}}
- {{gap_description}}
{{/each}}
## Related Code & Reuse Opportunities
### Similar Features Elsewhere
{{#each similar_features}}
- **{{feature_name}}** (`{{feature_path}}`)
- Similarity: {{similarity_description}}
- Can Reference For: {{reference_use_case}}
{{/each}}
### Reusable Utilities Available
{{#each reusable_utilities}}
- **{{utility_name}}** (`{{utility_path}}`)
- Purpose: {{utility_purpose}}
- How to Use: {{usage_example}}
{{/each}}
### Patterns to Follow
{{#each patterns_to_follow}}
- **{{pattern_name}}**: Reference `{{reference_file}}` for implementation
{{/each}}
## Implementation Notes
### Code Quality Observations
{{#each quality_observations}}
- {{observation}}
{{/each}}
### TODOs and Future Work
{{#each all_todos}}
- **{{file_path}}:{{line_number}}**: {{todo_text}}
{{/each}}
### Known Issues
{{#each known_issues}}
- {{issue_description}}
{{/each}}
### Optimization Opportunities
{{#each optimizations}}
- {{optimization_suggestion}}
{{/each}}
### Technical Debt
{{#each tech_debt_items}}
- {{debt_description}}
{{/each}}
## Modification Guidance
### To Add New Functionality
{{modification_guidance_add}}
### To Modify Existing Functionality
{{modification_guidance_modify}}
### To Remove/Deprecate
{{modification_guidance_remove}}
### Testing Checklist for Changes
{{#each testing_checklist_items}}
- [ ] {{checklist_item}}
{{/each}}
---
_Generated by `document-project` workflow (deep-dive mode)_
_Base Documentation: docs/index.md_
_Scan Date: {{date}}_
_Analysis Mode: Exhaustive_

View File

@ -0,0 +1,169 @@
# {{project_name}} Documentation Index
**Type:** {{repository_type}}{{#if is_multi_part}} with {{parts_count}} parts{{/if}}
**Primary Language:** {{primary_language}}
**Architecture:** {{architecture_type}}
**Last Updated:** {{date}}
## Project Overview
{{project_description}}
{{#if is_multi_part}}
## Project Structure
This project consists of {{parts_count}} parts:
{{#each project_parts}}
### {{part_name}} ({{part_id}})
- **Type:** {{project_type}}
- **Location:** `{{root_path}}`
- **Tech Stack:** {{tech_stack_summary}}
- **Entry Point:** {{entry_point}}
{{/each}}
## Cross-Part Integration
{{integration_summary}}
{{/if}}
## Quick Reference
{{#if is_single_part}}
- **Tech Stack:** {{tech_stack_summary}}
- **Entry Point:** {{entry_point}}
- **Architecture Pattern:** {{architecture_pattern}}
- **Database:** {{database}}
- **Deployment:** {{deployment_platform}}
{{else}}
{{#each project_parts}}
### {{part_name}} Quick Ref
- **Stack:** {{tech_stack_summary}}
- **Entry:** {{entry_point}}
- **Pattern:** {{architecture_pattern}}
{{/each}}
{{/if}}
## Generated Documentation
### Core Documentation
- [Project Overview](./project-overview.md) - Executive summary and high-level architecture
- [Source Tree Analysis](./source-tree-analysis.md) - Annotated directory structure
{{#if is_single_part}}
- [Architecture](./architecture.md) - Detailed technical architecture
- [Component Inventory](./component-inventory.md) - Catalog of major components{{#if has_ui_components}} and UI elements{{/if}}
- [Development Guide](./development-guide.md) - Local setup and development workflow
{{#if has_api_docs}}- [API Contracts](./api-contracts.md) - API endpoints and schemas{{/if}}
{{#if has_data_models}}- [Data Models](./data-models.md) - Database schema and models{{/if}}
{{else}}
### Part-Specific Documentation
{{#each project_parts}}
#### {{part_name}} ({{part_id}})
- [Architecture](./architecture-{{part_id}}.md) - Technical architecture for {{part_name}}
{{#if has_components}}- [Components](./component-inventory-{{part_id}}.md) - Component catalog{{/if}}
- [Development Guide](./development-guide-{{part_id}}.md) - Setup and dev workflow
{{#if has_api}}- [API Contracts](./api-contracts-{{part_id}}.md) - API documentation{{/if}}
{{#if has_data}}- [Data Models](./data-models-{{part_id}}.md) - Data architecture{{/if}}
{{/each}}
### Integration
- [Integration Architecture](./integration-architecture.md) - How parts communicate
- [Project Parts Metadata](./project-parts.json) - Machine-readable structure
{{/if}}
### Optional Documentation
{{#if has_deployment_guide}}- [Deployment Guide](./deployment-guide.md) - Deployment process and infrastructure{{/if}}
{{#if has_contribution_guide}}- [Contribution Guide](./contribution-guide.md) - Contributing guidelines and standards{{/if}}
## Existing Documentation
{{#if has_existing_docs}}
{{#each existing_docs}}
- [{{title}}]({{path}}) - {{description}}
{{/each}}
{{else}}
No existing documentation files were found in the project.
{{/if}}
## Getting Started
{{#if is_single_part}}
### Prerequisites
{{prerequisites}}
### Setup
```bash
{{setup_commands}}
```
### Run Locally
```bash
{{run_commands}}
```
### Run Tests
```bash
{{test_commands}}
```
{{else}}
{{#each project_parts}}
### {{part_name}} Setup
**Prerequisites:** {{prerequisites}}
**Install & Run:**
```bash
cd {{root_path}}
{{setup_command}}
{{run_command}}
```
{{/each}}
{{/if}}
## For AI-Assisted Development
This documentation was generated specifically to enable AI agents to understand and extend this codebase.
### When Planning New Features:
**UI-only features:**
{{#if is_multi_part}}→ Reference: `architecture-{{ui_part_id}}.md`, `component-inventory-{{ui_part_id}}.md`{{else}}→ Reference: `architecture.md`, `component-inventory.md`{{/if}}
**API/Backend features:**
{{#if is_multi_part}}→ Reference: `architecture-{{api_part_id}}.md`, `api-contracts-{{api_part_id}}.md`, `data-models-{{api_part_id}}.md`{{else}}→ Reference: `architecture.md`{{#if has_api_docs}}, `api-contracts.md`{{/if}}{{#if has_data_models}}, `data-models.md`{{/if}}{{/if}}
**Full-stack features:**
→ Reference: All architecture docs{{#if is_multi_part}} + `integration-architecture.md`{{/if}}
**Deployment changes:**
{{#if has_deployment_guide}}→ Reference: `deployment-guide.md`{{else}}→ Review CI/CD configs in project{{/if}}
---
_Documentation generated by BMAD Method `document-project` workflow_

View File

@ -0,0 +1,103 @@
# {{project_name}} - Project Overview
**Date:** {{date}}
**Type:** {{project_type}}
**Architecture:** {{architecture_type}}
## Executive Summary
{{executive_summary}}
## Project Classification
- **Repository Type:** {{repository_type}}
- **Project Type(s):** {{project_types_list}}
- **Primary Language(s):** {{primary_languages}}
- **Architecture Pattern:** {{architecture_pattern}}
{{#if is_multi_part}}
## Multi-Part Structure
This project consists of {{parts_count}} distinct parts:
{{#each project_parts}}
### {{part_name}}
- **Type:** {{project_type}}
- **Location:** `{{root_path}}`
- **Purpose:** {{purpose}}
- **Tech Stack:** {{tech_stack}}
{{/each}}
### How Parts Integrate
{{integration_description}}
{{/if}}
## Technology Stack Summary
{{#if is_single_part}}
{{technology_table}}
{{else}}
{{#each project_parts}}
### {{part_name}} Stack
{{technology_table}}
{{/each}}
{{/if}}
## Key Features
{{key_features}}
## Architecture Highlights
{{architecture_highlights}}
## Development Overview
### Prerequisites
{{prerequisites}}
### Getting Started
{{getting_started_summary}}
### Key Commands
{{#if is_single_part}}
- **Install:** `{{install_command}}`
- **Dev:** `{{dev_command}}`
- **Build:** `{{build_command}}`
- **Test:** `{{test_command}}`
{{else}}
{{#each project_parts}}
#### {{part_name}}
- **Install:** `{{install_command}}`
- **Dev:** `{{dev_command}}`
{{/each}}
{{/if}}
## Repository Structure
{{repository_structure_summary}}
## Documentation Map
For detailed information, see:
- [index.md](./index.md) - Master documentation index
- [architecture.md](./architecture{{#if is_multi_part}}-{part_id}{{/if}}.md) - Detailed architecture
- [source-tree-analysis.md](./source-tree-analysis.md) - Directory structure
- [development-guide.md](./development-guide{{#if is_multi_part}}-{part_id}{{/if}}.md) - Development workflow
---
_Generated using BMAD Method `document-project` workflow_

View File

@ -0,0 +1,160 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Project Scan Report Schema",
"description": "State tracking file for document-project workflow resumability",
"type": "object",
"required": ["workflow_version", "timestamps", "mode", "scan_level", "completed_steps", "current_step"],
"properties": {
"workflow_version": {
"type": "string",
"description": "Version of document-project workflow",
"example": "1.2.0"
},
"timestamps": {
"type": "object",
"required": ["started", "last_updated"],
"properties": {
"started": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp when workflow started"
},
"last_updated": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of last state update"
},
"completed": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp when workflow completed (if finished)"
}
}
},
"mode": {
"type": "string",
"enum": ["initial_scan", "full_rescan", "deep_dive"],
"description": "Workflow execution mode"
},
"scan_level": {
"type": "string",
"enum": ["quick", "deep", "exhaustive"],
"description": "Scan depth level (deep_dive mode always uses exhaustive)"
},
"project_root": {
"type": "string",
"description": "Absolute path to project root directory"
},
"output_folder": {
"type": "string",
"description": "Absolute path to output folder"
},
"completed_steps": {
"type": "array",
"items": {
"type": "object",
"required": ["step", "status"],
"properties": {
"step": {
"type": "string",
"description": "Step identifier (e.g., 'step_1', 'step_2')"
},
"status": {
"type": "string",
"enum": ["completed", "partial", "failed"]
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"outputs": {
"type": "array",
"items": { "type": "string" },
"description": "Files written during this step"
},
"summary": {
"type": "string",
"description": "1-2 sentence summary of step outcome"
}
}
}
},
"current_step": {
"type": "string",
"description": "Current step identifier for resumption"
},
"findings": {
"type": "object",
"description": "High-level summaries only (detailed findings purged after writing)",
"properties": {
"project_classification": {
"type": "object",
"properties": {
"repository_type": { "type": "string" },
"parts_count": { "type": "integer" },
"primary_language": { "type": "string" },
"architecture_type": { "type": "string" }
}
},
"technology_stack": {
"type": "array",
"items": {
"type": "object",
"properties": {
"part_id": { "type": "string" },
"tech_summary": { "type": "string" }
}
}
},
"batches_completed": {
"type": "array",
"description": "For deep/exhaustive scans: subfolders processed",
"items": {
"type": "object",
"properties": {
"path": { "type": "string" },
"files_scanned": { "type": "integer" },
"summary": { "type": "string" }
}
}
}
}
},
"outputs_generated": {
"type": "array",
"items": { "type": "string" },
"description": "List of all output files generated"
},
"resume_instructions": {
"type": "string",
"description": "Instructions for resuming from current_step"
},
"validation_status": {
"type": "object",
"properties": {
"last_validated": {
"type": "string",
"format": "date-time"
},
"validation_errors": {
"type": "array",
"items": { "type": "string" }
}
}
},
"deep_dive_targets": {
"type": "array",
"description": "Track deep-dive areas analyzed (for deep_dive mode)",
"items": {
"type": "object",
"properties": {
"target_name": { "type": "string" },
"target_path": { "type": "string" },
"files_analyzed": { "type": "integer" },
"output_file": { "type": "string" },
"timestamp": { "type": "string", "format": "date-time" }
}
}
}
}
}

View File

@ -0,0 +1,135 @@
# {{project_name}} - Source Tree Analysis
**Date:** {{date}}
## Overview
{{source_tree_overview}}
{{#if is_multi_part}}
## Multi-Part Structure
This project is organized into {{parts_count}} distinct parts:
{{#each project_parts}}
- **{{part_name}}** (`{{root_path}}`): {{purpose}}
{{/each}}
{{/if}}
## Complete Directory Structure
```
{{complete_source_tree}}
```
## Critical Directories
{{#each critical_folders}}
### `{{folder_path}}`
{{description}}
**Purpose:** {{purpose}}
**Contains:** {{contents_summary}}
{{#if entry_points}}**Entry Points:** {{entry_points}}{{/if}}
{{#if integration_note}}**Integration:** {{integration_note}}{{/if}}
{{/each}}
{{#if is_multi_part}}
## Part-Specific Trees
{{#each project_parts}}
### {{part_name}} Structure
```
{{source_tree}}
```
**Key Directories:**
{{#each critical_directories}}
- **`{{path}}`**: {{description}}
{{/each}}
{{/each}}
## Integration Points
{{#each integration_points}}
### {{from_part}} → {{to_part}}
- **Location:** `{{integration_path}}`
- **Type:** {{integration_type}}
- **Details:** {{details}}
{{/each}}
{{/if}}
## Entry Points
{{#if is_single_part}}
- **Main Entry:** `{{main_entry_point}}`
{{#if additional_entry_points}}
- **Additional:**
{{#each additional_entry_points}}
- `{{path}}`: {{description}}
{{/each}}
{{/if}}
{{else}}
{{#each project_parts}}
### {{part_name}}
- **Entry Point:** `{{entry_point}}`
- **Bootstrap:** {{bootstrap_description}}
{{/each}}
{{/if}}
## File Organization Patterns
{{file_organization_patterns}}
## Key File Types
{{#each file_type_patterns}}
### {{file_type}}
- **Pattern:** `{{pattern}}`
- **Purpose:** {{purpose}}
- **Examples:** {{examples}}
{{/each}}
## Asset Locations
{{#if has_assets}}
{{#each asset_locations}}
- **{{asset_type}}**: `{{location}}` ({{file_count}} files, {{total_size}})
{{/each}}
{{else}}
No significant assets detected.
{{/if}}
## Configuration Files
{{#each config_files}}
- **`{{path}}`**: {{description}}
{{/each}}
## Notes for Development
{{development_notes}}
---
_Generated using BMAD Method `document-project` workflow_

View File

@ -0,0 +1,30 @@
# Document Project Workflow Configuration
name: "document-project"
version: "1.2.0"
description: "Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development"
author: "BMad"
# Critical variables
config_source: "{project-root}/_bmad/bmm/config.yaml"
output_folder: "{config_source}:project_knowledge"
user_name: "{config_source}:user_name"
communication_language: "{config_source}:communication_language"
document_output_language: "{config_source}:document_output_language"
user_skill_level: "{config_source}:user_skill_level"
date: system-generated
# Module path and component files
installed_path: "{project-root}/_bmad/bmm/workflows/document-project"
instructions: "{installed_path}/instructions.md"
validation: "{installed_path}/checklist.md"
# Required data files - CRITICAL for project type detection and documentation requirements
documentation_requirements_csv: "{installed_path}/documentation-requirements.csv"
# Output configuration - Multiple files generated in output folder
# Primary output: {output_folder}/project-documentation/
# Additional files generated by sub-workflows based on project structure
standalone: true
web_bundle: false

View File

@ -0,0 +1,298 @@
# Deep-Dive Documentation Instructions
<workflow>
<critical>This workflow performs exhaustive deep-dive documentation of specific areas</critical>
<critical>Called by: ../document-project/instructions.md router</critical>
<critical>Handles: deep_dive mode only</critical>
<step n="13" goal="Deep-dive documentation of specific area" if="workflow_mode == deep_dive">
<critical>Deep-dive mode requires literal full-file review. Sampling, guessing, or relying solely on tooling output is FORBIDDEN.</critical>
<action>Load existing project structure from index.md and project-parts.json (if exists)</action>
<action>Load source tree analysis to understand available areas</action>
<step n="13a" goal="Identify area for deep-dive">
<action>Analyze existing documentation to suggest deep-dive options</action>
<ask>What area would you like to deep-dive into?
**Suggested Areas Based on Project Structure:**
{{#if has_api_routes}}
## API Routes ({{api_route_count}} endpoints found)
{{#each api_route_groups}}
{{group_index}}. {{group_name}} - {{endpoint_count}} endpoints in `{{path}}`
{{/each}}
{{/if}}
{{#if has_feature_modules}}
## Feature Modules ({{feature_count}} features)
{{#each feature_modules}}
{{module_index}}. {{module_name}} - {{file_count}} files in `{{path}}`
{{/each}}
{{/if}}
{{#if has_ui_components}}
### UI Component Areas
{{#each component_groups}}
{{group_index}}. {{group_name}} - {{component_count}} components in `{{path}}`
{{/each}}
{{/if}}
{{#if has_services}}
### Services/Business Logic
{{#each service_groups}}
{{service_index}}. {{service_name}} - `{{path}}`
{{/each}}
{{/if}}
**Or specify custom:**
- Folder path (e.g., "client/src/features/dashboard")
- File path (e.g., "server/src/api/users.ts")
- Feature name (e.g., "authentication system")
Enter your choice (number or custom path):
</ask>
<action>Parse user input to determine: - target_type: "folder" | "file" | "feature" | "api_group" | "component_group" - target_path: Absolute path to scan - target_name: Human-readable name for documentation - target_scope: List of all files to analyze
</action>
<action>Store as {{deep_dive_target}}</action>
<action>Display confirmation:
Target: {{target_name}}
Type: {{target_type}}
Path: {{target_path}}
Estimated files to analyze: {{estimated_file_count}}
This will read EVERY file in this area. Proceed? [y/n]
</action>
<action if="user confirms 'n'">Return to Step 13a (select different area)</action>
</step>
<step n="13b" goal="Comprehensive exhaustive scan of target area">
<action>Set scan_mode = "exhaustive"</action>
<action>Initialize file_inventory = []</action>
<critical>You must read every line of every file in scope and capture a plain-language explanation (what the file does, side effects, why it matters) that future developer agents can act on. No shortcuts.</critical>
<check if="target_type == folder">
<action>Get complete recursive file list from {{target_path}}</action>
<action>Filter out: node_modules/, .git/, dist/, build/, coverage/, *.min.js, *.map</action>
<action>For EVERY remaining file in folder:
- Read complete file contents (all lines)
- Extract all exports (functions, classes, types, interfaces, constants)
- Extract all imports (dependencies)
- Identify purpose from comments and code structure
- Write 1-2 sentences (minimum) in natural language describing behaviour, side effects, assumptions, and anything a developer must know before modifying the file
- Extract function signatures with parameter types and return types
- Note any TODOs, FIXMEs, or comments
- Identify patterns (hooks, components, services, controllers, etc.)
- Capture per-file contributor guidance: `contributor_note`, `risks`, `verification_steps`, `suggested_tests`
- Store in file_inventory
</action>
</check>
<check if="target_type == file">
<action>Read complete file at {{target_path}}</action>
<action>Extract all information as above</action>
<action>Read all files it imports (follow import chain 1 level deep)</action>
<action>Find all files that import this file (dependents via grep)</action>
<action>Store all in file_inventory</action>
</check>
<check if="target_type == api_group">
<action>Identify all route/controller files in API group</action>
<action>Read all route handlers completely</action>
<action>Read associated middleware, controllers, services</action>
<action>Read data models and schemas used</action>
<action>Extract complete request/response schemas</action>
<action>Document authentication and authorization requirements</action>
<action>Store all in file_inventory</action>
</check>
<check if="target_type == feature">
<action>Search codebase for all files related to feature name</action>
<action>Include: UI components, API endpoints, models, services, tests</action>
<action>Read each file completely</action>
<action>Store all in file_inventory</action>
</check>
<check if="target_type == component_group">
<action>Get all component files in group</action>
<action>Read each component completely</action>
<action>Extract: Props interfaces, hooks used, child components, state management</action>
<action>Store all in file_inventory</action>
</check>
<action>For each file in file\*inventory, document: - **File Path:** Full path - **Purpose:** What this file does (1-2 sentences) - **Lines of Code:** Total LOC - **Exports:** Complete list with signatures
- Functions: `functionName(param: Type): ReturnType` - Description
- Classes: `ClassName` - Description with key methods
- Types/Interfaces: `TypeName` - Description
- Constants: `CONSTANT_NAME: Type` - Description - **Imports/Dependencies:** What it uses and why - **Used By:** Files that import this (dependents) - **Key Implementation Details:** Important logic, algorithms, patterns - **State Management:** If applicable (Redux, Context, local state) - **Side Effects:** API calls, database queries, file I/O, external services - **Error Handling:** Try/catch blocks, error boundaries, validation - **Testing:** Associated test files and coverage - **Comments/TODOs:** Any inline documentation or planned work
</action>
<template-output>comprehensive_file_inventory</template-output>
</step>
<step n="13c" goal="Analyze relationships and data flow">
<action>Build dependency graph for scanned area:
- Create graph with files as nodes
- Add edges for import relationships
- Identify circular dependencies if any
- Find entry points (files not imported by others in scope)
- Find leaf nodes (files that don't import others in scope)
</action>
<action>Trace data flow through the system: - Follow function calls and data transformations - Track API calls and their responses - Document state updates and propagation - Map database queries and mutations
</action>
<action>Identify integration points: - External APIs consumed - Internal APIs/services called - Shared state accessed - Events published/subscribed - Database tables accessed
</action>
<template-output>dependency_graph</template-output>
<template-output>data_flow_analysis</template-output>
<template-output>integration_points</template-output>
</step>
<step n="13d" goal="Find related code and similar patterns">
<action>Search codebase OUTSIDE scanned area for:
- Similar file/folder naming patterns
- Similar function signatures
- Similar component structures
- Similar API patterns
- Reusable utilities that could be used
</action>
<action>Identify code reuse opportunities: - Shared utilities available - Design patterns used elsewhere - Component libraries available - Helper functions that could apply
</action>
<action>Find reference implementations: - Similar features in other parts of codebase - Established patterns to follow - Testing approaches used elsewhere
</action>
<template-output>related_code_references</template-output>
<template-output>reuse_opportunities</template-output>
</step>
<step n="13e" goal="Generate comprehensive deep-dive documentation">
<action>Create documentation filename: deep-dive-{{sanitized_target_name}}.md</action>
<action>Aggregate contributor insights across files:
- Combine unique risk/gotcha notes into {{risks_notes}}
- Combine verification steps developers should run before changes into {{verification_steps}}
- Combine recommended test commands into {{suggested_tests}}
</action>
<action>Load complete deep-dive template from: {installed_path}/templates/deep-dive-template.md</action>
<action>Fill template with all collected data from steps 13b-13d</action>
<action>Write filled template to: {output_folder}/deep-dive-{{sanitized_target_name}}.md</action>
<action>Validate deep-dive document completeness</action>
<template-output>deep_dive_documentation</template-output>
<action>Update state file: - Add to deep_dive_targets array: {"target_name": "{{target_name}}", "target_path": "{{target_path}}", "files_analyzed": {{file_count}}, "output_file": "deep-dive-{{sanitized_target_name}}.md", "timestamp": "{{now}}"} - Add output to outputs_generated - Update last_updated timestamp
</action>
</step>
<step n="13f" goal="Update master index with deep-dive link">
<action>Read existing index.md</action>
<action>Check if "Deep-Dive Documentation" section exists</action>
<check if="section does not exist">
<action>Add new section after "Generated Documentation":
## Deep-Dive Documentation
Detailed exhaustive analysis of specific areas:
</action>
</check>
<action>Add link to new deep-dive doc:
- [{{target_name}} Deep-Dive](./deep-dive-{{sanitized_target_name}}.md) - Comprehensive analysis of {{target_description}} ({{file_count}} files, {{total_loc}} LOC) - Generated {{date}}
</action>
<action>Update index metadata:
Last Updated: {{date}}
Deep-Dives: {{deep_dive_count}}
</action>
<action>Save updated index.md</action>
<template-output>updated_index</template-output>
</step>
<step n="13g" goal="Offer to continue or complete">
<action>Display summary:
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
## Deep-Dive Documentation Complete! ✓
**Generated:** {output_folder}/deep-dive-{{target_name}}.md
**Files Analyzed:** {{file_count}}
**Lines of Code Scanned:** {{total_loc}}
**Time Taken:** ~{{duration}}
**Documentation Includes:**
- Complete file inventory with all exports
- Dependency graph and data flow
- Integration points and API contracts
- Testing analysis and coverage
- Related code and reuse opportunities
- Implementation guidance
**Index Updated:** {output_folder}/index.md now includes link to this deep-dive
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
</action>
<ask>Would you like to:
1. **Deep-dive another area** - Analyze another feature/module/folder
2. **Finish** - Complete workflow
Your choice [1/2]:
</ask>
<action if="user selects 1">
<action>Clear current deep_dive_target</action>
<action>Go to Step 13a (select new area)</action>
</action>
<action if="user selects 2">
<action>Display final message:
All deep-dive documentation complete!
**Master Index:** {output_folder}/index.md
**Deep-Dives Generated:** {{deep_dive_count}}
These comprehensive docs are now ready for:
- Architecture review
- Implementation planning
- Code understanding
- Brownfield PRD creation
Thank you for using the document-project workflow!
</action>
<action>Exit workflow</action>
</action>
</step>
</step>
</workflow>

View File

@ -0,0 +1,31 @@
# Deep-Dive Documentation Workflow Configuration
name: "document-project-deep-dive"
description: "Exhaustive deep-dive documentation of specific project areas"
author: "BMad"
# This is a sub-workflow called by document-project/workflow.yaml
parent_workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
# Critical variables inherited from parent
config_source: "{project-root}/_bmad/bmb/config.yaml"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
date: system-generated
# Module path and component files
installed_path: "{project-root}/_bmad/bmm/workflows/document-project/workflows"
template: false # Action workflow
instructions: "{installed_path}/deep-dive-instructions.md"
validation: "{project-root}/_bmad/bmm/workflows/document-project/checklist.md"
# Templates
deep_dive_template: "{project-root}/_bmad/bmm/workflows/document-project/templates/deep-dive-template.md"
# Runtime inputs (passed from parent workflow)
workflow_mode: "deep_dive"
scan_level: "exhaustive" # Deep-dive always uses exhaustive scan
project_root_path: ""
existing_index_path: "" # Path to existing index.md
# Configuration
autonomous: false # Requires user input to select target area

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,31 @@
# Full Project Scan Workflow Configuration
name: "document-project-full-scan"
description: "Complete project documentation workflow (initial scan or full rescan)"
author: "BMad"
# This is a sub-workflow called by document-project/workflow.yaml
parent_workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
# Critical variables inherited from parent
config_source: "{project-root}/_bmad/bmb/config.yaml"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
date: system-generated
# Data files
documentation_requirements_csv: "{project-root}/_bmad/bmm/workflows/document-project/documentation-requirements.csv"
# Module path and component files
installed_path: "{project-root}/_bmad/bmm/workflows/document-project/workflows"
template: false # Action workflow
instructions: "{installed_path}/full-scan-instructions.md"
validation: "{project-root}/_bmad/bmm/workflows/document-project/checklist.md"
# Runtime inputs (passed from parent workflow)
workflow_mode: "" # "initial_scan" or "full_rescan"
scan_level: "" # "quick", "deep", or "exhaustive"
resume_mode: false
project_root_path: ""
# Configuration
autonomous: false # Requires user input at key decision points

View File

@ -0,0 +1,39 @@
# Create Data Flow Diagram - Validation Checklist
## DFD Notation
- [ ] Processes shown as circles/ellipses
- [ ] Data stores shown as parallel lines or rectangles
- [ ] External entities shown as rectangles
- [ ] Data flows shown as labeled arrows
- [ ] Follows standard DFD notation
## Structure
- [ ] All processes numbered correctly
- [ ] All data flows labeled with data names
- [ ] All data stores named appropriately
- [ ] External entities clearly identified
## Completeness
- [ ] All inputs and outputs accounted for
- [ ] No orphaned processes (unconnected)
- [ ] Data conservation maintained
- [ ] Level appropriate (context/level 0/level 1)
## Layout
- [ ] Logical flow direction (left to right, top to bottom)
- [ ] No crossing data flows where avoidable
- [ ] Balanced layout
- [ ] Grid alignment maintained
## Technical Quality
- [ ] All elements properly grouped
- [ ] Arrows have proper bindings
- [ ] Text readable and properly sized
- [ ] No elements with `isDeleted: true`
- [ ] JSON is valid
- [ ] File saved to correct location

Some files were not shown because too many files have changed in this diff Show More