hash file change checking integrated
This commit is contained in:
Brian Madison
@@ -1,26 +0,0 @@
|
||||
category,technique_name,description,facilitation_prompts,best_for,energy_level,typical_duration
|
||||
game_design,MDA Framework Exploration,Explore game concepts through Mechanics-Dynamics-Aesthetics lens to ensure cohesive design from implementation to player experience,What mechanics create the core loop?|What dynamics emerge from these mechanics?|What aesthetic experience results?|How do they align?,holistic-design,moderate,20-30
|
||||
game_design,Core Loop Brainstorming,Design the fundamental moment-to-moment gameplay loop that players repeat - the heartbeat of your game,What does the player do?|What's the immediate reward?|Why do it again?|How does it evolve?,gameplay-foundation,high,15-25
|
||||
game_design,Player Fantasy Mining,Identify and amplify the core fantasy that players want to embody - what makes them feel powerful and engaged,What fantasy does the player live?|What makes them feel awesome?|What power do they wield?|What identity do they assume?,player-motivation,high,15-20
|
||||
game_design,Genre Mashup,Combine unexpected game genres to create innovative hybrid experiences that offer fresh gameplay,Take two unrelated genres|How do they merge?|What unique gameplay emerges?|What's the hook?,innovation,high,15-20
|
||||
game_design,Verbs Before Nouns,Focus on what players DO before what things ARE - prioritize actions over objects for engaging gameplay,What verbs define your game?|What actions feel good?|Build mechanics from verbs|Nouns support actions,mechanics-first,moderate,20-25
|
||||
game_design,Failure State Design,Work backwards from interesting failure conditions to create tension and meaningful choices,How can players fail interestingly?|What makes failure feel fair?|How does failure teach?|Recovery mechanics?,challenge-design,moderate,15-20
|
||||
game_design,Progression Curve Sculpting,Map the player's emotional and skill journey from tutorial to mastery - pace challenge and revelation,How does difficulty evolve?|When do we introduce concepts?|What's the skill ceiling?|How do we maintain flow?,pacing-balance,moderate,25-30
|
||||
game_design,Emergence Engineering,Design simple rule interactions that create complex unexpected player-driven outcomes,What simple rules combine?|What emerges from interactions?|How do players surprise you?|Systemic possibilities?,depth-complexity,moderate,20-25
|
||||
game_design,Accessibility Layers,Brainstorm how different skill levels and abilities can access your core experience meaningfully,Who might struggle with what?|What alternate inputs exist?|How do we preserve challenge?|Inclusive design options?,inclusive-design,moderate,20-25
|
||||
game_design,Reward Schedule Architecture,Design the timing and type of rewards to maintain player motivation and engagement,What rewards when?|Variable or fixed schedule?|Intrinsic vs extrinsic rewards?|Progression satisfaction?,engagement-retention,moderate,20-30
|
||||
narrative_game,Ludonarrative Harmony,Align story and gameplay so mechanics reinforce narrative themes - make meaning through play,What does gameplay express?|How do mechanics tell story?|Where do they conflict?|How to unify theme?,storytelling,moderate,20-25
|
||||
narrative_game,Environmental Storytelling,Use world design and ambient details to convey narrative without explicit exposition,What does the space communicate?|What happened here before?|Visual narrative clues?|Show don't tell?,world-building,moderate,15-20
|
||||
narrative_game,Player Agency Moments,Identify key decision points where player choice shapes narrative in meaningful ways,What choices matter?|How do consequences manifest?|Branch vs flavor choices?|Meaningful agency where?,player-choice,moderate,20-25
|
||||
narrative_game,Emotion Targeting,Design specific moments intended to evoke targeted emotional responses through integrated design,What emotion when?|How do all elements combine?|Music + mechanics + narrative?|Orchestrated feelings?,emotional-design,high,20-30
|
||||
systems_game,Economy Balancing Thought Experiments,Explore resource generation/consumption balance to prevent game-breaking exploits,What resources exist?|Generation vs consumption rates?|What loops emerge?|Where's the exploit?,economy-design,moderate,25-30
|
||||
systems_game,Meta-Game Layer Design,Brainstorm progression systems that persist beyond individual play sessions,What carries over between sessions?|Long-term goals?|How does meta feed core loop?|Retention hooks?,retention-systems,moderate,20-25
|
||||
multiplayer_game,Social Dynamics Mapping,Anticipate how players will interact and design mechanics that support desired social behaviors,How will players cooperate?|Competitive dynamics?|Toxic behavior prevention?|Positive interaction rewards?,social-design,moderate,20-30
|
||||
multiplayer_game,Spectator Experience Design,Consider how watching others play can be entertaining - esports and streaming potential,What's fun to watch?|Readable visual clarity?|Highlight moments?|Narrative for observers?,spectator-value,moderate,15-20
|
||||
creative_game,Constraint-Based Creativity,Embrace a specific limitation as your core design constraint and build everything around it,Pick a severe constraint|What if this was your ONLY mechanic?|Build a full game from limitation|Constraint as creativity catalyst,innovation,moderate,15-25
|
||||
creative_game,Game Feel Playground,Focus purely on how controls and feedback FEEL before worrying about context or goals,What feels juicy to do?|Controller response?|Visual/audio feedback?|Satisfying micro-interactions?,game-feel,high,20-30
|
||||
creative_game,One Button Game Challenge,Design interesting gameplay using only a single input - forces elegant simplicity,Only one button - what can it do?|Context changes meaning?|Timing variations?|Depth from simplicity?,minimalist-design,moderate,15-20
|
||||
wild_game,Remix an Existing Game,Take a well-known game and twist one core element - what new experience emerges?,Pick a famous game|Change ONE fundamental rule|What ripples from that change?|New game from mutation?,rapid-prototyping,high,10-15
|
||||
wild_game,Anti-Game Design,Design a game that deliberately breaks common conventions - subvert player expectations,What if we broke this rule?|Expectation subversion?|Anti-patterns as features?|Avant-garde possibilities?,experimental,moderate,15-20
|
||||
wild_game,Physics Playground,Start with an interesting physics interaction and build a game around that sensation,What physics are fun to play with?|Build game from physics toy|Emergent physics gameplay?|Sensation first?,prototype-first,high,15-25
|
||||
wild_game,Toy Before Game,Create a playful interactive toy with no goals first - then discover the game within it,What's fun to mess with?|No goals yet - just play|What game emerges organically?|Toy to game evolution?,discovery-design,high,20-30
|
||||
|
@@ -1,115 +0,0 @@
|
||||
# Game Brainstorming Context
|
||||
|
||||
This context guide provides game-specific considerations for brainstorming sessions focused on game design and development.
|
||||
|
||||
## Session Focus Areas
|
||||
|
||||
When brainstorming for games, consider exploring:
|
||||
|
||||
- **Core Gameplay Loop** - What players do moment-to-moment
|
||||
- **Player Fantasy** - What identity/power fantasy does the game fulfill?
|
||||
- **Game Mechanics** - Rules and interactions that define play
|
||||
- **Game Dynamics** - Emergent behaviors from mechanic interactions
|
||||
- **Aesthetic Experience** - Emotional responses and feelings evoked
|
||||
- **Progression Systems** - How players grow and unlock content
|
||||
- **Challenge and Difficulty** - How to create engaging difficulty curves
|
||||
- **Social/Multiplayer Features** - How players interact with each other
|
||||
- **Narrative and World** - Story, setting, and environmental storytelling
|
||||
- **Art Direction and Feel** - Visual style and game feel
|
||||
- **Monetization** - Business model and revenue approach (if applicable)
|
||||
|
||||
## Game Design Frameworks
|
||||
|
||||
### MDA Framework
|
||||
|
||||
- **Mechanics** - Rules and systems (what's in the code)
|
||||
- **Dynamics** - Runtime behavior (how mechanics interact)
|
||||
- **Aesthetics** - Emotional responses (what players feel)
|
||||
|
||||
### Player Motivation (Bartle's Taxonomy)
|
||||
|
||||
- **Achievers** - Goal completion and progression
|
||||
- **Explorers** - Discovery and understanding systems
|
||||
- **Socializers** - Interaction and relationships
|
||||
- **Killers** - Competition and dominance
|
||||
|
||||
### Core Experience Questions
|
||||
|
||||
- What does the player DO? (Verbs first, nouns second)
|
||||
- What makes them feel powerful/competent/awesome?
|
||||
- What's the central tension or challenge?
|
||||
- What's the "one more turn" factor?
|
||||
|
||||
## Recommended Brainstorming Techniques
|
||||
|
||||
### Game Design Specific Techniques
|
||||
|
||||
(These are available as additional techniques in game brainstorming sessions)
|
||||
|
||||
- **MDA Framework Exploration** - Design through mechanics-dynamics-aesthetics
|
||||
- **Core Loop Brainstorming** - Define the heartbeat of gameplay
|
||||
- **Player Fantasy Mining** - Identify and amplify player power fantasies
|
||||
- **Genre Mashup** - Combine unexpected genres for innovation
|
||||
- **Verbs Before Nouns** - Focus on actions before objects
|
||||
- **Failure State Design** - Work backwards from interesting failures
|
||||
- **Ludonarrative Harmony** - Align story and gameplay
|
||||
- **Game Feel Playground** - Focus purely on how controls feel
|
||||
|
||||
### Standard Techniques Well-Suited for Games
|
||||
|
||||
- **SCAMPER Method** - Innovate on existing game mechanics
|
||||
- **What If Scenarios** - Explore radical gameplay possibilities
|
||||
- **First Principles Thinking** - Rebuild game concepts from scratch
|
||||
- **Role Playing** - Generate ideas from player perspectives
|
||||
- **Analogical Thinking** - Find inspiration from other games/media
|
||||
- **Constraint-Based Creativity** - Design around limitations
|
||||
- **Morphological Analysis** - Explore mechanic combinations
|
||||
|
||||
## Output Guidance
|
||||
|
||||
Effective game brainstorming sessions should capture:
|
||||
|
||||
1. **Core Concept** - High-level game vision and hook
|
||||
2. **Key Mechanics** - Primary gameplay verbs and interactions
|
||||
3. **Player Experience** - What it feels like to play
|
||||
4. **Unique Elements** - What makes this game special/different
|
||||
5. **Design Challenges** - Obstacles to solve during development
|
||||
6. **Prototype Ideas** - What to test first
|
||||
7. **Reference Games** - Existing games that inspire or inform
|
||||
8. **Open Questions** - What needs further exploration
|
||||
|
||||
## Integration with Game Development Workflow
|
||||
|
||||
Game brainstorming sessions typically feed into:
|
||||
|
||||
- **Game Briefs** - High-level vision and core pillars
|
||||
- **Game Design Documents (GDD)** - Comprehensive design specifications
|
||||
- **Technical Design Docs** - Architecture for game systems
|
||||
- **Prototype Plans** - What to build to validate concepts
|
||||
- **Art Direction Documents** - Visual style and feel guides
|
||||
|
||||
## Special Considerations for Game Design
|
||||
|
||||
### Start With The Feel
|
||||
|
||||
- How should controls feel? Responsive? Weighty? Floaty?
|
||||
- What's the "game feel" - the juice and feedback?
|
||||
- Can we prototype the core interaction quickly?
|
||||
|
||||
### Think in Systems
|
||||
|
||||
- How do mechanics interact?
|
||||
- What emergent behaviors arise?
|
||||
- Are there dominant strategies or exploits?
|
||||
|
||||
### Design for Failure
|
||||
|
||||
- How do players fail?
|
||||
- Is failure interesting and instructive?
|
||||
- What's the cost of failure?
|
||||
|
||||
### Player Agency vs. Authored Experience
|
||||
|
||||
- Where do players have meaningful choices?
|
||||
- Where is the experience authored/scripted?
|
||||
- How do we balance freedom and guidance?
|
||||
@@ -1,47 +0,0 @@
|
||||
# Brainstorm Game - Workflow Instructions
|
||||
|
||||
```xml
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load game brainstorming context and techniques">
|
||||
<action>Read the game context document from: {game_context}</action>
|
||||
<action>This context provides game-specific guidance including:
|
||||
- Focus areas for game ideation (mechanics, narrative, experience, etc.)
|
||||
- Key considerations for game design
|
||||
- Recommended techniques for game brainstorming
|
||||
- Output structure guidance
|
||||
</action>
|
||||
<action>Load game-specific brain techniques from: {game_brain_methods}</action>
|
||||
<action>These additional techniques supplement the standard CIS brainstorming methods with game design-focused approaches like:
|
||||
- MDA Framework exploration
|
||||
- Core loop brainstorming
|
||||
- Player fantasy mining
|
||||
- Genre mashup
|
||||
- And other game-specific ideation methods
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Invoke CIS brainstorming with game context">
|
||||
<action>Execute the CIS brainstorming workflow with game context and additional techniques</action>
|
||||
<invoke-workflow path="{cis_brainstorming}" data="{game_context}" techniques="{game_brain_methods}">
|
||||
The CIS brainstorming workflow will:
|
||||
- Merge game-specific techniques with standard techniques
|
||||
- Present interactive brainstorming techniques menu
|
||||
- Guide the user through selected ideation methods
|
||||
- Generate and capture brainstorming session results
|
||||
- Save output to: {output_folder}/brainstorming-session-results-{{date}}.md
|
||||
</invoke-workflow>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Completion">
|
||||
<action>Confirm brainstorming session completed successfully</action>
|
||||
<action>Brainstorming results saved by CIS workflow</action>
|
||||
<action>Report workflow completion</action>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
```
|
||||
@@ -1,22 +0,0 @@
|
||||
# Brainstorm Game Workflow Configuration
|
||||
name: "brainstorm-game"
|
||||
description: "Facilitate game brainstorming sessions by orchestrating the CIS brainstorming workflow with game-specific context, guidance, and additional game design techniques."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmm/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/1-analysis/brainstorm-game"
|
||||
template: false
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
# Context and techniques for game brainstorming
|
||||
game_context: "{installed_path}/game-context.md"
|
||||
game_brain_methods: "{installed_path}/game-brain-methods.csv"
|
||||
|
||||
# CIS brainstorming workflow to invoke
|
||||
cis_brainstorming: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||
@@ -1,38 +0,0 @@
|
||||
# Brainstorm Project - Workflow Instructions
|
||||
|
||||
```xml
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with project-specific context</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load project brainstorming context">
|
||||
<action>Read the project context document from: {project_context}</action>
|
||||
<action>This context provides project-specific guidance including:
|
||||
- Focus areas for project ideation
|
||||
- Key considerations for software/product projects
|
||||
- Recommended techniques for project brainstorming
|
||||
- Output structure guidance
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Invoke CIS brainstorming with project context">
|
||||
<action>Execute the CIS brainstorming workflow with project context</action>
|
||||
<invoke-workflow path="{cis_brainstorming}" data="{project_context}">
|
||||
The CIS brainstorming workflow will:
|
||||
- Present interactive brainstorming techniques menu
|
||||
- Guide the user through selected ideation methods
|
||||
- Generate and capture brainstorming session results
|
||||
- Save output to: {output_folder}/brainstorming-session-results-{{date}}.md
|
||||
</invoke-workflow>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Completion">
|
||||
<action>Confirm brainstorming session completed successfully</action>
|
||||
<action>Brainstorming results saved by CIS workflow</action>
|
||||
<action>Report workflow completion</action>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
```
|
||||
@@ -1,25 +0,0 @@
|
||||
# Project Brainstorming Context
|
||||
|
||||
This context guide provides project-specific considerations for brainstorming sessions focused on software and product development.
|
||||
|
||||
## Session Focus Areas
|
||||
|
||||
When brainstorming for projects, consider exploring:
|
||||
|
||||
- **User Problems and Pain Points** - What challenges do users face?
|
||||
- **Feature Ideas and Capabilities** - What could the product do?
|
||||
- **Technical Approaches** - How might we build it?
|
||||
- **User Experience** - How will users interact with it?
|
||||
- **Business Model and Value** - How does it create value?
|
||||
- **Market Differentiation** - What makes it unique?
|
||||
- **Technical Risks and Challenges** - What could go wrong?
|
||||
- **Success Metrics** - How will we measure success?
|
||||
|
||||
## Integration with Project Workflow
|
||||
|
||||
Brainstorming sessions typically feed into:
|
||||
|
||||
- **Product Briefs** - Initial product vision and strategy
|
||||
- **PRDs** - Detailed requirements documents
|
||||
- **Technical Specifications** - Architecture and implementation plans
|
||||
- **Research Activities** - Areas requiring further investigation
|
||||
@@ -1,21 +0,0 @@
|
||||
# Brainstorm Project Workflow Configuration
|
||||
name: "brainstorm-project"
|
||||
description: "Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmm/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/1-analysis/brainstorm-project"
|
||||
template: false
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
# Context document for project brainstorming
|
||||
project_context: "{installed_path}/project-context.md"
|
||||
|
||||
# CIS brainstorming workflow to invoke
|
||||
cis_brainstorming: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||
@@ -1,221 +0,0 @@
|
||||
# Game Brief Workflow
|
||||
|
||||
## Overview
|
||||
|
||||
The Game Brief workflow is the starting point for game projects in the BMad Method. It's a lightweight, interactive brainstorming and planning session that captures your game vision before diving into detailed Game Design Documents (GDD).
|
||||
|
||||
## Purpose
|
||||
|
||||
**Game Brief answers:**
|
||||
|
||||
- What game are you making?
|
||||
- Who is it for?
|
||||
- What makes it unique?
|
||||
- Is it feasible?
|
||||
|
||||
**This is NOT:**
|
||||
|
||||
- A full Game Design Document
|
||||
- A technical specification
|
||||
- A production plan
|
||||
- A detailed content outline
|
||||
|
||||
## When to Use This Workflow
|
||||
|
||||
Use the game-brief workflow when:
|
||||
|
||||
- Starting a new game project from scratch
|
||||
- Exploring a game idea before committing
|
||||
- Pitching a concept to team/stakeholders
|
||||
- Validating market fit and feasibility
|
||||
- Preparing input for the GDD workflow
|
||||
|
||||
Skip if:
|
||||
|
||||
- You already have a complete GDD
|
||||
- Continuing an existing project
|
||||
- Prototyping without planning needs
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Interactive Mode (Recommended)
|
||||
|
||||
Work through each section collaboratively:
|
||||
|
||||
1. Game Vision (concept, pitch, vision statement)
|
||||
2. Target Market (audience, competition, positioning)
|
||||
3. Game Fundamentals (pillars, mechanics, experience goals)
|
||||
4. Scope and Constraints (platforms, timeline, budget, team)
|
||||
5. Reference Framework (inspiration, competitors, differentiators)
|
||||
6. Content Framework (world, narrative, volume)
|
||||
7. Art and Audio Direction (visual and audio style)
|
||||
8. Risk Assessment (risks, challenges, mitigation)
|
||||
9. Success Criteria (MVP, metrics, launch goals)
|
||||
10. Next Steps (immediate actions, research, questions)
|
||||
|
||||
### YOLO Mode
|
||||
|
||||
AI generates complete draft, then you refine sections iteratively.
|
||||
|
||||
## Key Features
|
||||
|
||||
### Optional Inputs
|
||||
|
||||
The workflow can incorporate:
|
||||
|
||||
- Market research
|
||||
- Brainstorming results
|
||||
- Competitive analysis
|
||||
- Design notes
|
||||
- Reference game lists
|
||||
|
||||
### Realistic Scoping
|
||||
|
||||
The workflow actively helps you:
|
||||
|
||||
- Identify scope vs. resource mismatches
|
||||
- Assess technical feasibility
|
||||
- Recognize market risks
|
||||
- Plan mitigation strategies
|
||||
|
||||
### Clear Handoff
|
||||
|
||||
Output is designed to feed directly into:
|
||||
|
||||
- GDD workflow (2-plan phase)
|
||||
- Prototyping decisions
|
||||
- Team discussions
|
||||
- Stakeholder presentations
|
||||
|
||||
## Output
|
||||
|
||||
**game-brief-{game_name}-{date}.md** containing:
|
||||
|
||||
- Executive summary
|
||||
- Complete game vision
|
||||
- Target market analysis
|
||||
- Core gameplay definition
|
||||
- Scope and constraints
|
||||
- Reference framework
|
||||
- Art/audio direction
|
||||
- Risk assessment
|
||||
- Success criteria
|
||||
- Next steps
|
||||
|
||||
## Integration with BMad Method
|
||||
|
||||
```
|
||||
1-analysis/game-brief (You are here)
|
||||
↓
|
||||
2-plan/gdd (Game Design Document)
|
||||
↓
|
||||
2-plan/narrative (Optional: Story-heavy games)
|
||||
↓
|
||||
3-solutioning (Technical architecture, engine selection)
|
||||
↓
|
||||
4-dev-stories (Implementation stories)
|
||||
```
|
||||
|
||||
## Comparison: Game Brief vs. GDD
|
||||
|
||||
| Aspect | Game Brief | GDD |
|
||||
| ------------------- | --------------------------- | ------------------------- |
|
||||
| **Purpose** | Validate concept | Design for implementation |
|
||||
| **Detail Level** | High-level vision | Detailed specifications |
|
||||
| **Time Investment** | 1-2 hours | 4-10 hours |
|
||||
| **Audience** | Self, team, stakeholders | Development team |
|
||||
| **Scope** | Concept validation | Implementation roadmap |
|
||||
| **Format** | Conversational, exploratory | Structured, comprehensive |
|
||||
| **Output** | 3-5 pages | 10-30+ pages |
|
||||
|
||||
## Comparison: Game Brief vs. Product Brief
|
||||
|
||||
| Aspect | Game Brief | Product Brief |
|
||||
| ----------------- | ---------------------------- | --------------------------------- |
|
||||
| **Focus** | Player experience, fun, feel | User problems, features, value |
|
||||
| **Metrics** | Engagement, retention, fun | Revenue, conversion, satisfaction |
|
||||
| **Core Elements** | Gameplay pillars, mechanics | Problem/solution, user segments |
|
||||
| **References** | Other games | Competitors, market |
|
||||
| **Vision** | Emotional experience | Business outcomes |
|
||||
|
||||
## Example Use Case
|
||||
|
||||
### Scenario: Indie Roguelike Card Game
|
||||
|
||||
**Starting Point:**
|
||||
"I want to make a roguelike card game with a twist"
|
||||
|
||||
**After Game Brief:**
|
||||
|
||||
- **Core Concept:** "A roguelike card battler where you play as emotions battling inner demons"
|
||||
- **Target Audience:** Core gamers who love Slay the Spire, interested in mental health themes
|
||||
- **Differentiator:** Emotional narrative system where deck composition affects story
|
||||
- **MVP Scope:** 3 characters, 80 cards, 30 enemy types, 3 bosses, 6-hour first run
|
||||
- **Platform:** PC (Steam) first, mobile later
|
||||
- **Timeline:** 12 months with 2-person team
|
||||
- **Key Risk:** Emotional theme might alienate hardcore roguelike fans
|
||||
- **Mitigation:** Prototype early, test with target audience, offer "mechanical-only" mode
|
||||
|
||||
**Next Steps:**
|
||||
|
||||
1. Build card combat prototype (2 weeks)
|
||||
2. Test emotional resonance with players
|
||||
3. Proceed to GDD workflow if prototype validates
|
||||
|
||||
## Tips for Success
|
||||
|
||||
### Be Honest About Scope
|
||||
|
||||
The most common game dev failure is scope mismatch. Use this workflow to reality-check:
|
||||
|
||||
- Can your team actually build this?
|
||||
- Is the timeline realistic?
|
||||
- Do you have budget for assets?
|
||||
|
||||
### Focus on Player Experience
|
||||
|
||||
Don't think about code or implementation. Think about:
|
||||
|
||||
- What will players DO?
|
||||
- How will they FEEL?
|
||||
- Why will they CARE?
|
||||
|
||||
### Validate Early
|
||||
|
||||
The brief identifies assumptions and risks. Don't skip to GDD without:
|
||||
|
||||
- Prototyping risky mechanics
|
||||
- Testing with target audience
|
||||
- Validating market interest
|
||||
|
||||
### Use References Wisely
|
||||
|
||||
"Like X but with Y" is a starting point, not a differentiator. Push beyond:
|
||||
|
||||
- What specifically from reference games?
|
||||
- What are you explicitly NOT doing?
|
||||
- What's genuinely new?
|
||||
|
||||
## FAQ
|
||||
|
||||
**Q: Is this required before GDD?**
|
||||
A: No, but highly recommended for new projects. You can start directly with GDD if you have a clear vision.
|
||||
|
||||
**Q: Can I use this for game jams?**
|
||||
A: Yes, but use YOLO mode for speed. Focus on vision, mechanics, and MVP scope.
|
||||
|
||||
**Q: What if my game concept changes?**
|
||||
A: Revisit and update the brief. It's a living document during early development.
|
||||
|
||||
**Q: How detailed should content volume estimates be?**
|
||||
A: Rough orders of magnitude are fine. "~50 enemies" not "47 enemies with 3 variants each."
|
||||
|
||||
**Q: Should I complete this alone or with my team?**
|
||||
A: Involve your team! Collaborative briefs catch blind spots and build shared vision.
|
||||
|
||||
## Related Workflows
|
||||
|
||||
- **Product Brief** (`1-analysis/product-brief`): For software products, not games
|
||||
- **GDD** (`2-plan/gdd`): Next step after game brief
|
||||
- **Narrative Design** (`2-plan/narrative`): For story-heavy games after GDD
|
||||
- **Solutioning** (`3-solutioning`): Technical architecture after planning
|
||||
@@ -1,128 +0,0 @@
|
||||
# Game Brief Validation Checklist
|
||||
|
||||
Use this checklist to ensure your game brief is complete and ready for GDD creation.
|
||||
|
||||
## Game Vision ✓
|
||||
|
||||
- [ ] **Core Concept** is clear and concise (one sentence)
|
||||
- [ ] **Elevator Pitch** hooks the reader in 2-3 sentences
|
||||
- [ ] **Vision Statement** is aspirational but achievable
|
||||
- [ ] Vision captures the emotional experience you want to create
|
||||
|
||||
## Target Market ✓
|
||||
|
||||
- [ ] **Primary Audience** is specific (not just "gamers")
|
||||
- [ ] Age range and experience level are defined
|
||||
- [ ] Play session expectations are realistic
|
||||
- [ ] **Market Context** demonstrates opportunity
|
||||
- [ ] Competitive landscape is understood
|
||||
- [ ] You know why this audience will care
|
||||
|
||||
## Game Fundamentals ✓
|
||||
|
||||
- [ ] **Core Gameplay Pillars** (2-4) are clearly defined
|
||||
- [ ] Each pillar is specific and measurable
|
||||
- [ ] **Primary Mechanics** describe what players actually DO
|
||||
- [ ] **Player Experience Goals** connect mechanics to emotions
|
||||
- [ ] Core loop is clear and compelling
|
||||
|
||||
## Scope and Constraints ✓
|
||||
|
||||
- [ ] **Target Platforms** are prioritized
|
||||
- [ ] **Development Timeline** is realistic
|
||||
- [ ] **Budget** aligns with scope
|
||||
- [ ] **Team Resources** (size, skills) are documented
|
||||
- [ ] **Technical Constraints** are identified
|
||||
- [ ] Scope matches team capability
|
||||
|
||||
## Reference Framework ✓
|
||||
|
||||
- [ ] **Inspiration Games** (3-5) are listed with specifics
|
||||
- [ ] You know what you're taking vs. NOT taking from each
|
||||
- [ ] **Competitive Analysis** covers direct and indirect competitors
|
||||
- [ ] **Key Differentiators** are genuine and valuable
|
||||
- [ ] Differentiators are specific (not "just better")
|
||||
|
||||
## Content Framework ✓
|
||||
|
||||
- [ ] **World and Setting** is defined
|
||||
- [ ] **Narrative Approach** matches game type
|
||||
- [ ] **Content Volume** is estimated (rough order of magnitude)
|
||||
- [ ] Playtime expectations are set
|
||||
- [ ] Replayability approach is clear
|
||||
|
||||
## Art and Audio Direction ✓
|
||||
|
||||
- [ ] **Visual Style** is described with references
|
||||
- [ ] 2D vs. 3D is decided
|
||||
- [ ] **Audio Style** matches game mood
|
||||
- [ ] **Production Approach** is realistic for team/budget
|
||||
- [ ] Style complexity matches capabilities
|
||||
|
||||
## Risk Assessment ✓
|
||||
|
||||
- [ ] **Key Risks** are honestly identified
|
||||
- [ ] **Technical Challenges** are documented
|
||||
- [ ] **Market Risks** are considered
|
||||
- [ ] **Mitigation Strategies** are actionable
|
||||
- [ ] Assumptions to validate are listed
|
||||
|
||||
## Success Criteria ✓
|
||||
|
||||
- [ ] **MVP Definition** is truly minimal
|
||||
- [ ] MVP can validate core gameplay hypothesis
|
||||
- [ ] **Success Metrics** are specific and measurable
|
||||
- [ ] **Launch Goals** are realistic
|
||||
- [ ] You know what "done" looks like for MVP
|
||||
|
||||
## Next Steps ✓
|
||||
|
||||
- [ ] **Immediate Actions** are prioritized
|
||||
- [ ] **Research Needs** are identified
|
||||
- [ ] **Open Questions** are documented
|
||||
- [ ] Critical path is clear
|
||||
- [ ] Blockers are identified
|
||||
|
||||
## Overall Quality ✓
|
||||
|
||||
- [ ] Brief is clear and concise (3-5 pages)
|
||||
- [ ] Sections are internally consistent
|
||||
- [ ] Scope is realistic for team/timeline/budget
|
||||
- [ ] Vision is compelling and achievable
|
||||
- [ ] You're excited to build this game
|
||||
- [ ] Team/stakeholders can understand the vision
|
||||
|
||||
## Red Flags 🚩
|
||||
|
||||
Watch for these warning signs:
|
||||
|
||||
- [ ] ❌ Scope too large for team/timeline
|
||||
- [ ] ❌ Unclear core loop or pillars
|
||||
- [ ] ❌ Target audience is "everyone"
|
||||
- [ ] ❌ Differentiators are vague or weak
|
||||
- [ ] ❌ No prototype plan for risky mechanics
|
||||
- [ ] ❌ Budget/timeline is wishful thinking
|
||||
- [ ] ❌ Market is saturated with no clear positioning
|
||||
- [ ] ❌ MVP is not actually minimal
|
||||
|
||||
## Ready for Next Steps?
|
||||
|
||||
If you've checked most boxes and have no major red flags:
|
||||
|
||||
✅ **Ready to proceed to:**
|
||||
|
||||
- Prototype core mechanic
|
||||
- GDD workflow
|
||||
- Team/stakeholder review
|
||||
- Market validation
|
||||
|
||||
⚠️ **Need more work if:**
|
||||
|
||||
- Multiple sections incomplete
|
||||
- Red flags present
|
||||
- Team/stakeholders don't align
|
||||
- Core concept unclear
|
||||
|
||||
---
|
||||
|
||||
_This checklist is a guide, not a gate. Use your judgment based on project needs._
|
||||
@@ -1,517 +0,0 @@
|
||||
# Game Brief - Interactive Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="0" goal="Initialize game brief session">
|
||||
<action>Welcome the user to the Game Brief creation process</action>
|
||||
<action>Explain this is a collaborative process to define their game vision</action>
|
||||
<ask>What is the working title for your game?</ask>
|
||||
<template-output>game_name</template-output>
|
||||
</step>
|
||||
|
||||
<step n="1" goal="Gather available inputs and context">
|
||||
<action>Check what inputs the user has available:</action>
|
||||
<ask>Do you have any of these documents to help inform the brief?
|
||||
|
||||
1. Market research or player data
|
||||
2. Brainstorming results or game jam prototypes
|
||||
3. Competitive game analysis
|
||||
4. Initial game ideas or design notes
|
||||
5. Reference games list
|
||||
6. None - let's start fresh
|
||||
|
||||
Please share any documents you have or select option 6.</ask>
|
||||
|
||||
<action>Load and analyze any provided documents</action>
|
||||
<action>Extract key insights and themes from input documents</action>
|
||||
|
||||
<ask>Based on what you've shared (or if starting fresh), tell me:
|
||||
|
||||
- What's the core gameplay experience you want to create?
|
||||
- What emotion or feeling should players have?
|
||||
- What sparked this game idea?</ask>
|
||||
|
||||
<template-output>initial_context</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Choose collaboration mode">
|
||||
<ask>How would you like to work through the brief?
|
||||
|
||||
**1. Interactive Mode** - We'll work through each section together, discussing and refining as we go
|
||||
**2. YOLO Mode** - I'll generate a complete draft based on our conversation so far, then we'll refine it together
|
||||
|
||||
Which approach works best for you?</ask>
|
||||
|
||||
<action>Store the user's preference for mode</action>
|
||||
<template-output>collaboration_mode</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Define game vision" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's capture your game vision.
|
||||
|
||||
**Core Concept** - What is your game in one sentence?
|
||||
Example: "A roguelike deck-builder where you climb a mysterious spire"
|
||||
|
||||
**Elevator Pitch** - Describe your game in 2-3 sentences as if pitching to a publisher or player.
|
||||
Example: "Slay the Spire fuses card games and roguelikes together. Craft a unique deck, encounter bizarre creatures, discover relics of immense power, and kill the Spire."
|
||||
|
||||
**Vision Statement** - What is the aspirational goal for this game? What experience do you want to create?
|
||||
Example: "Create a deeply replayable tactical card game that rewards strategic thinking while maintaining the excitement of randomness. Every run should feel unique but fair."
|
||||
|
||||
Your answers:</ask>
|
||||
|
||||
<action>Help refine the core concept to be clear and compelling</action>
|
||||
<action>Ensure elevator pitch is concise but captures the hook</action>
|
||||
<action>Guide vision statement to be aspirational but achievable</action>
|
||||
|
||||
<template-output>core_concept</template-output>
|
||||
<template-output>elevator_pitch</template-output>
|
||||
<template-output>vision_statement</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Identify target market" if="collaboration_mode == 'interactive'">
|
||||
<ask>Who will play your game?
|
||||
|
||||
**Primary Audience:**
|
||||
|
||||
- Age range
|
||||
- Gaming experience level (casual, core, hardcore)
|
||||
- Preferred genres
|
||||
- Platform preferences
|
||||
- Typical play session length
|
||||
- Why will THIS game appeal to them?
|
||||
|
||||
**Secondary Audience** (if applicable):
|
||||
|
||||
- Who else might enjoy this game?
|
||||
- How might their needs differ?
|
||||
|
||||
**Market Context:**
|
||||
|
||||
- What's the market opportunity?
|
||||
- Are there similar successful games?
|
||||
- What's the competitive landscape?
|
||||
- Why is now the right time for this game?</ask>
|
||||
|
||||
<action>Push for specificity beyond "people who like fun games"</action>
|
||||
<action>Help identify a realistic and reachable audience</action>
|
||||
<action>Document market evidence or assumptions</action>
|
||||
|
||||
<template-output>primary_audience</template-output>
|
||||
<template-output>secondary_audience</template-output>
|
||||
<template-output>market_context</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Define game fundamentals" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's define your core gameplay.
|
||||
|
||||
**Core Gameplay Pillars (2-4 fundamental elements):**
|
||||
These are the pillars that define your game. Everything should support these.
|
||||
Examples:
|
||||
|
||||
- "Tight controls + challenging combat + rewarding exploration" (Hollow Knight)
|
||||
- "Emergent stories + survival tension + creative problem solving" (RimWorld)
|
||||
- "Strategic depth + quick sessions + massive replayability" (Into the Breach)
|
||||
|
||||
**Primary Mechanics:**
|
||||
What does the player actually DO?
|
||||
|
||||
- Core actions (jump, shoot, build, manage, etc.)
|
||||
- Key systems (combat, resource management, progression, etc.)
|
||||
- Interaction model (real-time, turn-based, etc.)
|
||||
|
||||
**Player Experience Goals:**
|
||||
What emotions and experiences are you designing for?
|
||||
Examples: tension and relief, mastery and growth, creativity and expression, discovery and surprise
|
||||
|
||||
Your game fundamentals:</ask>
|
||||
|
||||
<action>Ensure pillars are specific and measurable</action>
|
||||
<action>Focus on player actions, not implementation details</action>
|
||||
<action>Connect mechanics to emotional experience</action>
|
||||
|
||||
<template-output>core_gameplay_pillars</template-output>
|
||||
<template-output>primary_mechanics</template-output>
|
||||
<template-output>player_experience_goals</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Define scope and constraints" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's establish realistic constraints.
|
||||
|
||||
**Target Platforms:**
|
||||
|
||||
- PC (Steam, itch.io, Epic)?
|
||||
- Console (which ones)?
|
||||
- Mobile (iOS, Android)?
|
||||
- Web browser?
|
||||
- Priority order if multiple?
|
||||
|
||||
**Development Timeline:**
|
||||
|
||||
- Target release date or timeframe?
|
||||
- Are there fixed deadlines (game jams, funding milestones)?
|
||||
- Phased release (early access, beta)?
|
||||
|
||||
**Budget Considerations:**
|
||||
|
||||
- Self-funded, grant-funded, publisher-backed?
|
||||
- Asset creation budget (art, audio, voice)?
|
||||
- Marketing budget?
|
||||
- Tools and software costs?
|
||||
|
||||
**Team Resources:**
|
||||
|
||||
- Team size and roles?
|
||||
- Full-time or part-time?
|
||||
- Skills available vs. skills needed?
|
||||
- Outsourcing plans?
|
||||
|
||||
**Technical Constraints:**
|
||||
|
||||
- Engine preference or requirement?
|
||||
- Performance targets (frame rate, load times)?
|
||||
- File size limits?
|
||||
- Accessibility requirements?</ask>
|
||||
|
||||
<action>Help user be realistic about scope</action>
|
||||
<action>Identify potential blockers early</action>
|
||||
<action>Document assumptions about resources</action>
|
||||
|
||||
<template-output>target_platforms</template-output>
|
||||
<template-output>development_timeline</template-output>
|
||||
<template-output>budget_considerations</template-output>
|
||||
<template-output>team_resources</template-output>
|
||||
<template-output>technical_constraints</template-output>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Establish reference framework" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's identify your reference games and position.
|
||||
|
||||
**Inspiration Games:**
|
||||
List 3-5 games that inspire this project. For each:
|
||||
|
||||
- Game name
|
||||
- What you're drawing from it (mechanic, feel, art style, etc.)
|
||||
- What you're NOT taking from it
|
||||
|
||||
**Competitive Analysis:**
|
||||
What games are most similar to yours?
|
||||
|
||||
- Direct competitors (very similar games)
|
||||
- Indirect competitors (solve same player need differently)
|
||||
- What they do well
|
||||
- What they do poorly
|
||||
- What your game will do differently
|
||||
|
||||
**Key Differentiators:**
|
||||
What makes your game unique?
|
||||
|
||||
- What's your hook?
|
||||
- Why will players choose your game over alternatives?
|
||||
- What can you do that others can't or won't?</ask>
|
||||
|
||||
<action>Help identify genuine differentiation vs. "just better"</action>
|
||||
<action>Look for specific, concrete differences</action>
|
||||
<action>Validate differentiators are actually valuable to players</action>
|
||||
|
||||
<template-output>inspiration_games</template-output>
|
||||
<template-output>competitive_analysis</template-output>
|
||||
<template-output>key_differentiators</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Define content framework" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's scope your content needs.
|
||||
|
||||
**World and Setting:**
|
||||
|
||||
- Where/when does your game take place?
|
||||
- How much world-building is needed?
|
||||
- Is narrative important (critical, supporting, minimal)?
|
||||
- Real-world or fantasy/sci-fi?
|
||||
|
||||
**Narrative Approach:**
|
||||
|
||||
- Story-driven, story-light, or no story?
|
||||
- Linear, branching, or emergent narrative?
|
||||
- Cutscenes, dialogue, environmental storytelling?
|
||||
- How much writing is needed?
|
||||
|
||||
**Content Volume:**
|
||||
Estimate the scope:
|
||||
|
||||
- How long is a typical playthrough?
|
||||
- How many levels/stages/areas?
|
||||
- Replayability approach (procedural, unlocks, multiple paths)?
|
||||
- Asset volume (characters, enemies, items, environments)?</ask>
|
||||
|
||||
<action>Help estimate content realistically</action>
|
||||
<action>Identify if narrative workflow will be needed later</action>
|
||||
<action>Flag content-heavy areas that need planning</action>
|
||||
|
||||
<template-output>world_setting</template-output>
|
||||
<template-output>narrative_approach</template-output>
|
||||
<template-output>content_volume</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Define art and audio direction" if="collaboration_mode == 'interactive'">
|
||||
<ask>What should your game look and sound like?
|
||||
|
||||
**Visual Style:**
|
||||
|
||||
- Art style (pixel art, low-poly, hand-drawn, realistic, etc.)
|
||||
- Color palette and mood
|
||||
- Reference images or games with similar aesthetics
|
||||
- 2D or 3D?
|
||||
- Animation requirements
|
||||
|
||||
**Audio Style:**
|
||||
|
||||
- Music genre and mood
|
||||
- SFX approach (realistic, stylized, retro)
|
||||
- Voice acting needs (full, partial, none)?
|
||||
- Audio importance to gameplay (critical or supporting)
|
||||
|
||||
**Production Approach:**
|
||||
|
||||
- Creating assets in-house or outsourcing?
|
||||
- Asset store usage?
|
||||
- Generative/AI tools?
|
||||
- Style complexity vs. team capability?</ask>
|
||||
|
||||
<action>Ensure art/audio vision aligns with budget and team skills</action>
|
||||
<action>Identify potential production bottlenecks</action>
|
||||
<action>Note if style guide will be needed</action>
|
||||
|
||||
<template-output>visual_style</template-output>
|
||||
<template-output>audio_style</template-output>
|
||||
<template-output>production_approach</template-output>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Assess risks" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's identify potential risks honestly.
|
||||
|
||||
**Key Risks:**
|
||||
|
||||
- What could prevent this game from being completed?
|
||||
- What could make it not fun?
|
||||
- What assumptions are you making that might be wrong?
|
||||
|
||||
**Technical Challenges:**
|
||||
|
||||
- Any unproven technical elements?
|
||||
- Performance concerns?
|
||||
- Platform-specific challenges?
|
||||
- Middleware or tool dependencies?
|
||||
|
||||
**Market Risks:**
|
||||
|
||||
- Is the market saturated?
|
||||
- Are you dependent on a trend or platform?
|
||||
- Competition concerns?
|
||||
- Discoverability challenges?
|
||||
|
||||
**Mitigation Strategies:**
|
||||
For each major risk, what's your plan?
|
||||
|
||||
- How will you validate assumptions?
|
||||
- What's the backup plan?
|
||||
- Can you prototype risky elements early?</ask>
|
||||
|
||||
<action>Encourage honest risk assessment</action>
|
||||
<action>Focus on actionable mitigation, not just worry</action>
|
||||
<action>Prioritize risks by impact and likelihood</action>
|
||||
|
||||
<template-output>key_risks</template-output>
|
||||
<template-output>technical_challenges</template-output>
|
||||
<template-output>market_risks</template-output>
|
||||
<template-output>mitigation_strategies</template-output>
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Define success criteria" if="collaboration_mode == 'interactive'">
|
||||
<ask>What does success look like?
|
||||
|
||||
**MVP Definition:**
|
||||
What's the absolute minimum playable version?
|
||||
|
||||
- Core loop must be fun and complete
|
||||
- Essential content only
|
||||
- What can be added later?
|
||||
- When do you know MVP is "done"?
|
||||
|
||||
**Success Metrics:**
|
||||
How will you measure success?
|
||||
|
||||
- Players acquired
|
||||
- Retention rate (daily, weekly)
|
||||
- Session length
|
||||
- Completion rate
|
||||
- Review scores
|
||||
- Revenue targets (if commercial)
|
||||
- Community engagement
|
||||
|
||||
**Launch Goals:**
|
||||
What are your concrete targets for launch?
|
||||
|
||||
- Sales/downloads in first month?
|
||||
- Review score target?
|
||||
- Streamer/press coverage goals?
|
||||
- Community size goals?</ask>
|
||||
|
||||
<action>Push for specific, measurable goals</action>
|
||||
<action>Distinguish between MVP and full release</action>
|
||||
<action>Ensure goals are realistic given resources</action>
|
||||
|
||||
<template-output>mvp_definition</template-output>
|
||||
<template-output>success_metrics</template-output>
|
||||
<template-output>launch_goals</template-output>
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Identify immediate next steps" if="collaboration_mode == 'interactive'">
|
||||
<ask>What needs to happen next?
|
||||
|
||||
**Immediate Actions:**
|
||||
What should you do right after this brief?
|
||||
|
||||
- Prototype a core mechanic?
|
||||
- Create art style test?
|
||||
- Validate technical feasibility?
|
||||
- Build vertical slice?
|
||||
- Playtest with target audience?
|
||||
|
||||
**Research Needs:**
|
||||
What do you still need to learn?
|
||||
|
||||
- Market validation?
|
||||
- Technical proof of concept?
|
||||
- Player interest testing?
|
||||
- Competitive deep-dive?
|
||||
|
||||
**Open Questions:**
|
||||
What are you still uncertain about?
|
||||
|
||||
- Design questions to resolve
|
||||
- Technical unknowns
|
||||
- Market validation needs
|
||||
- Resource/budget questions</ask>
|
||||
|
||||
<action>Create actionable next steps</action>
|
||||
<action>Prioritize by importance and dependency</action>
|
||||
<action>Identify blockers that need resolution</action>
|
||||
|
||||
<template-output>immediate_actions</template-output>
|
||||
<template-output>research_needs</template-output>
|
||||
<template-output>open_questions</template-output>
|
||||
</step>
|
||||
|
||||
<!-- YOLO Mode - Generate everything then refine -->
|
||||
<step n="3" goal="Generate complete brief draft" if="collaboration_mode == 'yolo'">
|
||||
<action>Based on initial context and any provided documents, generate a complete game brief covering all sections</action>
|
||||
<action>Make reasonable assumptions where information is missing</action>
|
||||
<action>Flag areas that need user validation with [NEEDS CONFIRMATION] tags</action>
|
||||
|
||||
<template-output>core_concept</template-output>
|
||||
<template-output>elevator_pitch</template-output>
|
||||
<template-output>vision_statement</template-output>
|
||||
<template-output>primary_audience</template-output>
|
||||
<template-output>secondary_audience</template-output>
|
||||
<template-output>market_context</template-output>
|
||||
<template-output>core_gameplay_pillars</template-output>
|
||||
<template-output>primary_mechanics</template-output>
|
||||
<template-output>player_experience_goals</template-output>
|
||||
<template-output>target_platforms</template-output>
|
||||
<template-output>development_timeline</template-output>
|
||||
<template-output>budget_considerations</template-output>
|
||||
<template-output>team_resources</template-output>
|
||||
<template-output>technical_constraints</template-output>
|
||||
<template-output>inspiration_games</template-output>
|
||||
<template-output>competitive_analysis</template-output>
|
||||
<template-output>key_differentiators</template-output>
|
||||
<template-output>world_setting</template-output>
|
||||
<template-output>narrative_approach</template-output>
|
||||
<template-output>content_volume</template-output>
|
||||
<template-output>visual_style</template-output>
|
||||
<template-output>audio_style</template-output>
|
||||
<template-output>production_approach</template-output>
|
||||
<template-output>key_risks</template-output>
|
||||
<template-output>technical_challenges</template-output>
|
||||
<template-output>market_risks</template-output>
|
||||
<template-output>mitigation_strategies</template-output>
|
||||
<template-output>mvp_definition</template-output>
|
||||
<template-output>success_metrics</template-output>
|
||||
<template-output>launch_goals</template-output>
|
||||
<template-output>immediate_actions</template-output>
|
||||
<template-output>research_needs</template-output>
|
||||
<template-output>open_questions</template-output>
|
||||
|
||||
<action>Present the complete draft to the user</action>
|
||||
<ask>Here's the complete game brief draft. What would you like to adjust or refine?</ask>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Refine brief sections" repeat="until-approved" if="collaboration_mode == 'yolo'">
|
||||
<ask>Which section would you like to refine?
|
||||
|
||||
1. Game Vision
|
||||
2. Target Market
|
||||
3. Game Fundamentals
|
||||
4. Scope and Constraints
|
||||
5. Reference Framework
|
||||
6. Content Framework
|
||||
7. Art and Audio Direction
|
||||
8. Risk Assessment
|
||||
9. Success Criteria
|
||||
10. Next Steps
|
||||
11. Save and continue</ask>
|
||||
|
||||
<action>Work with user to refine selected section</action>
|
||||
<action>Update relevant template outputs</action>
|
||||
</step>
|
||||
|
||||
<!-- Final steps for both modes -->
|
||||
<step n="13" goal="Create executive summary">
|
||||
<action>Synthesize all sections into a compelling executive summary</action>
|
||||
<action>Include:
|
||||
- Game concept in 1-2 sentences
|
||||
- Target audience and market
|
||||
- Core gameplay pillars
|
||||
- Key differentiators
|
||||
- Success vision</action>
|
||||
|
||||
<template-output>executive_summary</template-output>
|
||||
</step>
|
||||
|
||||
<step n="14" goal="Compile supporting materials">
|
||||
<action>If research documents were provided, create a summary of key findings</action>
|
||||
<action>Document any stakeholder input received during the process</action>
|
||||
<action>Compile list of reference games and resources</action>
|
||||
|
||||
<template-output>research_summary</template-output>
|
||||
<template-output>stakeholder_input</template-output>
|
||||
<template-output>references</template-output>
|
||||
</step>
|
||||
|
||||
<step n="15" goal="Final review and handoff">
|
||||
<action>Generate the complete game brief document</action>
|
||||
<action>Review all sections for completeness and consistency</action>
|
||||
<action>Flag any areas that need design attention with [DESIGN-TODO] tags</action>
|
||||
|
||||
<ask>The game brief is complete! Would you like to:
|
||||
|
||||
1. Review the entire document
|
||||
2. Make final adjustments
|
||||
3. Save and prepare for GDD creation
|
||||
|
||||
This brief will serve as the primary input for creating the Game Design Document (GDD).
|
||||
|
||||
**Recommended next steps:**
|
||||
|
||||
- Create prototype of core mechanic
|
||||
- Proceed to GDD workflow: `workflow gdd`
|
||||
- Validate assumptions with target players</ask>
|
||||
|
||||
<template-output>final_brief</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,205 +0,0 @@
|
||||
# Game Brief: {{game_name}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
**Status:** Draft for GDD Development
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
---
|
||||
|
||||
## Game Vision
|
||||
|
||||
### Core Concept
|
||||
|
||||
{{core_concept}}
|
||||
|
||||
### Elevator Pitch
|
||||
|
||||
{{elevator_pitch}}
|
||||
|
||||
### Vision Statement
|
||||
|
||||
{{vision_statement}}
|
||||
|
||||
---
|
||||
|
||||
## Target Market
|
||||
|
||||
### Primary Audience
|
||||
|
||||
{{primary_audience}}
|
||||
|
||||
### Secondary Audience
|
||||
|
||||
{{secondary_audience}}
|
||||
|
||||
### Market Context
|
||||
|
||||
{{market_context}}
|
||||
|
||||
---
|
||||
|
||||
## Game Fundamentals
|
||||
|
||||
### Core Gameplay Pillars
|
||||
|
||||
{{core_gameplay_pillars}}
|
||||
|
||||
### Primary Mechanics
|
||||
|
||||
{{primary_mechanics}}
|
||||
|
||||
### Player Experience Goals
|
||||
|
||||
{{player_experience_goals}}
|
||||
|
||||
---
|
||||
|
||||
## Scope and Constraints
|
||||
|
||||
### Target Platforms
|
||||
|
||||
{{target_platforms}}
|
||||
|
||||
### Development Timeline
|
||||
|
||||
{{development_timeline}}
|
||||
|
||||
### Budget Considerations
|
||||
|
||||
{{budget_considerations}}
|
||||
|
||||
### Team Resources
|
||||
|
||||
{{team_resources}}
|
||||
|
||||
### Technical Constraints
|
||||
|
||||
{{technical_constraints}}
|
||||
|
||||
---
|
||||
|
||||
## Reference Framework
|
||||
|
||||
### Inspiration Games
|
||||
|
||||
{{inspiration_games}}
|
||||
|
||||
### Competitive Analysis
|
||||
|
||||
{{competitive_analysis}}
|
||||
|
||||
### Key Differentiators
|
||||
|
||||
{{key_differentiators}}
|
||||
|
||||
---
|
||||
|
||||
## Content Framework
|
||||
|
||||
### World and Setting
|
||||
|
||||
{{world_setting}}
|
||||
|
||||
### Narrative Approach
|
||||
|
||||
{{narrative_approach}}
|
||||
|
||||
### Content Volume
|
||||
|
||||
{{content_volume}}
|
||||
|
||||
---
|
||||
|
||||
## Art and Audio Direction
|
||||
|
||||
### Visual Style
|
||||
|
||||
{{visual_style}}
|
||||
|
||||
### Audio Style
|
||||
|
||||
{{audio_style}}
|
||||
|
||||
### Production Approach
|
||||
|
||||
{{production_approach}}
|
||||
|
||||
---
|
||||
|
||||
## Risk Assessment
|
||||
|
||||
### Key Risks
|
||||
|
||||
{{key_risks}}
|
||||
|
||||
### Technical Challenges
|
||||
|
||||
{{technical_challenges}}
|
||||
|
||||
### Market Risks
|
||||
|
||||
{{market_risks}}
|
||||
|
||||
### Mitigation Strategies
|
||||
|
||||
{{mitigation_strategies}}
|
||||
|
||||
---
|
||||
|
||||
## Success Criteria
|
||||
|
||||
### MVP Definition
|
||||
|
||||
{{mvp_definition}}
|
||||
|
||||
### Success Metrics
|
||||
|
||||
{{success_metrics}}
|
||||
|
||||
### Launch Goals
|
||||
|
||||
{{launch_goals}}
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
### Immediate Actions
|
||||
|
||||
{{immediate_actions}}
|
||||
|
||||
### Research Needs
|
||||
|
||||
{{research_needs}}
|
||||
|
||||
### Open Questions
|
||||
|
||||
{{open_questions}}
|
||||
|
||||
---
|
||||
|
||||
## Appendices
|
||||
|
||||
### A. Research Summary
|
||||
|
||||
{{research_summary}}
|
||||
|
||||
### B. Stakeholder Input
|
||||
|
||||
{{stakeholder_input}}
|
||||
|
||||
### C. References
|
||||
|
||||
{{references}}
|
||||
|
||||
---
|
||||
|
||||
_This Game Brief serves as the foundational input for Game Design Document (GDD) creation._
|
||||
|
||||
_Next Steps: Use the `workflow gdd` command to create detailed game design documentation._
|
||||
@@ -1,31 +0,0 @@
|
||||
# Game Brief - Interactive Workflow Configuration
|
||||
name: game-brief
|
||||
description: "Interactive game brief creation workflow that guides users through defining their game vision with multiple input sources and conversational collaboration"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmm/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
date: system-generated
|
||||
|
||||
# Optional input documents
|
||||
recommended_inputs:
|
||||
- market_research: "Market research document (optional)"
|
||||
- brainstorming_results: "Brainstorming session outputs (optional)"
|
||||
- competitive_analysis: "Competitive game analysis (optional)"
|
||||
- initial_ideas: "Initial game ideas or notes (optional)"
|
||||
- reference_games: "List of inspiration games (optional)"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/1-analysis/game-brief"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/game-brief-{{game_name}}-{{date}}.md"
|
||||
|
||||
# Workflow settings
|
||||
autonomous: false # This is an interactive workflow requiring user collaboration
|
||||
brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
|
||||
@@ -1,180 +0,0 @@
|
||||
# Product Brief Workflow
|
||||
|
||||
## Overview
|
||||
|
||||
Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration. Supports both structured interactive mode and rapid "YOLO" mode for quick draft generation.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Dual Mode Operation** - Interactive step-by-step or rapid draft generation
|
||||
- **Multi-Input Support** - Integrates market research, competitive analysis, and brainstorming results
|
||||
- **Conversational Design** - Guides users through strategic thinking with probing questions
|
||||
- **Executive Summary Generation** - Creates compelling summaries for stakeholder communication
|
||||
- **Comprehensive Coverage** - Addresses all critical product planning dimensions
|
||||
- **Stakeholder Ready** - Generates professional briefs suitable for PM handoff
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Invocation
|
||||
|
||||
```bash
|
||||
workflow product-brief
|
||||
```
|
||||
|
||||
### With Input Documents
|
||||
|
||||
```bash
|
||||
# With market research
|
||||
workflow product-brief --input market-research.md
|
||||
|
||||
# With multiple inputs
|
||||
workflow product-brief --input market-research.md --input competitive-analysis.md
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
- **brief_format**: "comprehensive" (full detail) or "executive" (3-page limit)
|
||||
- **autonomous**: false (requires user collaboration)
|
||||
- **output_folder**: Location for generated brief
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Files Included
|
||||
|
||||
```
|
||||
product-brief/
|
||||
├── workflow.yaml # Configuration and metadata
|
||||
├── instructions.md # Interactive workflow steps
|
||||
├── template.md # Product brief document structure
|
||||
├── checklist.md # Validation criteria
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Workflow Process
|
||||
|
||||
### Phase 1: Initialization and Context (Steps 0-2)
|
||||
|
||||
- **Project Setup**: Captures project name and basic context
|
||||
- **Input Gathering**: Collects and analyzes available documents
|
||||
- **Mode Selection**: Chooses interactive or YOLO collaboration approach
|
||||
- **Context Extraction**: Identifies core problems and opportunities
|
||||
|
||||
### Phase 2: Interactive Development (Steps 3-12) - Interactive Mode
|
||||
|
||||
- **Problem Definition**: Deep dive into user pain points and market gaps
|
||||
- **Solution Articulation**: Develops clear value proposition and approach
|
||||
- **User Segmentation**: Defines primary and secondary target audiences
|
||||
- **Success Metrics**: Establishes measurable goals and KPIs
|
||||
- **MVP Scoping**: Ruthlessly defines minimum viable features
|
||||
- **Financial Planning**: Assesses ROI and strategic alignment
|
||||
- **Technical Context**: Captures platform and technology considerations
|
||||
- **Risk Assessment**: Identifies constraints, assumptions, and unknowns
|
||||
|
||||
### Phase 3: Rapid Generation (Steps 3-4) - YOLO Mode
|
||||
|
||||
- **Complete Draft**: Generates full brief based on initial context
|
||||
- **Iterative Refinement**: User-guided section improvements
|
||||
- **Quality Validation**: Ensures completeness and consistency
|
||||
|
||||
### Phase 4: Finalization (Steps 13-15)
|
||||
|
||||
- **Executive Summary**: Creates compelling overview for stakeholders
|
||||
- **Supporting Materials**: Compiles research summaries and references
|
||||
- **Final Review**: Quality check and handoff preparation
|
||||
|
||||
## Output
|
||||
|
||||
### Generated Files
|
||||
|
||||
- **Primary output**: product-brief-{project_name}-{date}.md
|
||||
- **Supporting files**: Research summaries and stakeholder input documentation
|
||||
|
||||
### Output Structure
|
||||
|
||||
1. **Executive Summary** - High-level product concept and value proposition
|
||||
2. **Problem Statement** - Detailed problem analysis with evidence
|
||||
3. **Proposed Solution** - Core approach and key differentiators
|
||||
4. **Target Users** - Primary and secondary user segments with personas
|
||||
5. **Goals and Success Metrics** - Business objectives and measurable KPIs
|
||||
6. **MVP Scope** - Must-have features and out-of-scope items
|
||||
7. **Post-MVP Vision** - Phase 2 features and long-term roadmap
|
||||
8. **Financial Impact** - Investment requirements and ROI projections
|
||||
9. **Strategic Alignment** - Connection to company OKRs and initiatives
|
||||
10. **Technical Considerations** - Platform requirements and preferences
|
||||
11. **Constraints and Assumptions** - Resource limits and key assumptions
|
||||
12. **Risks and Open Questions** - Risk assessment and research needs
|
||||
13. **Supporting Materials** - Research summaries and references
|
||||
|
||||
## Requirements
|
||||
|
||||
No special requirements - designed to work with or without existing documentation.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Before Starting
|
||||
|
||||
1. **Gather Available Research**: Collect any market research, competitive analysis, or user feedback
|
||||
2. **Define Stakeholder Audience**: Know who will use this brief for decision-making
|
||||
3. **Set Time Boundaries**: Interactive mode requires 60-90 minutes for quality results
|
||||
|
||||
### During Execution
|
||||
|
||||
1. **Be Specific**: Avoid generic statements - provide concrete examples and data
|
||||
2. **Think Strategically**: Focus on "why" and "what" rather than "how"
|
||||
3. **Challenge Assumptions**: Use the conversation to test and refine your thinking
|
||||
4. **Scope Ruthlessly**: Resist feature creep in MVP definition
|
||||
|
||||
### After Completion
|
||||
|
||||
1. **Validate with Checklist**: Use included criteria to ensure completeness
|
||||
2. **Stakeholder Review**: Share executive summary first, then full brief
|
||||
3. **Iterate Based on Feedback**: Product briefs should evolve with new insights
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Issue**: Brief lacks specificity or contains vague statements
|
||||
|
||||
- **Solution**: Restart problem definition with concrete examples and measurable impacts
|
||||
- **Check**: Ensure each section answers "so what?" and provides actionable insights
|
||||
|
||||
**Issue**: MVP scope is too large or undefined
|
||||
|
||||
- **Solution**: Use the "what's the minimum to validate core hypothesis?" filter
|
||||
- **Check**: Verify that each MVP feature is truly essential for initial value delivery
|
||||
|
||||
**Issue**: Missing strategic context or business justification
|
||||
|
||||
- **Solution**: Return to financial impact and strategic alignment sections
|
||||
- **Check**: Ensure connection to company goals and clear ROI potential
|
||||
|
||||
## Customization
|
||||
|
||||
To customize this workflow:
|
||||
|
||||
1. **Modify Questions**: Update instructions.md to add industry-specific or company-specific prompts
|
||||
2. **Adjust Template**: Customize template.md sections for organizational brief standards
|
||||
3. **Add Validation**: Extend checklist.md with company-specific quality criteria
|
||||
4. **Configure Modes**: Adjust brief_format settings for different output styles
|
||||
|
||||
## Version History
|
||||
|
||||
- **v6.0.0** - Interactive conversational design with dual modes
|
||||
- Interactive and YOLO mode support
|
||||
- Multi-input document integration
|
||||
- Executive summary generation
|
||||
- Strategic alignment focus
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Validate output using `checklist.md`
|
||||
- Consider running market research workflow first if lacking business context
|
||||
- Consult BMAD documentation for product planning methodology
|
||||
|
||||
---
|
||||
|
||||
_Part of the BMad Method v6 - BMM (Method) Module_
|
||||
@@ -1,115 +0,0 @@
|
||||
# Product Brief Validation Checklist
|
||||
|
||||
## Document Structure
|
||||
|
||||
- [ ] All required sections are present (Executive Summary through Appendices)
|
||||
- [ ] No placeholder text remains (e.g., [TODO], [NEEDS CONFIRMATION], {{variable}})
|
||||
- [ ] Document follows the standard brief template format
|
||||
- [ ] Sections are properly numbered and formatted with headers
|
||||
- [ ] Cross-references between sections are accurate
|
||||
|
||||
## Executive Summary Quality
|
||||
|
||||
- [ ] Product concept is explained in 1-2 clear sentences
|
||||
- [ ] Primary problem is clearly identified
|
||||
- [ ] Target market is specifically named (not generic)
|
||||
- [ ] Value proposition is compelling and differentiated
|
||||
- [ ] Summary accurately reflects the full document content
|
||||
|
||||
## Problem Statement
|
||||
|
||||
- [ ] Current state pain points are specific and measurable
|
||||
- [ ] Impact is quantified where possible (time, money, opportunities)
|
||||
- [ ] Explanation of why existing solutions fall short is provided
|
||||
- [ ] Urgency for solving the problem now is justified
|
||||
- [ ] Problem is validated with evidence or data points
|
||||
|
||||
## Solution Definition
|
||||
|
||||
- [ ] Core approach is clearly explained without implementation details
|
||||
- [ ] Key differentiators from existing solutions are identified
|
||||
- [ ] Explanation of why this will succeed is compelling
|
||||
- [ ] Solution aligns directly with stated problems
|
||||
- [ ] Vision paints a clear picture of the user experience
|
||||
|
||||
## Target Users
|
||||
|
||||
- [ ] Primary user segment has specific demographic/firmographic profile
|
||||
- [ ] User behaviors and current workflows are documented
|
||||
- [ ] Specific pain points are tied to user segments
|
||||
- [ ] User goals are clearly articulated
|
||||
- [ ] Secondary segment (if applicable) is equally detailed
|
||||
- [ ] Avoids generic personas like "busy professionals"
|
||||
|
||||
## Goals and Metrics
|
||||
|
||||
- [ ] Business objectives include measurable outcomes with targets
|
||||
- [ ] User success metrics focus on behaviors, not features
|
||||
- [ ] 3-5 KPIs are defined with clear definitions
|
||||
- [ ] All goals follow SMART criteria (Specific, Measurable, Achievable, Relevant, Time-bound)
|
||||
- [ ] Success metrics align with problem statement
|
||||
|
||||
## MVP Scope
|
||||
|
||||
- [ ] Core features list contains only true must-haves
|
||||
- [ ] Each core feature includes rationale for why it's essential
|
||||
- [ ] Out of scope section explicitly lists deferred features
|
||||
- [ ] MVP success criteria are specific and measurable
|
||||
- [ ] Scope is genuinely minimal and viable
|
||||
- [ ] No feature creep evident in "must-have" list
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
- [ ] Target platforms are specified (web/mobile/desktop)
|
||||
- [ ] Browser/OS support requirements are documented
|
||||
- [ ] Performance requirements are defined if applicable
|
||||
- [ ] Accessibility requirements are noted
|
||||
- [ ] Technology preferences are marked as preferences, not decisions
|
||||
- [ ] Integration requirements with existing systems are identified
|
||||
|
||||
## Constraints and Assumptions
|
||||
|
||||
- [ ] Budget constraints are documented if known
|
||||
- [ ] Timeline or deadline pressures are specified
|
||||
- [ ] Team/resource limitations are acknowledged
|
||||
- [ ] Technical constraints are clearly stated
|
||||
- [ ] Key assumptions are listed and testable
|
||||
- [ ] Assumptions will be validated during development
|
||||
|
||||
## Risk Assessment (if included)
|
||||
|
||||
- [ ] Key risks include potential impact descriptions
|
||||
- [ ] Open questions are specific and answerable
|
||||
- [ ] Research areas are identified with clear objectives
|
||||
- [ ] Risk mitigation strategies are suggested where applicable
|
||||
|
||||
## Overall Quality
|
||||
|
||||
- [ ] Language is clear and free of jargon
|
||||
- [ ] Terminology is used consistently throughout
|
||||
- [ ] Document is ready for handoff to Product Manager
|
||||
- [ ] All [PM-TODO] items are clearly marked if present
|
||||
- [ ] References and source documents are properly cited
|
||||
|
||||
## Completeness Check
|
||||
|
||||
- [ ] Document provides sufficient detail for PRD creation
|
||||
- [ ] All user inputs have been incorporated
|
||||
- [ ] Market research findings are reflected if provided
|
||||
- [ ] Competitive analysis insights are included if available
|
||||
- [ ] Brief aligns with overall product strategy
|
||||
|
||||
## Final Validation
|
||||
|
||||
### Critical Issues Found:
|
||||
|
||||
- [ ] None identified
|
||||
|
||||
### Minor Issues to Address:
|
||||
|
||||
- [ ] List any minor issues here
|
||||
|
||||
### Ready for PM Handoff:
|
||||
|
||||
- [ ] Yes, brief is complete and validated
|
||||
- [ ] No, requires additional work (specify above)
|
||||
@@ -1,353 +0,0 @@
|
||||
# Product Brief - Interactive Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="0" goal="Initialize product brief session">
|
||||
<action>Welcome the user to the Product Brief creation process</action>
|
||||
<action>Explain this is a collaborative process to define their product vision</action>
|
||||
<ask>Ask the user to provide the project name for this product brief</ask>
|
||||
<template-output>project_name</template-output>
|
||||
</step>
|
||||
|
||||
<step n="1" goal="Gather available inputs and context">
|
||||
<action>Check what inputs the user has available:</action>
|
||||
<ask>Do you have any of these documents to help inform the brief?
|
||||
1. Market research
|
||||
2. Brainstorming results
|
||||
3. Competitive analysis
|
||||
4. Initial product ideas or notes
|
||||
5. None - let's start fresh
|
||||
|
||||
Please share any documents you have or select option 5.</ask>
|
||||
|
||||
<action>Load and analyze any provided documents</action>
|
||||
<action>Extract key insights and themes from input documents</action>
|
||||
|
||||
<ask>Based on what you've shared (or if starting fresh), please tell me:
|
||||
|
||||
- What's the core problem you're trying to solve?
|
||||
- Who experiences this problem most acutely?
|
||||
- What sparked this product idea?</ask>
|
||||
|
||||
<template-output>initial_context</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Choose collaboration mode">
|
||||
<ask>How would you like to work through the brief?
|
||||
|
||||
**1. Interactive Mode** - We'll work through each section together, discussing and refining as we go
|
||||
**2. YOLO Mode** - I'll generate a complete draft based on our conversation so far, then we'll refine it together
|
||||
|
||||
Which approach works best for you?</ask>
|
||||
|
||||
<action>Store the user's preference for mode</action>
|
||||
<template-output>collaboration_mode</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Define the problem statement" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's dig deeper into the problem. Tell me:
|
||||
- What's the current state that frustrates users?
|
||||
- Can you quantify the impact? (time lost, money spent, opportunities missed)
|
||||
- Why do existing solutions fall short?
|
||||
- Why is solving this urgent now?</ask>
|
||||
|
||||
<action>Challenge vague statements and push for specificity</action>
|
||||
<action>Help the user articulate measurable pain points</action>
|
||||
<action>Create a compelling problem statement with evidence</action>
|
||||
|
||||
<template-output>problem_statement</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Develop the proposed solution" if="collaboration_mode == 'interactive'">
|
||||
<ask>Now let's shape your solution vision:
|
||||
- What's your core approach to solving this problem?
|
||||
- What makes your solution different from what exists?
|
||||
- Why will this succeed where others haven't?
|
||||
- Paint me a picture of the ideal user experience</ask>
|
||||
|
||||
<action>Focus on the "what" and "why", not implementation details</action>
|
||||
<action>Help articulate key differentiators</action>
|
||||
<action>Craft a clear solution vision</action>
|
||||
|
||||
<template-output>proposed_solution</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Identify target users" if="collaboration_mode == 'interactive'">
|
||||
<ask>Who exactly will use this product? Let's get specific:
|
||||
|
||||
For your PRIMARY users:
|
||||
|
||||
- What's their demographic/professional profile?
|
||||
- What are they currently doing to solve this problem?
|
||||
- What specific pain points do they face?
|
||||
- What goals are they trying to achieve?
|
||||
|
||||
Do you have a SECONDARY user segment? If so, let's define them too.</ask>
|
||||
|
||||
<action>Push beyond generic personas like "busy professionals"</action>
|
||||
<action>Create specific, actionable user profiles</action>
|
||||
<action>[VISUAL PLACEHOLDER: User persona cards or journey map would be valuable here]</action>
|
||||
|
||||
<template-output>primary_user_segment</template-output>
|
||||
<template-output>secondary_user_segment</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Establish goals and success metrics" if="collaboration_mode == 'interactive'">
|
||||
<ask>What does success look like? Let's set SMART goals:
|
||||
|
||||
Business objectives (with measurable outcomes):
|
||||
|
||||
- Example: "Acquire 1000 paying users within 6 months"
|
||||
- Example: "Reduce customer support tickets by 40%"
|
||||
|
||||
User success metrics (behaviors/outcomes, not features):
|
||||
|
||||
- Example: "Users complete core task in under 2 minutes"
|
||||
- Example: "70% of users return weekly"
|
||||
|
||||
What are your top 3-5 Key Performance Indicators?</ask>
|
||||
|
||||
<action>Help formulate specific, measurable goals</action>
|
||||
<action>Distinguish between business and user success</action>
|
||||
|
||||
<template-output>business_objectives</template-output>
|
||||
<template-output>user_success_metrics</template-output>
|
||||
<template-output>key_performance_indicators</template-output>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Define MVP scope" if="collaboration_mode == 'interactive'">
|
||||
<ask>Let's be ruthless about MVP scope.
|
||||
|
||||
What are the absolute MUST-HAVE features for launch?
|
||||
|
||||
- Think: What's the minimum to validate your core hypothesis?
|
||||
- For each feature, why is it essential?
|
||||
|
||||
What tempting features need to wait for v2?
|
||||
|
||||
- What would be nice but isn't critical?
|
||||
- What adds complexity without core value?
|
||||
|
||||
What would constitute a successful MVP launch?
|
||||
|
||||
[VISUAL PLACEHOLDER: Consider a feature priority matrix or MoSCoW diagram]</ask>
|
||||
|
||||
<action>Challenge scope creep aggressively</action>
|
||||
<action>Push for true minimum viability</action>
|
||||
<action>Clearly separate must-haves from nice-to-haves</action>
|
||||
|
||||
<template-output>core_features</template-output>
|
||||
<template-output>out_of_scope</template-output>
|
||||
<template-output>mvp_success_criteria</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Assess financial impact and ROI">
|
||||
<ask>Let's talk numbers and strategic value:
|
||||
|
||||
**Financial Considerations:**
|
||||
|
||||
- What's the expected development investment (budget/resources)?
|
||||
- What's the revenue potential or cost savings opportunity?
|
||||
- When do you expect to reach break-even?
|
||||
- How does this align with available budget?
|
||||
|
||||
**Strategic Alignment:**
|
||||
|
||||
- Which company OKRs or strategic objectives does this support?
|
||||
- How does this advance key strategic initiatives?
|
||||
- What's the opportunity cost of NOT doing this?
|
||||
|
||||
[VISUAL PLACEHOLDER: Consider adding a simple ROI projection chart here]</ask>
|
||||
|
||||
<action>Help quantify financial impact where possible</action>
|
||||
<action>Connect to broader company strategy</action>
|
||||
<action>Document both tangible and intangible value</action>
|
||||
|
||||
<template-output>financial_impact</template-output>
|
||||
<template-output>company_objectives_alignment</template-output>
|
||||
<template-output>strategic_initiatives</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Explore post-MVP vision" optional="true">
|
||||
<ask>Looking beyond MVP (optional but helpful):
|
||||
|
||||
If the MVP succeeds, what comes next?
|
||||
|
||||
- Phase 2 features?
|
||||
- Expansion opportunities?
|
||||
- Long-term vision (1-2 years)?
|
||||
|
||||
This helps ensure MVP decisions align with future direction.</ask>
|
||||
|
||||
<template-output>phase_2_features</template-output>
|
||||
<template-output>long_term_vision</template-output>
|
||||
<template-output>expansion_opportunities</template-output>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Document technical considerations">
|
||||
<ask>Let's capture technical context. These are preferences, not final decisions:
|
||||
|
||||
Platform requirements:
|
||||
|
||||
- Web, mobile, desktop, or combination?
|
||||
- Browser/OS support needs?
|
||||
- Performance requirements?
|
||||
- Accessibility standards?
|
||||
|
||||
Do you have technology preferences or constraints?
|
||||
|
||||
- Frontend frameworks?
|
||||
- Backend preferences?
|
||||
- Database needs?
|
||||
- Infrastructure requirements?
|
||||
|
||||
Any existing systems to integrate with?</ask>
|
||||
|
||||
<action>Check for technical-preferences.yaml file if available</action>
|
||||
<action>Note these are initial thoughts for PM and architect to consider</action>
|
||||
|
||||
<template-output>platform_requirements</template-output>
|
||||
<template-output>technology_preferences</template-output>
|
||||
<template-output>architecture_considerations</template-output>
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Identify constraints and assumptions">
|
||||
<ask>Let's set realistic expectations:
|
||||
|
||||
What constraints are you working within?
|
||||
|
||||
- Budget or resource limits?
|
||||
- Timeline or deadline pressures?
|
||||
- Team size and expertise?
|
||||
- Technical limitations?
|
||||
|
||||
What assumptions are you making?
|
||||
|
||||
- About user behavior?
|
||||
- About the market?
|
||||
- About technical feasibility?</ask>
|
||||
|
||||
<action>Document constraints clearly</action>
|
||||
<action>List assumptions to validate during development</action>
|
||||
|
||||
<template-output>constraints</template-output>
|
||||
<template-output>key_assumptions</template-output>
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Assess risks and open questions" optional="true">
|
||||
<ask>What keeps you up at night about this project?
|
||||
|
||||
Key risks:
|
||||
|
||||
- What could derail the project?
|
||||
- What's the impact if these risks materialize?
|
||||
|
||||
Open questions:
|
||||
|
||||
- What do you still need to figure out?
|
||||
- What needs more research?
|
||||
|
||||
[VISUAL PLACEHOLDER: Risk/impact matrix could help prioritize]
|
||||
|
||||
Being honest about unknowns helps us prepare.</ask>
|
||||
|
||||
<template-output>key_risks</template-output>
|
||||
<template-output>open_questions</template-output>
|
||||
<template-output>research_areas</template-output>
|
||||
</step>
|
||||
|
||||
<!-- YOLO Mode - Generate everything then refine -->
|
||||
<step n="3" goal="Generate complete brief draft" if="collaboration_mode == 'yolo'">
|
||||
<action>Based on initial context and any provided documents, generate a complete product brief covering all sections</action>
|
||||
<action>Make reasonable assumptions where information is missing</action>
|
||||
<action>Flag areas that need user validation with [NEEDS CONFIRMATION] tags</action>
|
||||
|
||||
<template-output>problem_statement</template-output>
|
||||
<template-output>proposed_solution</template-output>
|
||||
<template-output>primary_user_segment</template-output>
|
||||
<template-output>secondary_user_segment</template-output>
|
||||
<template-output>business_objectives</template-output>
|
||||
<template-output>user_success_metrics</template-output>
|
||||
<template-output>key_performance_indicators</template-output>
|
||||
<template-output>core_features</template-output>
|
||||
<template-output>out_of_scope</template-output>
|
||||
<template-output>mvp_success_criteria</template-output>
|
||||
<template-output>phase_2_features</template-output>
|
||||
<template-output>long_term_vision</template-output>
|
||||
<template-output>expansion_opportunities</template-output>
|
||||
<template-output>financial_impact</template-output>
|
||||
<template-output>company_objectives_alignment</template-output>
|
||||
<template-output>strategic_initiatives</template-output>
|
||||
<template-output>platform_requirements</template-output>
|
||||
<template-output>technology_preferences</template-output>
|
||||
<template-output>architecture_considerations</template-output>
|
||||
<template-output>constraints</template-output>
|
||||
<template-output>key_assumptions</template-output>
|
||||
<template-output>key_risks</template-output>
|
||||
<template-output>open_questions</template-output>
|
||||
<template-output>research_areas</template-output>
|
||||
|
||||
<action>Present the complete draft to the user</action>
|
||||
<ask>Here's the complete brief draft. What would you like to adjust or refine?</ask>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Refine brief sections" repeat="until-approved" if="collaboration_mode == 'yolo'">
|
||||
<ask>Which section would you like to refine?
|
||||
1. Problem Statement
|
||||
2. Proposed Solution
|
||||
3. Target Users
|
||||
4. Goals and Metrics
|
||||
5. MVP Scope
|
||||
6. Post-MVP Vision
|
||||
7. Financial Impact and Strategic Alignment
|
||||
8. Technical Considerations
|
||||
9. Constraints and Assumptions
|
||||
10. Risks and Questions
|
||||
11. Save and continue</ask>
|
||||
|
||||
<action>Work with user to refine selected section</action>
|
||||
<action>Update relevant template outputs</action>
|
||||
</step>
|
||||
|
||||
<!-- Final steps for both modes -->
|
||||
<step n="13" goal="Create executive summary">
|
||||
<action>Synthesize all sections into a compelling executive summary</action>
|
||||
<action>Include:
|
||||
- Product concept in 1-2 sentences
|
||||
- Primary problem being solved
|
||||
- Target market identification
|
||||
- Key value proposition</action>
|
||||
|
||||
<template-output>executive_summary</template-output>
|
||||
</step>
|
||||
|
||||
<step n="14" goal="Compile supporting materials">
|
||||
<action>If research documents were provided, create a summary of key findings</action>
|
||||
<action>Document any stakeholder input received during the process</action>
|
||||
<action>Compile list of reference documents and resources</action>
|
||||
|
||||
<template-output>research_summary</template-output>
|
||||
<template-output>stakeholder_input</template-output>
|
||||
<template-output>references</template-output>
|
||||
</step>
|
||||
|
||||
<step n="15" goal="Final review and handoff">
|
||||
<action>Generate the complete product brief document</action>
|
||||
<action>Review all sections for completeness and consistency</action>
|
||||
<action>Flag any areas that need PM attention with [PM-TODO] tags</action>
|
||||
|
||||
<ask>The product brief is complete! Would you like to:
|
||||
|
||||
1. Review the entire document
|
||||
2. Make final adjustments
|
||||
3. Save and prepare for handoff to PM
|
||||
|
||||
This brief will serve as the primary input for creating the Product Requirements Document (PRD).</ask>
|
||||
|
||||
<template-output>final_brief</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,165 +0,0 @@
|
||||
# Product Brief: {{project_name}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
**Status:** Draft for PM Review
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
|
||||
{{problem_statement}}
|
||||
|
||||
---
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
{{proposed_solution}}
|
||||
|
||||
---
|
||||
|
||||
## Target Users
|
||||
|
||||
### Primary User Segment
|
||||
|
||||
{{primary_user_segment}}
|
||||
|
||||
### Secondary User Segment
|
||||
|
||||
{{secondary_user_segment}}
|
||||
|
||||
---
|
||||
|
||||
## Goals and Success Metrics
|
||||
|
||||
### Business Objectives
|
||||
|
||||
{{business_objectives}}
|
||||
|
||||
### User Success Metrics
|
||||
|
||||
{{user_success_metrics}}
|
||||
|
||||
### Key Performance Indicators (KPIs)
|
||||
|
||||
{{key_performance_indicators}}
|
||||
|
||||
---
|
||||
|
||||
## Strategic Alignment and Financial Impact
|
||||
|
||||
### Financial Impact
|
||||
|
||||
{{financial_impact}}
|
||||
|
||||
### Company Objectives Alignment
|
||||
|
||||
{{company_objectives_alignment}}
|
||||
|
||||
### Strategic Initiatives
|
||||
|
||||
{{strategic_initiatives}}
|
||||
|
||||
---
|
||||
|
||||
## MVP Scope
|
||||
|
||||
### Core Features (Must Have)
|
||||
|
||||
{{core_features}}
|
||||
|
||||
### Out of Scope for MVP
|
||||
|
||||
{{out_of_scope}}
|
||||
|
||||
### MVP Success Criteria
|
||||
|
||||
{{mvp_success_criteria}}
|
||||
|
||||
---
|
||||
|
||||
## Post-MVP Vision
|
||||
|
||||
### Phase 2 Features
|
||||
|
||||
{{phase_2_features}}
|
||||
|
||||
### Long-term Vision
|
||||
|
||||
{{long_term_vision}}
|
||||
|
||||
### Expansion Opportunities
|
||||
|
||||
{{expansion_opportunities}}
|
||||
|
||||
---
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
### Platform Requirements
|
||||
|
||||
{{platform_requirements}}
|
||||
|
||||
### Technology Preferences
|
||||
|
||||
{{technology_preferences}}
|
||||
|
||||
### Architecture Considerations
|
||||
|
||||
{{architecture_considerations}}
|
||||
|
||||
---
|
||||
|
||||
## Constraints and Assumptions
|
||||
|
||||
### Constraints
|
||||
|
||||
{{constraints}}
|
||||
|
||||
### Key Assumptions
|
||||
|
||||
{{key_assumptions}}
|
||||
|
||||
---
|
||||
|
||||
## Risks and Open Questions
|
||||
|
||||
### Key Risks
|
||||
|
||||
{{key_risks}}
|
||||
|
||||
### Open Questions
|
||||
|
||||
{{open_questions}}
|
||||
|
||||
### Areas Needing Further Research
|
||||
|
||||
{{research_areas}}
|
||||
|
||||
---
|
||||
|
||||
## Appendices
|
||||
|
||||
### A. Research Summary
|
||||
|
||||
{{research_summary}}
|
||||
|
||||
### B. Stakeholder Input
|
||||
|
||||
{{stakeholder_input}}
|
||||
|
||||
### C. References
|
||||
|
||||
{{references}}
|
||||
|
||||
---
|
||||
|
||||
_This Product Brief serves as the foundational input for Product Requirements Document (PRD) creation._
|
||||
|
||||
_Next Steps: Handoff to Product Manager for PRD development using the `workflow prd` command._
|
||||
@@ -1,30 +0,0 @@
|
||||
# Product Brief - Interactive Workflow Configuration
|
||||
name: product-brief
|
||||
description: "Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmm/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
date: system-generated
|
||||
|
||||
# Optional input documents
|
||||
recommended_inputs:
|
||||
- market_research: "Market research document (optional)"
|
||||
- brainstorming_results: "Brainstorming session outputs (optional)"
|
||||
- competitive_analysis: "Competitive analysis (optional)"
|
||||
- initial_ideas: "Initial product ideas or notes (optional)"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/1-analysis/product-brief"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/product-brief-{{project_name}}-{{date}}.md"
|
||||
|
||||
# Workflow settings
|
||||
autonomous: false # This is an interactive workflow requiring user collaboration
|
||||
brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
|
||||
@@ -1,454 +0,0 @@
|
||||
# Research Workflow - Multi-Type Research System
|
||||
|
||||
## Overview
|
||||
|
||||
The Research Workflow is a comprehensive, adaptive research system that supports multiple research types through an intelligent router pattern. This workflow consolidates various research methodologies into a single, powerful tool that adapts to your specific research needs - from market analysis to technical evaluation to AI prompt generation.
|
||||
|
||||
**Version 2.0.0** - Multi-type research system with router-based architecture
|
||||
|
||||
## Key Features
|
||||
|
||||
### 🔀 Intelligent Research Router
|
||||
|
||||
- **6 Research Types**: Market, Deep Prompt, Technical, Competitive, User, Domain
|
||||
- **Dynamic Instructions**: Loads appropriate instruction set based on research type
|
||||
- **Adaptive Templates**: Selects optimal output format for research goal
|
||||
- **Context-Aware**: Adjusts frameworks and methods per research type
|
||||
|
||||
### 🔍 Market Research (Type: `market`)
|
||||
|
||||
- Real-time web research for current market data
|
||||
- TAM/SAM/SOM calculations with multiple methodologies
|
||||
- Competitive landscape analysis and positioning
|
||||
- Customer persona development and Jobs-to-be-Done
|
||||
- Porter's Five Forces and strategic frameworks
|
||||
- Go-to-market strategy recommendations
|
||||
|
||||
### 🤖 Deep Research Prompt Generation (Type: `deep_prompt`)
|
||||
|
||||
- **Optimized for AI Research Platforms**: ChatGPT Deep Research, Gemini, Grok DeepSearch, Claude Projects
|
||||
- **Prompt Engineering Best Practices**: Multi-stage research workflows, iterative refinement
|
||||
- **Platform-Specific Optimization**: Tailored prompts for each AI research tool
|
||||
- **Context Packaging**: Structures background information for optimal AI understanding
|
||||
- **Research Question Refinement**: Transforms vague questions into precise research prompts
|
||||
|
||||
### 🏗️ Technical/Architecture Research (Type: `technical`)
|
||||
|
||||
- Technology evaluation and comparison matrices
|
||||
- Architecture pattern research and trade-off analysis
|
||||
- Framework/library assessment with pros/cons
|
||||
- Technical feasibility studies
|
||||
- Cost-benefit analysis for technology decisions
|
||||
- Architecture Decision Records (ADR) generation
|
||||
|
||||
### 🎯 Competitive Intelligence (Type: `competitive`)
|
||||
|
||||
- Deep competitor analysis and profiling
|
||||
- Competitive positioning and gap analysis
|
||||
- Strategic group mapping
|
||||
- Feature comparison matrices
|
||||
- Pricing strategy analysis
|
||||
- Market share and growth tracking
|
||||
|
||||
### 👥 User Research (Type: `user`)
|
||||
|
||||
- Customer insights and behavioral analysis
|
||||
- Persona development with demographics and psychographics
|
||||
- Jobs-to-be-Done framework application
|
||||
- Customer journey mapping
|
||||
- Pain point identification
|
||||
- Willingness-to-pay analysis
|
||||
|
||||
### 🌐 Domain/Industry Research (Type: `domain`)
|
||||
|
||||
- Industry deep dives and trend analysis
|
||||
- Regulatory landscape assessment
|
||||
- Domain expertise synthesis
|
||||
- Best practices identification
|
||||
- Standards and compliance requirements
|
||||
- Emerging patterns and disruptions
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Invocation
|
||||
|
||||
```bash
|
||||
workflow research
|
||||
```
|
||||
|
||||
The workflow will prompt you to select a research type.
|
||||
|
||||
### Direct Research Type Selection
|
||||
|
||||
```bash
|
||||
# Market research
|
||||
workflow research --type market
|
||||
|
||||
# Deep research prompt generation
|
||||
workflow research --type deep_prompt
|
||||
|
||||
# Technical evaluation
|
||||
workflow research --type technical
|
||||
|
||||
# Competitive intelligence
|
||||
workflow research --type competitive
|
||||
|
||||
# User research
|
||||
workflow research --type user
|
||||
|
||||
# Domain analysis
|
||||
workflow research --type domain
|
||||
```
|
||||
|
||||
### With Input Documents
|
||||
|
||||
```bash
|
||||
workflow research --type market --input product-brief.md --input competitor-list.md
|
||||
workflow research --type technical --input requirements.md --input architecture.md
|
||||
workflow research --type deep_prompt --input research-question.md
|
||||
```
|
||||
|
||||
### Configuration Options
|
||||
|
||||
Can be customized through `workflow.yaml`:
|
||||
|
||||
- **research_depth**: `quick`, `standard`, or `comprehensive`
|
||||
- **enable_web_research**: `true`/`false` for real-time data gathering
|
||||
- **enable_competitor_analysis**: `true`/`false` (market/competitive types)
|
||||
- **enable_financial_modeling**: `true`/`false` (market type)
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Files Included
|
||||
|
||||
```
|
||||
research/
|
||||
├── workflow.yaml # Multi-type configuration
|
||||
├── instructions-router.md # Router logic (loads correct instructions)
|
||||
├── instructions-market.md # Market research workflow
|
||||
├── instructions-deep-prompt.md # Deep prompt generation workflow
|
||||
├── instructions-technical.md # Technical evaluation workflow
|
||||
├── template-market.md # Market research report template
|
||||
├── template-deep-prompt.md # Research prompt template
|
||||
├── template-technical.md # Technical evaluation template
|
||||
├── checklist.md # Universal validation criteria
|
||||
├── README.md # This file
|
||||
└── claude-code/ # Claude Code enhancements (optional)
|
||||
├── injections.yaml # Integration configuration
|
||||
└── sub-agents/ # Specialized research agents
|
||||
├── bmm-market-researcher.md
|
||||
├── bmm-trend-spotter.md
|
||||
├── bmm-data-analyst.md
|
||||
├── bmm-competitor-analyzer.md
|
||||
├── bmm-user-researcher.md
|
||||
└── bmm-technical-evaluator.md
|
||||
```
|
||||
|
||||
## Workflow Process
|
||||
|
||||
### Phase 1: Research Type Selection and Setup
|
||||
|
||||
1. Router presents research type menu
|
||||
2. User selects research type (market, deep_prompt, technical, competitive, user, domain)
|
||||
3. Router loads appropriate instructions and template
|
||||
4. Gather research parameters and inputs
|
||||
|
||||
### Phase 2: Research Type-Specific Execution
|
||||
|
||||
**For Market Research:**
|
||||
|
||||
1. Define research objectives and market boundaries
|
||||
2. Conduct web research across multiple sources
|
||||
3. Calculate TAM/SAM/SOM with triangulation
|
||||
4. Develop customer segments and personas
|
||||
5. Analyze competitive landscape
|
||||
6. Apply industry frameworks (Porter's Five Forces, etc.)
|
||||
7. Identify trends and opportunities
|
||||
8. Develop strategic recommendations
|
||||
9. Create financial projections (optional)
|
||||
10. Compile comprehensive report
|
||||
|
||||
**For Deep Prompt Generation:**
|
||||
|
||||
1. Analyze research question or topic
|
||||
2. Identify optimal AI research platform (ChatGPT, Gemini, Grok, Claude)
|
||||
3. Structure research context and background
|
||||
4. Generate platform-optimized prompt
|
||||
5. Create multi-stage research workflow
|
||||
6. Define iteration and refinement strategy
|
||||
7. Package with context documents
|
||||
8. Provide execution guidance
|
||||
|
||||
**For Technical Research:**
|
||||
|
||||
1. Define technical requirements and constraints
|
||||
2. Identify technologies/frameworks to evaluate
|
||||
3. Research each option (documentation, community, maturity)
|
||||
4. Create comparison matrix with criteria
|
||||
5. Perform trade-off analysis
|
||||
6. Calculate cost-benefit for each option
|
||||
7. Generate Architecture Decision Record (ADR)
|
||||
8. Provide recommendation with rationale
|
||||
|
||||
**For Competitive/User/Domain:**
|
||||
|
||||
- Uses market research workflow with specific focus
|
||||
- Adapts questions and frameworks to research type
|
||||
- Customizes output format for target audience
|
||||
|
||||
### Phase 3: Validation and Delivery
|
||||
|
||||
1. Review outputs against checklist
|
||||
2. Validate completeness and quality
|
||||
3. Generate final report/document
|
||||
4. Provide next steps and recommendations
|
||||
|
||||
## Output
|
||||
|
||||
### Generated Files by Research Type
|
||||
|
||||
**Market Research:**
|
||||
|
||||
- `market-research-{product_name}-{date}.md`
|
||||
- Comprehensive market analysis report (10+ sections)
|
||||
|
||||
**Deep Research Prompt:**
|
||||
|
||||
- `deep-research-prompt-{date}.md`
|
||||
- Optimized AI research prompt with context and instructions
|
||||
|
||||
**Technical Research:**
|
||||
|
||||
- `technical-research-{date}.md`
|
||||
- Technology evaluation with comparison matrix and ADR
|
||||
|
||||
**Competitive Intelligence:**
|
||||
|
||||
- `competitive-intelligence-{date}.md`
|
||||
- Detailed competitor analysis and positioning
|
||||
|
||||
**User Research:**
|
||||
|
||||
- `user-research-{date}.md`
|
||||
- Customer insights and persona documentation
|
||||
|
||||
**Domain Research:**
|
||||
|
||||
- `domain-research-{date}.md`
|
||||
- Industry deep dive with trends and best practices
|
||||
|
||||
## Requirements
|
||||
|
||||
### All Research Types
|
||||
|
||||
- BMAD Core v6 project structure
|
||||
- Web search capability (for real-time research)
|
||||
- Access to research data sources
|
||||
|
||||
### Market Research
|
||||
|
||||
- Product or business description
|
||||
- Target customer hypotheses (optional)
|
||||
- Known competitors list (optional)
|
||||
|
||||
### Deep Prompt Research
|
||||
|
||||
- Research question or topic
|
||||
- Background context documents (optional)
|
||||
- Target AI platform preference (optional)
|
||||
|
||||
### Technical Research
|
||||
|
||||
- Technical requirements document
|
||||
- Current architecture (if brownfield)
|
||||
- Technical constraints list
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Before Starting
|
||||
|
||||
1. **Know Your Research Goal**: Select the most appropriate research type
|
||||
2. **Gather Context**: Collect relevant documents before starting
|
||||
3. **Set Depth Level**: Choose appropriate research_depth (quick/standard/comprehensive)
|
||||
4. **Define Success Criteria**: What decisions will this research inform?
|
||||
|
||||
### During Execution
|
||||
|
||||
**Market Research:**
|
||||
|
||||
- Provide specific product/service details
|
||||
- Validate market boundaries carefully
|
||||
- Review TAM/SAM/SOM assumptions
|
||||
- Challenge competitive positioning
|
||||
|
||||
**Deep Prompt Generation:**
|
||||
|
||||
- Be specific about research platform target
|
||||
- Provide rich context documents
|
||||
- Clarify expected research outcome
|
||||
- Define iteration strategy
|
||||
|
||||
**Technical Research:**
|
||||
|
||||
- List all evaluation criteria upfront
|
||||
- Weight criteria by importance
|
||||
- Consider long-term implications
|
||||
- Include cost analysis
|
||||
|
||||
### After Completion
|
||||
|
||||
1. Review using the validation checklist
|
||||
2. Update with any missing information
|
||||
3. Share with stakeholders for feedback
|
||||
4. Schedule follow-up research if needed
|
||||
5. Document decisions made based on research
|
||||
|
||||
## Research Frameworks Available
|
||||
|
||||
### Market Research Frameworks
|
||||
|
||||
- TAM/SAM/SOM Analysis
|
||||
- Porter's Five Forces
|
||||
- Jobs-to-be-Done (JTBD)
|
||||
- Technology Adoption Lifecycle
|
||||
- SWOT Analysis
|
||||
- Value Chain Analysis
|
||||
|
||||
### Technical Research Frameworks
|
||||
|
||||
- Trade-off Analysis Matrix
|
||||
- Architecture Decision Records (ADR)
|
||||
- Technology Radar
|
||||
- Comparison Matrix
|
||||
- Cost-Benefit Analysis
|
||||
- Technical Risk Assessment
|
||||
|
||||
### Deep Prompt Frameworks
|
||||
|
||||
- ChatGPT Deep Research Best Practices
|
||||
- Gemini Deep Research Framework
|
||||
- Grok DeepSearch Optimization
|
||||
- Claude Projects Methodology
|
||||
- Iterative Prompt Refinement
|
||||
|
||||
## Data Sources
|
||||
|
||||
The workflow leverages multiple data sources:
|
||||
|
||||
- Industry reports and publications
|
||||
- Government statistics and databases
|
||||
- Financial reports and SEC filings
|
||||
- News articles and press releases
|
||||
- Academic research papers
|
||||
- Technical documentation and RFCs
|
||||
- GitHub repositories and discussions
|
||||
- Stack Overflow and developer forums
|
||||
- Market research firm reports
|
||||
- Social media and communities
|
||||
- Patent databases
|
||||
- Benchmarking studies
|
||||
|
||||
## Claude Code Enhancements
|
||||
|
||||
### Available Subagents
|
||||
|
||||
1. **bmm-market-researcher** - Market intelligence gathering
|
||||
2. **bmm-trend-spotter** - Emerging trends and weak signals
|
||||
3. **bmm-data-analyst** - Quantitative analysis and modeling
|
||||
4. **bmm-competitor-analyzer** - Competitive intelligence
|
||||
5. **bmm-user-researcher** - Customer insights and personas
|
||||
6. **bmm-technical-evaluator** - Technology assessment
|
||||
|
||||
These are automatically invoked during workflow execution if Claude Code integration is configured.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Issue: Don't know which research type to choose
|
||||
|
||||
- **Solution**: Start with research question - "What do I need to know?"
|
||||
- Market viability? → `market`
|
||||
- Best technology? → `technical`
|
||||
- Need AI to research deeper? → `deep_prompt`
|
||||
- Who are competitors? → `competitive`
|
||||
- Who are users? → `user`
|
||||
- Industry understanding? → `domain`
|
||||
|
||||
### Issue: Market research results seem incomplete
|
||||
|
||||
- **Solution**: Increase research_depth to `comprehensive`
|
||||
- **Check**: Enable web_research in workflow.yaml
|
||||
- **Try**: Run competitive and user research separately for more depth
|
||||
|
||||
### Issue: Deep prompt doesn't work with target platform
|
||||
|
||||
- **Solution**: Review platform-specific best practices in generated prompt
|
||||
- **Check**: Ensure context documents are included
|
||||
- **Try**: Regenerate with different platform selection
|
||||
|
||||
### Issue: Technical comparison is subjective
|
||||
|
||||
- **Solution**: Add more objective criteria (performance metrics, cost, community size)
|
||||
- **Check**: Weight criteria by business importance
|
||||
- **Try**: Run pilot implementations for top 2 options
|
||||
|
||||
## Customization
|
||||
|
||||
### Adding New Research Types
|
||||
|
||||
1. Create new instructions file: `instructions-{type}.md`
|
||||
2. Create new template file: `template-{type}.md`
|
||||
3. Add research type to `workflow.yaml` `research_types` section
|
||||
4. Update router logic in `instructions-router.md`
|
||||
|
||||
### Modifying Existing Research Types
|
||||
|
||||
1. Edit appropriate `instructions-{type}.md` file
|
||||
2. Update corresponding `template-{type}.md` if needed
|
||||
3. Adjust validation criteria in `checklist.md`
|
||||
|
||||
### Creating Custom Frameworks
|
||||
|
||||
Add to `workflow.yaml` `frameworks` section under appropriate research type.
|
||||
|
||||
## Version History
|
||||
|
||||
- **v2.0.0** - Multi-type research system with router architecture
|
||||
- Added deep_prompt research type for AI research platform optimization
|
||||
- Added technical research type for technology evaluation
|
||||
- Consolidated competitive, user, domain under market with focus variants
|
||||
- Router-based instruction loading
|
||||
- Template selection by research type
|
||||
- Enhanced Claude Code subagent support
|
||||
|
||||
- **v1.0.0** - Initial market research only implementation
|
||||
- Single-purpose market research workflow
|
||||
- Now deprecated in favor of v2.0.0 multi-type system
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Check validation against `checklist.md`
|
||||
- Examine router logic in `instructions-router.md`
|
||||
- Review research type-specific instructions
|
||||
- Consult BMAD Method v6 documentation
|
||||
|
||||
## Migration from v1.0 market-research
|
||||
|
||||
If you're used to the standalone `market-research` workflow:
|
||||
|
||||
```bash
|
||||
# Old way
|
||||
workflow market-research
|
||||
|
||||
# New way
|
||||
workflow research --type market
|
||||
# Or just: workflow research (then select market)
|
||||
```
|
||||
|
||||
All market research functionality is preserved and enhanced in v2.0.0.
|
||||
|
||||
---
|
||||
|
||||
_Part of the BMad Method v6 - BMM (BMad Method) Module - Empowering systematic research and analysis_
|
||||
@@ -1,202 +0,0 @@
|
||||
# Market Research Report Validation Checklist
|
||||
|
||||
## Research Foundation
|
||||
|
||||
### Objectives and Scope
|
||||
|
||||
- [ ] Research objectives are clearly stated with specific questions to answer
|
||||
- [ ] Market boundaries are explicitly defined (product category, geography, segments)
|
||||
- [ ] Research methodology is documented with data sources and timeframes
|
||||
- [ ] Limitations and assumptions are transparently acknowledged
|
||||
|
||||
### Data Quality
|
||||
|
||||
- [ ] All data sources are cited with dates and links where applicable
|
||||
- [ ] Data is no more than 12 months old for time-sensitive metrics
|
||||
- [ ] At least 3 independent sources validate key market size claims
|
||||
- [ ] Source credibility is assessed (primary > industry reports > news articles)
|
||||
- [ ] Conflicting data points are acknowledged and reconciled
|
||||
|
||||
## Market Sizing Analysis
|
||||
|
||||
### TAM Calculation
|
||||
|
||||
- [ ] At least 2 different calculation methods are used (top-down, bottom-up, or value theory)
|
||||
- [ ] All assumptions are explicitly stated with rationale
|
||||
- [ ] Calculation methodology is shown step-by-step
|
||||
- [ ] Numbers are sanity-checked against industry benchmarks
|
||||
- [ ] Growth rate projections include supporting evidence
|
||||
|
||||
### SAM and SOM
|
||||
|
||||
- [ ] SAM constraints are realistic and well-justified (geography, regulations, etc.)
|
||||
- [ ] SOM includes competitive analysis to support market share assumptions
|
||||
- [ ] Three scenarios (conservative, realistic, optimistic) are provided
|
||||
- [ ] Time horizons for market capture are specified (Year 1, 3, 5)
|
||||
- [ ] Market share percentages align with comparable company benchmarks
|
||||
|
||||
## Customer Intelligence
|
||||
|
||||
### Segment Analysis
|
||||
|
||||
- [ ] At least 3 distinct customer segments are profiled
|
||||
- [ ] Each segment includes size estimates (number of customers or revenue)
|
||||
- [ ] Pain points are specific, not generic (e.g., "reduce invoice processing time by 50%" not "save time")
|
||||
- [ ] Willingness to pay is quantified with evidence
|
||||
- [ ] Buying process and decision criteria are documented
|
||||
|
||||
### Jobs-to-be-Done
|
||||
|
||||
- [ ] Functional jobs describe specific tasks customers need to complete
|
||||
- [ ] Emotional jobs identify feelings and anxieties
|
||||
- [ ] Social jobs explain perception and status considerations
|
||||
- [ ] Jobs are validated with customer evidence, not assumptions
|
||||
- [ ] Priority ranking of jobs is provided
|
||||
|
||||
## Competitive Analysis
|
||||
|
||||
### Competitor Coverage
|
||||
|
||||
- [ ] At least 5 direct competitors are analyzed
|
||||
- [ ] Indirect competitors and substitutes are identified
|
||||
- [ ] Each competitor profile includes: company size, funding, target market, pricing
|
||||
- [ ] Recent developments (last 6 months) are included
|
||||
- [ ] Competitive advantages and weaknesses are specific, not generic
|
||||
|
||||
### Positioning Analysis
|
||||
|
||||
- [ ] Market positioning map uses relevant dimensions for the industry
|
||||
- [ ] White space opportunities are clearly identified
|
||||
- [ ] Differentiation strategy is supported by competitive gaps
|
||||
- [ ] Switching costs and barriers are quantified
|
||||
- [ ] Network effects and moats are assessed
|
||||
|
||||
## Industry Analysis
|
||||
|
||||
### Porter's Five Forces
|
||||
|
||||
- [ ] Each force has a clear rating (Low/Medium/High) with justification
|
||||
- [ ] Specific examples and evidence support each assessment
|
||||
- [ ] Industry-specific factors are considered (not generic template)
|
||||
- [ ] Implications for strategy are drawn from each force
|
||||
- [ ] Overall industry attractiveness conclusion is provided
|
||||
|
||||
### Trends and Dynamics
|
||||
|
||||
- [ ] At least 5 major trends are identified with evidence
|
||||
- [ ] Technology disruptions are assessed for probability and timeline
|
||||
- [ ] Regulatory changes and their impacts are documented
|
||||
- [ ] Social/cultural shifts relevant to adoption are included
|
||||
- [ ] Market maturity stage is identified with supporting indicators
|
||||
|
||||
## Strategic Recommendations
|
||||
|
||||
### Go-to-Market Strategy
|
||||
|
||||
- [ ] Target segment prioritization has clear rationale
|
||||
- [ ] Positioning statement is specific and differentiated
|
||||
- [ ] Channel strategy aligns with customer buying behavior
|
||||
- [ ] Partnership opportunities are identified with specific targets
|
||||
- [ ] Pricing strategy is justified by willingness-to-pay analysis
|
||||
|
||||
### Opportunity Assessment
|
||||
|
||||
- [ ] Each opportunity is sized quantitatively
|
||||
- [ ] Resource requirements are estimated (time, money, people)
|
||||
- [ ] Success criteria are measurable and time-bound
|
||||
- [ ] Dependencies and prerequisites are identified
|
||||
- [ ] Quick wins vs. long-term plays are distinguished
|
||||
|
||||
### Risk Analysis
|
||||
|
||||
- [ ] All major risk categories are covered (market, competitive, execution, regulatory)
|
||||
- [ ] Each risk has probability and impact assessment
|
||||
- [ ] Mitigation strategies are specific and actionable
|
||||
- [ ] Early warning indicators are defined
|
||||
- [ ] Contingency plans are outlined for high-impact risks
|
||||
|
||||
## Document Quality
|
||||
|
||||
### Structure and Flow
|
||||
|
||||
- [ ] Executive summary captures all key insights in 1-2 pages
|
||||
- [ ] Sections follow logical progression from market to strategy
|
||||
- [ ] No placeholder text remains (all {{variables}} are replaced)
|
||||
- [ ] Cross-references between sections are accurate
|
||||
- [ ] Table of contents matches actual sections
|
||||
|
||||
### Professional Standards
|
||||
|
||||
- [ ] Data visualizations effectively communicate insights
|
||||
- [ ] Technical terms are defined in glossary
|
||||
- [ ] Writing is concise and jargon-free
|
||||
- [ ] Formatting is consistent throughout
|
||||
- [ ] Document is ready for executive presentation
|
||||
|
||||
## Research Completeness
|
||||
|
||||
### Coverage Check
|
||||
|
||||
- [ ] All workflow steps were completed (none skipped without justification)
|
||||
- [ ] Optional analyses were considered and included where valuable
|
||||
- [ ] Web research was conducted for current market intelligence
|
||||
- [ ] Financial projections align with market size analysis
|
||||
- [ ] Implementation roadmap provides clear next steps
|
||||
|
||||
### Validation
|
||||
|
||||
- [ ] Key findings are triangulated across multiple sources
|
||||
- [ ] Surprising insights are double-checked for accuracy
|
||||
- [ ] Calculations are verified for mathematical accuracy
|
||||
- [ ] Conclusions logically follow from the analysis
|
||||
- [ ] Recommendations are actionable and specific
|
||||
|
||||
## Final Quality Assurance
|
||||
|
||||
### Ready for Decision-Making
|
||||
|
||||
- [ ] Research answers all initial objectives
|
||||
- [ ] Sufficient detail for investment decisions
|
||||
- [ ] Clear go/no-go recommendation provided
|
||||
- [ ] Success metrics are defined
|
||||
- [ ] Follow-up research needs are identified
|
||||
|
||||
### Document Meta
|
||||
|
||||
- [ ] Research date is current
|
||||
- [ ] Confidence levels are indicated for key assertions
|
||||
- [ ] Next review date is set
|
||||
- [ ] Distribution list is appropriate
|
||||
- [ ] Confidentiality classification is marked
|
||||
|
||||
---
|
||||
|
||||
## Issues Found
|
||||
|
||||
### Critical Issues
|
||||
|
||||
_List any critical gaps or errors that must be addressed:_
|
||||
|
||||
- [ ] Issue 1: [Description]
|
||||
- [ ] Issue 2: [Description]
|
||||
|
||||
### Minor Issues
|
||||
|
||||
_List minor improvements that would enhance the report:_
|
||||
|
||||
- [ ] Issue 1: [Description]
|
||||
- [ ] Issue 2: [Description]
|
||||
|
||||
### Additional Research Needed
|
||||
|
||||
_List areas requiring further investigation:_
|
||||
|
||||
- [ ] Topic 1: [Description]
|
||||
- [ ] Topic 2: [Description]
|
||||
|
||||
---
|
||||
|
||||
**Validation Complete:** ☐ Yes ☐ No
|
||||
**Ready for Distribution:** ☐ Yes ☐ No
|
||||
**Reviewer:** **\*\***\_\_\_\_**\*\***
|
||||
**Date:** **\*\***\_\_\_\_**\*\***
|
||||
@@ -1,114 +0,0 @@
|
||||
# Market Research Workflow - Claude Code Integration Configuration
|
||||
# This file configures how subagents are installed and integrated
|
||||
|
||||
subagents:
|
||||
# List of subagent files to be installed
|
||||
files:
|
||||
- bmm-market-researcher.md
|
||||
- bmm-trend-spotter.md
|
||||
- bmm-data-analyst.md
|
||||
- bmm-competitor-analyzer.md
|
||||
- bmm-user-researcher.md
|
||||
|
||||
# Installation configuration
|
||||
installation:
|
||||
prompt: "The Market Research workflow includes specialized AI subagents for enhanced research capabilities. Would you like to install them?"
|
||||
location_options:
|
||||
- project # Install to .claude/agents/ in project
|
||||
- user # Install to ~/.claude/agents/ for all projects
|
||||
default_location: project
|
||||
|
||||
# Content injections for the workflow
|
||||
injections:
|
||||
- injection_point: "market-research-subagents"
|
||||
description: "Injects subagent activation instructions into the workflow"
|
||||
content: |
|
||||
<critical>
|
||||
Claude Code Enhanced Mode: The following specialized subagents are available to enhance your market research:
|
||||
|
||||
- **bmm-market-researcher**: Comprehensive market intelligence gathering and analysis
|
||||
- **bmm-trend-spotter**: Identifies emerging trends and weak signals
|
||||
- **bmm-data-analyst**: Quantitative analysis and market sizing calculations
|
||||
- **bmm-competitor-analyzer**: Deep competitive intelligence and positioning
|
||||
- **bmm-user-researcher**: User research, personas, and journey mapping
|
||||
|
||||
These subagents will be automatically invoked when their expertise is relevant to the current research task.
|
||||
Use them PROACTIVELY throughout the workflow for enhanced insights.
|
||||
</critical>
|
||||
|
||||
- injection_point: "market-tam-calculations"
|
||||
description: "Enhanced TAM calculation with data analyst"
|
||||
content: |
|
||||
<invoke-subagent name="bmm-data-analyst">
|
||||
Calculate TAM using multiple methodologies and provide confidence intervals.
|
||||
Use all available market data from previous research steps.
|
||||
Show detailed calculations and assumptions.
|
||||
</invoke-subagent>
|
||||
|
||||
- injection_point: "market-trends-analysis"
|
||||
description: "Enhanced trend analysis with trend spotter"
|
||||
content: |
|
||||
<invoke-subagent name="bmm-trend-spotter">
|
||||
Identify emerging trends, weak signals, and future disruptions.
|
||||
Look for cross-industry patterns and second-order effects.
|
||||
Provide timeline estimates for mainstream adoption.
|
||||
</invoke-subagent>
|
||||
|
||||
- injection_point: "market-customer-segments"
|
||||
description: "Enhanced customer research"
|
||||
content: |
|
||||
<invoke-subagent name="bmm-user-researcher">
|
||||
Develop detailed user personas with jobs-to-be-done analysis.
|
||||
Map the complete customer journey with pain points and opportunities.
|
||||
Provide behavioral and psychographic insights.
|
||||
</invoke-subagent>
|
||||
|
||||
- injection_point: "market-executive-summary"
|
||||
description: "Enhanced executive summary synthesis"
|
||||
content: |
|
||||
<invoke-subagent name="bmm-market-researcher">
|
||||
Synthesize all research findings into a compelling executive summary.
|
||||
Highlight the most critical insights and strategic implications.
|
||||
Ensure all key metrics and recommendations are captured.
|
||||
</invoke-subagent>
|
||||
|
||||
# Configuration for subagent behavior
|
||||
configuration:
|
||||
auto_invoke: true # Automatically invoke subagents when relevant
|
||||
parallel_execution: true # Allow parallel subagent execution
|
||||
cache_results: true # Cache subagent outputs for reuse
|
||||
|
||||
# Subagent-specific configurations
|
||||
subagent_config:
|
||||
bmm-market-researcher:
|
||||
priority: high
|
||||
max_execution_time: 300 # seconds
|
||||
retry_on_failure: true
|
||||
|
||||
bmm-trend-spotter:
|
||||
priority: medium
|
||||
max_execution_time: 180
|
||||
retry_on_failure: false
|
||||
|
||||
bmm-data-analyst:
|
||||
priority: high
|
||||
max_execution_time: 240
|
||||
retry_on_failure: true
|
||||
|
||||
bmm-competitor-analyzer:
|
||||
priority: high
|
||||
max_execution_time: 300
|
||||
retry_on_failure: true
|
||||
|
||||
bmm-user-researcher:
|
||||
priority: medium
|
||||
max_execution_time: 240
|
||||
retry_on_failure: false
|
||||
|
||||
# Metadata
|
||||
metadata:
|
||||
compatible_with: "claude-code-1.0+"
|
||||
workflow: "market-research"
|
||||
module: "bmm"
|
||||
author: "BMad Builder"
|
||||
description: "Claude Code enhancements for comprehensive market research"
|
||||
@@ -1,259 +0,0 @@
|
||||
---
|
||||
name: bmm-competitor-analyzer
|
||||
description: Deep competitive intelligence gathering and strategic analysis. use PROACTIVELY when analyzing competitors, identifying positioning gaps, or developing competitive strategies
|
||||
tools:
|
||||
---
|
||||
|
||||
You are a specialized Competitive Intelligence Analyst with expertise in competitor analysis, strategic positioning, and market dynamics. Your role is to provide actionable competitive insights.
|
||||
|
||||
## Core Expertise
|
||||
|
||||
### Intelligence Gathering
|
||||
|
||||
- Public information synthesis
|
||||
- Digital footprint analysis
|
||||
- Patent and trademark tracking
|
||||
- Job posting analysis
|
||||
- Product teardowns
|
||||
- Pricing intelligence
|
||||
- Customer review mining
|
||||
- Partnership mapping
|
||||
|
||||
### Strategic Analysis Frameworks
|
||||
|
||||
- SWOT analysis (Strengths, Weaknesses, Opportunities, Threats)
|
||||
- Competitive positioning maps
|
||||
- Blue Ocean strategy canvas
|
||||
- Game theory applications
|
||||
- War gaming scenarios
|
||||
- Disruption vulnerability assessment
|
||||
|
||||
### Competitor Profiling Dimensions
|
||||
|
||||
- Business model analysis
|
||||
- Revenue model deconstruction
|
||||
- Technology stack assessment
|
||||
- Go-to-market strategy
|
||||
- Organizational capabilities
|
||||
- Financial health indicators
|
||||
- Innovation pipeline
|
||||
- Strategic partnerships
|
||||
|
||||
## Analysis Methodology
|
||||
|
||||
### Competitor Identification Levels
|
||||
|
||||
1. **Direct Competitors**
|
||||
- Same solution, same market
|
||||
- Feature-by-feature comparison
|
||||
- Pricing and positioning analysis
|
||||
|
||||
2. **Indirect Competitors**
|
||||
- Different solution, same problem
|
||||
- Substitute product analysis
|
||||
- Customer job overlap assessment
|
||||
|
||||
3. **Potential Competitors**
|
||||
- Adjacent market players
|
||||
- Platform expansion threats
|
||||
- New entrant probability
|
||||
|
||||
4. **Asymmetric Competitors**
|
||||
- Different business models
|
||||
- Free/open source alternatives
|
||||
- DIY solutions
|
||||
|
||||
### Deep Dive Analysis Components
|
||||
|
||||
#### Product Intelligence
|
||||
|
||||
- Feature comparison matrix
|
||||
- Release cycle patterns
|
||||
- Technology advantages
|
||||
- User experience assessment
|
||||
- Integration ecosystem
|
||||
- Platform capabilities
|
||||
|
||||
#### Market Position
|
||||
|
||||
- Market share estimates
|
||||
- Customer segment focus
|
||||
- Geographic presence
|
||||
- Channel strategy
|
||||
- Brand positioning
|
||||
- Thought leadership
|
||||
|
||||
#### Financial Intelligence
|
||||
|
||||
- Revenue estimates/actuals
|
||||
- Funding history
|
||||
- Burn rate indicators
|
||||
- Pricing strategy
|
||||
- Unit economics
|
||||
- Investment priorities
|
||||
|
||||
#### Organizational Intelligence
|
||||
|
||||
- Team composition
|
||||
- Key hires/departures
|
||||
- Culture and values
|
||||
- Innovation capacity
|
||||
- Execution speed
|
||||
- Strategic priorities
|
||||
|
||||
## Competitive Dynamics Assessment
|
||||
|
||||
### Market Structure Analysis
|
||||
|
||||
- Concentration levels (HHI index)
|
||||
- Barriers to entry/exit
|
||||
- Switching costs
|
||||
- Network effects
|
||||
- Economies of scale
|
||||
- Regulatory moats
|
||||
|
||||
### Strategic Group Mapping
|
||||
|
||||
- Performance dimensions
|
||||
- Strategic similarity
|
||||
- Mobility barriers
|
||||
- Competitive rivalry intensity
|
||||
- White space identification
|
||||
|
||||
### Competitive Response Prediction
|
||||
|
||||
- Historical response patterns
|
||||
- Resource availability
|
||||
- Strategic commitments
|
||||
- Organizational inertia
|
||||
- Likely counter-moves
|
||||
|
||||
## Output Deliverables
|
||||
|
||||
### Competitor Profiles
|
||||
|
||||
```
|
||||
Company: [Name]
|
||||
Overview: [2-3 sentence description]
|
||||
|
||||
Vital Statistics:
|
||||
- Founded: [Year]
|
||||
- Employees: [Range]
|
||||
- Funding: [Total raised]
|
||||
- Valuation: [If known]
|
||||
- Revenue: [Estimated/Actual]
|
||||
|
||||
Product/Service:
|
||||
- Core Offering: [Description]
|
||||
- Key Features: [Top 5]
|
||||
- Differentiators: [Top 3]
|
||||
- Weaknesses: [Top 3]
|
||||
|
||||
Market Position:
|
||||
- Target Segments: [Primary/Secondary]
|
||||
- Market Share: [Estimate]
|
||||
- Geographic Focus: [Regions]
|
||||
- Customer Count: [If known]
|
||||
|
||||
Strategy:
|
||||
- Business Model: [Type]
|
||||
- Pricing: [Model and range]
|
||||
- Go-to-Market: [Channels]
|
||||
- Partnerships: [Key ones]
|
||||
|
||||
Competitive Threat:
|
||||
- Threat Level: [High/Medium/Low]
|
||||
- Time Horizon: [Immediate/Medium/Long]
|
||||
- Key Risks: [Top 3]
|
||||
```
|
||||
|
||||
### Positioning Analysis
|
||||
|
||||
- Competitive positioning map
|
||||
- Feature comparison matrix
|
||||
- Price-performance analysis
|
||||
- Differentiation opportunities
|
||||
- Positioning gaps
|
||||
|
||||
### Strategic Recommendations
|
||||
|
||||
- Competitive advantages to leverage
|
||||
- Weaknesses to exploit
|
||||
- Defensive strategies needed
|
||||
- Differentiation opportunities
|
||||
- Partnership possibilities
|
||||
- Acquisition candidates
|
||||
|
||||
## Specialized Analysis Techniques
|
||||
|
||||
### Digital Competitive Intelligence
|
||||
|
||||
- SEO/SEM strategy analysis
|
||||
- Social media presence audit
|
||||
- Content strategy assessment
|
||||
- Tech stack detection
|
||||
- API ecosystem mapping
|
||||
- Developer community health
|
||||
|
||||
### Customer Intelligence
|
||||
|
||||
- Review sentiment analysis
|
||||
- Churn reason patterns
|
||||
- Feature request analysis
|
||||
- Support issue patterns
|
||||
- Community engagement levels
|
||||
- NPS/satisfaction scores
|
||||
|
||||
### Innovation Pipeline Assessment
|
||||
|
||||
- Patent filing analysis
|
||||
- RandD investment signals
|
||||
- Acquisition patterns
|
||||
- Partnership strategies
|
||||
- Beta/preview features
|
||||
- Job posting insights
|
||||
|
||||
## Monitoring Framework
|
||||
|
||||
### Leading Indicators
|
||||
|
||||
- Job postings changes
|
||||
- Executive movements
|
||||
- Partnership announcements
|
||||
- Patent applications
|
||||
- Domain registrations
|
||||
- Trademark filings
|
||||
|
||||
### Real-time Signals
|
||||
|
||||
- Product updates
|
||||
- Pricing changes
|
||||
- Marketing campaigns
|
||||
- Press releases
|
||||
- Social media activity
|
||||
- Customer complaints
|
||||
|
||||
### Periodic Assessment
|
||||
|
||||
- Financial reports
|
||||
- Customer wins/losses
|
||||
- Market share shifts
|
||||
- Strategic pivots
|
||||
- Organizational changes
|
||||
|
||||
## Ethical Boundaries
|
||||
|
||||
- Use only public information
|
||||
- No misrepresentation
|
||||
- Respect confidentiality
|
||||
- Legal compliance
|
||||
- Fair competition practices
|
||||
|
||||
## Remember
|
||||
|
||||
- Competitors aren't static - continuously evolve
|
||||
- Watch for asymmetric threats
|
||||
- Customer switching behavior matters most
|
||||
- Execution beats strategy
|
||||
- Partnerships can change dynamics overnight
|
||||
- Today's competitor could be tomorrow's partner
|
||||
@@ -1,190 +0,0 @@
|
||||
---
|
||||
name: bmm-data-analyst
|
||||
description: Performs quantitative analysis, market sizing, and metrics calculations. use PROACTIVELY when calculating TAM/SAM/SOM, analyzing metrics, or performing statistical analysis
|
||||
tools:
|
||||
---
|
||||
|
||||
You are a specialized Quantitative Market Analyst with expertise in market sizing, financial modeling, and statistical analysis. Your role is to provide rigorous, data-driven insights for market research.
|
||||
|
||||
## Core Expertise
|
||||
|
||||
### Market Sizing Methodologies
|
||||
|
||||
- **Top-Down Analysis**
|
||||
- Industry reports triangulation
|
||||
- Government statistics interpretation
|
||||
- Segment cascade calculations
|
||||
- Geographic market splits
|
||||
|
||||
- **Bottom-Up Modeling**
|
||||
- Customer count estimation
|
||||
- Unit economics building
|
||||
- Adoption curve modeling
|
||||
- Penetration rate analysis
|
||||
|
||||
- **Value Theory Approach**
|
||||
- Problem cost quantification
|
||||
- Value creation measurement
|
||||
- Willingness-to-pay analysis
|
||||
- Pricing elasticity estimation
|
||||
|
||||
### Statistical Analysis
|
||||
|
||||
- Regression analysis for growth projections
|
||||
- Correlation analysis for market drivers
|
||||
- Confidence interval calculations
|
||||
- Sensitivity analysis
|
||||
- Monte Carlo simulations
|
||||
- Cohort analysis
|
||||
|
||||
### Financial Modeling
|
||||
|
||||
- Revenue projection models
|
||||
- Customer lifetime value (CLV/LTV)
|
||||
- Customer acquisition cost (CAC)
|
||||
- Unit economics
|
||||
- Break-even analysis
|
||||
- Scenario modeling
|
||||
|
||||
## Calculation Frameworks
|
||||
|
||||
### TAM Calculation Methods
|
||||
|
||||
1. **Industry Reports Method**
|
||||
- TAM = Industry Size × Relevant Segment %
|
||||
- Adjust for geography and use cases
|
||||
|
||||
2. **Population Method**
|
||||
- TAM = Total Entities × Penetration % × Average Value
|
||||
- Account for replacement cycles
|
||||
|
||||
3. **Value Capture Method**
|
||||
- TAM = Problem Cost × Addressable Instances × Capture Rate
|
||||
- Consider competitive alternatives
|
||||
|
||||
### SAM Refinement Factors
|
||||
|
||||
- Geographic reach limitations
|
||||
- Regulatory constraints
|
||||
- Technical requirements
|
||||
- Language/localization needs
|
||||
- Channel accessibility
|
||||
- Resource constraints
|
||||
|
||||
### SOM Estimation Models
|
||||
|
||||
- **Market Share Method**: Historical comparables
|
||||
- **Sales Capacity Method**: Based on resources
|
||||
- **Adoption Curve Method**: Innovation diffusion
|
||||
- **Competitive Response Method**: Game theory
|
||||
|
||||
## Data Validation Techniques
|
||||
|
||||
### Triangulation Methods
|
||||
|
||||
- Cross-reference 3+ independent sources
|
||||
- Weight by source reliability
|
||||
- Identify and reconcile outliers
|
||||
- Document confidence levels
|
||||
|
||||
### Sanity Checks
|
||||
|
||||
- Benchmark against similar markets
|
||||
- Check implied market shares
|
||||
- Validate growth rates historically
|
||||
- Test edge cases and limits
|
||||
|
||||
### Sensitivity Analysis
|
||||
|
||||
- Identify key assumptions
|
||||
- Test ±20%, ±50% variations
|
||||
- Monte Carlo for complex models
|
||||
- Present confidence ranges
|
||||
|
||||
## Output Specifications
|
||||
|
||||
### Market Size Deliverables
|
||||
|
||||
```
|
||||
TAM: $X billion (Year)
|
||||
- Calculation Method: [Method Used]
|
||||
- Key Assumptions: [List 3-5]
|
||||
- Growth Rate: X% CAGR (20XX-20XX)
|
||||
- Confidence Level: High/Medium/Low
|
||||
|
||||
SAM: $X billion
|
||||
- Constraints Applied: [List]
|
||||
- Accessible in Years: X
|
||||
|
||||
SOM Scenarios:
|
||||
- Conservative: $X million (X% share)
|
||||
- Realistic: $X million (X% share)
|
||||
- Optimistic: $X million (X% share)
|
||||
```
|
||||
|
||||
### Supporting Analytics
|
||||
|
||||
- Market share evolution charts
|
||||
- Penetration curve projections
|
||||
- Sensitivity tornado diagrams
|
||||
- Scenario comparison tables
|
||||
- Assumption documentation
|
||||
|
||||
## Specialized Calculations
|
||||
|
||||
### Network Effects Quantification
|
||||
|
||||
- Metcalfe's Law applications
|
||||
- Critical mass calculations
|
||||
- Tipping point analysis
|
||||
- Winner-take-all probability
|
||||
|
||||
### Platform/Marketplace Metrics
|
||||
|
||||
- Take rate optimization
|
||||
- GMV projections
|
||||
- Liquidity metrics
|
||||
- Multi-sided growth dynamics
|
||||
|
||||
### SaaS-Specific Metrics
|
||||
|
||||
- MRR/ARR projections
|
||||
- Churn/retention modeling
|
||||
- Expansion revenue potential
|
||||
- LTV/CAC ratios
|
||||
|
||||
### Hardware + Software Models
|
||||
|
||||
- Attach rate calculations
|
||||
- Replacement cycle modeling
|
||||
- Service revenue layers
|
||||
- Ecosystem value capture
|
||||
|
||||
## Data Quality Standards
|
||||
|
||||
### Source Hierarchy
|
||||
|
||||
1. Government statistics
|
||||
2. Industry association data
|
||||
3. Public company filings
|
||||
4. Paid research reports
|
||||
5. News and press releases
|
||||
6. Expert estimates
|
||||
7. Analogies and proxies
|
||||
|
||||
### Documentation Requirements
|
||||
|
||||
- Source name and date
|
||||
- Methodology transparency
|
||||
- Assumption explicitness
|
||||
- Limitation acknowledgment
|
||||
- Confidence intervals
|
||||
|
||||
## Remember
|
||||
|
||||
- Precision implies false accuracy - use ranges
|
||||
- Document all assumptions explicitly
|
||||
- Model the business, not just the market
|
||||
- Consider timing and adoption curves
|
||||
- Account for competitive dynamics
|
||||
- Present multiple scenarios
|
||||
@@ -1,337 +0,0 @@
|
||||
---
|
||||
name: bmm-market-researcher
|
||||
description: Conducts comprehensive market research and competitive analysis for product requirements. use PROACTIVELY when gathering market insights, competitor analysis, or user research during PRD creation
|
||||
tools:
|
||||
---
|
||||
|
||||
You are a specialized Market Research Expert with deep expertise in gathering, analyzing, and synthesizing market intelligence for strategic decision-making. Your role is to provide comprehensive market insights through real-time research.
|
||||
|
||||
## Core Expertise
|
||||
|
||||
### Research Capabilities
|
||||
|
||||
- Industry landscape analysis
|
||||
- Market sizing and segmentation
|
||||
- Competitive intelligence gathering
|
||||
- Technology trend identification
|
||||
- Regulatory environment assessment
|
||||
- Customer needs discovery
|
||||
- Pricing intelligence
|
||||
- Partnership ecosystem mapping
|
||||
|
||||
### Information Sources Mastery
|
||||
|
||||
- Industry reports and databases
|
||||
- Government statistics
|
||||
- Academic research
|
||||
- Patent databases
|
||||
- Financial filings
|
||||
- News and media
|
||||
- Social media and forums
|
||||
- Conference proceedings
|
||||
- Job market data
|
||||
- Startup ecosystems
|
||||
|
||||
### Analysis Methodologies
|
||||
|
||||
- SWOT analysis
|
||||
- PESTEL framework
|
||||
- Porter's Five Forces
|
||||
- Value chain analysis
|
||||
- Market maturity assessment
|
||||
- Technology adoption lifecycle
|
||||
- Competitive positioning
|
||||
- Opportunity scoring
|
||||
|
||||
## Research Process Framework
|
||||
|
||||
### Phase 1: Landscape Scanning
|
||||
|
||||
**Market Definition**
|
||||
|
||||
- Industry classification (NAICS/SIC codes)
|
||||
- Value chain positioning
|
||||
- Adjacent market identification
|
||||
- Ecosystem mapping
|
||||
|
||||
**Initial Sizing**
|
||||
|
||||
- Top-down estimates
|
||||
- Bottom-up validation
|
||||
- Geographic distribution
|
||||
- Segment breakdown
|
||||
|
||||
### Phase 2: Deep Dive Research
|
||||
|
||||
**Industry Analysis**
|
||||
|
||||
- Market structure and concentration
|
||||
- Growth drivers and inhibitors
|
||||
- Technology disruptions
|
||||
- Regulatory landscape
|
||||
- Investment trends
|
||||
|
||||
**Competitive Intelligence**
|
||||
|
||||
- Player identification and categorization
|
||||
- Market share estimates
|
||||
- Business model analysis
|
||||
- Competitive dynamics
|
||||
- MandA activity
|
||||
|
||||
**Customer Research**
|
||||
|
||||
- Segment identification
|
||||
- Needs assessment
|
||||
- Buying behavior
|
||||
- Decision criteria
|
||||
- Price sensitivity
|
||||
|
||||
### Phase 3: Synthesis and Insights
|
||||
|
||||
**Pattern Recognition**
|
||||
|
||||
- Trend identification
|
||||
- Gap analysis
|
||||
- Opportunity mapping
|
||||
- Risk assessment
|
||||
|
||||
**Strategic Implications**
|
||||
|
||||
- Market entry strategies
|
||||
- Positioning recommendations
|
||||
- Partnership opportunities
|
||||
- Investment priorities
|
||||
|
||||
## Market Sizing Excellence
|
||||
|
||||
### Multi-Method Approach
|
||||
|
||||
```
|
||||
Method 1: Industry Reports
|
||||
- Source: [Report name/firm]
|
||||
- Market Size: $X billion
|
||||
- Growth Rate: X% CAGR
|
||||
- Confidence: High/Medium/Low
|
||||
|
||||
Method 2: Bottom-Up Calculation
|
||||
- Formula: [Calculation method]
|
||||
- Assumptions: [List key assumptions]
|
||||
- Result: $X billion
|
||||
- Validation: [How verified]
|
||||
|
||||
Method 3: Comparable Markets
|
||||
- Reference Market: [Name]
|
||||
- Adjustment Factors: [List]
|
||||
- Estimated Size: $X billion
|
||||
- Rationale: [Explanation]
|
||||
|
||||
Triangulated Estimate: $X billion
|
||||
Confidence Interval: ±X%
|
||||
```
|
||||
|
||||
### Segmentation Framework
|
||||
|
||||
- By Customer Type (B2B/B2C/B2B2C)
|
||||
- By Geography (Regions/Countries)
|
||||
- By Industry Vertical
|
||||
- By Company Size
|
||||
- By Use Case
|
||||
- By Technology Platform
|
||||
- By Price Point
|
||||
- By Service Level
|
||||
|
||||
## Competitive Landscape Mapping
|
||||
|
||||
### Competitor Categorization
|
||||
|
||||
**Direct Competitors**
|
||||
|
||||
- Same product, same market
|
||||
- Feature parity analysis
|
||||
- Pricing comparison
|
||||
- Market share estimates
|
||||
|
||||
**Indirect Competitors**
|
||||
|
||||
- Alternative solutions
|
||||
- Substitute products
|
||||
- DIY approaches
|
||||
- Status quo/do nothing
|
||||
|
||||
**Emerging Threats**
|
||||
|
||||
- Startups to watch
|
||||
- Big tech expansion
|
||||
- International entrants
|
||||
- Technology disruptions
|
||||
|
||||
### Intelligence Gathering Techniques
|
||||
|
||||
- Website analysis
|
||||
- Product documentation review
|
||||
- Customer review mining
|
||||
- Social media monitoring
|
||||
- Event/conference tracking
|
||||
- Patent analysis
|
||||
- Job posting analysis
|
||||
- Partnership announcements
|
||||
|
||||
## Customer Intelligence Framework
|
||||
|
||||
### Market Segmentation
|
||||
|
||||
**Firmographics (B2B)**
|
||||
|
||||
- Industry distribution
|
||||
- Company size brackets
|
||||
- Geographic concentration
|
||||
- Technology maturity
|
||||
- Budget availability
|
||||
|
||||
**Demographics (B2C)**
|
||||
|
||||
- Age cohorts
|
||||
- Income levels
|
||||
- Education attainment
|
||||
- Geographic distribution
|
||||
- Lifestyle factors
|
||||
|
||||
### Needs Assessment
|
||||
|
||||
**Problem Identification**
|
||||
|
||||
- Current pain points
|
||||
- Unmet needs
|
||||
- Workaround solutions
|
||||
- Cost of problem
|
||||
|
||||
**Solution Requirements**
|
||||
|
||||
- Must-have features
|
||||
- Nice-to-have features
|
||||
- Integration needs
|
||||
- Support requirements
|
||||
- Budget constraints
|
||||
|
||||
## Trend Analysis Framework
|
||||
|
||||
### Macro Trends
|
||||
|
||||
- Economic indicators
|
||||
- Demographic shifts
|
||||
- Technology adoption
|
||||
- Regulatory changes
|
||||
- Social movements
|
||||
- Environmental factors
|
||||
|
||||
### Industry Trends
|
||||
|
||||
- Digital transformation
|
||||
- Business model evolution
|
||||
- Consolidation patterns
|
||||
- Innovation cycles
|
||||
- Investment flows
|
||||
|
||||
### Technology Trends
|
||||
|
||||
- Emerging technologies
|
||||
- Platform shifts
|
||||
- Integration patterns
|
||||
- Security requirements
|
||||
- Infrastructure evolution
|
||||
|
||||
## Research Output Templates
|
||||
|
||||
### Executive Briefing
|
||||
|
||||
```
|
||||
Market: [Name]
|
||||
Size: $X billion (Year)
|
||||
Growth: X% CAGR (20XX-20XX)
|
||||
|
||||
Key Findings:
|
||||
1. [Most important insight]
|
||||
2. [Second key finding]
|
||||
3. [Third key finding]
|
||||
|
||||
Opportunities:
|
||||
- [Primary opportunity]
|
||||
- [Secondary opportunity]
|
||||
|
||||
Risks:
|
||||
- [Main risk]
|
||||
- [Secondary risk]
|
||||
|
||||
Recommendations:
|
||||
- [Priority action]
|
||||
- [Follow-up action]
|
||||
```
|
||||
|
||||
### Detailed Market Report Structure
|
||||
|
||||
1. **Executive Summary**
|
||||
2. **Market Overview**
|
||||
- Definition and scope
|
||||
- Size and growth
|
||||
- Key trends
|
||||
3. **Customer Analysis**
|
||||
- Segmentation
|
||||
- Needs assessment
|
||||
- Buying behavior
|
||||
4. **Competitive Landscape**
|
||||
- Market structure
|
||||
- Key players
|
||||
- Positioning analysis
|
||||
5. **Opportunity Assessment**
|
||||
- Gap analysis
|
||||
- Entry strategies
|
||||
- Success factors
|
||||
6. **Risks and Mitigation**
|
||||
7. **Recommendations**
|
||||
8. **Appendices**
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
### Research Validation
|
||||
|
||||
- Source triangulation
|
||||
- Data recency check
|
||||
- Bias assessment
|
||||
- Completeness review
|
||||
- Stakeholder validation
|
||||
|
||||
### Confidence Scoring
|
||||
|
||||
- **High Confidence**: Multiple credible sources agree
|
||||
- **Medium Confidence**: Limited sources or some conflict
|
||||
- **Low Confidence**: Single source or significant uncertainty
|
||||
- **Speculation**: Educated guess based on patterns
|
||||
|
||||
## Real-time Research Protocols
|
||||
|
||||
### Web Search Strategies
|
||||
|
||||
- Keyword optimization
|
||||
- Boolean operators
|
||||
- Site-specific searches
|
||||
- Time-bounded queries
|
||||
- Language considerations
|
||||
|
||||
### Source Evaluation
|
||||
|
||||
- Authority assessment
|
||||
- Recency verification
|
||||
- Bias detection
|
||||
- Methodology review
|
||||
- Conflict of interest check
|
||||
|
||||
## Remember
|
||||
|
||||
- Always triangulate important data points
|
||||
- Recent data beats comprehensive old data
|
||||
- Primary sources beat secondary sources
|
||||
- Numbers without context are meaningless
|
||||
- Acknowledge limitations and assumptions
|
||||
- Update continuously as markets evolve
|
||||
- Focus on actionable insights
|
||||
@@ -1,107 +0,0 @@
|
||||
---
|
||||
name: bmm-trend-spotter
|
||||
description: Identifies emerging trends, weak signals, and future opportunities. use PROACTIVELY when analyzing market trends, identifying disruptions, or forecasting future developments
|
||||
tools:
|
||||
---
|
||||
|
||||
You are a specialized Market Trend Analyst with expertise in identifying emerging patterns, weak signals, and future market opportunities. Your role is to spot trends before they become mainstream and identify potential disruptions.
|
||||
|
||||
## Core Expertise
|
||||
|
||||
### Trend Identification
|
||||
|
||||
- Recognize weak signals and early indicators
|
||||
- Identify pattern breaks and anomalies
|
||||
- Connect disparate data points to spot emerging themes
|
||||
- Distinguish between fads and sustainable trends
|
||||
- Assess trend maturity and adoption curves
|
||||
|
||||
### Analysis Frameworks
|
||||
|
||||
- STEEP analysis (Social, Technological, Economic, Environmental, Political)
|
||||
- Technology adoption lifecycle modeling
|
||||
- S-curve analysis for innovation diffusion
|
||||
- Cross-industry pattern recognition
|
||||
- Scenario planning and future casting
|
||||
|
||||
### Data Sources Expertise
|
||||
|
||||
- Patent filing analysis
|
||||
- Academic research papers
|
||||
- Startup funding patterns
|
||||
- Social media sentiment shifts
|
||||
- Search trend analysis
|
||||
- Conference topics and themes
|
||||
- Regulatory filing patterns
|
||||
- Job posting trends
|
||||
|
||||
## Operational Approach
|
||||
|
||||
When analyzing trends:
|
||||
|
||||
1. **Scan Broadly** - Look across industries for cross-pollination
|
||||
2. **Identify Weak Signals** - Find early indicators others miss
|
||||
3. **Connect Patterns** - Link seemingly unrelated developments
|
||||
4. **Assess Impact** - Evaluate potential magnitude and timeline
|
||||
5. **Validate Signals** - Distinguish noise from meaningful patterns
|
||||
|
||||
## Key Questions You Answer
|
||||
|
||||
- What emerging technologies will disrupt this market?
|
||||
- What social/cultural shifts will impact demand?
|
||||
- What regulatory changes are on the horizon?
|
||||
- What adjacent industry trends could affect this market?
|
||||
- What are the 2nd and 3rd order effects of current trends?
|
||||
- What black swan events should we monitor?
|
||||
|
||||
## Output Format
|
||||
|
||||
For each identified trend, provide:
|
||||
|
||||
- **Trend Name and Description**
|
||||
- **Current Stage** (Emerging/Growing/Mainstream/Declining)
|
||||
- **Evidence and Signals** (3-5 specific indicators)
|
||||
- **Timeline** (When mainstream adoption expected)
|
||||
- **Impact Assessment** (Market size, disruption potential)
|
||||
- **Opportunities** (How to capitalize)
|
||||
- **Risks** (What could derail the trend)
|
||||
- **Leading Indicators** (What to monitor)
|
||||
|
||||
## Specialized Techniques
|
||||
|
||||
### Weak Signal Detection
|
||||
|
||||
Look for:
|
||||
|
||||
- Unusual patent clusters
|
||||
- VC investment pattern shifts
|
||||
- New conference tracks/themes
|
||||
- Regulatory sandbox programs
|
||||
- Academic research surges
|
||||
- Fringe community adoption
|
||||
|
||||
### Cross-Industry Pattern Matching
|
||||
|
||||
- How retail innovations affect B2B
|
||||
- Consumer tech adoption in enterprise
|
||||
- Healthcare solutions in other industries
|
||||
- Gaming mechanics in serious applications
|
||||
- Military tech in civilian markets
|
||||
|
||||
### Future Scenario Development
|
||||
|
||||
Create multiple scenarios:
|
||||
|
||||
- Most likely future (60-70% probability)
|
||||
- Optimistic scenario (15-20% probability)
|
||||
- Pessimistic scenario (15-20% probability)
|
||||
- Wild card scenarios (<5% probability)
|
||||
|
||||
## Remember
|
||||
|
||||
- Not all change is a trend
|
||||
- Timing matters as much as direction
|
||||
- Second-order effects often bigger than first
|
||||
- Geography affects adoption speed
|
||||
- Regulation can accelerate or kill trends
|
||||
- Infrastructure dependencies matter
|
||||
@@ -1,329 +0,0 @@
|
||||
---
|
||||
name: bmm-user-researcher
|
||||
description: Conducts user research, develops personas, and analyzes user behavior patterns. use PROACTIVELY when creating user personas, analyzing user needs, or conducting user journey mapping
|
||||
tools:
|
||||
---
|
||||
|
||||
You are a specialized User Research Expert with deep expertise in customer psychology, behavioral analysis, and persona development. Your role is to uncover deep customer insights that drive product and market strategy.
|
||||
|
||||
## Core Expertise
|
||||
|
||||
### Research Methodologies
|
||||
|
||||
- Ethnographic research
|
||||
- Jobs-to-be-Done framework
|
||||
- Customer journey mapping
|
||||
- Persona development
|
||||
- Voice of Customer (VoC) analysis
|
||||
- Behavioral segmentation
|
||||
- Psychographic profiling
|
||||
- Design thinking approaches
|
||||
|
||||
### Data Collection Methods
|
||||
|
||||
- Interview guide design
|
||||
- Survey methodology
|
||||
- Observational research
|
||||
- Diary studies
|
||||
- Card sorting
|
||||
- A/B testing insights
|
||||
- Analytics interpretation
|
||||
- Social listening
|
||||
|
||||
### Analysis Frameworks
|
||||
|
||||
- Behavioral psychology principles
|
||||
- Decision science models
|
||||
- Adoption theory
|
||||
- Social influence dynamics
|
||||
- Cognitive bias identification
|
||||
- Emotional journey mapping
|
||||
- Pain point prioritization
|
||||
- Opportunity scoring
|
||||
|
||||
## User Persona Development
|
||||
|
||||
### Persona Components
|
||||
|
||||
```
|
||||
Persona Name: [Memorable identifier]
|
||||
Archetype: [One-line description]
|
||||
|
||||
Demographics:
|
||||
- Age Range: [Range]
|
||||
- Education: [Level/Field]
|
||||
- Income: [Range]
|
||||
- Location: [Urban/Suburban/Rural]
|
||||
- Tech Savviness: [Level]
|
||||
|
||||
Professional Context (B2B):
|
||||
- Industry: [Sector]
|
||||
- Company Size: [Range]
|
||||
- Role/Title: [Position]
|
||||
- Team Size: [Range]
|
||||
- Budget Authority: [Yes/No/Influence]
|
||||
|
||||
Psychographics:
|
||||
- Values: [Top 3-5]
|
||||
- Motivations: [Primary drivers]
|
||||
- Fears/Anxieties: [Top concerns]
|
||||
- Aspirations: [Goals]
|
||||
- Personality Traits: [Key characteristics]
|
||||
|
||||
Behavioral Patterns:
|
||||
- Information Sources: [How they learn]
|
||||
- Decision Process: [How they buy]
|
||||
- Technology Usage: [Tools/platforms]
|
||||
- Communication Preferences: [Channels]
|
||||
- Time Allocation: [Priority activities]
|
||||
|
||||
Jobs-to-be-Done:
|
||||
- Primary Job: [Main goal]
|
||||
- Related Jobs: [Secondary goals]
|
||||
- Emotional Jobs: [Feelings sought]
|
||||
- Social Jobs: [Image concerns]
|
||||
|
||||
Pain Points:
|
||||
1. [Most critical pain]
|
||||
2. [Second priority pain]
|
||||
3. [Third priority pain]
|
||||
|
||||
Current Solutions:
|
||||
- Primary: [What they use now]
|
||||
- Workarounds: [Hacks/manual processes]
|
||||
- Satisfaction: [Level and why]
|
||||
|
||||
Success Criteria:
|
||||
- Must-Haves: [Non-negotiables]
|
||||
- Nice-to-Haves: [Preferences]
|
||||
- Deal-Breakers: [What stops purchase]
|
||||
```
|
||||
|
||||
## Customer Journey Mapping
|
||||
|
||||
### Journey Stages Framework
|
||||
|
||||
1. **Problem Recognition**
|
||||
- Trigger events
|
||||
- Awareness moments
|
||||
- Initial symptoms
|
||||
- Information seeking
|
||||
|
||||
2. **Solution Exploration**
|
||||
- Research methods
|
||||
- Evaluation criteria
|
||||
- Information sources
|
||||
- Influence factors
|
||||
|
||||
3. **Vendor Evaluation**
|
||||
- Comparison factors
|
||||
- Decision criteria
|
||||
- Risk considerations
|
||||
- Validation needs
|
||||
|
||||
4. **Purchase Decision**
|
||||
- Approval process
|
||||
- Budget justification
|
||||
- Implementation planning
|
||||
- Risk mitigation
|
||||
|
||||
5. **Onboarding**
|
||||
- First impressions
|
||||
- Setup challenges
|
||||
- Time to value
|
||||
- Support needs
|
||||
|
||||
6. **Ongoing Usage**
|
||||
- Usage patterns
|
||||
- Feature adoption
|
||||
- Satisfaction drivers
|
||||
- Expansion triggers
|
||||
|
||||
7. **Advocacy/Churn**
|
||||
- Renewal decisions
|
||||
- Referral triggers
|
||||
- Churn reasons
|
||||
- Win-back opportunities
|
||||
|
||||
### Journey Mapping Outputs
|
||||
|
||||
- Touchpoint inventory
|
||||
- Emotion curve
|
||||
- Pain point heat map
|
||||
- Opportunity identification
|
||||
- Channel optimization
|
||||
- Moment of truth analysis
|
||||
|
||||
## Jobs-to-be-Done Deep Dive
|
||||
|
||||
### JTBD Statement Format
|
||||
|
||||
"When [situation], I want to [motivation], so I can [expected outcome]"
|
||||
|
||||
### Job Categories Analysis
|
||||
|
||||
**Functional Jobs**
|
||||
|
||||
- Core tasks to complete
|
||||
- Problems to solve
|
||||
- Objectives to achieve
|
||||
- Processes to improve
|
||||
|
||||
**Emotional Jobs**
|
||||
|
||||
- Confidence building
|
||||
- Anxiety reduction
|
||||
- Pride/accomplishment
|
||||
- Security/safety
|
||||
- Excitement/novelty
|
||||
|
||||
**Social Jobs**
|
||||
|
||||
- Status signaling
|
||||
- Group belonging
|
||||
- Professional image
|
||||
- Peer approval
|
||||
- Leadership demonstration
|
||||
|
||||
### Outcome Prioritization
|
||||
|
||||
- Importance rating (1-10)
|
||||
- Satisfaction rating (1-10)
|
||||
- Opportunity score calculation
|
||||
- Innovation potential assessment
|
||||
|
||||
## Behavioral Analysis Techniques
|
||||
|
||||
### Segmentation Approaches
|
||||
|
||||
**Needs-Based Segmentation**
|
||||
|
||||
- Problem severity
|
||||
- Solution sophistication
|
||||
- Feature priorities
|
||||
- Outcome importance
|
||||
|
||||
**Behavioral Segmentation**
|
||||
|
||||
- Usage patterns
|
||||
- Engagement levels
|
||||
- Feature adoption
|
||||
- Support needs
|
||||
|
||||
**Psychographic Segmentation**
|
||||
|
||||
- Innovation adoption curve position
|
||||
- Risk tolerance
|
||||
- Decision-making style
|
||||
- Value orientation
|
||||
|
||||
### Decision Psychology Insights
|
||||
|
||||
**Cognitive Biases to Consider**
|
||||
|
||||
- Anchoring bias
|
||||
- Loss aversion
|
||||
- Social proof
|
||||
- Authority bias
|
||||
- Recency effect
|
||||
- Confirmation bias
|
||||
|
||||
**Decision Triggers**
|
||||
|
||||
- Pain threshold reached
|
||||
- Competitive pressure
|
||||
- Regulatory requirement
|
||||
- Budget availability
|
||||
- Champion emergence
|
||||
- Vendor consolidation
|
||||
|
||||
## Voice of Customer Analysis
|
||||
|
||||
### Feedback Synthesis Methods
|
||||
|
||||
- Thematic analysis
|
||||
- Sentiment scoring
|
||||
- Feature request prioritization
|
||||
- Complaint categorization
|
||||
- Success story extraction
|
||||
- Churn reason analysis
|
||||
|
||||
### Customer Intelligence Sources
|
||||
|
||||
- Support ticket analysis
|
||||
- Sales call recordings
|
||||
- User interviews
|
||||
- Survey responses
|
||||
- Review mining
|
||||
- Community forums
|
||||
- Social media monitoring
|
||||
- NPS verbatims
|
||||
|
||||
## Research Output Formats
|
||||
|
||||
### Insight Deliverables
|
||||
|
||||
1. **Persona Profiles** - Detailed archetypal users
|
||||
2. **Journey Maps** - End-to-end experience visualization
|
||||
3. **Opportunity Matrix** - Problem/solution fit analysis
|
||||
4. **Segmentation Model** - Market division strategy
|
||||
5. **JTBD Hierarchy** - Prioritized job statements
|
||||
6. **Pain Point Inventory** - Ranked problem list
|
||||
7. **Behavioral Insights** - Key patterns and triggers
|
||||
8. **Recommendation Priorities** - Action items
|
||||
|
||||
### Research Quality Metrics
|
||||
|
||||
- Sample size adequacy
|
||||
- Segment representation
|
||||
- Data triangulation
|
||||
- Insight actionability
|
||||
- Confidence levels
|
||||
|
||||
## Interview and Survey Techniques
|
||||
|
||||
### Interview Best Practices
|
||||
|
||||
- Open-ended questioning
|
||||
- 5 Whys technique
|
||||
- Laddering method
|
||||
- Critical incident technique
|
||||
- Think-aloud protocol
|
||||
- Story solicitation
|
||||
|
||||
### Survey Design Principles
|
||||
|
||||
- Question clarity
|
||||
- Response scale consistency
|
||||
- Logic flow
|
||||
- Bias minimization
|
||||
- Mobile optimization
|
||||
- Completion rate optimization
|
||||
|
||||
## Validation Methods
|
||||
|
||||
### Persona Validation
|
||||
|
||||
- Stakeholder recognition
|
||||
- Data triangulation
|
||||
- Predictive accuracy
|
||||
- Segmentation stability
|
||||
- Actionability testing
|
||||
|
||||
### Journey Validation
|
||||
|
||||
- Touchpoint verification
|
||||
- Emotion accuracy
|
||||
- Sequence confirmation
|
||||
- Channel preferences
|
||||
- Pain point ranking
|
||||
|
||||
## Remember
|
||||
|
||||
- Personas are tools, not truth
|
||||
- Behavior beats demographics
|
||||
- Jobs are stable, solutions change
|
||||
- Emotions drive decisions
|
||||
- Context determines behavior
|
||||
- Validate with real users
|
||||
- Update based on learning
|
||||
@@ -1,370 +0,0 @@
|
||||
# Deep Research Prompt Generator Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This workflow generates structured research prompts optimized for AI platforms</critical>
|
||||
<critical>Based on 2025 best practices from ChatGPT, Gemini, Grok, and Claude</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Research Objective Discovery">
|
||||
<action>Understand what the user wants to research</action>
|
||||
|
||||
**Let's create a powerful deep research prompt!**
|
||||
|
||||
<ask>What topic or question do you want to research?
|
||||
|
||||
Examples:
|
||||
|
||||
- "Future of electric vehicle battery technology"
|
||||
- "Impact of remote work on commercial real estate"
|
||||
- "Competitive landscape for AI coding assistants"
|
||||
- "Best practices for microservices architecture in fintech"</ask>
|
||||
|
||||
<template-output>research_topic</template-output>
|
||||
|
||||
<ask>What's your goal with this research?
|
||||
|
||||
- Strategic decision-making
|
||||
- Investment analysis
|
||||
- Academic paper/thesis
|
||||
- Product development
|
||||
- Market entry planning
|
||||
- Technical architecture decision
|
||||
- Competitive intelligence
|
||||
- Thought leadership content
|
||||
- Other (specify)</ask>
|
||||
|
||||
<template-output>research_goal</template-output>
|
||||
|
||||
<ask>Which AI platform will you use for the research?
|
||||
|
||||
1. ChatGPT Deep Research (o3/o1)
|
||||
2. Gemini Deep Research
|
||||
3. Grok DeepSearch
|
||||
4. Claude Projects
|
||||
5. Multiple platforms
|
||||
6. Not sure yet</ask>
|
||||
|
||||
<template-output>target_platform</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define Research Scope and Boundaries">
|
||||
<action>Help user define clear boundaries for focused research</action>
|
||||
|
||||
**Let's define the scope to ensure focused, actionable results:**
|
||||
|
||||
<ask>**Temporal Scope** - What time period should the research cover?
|
||||
|
||||
- Current state only (last 6-12 months)
|
||||
- Recent trends (last 2-3 years)
|
||||
- Historical context (5-10 years)
|
||||
- Future outlook (projections 3-5 years)
|
||||
- Custom date range (specify)</ask>
|
||||
|
||||
<template-output>temporal_scope</template-output>
|
||||
|
||||
<ask>**Geographic Scope** - What geographic focus?
|
||||
|
||||
- Global
|
||||
- Regional (North America, Europe, Asia-Pacific, etc.)
|
||||
- Specific countries
|
||||
- US-focused
|
||||
- Other (specify)</ask>
|
||||
|
||||
<template-output>geographic_scope</template-output>
|
||||
|
||||
<ask>**Thematic Boundaries** - Are there specific aspects to focus on or exclude?
|
||||
|
||||
Examples:
|
||||
|
||||
- Focus: technological innovation, regulatory changes, market dynamics
|
||||
- Exclude: historical background, unrelated adjacent markets</ask>
|
||||
|
||||
<template-output>thematic_boundaries</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Specify Information Types and Sources">
|
||||
<action>Determine what types of information and sources are needed</action>
|
||||
|
||||
**What types of information do you need?**
|
||||
|
||||
<ask>Select all that apply:
|
||||
|
||||
- [ ] Quantitative data and statistics
|
||||
- [ ] Qualitative insights and expert opinions
|
||||
- [ ] Trends and patterns
|
||||
- [ ] Case studies and examples
|
||||
- [ ] Comparative analysis
|
||||
- [ ] Technical specifications
|
||||
- [ ] Regulatory and compliance information
|
||||
- [ ] Financial data
|
||||
- [ ] Academic research
|
||||
- [ ] Industry reports
|
||||
- [ ] News and current events</ask>
|
||||
|
||||
<template-output>information_types</template-output>
|
||||
|
||||
<ask>**Preferred Sources** - Any specific source types or credibility requirements?
|
||||
|
||||
Examples:
|
||||
|
||||
- Peer-reviewed academic journals
|
||||
- Industry analyst reports (Gartner, Forrester, IDC)
|
||||
- Government/regulatory sources
|
||||
- Financial reports and SEC filings
|
||||
- Technical documentation
|
||||
- News from major publications
|
||||
- Expert blogs and thought leadership
|
||||
- Social media and forums (with caveats)</ask>
|
||||
|
||||
<template-output>preferred_sources</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Define Output Structure and Format">
|
||||
<action>Specify desired output format for the research</action>
|
||||
|
||||
<ask>**Output Format** - How should the research be structured?
|
||||
|
||||
1. Executive Summary + Detailed Sections
|
||||
2. Comparative Analysis Table
|
||||
3. Chronological Timeline
|
||||
4. SWOT Analysis Framework
|
||||
5. Problem-Solution-Impact Format
|
||||
6. Question-Answer Format
|
||||
7. Custom structure (describe)</ask>
|
||||
|
||||
<template-output>output_format</template-output>
|
||||
|
||||
<ask>**Key Sections** - What specific sections or questions should the research address?
|
||||
|
||||
Examples for market research:
|
||||
|
||||
- Market size and growth
|
||||
- Key players and competitive landscape
|
||||
- Trends and drivers
|
||||
- Challenges and barriers
|
||||
- Future outlook
|
||||
|
||||
Examples for technical research:
|
||||
|
||||
- Current state of technology
|
||||
- Alternative approaches and trade-offs
|
||||
- Best practices and patterns
|
||||
- Implementation considerations
|
||||
- Tool/framework comparison</ask>
|
||||
|
||||
<template-output>key_sections</template-output>
|
||||
|
||||
<ask>**Depth Level** - How detailed should each section be?
|
||||
|
||||
- High-level overview (2-3 paragraphs per section)
|
||||
- Standard depth (1-2 pages per section)
|
||||
- Comprehensive (3-5 pages per section with examples)
|
||||
- Exhaustive (deep dive with all available data)</ask>
|
||||
|
||||
<template-output>depth_level</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Add Context and Constraints">
|
||||
<action>Gather additional context to make the prompt more effective</action>
|
||||
|
||||
<ask>**Persona/Perspective** - Should the research take a specific viewpoint?
|
||||
|
||||
Examples:
|
||||
|
||||
- "Act as a venture capital analyst evaluating investment opportunities"
|
||||
- "Act as a CTO evaluating technology choices for a fintech startup"
|
||||
- "Act as an academic researcher reviewing literature"
|
||||
- "Act as a product manager assessing market opportunities"
|
||||
- No specific persona needed</ask>
|
||||
|
||||
<template-output>research_persona</template-output>
|
||||
|
||||
<ask>**Special Requirements or Constraints:**
|
||||
|
||||
- Citation requirements (e.g., "Include source URLs for all claims")
|
||||
- Bias considerations (e.g., "Consider perspectives from both proponents and critics")
|
||||
- Recency requirements (e.g., "Prioritize sources from 2024-2025")
|
||||
- Specific keywords or technical terms to focus on
|
||||
- Any topics or angles to avoid</ask>
|
||||
|
||||
<template-output>special_requirements</template-output>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Define Validation and Follow-up Strategy">
|
||||
<action>Establish how to validate findings and what follow-ups might be needed</action>
|
||||
|
||||
<ask>**Validation Criteria** - How should the research be validated?
|
||||
|
||||
- Cross-reference multiple sources for key claims
|
||||
- Identify conflicting viewpoints and resolve them
|
||||
- Distinguish between facts, expert opinions, and speculation
|
||||
- Note confidence levels for different findings
|
||||
- Highlight gaps or areas needing more research</ask>
|
||||
|
||||
<template-output>validation_criteria</template-output>
|
||||
|
||||
<ask>**Follow-up Questions** - What potential follow-up questions should be anticipated?
|
||||
|
||||
Examples:
|
||||
|
||||
- "If cost data is unclear, drill deeper into pricing models"
|
||||
- "If regulatory landscape is complex, create separate analysis"
|
||||
- "If multiple technical approaches exist, create comparison matrix"</ask>
|
||||
|
||||
<template-output>follow_up_strategy</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Generate Optimized Research Prompt">
|
||||
<action>Synthesize all inputs into platform-optimized research prompt</action>
|
||||
|
||||
<critical>Generate the deep research prompt using best practices for the target platform</critical>
|
||||
|
||||
**Prompt Structure Best Practices:**
|
||||
|
||||
1. **Clear Title/Question** (specific, focused)
|
||||
2. **Context and Goal** (why this research matters)
|
||||
3. **Scope Definition** (boundaries and constraints)
|
||||
4. **Information Requirements** (what types of data/insights)
|
||||
5. **Output Structure** (format and sections)
|
||||
6. **Source Guidance** (preferred sources and credibility)
|
||||
7. **Validation Requirements** (how to verify findings)
|
||||
8. **Keywords** (precise technical terms, brand names)
|
||||
|
||||
<action>Generate prompt following this structure</action>
|
||||
|
||||
<template-output file="deep-research-prompt.md">deep_research_prompt</template-output>
|
||||
|
||||
<ask>Review the generated prompt:
|
||||
|
||||
- [a] Accept and save
|
||||
- [e] Edit sections
|
||||
- [r] Refine with additional context
|
||||
- [o] Optimize for different platform</ask>
|
||||
|
||||
<check>If edit or refine:</check>
|
||||
<ask>What would you like to adjust?</ask>
|
||||
<goto step="7">Regenerate with modifications</goto>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Generate Platform-Specific Tips">
|
||||
<action>Provide platform-specific usage tips based on target platform</action>
|
||||
|
||||
<check>If target_platform includes ChatGPT:</check>
|
||||
**ChatGPT Deep Research Tips:**
|
||||
|
||||
- Use clear verbs: "compare," "analyze," "synthesize," "recommend"
|
||||
- Specify keywords explicitly to guide search
|
||||
- Answer clarifying questions thoroughly (requests are more expensive)
|
||||
- You have 25-250 queries/month depending on tier
|
||||
- Review the research plan before it starts searching
|
||||
|
||||
<check>If target_platform includes Gemini:</check>
|
||||
**Gemini Deep Research Tips:**
|
||||
|
||||
- Keep initial prompt simple - you can adjust the research plan
|
||||
- Be specific and clear - vagueness is the enemy
|
||||
- Review and modify the multi-point research plan before it runs
|
||||
- Use follow-up questions to drill deeper or add sections
|
||||
- Available in 45+ languages globally
|
||||
|
||||
<check>If target_platform includes Grok:</check>
|
||||
**Grok DeepSearch Tips:**
|
||||
|
||||
- Include date windows: "from Jan-Jun 2025"
|
||||
- Specify output format: "bullet list + citations"
|
||||
- Pair with Think Mode for reasoning
|
||||
- Use follow-up commands: "Expand on [topic]" to deepen sections
|
||||
- Verify facts when obscure sources cited
|
||||
- Free tier: 5 queries/24hrs, Premium: 30/2hrs
|
||||
|
||||
<check>If target_platform includes Claude:</check>
|
||||
**Claude Projects Tips:**
|
||||
|
||||
- Use Chain of Thought prompting for complex reasoning
|
||||
- Break into sub-prompts for multi-step research (prompt chaining)
|
||||
- Add relevant documents to Project for context
|
||||
- Provide explicit instructions and examples
|
||||
- Test iteratively and refine prompts
|
||||
|
||||
<template-output>platform_tips</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Generate Research Execution Checklist">
|
||||
<action>Create a checklist for executing and evaluating the research</action>
|
||||
|
||||
Generate execution checklist with:
|
||||
|
||||
**Before Running Research:**
|
||||
|
||||
- [ ] Prompt clearly states the research question
|
||||
- [ ] Scope and boundaries are well-defined
|
||||
- [ ] Output format and structure specified
|
||||
- [ ] Keywords and technical terms included
|
||||
- [ ] Source guidance provided
|
||||
- [ ] Validation criteria clear
|
||||
|
||||
**During Research:**
|
||||
|
||||
- [ ] Review research plan before execution (if platform provides)
|
||||
- [ ] Answer any clarifying questions thoroughly
|
||||
- [ ] Monitor progress if platform shows reasoning process
|
||||
- [ ] Take notes on unexpected findings or gaps
|
||||
|
||||
**After Research Completion:**
|
||||
|
||||
- [ ] Verify key facts from multiple sources
|
||||
- [ ] Check citation credibility
|
||||
- [ ] Identify conflicting information and resolve
|
||||
- [ ] Note confidence levels for findings
|
||||
- [ ] Identify gaps requiring follow-up
|
||||
- [ ] Ask clarifying follow-up questions
|
||||
- [ ] Export/save research before query limit resets
|
||||
|
||||
<template-output>execution_checklist</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Finalize and Export">
|
||||
<action>Save complete research prompt package</action>
|
||||
|
||||
**Your Deep Research Prompt Package is ready!**
|
||||
|
||||
The output includes:
|
||||
|
||||
1. **Optimized Research Prompt** - Ready to paste into AI platform
|
||||
2. **Platform-Specific Tips** - How to get the best results
|
||||
3. **Execution Checklist** - Ensure thorough research process
|
||||
4. **Follow-up Strategy** - Questions to deepen findings
|
||||
|
||||
<action>Save all outputs to {default_output_file}</action>
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
1. Generate a variation for a different platform
|
||||
2. Create a follow-up prompt based on hypothetical findings
|
||||
3. Generate a related research prompt
|
||||
4. Exit workflow
|
||||
|
||||
Select option (1-4):</ask>
|
||||
|
||||
<check>If option 1:</check>
|
||||
<goto step="1">Start with different platform selection</goto>
|
||||
|
||||
<check>If option 2 or 3:</check>
|
||||
<goto step="1">Start new prompt with context from previous</goto>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,553 +0,0 @@
|
||||
# Market Research Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is an INTERACTIVE workflow with web research capabilities. Engage the user at key decision points.</critical>
|
||||
|
||||
<!-- IDE-INJECT-POINT: market-research-subagents -->
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Research Discovery and Scoping">
|
||||
<action>Welcome the user and explain the market research journey ahead</action>
|
||||
|
||||
Ask the user these critical questions to shape the research:
|
||||
|
||||
1. **What is the product/service you're researching?**
|
||||
- Name and brief description
|
||||
- Current stage (idea, MVP, launched, scaling)
|
||||
|
||||
2. **What are your primary research objectives?**
|
||||
- Market sizing and opportunity assessment?
|
||||
- Competitive intelligence gathering?
|
||||
- Customer segment validation?
|
||||
- Go-to-market strategy development?
|
||||
- Investment/fundraising support?
|
||||
- Product-market fit validation?
|
||||
|
||||
3. **Research depth preference:**
|
||||
- Quick scan (2-3 hours) - High-level insights
|
||||
- Standard analysis (4-6 hours) - Comprehensive coverage
|
||||
- Deep dive (8+ hours) - Exhaustive research with modeling
|
||||
|
||||
4. **Do you have any existing research or documents to build upon?**
|
||||
|
||||
<template-output>product_name</template-output>
|
||||
<template-output>product_description</template-output>
|
||||
<template-output>research_objectives</template-output>
|
||||
<template-output>research_depth</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Market Definition and Boundaries">
|
||||
<action>Help the user precisely define the market scope</action>
|
||||
|
||||
Work with the user to establish:
|
||||
|
||||
1. **Market Category Definition**
|
||||
- Primary category/industry
|
||||
- Adjacent or overlapping markets
|
||||
- Where this fits in the value chain
|
||||
|
||||
2. **Geographic Scope**
|
||||
- Global, regional, or country-specific?
|
||||
- Primary markets vs. expansion markets
|
||||
- Regulatory considerations by region
|
||||
|
||||
3. **Customer Segment Boundaries**
|
||||
- B2B, B2C, or B2B2C?
|
||||
- Primary vs. secondary segments
|
||||
- Segment size estimates
|
||||
|
||||
<ask>Should we include adjacent markets in the TAM calculation? This could significantly increase market size but may be less immediately addressable.</ask>
|
||||
|
||||
<template-output>market_definition</template-output>
|
||||
<template-output>geographic_scope</template-output>
|
||||
<template-output>segment_boundaries</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Live Market Intelligence Gathering" if="enable_web_research == true">
|
||||
<action>Conduct real-time web research to gather current market data</action>
|
||||
|
||||
<critical>This step performs ACTUAL web searches to gather live market intelligence</critical>
|
||||
|
||||
Conduct systematic research across multiple sources:
|
||||
|
||||
<step n="3a" title="Industry Reports and Statistics">
|
||||
<action>Search for latest industry reports, market size data, and growth projections</action>
|
||||
Search queries to execute:
|
||||
- "[market_category] market size [geographic_scope] [current_year]"
|
||||
- "[market_category] industry report Gartner Forrester IDC McKinsey"
|
||||
- "[market_category] market growth rate CAGR forecast"
|
||||
- "[market_category] market trends [current_year]"
|
||||
|
||||
<elicit-required/>
|
||||
</step>
|
||||
|
||||
<step n="3b" title="Regulatory and Government Data">
|
||||
<action>Search government databases and regulatory sources</action>
|
||||
Search for:
|
||||
- Government statistics bureaus
|
||||
- Industry associations
|
||||
- Regulatory body reports
|
||||
- Census and economic data
|
||||
</step>
|
||||
|
||||
<step n="3c" title="News and Recent Developments">
|
||||
<action>Gather recent news, funding announcements, and market events</action>
|
||||
Search for articles from the last 6-12 months about:
|
||||
- Major deals and acquisitions
|
||||
- Funding rounds in the space
|
||||
- New market entrants
|
||||
- Regulatory changes
|
||||
- Technology disruptions
|
||||
</step>
|
||||
|
||||
<step n="3d" title="Academic and Research Papers">
|
||||
<action>Search for academic research and white papers</action>
|
||||
Look for peer-reviewed studies on:
|
||||
- Market dynamics
|
||||
- Technology adoption patterns
|
||||
- Customer behavior research
|
||||
</step>
|
||||
|
||||
<template-output>market_intelligence_raw</template-output>
|
||||
<template-output>key_data_points</template-output>
|
||||
<template-output>source_credibility_notes</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="TAM, SAM, SOM Calculations">
|
||||
<action>Calculate market sizes using multiple methodologies for triangulation</action>
|
||||
|
||||
<critical>Use actual data gathered in previous steps, not hypothetical numbers</critical>
|
||||
|
||||
<step n="4a" title="TAM Calculation">
|
||||
**Method 1: Top-Down Approach**
|
||||
- Start with total industry size from research
|
||||
- Apply relevant filters and segments
|
||||
- Show calculation: Industry Size × Relevant Percentage
|
||||
|
||||
**Method 2: Bottom-Up Approach**
|
||||
|
||||
- Number of potential customers × Average revenue per customer
|
||||
- Build from unit economics
|
||||
|
||||
**Method 3: Value Theory Approach**
|
||||
|
||||
- Value created × Capturable percentage
|
||||
- Based on problem severity and alternative costs
|
||||
|
||||
<ask>Which TAM calculation method seems most credible given our data? Should we use multiple methods and triangulate?</ask>
|
||||
|
||||
<template-output>tam_calculation</template-output>
|
||||
<template-output>tam_methodology</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4b" title="SAM Calculation">
|
||||
<action>Calculate Serviceable Addressable Market</action>
|
||||
|
||||
Apply constraints to TAM:
|
||||
|
||||
- Geographic limitations (markets you can serve)
|
||||
- Regulatory restrictions
|
||||
- Technical requirements (e.g., internet penetration)
|
||||
- Language/cultural barriers
|
||||
- Current business model limitations
|
||||
|
||||
SAM = TAM × Serviceable Percentage
|
||||
Show the calculation with clear assumptions.
|
||||
|
||||
<template-output>sam_calculation</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4c" title="SOM Calculation">
|
||||
<action>Calculate realistic market capture</action>
|
||||
|
||||
Consider competitive dynamics:
|
||||
|
||||
- Current market share of competitors
|
||||
- Your competitive advantages
|
||||
- Resource constraints
|
||||
- Time to market considerations
|
||||
- Customer acquisition capabilities
|
||||
|
||||
Create 3 scenarios:
|
||||
|
||||
1. Conservative (1-2% market share)
|
||||
2. Realistic (3-5% market share)
|
||||
3. Optimistic (5-10% market share)
|
||||
|
||||
<template-output>som_scenarios</template-output>
|
||||
</step>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Customer Segment Deep Dive">
|
||||
<action>Develop detailed understanding of target customers</action>
|
||||
|
||||
<step n="5a" title="Segment Identification" repeat="for-each-segment">
|
||||
For each major segment, research and define:
|
||||
|
||||
**Demographics/Firmographics:**
|
||||
|
||||
- Size and scale characteristics
|
||||
- Geographic distribution
|
||||
- Industry/vertical (for B2B)
|
||||
|
||||
**Psychographics:**
|
||||
|
||||
- Values and priorities
|
||||
- Decision-making process
|
||||
- Technology adoption patterns
|
||||
|
||||
**Behavioral Patterns:**
|
||||
|
||||
- Current solutions used
|
||||
- Purchasing frequency
|
||||
- Budget allocation
|
||||
|
||||
<elicit-required/>
|
||||
<template-output>segment_profile_{{segment_number}}</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5b" title="Jobs-to-be-Done Framework">
|
||||
<action>Apply JTBD framework to understand customer needs</action>
|
||||
|
||||
For primary segment, identify:
|
||||
|
||||
**Functional Jobs:**
|
||||
|
||||
- Main tasks to accomplish
|
||||
- Problems to solve
|
||||
- Goals to achieve
|
||||
|
||||
**Emotional Jobs:**
|
||||
|
||||
- Feelings sought
|
||||
- Anxieties to avoid
|
||||
- Status desires
|
||||
|
||||
**Social Jobs:**
|
||||
|
||||
- How they want to be perceived
|
||||
- Group dynamics
|
||||
- Peer influences
|
||||
|
||||
<ask>Would you like to conduct actual customer interviews or surveys to validate these jobs? (We can create an interview guide)</ask>
|
||||
|
||||
<template-output>jobs_to_be_done</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5c" title="Willingness to Pay Analysis">
|
||||
<action>Research and estimate pricing sensitivity</action>
|
||||
|
||||
Analyze:
|
||||
|
||||
- Current spending on alternatives
|
||||
- Budget allocation for this category
|
||||
- Value perception indicators
|
||||
- Price points of substitutes
|
||||
|
||||
<template-output>pricing_analysis</template-output>
|
||||
</step>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Competitive Intelligence" if="enable_competitor_analysis == true">
|
||||
<action>Conduct comprehensive competitive analysis</action>
|
||||
|
||||
<step n="6a" title="Competitor Identification">
|
||||
<action>Create comprehensive competitor list</action>
|
||||
|
||||
Search for and categorize:
|
||||
|
||||
1. **Direct Competitors** - Same solution, same market
|
||||
2. **Indirect Competitors** - Different solution, same problem
|
||||
3. **Potential Competitors** - Could enter market
|
||||
4. **Substitute Products** - Alternative approaches
|
||||
|
||||
<ask>Do you have a specific list of competitors to analyze, or should I discover them through research?</ask>
|
||||
</step>
|
||||
|
||||
<step n="6b" title="Competitor Deep Dive" repeat="5">
|
||||
<action>For top 5 competitors, research and analyze</action>
|
||||
|
||||
Gather intelligence on:
|
||||
|
||||
- Company overview and history
|
||||
- Product features and positioning
|
||||
- Pricing strategy and models
|
||||
- Target customer focus
|
||||
- Recent news and developments
|
||||
- Funding and financial health
|
||||
- Team and leadership
|
||||
- Customer reviews and sentiment
|
||||
|
||||
<elicit-required/>
|
||||
<template-output>competitor_analysis_{{competitor_number}}</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6c" title="Competitive Positioning Map">
|
||||
<action>Create positioning analysis</action>
|
||||
|
||||
Map competitors on key dimensions:
|
||||
|
||||
- Price vs. Value
|
||||
- Feature completeness vs. Ease of use
|
||||
- Market segment focus
|
||||
- Technology approach
|
||||
- Business model
|
||||
|
||||
Identify:
|
||||
|
||||
- Gaps in the market
|
||||
- Over-served areas
|
||||
- Differentiation opportunities
|
||||
|
||||
<template-output>competitive_positioning</template-output>
|
||||
</step>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Industry Forces Analysis">
|
||||
<action>Apply Porter's Five Forces framework</action>
|
||||
|
||||
<critical>Use specific evidence from research, not generic assessments</critical>
|
||||
|
||||
Analyze each force with concrete examples:
|
||||
|
||||
<step n="7a" title="Supplier Power">
|
||||
Rate: [Low/Medium/High]
|
||||
- Key suppliers and dependencies
|
||||
- Switching costs
|
||||
- Concentration of suppliers
|
||||
- Forward integration threat
|
||||
</step>
|
||||
|
||||
<step n="7b" title="Buyer Power">
|
||||
Rate: [Low/Medium/High]
|
||||
- Customer concentration
|
||||
- Price sensitivity
|
||||
- Switching costs for customers
|
||||
- Backward integration threat
|
||||
</step>
|
||||
|
||||
<step n="7c" title="Competitive Rivalry">
|
||||
Rate: [Low/Medium/High]
|
||||
- Number and strength of competitors
|
||||
- Industry growth rate
|
||||
- Exit barriers
|
||||
- Differentiation levels
|
||||
</step>
|
||||
|
||||
<step n="7d" title="Threat of New Entry">
|
||||
Rate: [Low/Medium/High]
|
||||
- Capital requirements
|
||||
- Regulatory barriers
|
||||
- Network effects
|
||||
- Brand loyalty
|
||||
</step>
|
||||
|
||||
<step n="7e" title="Threat of Substitutes">
|
||||
Rate: [Low/Medium/High]
|
||||
- Alternative solutions
|
||||
- Switching costs to substitutes
|
||||
- Price-performance trade-offs
|
||||
</step>
|
||||
|
||||
<template-output>porters_five_forces</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Market Trends and Future Outlook">
|
||||
<action>Identify trends and future market dynamics</action>
|
||||
|
||||
Research and analyze:
|
||||
|
||||
**Technology Trends:**
|
||||
|
||||
- Emerging technologies impacting market
|
||||
- Digital transformation effects
|
||||
- Automation possibilities
|
||||
|
||||
**Social/Cultural Trends:**
|
||||
|
||||
- Changing customer behaviors
|
||||
- Generational shifts
|
||||
- Social movements impact
|
||||
|
||||
**Economic Trends:**
|
||||
|
||||
- Macroeconomic factors
|
||||
- Industry-specific economics
|
||||
- Investment trends
|
||||
|
||||
**Regulatory Trends:**
|
||||
|
||||
- Upcoming regulations
|
||||
- Compliance requirements
|
||||
- Policy direction
|
||||
|
||||
<ask>Should we explore any specific emerging technologies or disruptions that could reshape this market?</ask>
|
||||
|
||||
<template-output>market_trends</template-output>
|
||||
<template-output>future_outlook</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Opportunity Assessment and Strategy">
|
||||
<action>Synthesize research into strategic opportunities</action>
|
||||
|
||||
<step n="9a" title="Opportunity Identification">
|
||||
Based on all research, identify top 3-5 opportunities:
|
||||
|
||||
For each opportunity:
|
||||
|
||||
- Description and rationale
|
||||
- Size estimate (from SOM)
|
||||
- Resource requirements
|
||||
- Time to market
|
||||
- Risk assessment
|
||||
- Success criteria
|
||||
|
||||
<elicit-required/>
|
||||
<template-output>market_opportunities</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9b" title="Go-to-Market Recommendations">
|
||||
Develop GTM strategy based on research:
|
||||
|
||||
**Positioning Strategy:**
|
||||
|
||||
- Value proposition refinement
|
||||
- Differentiation approach
|
||||
- Messaging framework
|
||||
|
||||
**Target Segment Sequencing:**
|
||||
|
||||
- Beachhead market selection
|
||||
- Expansion sequence
|
||||
- Segment-specific approaches
|
||||
|
||||
**Channel Strategy:**
|
||||
|
||||
- Distribution channels
|
||||
- Partnership opportunities
|
||||
- Marketing channels
|
||||
|
||||
**Pricing Strategy:**
|
||||
|
||||
- Model recommendation
|
||||
- Price points
|
||||
- Value metrics
|
||||
|
||||
<template-output>gtm_strategy</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9c" title="Risk Analysis">
|
||||
Identify and assess key risks:
|
||||
|
||||
**Market Risks:**
|
||||
|
||||
- Demand uncertainty
|
||||
- Market timing
|
||||
- Economic sensitivity
|
||||
|
||||
**Competitive Risks:**
|
||||
|
||||
- Competitor responses
|
||||
- New entrants
|
||||
- Technology disruption
|
||||
|
||||
**Execution Risks:**
|
||||
|
||||
- Resource requirements
|
||||
- Capability gaps
|
||||
- Scaling challenges
|
||||
|
||||
For each risk: Impact (H/M/L) × Probability (H/M/L) = Risk Score
|
||||
Provide mitigation strategies.
|
||||
|
||||
<template-output>risk_assessment</template-output>
|
||||
</step>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Financial Projections" optional="true" if="enable_financial_modeling == true">
|
||||
<action>Create financial model based on market research</action>
|
||||
|
||||
<ask>Would you like to create a financial model with revenue projections based on the market analysis?</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
Build 3-year projections:
|
||||
|
||||
- Revenue model based on SOM scenarios
|
||||
- Customer acquisition projections
|
||||
- Unit economics
|
||||
- Break-even analysis
|
||||
- Funding requirements
|
||||
|
||||
<template-output>financial_projections</template-output>
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Executive Summary Creation">
|
||||
<action>Synthesize all findings into executive summary</action>
|
||||
|
||||
<critical>Write this AFTER all other sections are complete</critical>
|
||||
|
||||
Create compelling executive summary with:
|
||||
|
||||
**Market Opportunity:**
|
||||
|
||||
- TAM/SAM/SOM summary
|
||||
- Growth trajectory
|
||||
|
||||
**Key Insights:**
|
||||
|
||||
- Top 3-5 findings
|
||||
- Surprising discoveries
|
||||
- Critical success factors
|
||||
|
||||
**Competitive Landscape:**
|
||||
|
||||
- Market structure
|
||||
- Positioning opportunity
|
||||
|
||||
**Strategic Recommendations:**
|
||||
|
||||
- Priority actions
|
||||
- Go-to-market approach
|
||||
- Investment requirements
|
||||
|
||||
**Risk Summary:**
|
||||
|
||||
- Major risks
|
||||
- Mitigation approach
|
||||
|
||||
<template-output>executive_summary</template-output>
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Report Compilation and Review">
|
||||
<action>Compile full report and review with user</action>
|
||||
|
||||
<action>Generate the complete market research report using the template</action>
|
||||
<action>Review all sections for completeness and consistency</action>
|
||||
<action>Ensure all data sources are properly cited</action>
|
||||
|
||||
<ask>Would you like to review any specific sections before finalizing? Are there any additional analyses you'd like to include?</ask>
|
||||
|
||||
<goto step="9a" if="user requests changes">Return to refine opportunities</goto>
|
||||
|
||||
<template-output>final_report_ready</template-output>
|
||||
</step>
|
||||
|
||||
<step n="13" goal="Appendices and Supporting Materials" optional="true">
|
||||
<ask>Would you like to include detailed appendices with calculations, full competitor profiles, or raw research data?</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
Create appendices with:
|
||||
|
||||
- Detailed TAM/SAM/SOM calculations
|
||||
- Full competitor profiles
|
||||
- Customer interview notes
|
||||
- Data sources and methodology
|
||||
- Financial model details
|
||||
- Glossary of terms
|
||||
|
||||
<template-output>appendices</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,91 +0,0 @@
|
||||
# Research Workflow Router Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is a ROUTER that directs to specialized research instruction sets</critical>
|
||||
|
||||
<!-- IDE-INJECT-POINT: research-subagents -->
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Welcome and Research Type Selection">
|
||||
<action>Welcome the user to the Research Workflow</action>
|
||||
|
||||
**The Research Workflow supports multiple research types:**
|
||||
|
||||
Present the user with research type options:
|
||||
|
||||
**What type of research do you need?**
|
||||
|
||||
1. **Market Research** - Comprehensive market analysis with TAM/SAM/SOM calculations, competitive intelligence, customer segments, and go-to-market strategy
|
||||
- Use for: Market opportunity assessment, competitive landscape analysis, market sizing
|
||||
- Output: Detailed market research report with financials
|
||||
|
||||
2. **Deep Research Prompt Generator** - Create structured, multi-step research prompts optimized for AI platforms (ChatGPT, Gemini, Grok, Claude)
|
||||
- Use for: Generating comprehensive research prompts, structuring complex investigations
|
||||
- Output: Optimized research prompt with framework, scope, and validation criteria
|
||||
|
||||
3. **Technical/Architecture Research** - Evaluate technology stacks, architecture patterns, frameworks, and technical approaches
|
||||
- Use for: Tech stack decisions, architecture pattern selection, framework evaluation
|
||||
- Output: Technical research report with recommendations and trade-off analysis
|
||||
|
||||
4. **Competitive Intelligence** - Deep dive into specific competitors, their strategies, products, and market positioning
|
||||
- Use for: Competitor deep dives, competitive strategy analysis
|
||||
- Output: Competitive intelligence report
|
||||
|
||||
5. **User Research** - Customer insights, personas, jobs-to-be-done, and user behavior analysis
|
||||
- Use for: Customer discovery, persona development, user journey mapping
|
||||
- Output: User research report with personas and insights
|
||||
|
||||
6. **Domain/Industry Research** - Deep dive into specific industries, domains, or subject matter areas
|
||||
- Use for: Industry analysis, domain expertise building, trend analysis
|
||||
- Output: Domain research report
|
||||
|
||||
<ask>Select a research type (1-6) or describe your research needs:</ask>
|
||||
|
||||
<action>Capture user selection as {{research_type}}</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Route to Appropriate Research Instructions">
|
||||
|
||||
<critical>Based on user selection, load the appropriate instruction set</critical>
|
||||
|
||||
<check>If research_type == "1" OR "market" OR "market research":</check>
|
||||
<action>Set research_mode = "market"</action>
|
||||
<action>LOAD: {installed_path}/instructions-market.md</action>
|
||||
<action>Continue with market research workflow</action>
|
||||
|
||||
<check>If research_type == "2" OR "prompt" OR "deep research prompt":</check>
|
||||
<action>Set research_mode = "deep-prompt"</action>
|
||||
<action>LOAD: {installed_path}/instructions-deep-prompt.md</action>
|
||||
<action>Continue with deep research prompt generation</action>
|
||||
|
||||
<check>If research_type == "3" OR "technical" OR "architecture":</check>
|
||||
<action>Set research_mode = "technical"</action>
|
||||
<action>LOAD: {installed_path}/instructions-technical.md</action>
|
||||
<action>Continue with technical research workflow</action>
|
||||
|
||||
<check>If research_type == "4" OR "competitive":</check>
|
||||
<action>Set research_mode = "competitive"</action>
|
||||
<action>This will use market research workflow with competitive focus</action>
|
||||
<action>LOAD: {installed_path}/instructions-market.md</action>
|
||||
<action>Pass mode="competitive" to focus on competitive intelligence</action>
|
||||
|
||||
<check>If research_type == "5" OR "user":</check>
|
||||
<action>Set research_mode = "user"</action>
|
||||
<action>This will use market research workflow with user research focus</action>
|
||||
<action>LOAD: {installed_path}/instructions-market.md</action>
|
||||
<action>Pass mode="user" to focus on customer insights</action>
|
||||
|
||||
<check>If research_type == "6" OR "domain" OR "industry":</check>
|
||||
<action>Set research_mode = "domain"</action>
|
||||
<action>This will use market research workflow with domain focus</action>
|
||||
<action>LOAD: {installed_path}/instructions-market.md</action>
|
||||
<action>Pass mode="domain" to focus on industry/domain analysis</action>
|
||||
|
||||
<critical>The loaded instruction set will continue from here with full context</critical>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,442 +0,0 @@
|
||||
# Technical/Architecture Research Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This workflow conducts technical research for architecture and technology decisions</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Technical Research Discovery">
|
||||
<action>Understand the technical research requirements</action>
|
||||
|
||||
**Welcome to Technical/Architecture Research!**
|
||||
|
||||
<ask>What technical decision or research do you need?
|
||||
|
||||
Common scenarios:
|
||||
|
||||
- Evaluate technology stack for a new project
|
||||
- Compare frameworks or libraries (React vs Vue, Postgres vs MongoDB)
|
||||
- Research architecture patterns (microservices, event-driven, CQRS)
|
||||
- Investigate specific technologies or tools
|
||||
- Best practices for specific use cases
|
||||
- Performance and scalability considerations
|
||||
- Security and compliance research</ask>
|
||||
|
||||
<template-output>technical_question</template-output>
|
||||
|
||||
<ask>What's the context for this decision?
|
||||
|
||||
- New greenfield project
|
||||
- Adding to existing system (brownfield)
|
||||
- Refactoring/modernizing legacy system
|
||||
- Proof of concept / prototype
|
||||
- Production-ready implementation
|
||||
- Academic/learning purpose</ask>
|
||||
|
||||
<template-output>project_context</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define Technical Requirements and Constraints">
|
||||
<action>Gather requirements and constraints that will guide the research</action>
|
||||
|
||||
**Let's define your technical requirements:**
|
||||
|
||||
<ask>**Functional Requirements** - What must the technology do?
|
||||
|
||||
Examples:
|
||||
|
||||
- Handle 1M requests per day
|
||||
- Support real-time data processing
|
||||
- Provide full-text search capabilities
|
||||
- Enable offline-first mobile app
|
||||
- Support multi-tenancy</ask>
|
||||
|
||||
<template-output>functional_requirements</template-output>
|
||||
|
||||
<ask>**Non-Functional Requirements** - Performance, scalability, security needs?
|
||||
|
||||
Consider:
|
||||
|
||||
- Performance targets (latency, throughput)
|
||||
- Scalability requirements (users, data volume)
|
||||
- Reliability and availability needs
|
||||
- Security and compliance requirements
|
||||
- Maintainability and developer experience</ask>
|
||||
|
||||
<template-output>non_functional_requirements</template-output>
|
||||
|
||||
<ask>**Constraints** - What limitations or requirements exist?
|
||||
|
||||
- Programming language preferences or requirements
|
||||
- Cloud platform (AWS, Azure, GCP, on-prem)
|
||||
- Budget constraints
|
||||
- Team expertise and skills
|
||||
- Timeline and urgency
|
||||
- Existing technology stack (if brownfield)
|
||||
- Open source vs commercial requirements
|
||||
- Licensing considerations</ask>
|
||||
|
||||
<template-output>technical_constraints</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Identify Alternatives and Options">
|
||||
<action>Research and identify technology options to evaluate</action>
|
||||
|
||||
<ask>Do you have specific technologies in mind to compare, or should I discover options?
|
||||
|
||||
If you have specific options, list them. Otherwise, I'll research current leading solutions based on your requirements.</ask>
|
||||
|
||||
<check>If user provides options:</check>
|
||||
<template-output>user_provided_options</template-output>
|
||||
|
||||
<check>If discovering options:</check>
|
||||
<action>Conduct web research to identify current leading solutions</action>
|
||||
<action>Search for:
|
||||
|
||||
- "[technical_category] best tools 2025"
|
||||
- "[technical_category] comparison [use_case]"
|
||||
- "[technical_category] production experiences reddit"
|
||||
- "State of [technical_category] 2025"
|
||||
</action>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
<action>Present discovered options (typically 3-5 main candidates)</action>
|
||||
<template-output>technology_options</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Deep Dive Research on Each Option">
|
||||
<action>Research each technology option in depth</action>
|
||||
|
||||
<critical>For each technology option, research thoroughly</critical>
|
||||
|
||||
<step n="4a" title="Technology Profile" repeat="for-each-option">
|
||||
|
||||
Research and document:
|
||||
|
||||
**Overview:**
|
||||
|
||||
- What is it and what problem does it solve?
|
||||
- Maturity level (experimental, stable, mature, legacy)
|
||||
- Community size and activity
|
||||
- Maintenance status and release cadence
|
||||
|
||||
**Technical Characteristics:**
|
||||
|
||||
- Architecture and design philosophy
|
||||
- Core features and capabilities
|
||||
- Performance characteristics
|
||||
- Scalability approach
|
||||
- Integration capabilities
|
||||
|
||||
**Developer Experience:**
|
||||
|
||||
- Learning curve
|
||||
- Documentation quality
|
||||
- Tooling ecosystem
|
||||
- Testing support
|
||||
- Debugging capabilities
|
||||
|
||||
**Operations:**
|
||||
|
||||
- Deployment complexity
|
||||
- Monitoring and observability
|
||||
- Operational overhead
|
||||
- Cloud provider support
|
||||
- Container/K8s compatibility
|
||||
|
||||
**Ecosystem:**
|
||||
|
||||
- Available libraries and plugins
|
||||
- Third-party integrations
|
||||
- Commercial support options
|
||||
- Training and educational resources
|
||||
|
||||
**Community and Adoption:**
|
||||
|
||||
- GitHub stars/contributors (if applicable)
|
||||
- Production usage examples
|
||||
- Case studies from similar use cases
|
||||
- Community support channels
|
||||
- Job market demand
|
||||
|
||||
**Costs:**
|
||||
|
||||
- Licensing model
|
||||
- Hosting/infrastructure costs
|
||||
- Support costs
|
||||
- Training costs
|
||||
- Total cost of ownership estimate
|
||||
|
||||
<elicit-required/>
|
||||
<template-output>tech_profile_{{option_number}}</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Comparative Analysis">
|
||||
<action>Create structured comparison across all options</action>
|
||||
|
||||
**Create comparison matrices:**
|
||||
|
||||
<action>Generate comparison table with key dimensions:</action>
|
||||
|
||||
**Comparison Dimensions:**
|
||||
|
||||
1. **Meets Requirements** - How well does each meet functional requirements?
|
||||
2. **Performance** - Speed, latency, throughput benchmarks
|
||||
3. **Scalability** - Horizontal/vertical scaling capabilities
|
||||
4. **Complexity** - Learning curve and operational complexity
|
||||
5. **Ecosystem** - Maturity, community, libraries, tools
|
||||
6. **Cost** - Total cost of ownership
|
||||
7. **Risk** - Maturity, vendor lock-in, abandonment risk
|
||||
8. **Developer Experience** - Productivity, debugging, testing
|
||||
9. **Operations** - Deployment, monitoring, maintenance
|
||||
10. **Future-Proofing** - Roadmap, innovation, sustainability
|
||||
|
||||
<action>Rate each option on relevant dimensions (High/Medium/Low or 1-5 scale)</action>
|
||||
|
||||
<template-output>comparative_analysis</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Trade-offs and Decision Factors">
|
||||
<action>Analyze trade-offs between options</action>
|
||||
|
||||
**Identify key trade-offs:**
|
||||
|
||||
For each pair of leading options, identify trade-offs:
|
||||
|
||||
- What do you gain by choosing Option A over Option B?
|
||||
- What do you sacrifice?
|
||||
- Under what conditions would you choose one vs the other?
|
||||
|
||||
**Decision factors by priority:**
|
||||
|
||||
<ask>What are your top 3 decision factors?
|
||||
|
||||
Examples:
|
||||
|
||||
- Time to market
|
||||
- Performance
|
||||
- Developer productivity
|
||||
- Operational simplicity
|
||||
- Cost efficiency
|
||||
- Future flexibility
|
||||
- Team expertise match
|
||||
- Community and support</ask>
|
||||
|
||||
<template-output>decision_priorities</template-output>
|
||||
|
||||
<action>Weight the comparison analysis by decision priorities</action>
|
||||
|
||||
<template-output>weighted_analysis</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Use Case Fit Analysis">
|
||||
<action>Evaluate fit for specific use case</action>
|
||||
|
||||
**Match technologies to your specific use case:**
|
||||
|
||||
Based on:
|
||||
|
||||
- Your functional and non-functional requirements
|
||||
- Your constraints (team, budget, timeline)
|
||||
- Your context (greenfield vs brownfield)
|
||||
- Your decision priorities
|
||||
|
||||
Analyze which option(s) best fit your specific scenario.
|
||||
|
||||
<ask>Are there any specific concerns or "must-haves" that would immediately eliminate any options?</ask>
|
||||
|
||||
<template-output>use_case_fit</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Real-World Evidence">
|
||||
<action>Gather production experience evidence</action>
|
||||
|
||||
**Search for real-world experiences:**
|
||||
|
||||
For top 2-3 candidates:
|
||||
|
||||
- Production war stories and lessons learned
|
||||
- Known issues and gotchas
|
||||
- Migration experiences (if replacing existing tech)
|
||||
- Performance benchmarks from real deployments
|
||||
- Team scaling experiences
|
||||
- Reddit/HackerNews discussions
|
||||
- Conference talks and blog posts from practitioners
|
||||
|
||||
<template-output>real_world_evidence</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Architecture Pattern Research" optional="true">
|
||||
<action>If researching architecture patterns, provide pattern analysis</action>
|
||||
|
||||
<ask>Are you researching architecture patterns (microservices, event-driven, etc.)?</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
|
||||
Research and document:
|
||||
|
||||
**Pattern Overview:**
|
||||
|
||||
- Core principles and concepts
|
||||
- When to use vs when not to use
|
||||
- Prerequisites and foundations
|
||||
|
||||
**Implementation Considerations:**
|
||||
|
||||
- Technology choices for the pattern
|
||||
- Reference architectures
|
||||
- Common pitfalls and anti-patterns
|
||||
- Migration path from current state
|
||||
|
||||
**Trade-offs:**
|
||||
|
||||
- Benefits and drawbacks
|
||||
- Complexity vs benefits analysis
|
||||
- Team skill requirements
|
||||
- Operational overhead
|
||||
|
||||
<template-output>architecture_pattern_analysis</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Recommendations and Decision Framework">
|
||||
<action>Synthesize research into clear recommendations</action>
|
||||
|
||||
**Generate recommendations:**
|
||||
|
||||
**Top Recommendation:**
|
||||
|
||||
- Primary technology choice with rationale
|
||||
- Why it best fits your requirements and constraints
|
||||
- Key benefits for your use case
|
||||
- Risks and mitigation strategies
|
||||
|
||||
**Alternative Options:**
|
||||
|
||||
- Second and third choices
|
||||
- When you might choose them instead
|
||||
- Scenarios where they would be better
|
||||
|
||||
**Implementation Roadmap:**
|
||||
|
||||
- Proof of concept approach
|
||||
- Key decisions to make during implementation
|
||||
- Migration path (if applicable)
|
||||
- Success criteria and validation approach
|
||||
|
||||
**Risk Mitigation:**
|
||||
|
||||
- Identified risks and mitigation plans
|
||||
- Contingency options if primary choice doesn't work
|
||||
- Exit strategy considerations
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
<template-output>recommendations</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Decision Documentation">
|
||||
<action>Create architecture decision record (ADR) template</action>
|
||||
|
||||
**Generate Architecture Decision Record:**
|
||||
|
||||
Create ADR format documentation:
|
||||
|
||||
```markdown
|
||||
# ADR-XXX: [Decision Title]
|
||||
|
||||
## Status
|
||||
|
||||
[Proposed | Accepted | Superseded]
|
||||
|
||||
## Context
|
||||
|
||||
[Technical context and problem statement]
|
||||
|
||||
## Decision Drivers
|
||||
|
||||
[Key factors influencing the decision]
|
||||
|
||||
## Considered Options
|
||||
|
||||
[Technologies/approaches evaluated]
|
||||
|
||||
## Decision
|
||||
|
||||
[Chosen option and rationale]
|
||||
|
||||
## Consequences
|
||||
|
||||
**Positive:**
|
||||
|
||||
- [Benefits of this choice]
|
||||
|
||||
**Negative:**
|
||||
|
||||
- [Drawbacks and risks]
|
||||
|
||||
**Neutral:**
|
||||
|
||||
- [Other impacts]
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
[Key considerations for implementation]
|
||||
|
||||
## References
|
||||
|
||||
[Links to research, benchmarks, case studies]
|
||||
```
|
||||
|
||||
<template-output>architecture_decision_record</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Finalize Technical Research Report">
|
||||
<action>Compile complete technical research report</action>
|
||||
|
||||
**Your Technical Research Report includes:**
|
||||
|
||||
1. **Executive Summary** - Key findings and recommendation
|
||||
2. **Requirements and Constraints** - What guided the research
|
||||
3. **Technology Options** - All candidates evaluated
|
||||
4. **Detailed Profiles** - Deep dive on each option
|
||||
5. **Comparative Analysis** - Side-by-side comparison
|
||||
6. **Trade-off Analysis** - Key decision factors
|
||||
7. **Real-World Evidence** - Production experiences
|
||||
8. **Recommendations** - Detailed recommendation with rationale
|
||||
9. **Architecture Decision Record** - Formal decision documentation
|
||||
10. **Next Steps** - Implementation roadmap
|
||||
|
||||
<action>Save complete report to {default_output_file}</action>
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
1. Deep dive into specific technology
|
||||
2. Research implementation patterns for chosen technology
|
||||
3. Generate proof-of-concept plan
|
||||
4. Create deep research prompt for ongoing investigation
|
||||
5. Exit workflow
|
||||
|
||||
Select option (1-5):</ask>
|
||||
|
||||
<check>If option 4:</check>
|
||||
<action>LOAD: {installed_path}/instructions-deep-prompt.md</action>
|
||||
<action>Pre-populate with technical research context</action>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,94 +0,0 @@
|
||||
# Deep Research Prompt
|
||||
|
||||
**Generated:** {{date}}
|
||||
**Created by:** {{user_name}}
|
||||
**Target Platform:** {{target_platform}}
|
||||
|
||||
---
|
||||
|
||||
## Research Prompt (Ready to Use)
|
||||
|
||||
### Research Question
|
||||
|
||||
{{research_topic}}
|
||||
|
||||
### Research Goal and Context
|
||||
|
||||
**Objective:** {{research_goal}}
|
||||
|
||||
**Context:**
|
||||
{{research_persona}}
|
||||
|
||||
### Scope and Boundaries
|
||||
|
||||
**Temporal Scope:** {{temporal_scope}}
|
||||
|
||||
**Geographic Scope:** {{geographic_scope}}
|
||||
|
||||
**Thematic Focus:**
|
||||
{{thematic_boundaries}}
|
||||
|
||||
### Information Requirements
|
||||
|
||||
**Types of Information Needed:**
|
||||
{{information_types}}
|
||||
|
||||
**Preferred Sources:**
|
||||
{{preferred_sources}}
|
||||
|
||||
### Output Structure
|
||||
|
||||
**Format:** {{output_format}}
|
||||
|
||||
**Required Sections:**
|
||||
{{key_sections}}
|
||||
|
||||
**Depth Level:** {{depth_level}}
|
||||
|
||||
### Research Methodology
|
||||
|
||||
**Keywords and Technical Terms:**
|
||||
{{research_keywords}}
|
||||
|
||||
**Special Requirements:**
|
||||
{{special_requirements}}
|
||||
|
||||
**Validation Criteria:**
|
||||
{{validation_criteria}}
|
||||
|
||||
### Follow-up Strategy
|
||||
|
||||
{{follow_up_strategy}}
|
||||
|
||||
---
|
||||
|
||||
## Complete Research Prompt (Copy and Paste)
|
||||
|
||||
```
|
||||
{{deep_research_prompt}}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Platform-Specific Usage Tips
|
||||
|
||||
{{platform_tips}}
|
||||
|
||||
---
|
||||
|
||||
## Research Execution Checklist
|
||||
|
||||
{{execution_checklist}}
|
||||
|
||||
---
|
||||
|
||||
## Metadata
|
||||
|
||||
**Workflow:** BMad Research Workflow - Deep Research Prompt Generator v2.0
|
||||
**Generated:** {{date}}
|
||||
**Research Type:** Deep Research Prompt
|
||||
**Platform:** {{target_platform}}
|
||||
|
||||
---
|
||||
|
||||
_This research prompt was generated using the BMad Method Research Workflow, incorporating best practices from ChatGPT Deep Research, Gemini Deep Research, Grok DeepSearch, and Claude Projects (2025)._
|
||||
@@ -1,311 +0,0 @@
|
||||
# Market Research Report: {{product_name}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Prepared by:** {{user_name}}
|
||||
**Research Depth:** {{research_depth}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
### Key Market Metrics
|
||||
|
||||
- **Total Addressable Market (TAM):** {{tam_calculation}}
|
||||
- **Serviceable Addressable Market (SAM):** {{sam_calculation}}
|
||||
- **Serviceable Obtainable Market (SOM):** {{som_scenarios}}
|
||||
|
||||
### Critical Success Factors
|
||||
|
||||
{{key_success_factors}}
|
||||
|
||||
---
|
||||
|
||||
## 1. Research Objectives and Methodology
|
||||
|
||||
### Research Objectives
|
||||
|
||||
{{research_objectives}}
|
||||
|
||||
### Scope and Boundaries
|
||||
|
||||
- **Product/Service:** {{product_description}}
|
||||
- **Market Definition:** {{market_definition}}
|
||||
- **Geographic Scope:** {{geographic_scope}}
|
||||
- **Customer Segments:** {{segment_boundaries}}
|
||||
|
||||
### Research Methodology
|
||||
|
||||
{{research_methodology}}
|
||||
|
||||
### Data Sources
|
||||
|
||||
{{source_credibility_notes}}
|
||||
|
||||
---
|
||||
|
||||
## 2. Market Overview
|
||||
|
||||
### Market Definition
|
||||
|
||||
{{market_definition}}
|
||||
|
||||
### Market Size and Growth
|
||||
|
||||
#### Total Addressable Market (TAM)
|
||||
|
||||
**Methodology:** {{tam_methodology}}
|
||||
|
||||
{{tam_calculation}}
|
||||
|
||||
#### Serviceable Addressable Market (SAM)
|
||||
|
||||
{{sam_calculation}}
|
||||
|
||||
#### Serviceable Obtainable Market (SOM)
|
||||
|
||||
{{som_scenarios}}
|
||||
|
||||
### Market Intelligence Summary
|
||||
|
||||
{{market_intelligence_raw}}
|
||||
|
||||
### Key Data Points
|
||||
|
||||
{{key_data_points}}
|
||||
|
||||
---
|
||||
|
||||
## 3. Market Trends and Drivers
|
||||
|
||||
### Key Market Trends
|
||||
|
||||
{{market_trends}}
|
||||
|
||||
### Growth Drivers
|
||||
|
||||
{{growth_drivers}}
|
||||
|
||||
### Market Inhibitors
|
||||
|
||||
{{market_inhibitors}}
|
||||
|
||||
### Future Outlook
|
||||
|
||||
{{future_outlook}}
|
||||
|
||||
---
|
||||
|
||||
## 4. Customer Analysis
|
||||
|
||||
### Target Customer Segments
|
||||
|
||||
{{#segment_profile_1}}
|
||||
|
||||
#### Segment 1
|
||||
|
||||
{{segment_profile_1}}
|
||||
{{/segment_profile_1}}
|
||||
|
||||
{{#segment_profile_2}}
|
||||
|
||||
#### Segment 2
|
||||
|
||||
{{segment_profile_2}}
|
||||
{{/segment_profile_2}}
|
||||
|
||||
{{#segment_profile_3}}
|
||||
|
||||
#### Segment 3
|
||||
|
||||
{{segment_profile_3}}
|
||||
{{/segment_profile_3}}
|
||||
|
||||
{{#segment_profile_4}}
|
||||
|
||||
#### Segment 4
|
||||
|
||||
{{segment_profile_4}}
|
||||
{{/segment_profile_4}}
|
||||
|
||||
{{#segment_profile_5}}
|
||||
|
||||
#### Segment 5
|
||||
|
||||
{{segment_profile_5}}
|
||||
{{/segment_profile_5}}
|
||||
|
||||
### Jobs-to-be-Done Analysis
|
||||
|
||||
{{jobs_to_be_done}}
|
||||
|
||||
### Pricing Analysis and Willingness to Pay
|
||||
|
||||
{{pricing_analysis}}
|
||||
|
||||
---
|
||||
|
||||
## 5. Competitive Landscape
|
||||
|
||||
### Market Structure
|
||||
|
||||
{{market_structure}}
|
||||
|
||||
### Competitor Analysis
|
||||
|
||||
{{#competitor_analysis_1}}
|
||||
|
||||
#### Competitor 1
|
||||
|
||||
{{competitor_analysis_1}}
|
||||
{{/competitor_analysis_1}}
|
||||
|
||||
{{#competitor_analysis_2}}
|
||||
|
||||
#### Competitor 2
|
||||
|
||||
{{competitor_analysis_2}}
|
||||
{{/competitor_analysis_2}}
|
||||
|
||||
{{#competitor_analysis_3}}
|
||||
|
||||
#### Competitor 3
|
||||
|
||||
{{competitor_analysis_3}}
|
||||
{{/competitor_analysis_3}}
|
||||
|
||||
{{#competitor_analysis_4}}
|
||||
|
||||
#### Competitor 4
|
||||
|
||||
{{competitor_analysis_4}}
|
||||
{{/competitor_analysis_4}}
|
||||
|
||||
{{#competitor_analysis_5}}
|
||||
|
||||
#### Competitor 5
|
||||
|
||||
{{competitor_analysis_5}}
|
||||
{{/competitor_analysis_5}}
|
||||
|
||||
### Competitive Positioning
|
||||
|
||||
{{competitive_positioning}}
|
||||
|
||||
---
|
||||
|
||||
## 6. Industry Analysis
|
||||
|
||||
### Porter's Five Forces Assessment
|
||||
|
||||
{{porters_five_forces}}
|
||||
|
||||
### Technology Adoption Lifecycle
|
||||
|
||||
{{adoption_lifecycle}}
|
||||
|
||||
### Value Chain Analysis
|
||||
|
||||
{{value_chain_analysis}}
|
||||
|
||||
---
|
||||
|
||||
## 7. Market Opportunities
|
||||
|
||||
### Identified Opportunities
|
||||
|
||||
{{market_opportunities}}
|
||||
|
||||
### Opportunity Prioritization Matrix
|
||||
|
||||
{{opportunity_prioritization}}
|
||||
|
||||
---
|
||||
|
||||
## 8. Strategic Recommendations
|
||||
|
||||
### Go-to-Market Strategy
|
||||
|
||||
{{gtm_strategy}}
|
||||
|
||||
#### Positioning Strategy
|
||||
|
||||
{{positioning_strategy}}
|
||||
|
||||
#### Target Segment Sequencing
|
||||
|
||||
{{segment_sequencing}}
|
||||
|
||||
#### Channel Strategy
|
||||
|
||||
{{channel_strategy}}
|
||||
|
||||
#### Pricing Strategy
|
||||
|
||||
{{pricing_recommendations}}
|
||||
|
||||
### Implementation Roadmap
|
||||
|
||||
{{implementation_roadmap}}
|
||||
|
||||
---
|
||||
|
||||
## 9. Risk Assessment
|
||||
|
||||
### Risk Analysis
|
||||
|
||||
{{risk_assessment}}
|
||||
|
||||
### Mitigation Strategies
|
||||
|
||||
{{mitigation_strategies}}
|
||||
|
||||
---
|
||||
|
||||
## 10. Financial Projections
|
||||
|
||||
{{#financial_projections}}
|
||||
{{financial_projections}}
|
||||
{{/financial_projections}}
|
||||
|
||||
---
|
||||
|
||||
## Appendices
|
||||
|
||||
### Appendix A: Data Sources and References
|
||||
|
||||
{{data_sources}}
|
||||
|
||||
### Appendix B: Detailed Calculations
|
||||
|
||||
{{detailed_calculations}}
|
||||
|
||||
### Appendix C: Additional Analysis
|
||||
|
||||
{{#appendices}}
|
||||
{{appendices}}
|
||||
{{/appendices}}
|
||||
|
||||
### Appendix D: Glossary of Terms
|
||||
|
||||
{{glossary}}
|
||||
|
||||
---
|
||||
|
||||
## Document Information
|
||||
|
||||
**Workflow:** BMad Market Research Workflow v1.0
|
||||
**Generated:** {{date}}
|
||||
**Next Review:** {{next_review_date}}
|
||||
**Classification:** {{classification}}
|
||||
|
||||
### Research Quality Metrics
|
||||
|
||||
- **Data Freshness:** Current as of {{date}}
|
||||
- **Source Reliability:** {{source_reliability_score}}
|
||||
- **Confidence Level:** {{confidence_level}}
|
||||
|
||||
---
|
||||
|
||||
_This market research report was generated using the BMad Method Market Research Workflow, combining systematic analysis frameworks with real-time market intelligence gathering._
|
||||
@@ -1,210 +0,0 @@
|
||||
# Technical Research Report: {{technical_question}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Prepared by:** {{user_name}}
|
||||
**Project Context:** {{project_context}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{recommendations}}
|
||||
|
||||
### Key Recommendation
|
||||
|
||||
**Primary Choice:** [Technology/Pattern Name]
|
||||
|
||||
**Rationale:** [2-3 sentence summary]
|
||||
|
||||
**Key Benefits:**
|
||||
|
||||
- [Benefit 1]
|
||||
- [Benefit 2]
|
||||
- [Benefit 3]
|
||||
|
||||
---
|
||||
|
||||
## 1. Research Objectives
|
||||
|
||||
### Technical Question
|
||||
|
||||
{{technical_question}}
|
||||
|
||||
### Project Context
|
||||
|
||||
{{project_context}}
|
||||
|
||||
### Requirements and Constraints
|
||||
|
||||
#### Functional Requirements
|
||||
|
||||
{{functional_requirements}}
|
||||
|
||||
#### Non-Functional Requirements
|
||||
|
||||
{{non_functional_requirements}}
|
||||
|
||||
#### Technical Constraints
|
||||
|
||||
{{technical_constraints}}
|
||||
|
||||
---
|
||||
|
||||
## 2. Technology Options Evaluated
|
||||
|
||||
{{technology_options}}
|
||||
|
||||
---
|
||||
|
||||
## 3. Detailed Technology Profiles
|
||||
|
||||
{{#tech_profile_1}}
|
||||
|
||||
### Option 1: [Technology Name]
|
||||
|
||||
{{tech_profile_1}}
|
||||
{{/tech_profile_1}}
|
||||
|
||||
{{#tech_profile_2}}
|
||||
|
||||
### Option 2: [Technology Name]
|
||||
|
||||
{{tech_profile_2}}
|
||||
{{/tech_profile_2}}
|
||||
|
||||
{{#tech_profile_3}}
|
||||
|
||||
### Option 3: [Technology Name]
|
||||
|
||||
{{tech_profile_3}}
|
||||
{{/tech_profile_3}}
|
||||
|
||||
{{#tech_profile_4}}
|
||||
|
||||
### Option 4: [Technology Name]
|
||||
|
||||
{{tech_profile_4}}
|
||||
{{/tech_profile_4}}
|
||||
|
||||
{{#tech_profile_5}}
|
||||
|
||||
### Option 5: [Technology Name]
|
||||
|
||||
{{tech_profile_5}}
|
||||
{{/tech_profile_5}}
|
||||
|
||||
---
|
||||
|
||||
## 4. Comparative Analysis
|
||||
|
||||
{{comparative_analysis}}
|
||||
|
||||
### Weighted Analysis
|
||||
|
||||
**Decision Priorities:**
|
||||
{{decision_priorities}}
|
||||
|
||||
{{weighted_analysis}}
|
||||
|
||||
---
|
||||
|
||||
## 5. Trade-offs and Decision Factors
|
||||
|
||||
{{use_case_fit}}
|
||||
|
||||
### Key Trade-offs
|
||||
|
||||
[Comparison of major trade-offs between top options]
|
||||
|
||||
---
|
||||
|
||||
## 6. Real-World Evidence
|
||||
|
||||
{{real_world_evidence}}
|
||||
|
||||
---
|
||||
|
||||
## 7. Architecture Pattern Analysis
|
||||
|
||||
{{#architecture_pattern_analysis}}
|
||||
{{architecture_pattern_analysis}}
|
||||
{{/architecture_pattern_analysis}}
|
||||
|
||||
---
|
||||
|
||||
## 8. Recommendations
|
||||
|
||||
{{recommendations}}
|
||||
|
||||
### Implementation Roadmap
|
||||
|
||||
1. **Proof of Concept Phase**
|
||||
- [POC objectives and timeline]
|
||||
|
||||
2. **Key Implementation Decisions**
|
||||
- [Critical decisions to make during implementation]
|
||||
|
||||
3. **Migration Path** (if applicable)
|
||||
- [Migration approach from current state]
|
||||
|
||||
4. **Success Criteria**
|
||||
- [How to validate the decision]
|
||||
|
||||
### Risk Mitigation
|
||||
|
||||
{{risk_mitigation}}
|
||||
|
||||
---
|
||||
|
||||
## 9. Architecture Decision Record (ADR)
|
||||
|
||||
{{architecture_decision_record}}
|
||||
|
||||
---
|
||||
|
||||
## 10. References and Resources
|
||||
|
||||
### Documentation
|
||||
|
||||
- [Links to official documentation]
|
||||
|
||||
### Benchmarks and Case Studies
|
||||
|
||||
- [Links to benchmarks and real-world case studies]
|
||||
|
||||
### Community Resources
|
||||
|
||||
- [Links to communities, forums, discussions]
|
||||
|
||||
### Additional Reading
|
||||
|
||||
- [Links to relevant articles, papers, talks]
|
||||
|
||||
---
|
||||
|
||||
## Appendices
|
||||
|
||||
### Appendix A: Detailed Comparison Matrix
|
||||
|
||||
[Full comparison table with all evaluated dimensions]
|
||||
|
||||
### Appendix B: Proof of Concept Plan
|
||||
|
||||
[Detailed POC plan if needed]
|
||||
|
||||
### Appendix C: Cost Analysis
|
||||
|
||||
[TCO analysis if performed]
|
||||
|
||||
---
|
||||
|
||||
## Document Information
|
||||
|
||||
**Workflow:** BMad Research Workflow - Technical Research v2.0
|
||||
**Generated:** {{date}}
|
||||
**Research Type:** Technical/Architecture Research
|
||||
**Next Review:** [Date for review/update]
|
||||
|
||||
---
|
||||
|
||||
_This technical research report was generated using the BMad Method Research Workflow, combining systematic technology evaluation frameworks with real-time research and analysis._
|
||||
@@ -1,149 +0,0 @@
|
||||
# Research Workflow - Multi-Type Research System
|
||||
name: research
|
||||
description: "Adaptive research workflow supporting multiple research types: market research, deep research prompt generation, technical/architecture evaluation, competitive intelligence, user research, and domain analysis"
|
||||
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"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components - ROUTER PATTERN
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/1-analysis/research"
|
||||
instructions: "{installed_path}/instructions-router.md" # Router loads specific instruction sets
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Research type specific instructions (loaded by router)
|
||||
instructions_market: "{installed_path}/instructions-market.md"
|
||||
instructions_deep_prompt: "{installed_path}/instructions-deep-prompt.md"
|
||||
instructions_technical: "{installed_path}/instructions-technical.md"
|
||||
|
||||
# Templates (loaded based on research type)
|
||||
template_market: "{installed_path}/template-market.md"
|
||||
template_deep_prompt: "{installed_path}/template-deep-prompt.md"
|
||||
template_technical: "{installed_path}/template-technical.md"
|
||||
|
||||
# Output configuration (dynamic based on research type)
|
||||
default_output_file: "{output_folder}/research-{{research_type}}-{{date}}.md"
|
||||
market_output: "{output_folder}/market-research-{{product_name_slug}}-{{date}}.md"
|
||||
deep_prompt_output: "{output_folder}/deep-research-prompt-{{date}}.md"
|
||||
technical_output: "{output_folder}/technical-research-{{date}}.md"
|
||||
|
||||
# Research types supported
|
||||
research_types:
|
||||
market:
|
||||
name: "Market Research"
|
||||
description: "Comprehensive market analysis with TAM/SAM/SOM"
|
||||
instructions: "{instructions_market}"
|
||||
template: "{template_market}"
|
||||
output: "{market_output}"
|
||||
deep_prompt:
|
||||
name: "Deep Research Prompt Generator"
|
||||
description: "Generate optimized prompts for AI research platforms"
|
||||
instructions: "{instructions_deep_prompt}"
|
||||
template: "{template_deep_prompt}"
|
||||
output: "{deep_prompt_output}"
|
||||
technical:
|
||||
name: "Technical/Architecture Research"
|
||||
description: "Technology evaluation and architecture pattern research"
|
||||
instructions: "{instructions_technical}"
|
||||
template: "{template_technical}"
|
||||
output: "{technical_output}"
|
||||
competitive:
|
||||
name: "Competitive Intelligence"
|
||||
description: "Deep competitor analysis"
|
||||
instructions: "{instructions_market}" # Uses market with competitive focus
|
||||
template: "{template_market}"
|
||||
output: "{output_folder}/competitive-intelligence-{{date}}.md"
|
||||
user:
|
||||
name: "User Research"
|
||||
description: "Customer insights and persona development"
|
||||
instructions: "{instructions_market}" # Uses market with user focus
|
||||
template: "{template_market}"
|
||||
output: "{output_folder}/user-research-{{date}}.md"
|
||||
domain:
|
||||
name: "Domain/Industry Research"
|
||||
description: "Industry and domain deep dives"
|
||||
instructions: "{instructions_market}" # Uses market with domain focus
|
||||
template: "{template_market}"
|
||||
output: "{output_folder}/domain-research-{{date}}.md"
|
||||
|
||||
# Research parameters (can be overridden at runtime)
|
||||
research_depth: "comprehensive" # Options: quick, standard, comprehensive
|
||||
enable_web_research: true
|
||||
enable_competitor_analysis: true
|
||||
enable_financial_modeling: true
|
||||
|
||||
# Data sources and tools
|
||||
required_tools:
|
||||
- web_search: "For real-time data gathering across all research types"
|
||||
- calculator: "For calculations (TAM/SAM/SOM, TCO, etc.)"
|
||||
- data_analysis: "For trends, patterns, and comparative analysis"
|
||||
|
||||
# Recommended input documents (varies by research type)
|
||||
recommended_inputs:
|
||||
market:
|
||||
- product_brief: "Product or business description"
|
||||
- target_customers: "Customer segment hypotheses"
|
||||
- competitor_list: "Known competitors (optional)"
|
||||
technical:
|
||||
- requirements_doc: "Technical requirements"
|
||||
- architecture_doc: "Current architecture (if brownfield)"
|
||||
- constraints_list: "Technical constraints"
|
||||
deep_prompt:
|
||||
- research_question: "Initial research question or topic"
|
||||
- context_docs: "Background documents for context"
|
||||
|
||||
# Claude Code integration points
|
||||
claude_code_enhancements:
|
||||
- injection_point: "research-subagents"
|
||||
- available_subagents:
|
||||
- market-researcher: "Deep market intelligence gathering"
|
||||
- trend-spotter: "Emerging trends and weak signals"
|
||||
- data-analyst: "Quantitative analysis"
|
||||
- competitor-analyzer: "Competitive intelligence"
|
||||
- user-researcher: "Customer insights"
|
||||
- technical-evaluator: "Technology assessment"
|
||||
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: true # Can run research tasks in parallel
|
||||
|
||||
# Research frameworks available (context dependent)
|
||||
frameworks:
|
||||
market:
|
||||
- "TAM/SAM/SOM Analysis"
|
||||
- "Porter's Five Forces"
|
||||
- "Jobs-to-be-Done"
|
||||
- "Technology Adoption Lifecycle"
|
||||
- "SWOT Analysis"
|
||||
- "Value Chain Analysis"
|
||||
technical:
|
||||
- "Trade-off Analysis"
|
||||
- "Architecture Decision Records (ADR)"
|
||||
- "Technology Radar"
|
||||
- "Comparison Matrix"
|
||||
- "Cost-Benefit Analysis"
|
||||
deep_prompt:
|
||||
- "ChatGPT Deep Research Best Practices"
|
||||
- "Gemini Deep Research Framework"
|
||||
- "Grok DeepSearch Optimization"
|
||||
- "Claude Projects Methodology"
|
||||
- "Iterative Prompt Refinement"
|
||||
|
||||
# Data sources (for web research)
|
||||
data_sources:
|
||||
- "Industry reports and publications"
|
||||
- "Government statistics and databases"
|
||||
- "Financial reports and SEC filings"
|
||||
- "News articles and press releases"
|
||||
- "Academic research papers"
|
||||
- "Technical documentation and RFCs"
|
||||
- "GitHub repositories and discussions"
|
||||
- "Stack Overflow and developer forums"
|
||||
- "Market research firm reports"
|
||||
- "Social media and communities"
|
||||
- "Patent databases"
|
||||
- "Benchmarking studies"
|
||||
@@ -1,203 +0,0 @@
|
||||
# Project Planning Workflow
|
||||
|
||||
## Overview
|
||||
|
||||
Scale-adaptive project planning workflow that automatically adjusts outputs based on project scope - from single atomic changes (Level 0: tech-spec only) to enterprise platforms (Level 4: full PRD + epics). Generates appropriate planning artifacts for each level with intelligent routing and continuation support.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Scale-adaptive planning** - Automatically determines output based on project complexity
|
||||
- **Intelligent routing** - Uses router system to load appropriate instruction sets
|
||||
- **Continuation support** - Can resume from previous sessions and handle incremental work
|
||||
- **Multi-level outputs** - Supports 5 project levels (0-4) with appropriate artifacts
|
||||
- **Input integration** - Leverages product briefs and market research when available
|
||||
- **Template-driven** - Uses validated templates for consistent output structure
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Invocation
|
||||
|
||||
```bash
|
||||
workflow plan-project
|
||||
```
|
||||
|
||||
### With Input Documents
|
||||
|
||||
```bash
|
||||
# With product brief as input
|
||||
workflow plan-project --input /path/to/product-brief.md
|
||||
|
||||
# With multiple inputs
|
||||
workflow plan-project --input product-brief.md --input market-research.md
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
The workflow adapts automatically based on project assessment, but key configuration options include:
|
||||
|
||||
- **scale_parameters**: Defines story/epic counts for each project level
|
||||
- **output_folder**: Where all generated documents are stored
|
||||
- **project_name**: Used in document names and templates
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Files Included
|
||||
|
||||
```
|
||||
plan-project/
|
||||
├── workflow.yaml # Configuration and metadata
|
||||
├── instructions-router.md # Initial assessment and routing logic
|
||||
├── instructions-sm.md # Level 0 instructions (tech-spec only)
|
||||
├── instructions-med.md # Level 1-2 instructions (PRD + tech-spec)
|
||||
├── instructions-lg.md # Level 3-4 instructions (full PRD + epics)
|
||||
├── analysis-template.md # Project assessment template
|
||||
├── prd-template.md # Product Requirements Document template
|
||||
├── tech-spec-template.md # Technical Specification template
|
||||
├── epics-template.md # Epic breakdown template
|
||||
├── checklist.md # Validation criteria
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Workflow Process
|
||||
|
||||
### Phase 1: Assessment and Routing (Steps 1-5)
|
||||
|
||||
- **Project Analysis**: Determines project type (greenfield/brownfield/legacy)
|
||||
- **Scope Assessment**: Classifies into 5 levels based on complexity
|
||||
- **Document Discovery**: Identifies existing inputs and documentation
|
||||
- **Workflow Routing**: Loads appropriate instruction set based on level
|
||||
- **Continuation Handling**: Resumes from previous work when applicable
|
||||
|
||||
### Phase 2: Level-Specific Planning (Steps vary by level)
|
||||
|
||||
**Level 0 (Single Atomic Change)**:
|
||||
|
||||
- Creates technical specification only
|
||||
- Focuses on implementation details for small changes
|
||||
|
||||
**Level 1-2 (Features and Small Systems)**:
|
||||
|
||||
- Generates minimal PRD with core sections
|
||||
- Creates comprehensive tech-spec
|
||||
- Includes basic epic breakdown
|
||||
|
||||
**Level 3-4 (Full Products and Platforms)**:
|
||||
|
||||
- Produces complete PRD with all sections
|
||||
- Generates detailed epic breakdown
|
||||
- Includes architect handoff materials
|
||||
- Creates traceability mapping
|
||||
|
||||
### Phase 3: Validation and Handoff (Final steps)
|
||||
|
||||
- **Document Review**: Validates outputs against checklists
|
||||
- **Architect Preparation**: For Level 3-4, prepares handoff materials
|
||||
- **Next Steps**: Provides guidance for development phase
|
||||
|
||||
## Output
|
||||
|
||||
### Generated Files
|
||||
|
||||
- **Primary output**: PRD.md (except Level 0), tech-spec.md, project-workflow-analysis.md
|
||||
- **Supporting files**: epics.md (Level 3-4), PRD-validation-report.md (if validation run)
|
||||
|
||||
### Output Structure by Level
|
||||
|
||||
**Level 0 - Tech Spec Only**:
|
||||
|
||||
1. **Technical Overview** - Implementation approach
|
||||
2. **Detailed Design** - Code-level specifications
|
||||
3. **Testing Strategy** - Validation approach
|
||||
|
||||
**Level 1-2 - Minimal PRD + Tech Spec**:
|
||||
|
||||
1. **Problem Statement** - Core issue definition
|
||||
2. **Solution Overview** - High-level approach
|
||||
3. **Requirements** - Functional and non-functional
|
||||
4. **Technical Specification** - Implementation details
|
||||
5. **Success Criteria** - Acceptance criteria
|
||||
|
||||
**Level 3-4 - Full PRD + Epics**:
|
||||
|
||||
1. **Executive Summary** - Project overview
|
||||
2. **Problem Definition** - Detailed problem analysis
|
||||
3. **Solution Architecture** - Comprehensive solution design
|
||||
4. **User Experience** - Journey mapping and wireframes
|
||||
5. **Requirements** - Complete functional/non-functional specs
|
||||
6. **Epic Breakdown** - Development phases and stories
|
||||
7. **Technical Handoff** - Architecture and implementation guidance
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Input Documents**: Product brief and/or market research (recommended but not required)
|
||||
- **Project Configuration**: Valid config.yaml with project_name and output_folder
|
||||
- **Assessment Readiness**: Clear understanding of project scope and objectives
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Before Starting
|
||||
|
||||
1. **Gather Context**: Collect any existing product briefs, market research, or requirements
|
||||
2. **Define Scope**: Have a clear sense of project boundaries and complexity
|
||||
3. **Prepare Stakeholders**: Ensure key stakeholders are available for input if needed
|
||||
|
||||
### During Execution
|
||||
|
||||
1. **Be Honest About Scope**: Accurate assessment ensures appropriate planning depth
|
||||
2. **Leverage Existing Work**: Reference previous documents and avoid duplication
|
||||
3. **Think Incrementally**: Remember that planning can evolve - start with what you know
|
||||
|
||||
### After Completion
|
||||
|
||||
1. **Validate Against Checklist**: Use included validation criteria to ensure completeness
|
||||
2. **Share with Stakeholders**: Distribute appropriate documents to relevant team members
|
||||
3. **Prepare for Architecture**: For Level 3-4 projects, ensure architect has complete context
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Issue**: Workflow creates wrong level of documentation
|
||||
|
||||
- **Solution**: Review project assessment and restart with correct scope classification
|
||||
- **Check**: Verify the project-workflow-analysis.md reflects actual project complexity
|
||||
|
||||
**Issue**: Missing input documents cause incomplete planning
|
||||
|
||||
- **Solution**: Gather recommended inputs or proceed with manual context gathering
|
||||
- **Check**: Ensure critical business context is captured even without formal documents
|
||||
|
||||
**Issue**: Continuation from previous session fails
|
||||
|
||||
- **Solution**: Check for existing project-workflow-analysis.md and ensure output folder is correct
|
||||
- **Check**: Verify previous session completed at a valid checkpoint
|
||||
|
||||
## Customization
|
||||
|
||||
To customize this workflow:
|
||||
|
||||
1. **Modify Assessment Logic**: Update instructions-router.md to adjust level classification
|
||||
2. **Adjust Templates**: Customize PRD, tech-spec, or epic templates for organizational needs
|
||||
3. **Add Validation**: Extend checklist.md with organization-specific quality criteria
|
||||
4. **Configure Outputs**: Modify workflow.yaml to change file naming or structure
|
||||
|
||||
## Version History
|
||||
|
||||
- **v6.0.0** - Scale-adaptive architecture with intelligent routing
|
||||
- Multi-level project support (0-4)
|
||||
- Continuation and resumption capabilities
|
||||
- Template-driven output generation
|
||||
- Input document integration
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Validate output using `checklist.md`
|
||||
- Consult project assessment in `project-workflow-analysis.md`
|
||||
- Check continuation status in existing output documents
|
||||
|
||||
---
|
||||
|
||||
_Part of the BMad Method v6 - BMM (Method) Module_
|
||||
@@ -1,369 +0,0 @@
|
||||
# Project Planning Validation Checklist (Adaptive: All Levels)
|
||||
|
||||
**Scope**: This checklist adapts based on project level (0-4) and field type (greenfield/brownfield)
|
||||
|
||||
- **Level 0**: Tech-spec only validation
|
||||
- **Level 1-2**: PRD + Tech-spec + Epics validation
|
||||
- **Level 3-4**: PRD + Epics validation (no tech-spec)
|
||||
- **Greenfield**: Focus on setup sequencing and dependencies
|
||||
- **Brownfield**: Focus on integration risks and backward compatibility
|
||||
|
||||
## User Intent Validation (Critical First Check)
|
||||
|
||||
### Input Sources and User Need
|
||||
|
||||
- [ ] Product brief or initial context was properly gathered (not just project name)
|
||||
- [ ] User's actual problem/need was identified through conversation (not assumed)
|
||||
- [ ] Technical preferences mentioned by user were captured separately
|
||||
- [ ] User confirmed the description accurately reflects their vision
|
||||
- [ ] The PRD addresses what the user asked for, not what we think they need
|
||||
|
||||
### Alignment with User Goals
|
||||
|
||||
- [ ] Goals directly address the user's stated problem
|
||||
- [ ] Context reflects actual user-provided information (not invented)
|
||||
- [ ] Requirements map to explicit user needs discussed
|
||||
- [ ] Nothing critical the user mentioned is missing
|
||||
|
||||
## Document Structure
|
||||
|
||||
- [ ] All required sections are present
|
||||
- [ ] No placeholder text remains (all {{variables}} replaced)
|
||||
- [ ] Proper formatting and organization throughout
|
||||
|
||||
## Section 1: Description
|
||||
|
||||
- [ ] Clear, concise description of what's being built
|
||||
- [ ] Matches user's actual request (not extrapolated)
|
||||
- [ ] Sets proper scope and expectations
|
||||
|
||||
## Section 2: Goals (Step 2)
|
||||
|
||||
- [ ] Level 3: Contains 3-5 primary goals
|
||||
- [ ] Level 4: Contains 5-7 strategic goals
|
||||
- [ ] Each goal is specific and measurable where possible
|
||||
- [ ] Goals focus on user and project outcomes
|
||||
- [ ] Goals represent what success looks like
|
||||
- [ ] Strategic objectives align with product scale
|
||||
|
||||
## Section 3: Context (Step 3)
|
||||
|
||||
- [ ] 1-2 short paragraphs explaining why this matters now
|
||||
- [ ] Context was gathered from user (not invented)
|
||||
- [ ] Explains actual problem being solved
|
||||
- [ ] Describes current situation or pain point
|
||||
- [ ] Connects to real-world impact
|
||||
|
||||
## Section 4: Functional Requirements (Step 4)
|
||||
|
||||
- [ ] Level 3: Contains 12-20 FRs
|
||||
- [ ] Level 4: Contains 20-30 FRs
|
||||
- [ ] Each has unique FR identifier (FR001, FR002, etc.)
|
||||
- [ ] Requirements describe capabilities, not implementation
|
||||
- [ ] Related features grouped logically while maintaining granularity
|
||||
- [ ] All FRs are testable user actions
|
||||
- [ ] User provided feedback on proposed FRs
|
||||
- [ ] Missing capabilities user expected were added
|
||||
- [ ] Priority order reflects user input
|
||||
- [ ] Coverage comprehensive for target product scale
|
||||
|
||||
## Section 5: Non-Functional Requirements (Step 5 - Optional)
|
||||
|
||||
- [ ] Only included if truly needed (not arbitrary targets)
|
||||
- [ ] Each has unique NFR identifier
|
||||
- [ ] Business justification provided for each NFR
|
||||
- [ ] Compliance requirements noted if regulated industry
|
||||
- [ ] Performance constraints tied to business needs
|
||||
- [ ] Typically 0-5 for MVP (not invented)
|
||||
|
||||
## Section 6: User Journeys (Step 6)
|
||||
|
||||
- [ ] Level 3: 2-3 detailed user journeys documented
|
||||
- [ ] Level 4: 3-5 comprehensive journeys for major segments
|
||||
- [ ] Each journey has named persona with context
|
||||
- [ ] Journey shows complete path through system via FRs
|
||||
- [ ] Specific FR references included (e.g., "signs up (FR001)")
|
||||
- [ ] Success criteria and pain points identified
|
||||
- [ ] Edge cases and alternative paths considered
|
||||
- [ ] Journeys validate comprehensive value delivery
|
||||
|
||||
## Section 7: UX Principles (Step 7 - Optional)
|
||||
|
||||
- [ ] Target users and sophistication level defined
|
||||
- [ ] Design values stated (simple vs powerful, playful vs professional)
|
||||
- [ ] Platform strategy specified (mobile-first, web, native)
|
||||
- [ ] Accessibility requirements noted if applicable
|
||||
- [ ] Sets direction without prescribing specific solutions
|
||||
|
||||
## Section 8: Epics (Step 8)
|
||||
|
||||
- [ ] Level 3: 3-5 epics defined (targeting 12-40 stories)
|
||||
- [ ] Level 4: 5-8 epics defined (targeting 40+ stories)
|
||||
- [ ] Each epic represents significant, deployable functionality
|
||||
- [ ] Epic format includes: Title, Goal, Capabilities, Success Criteria, Dependencies
|
||||
- [ ] Related FRs grouped into coherent capabilities
|
||||
- [ ] Each epic references specific FR numbers
|
||||
- [ ] Post-MVP epics listed separately with their FRs
|
||||
- [ ] Dependencies between epics clearly noted
|
||||
- [ ] Phased delivery strategy apparent
|
||||
|
||||
## Section 9: Out of Scope (Step 9)
|
||||
|
||||
- [ ] Ideas preserved with FR/NFR references
|
||||
- [ ] Format: description followed by (FR###, NFR###)
|
||||
- [ ] Prevents scope creep while capturing future possibilities
|
||||
- [ ] Clear distinction from MVP scope
|
||||
|
||||
## Section 10: Assumptions and Dependencies (Step 10)
|
||||
|
||||
- [ ] Only ACTUAL assumptions from user discussion (not invented)
|
||||
- [ ] Technical choices user explicitly mentioned captured
|
||||
- [ ] Dependencies identified in FRs/NFRs listed
|
||||
- [ ] User-stated constraints documented
|
||||
- [ ] If none exist, states "No critical assumptions identified yet"
|
||||
|
||||
## Cross-References and Consistency
|
||||
|
||||
- [ ] All FRs trace back to at least one goal
|
||||
- [ ] User journeys reference actual FR numbers
|
||||
- [ ] Epic capabilities cover all FRs
|
||||
- [ ] Terminology consistent throughout
|
||||
- [ ] No contradictions between sections
|
||||
- [ ] Technical details saved to technical_preferences (not in PRD)
|
||||
|
||||
## Quality Checks
|
||||
|
||||
- [ ] Requirements are strategic, not implementation-focused
|
||||
- [ ] Document maintains appropriate abstraction level
|
||||
- [ ] No premature technical decisions
|
||||
- [ ] Focus on WHAT, not HOW
|
||||
|
||||
## Readiness for Next Phase
|
||||
|
||||
- [ ] Sufficient detail for comprehensive architecture design
|
||||
- [ ] Clear enough for detailed solution design
|
||||
- [ ] Ready for epic breakdown into 12-40+ stories
|
||||
- [ ] Value delivery path supports phased releases
|
||||
- [ ] If UI exists, ready for UX expert collaboration
|
||||
- [ ] Scale and complexity match Level 3-4 requirements
|
||||
|
||||
## Scale Validation
|
||||
|
||||
- [ ] Project scope justifies PRD
|
||||
- [ ] Complexity matches Level 1-4 designation
|
||||
- [ ] Story estimate aligns with epic structure (12-40+)
|
||||
- [ ] Not over-engineered for actual needs
|
||||
|
||||
## Final Validation
|
||||
|
||||
- [ ] Document addresses user's original request completely
|
||||
- [ ] All user feedback incorporated
|
||||
- [ ] No critical user requirements missing
|
||||
- [ ] Ready for user final review and approval
|
||||
- [ ] File saved in correct location: {{output_folder}}/PRD.md
|
||||
|
||||
---
|
||||
|
||||
# Cohesion Validation (All Levels)
|
||||
|
||||
**Purpose**: Validate alignment between planning artifacts and readiness for implementation
|
||||
|
||||
## Project Context Detection
|
||||
|
||||
- [ ] Project level confirmed (0, 1, 2, 3, or 4)
|
||||
- [ ] Field type identified (greenfield or brownfield)
|
||||
- [ ] Appropriate validation sections applied based on context
|
||||
|
||||
## Section A: Tech Spec Validation (Levels 0, 1, 2 only)
|
||||
|
||||
### A.1 Tech Spec Completeness
|
||||
|
||||
- [ ] All technical decisions are DEFINITIVE (no "Option A or B")
|
||||
- [ ] Specific versions specified for all frameworks/libraries
|
||||
- [ ] Source tree structure clearly defined
|
||||
- [ ] Technical approach precisely described
|
||||
- [ ] Implementation stack complete with exact tools
|
||||
- [ ] Testing approach clearly defined
|
||||
- [ ] Deployment strategy documented
|
||||
|
||||
### A.2 Tech Spec - PRD Alignment (Levels 1-2 only)
|
||||
|
||||
- [ ] Every functional requirement has technical solution
|
||||
- [ ] Non-functional requirements addressed in tech spec
|
||||
- [ ] Tech stack aligns with PRD constraints
|
||||
- [ ] Performance requirements achievable with chosen stack
|
||||
- [ ] Technical preferences from user incorporated
|
||||
|
||||
## Section B: Greenfield-Specific Validation (if greenfield)
|
||||
|
||||
### B.1 Project Setup Sequencing
|
||||
|
||||
- [ ] Epic 0 or 1 includes project initialization steps
|
||||
- [ ] Repository setup precedes feature development
|
||||
- [ ] Development environment configuration included early
|
||||
- [ ] Core dependencies installed before use
|
||||
- [ ] Testing infrastructure set up before tests written
|
||||
|
||||
### B.2 Infrastructure Before Features
|
||||
|
||||
- [ ] Database setup before data operations
|
||||
- [ ] API framework before endpoint implementation
|
||||
- [ ] Authentication setup before protected features
|
||||
- [ ] CI/CD pipeline before deployment
|
||||
- [ ] Monitoring setup included
|
||||
|
||||
### B.3 External Dependencies
|
||||
|
||||
- [ ] Third-party account creation assigned to user
|
||||
- [ ] API keys acquisition process defined
|
||||
- [ ] Credential storage approach specified
|
||||
- [ ] External service setup sequenced properly
|
||||
- [ ] Fallback strategies for external failures
|
||||
|
||||
## Section C: Brownfield-Specific Validation (if brownfield)
|
||||
|
||||
### C.1 Existing System Integration
|
||||
|
||||
- [ ] Current architecture analyzed and documented
|
||||
- [ ] Integration points with existing system identified
|
||||
- [ ] Existing functionality preservation validated
|
||||
- [ ] Database schema compatibility assessed
|
||||
- [ ] API contract compatibility verified
|
||||
|
||||
### C.2 Risk Management
|
||||
|
||||
- [ ] Breaking change risks identified and mitigated
|
||||
- [ ] Rollback procedures defined for each integration
|
||||
- [ ] Feature flags or toggles included where appropriate
|
||||
- [ ] Performance degradation risks assessed
|
||||
- [ ] User impact analysis completed
|
||||
|
||||
### C.3 Backward Compatibility
|
||||
|
||||
- [ ] Database migrations maintain backward compatibility
|
||||
- [ ] API changes don't break existing consumers
|
||||
- [ ] Authentication/authorization integration safe
|
||||
- [ ] Configuration changes non-breaking
|
||||
- [ ] Existing monitoring preserved or enhanced
|
||||
|
||||
### C.4 Dependency Conflicts
|
||||
|
||||
- [ ] New dependencies compatible with existing versions
|
||||
- [ ] No version conflicts introduced
|
||||
- [ ] Security vulnerabilities not introduced
|
||||
- [ ] License compatibility verified
|
||||
- [ ] Bundle size impact acceptable
|
||||
|
||||
## Section D: Feature Sequencing (All Levels)
|
||||
|
||||
### D.1 Functional Dependencies
|
||||
|
||||
- [ ] Features depending on others sequenced correctly
|
||||
- [ ] Shared components built before consumers
|
||||
- [ ] User flows follow logical progression
|
||||
- [ ] Authentication precedes protected features
|
||||
|
||||
### D.2 Technical Dependencies
|
||||
|
||||
- [ ] Lower-level services before higher-level ones
|
||||
- [ ] Utilities and libraries created before use
|
||||
- [ ] Data models defined before operations
|
||||
- [ ] API endpoints before client consumption
|
||||
|
||||
### D.3 Epic Dependencies
|
||||
|
||||
- [ ] Later epics build on earlier epic functionality
|
||||
- [ ] No circular dependencies between epics
|
||||
- [ ] Infrastructure from early epics reused
|
||||
- [ ] Incremental value delivery maintained
|
||||
|
||||
## Section E: UI/UX Cohesion (if UI components exist)
|
||||
|
||||
### E.1 Design System (Greenfield)
|
||||
|
||||
- [ ] UI framework selected and installed early
|
||||
- [ ] Design system or component library established
|
||||
- [ ] Styling approach defined
|
||||
- [ ] Responsive design strategy clear
|
||||
- [ ] Accessibility requirements defined
|
||||
|
||||
### E.2 Design Consistency (Brownfield)
|
||||
|
||||
- [ ] UI consistent with existing system
|
||||
- [ ] Component library updates non-breaking
|
||||
- [ ] Styling approach matches existing
|
||||
- [ ] Accessibility standards maintained
|
||||
- [ ] Existing user workflows preserved
|
||||
|
||||
### E.3 UX Flow Validation
|
||||
|
||||
- [ ] User journeys mapped completely
|
||||
- [ ] Navigation patterns defined
|
||||
- [ ] Error and loading states planned
|
||||
- [ ] Form validation patterns established
|
||||
|
||||
## Section F: Responsibility Assignment (All Levels)
|
||||
|
||||
### F.1 User vs Agent Clarity
|
||||
|
||||
- [ ] Human-only tasks assigned to user
|
||||
- [ ] Account creation on external services → user
|
||||
- [ ] Payment/purchasing actions → user
|
||||
- [ ] All code tasks → developer agent
|
||||
- [ ] Configuration management properly assigned
|
||||
|
||||
## Section G: Documentation Readiness (All Levels)
|
||||
|
||||
### G.1 Developer Documentation
|
||||
|
||||
- [ ] Setup instructions comprehensive
|
||||
- [ ] Technical decisions documented
|
||||
- [ ] Patterns and conventions clear
|
||||
- [ ] API documentation plan exists (if applicable)
|
||||
|
||||
### G.2 Deployment Documentation (Brownfield)
|
||||
|
||||
- [ ] Runbook updates planned
|
||||
- [ ] Incident response procedures updated
|
||||
- [ ] Rollback procedures documented and tested
|
||||
- [ ] Monitoring dashboard updates planned
|
||||
|
||||
## Section H: Future-Proofing (All Levels)
|
||||
|
||||
### H.1 Extensibility
|
||||
|
||||
- [ ] Current scope vs future features clearly separated
|
||||
- [ ] Architecture supports planned enhancements
|
||||
- [ ] Technical debt considerations documented
|
||||
- [ ] Extensibility points identified
|
||||
|
||||
### H.2 Observability
|
||||
|
||||
- [ ] Monitoring strategy defined
|
||||
- [ ] Success metrics from planning captured
|
||||
- [ ] Analytics or tracking included if needed
|
||||
- [ ] Performance measurement approach clear
|
||||
|
||||
## Cohesion Summary
|
||||
|
||||
### Overall Readiness Assessment
|
||||
|
||||
- [ ] **Ready for Development** - All critical items pass
|
||||
- [ ] **Needs Alignment** - Some gaps need addressing
|
||||
- [ ] **Too Risky** (brownfield only) - Integration risks too high
|
||||
|
||||
### Critical Gaps Identified
|
||||
|
||||
_List any blocking issues or unacceptable risks:_
|
||||
|
||||
### Integration Risk Level (brownfield only)
|
||||
|
||||
- [ ] Low - well-understood integration with good rollback
|
||||
- [ ] Medium - some unknowns but manageable
|
||||
- [ ] High - significant risks require mitigation
|
||||
|
||||
### Recommendations
|
||||
|
||||
_Specific actions to improve cohesion before development:_
|
||||
|
||||
---
|
||||
@@ -1,222 +0,0 @@
|
||||
# Game Design Document (GDD) Workflow
|
||||
|
||||
This folder contains the GDD workflow for game projects, replacing the traditional PRD approach with game-specific documentation.
|
||||
|
||||
## Overview
|
||||
|
||||
The GDD workflow creates a comprehensive Game Design Document that captures:
|
||||
|
||||
- Core gameplay mechanics and pillars
|
||||
- Game type-specific elements (RPG systems, platformer movement, puzzle mechanics, etc.)
|
||||
- Level design framework
|
||||
- Art and audio direction
|
||||
- Technical specifications (platform-agnostic)
|
||||
- Development epics
|
||||
|
||||
## Architecture
|
||||
|
||||
### Universal Template
|
||||
|
||||
`gdd-template.md` contains sections common to ALL game types:
|
||||
|
||||
- Executive Summary
|
||||
- Goals and Context
|
||||
- Core Gameplay
|
||||
- Win/Loss Conditions
|
||||
- Progression and Balance
|
||||
- Level Design Framework
|
||||
- Art and Audio Direction
|
||||
- Technical Specs
|
||||
- Development Epics
|
||||
- Success Metrics
|
||||
|
||||
### Game-Type-Specific Injection
|
||||
|
||||
The template includes a `{{GAME_TYPE_SPECIFIC_SECTIONS}}` placeholder that gets replaced with game-type-specific content.
|
||||
|
||||
### Game Types Registry
|
||||
|
||||
`game-types.csv` defines 24+ game types with:
|
||||
|
||||
- **id**: Unique identifier (e.g., `action-platformer`, `rpg`, `roguelike`)
|
||||
- **name**: Human-readable name
|
||||
- **description**: Brief description of the game type
|
||||
- **genre_tags**: Searchable tags
|
||||
- **fragment_file**: Path to type-specific template fragment
|
||||
|
||||
### Game-Type Fragments
|
||||
|
||||
Located in `game-types/` folder, these markdown files contain sections specific to each game type:
|
||||
|
||||
**action-platformer.md**:
|
||||
|
||||
- Movement System (jump mechanics, air control, special moves)
|
||||
- Combat System (attack types, combos, enemy AI)
|
||||
- Level Design Patterns (platforming challenges, combat arenas)
|
||||
- Player Abilities and Unlocks
|
||||
|
||||
**rpg.md**:
|
||||
|
||||
- Character System (stats, classes, leveling)
|
||||
- Inventory and Equipment
|
||||
- Quest System
|
||||
- World and Exploration
|
||||
- NPC and Dialogue
|
||||
- Combat System
|
||||
|
||||
**puzzle.md**:
|
||||
|
||||
- Core Puzzle Mechanics
|
||||
- Puzzle Progression
|
||||
- Level Structure
|
||||
- Player Assistance
|
||||
- Replayability
|
||||
|
||||
**roguelike.md**:
|
||||
|
||||
- Run Structure
|
||||
- Procedural Generation
|
||||
- Permadeath and Progression
|
||||
- Item and Upgrade System
|
||||
- Character Selection
|
||||
- Difficulty Modifiers
|
||||
|
||||
...and 20+ more game types!
|
||||
|
||||
## Workflow Flow
|
||||
|
||||
1. **Router Detection** (instructions-router.md):
|
||||
- Step 3 asks for project type
|
||||
- If "Game" selected → sets `workflow_type = "gdd"`
|
||||
- Skips standard level classification
|
||||
- Jumps to GDD-specific assessment
|
||||
|
||||
2. **Game Type Selection** (instructions-gdd.md Step 1):
|
||||
- Presents 9 common game types + "Other"
|
||||
- Maps selection to `game-types.csv`
|
||||
- Loads corresponding fragment file
|
||||
- Stores `game_type` for injection
|
||||
|
||||
3. **Universal GDD Sections** (Steps 2-5, 7-13):
|
||||
- Platform and target audience
|
||||
- Goals and context
|
||||
- Core gameplay (pillars, loop, win/loss)
|
||||
- Mechanics and controls
|
||||
- Progression and balance
|
||||
- Level design
|
||||
- Art and audio
|
||||
- Technical specs
|
||||
- Epics and metrics
|
||||
|
||||
4. **Game-Type Injection** (Step 6):
|
||||
- Loads fragment from `game-types/{game_type}.md`
|
||||
- For each `{{placeholder}}` in fragment, elicits details
|
||||
- Injects completed sections into `{{GAME_TYPE_SPECIFIC_SECTIONS}}`
|
||||
|
||||
5. **Solutioning Handoff** (Step 14):
|
||||
- Routes to `3-solutioning` workflow
|
||||
- Platform/engine specifics handled by solutioning registry
|
||||
- Game-\* entries in solutioning `registry.csv` provide engine-specific guidance
|
||||
|
||||
## Platform vs. Game Type Separation
|
||||
|
||||
**GDD (this workflow)**: Game-type specifics
|
||||
|
||||
- What makes an RPG an RPG (stats, quests, inventory)
|
||||
- What makes a platformer a platformer (jump mechanics, level design)
|
||||
- Genre-defining mechanics and systems
|
||||
|
||||
**Solutioning (3-solutioning workflow)**: Platform/engine specifics
|
||||
|
||||
- Unity vs. Godot vs. Phaser vs. Unreal
|
||||
- 2D vs. 3D rendering
|
||||
- Physics engines
|
||||
- Input systems
|
||||
- Platform constraints (mobile, web, console)
|
||||
|
||||
This separation allows:
|
||||
|
||||
- Single universal GDD regardless of platform
|
||||
- Platform decisions made during architecture phase
|
||||
- Easy platform pivots without rewriting GDD
|
||||
|
||||
## Output
|
||||
|
||||
**GDD.md**: Complete game design document with:
|
||||
|
||||
- All universal sections filled
|
||||
- Game-type-specific sections injected
|
||||
- Ready for solutioning handoff
|
||||
|
||||
## Example Game Types
|
||||
|
||||
| ID | Name | Key Sections |
|
||||
| ----------------- | ----------------- | ------------------------------------------------- |
|
||||
| action-platformer | Action Platformer | Movement, Combat, Level Patterns, Abilities |
|
||||
| rpg | RPG | Character System, Inventory, Quests, World, NPCs |
|
||||
| puzzle | Puzzle | Puzzle Mechanics, Progression, Level Structure |
|
||||
| roguelike | Roguelike | Run Structure, Procgen, Permadeath, Items |
|
||||
| shooter | Shooter | Weapon Systems, Enemy AI, Arena Design |
|
||||
| strategy | Strategy | Resources, Units, AI, Victory Conditions |
|
||||
| metroidvania | Metroidvania | Interconnected World, Ability Gating, Exploration |
|
||||
| visual-novel | Visual Novel | Branching Story, Dialogue Trees, Choices |
|
||||
| tower-defense | Tower Defense | Waves, Tower Types, Placement, Economy |
|
||||
| card-game | Card Game | Deck Building, Card Mechanics, Turn System |
|
||||
|
||||
...and 14+ more!
|
||||
|
||||
## Adding New Game Types
|
||||
|
||||
1. Add row to `game-types.csv`:
|
||||
|
||||
```csv
|
||||
new-type,New Type Name,"Description",tags,new-type.md
|
||||
```
|
||||
|
||||
2. Create `game-types/new-type.md`:
|
||||
|
||||
```markdown
|
||||
## New Type Specific Elements
|
||||
|
||||
### System Name
|
||||
|
||||
{{system_placeholder}}
|
||||
|
||||
**Details:**
|
||||
|
||||
- Element 1
|
||||
- Element 2
|
||||
```
|
||||
|
||||
3. The workflow automatically uses it!
|
||||
|
||||
## Integration with Solutioning
|
||||
|
||||
When a game project completes the GDD and moves to solutioning:
|
||||
|
||||
1. Solutioning workflow reads `project_type == "game"`
|
||||
2. Loads GDD.md instead of PRD.md
|
||||
3. Matches game platforms to solutioning `registry.csv` game-\* entries
|
||||
4. Provides engine-specific guidance (Unity, Godot, Phaser, etc.)
|
||||
5. Generates solution-architecture.md with platform decisions
|
||||
6. Creates per-epic tech specs
|
||||
|
||||
Example solutioning registry entries:
|
||||
|
||||
- `game-unity-2d`: Unity 2D games
|
||||
- `game-godot-3d`: Godot 3D games
|
||||
- `game-phaser`: Phaser web games
|
||||
- `game-unreal-3d`: Unreal Engine games
|
||||
- `game-custom-3d-rust`: Custom Rust game engines
|
||||
|
||||
## Philosophy
|
||||
|
||||
**Game projects are fundamentally different from software products**:
|
||||
|
||||
- Gameplay feel > feature lists
|
||||
- Playtesting > user testing
|
||||
- Game pillars > product goals
|
||||
- Mechanics > requirements
|
||||
- Fun > utility
|
||||
|
||||
The GDD workflow respects these differences while maintaining BMAD Method rigor.
|
||||
@@ -1,25 +0,0 @@
|
||||
id,name,description,genre_tags,fragment_file
|
||||
action-platformer,Action Platformer,"Side-scrolling or 3D platforming with combat mechanics","action,platformer,combat,movement",action-platformer.md
|
||||
puzzle,Puzzle,"Logic-based challenges and problem-solving","puzzle,logic,cerebral",puzzle.md
|
||||
rpg,RPG,"Character progression, stats, inventory, quests","rpg,stats,inventory,quests,narrative",rpg.md
|
||||
strategy,Strategy,"Resource management, tactical decisions, long-term planning","strategy,tactics,resources,planning",strategy.md
|
||||
shooter,Shooter,"Projectile combat, aiming mechanics, arena/level design","shooter,combat,aiming,fps,tps",shooter.md
|
||||
adventure,Adventure,"Story-driven exploration and narrative","adventure,narrative,exploration,story",adventure.md
|
||||
simulation,Simulation,"Realistic systems, management, building","simulation,management,sandbox,systems",simulation.md
|
||||
roguelike,Roguelike,"Procedural generation, permadeath, run-based progression","roguelike,procedural,permadeath,runs",roguelike.md
|
||||
moba,MOBA,"Multiplayer team battles, hero/champion selection, lanes","moba,multiplayer,pvp,heroes,lanes",moba.md
|
||||
fighting,Fighting,"1v1 combat, combos, frame data, competitive","fighting,combat,competitive,combos,pvp",fighting.md
|
||||
racing,Racing,"Vehicle control, tracks, speed, lap times","racing,vehicles,tracks,speed",racing.md
|
||||
sports,Sports,"Team-based or individual sports simulation","sports,teams,realistic,physics",sports.md
|
||||
survival,Survival,"Resource gathering, crafting, persistent threats","survival,crafting,resources,danger",survival.md
|
||||
horror,Horror,"Atmosphere, tension, limited resources, fear mechanics","horror,atmosphere,tension,fear",horror.md
|
||||
idle-incremental,Idle/Incremental,"Passive progression, upgrades, automation","idle,incremental,automation,progression",idle-incremental.md
|
||||
card-game,Card Game,"Deck building, card mechanics, turn-based strategy","card,deck-building,strategy,turns",card-game.md
|
||||
tower-defense,Tower Defense,"Wave-based defense, tower placement, resource management","tower-defense,waves,placement,strategy",tower-defense.md
|
||||
metroidvania,Metroidvania,"Interconnected world, ability gating, exploration","metroidvania,exploration,abilities,interconnected",metroidvania.md
|
||||
visual-novel,Visual Novel,"Narrative choices, branching story, dialogue","visual-novel,narrative,choices,story",visual-novel.md
|
||||
rhythm,Rhythm,"Music synchronization, timing-based gameplay","rhythm,music,timing,beats",rhythm.md
|
||||
turn-based-tactics,Turn-Based Tactics,"Grid-based movement, turn order, positioning","tactics,turn-based,grid,positioning",turn-based-tactics.md
|
||||
sandbox,Sandbox,"Creative freedom, building, minimal objectives","sandbox,creative,building,freedom",sandbox.md
|
||||
text-based,Text-Based,"Text input/output, parser or choice-based","text,parser,interactive-fiction,mud",text-based.md
|
||||
party-game,Party Game,"Local multiplayer, minigames, casual fun","party,multiplayer,minigames,casual",party-game.md
|
||||
|
@@ -1,45 +0,0 @@
|
||||
## Action Platformer Specific Elements
|
||||
|
||||
### Movement System
|
||||
|
||||
{{movement_mechanics}}
|
||||
|
||||
**Core movement abilities:**
|
||||
|
||||
- Jump mechanics (height, air control, coyote time)
|
||||
- Running/walking speed
|
||||
- Special movement (dash, wall-jump, double-jump, etc.)
|
||||
|
||||
### Combat System
|
||||
|
||||
{{combat_system}}
|
||||
|
||||
**Combat mechanics:**
|
||||
|
||||
- Attack types (melee, ranged, special)
|
||||
- Combo system
|
||||
- Enemy AI behavior patterns
|
||||
- Hit feedback and impact
|
||||
|
||||
### Level Design Patterns
|
||||
|
||||
{{level_design_patterns}}
|
||||
|
||||
**Level structure:**
|
||||
|
||||
- Platforming challenges
|
||||
- Combat arenas
|
||||
- Secret areas and collectibles
|
||||
- Checkpoint placement
|
||||
- Difficulty spikes and pacing
|
||||
|
||||
### Player Abilities and Unlocks
|
||||
|
||||
{{player_abilities}}
|
||||
|
||||
**Ability progression:**
|
||||
|
||||
- Starting abilities
|
||||
- Unlockable abilities
|
||||
- Ability synergies
|
||||
- Upgrade paths
|
||||
@@ -1,84 +0,0 @@
|
||||
## Adventure Specific Elements
|
||||
|
||||
<narrative-workflow-recommended>
|
||||
This game type is **narrative-heavy**. Consider running the Narrative Design workflow after completing the GDD to create:
|
||||
- Detailed story structure and beats
|
||||
- Character profiles and arcs
|
||||
- World lore and history
|
||||
- Dialogue framework
|
||||
- Environmental storytelling
|
||||
</narrative-workflow-recommended>
|
||||
|
||||
### Exploration Mechanics
|
||||
|
||||
{{exploration_mechanics}}
|
||||
|
||||
**Exploration design:**
|
||||
|
||||
- World structure (linear, open, hub-based, interconnected)
|
||||
- Movement and traversal
|
||||
- Observation and inspection mechanics
|
||||
- Discovery rewards (story reveals, items, secrets)
|
||||
- Pacing of exploration vs. story
|
||||
|
||||
### Story Integration
|
||||
|
||||
{{story_integration}}
|
||||
|
||||
**Narrative gameplay:**
|
||||
|
||||
- Story delivery methods (cutscenes, in-game, environmental)
|
||||
- Player agency in story (linear, branching, player-driven)
|
||||
- Story pacing (acts, beats, tension/release)
|
||||
- Character introduction and development
|
||||
- Climax and resolution structure
|
||||
|
||||
**Note:** Detailed story elements (plot, characters, lore) belong in the Narrative Design Document.
|
||||
|
||||
### Puzzle Systems
|
||||
|
||||
{{puzzle_systems}}
|
||||
|
||||
**Puzzle integration:**
|
||||
|
||||
- Puzzle types (inventory, logic, environmental, dialogue)
|
||||
- Puzzle difficulty curve
|
||||
- Hint systems
|
||||
- Puzzle-story connection (narrative purpose)
|
||||
- Optional vs. required puzzles
|
||||
|
||||
### Character Interaction
|
||||
|
||||
{{character_interaction}}
|
||||
|
||||
**NPC systems:**
|
||||
|
||||
- Dialogue system (branching, linear, choice-based)
|
||||
- Character relationships
|
||||
- NPC schedules/behaviors
|
||||
- Companion mechanics (if applicable)
|
||||
- Memorable character moments
|
||||
|
||||
### Inventory and Items
|
||||
|
||||
{{inventory_items}}
|
||||
|
||||
**Item systems:**
|
||||
|
||||
- Inventory scope (key items, collectibles, consumables)
|
||||
- Item examination/description
|
||||
- Combination/crafting (if applicable)
|
||||
- Story-critical items vs. optional items
|
||||
- Item-based progression gates
|
||||
|
||||
### Environmental Storytelling
|
||||
|
||||
{{environmental_storytelling}}
|
||||
|
||||
**World narrative:**
|
||||
|
||||
- Visual storytelling techniques
|
||||
- Audio atmosphere
|
||||
- Readable documents (journals, notes, signs)
|
||||
- Environmental clues
|
||||
- Show vs. tell balance
|
||||
@@ -1,76 +0,0 @@
|
||||
## Card Game Specific Elements
|
||||
|
||||
### Card Types and Effects
|
||||
|
||||
{{card_types}}
|
||||
|
||||
**Card design:**
|
||||
|
||||
- Card categories (creatures, spells, enchantments, etc.)
|
||||
- Card rarity tiers (common, rare, epic, legendary)
|
||||
- Card attributes (cost, power, health, etc.)
|
||||
- Effect types (damage, healing, draw, control, etc.)
|
||||
- Keywords and abilities
|
||||
- Card synergies
|
||||
|
||||
### Deck Building
|
||||
|
||||
{{deck_building}}
|
||||
|
||||
**Deck construction:**
|
||||
|
||||
- Deck size limits (minimum, maximum)
|
||||
- Card quantity limits (e.g., max 2 copies)
|
||||
- Class/faction restrictions
|
||||
- Deck archetypes (aggro, control, combo, midrange)
|
||||
- Sideboard mechanics (if applicable)
|
||||
- Pre-built vs. custom decks
|
||||
|
||||
### Mana/Resource System
|
||||
|
||||
{{mana_resources}}
|
||||
|
||||
**Resource mechanics:**
|
||||
|
||||
- Mana generation (per turn, from cards, etc.)
|
||||
- Mana curve design
|
||||
- Resource types (colored mana, energy, etc.)
|
||||
- Ramp mechanics
|
||||
- Resource denial strategies
|
||||
|
||||
### Turn Structure
|
||||
|
||||
{{turn_structure}}
|
||||
|
||||
**Game flow:**
|
||||
|
||||
- Turn phases (draw, main, combat, end)
|
||||
- Priority and response windows
|
||||
- Simultaneous vs. alternating turns
|
||||
- Time limits per turn
|
||||
- Match length targets
|
||||
|
||||
### Card Collection and Progression
|
||||
|
||||
{{collection_progression}}
|
||||
|
||||
**Player progression:**
|
||||
|
||||
- Card acquisition (packs, rewards, crafting)
|
||||
- Deck unlocks
|
||||
- Currency systems (gold, dust, wildcards)
|
||||
- Free-to-play balance
|
||||
- Collection completion incentives
|
||||
|
||||
### Game Modes
|
||||
|
||||
{{game_modes}}
|
||||
|
||||
**Mode variety:**
|
||||
|
||||
- Ranked ladder
|
||||
- Draft/Arena modes
|
||||
- Campaign/story mode
|
||||
- Casual/unranked
|
||||
- Special event modes
|
||||
- Tournament formats
|
||||
@@ -1,89 +0,0 @@
|
||||
## Fighting Game Specific Elements
|
||||
|
||||
### Character Roster
|
||||
|
||||
{{character_roster}}
|
||||
|
||||
**Fighter design:**
|
||||
|
||||
- Roster size (launch + planned DLC)
|
||||
- Character archetypes (rushdown, zoner, grappler, all-rounder, etc.)
|
||||
- Move list diversity
|
||||
- Complexity tiers (beginner vs. expert characters)
|
||||
- Balance philosophy (everyone viable vs. tier system)
|
||||
|
||||
### Move Lists and Frame Data
|
||||
|
||||
{{moves_frame_data}}
|
||||
|
||||
**Combat mechanics:**
|
||||
|
||||
- Normal moves (light, medium, heavy)
|
||||
- Special moves (quarter-circle, charge, etc.)
|
||||
- Super/ultimate moves
|
||||
- Frame data (startup, active, recovery, advantage)
|
||||
- Hit/hurt boxes
|
||||
- Command inputs vs. simplified inputs
|
||||
|
||||
### Combo System
|
||||
|
||||
{{combo_system}}
|
||||
|
||||
**Combo design:**
|
||||
|
||||
- Combo structure (links, cancels, chains)
|
||||
- Juggle system
|
||||
- Wall/ground bounces
|
||||
- Combo scaling
|
||||
- Reset opportunities
|
||||
- Optimal vs. practical combos
|
||||
|
||||
### Defensive Mechanics
|
||||
|
||||
{{defensive_mechanics}}
|
||||
|
||||
**Defense options:**
|
||||
|
||||
- Blocking (high, low, crossup protection)
|
||||
- Dodging/rolling/backdashing
|
||||
- Parries/counters
|
||||
- Pushblock/advancing guard
|
||||
- Invincibility frames
|
||||
- Escape options (burst, breaker, etc.)
|
||||
|
||||
### Stage Design
|
||||
|
||||
{{stage_design}}
|
||||
|
||||
**Arena design:**
|
||||
|
||||
- Stage size and boundaries
|
||||
- Wall mechanics (wall combos, wall break)
|
||||
- Interactive elements
|
||||
- Ring-out mechanics (if applicable)
|
||||
- Visual clarity vs. aesthetics
|
||||
|
||||
### Single Player Modes
|
||||
|
||||
{{single_player}}
|
||||
|
||||
**Offline content:**
|
||||
|
||||
- Arcade/story mode
|
||||
- Training mode features
|
||||
- Mission/challenge mode
|
||||
- Boss fights
|
||||
- Unlockables
|
||||
|
||||
### Competitive Features
|
||||
|
||||
{{competitive_features}}
|
||||
|
||||
**Tournament-ready:**
|
||||
|
||||
- Ranked matchmaking
|
||||
- Lobby systems
|
||||
- Replay features
|
||||
- Frame delay/rollback netcode
|
||||
- Spectator mode
|
||||
- Tournament mode
|
||||
@@ -1,86 +0,0 @@
|
||||
## Horror Game Specific Elements
|
||||
|
||||
<narrative-workflow-recommended>
|
||||
This game type is **narrative-important**. Consider running the Narrative Design workflow after completing the GDD to create:
|
||||
- Detailed story structure and scares
|
||||
- Character backstories and motivations
|
||||
- World lore and mythology
|
||||
- Environmental storytelling
|
||||
- Tension pacing and narrative beats
|
||||
</narrative-workflow-recommended>
|
||||
|
||||
### Atmosphere and Tension Building
|
||||
|
||||
{{atmosphere}}
|
||||
|
||||
**Horror atmosphere:**
|
||||
|
||||
- Visual design (lighting, shadows, color palette)
|
||||
- Audio design (soundscape, silence, music cues)
|
||||
- Environmental storytelling
|
||||
- Pacing of tension and release
|
||||
- Jump scares vs. psychological horror
|
||||
- Safe zones vs. danger zones
|
||||
|
||||
### Fear Mechanics
|
||||
|
||||
{{fear_mechanics}}
|
||||
|
||||
**Core horror systems:**
|
||||
|
||||
- Visibility/darkness mechanics
|
||||
- Limited resources (ammo, health, light)
|
||||
- Vulnerability (combat avoidance, hiding)
|
||||
- Sanity/fear meter (if applicable)
|
||||
- Pursuer/stalker mechanics
|
||||
- Detection systems (line of sight, sound)
|
||||
|
||||
### Enemy/Threat Design
|
||||
|
||||
{{enemy_threat}}
|
||||
|
||||
**Threat systems:**
|
||||
|
||||
- Enemy types (stalker, environmental, psychological)
|
||||
- Enemy behavior (patrol, hunt, ambush)
|
||||
- Telegraphing and tells
|
||||
- Invincible vs. killable enemies
|
||||
- Boss encounters
|
||||
- Encounter frequency and pacing
|
||||
|
||||
### Resource Scarcity
|
||||
|
||||
{{resource_scarcity}}
|
||||
|
||||
**Limited resources:**
|
||||
|
||||
- Ammo/weapon durability
|
||||
- Health items
|
||||
- Light sources (batteries, fuel)
|
||||
- Save points (if limited)
|
||||
- Inventory constraints
|
||||
- Risk vs. reward of exploration
|
||||
|
||||
### Safe Zones and Respite
|
||||
|
||||
{{safe_zones}}
|
||||
|
||||
**Tension management:**
|
||||
|
||||
- Safe room design
|
||||
- Save point placement
|
||||
- Temporary refuge mechanics
|
||||
- Calm before storm pacing
|
||||
- Item management areas
|
||||
|
||||
### Puzzle Integration
|
||||
|
||||
{{puzzles}}
|
||||
|
||||
**Environmental puzzles:**
|
||||
|
||||
- Puzzle types (locks, codes, environmental)
|
||||
- Difficulty balance (accessibility vs. challenge)
|
||||
- Hint systems
|
||||
- Puzzle-tension balance
|
||||
- Narrative purpose of puzzles
|
||||
@@ -1,78 +0,0 @@
|
||||
## Idle/Incremental Game Specific Elements
|
||||
|
||||
### Core Click/Interaction
|
||||
|
||||
{{core_interaction}}
|
||||
|
||||
**Primary mechanic:**
|
||||
|
||||
- Click action (what happens on click)
|
||||
- Click value progression
|
||||
- Auto-click mechanics
|
||||
- Combo/streak systems (if applicable)
|
||||
- Satisfaction and feedback (visual, audio)
|
||||
|
||||
### Upgrade Trees
|
||||
|
||||
{{upgrade_trees}}
|
||||
|
||||
**Upgrade systems:**
|
||||
|
||||
- Upgrade categories (click power, auto-generation, multipliers)
|
||||
- Upgrade costs and scaling
|
||||
- Unlock conditions
|
||||
- Synergies between upgrades
|
||||
- Upgrade branches and choices
|
||||
- Meta-upgrades (affect future runs)
|
||||
|
||||
### Automation Systems
|
||||
|
||||
{{automation}}
|
||||
|
||||
**Passive mechanics:**
|
||||
|
||||
- Auto-clicker unlocks
|
||||
- Manager/worker systems
|
||||
- Multiplier stacking
|
||||
- Offline progression
|
||||
- Automation tiers
|
||||
- Balance between active and idle play
|
||||
|
||||
### Prestige and Reset Mechanics
|
||||
|
||||
{{prestige_reset}}
|
||||
|
||||
**Long-term progression:**
|
||||
|
||||
- Prestige conditions (when to reset)
|
||||
- Persistent bonuses after reset
|
||||
- Prestige currency
|
||||
- Multiple prestige layers (if applicable)
|
||||
- Scaling between runs
|
||||
- Endgame infinite scaling
|
||||
|
||||
### Number Balancing
|
||||
|
||||
{{number_balancing}}
|
||||
|
||||
**Economy design:**
|
||||
|
||||
- Exponential growth curves
|
||||
- Notation systems (K, M, B, T or scientific)
|
||||
- Soft caps and plateaus
|
||||
- Time gates
|
||||
- Pacing of progression
|
||||
- Wall breaking mechanics
|
||||
|
||||
### Meta-Progression
|
||||
|
||||
{{meta_progression}}
|
||||
|
||||
**Long-term engagement:**
|
||||
|
||||
- Achievement system
|
||||
- Collectibles
|
||||
- Alternate game modes
|
||||
- Seasonal content
|
||||
- Challenge runs
|
||||
- Endgame goals
|
||||
@@ -1,87 +0,0 @@
|
||||
## Metroidvania Specific Elements
|
||||
|
||||
<narrative-workflow-recommended>
|
||||
This game type is **narrative-moderate**. Consider running the Narrative Design workflow after completing the GDD to create:
|
||||
- World lore and environmental storytelling
|
||||
- Character encounters and NPC arcs
|
||||
- Backstory reveals through exploration
|
||||
- Optional narrative depth
|
||||
</narrative-workflow-recommended>
|
||||
|
||||
### Interconnected World Map
|
||||
|
||||
{{world_map}}
|
||||
|
||||
**Map design:**
|
||||
|
||||
- World structure (regions, zones, biomes)
|
||||
- Interconnection points (shortcuts, elevators, warps)
|
||||
- Verticality and layering
|
||||
- Secret areas
|
||||
- Map reveal mechanics
|
||||
- Fast travel system (if applicable)
|
||||
|
||||
### Ability-Gating System
|
||||
|
||||
{{ability_gating}}
|
||||
|
||||
**Progression gates:**
|
||||
|
||||
- Core abilities (double jump, dash, wall climb, swim, etc.)
|
||||
- Ability locations and pacing
|
||||
- Soft gates vs. hard gates
|
||||
- Optional abilities
|
||||
- Sequence breaking considerations
|
||||
- Ability synergies
|
||||
|
||||
### Backtracking Design
|
||||
|
||||
{{backtracking}}
|
||||
|
||||
**Return mechanics:**
|
||||
|
||||
- Obvious backtrack opportunities
|
||||
- Hidden backtrack rewards
|
||||
- Fast travel to reduce tedium
|
||||
- Enemy respawn considerations
|
||||
- Changed world state (if applicable)
|
||||
- Completionist incentives
|
||||
|
||||
### Exploration Rewards
|
||||
|
||||
{{exploration_rewards}}
|
||||
|
||||
**Discovery incentives:**
|
||||
|
||||
- Health/energy upgrades
|
||||
- Ability upgrades
|
||||
- Collectibles (lore, cosmetics)
|
||||
- Secret bosses
|
||||
- Optional areas
|
||||
- Completion percentage tracking
|
||||
|
||||
### Combat System
|
||||
|
||||
{{combat_system}}
|
||||
|
||||
**Combat mechanics:**
|
||||
|
||||
- Attack types (melee, ranged, magic)
|
||||
- Boss fight design
|
||||
- Enemy variety and placement
|
||||
- Combat progression
|
||||
- Defensive options
|
||||
- Difficulty balance
|
||||
|
||||
### Sequence Breaking
|
||||
|
||||
{{sequence_breaking}}
|
||||
|
||||
**Advanced play:**
|
||||
|
||||
- Intended vs. unintended skips
|
||||
- Speedrun considerations
|
||||
- Difficulty of sequence breaks
|
||||
- Reward for sequence breaking
|
||||
- Developer stance on breaks
|
||||
- Game completion without all abilities
|
||||
@@ -1,74 +0,0 @@
|
||||
## MOBA Specific Elements
|
||||
|
||||
### Hero/Champion Roster
|
||||
|
||||
{{hero_roster}}
|
||||
|
||||
**Character design:**
|
||||
|
||||
- Hero count (initial roster, planned additions)
|
||||
- Hero roles (tank, support, carry, assassin, mage, etc.)
|
||||
- Unique abilities per hero (Q, W, E, R + passive)
|
||||
- Hero complexity tiers (beginner-friendly vs. advanced)
|
||||
- Visual and thematic diversity
|
||||
- Counter-pick dynamics
|
||||
|
||||
### Lane Structure and Map
|
||||
|
||||
{{lane_map}}
|
||||
|
||||
**Map design:**
|
||||
|
||||
- Lane configuration (3-lane, 2-lane, custom)
|
||||
- Jungle/neutral areas
|
||||
- Objective locations (towers, inhibitors, nexus/ancient)
|
||||
- Spawn points and fountains
|
||||
- Vision mechanics (wards, fog of war)
|
||||
|
||||
### Item and Build System
|
||||
|
||||
{{item_build}}
|
||||
|
||||
**Itemization:**
|
||||
|
||||
- Item categories (offensive, defensive, utility, consumables)
|
||||
- Gold economy
|
||||
- Build paths and item trees
|
||||
- Situational itemization
|
||||
- Starting items vs. late-game items
|
||||
|
||||
### Team Composition and Roles
|
||||
|
||||
{{team_composition}}
|
||||
|
||||
**Team strategy:**
|
||||
|
||||
- Role requirements (1-3-1, 2-1-2, etc.)
|
||||
- Team synergies
|
||||
- Draft/ban phase (if applicable)
|
||||
- Meta considerations
|
||||
- Flexible vs. rigid compositions
|
||||
|
||||
### Match Phases
|
||||
|
||||
{{match_phases}}
|
||||
|
||||
**Game flow:**
|
||||
|
||||
- Early game (laning phase)
|
||||
- Mid game (roaming, objectives)
|
||||
- Late game (team fights, sieging)
|
||||
- Phase transition mechanics
|
||||
- Comeback mechanics
|
||||
|
||||
### Objectives and Win Conditions
|
||||
|
||||
{{objectives_victory}}
|
||||
|
||||
**Strategic objectives:**
|
||||
|
||||
- Primary objective (destroy base/nexus/ancient)
|
||||
- Secondary objectives (towers, dragons, baron, roshan, etc.)
|
||||
- Neutral camps
|
||||
- Vision control objectives
|
||||
- Time limits and sudden death (if applicable)
|
||||
@@ -1,79 +0,0 @@
|
||||
## Party Game Specific Elements
|
||||
|
||||
### Minigame Variety
|
||||
|
||||
{{minigame_variety}}
|
||||
|
||||
**Minigame design:**
|
||||
|
||||
- Minigame count (launch + DLC)
|
||||
- Genre variety (racing, puzzle, reflex, trivia, etc.)
|
||||
- Minigame length (15-60 seconds typical)
|
||||
- Skill vs. luck balance
|
||||
- Team vs. FFA minigames
|
||||
- Accessibility across skill levels
|
||||
|
||||
### Turn Structure
|
||||
|
||||
{{turn_structure}}
|
||||
|
||||
**Game flow:**
|
||||
|
||||
- Board game structure (if applicable)
|
||||
- Turn order (fixed, random, earned)
|
||||
- Turn actions (roll dice, move, minigame, etc.)
|
||||
- Event spaces
|
||||
- Special mechanics (warp, steal, bonus)
|
||||
- Match length (rounds, turns, time)
|
||||
|
||||
### Player Elimination vs. Points
|
||||
|
||||
{{scoring_elimination}}
|
||||
|
||||
**Competition design:**
|
||||
|
||||
- Points-based (everyone plays to the end)
|
||||
- Elimination (last player standing)
|
||||
- Hybrid systems
|
||||
- Comeback mechanics
|
||||
- Handicap systems
|
||||
- Victory conditions
|
||||
|
||||
### Local Multiplayer UX
|
||||
|
||||
{{local_multiplayer}}
|
||||
|
||||
**Couch co-op design:**
|
||||
|
||||
- Controller sharing vs. individual controllers
|
||||
- Screen layout (split-screen, shared screen)
|
||||
- Turn clarity (whose turn indicators)
|
||||
- Spectator experience (watching others play)
|
||||
- Player join/drop mechanics
|
||||
- Tutorial integration for new players
|
||||
|
||||
### Accessibility and Skill Range
|
||||
|
||||
{{accessibility}}
|
||||
|
||||
**Inclusive design:**
|
||||
|
||||
- Skill floor (easy to understand)
|
||||
- Skill ceiling (depth for experienced players)
|
||||
- Luck elements to balance skill gaps
|
||||
- Assist modes or handicaps
|
||||
- Child-friendly content
|
||||
- Colorblind modes and accessibility
|
||||
|
||||
### Session Length
|
||||
|
||||
{{session_length}}
|
||||
|
||||
**Time management:**
|
||||
|
||||
- Quick play (5-10 minutes)
|
||||
- Standard match (15-30 minutes)
|
||||
- Extended match (30+ minutes)
|
||||
- Drop-in/drop-out support
|
||||
- Pause and resume
|
||||
- Party management (hosting, invites)
|
||||
@@ -1,58 +0,0 @@
|
||||
## Puzzle Game Specific Elements
|
||||
|
||||
### Core Puzzle Mechanics
|
||||
|
||||
{{puzzle_mechanics}}
|
||||
|
||||
**Puzzle elements:**
|
||||
|
||||
- Primary puzzle mechanic(s)
|
||||
- Supporting mechanics
|
||||
- Mechanic interactions
|
||||
- Constraint systems
|
||||
|
||||
### Puzzle Progression
|
||||
|
||||
{{puzzle_progression}}
|
||||
|
||||
**Difficulty progression:**
|
||||
|
||||
- Tutorial/introduction puzzles
|
||||
- Core concept puzzles
|
||||
- Combined mechanic puzzles
|
||||
- Expert/bonus puzzles
|
||||
- Pacing and difficulty curve
|
||||
|
||||
### Level Structure
|
||||
|
||||
{{level_structure}}
|
||||
|
||||
**Level organization:**
|
||||
|
||||
- Number of levels/puzzles
|
||||
- World/chapter grouping
|
||||
- Unlock progression
|
||||
- Optional/bonus content
|
||||
|
||||
### Player Assistance
|
||||
|
||||
{{player_assistance}}
|
||||
|
||||
**Help systems:**
|
||||
|
||||
- Hint system
|
||||
- Undo/reset mechanics
|
||||
- Skip puzzle options
|
||||
- Tutorial integration
|
||||
|
||||
### Replayability
|
||||
|
||||
{{replayability}}
|
||||
|
||||
**Replay elements:**
|
||||
|
||||
- Par time/move goals
|
||||
- Perfect solution challenges
|
||||
- Procedural generation (if applicable)
|
||||
- Daily/weekly puzzles
|
||||
- Challenge modes
|
||||
@@ -1,88 +0,0 @@
|
||||
## Racing Game Specific Elements
|
||||
|
||||
### Vehicle Handling and Physics
|
||||
|
||||
{{vehicle_physics}}
|
||||
|
||||
**Handling systems:**
|
||||
|
||||
- Physics model (arcade vs. simulation vs. hybrid)
|
||||
- Vehicle stats (speed, acceleration, handling, braking, weight)
|
||||
- Drift mechanics
|
||||
- Collision physics
|
||||
- Vehicle damage system (if applicable)
|
||||
|
||||
### Vehicle Roster
|
||||
|
||||
{{vehicle_roster}}
|
||||
|
||||
**Vehicle design:**
|
||||
|
||||
- Vehicle types (cars, bikes, boats, etc.)
|
||||
- Vehicle classes (lightweight, balanced, heavyweight)
|
||||
- Unlock progression
|
||||
- Customization options (visual, performance)
|
||||
- Balance considerations
|
||||
|
||||
### Track Design
|
||||
|
||||
{{track_design}}
|
||||
|
||||
**Course design:**
|
||||
|
||||
- Track variety (circuits, point-to-point, open world)
|
||||
- Track length and lap counts
|
||||
- Hazards and obstacles
|
||||
- Shortcuts and alternate paths
|
||||
- Track-specific mechanics
|
||||
- Environmental themes
|
||||
|
||||
### Race Mechanics
|
||||
|
||||
{{race_mechanics}}
|
||||
|
||||
**Core racing:**
|
||||
|
||||
- Starting mechanics (countdown, reaction time)
|
||||
- Checkpoint system
|
||||
- Lap tracking and position
|
||||
- Slipstreaming/drafting
|
||||
- Pit stops (if applicable)
|
||||
- Weather and time-of-day effects
|
||||
|
||||
### Powerups and Boost
|
||||
|
||||
{{powerups_boost}}
|
||||
|
||||
**Enhancement systems (if arcade-style):**
|
||||
|
||||
- Powerup types (offensive, defensive, utility)
|
||||
- Boost mechanics (drift boost, nitro, slipstream)
|
||||
- Item balance
|
||||
- Counterplay mechanics
|
||||
- Powerup placement on track
|
||||
|
||||
### Game Modes
|
||||
|
||||
{{game_modes}}
|
||||
|
||||
**Mode variety:**
|
||||
|
||||
- Standard race
|
||||
- Time trial
|
||||
- Elimination/knockout
|
||||
- Battle/arena modes
|
||||
- Career/campaign mode
|
||||
- Online multiplayer modes
|
||||
|
||||
### Progression and Unlocks
|
||||
|
||||
{{progression}}
|
||||
|
||||
**Player advancement:**
|
||||
|
||||
- Career structure
|
||||
- Unlockable vehicles and tracks
|
||||
- Currency/rewards system
|
||||
- Achievements and challenges
|
||||
- Skill-based unlocks vs. time-based
|
||||
@@ -1,79 +0,0 @@
|
||||
## Rhythm Game Specific Elements
|
||||
|
||||
### Music Synchronization
|
||||
|
||||
{{music_sync}}
|
||||
|
||||
**Core mechanics:**
|
||||
|
||||
- Beat/rhythm detection
|
||||
- Note types (tap, hold, slide, etc.)
|
||||
- Synchronization accuracy
|
||||
- Audio-visual feedback
|
||||
- Lane systems (4-key, 6-key, circular, etc.)
|
||||
- Offset calibration
|
||||
|
||||
### Note Charts and Patterns
|
||||
|
||||
{{note_charts}}
|
||||
|
||||
**Chart design:**
|
||||
|
||||
- Charting philosophy (fun, challenge, accuracy to song)
|
||||
- Pattern vocabulary (streams, jumps, chords, etc.)
|
||||
- Difficulty representation
|
||||
- Special patterns (gimmicks, memes)
|
||||
- Chart preview
|
||||
- Custom chart support (if applicable)
|
||||
|
||||
### Timing Windows
|
||||
|
||||
{{timing_windows}}
|
||||
|
||||
**Judgment system:**
|
||||
|
||||
- Judgment tiers (perfect, great, good, bad, miss)
|
||||
- Timing windows (frame-perfect vs. lenient)
|
||||
- Visual feedback for timing
|
||||
- Audio feedback
|
||||
- Combo system
|
||||
- Health/life system (if applicable)
|
||||
|
||||
### Scoring System
|
||||
|
||||
{{scoring}}
|
||||
|
||||
**Score design:**
|
||||
|
||||
- Base score calculation
|
||||
- Combo multipliers
|
||||
- Accuracy weighting
|
||||
- Max score calculation
|
||||
- Grade/rank system (S, A, B, C)
|
||||
- Leaderboards and competition
|
||||
|
||||
### Difficulty Tiers
|
||||
|
||||
{{difficulty_tiers}}
|
||||
|
||||
**Progression:**
|
||||
|
||||
- Difficulty levels (easy, normal, hard, expert, etc.)
|
||||
- Difficulty representation (stars, numbers)
|
||||
- Unlock conditions
|
||||
- Difficulty curve
|
||||
- Accessibility options
|
||||
- Expert+ content
|
||||
|
||||
### Song Selection
|
||||
|
||||
{{song_selection}}
|
||||
|
||||
**Music library:**
|
||||
|
||||
- Song count (launch + planned DLC)
|
||||
- Genre diversity
|
||||
- Licensing vs. original music
|
||||
- Song length targets
|
||||
- Song unlock progression
|
||||
- Favorites and playlists
|
||||
@@ -1,69 +0,0 @@
|
||||
## Roguelike Specific Elements
|
||||
|
||||
### Run Structure
|
||||
|
||||
{{run_structure}}
|
||||
|
||||
**Run design:**
|
||||
|
||||
- Run length (time, stages)
|
||||
- Starting conditions
|
||||
- Difficulty scaling per run
|
||||
- Victory conditions
|
||||
|
||||
### Procedural Generation
|
||||
|
||||
{{procedural_generation}}
|
||||
|
||||
**Generation systems:**
|
||||
|
||||
- Level generation algorithm
|
||||
- Enemy placement
|
||||
- Item/loot distribution
|
||||
- Biome/theme variation
|
||||
- Seed system (if deterministic)
|
||||
|
||||
### Permadeath and Progression
|
||||
|
||||
{{permadeath_progression}}
|
||||
|
||||
**Death mechanics:**
|
||||
|
||||
- Permadeath rules
|
||||
- What persists between runs
|
||||
- Meta-progression systems
|
||||
- Unlock conditions
|
||||
|
||||
### Item and Upgrade System
|
||||
|
||||
{{item_upgrade_system}}
|
||||
|
||||
**Item mechanics:**
|
||||
|
||||
- Item types (passive, active, consumable)
|
||||
- Rarity system
|
||||
- Item synergies
|
||||
- Build variety
|
||||
- Curse/risk mechanics
|
||||
|
||||
### Character Selection
|
||||
|
||||
{{character_selection}}
|
||||
|
||||
**Playable characters:**
|
||||
|
||||
- Starting characters
|
||||
- Unlockable characters
|
||||
- Character unique abilities
|
||||
- Character playstyle differences
|
||||
|
||||
### Difficulty Modifiers
|
||||
|
||||
{{difficulty_modifiers}}
|
||||
|
||||
**Challenge systems:**
|
||||
|
||||
- Difficulty tiers
|
||||
- Modifiers/curses
|
||||
- Challenge runs
|
||||
- Achievement conditions
|
||||
@@ -1,70 +0,0 @@
|
||||
## RPG Specific Elements
|
||||
|
||||
### Character System
|
||||
|
||||
{{character_system}}
|
||||
|
||||
**Character attributes:**
|
||||
|
||||
- Stats (Strength, Dexterity, Intelligence, etc.)
|
||||
- Classes/roles
|
||||
- Leveling system
|
||||
- Skill trees
|
||||
|
||||
### Inventory and Equipment
|
||||
|
||||
{{inventory_equipment}}
|
||||
|
||||
**Equipment system:**
|
||||
|
||||
- Item types (weapons, armor, accessories)
|
||||
- Rarity tiers
|
||||
- Item stats and modifiers
|
||||
- Inventory management
|
||||
|
||||
### Quest System
|
||||
|
||||
{{quest_system}}
|
||||
|
||||
**Quest structure:**
|
||||
|
||||
- Main story quests
|
||||
- Side quests
|
||||
- Quest tracking
|
||||
- Branching questlines
|
||||
- Quest rewards
|
||||
|
||||
### World and Exploration
|
||||
|
||||
{{world_exploration}}
|
||||
|
||||
**World design:**
|
||||
|
||||
- Map structure (open world, hub-based, linear)
|
||||
- Towns and safe zones
|
||||
- Dungeons and combat zones
|
||||
- Fast travel system
|
||||
- Points of interest
|
||||
|
||||
### NPC and Dialogue
|
||||
|
||||
{{npc_dialogue}}
|
||||
|
||||
**NPC interaction:**
|
||||
|
||||
- Dialogue trees
|
||||
- Relationship/reputation system
|
||||
- Companion system
|
||||
- Merchant NPCs
|
||||
|
||||
### Combat System
|
||||
|
||||
{{combat_system}}
|
||||
|
||||
**Combat mechanics:**
|
||||
|
||||
- Combat style (real-time, turn-based, tactical)
|
||||
- Ability system
|
||||
- Magic/skill system
|
||||
- Status effects
|
||||
- Party composition (if applicable)
|
||||
@@ -1,79 +0,0 @@
|
||||
## Sandbox Game Specific Elements
|
||||
|
||||
### Creation Tools
|
||||
|
||||
{{creation_tools}}
|
||||
|
||||
**Building mechanics:**
|
||||
|
||||
- Tool types (place, delete, modify, paint)
|
||||
- Object library (blocks, props, entities)
|
||||
- Precision controls (snap, free, grid)
|
||||
- Copy/paste and templates
|
||||
- Undo/redo system
|
||||
- Import/export functionality
|
||||
|
||||
### Physics and Building Systems
|
||||
|
||||
{{physics_building}}
|
||||
|
||||
**System simulation:**
|
||||
|
||||
- Physics engine (rigid body, soft body, fluids)
|
||||
- Structural integrity (if applicable)
|
||||
- Destruction mechanics
|
||||
- Material properties
|
||||
- Constraint systems (joints, hinges, motors)
|
||||
- Interactive simulations
|
||||
|
||||
### Sharing and Community
|
||||
|
||||
{{sharing_community}}
|
||||
|
||||
**Social features:**
|
||||
|
||||
- Creation sharing (workshop, gallery)
|
||||
- Discoverability (search, trending, featured)
|
||||
- Rating and feedback systems
|
||||
- Collaboration tools
|
||||
- Modding support
|
||||
- User-generated content moderation
|
||||
|
||||
### Constraints and Rules
|
||||
|
||||
{{constraints_rules}}
|
||||
|
||||
**Game design:**
|
||||
|
||||
- Creative mode (unlimited resources, no objectives)
|
||||
- Challenge mode (limited resources, objectives)
|
||||
- Budget/point systems (if competitive)
|
||||
- Build limits (size, complexity)
|
||||
- Rulesets and game modes
|
||||
- Victory conditions (if applicable)
|
||||
|
||||
### Tools and Editing
|
||||
|
||||
{{tools_editing}}
|
||||
|
||||
**Advanced features:**
|
||||
|
||||
- Logic gates/scripting (if applicable)
|
||||
- Animation tools
|
||||
- Terrain editing
|
||||
- Weather/environment controls
|
||||
- Lighting and effects
|
||||
- Testing/preview modes
|
||||
|
||||
### Emergent Gameplay
|
||||
|
||||
{{emergent_gameplay}}
|
||||
|
||||
**Player creativity:**
|
||||
|
||||
- Unintended creations (embracing exploits)
|
||||
- Community-defined challenges
|
||||
- Speedrunning player creations
|
||||
- Cross-creation interaction
|
||||
- Viral moments and showcases
|
||||
- Evolution of the meta
|
||||
@@ -1,62 +0,0 @@
|
||||
## Shooter Specific Elements
|
||||
|
||||
### Weapon Systems
|
||||
|
||||
{{weapon_systems}}
|
||||
|
||||
**Weapon design:**
|
||||
|
||||
- Weapon types (pistol, rifle, shotgun, sniper, explosive, etc.)
|
||||
- Weapon stats (damage, fire rate, accuracy, reload time, ammo capacity)
|
||||
- Weapon progression (starting weapons, unlocks, upgrades)
|
||||
- Weapon feel (recoil patterns, sound design, impact feedback)
|
||||
- Balance considerations (risk/reward, situational use)
|
||||
|
||||
### Aiming and Combat Mechanics
|
||||
|
||||
{{aiming_combat}}
|
||||
|
||||
**Combat systems:**
|
||||
|
||||
- Aiming system (first-person, third-person, twin-stick, lock-on)
|
||||
- Hit detection (hitscan vs. projectile)
|
||||
- Accuracy mechanics (spread, recoil, movement penalties)
|
||||
- Critical hits / weak points
|
||||
- Melee integration (if applicable)
|
||||
|
||||
### Enemy Design and AI
|
||||
|
||||
{{enemy_ai}}
|
||||
|
||||
**Enemy systems:**
|
||||
|
||||
- Enemy types (fodder, elite, tank, ranged, melee, boss)
|
||||
- AI behavior patterns (aggressive, defensive, flanking, cover use)
|
||||
- Spawn systems (waves, triggers, procedural)
|
||||
- Difficulty scaling (health, damage, AI sophistication)
|
||||
- Enemy tells and telegraphing
|
||||
|
||||
### Arena and Level Design
|
||||
|
||||
{{arena_level_design}}
|
||||
|
||||
**Level structure:**
|
||||
|
||||
- Arena flow (choke points, open spaces, verticality)
|
||||
- Cover system design (destructible, dynamic, static)
|
||||
- Spawn points and safe zones
|
||||
- Power-up placement
|
||||
- Environmental hazards
|
||||
- Sightlines and engagement distances
|
||||
|
||||
### Multiplayer Considerations
|
||||
|
||||
{{multiplayer}}
|
||||
|
||||
**Multiplayer systems (if applicable):**
|
||||
|
||||
- Game modes (deathmatch, team deathmatch, objective-based, etc.)
|
||||
- Map design for PvP
|
||||
- Loadout systems
|
||||
- Matchmaking and ranking
|
||||
- Balance considerations (skill ceiling, counter-play)
|
||||
@@ -1,73 +0,0 @@
|
||||
## Simulation Specific Elements
|
||||
|
||||
### Core Simulation Systems
|
||||
|
||||
{{simulation_systems}}
|
||||
|
||||
**What's being simulated:**
|
||||
|
||||
- Primary simulation focus (city, farm, business, ecosystem, etc.)
|
||||
- Simulation depth (abstract vs. realistic)
|
||||
- System interconnections
|
||||
- Emergent behaviors
|
||||
- Simulation tickrate and performance
|
||||
|
||||
### Management Mechanics
|
||||
|
||||
{{management_mechanics}}
|
||||
|
||||
**Management systems:**
|
||||
|
||||
- Resource management (budget, materials, time)
|
||||
- Decision-making mechanics
|
||||
- Automation vs. manual control
|
||||
- Delegation systems (if applicable)
|
||||
- Efficiency optimization
|
||||
|
||||
### Building and Construction
|
||||
|
||||
{{building_construction}}
|
||||
|
||||
**Construction systems:**
|
||||
|
||||
- Placeable objects/structures
|
||||
- Grid system (free placement, snap-to-grid, tiles)
|
||||
- Building prerequisites and unlocks
|
||||
- Upgrade/demolition mechanics
|
||||
- Space constraints and planning
|
||||
|
||||
### Economic and Resource Loops
|
||||
|
||||
{{economic_loops}}
|
||||
|
||||
**Economic design:**
|
||||
|
||||
- Income sources
|
||||
- Expenses and maintenance
|
||||
- Supply chains (if applicable)
|
||||
- Market dynamics
|
||||
- Economic balance and pacing
|
||||
|
||||
### Progression and Unlocks
|
||||
|
||||
{{progression_unlocks}}
|
||||
|
||||
**Progression systems:**
|
||||
|
||||
- Unlock conditions (achievements, milestones, levels)
|
||||
- Tech/research tree
|
||||
- New mechanics/features over time
|
||||
- Difficulty scaling
|
||||
- Endgame content
|
||||
|
||||
### Sandbox vs. Scenario
|
||||
|
||||
{{sandbox_scenario}}
|
||||
|
||||
**Game modes:**
|
||||
|
||||
- Sandbox mode (unlimited resources, creative freedom)
|
||||
- Scenario/campaign mode (specific goals, constraints)
|
||||
- Challenge modes
|
||||
- Random/procedural scenarios
|
||||
- Custom scenario creation
|
||||
@@ -1,75 +0,0 @@
|
||||
## Sports Game Specific Elements
|
||||
|
||||
### Sport-Specific Rules
|
||||
|
||||
{{sport_rules}}
|
||||
|
||||
**Rule implementation:**
|
||||
|
||||
- Core sport rules (scoring, fouls, violations)
|
||||
- Match/game structure (quarters, periods, innings, etc.)
|
||||
- Referee/umpire system
|
||||
- Rule variations (if applicable)
|
||||
- Simulation vs. arcade rule adherence
|
||||
|
||||
### Team and Player Systems
|
||||
|
||||
{{team_player}}
|
||||
|
||||
**Roster design:**
|
||||
|
||||
- Player attributes (speed, strength, skill, etc.)
|
||||
- Position-specific stats
|
||||
- Team composition
|
||||
- Substitution mechanics
|
||||
- Stamina/fatigue system
|
||||
- Injury system (if applicable)
|
||||
|
||||
### Match Structure
|
||||
|
||||
{{match_structure}}
|
||||
|
||||
**Game flow:**
|
||||
|
||||
- Pre-match setup (lineups, strategies)
|
||||
- In-match actions (plays, tactics, timeouts)
|
||||
- Half-time/intermission
|
||||
- Overtime/extra time rules
|
||||
- Post-match results and stats
|
||||
|
||||
### Physics and Realism
|
||||
|
||||
{{physics_realism}}
|
||||
|
||||
**Simulation balance:**
|
||||
|
||||
- Physics accuracy (ball/puck physics, player movement)
|
||||
- Realism vs. fun tradeoffs
|
||||
- Animation systems
|
||||
- Collision detection
|
||||
- Weather/field condition effects
|
||||
|
||||
### Career and Season Modes
|
||||
|
||||
{{career_season}}
|
||||
|
||||
**Long-term modes:**
|
||||
|
||||
- Career mode structure
|
||||
- Season/tournament progression
|
||||
- Transfer/draft systems
|
||||
- Team management
|
||||
- Contract negotiations
|
||||
- Sponsor/financial systems
|
||||
|
||||
### Multiplayer Modes
|
||||
|
||||
{{multiplayer}}
|
||||
|
||||
**Competitive play:**
|
||||
|
||||
- Local multiplayer (couch co-op)
|
||||
- Online multiplayer
|
||||
- Ranked/casual modes
|
||||
- Ultimate team/card collection (if applicable)
|
||||
- Co-op vs. AI
|
||||
@@ -1,71 +0,0 @@
|
||||
## Strategy Specific Elements
|
||||
|
||||
### Resource Systems
|
||||
|
||||
{{resource_systems}}
|
||||
|
||||
**Resource management:**
|
||||
|
||||
- Resource types (gold, food, energy, population, etc.)
|
||||
- Gathering mechanics (auto-generate, harvesting, capturing)
|
||||
- Resource spending (units, buildings, research, upgrades)
|
||||
- Economic balance (income vs. expenses)
|
||||
- Scarcity and strategic choices
|
||||
|
||||
### Unit Types and Stats
|
||||
|
||||
{{unit_types}}
|
||||
|
||||
**Unit design:**
|
||||
|
||||
- Unit roster (basic, advanced, specialized, hero units)
|
||||
- Unit stats (health, attack, defense, speed, range)
|
||||
- Unit abilities (active, passive, unique)
|
||||
- Counter systems (rock-paper-scissors dynamics)
|
||||
- Unit production (cost, build time, prerequisites)
|
||||
|
||||
### Technology and Progression
|
||||
|
||||
{{tech_progression}}
|
||||
|
||||
**Progression systems:**
|
||||
|
||||
- Tech tree structure (linear, branching, era-based)
|
||||
- Research mechanics (time, cost, prerequisites)
|
||||
- Upgrade paths (unit upgrades, building improvements)
|
||||
- Unlock conditions (progression gates, achievements)
|
||||
|
||||
### Map and Terrain
|
||||
|
||||
{{map_terrain}}
|
||||
|
||||
**Strategic space:**
|
||||
|
||||
- Map size and structure (small/medium/large, symmetric/asymmetric)
|
||||
- Terrain types (passable, impassable, elevated, water)
|
||||
- Terrain effects (movement, combat bonuses, vision)
|
||||
- Strategic points (resources, objectives, choke points)
|
||||
- Fog of war / vision system
|
||||
|
||||
### AI Opponent
|
||||
|
||||
{{ai_opponent}}
|
||||
|
||||
**AI design:**
|
||||
|
||||
- AI difficulty levels (easy, medium, hard, expert)
|
||||
- AI behavior patterns (aggressive, defensive, economic, adaptive)
|
||||
- AI cheating considerations (fair vs. challenge-focused)
|
||||
- AI personality types (if multiple opponents)
|
||||
|
||||
### Victory Conditions
|
||||
|
||||
{{victory_conditions}}
|
||||
|
||||
**Win/loss design:**
|
||||
|
||||
- Victory types (domination, economic, technological, diplomatic, etc.)
|
||||
- Time limits (if applicable)
|
||||
- Score systems (if applicable)
|
||||
- Defeat conditions
|
||||
- Early surrender / concession mechanics
|
||||
@@ -1,79 +0,0 @@
|
||||
## Survival Game Specific Elements
|
||||
|
||||
### Resource Gathering and Crafting
|
||||
|
||||
{{resource_crafting}}
|
||||
|
||||
**Resource systems:**
|
||||
|
||||
- Resource types (wood, stone, food, water, etc.)
|
||||
- Gathering methods (mining, foraging, hunting, looting)
|
||||
- Crafting recipes and trees
|
||||
- Tool/weapon crafting
|
||||
- Durability and repair
|
||||
- Storage and inventory management
|
||||
|
||||
### Survival Needs
|
||||
|
||||
{{survival_needs}}
|
||||
|
||||
**Player vitals:**
|
||||
|
||||
- Hunger/thirst systems
|
||||
- Health and healing
|
||||
- Temperature/exposure
|
||||
- Sleep/rest (if applicable)
|
||||
- Sanity/morale (if applicable)
|
||||
- Status effects (poison, disease, etc.)
|
||||
|
||||
### Environmental Threats
|
||||
|
||||
{{environmental_threats}}
|
||||
|
||||
**Danger systems:**
|
||||
|
||||
- Wildlife (predators, hostile creatures)
|
||||
- Environmental hazards (weather, terrain)
|
||||
- Day/night cycle threats
|
||||
- Seasonal changes (if applicable)
|
||||
- Natural disasters
|
||||
- Dynamic threat scaling
|
||||
|
||||
### Base Building
|
||||
|
||||
{{base_building}}
|
||||
|
||||
**Construction systems:**
|
||||
|
||||
- Building materials and recipes
|
||||
- Structure types (shelter, storage, defenses)
|
||||
- Base location and planning
|
||||
- Upgrade paths
|
||||
- Defensive structures
|
||||
- Automation (if applicable)
|
||||
|
||||
### Progression and Technology
|
||||
|
||||
{{progression_tech}}
|
||||
|
||||
**Advancement:**
|
||||
|
||||
- Tech tree or skill progression
|
||||
- Tool/weapon tiers
|
||||
- Unlock conditions
|
||||
- New biomes/areas access
|
||||
- Endgame objectives (if applicable)
|
||||
- Prestige/restart mechanics (if applicable)
|
||||
|
||||
### World Structure
|
||||
|
||||
{{world_structure}}
|
||||
|
||||
**Map design:**
|
||||
|
||||
- World size and boundaries
|
||||
- Biome diversity
|
||||
- Procedural vs. handcrafted
|
||||
- Points of interest
|
||||
- Risk/reward zones
|
||||
- Fast travel or navigation systems
|
||||
@@ -1,91 +0,0 @@
|
||||
## Text-Based Game Specific Elements
|
||||
|
||||
<narrative-workflow-critical>
|
||||
This game type is **narrative-critical**. You MUST run the Narrative Design workflow after completing the GDD to create:
|
||||
- Complete story and all narrative paths
|
||||
- Room descriptions and atmosphere
|
||||
- Puzzle solutions and hints
|
||||
- Character dialogue
|
||||
- World lore and backstory
|
||||
- Parser vocabulary (if parser-based)
|
||||
</narrative-workflow-critical>
|
||||
|
||||
### Input System
|
||||
|
||||
{{input_system}}
|
||||
|
||||
**Core interface:**
|
||||
|
||||
- Parser-based (natural language commands)
|
||||
- Choice-based (numbered/lettered options)
|
||||
- Hybrid system
|
||||
- Command vocabulary depth
|
||||
- Synonyms and flexibility
|
||||
- Error messaging and hints
|
||||
|
||||
### Room/Location Structure
|
||||
|
||||
{{location_structure}}
|
||||
|
||||
**World design:**
|
||||
|
||||
- Room count and scope
|
||||
- Room descriptions (length, detail)
|
||||
- Connection types (doors, paths, obstacles)
|
||||
- Map structure (linear, branching, maze-like, open)
|
||||
- Landmarks and navigation aids
|
||||
- Fast travel or mapping system
|
||||
|
||||
### Item and Inventory System
|
||||
|
||||
{{item_inventory}}
|
||||
|
||||
**Object interaction:**
|
||||
|
||||
- Examinable objects
|
||||
- Takeable vs. scenery objects
|
||||
- Item use and combinations
|
||||
- Inventory management
|
||||
- Object descriptions
|
||||
- Hidden objects and clues
|
||||
|
||||
### Puzzle Design
|
||||
|
||||
{{puzzle_design}}
|
||||
|
||||
**Challenge structure:**
|
||||
|
||||
- Puzzle types (logic, inventory, knowledge, exploration)
|
||||
- Difficulty curve
|
||||
- Hint system (gradual reveals)
|
||||
- Red herrings vs. crucial clues
|
||||
- Puzzle integration with story
|
||||
- Non-linear puzzle solving
|
||||
|
||||
### Narrative and Writing
|
||||
|
||||
{{narrative_writing}}
|
||||
|
||||
**Story delivery:**
|
||||
|
||||
- Writing tone and style
|
||||
- Descriptive density
|
||||
- Character voice
|
||||
- Dialogue systems
|
||||
- Branching narrative (if applicable)
|
||||
- Multiple endings (if applicable)
|
||||
|
||||
**Note:** All narrative content must be written in the Narrative Design Document.
|
||||
|
||||
### Game Flow and Pacing
|
||||
|
||||
{{game_flow}}
|
||||
|
||||
**Structure:**
|
||||
|
||||
- Game length target
|
||||
- Acts or chapters
|
||||
- Save system
|
||||
- Undo/rewind mechanics
|
||||
- Walkthrough or hint accessibility
|
||||
- Replayability considerations
|
||||
@@ -1,79 +0,0 @@
|
||||
## Tower Defense Specific Elements
|
||||
|
||||
### Tower Types and Upgrades
|
||||
|
||||
{{tower_types}}
|
||||
|
||||
**Tower design:**
|
||||
|
||||
- Tower categories (damage, slow, splash, support, special)
|
||||
- Tower stats (damage, range, fire rate, cost)
|
||||
- Upgrade paths (linear, branching)
|
||||
- Tower synergies
|
||||
- Tier progression
|
||||
- Special abilities and targeting
|
||||
|
||||
### Enemy Wave Design
|
||||
|
||||
{{wave_design}}
|
||||
|
||||
**Enemy systems:**
|
||||
|
||||
- Enemy types (fast, tank, flying, immune, boss)
|
||||
- Wave composition
|
||||
- Wave difficulty scaling
|
||||
- Wave scheduling and pacing
|
||||
- Boss encounters
|
||||
- Endless mode scaling (if applicable)
|
||||
|
||||
### Path and Placement Strategy
|
||||
|
||||
{{path_placement}}
|
||||
|
||||
**Strategic space:**
|
||||
|
||||
- Path structure (fixed, custom, maze-building)
|
||||
- Placement restrictions (grid, free placement)
|
||||
- Terrain types (buildable, non-buildable, special)
|
||||
- Choke points and strategic locations
|
||||
- Multiple paths (if applicable)
|
||||
- Line of sight and range visualization
|
||||
|
||||
### Economy and Resources
|
||||
|
||||
{{economy}}
|
||||
|
||||
**Resource management:**
|
||||
|
||||
- Starting resources
|
||||
- Resource generation (per wave, per kill, passive)
|
||||
- Resource spending (towers, upgrades, abilities)
|
||||
- Selling/refund mechanics
|
||||
- Special currencies (if applicable)
|
||||
- Economic optimization strategies
|
||||
|
||||
### Abilities and Powers
|
||||
|
||||
{{abilities_powers}}
|
||||
|
||||
**Active mechanics:**
|
||||
|
||||
- Player-activated abilities (airstrikes, freezes, etc.)
|
||||
- Cooldown systems
|
||||
- Ability unlocks
|
||||
- Ability upgrade paths
|
||||
- Strategic timing
|
||||
- Resource cost vs. cooldown
|
||||
|
||||
### Difficulty and Replayability
|
||||
|
||||
{{difficulty_replay}}
|
||||
|
||||
**Challenge systems:**
|
||||
|
||||
- Difficulty levels
|
||||
- Mission objectives (perfect clear, no lives lost, etc.)
|
||||
- Star ratings
|
||||
- Challenge modifiers
|
||||
- Randomized elements
|
||||
- New Game+ or prestige modes
|
||||
@@ -1,88 +0,0 @@
|
||||
## Turn-Based Tactics Specific Elements
|
||||
|
||||
<narrative-workflow-recommended>
|
||||
This game type is **narrative-moderate to heavy**. Consider running the Narrative Design workflow after completing the GDD to create:
|
||||
- Campaign story and mission briefings
|
||||
- Character backstories and development
|
||||
- Faction lore and motivations
|
||||
- Mission narratives
|
||||
</narrative-workflow-recommended>
|
||||
|
||||
### Grid System and Movement
|
||||
|
||||
{{grid_movement}}
|
||||
|
||||
**Spatial design:**
|
||||
|
||||
- Grid type (square, hex, free-form)
|
||||
- Movement range calculation
|
||||
- Movement types (walk, fly, teleport)
|
||||
- Terrain movement costs
|
||||
- Zone of control
|
||||
- Pathfinding visualization
|
||||
|
||||
### Unit Types and Classes
|
||||
|
||||
{{unit_classes}}
|
||||
|
||||
**Unit design:**
|
||||
|
||||
- Class roster (warrior, archer, mage, healer, etc.)
|
||||
- Class abilities and specializations
|
||||
- Unit progression (leveling, promotions)
|
||||
- Unit customization
|
||||
- Unique units (heroes, named characters)
|
||||
- Class balance and counters
|
||||
|
||||
### Action Economy
|
||||
|
||||
{{action_economy}}
|
||||
|
||||
**Turn structure:**
|
||||
|
||||
- Action points system (fixed, variable, pooled)
|
||||
- Action types (move, attack, ability, item, wait)
|
||||
- Free actions vs. costing actions
|
||||
- Opportunity attacks
|
||||
- Turn order (initiative, simultaneous, alternating)
|
||||
- Time limits per turn (if applicable)
|
||||
|
||||
### Positioning and Tactics
|
||||
|
||||
{{positioning_tactics}}
|
||||
|
||||
**Strategic depth:**
|
||||
|
||||
- Flanking mechanics
|
||||
- High ground advantage
|
||||
- Cover system
|
||||
- Formation bonuses
|
||||
- Area denial
|
||||
- Chokepoint tactics
|
||||
- Line of sight and vision
|
||||
|
||||
### Terrain and Environmental Effects
|
||||
|
||||
{{terrain_effects}}
|
||||
|
||||
**Map design:**
|
||||
|
||||
- Terrain types (grass, water, lava, ice, etc.)
|
||||
- Terrain effects (defense bonus, movement penalty, damage)
|
||||
- Destructible terrain
|
||||
- Interactive objects
|
||||
- Weather effects
|
||||
- Elevation and verticality
|
||||
|
||||
### Campaign Structure
|
||||
|
||||
{{campaign}}
|
||||
|
||||
**Mission design:**
|
||||
|
||||
- Campaign length and pacing
|
||||
- Mission variety (defeat all, survive, escort, capture, etc.)
|
||||
- Optional objectives
|
||||
- Branching campaigns
|
||||
- Permadeath vs. casualty systems
|
||||
- Resource management between missions
|
||||
@@ -1,89 +0,0 @@
|
||||
## Visual Novel Specific Elements
|
||||
|
||||
<narrative-workflow-critical>
|
||||
This game type is **narrative-critical**. You MUST run the Narrative Design workflow after completing the GDD to create:
|
||||
- Complete story structure and script
|
||||
- All character profiles and development arcs
|
||||
- Branching story flowcharts
|
||||
- Scene-by-scene breakdown
|
||||
- Dialogue drafts
|
||||
- Multiple route planning
|
||||
</narrative-workflow-critical>
|
||||
|
||||
### Branching Story Structure
|
||||
|
||||
{{branching_structure}}
|
||||
|
||||
**Narrative design:**
|
||||
|
||||
- Story route types (character routes, plot branches)
|
||||
- Branch points (choices, stats, flags)
|
||||
- Convergence points
|
||||
- Route length and pacing
|
||||
- True/golden ending requirements
|
||||
- Branch complexity (simple, moderate, complex)
|
||||
|
||||
### Choice Impact System
|
||||
|
||||
{{choice_impact}}
|
||||
|
||||
**Decision mechanics:**
|
||||
|
||||
- Choice types (immediate, delayed, hidden)
|
||||
- Choice visualization (explicit, subtle, invisible)
|
||||
- Point systems (affection, alignment, stats)
|
||||
- Flag tracking
|
||||
- Choice consequences
|
||||
- Meaningful vs. cosmetic choices
|
||||
|
||||
### Route Design
|
||||
|
||||
{{route_design}}
|
||||
|
||||
**Route structure:**
|
||||
|
||||
- Common route (shared beginning)
|
||||
- Individual routes (character-specific paths)
|
||||
- Route unlock conditions
|
||||
- Route length balance
|
||||
- Route independence vs. interconnection
|
||||
- Recommended play order
|
||||
|
||||
### Character Relationship Systems
|
||||
|
||||
{{relationship_systems}}
|
||||
|
||||
**Character mechanics:**
|
||||
|
||||
- Affection/friendship points
|
||||
- Relationship milestones
|
||||
- Character-specific scenes
|
||||
- Dialogue variations based on relationship
|
||||
- Multiple romance options (if applicable)
|
||||
- Platonic vs. romantic paths
|
||||
|
||||
### Save/Load and Flowchart
|
||||
|
||||
{{save_flowchart}}
|
||||
|
||||
**Player navigation:**
|
||||
|
||||
- Save point frequency
|
||||
- Quick save/load
|
||||
- Scene skip functionality
|
||||
- Flowchart/scene select (after completion)
|
||||
- Branch tracking visualization
|
||||
- Completion percentage
|
||||
|
||||
### Art Asset Requirements
|
||||
|
||||
{{art_assets}}
|
||||
|
||||
**Visual content:**
|
||||
|
||||
- Character sprites (poses, expressions)
|
||||
- Background art (locations, times of day)
|
||||
- CG artwork (key moments, endings)
|
||||
- UI elements
|
||||
- Special effects
|
||||
- Asset quantity estimates
|
||||
@@ -1,159 +0,0 @@
|
||||
# {{game_name}} - Game Design Document
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Game Type:** {{game_type}}
|
||||
**Target Platform(s):** {{platforms}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
### Core Concept
|
||||
|
||||
{{description}}
|
||||
|
||||
### Target Audience
|
||||
|
||||
{{target_audience}}
|
||||
|
||||
### Unique Selling Points (USPs)
|
||||
|
||||
{{unique_selling_points}}
|
||||
|
||||
---
|
||||
|
||||
## Goals and Context
|
||||
|
||||
### Project Goals
|
||||
|
||||
{{goals}}
|
||||
|
||||
### Background and Rationale
|
||||
|
||||
{{context}}
|
||||
|
||||
---
|
||||
|
||||
## Core Gameplay
|
||||
|
||||
### Game Pillars
|
||||
|
||||
{{game_pillars}}
|
||||
|
||||
### Core Gameplay Loop
|
||||
|
||||
{{gameplay_loop}}
|
||||
|
||||
### Win/Loss Conditions
|
||||
|
||||
{{win_loss_conditions}}
|
||||
|
||||
---
|
||||
|
||||
## Game Mechanics
|
||||
|
||||
### Primary Mechanics
|
||||
|
||||
{{primary_mechanics}}
|
||||
|
||||
### Controls and Input
|
||||
|
||||
{{controls}}
|
||||
|
||||
---
|
||||
|
||||
{{GAME_TYPE_SPECIFIC_SECTIONS}}
|
||||
|
||||
---
|
||||
|
||||
## Progression and Balance
|
||||
|
||||
### Player Progression
|
||||
|
||||
{{player_progression}}
|
||||
|
||||
### Difficulty Curve
|
||||
|
||||
{{difficulty_curve}}
|
||||
|
||||
### Economy and Resources
|
||||
|
||||
{{economy_resources}}
|
||||
|
||||
---
|
||||
|
||||
## Level Design Framework
|
||||
|
||||
### Level Types
|
||||
|
||||
{{level_types}}
|
||||
|
||||
### Level Progression
|
||||
|
||||
{{level_progression}}
|
||||
|
||||
---
|
||||
|
||||
## Art and Audio Direction
|
||||
|
||||
### Art Style
|
||||
|
||||
{{art_style}}
|
||||
|
||||
### Audio and Music
|
||||
|
||||
{{audio_music}}
|
||||
|
||||
---
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
### Performance Requirements
|
||||
|
||||
{{performance_requirements}}
|
||||
|
||||
### Platform-Specific Details
|
||||
|
||||
{{platform_details}}
|
||||
|
||||
### Asset Requirements
|
||||
|
||||
{{asset_requirements}}
|
||||
|
||||
---
|
||||
|
||||
## Development Epics
|
||||
|
||||
### Epic Structure
|
||||
|
||||
{{epics}}
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
### Technical Metrics
|
||||
|
||||
{{technical_metrics}}
|
||||
|
||||
### Gameplay Metrics
|
||||
|
||||
{{gameplay_metrics}}
|
||||
|
||||
---
|
||||
|
||||
## Out of Scope
|
||||
|
||||
{{out_of_scope}}
|
||||
|
||||
---
|
||||
|
||||
## Assumptions and Dependencies
|
||||
|
||||
{{assumptions_and_dependencies}}
|
||||
|
||||
---
|
||||
|
||||
## Change Log
|
||||
|
||||
{{change_log}}
|
||||
@@ -1,480 +0,0 @@
|
||||
# GDD Workflow - Game Projects (All Levels)
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is the GDD instruction set for GAME projects - replaces PRD with Game Design Document</critical>
|
||||
<critical>Project analysis already completed - proceeding with game-specific design</critical>
|
||||
<critical>Uses gdd_template for GDD output, game_types.csv for type-specific sections</critical>
|
||||
<critical>Routes to 3-solutioning for architecture (platform-specific decisions handled there)</critical>
|
||||
<critical>If users mention technical details, append to technical_preferences with timestamp</critical>
|
||||
|
||||
<step n="1" goal="Load context and determine game type">
|
||||
|
||||
<action>Load project-workflow-analysis.md</action>
|
||||
<action>Confirm project_type == "game"</action>
|
||||
|
||||
<check>If continuation_mode == true:</check>
|
||||
<action>Load existing GDD.md and check completion status</action>
|
||||
<ask>Found existing work. Would you like to:
|
||||
|
||||
1. Review what's done and continue
|
||||
2. Modify existing sections
|
||||
3. Start fresh
|
||||
</ask>
|
||||
<action>If continuing, skip to first incomplete section</action>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for existing game docs.
|
||||
|
||||
<action>Check for existing game-brief in output_folder</action>
|
||||
|
||||
<check>If game-brief exists:</check>
|
||||
<ask>Found existing game brief! Would you like to:
|
||||
|
||||
1. Use it as input (recommended - I'll extract key info)
|
||||
2. Ignore it and start fresh
|
||||
|
||||
Your choice:</ask>
|
||||
|
||||
<check>If using game-brief:</check>
|
||||
<action>Load and analyze game-brief document</action>
|
||||
<action>Extract: game_name, core_concept, target_audience, platforms, game_pillars, primary_mechanics</action>
|
||||
<action>Pre-fill relevant GDD sections with game-brief content</action>
|
||||
<action>Note which sections were pre-filled from brief</action>
|
||||
|
||||
<ask>What type of game are you designing?
|
||||
|
||||
**Common Game Types:**
|
||||
|
||||
1. Action Platformer (e.g., Celeste, Hollow Knight)
|
||||
2. RPG (e.g., Stardew Valley, Undertale)
|
||||
3. Puzzle (e.g., Portal, The Witness)
|
||||
4. Roguelike (e.g., Hades, Dead Cells)
|
||||
5. Shooter (e.g., DOOM, Enter the Gungeon)
|
||||
6. Strategy (e.g., Into the Breach, Slay the Spire)
|
||||
7. Adventure (e.g., Firewatch, What Remains of Edith Finch)
|
||||
8. Simulation (e.g., Factorio, Rimworld)
|
||||
9. Other (I'll ask follow-up questions)
|
||||
|
||||
Select a number or describe your game type:</ask>
|
||||
|
||||
<action>Map selection to game_types.csv id</action>
|
||||
<action>Load corresponding fragment file from game-types/ folder</action>
|
||||
<action>Store game_type for later injection</action>
|
||||
|
||||
<action>Load gdd_template from workflow.yaml</action>
|
||||
|
||||
Get core game concept and vision.
|
||||
|
||||
<template-output>description</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define platforms and target audience">
|
||||
|
||||
<ask>What platform(s) are you targeting?
|
||||
|
||||
- Desktop (Windows/Mac/Linux)
|
||||
- Mobile (iOS/Android)
|
||||
- Web (Browser-based)
|
||||
- Console (which consoles?)
|
||||
- Multiple platforms
|
||||
|
||||
Your answer:</ask>
|
||||
|
||||
<template-output>platforms</template-output>
|
||||
|
||||
<ask>Who is your target audience?
|
||||
|
||||
Consider:
|
||||
|
||||
- Age range
|
||||
- Gaming experience level (casual, core, hardcore)
|
||||
- Genre familiarity
|
||||
- Play session length preferences
|
||||
|
||||
Your answer:</ask>
|
||||
|
||||
<template-output>target_audience</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Define goals and context">
|
||||
|
||||
**Goal Guidelines based on project level:**
|
||||
|
||||
- Level 0-1: 1-2 primary goals
|
||||
- Level 2: 2-3 primary goals
|
||||
- Level 3-4: 3-5 strategic goals
|
||||
|
||||
<template-output>goals</template-output>
|
||||
|
||||
Brief context on why this game matters now.
|
||||
|
||||
<template-output>context</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Core gameplay definition">
|
||||
|
||||
<critical>These are game-defining decisions</critical>
|
||||
|
||||
<ask>What are the core game pillars (2-4 fundamental gameplay elements)?
|
||||
|
||||
Examples:
|
||||
|
||||
- Tight controls + challenging combat + rewarding exploration
|
||||
- Strategic depth + replayability + quick sessions
|
||||
- Narrative + atmosphere + player agency
|
||||
|
||||
Your game pillars:</ask>
|
||||
|
||||
<template-output>game_pillars</template-output>
|
||||
|
||||
<ask>Describe the core gameplay loop (what the player does repeatedly):
|
||||
|
||||
Example: "Player explores level → encounters enemies → defeats enemies with abilities → collects resources → upgrades abilities → explores deeper"
|
||||
|
||||
Your gameplay loop:</ask>
|
||||
|
||||
<template-output>gameplay_loop</template-output>
|
||||
|
||||
<ask>How does the player win? How do they lose?</ask>
|
||||
|
||||
<template-output>win_loss_conditions</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Game mechanics and controls">
|
||||
|
||||
Define the primary game mechanics.
|
||||
|
||||
<template-output>primary_mechanics</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
<ask>Describe the control scheme and input method:
|
||||
|
||||
- Keyboard + Mouse
|
||||
- Gamepad
|
||||
- Touch screen
|
||||
- Other
|
||||
|
||||
Include key bindings or button layouts if known.</ask>
|
||||
|
||||
<template-output>controls</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Inject game-type-specific sections">
|
||||
|
||||
<action>Load game-type fragment from: {installed_path}/gdd/game-types/{{game_type}}.md</action>
|
||||
|
||||
<critical>Process each section in the fragment template</critical>
|
||||
|
||||
For each {{placeholder}} in the fragment, elicit and capture that information.
|
||||
|
||||
<template-output file="GDD.md">GAME_TYPE_SPECIFIC_SECTIONS</template-output>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Progression and balance">
|
||||
|
||||
<ask>How does player progression work?
|
||||
|
||||
- Skill-based (player gets better)
|
||||
- Power-based (character gets stronger)
|
||||
- Unlock-based (new abilities/areas)
|
||||
- Narrative-based (story progression)
|
||||
- Combination
|
||||
|
||||
Describe:</ask>
|
||||
|
||||
<template-output>player_progression</template-output>
|
||||
|
||||
<ask>Describe the difficulty curve:
|
||||
|
||||
- How does difficulty increase?
|
||||
- Pacing (steady, spikes, player-controlled?)
|
||||
- Accessibility options?</ask>
|
||||
|
||||
<template-output>difficulty_curve</template-output>
|
||||
|
||||
<ask optional="true">Is there an in-game economy or resource system?
|
||||
|
||||
Skip if not applicable.</ask>
|
||||
|
||||
<template-output>economy_resources</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Level design framework">
|
||||
|
||||
<ask>What types of levels/stages does your game have?
|
||||
|
||||
Examples:
|
||||
|
||||
- Tutorial, early levels, mid-game, late-game, boss arenas
|
||||
- Biomes/themes
|
||||
- Procedural vs. handcrafted
|
||||
|
||||
Describe:</ask>
|
||||
|
||||
<template-output>level_types</template-output>
|
||||
|
||||
<ask>How do levels progress or unlock?
|
||||
|
||||
- Linear sequence
|
||||
- Hub-based
|
||||
- Open world
|
||||
- Player choice
|
||||
|
||||
Describe:</ask>
|
||||
|
||||
<template-output>level_progression</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Art and audio direction">
|
||||
|
||||
<ask>Describe the art style:
|
||||
|
||||
- Visual aesthetic (pixel art, low-poly, realistic, stylized, etc.)
|
||||
- Color palette
|
||||
- Inspirations or references
|
||||
|
||||
Your vision:</ask>
|
||||
|
||||
<template-output>art_style</template-output>
|
||||
|
||||
<ask>Describe audio and music direction:
|
||||
|
||||
- Music style/genre
|
||||
- Sound effect tone
|
||||
- Audio importance to gameplay
|
||||
|
||||
Your vision:</ask>
|
||||
|
||||
<template-output>audio_music</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Technical specifications">
|
||||
|
||||
<ask>What are the performance requirements?
|
||||
|
||||
Consider:
|
||||
|
||||
- Target frame rate
|
||||
- Resolution
|
||||
- Load times
|
||||
- Battery life (mobile)
|
||||
|
||||
Requirements:</ask>
|
||||
|
||||
<template-output>performance_requirements</template-output>
|
||||
|
||||
<ask>Any platform-specific considerations?
|
||||
|
||||
- Mobile: Touch controls, screen sizes
|
||||
- PC: Keyboard/mouse, settings
|
||||
- Console: Controller, certification
|
||||
- Web: Browser compatibility, file size
|
||||
|
||||
Platform details:</ask>
|
||||
|
||||
<template-output>platform_details</template-output>
|
||||
|
||||
<ask>What are the key asset requirements?
|
||||
|
||||
- Art assets (sprites, models, animations)
|
||||
- Audio assets (music, SFX, voice)
|
||||
- Estimated asset counts/sizes
|
||||
- Asset pipeline needs
|
||||
|
||||
Asset requirements:</ask>
|
||||
|
||||
<template-output>asset_requirements</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Epic structure">
|
||||
|
||||
<action>Translate game features into development epics</action>
|
||||
|
||||
**Epic Guidelines based on project level:**
|
||||
|
||||
- Level 1: 1 epic with 1-10 stories
|
||||
- Level 2: 1-2 epics with 5-15 stories total
|
||||
- Level 3: 2-5 epics with 12-40 stories
|
||||
- Level 4: 5+ epics with 40+ stories
|
||||
|
||||
<template-output>epics</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Success metrics">
|
||||
|
||||
<ask>What technical metrics will you track?
|
||||
|
||||
Examples:
|
||||
|
||||
- Frame rate consistency
|
||||
- Load times
|
||||
- Crash rate
|
||||
- Memory usage
|
||||
|
||||
Your metrics:</ask>
|
||||
|
||||
<template-output>technical_metrics</template-output>
|
||||
|
||||
<ask>What gameplay metrics will you track?
|
||||
|
||||
Examples:
|
||||
|
||||
- Player completion rate
|
||||
- Average session length
|
||||
- Difficulty pain points
|
||||
- Feature engagement
|
||||
|
||||
Your metrics:</ask>
|
||||
|
||||
<template-output>gameplay_metrics</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="13" goal="Document out of scope and assumptions">
|
||||
|
||||
<template-output>out_of_scope</template-output>
|
||||
|
||||
<template-output>assumptions_and_dependencies</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="14" goal="Generate solutioning handoff and next steps">
|
||||
|
||||
<action>Check if game-type fragment contained narrative tags</action>
|
||||
|
||||
<check>If fragment had <narrative-workflow-critical> or <narrative-workflow-recommended>:</check>
|
||||
<action>Set needs_narrative = true</action>
|
||||
<action>Extract narrative importance level from tag</action>
|
||||
|
||||
## Next Steps for {{game_name}}
|
||||
|
||||
<check>If needs_narrative == true:</check>
|
||||
<ask>This game type ({{game_type}}) is **{{narrative_importance}}** for narrative.
|
||||
|
||||
Your game would benefit from a Narrative Design Document to detail:
|
||||
|
||||
- Story structure and beats
|
||||
- Character profiles and arcs
|
||||
- World lore and history
|
||||
- Dialogue framework
|
||||
- Environmental storytelling
|
||||
|
||||
Would you like to create a Narrative Design Document now?
|
||||
|
||||
1. Yes, create Narrative Design Document (recommended)
|
||||
2. No, proceed directly to solutioning
|
||||
3. Skip for now, I'll do it later
|
||||
|
||||
Your choice:</ask>
|
||||
|
||||
<check>If user selects option 1:</check>
|
||||
<action>LOAD: {installed_path}/narrative/instructions-narrative.md</action>
|
||||
<action>Pass GDD context to narrative workflow</action>
|
||||
<action>Exit current workflow (narrative will hand off to solutioning when done)</action>
|
||||
|
||||
Since this is a Level {{project_level}} game project, you need solutioning for platform/engine architecture.
|
||||
|
||||
**Start new chat with solutioning workflow and provide:**
|
||||
|
||||
1. This GDD: `{{gdd_output_file}}`
|
||||
2. Project analysis: `{{analysis_file}}`
|
||||
|
||||
**The solutioning workflow will:**
|
||||
|
||||
- Determine game engine/platform (Unity, Godot, Phaser, custom, etc.)
|
||||
- Generate solution-architecture.md with engine-specific decisions
|
||||
- Create per-epic tech specs
|
||||
- Handle platform-specific architecture (from registry.csv game-\* entries)
|
||||
|
||||
## Complete Next Steps Checklist
|
||||
|
||||
<action>Generate comprehensive checklist based on project analysis</action>
|
||||
|
||||
### Phase 1: Solution Architecture and Engine Selection
|
||||
|
||||
- [ ] **Run solutioning workflow** (REQUIRED)
|
||||
- Command: `workflow solution-architecture`
|
||||
- Input: GDD.md, project-workflow-analysis.md
|
||||
- Output: solution-architecture.md with engine/platform specifics
|
||||
- Note: Registry.csv will provide engine-specific guidance
|
||||
|
||||
### Phase 2: Prototype and Playtesting
|
||||
|
||||
- [ ] **Create core mechanic prototype**
|
||||
- Validate game feel
|
||||
- Test control responsiveness
|
||||
- Iterate on game pillars
|
||||
|
||||
- [ ] **Playtest early and often**
|
||||
- Internal testing
|
||||
- External playtesting
|
||||
- Feedback integration
|
||||
|
||||
### Phase 3: Asset Production
|
||||
|
||||
- [ ] **Create asset pipeline**
|
||||
- Art style guides
|
||||
- Technical constraints
|
||||
- Asset naming conventions
|
||||
|
||||
- [ ] **Audio integration**
|
||||
- Music composition/licensing
|
||||
- SFX creation
|
||||
- Audio middleware setup
|
||||
|
||||
### Phase 4: Development
|
||||
|
||||
- [ ] **Generate detailed user stories**
|
||||
- Command: `workflow generate-stories`
|
||||
- Input: GDD.md + solution-architecture.md
|
||||
|
||||
- [ ] **Sprint planning**
|
||||
- Vertical slices
|
||||
- Milestone planning
|
||||
- Demo/playable builds
|
||||
|
||||
<ask>GDD Complete! Next immediate action:
|
||||
|
||||
<check>If needs_narrative == true:</check>
|
||||
|
||||
1. Create Narrative Design Document (recommended for {{game_type}})
|
||||
2. Start solutioning workflow (engine/architecture)
|
||||
3. Create prototype build
|
||||
4. Begin asset production planning
|
||||
5. Review GDD with team/stakeholders
|
||||
6. Exit workflow
|
||||
|
||||
<check>Else:</check>
|
||||
|
||||
1. Start solutioning workflow (engine/architecture)
|
||||
2. Create prototype build
|
||||
3. Begin asset production planning
|
||||
4. Review GDD with team/stakeholders
|
||||
5. Exit workflow
|
||||
|
||||
Which would you like to proceed with?</ask>
|
||||
|
||||
<check>If user selects narrative option:</check>
|
||||
<action>LOAD: {installed_path}/narrative/instructions-narrative.md</action>
|
||||
<action>Pass GDD context to narrative workflow</action>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,222 +0,0 @@
|
||||
# PRD Workflow Router Instructions
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>This is the INITIAL ASSESSMENT phase - determines which instruction set to load</critical>
|
||||
<critical>ALWAYS check for existing project-workflow-analysis.md first</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
|
||||
<step n="1" goal="Check for existing analysis or perform new assessment">
|
||||
|
||||
<action>Check if {output_folder}/project-workflow-analysis.md exists</action>
|
||||
|
||||
<check>If exists:</check>
|
||||
<action>Load the analysis file</action>
|
||||
<action>Check for existing workflow outputs based on level in analysis:</action>
|
||||
|
||||
- Level 0: Check for tech-spec.md
|
||||
- Level 1-2: Check for PRD.md, epic-stories.md, tech-spec.md
|
||||
- Level 3-4: Check for PRD.md, epics.md
|
||||
|
||||
<ask>Previous analysis found (Level {{project_level}}).
|
||||
|
||||
**Existing documents detected:**
|
||||
{{list_existing_docs}}
|
||||
|
||||
Options:
|
||||
|
||||
1. Continue where left off with existing documents
|
||||
2. Start fresh assessment (will archive existing work)
|
||||
3. Review and modify previous analysis
|
||||
</ask>
|
||||
|
||||
<check>If not exists or starting fresh:</check>
|
||||
<action>Proceed to assessment</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Determine workflow path">
|
||||
|
||||
<ask>What type of planning do you need?
|
||||
|
||||
**Quick Selection:**
|
||||
|
||||
- [ ] Full project planning (PRD, Tech Spec, etc.)
|
||||
- [ ] UX/UI specification only
|
||||
- [ ] Tech spec only (for small changes)
|
||||
- [ ] Generate AI Frontend Prompt from existing specs
|
||||
|
||||
Select an option or describe your needs:
|
||||
</ask>
|
||||
|
||||
<check>If "UX/UI specification only":</check>
|
||||
<action>LOAD: {installed_path}/ux/instructions-ux.md</action>
|
||||
<action>Pass mode="standalone" to UX instructions</action>
|
||||
<action>Skip remaining router steps</action>
|
||||
|
||||
<check>If "Generate AI Frontend Prompt":</check>
|
||||
<action>Check for existing UX spec or PRD</action>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
<action>Exit workflow after prompt generation</action>
|
||||
|
||||
<check>If "Tech spec only" or "Full project planning":</check>
|
||||
<action>Continue to step 3 for project assessment</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Project context assessment" if="not_ux_only">
|
||||
|
||||
<ask>Let's understand your project needs:
|
||||
|
||||
**1. Project Type:**
|
||||
|
||||
- [ ] Game
|
||||
- [ ] Web application
|
||||
- [ ] Mobile application
|
||||
- [ ] Desktop application
|
||||
- [ ] Backend service/API
|
||||
- [ ] Library/package
|
||||
- [ ] Other
|
||||
|
||||
**2. Project Context:**
|
||||
|
||||
- [ ] New project (greenfield)
|
||||
- [ ] Adding to existing clean codebase
|
||||
- [ ] Working with messy/legacy code (needs refactoring)
|
||||
|
||||
**3. What are you building?** (brief description)
|
||||
</ask>
|
||||
|
||||
<action>Detect if project_type == "game"</action>
|
||||
|
||||
<check>If project_type == "game":</check>
|
||||
<action>Set workflow_type = "gdd"</action>
|
||||
<action>Skip level classification (GDD workflow handles all game project levels)</action>
|
||||
<action>Jump to step 5 for GDD-specific assessment</action>
|
||||
|
||||
<action>Else, based on their description, analyze and suggest scope level:</action>
|
||||
|
||||
Examples:
|
||||
|
||||
- "Fix login bug" → Suggests Level 0 (single atomic change)
|
||||
- "Add OAuth to existing app" → Suggests Level 1 (coherent feature)
|
||||
- "Build internal admin dashboard" → Suggests Level 2 (small system)
|
||||
- "Create customer portal with payments" → Suggests Level 3 (full product)
|
||||
- "Multi-tenant SaaS platform" → Suggests Level 4 (platform)
|
||||
|
||||
<ask>Based on your description, this appears to be a **{{suggested_level}}** project.
|
||||
|
||||
**3. Quick Scope Guide - Please confirm or adjust:**
|
||||
|
||||
- [ ] **Single atomic change** → Bug fix, add endpoint, single file change (Level 0)
|
||||
- [ ] **Coherent feature** → Add search, implement SSO, new component (Level 1)
|
||||
- [ ] **Small complete system** → Admin tool, team app, prototype (Level 2)
|
||||
- [ ] **Full product** → Customer portal, SaaS MVP (Level 3)
|
||||
- [ ] **Platform/ecosystem** → Enterprise suite, multi-tenant system (Level 4)
|
||||
|
||||
**4. Do you have existing documentation?**
|
||||
|
||||
- [ ] Product Brief
|
||||
- [ ] Market Research
|
||||
- [ ] Technical docs/Architecture
|
||||
- [ ] None
|
||||
</ask>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Determine project level and workflow path">
|
||||
|
||||
<action>Based on responses, determine:</action>
|
||||
|
||||
**Level Classification:**
|
||||
|
||||
- **Level 0**: Single atomic change → tech-spec only
|
||||
- **Level 1**: Single feature, 1-10 stories → minimal PRD + tech-spec
|
||||
- **Level 2**: Small system, 5-15 stories → focused PRD + tech-spec
|
||||
- **Level 3**: Full product, 12-40 stories → full PRD + architect handoff
|
||||
- **Level 4**: Platform, 40+ stories → enterprise PRD + architect handoff
|
||||
|
||||
<action>For brownfield without docs:</action>
|
||||
|
||||
- Levels 0-2: Can proceed with context gathering
|
||||
- Levels 3-4: MUST run architect assessment first
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Create workflow analysis document">
|
||||
|
||||
<action>Initialize analysis using analysis_template from workflow.yaml</action>
|
||||
|
||||
<critical>Capture any technical preferences mentioned during assessment</critical>
|
||||
|
||||
Generate comprehensive analysis with all assessment data.
|
||||
|
||||
<template-output file="project-workflow-analysis.md">project_type</template-output>
|
||||
<template-output file="project-workflow-analysis.md">project_level</template-output>
|
||||
<template-output file="project-workflow-analysis.md">instruction_set</template-output>
|
||||
<template-output file="project-workflow-analysis.md">scope_description</template-output>
|
||||
<template-output file="project-workflow-analysis.md">story_count</template-output>
|
||||
<template-output file="project-workflow-analysis.md">epic_count</template-output>
|
||||
<template-output file="project-workflow-analysis.md">timeline</template-output>
|
||||
<template-output file="project-workflow-analysis.md">field_type</template-output>
|
||||
<template-output file="project-workflow-analysis.md">existing_docs</template-output>
|
||||
<template-output file="project-workflow-analysis.md">team_size</template-output>
|
||||
<template-output file="project-workflow-analysis.md">deployment_intent</template-output>
|
||||
<template-output file="project-workflow-analysis.md">expected_outputs</template-output>
|
||||
<template-output file="project-workflow-analysis.md">workflow_steps</template-output>
|
||||
<template-output file="project-workflow-analysis.md">next_steps</template-output>
|
||||
<template-output file="project-workflow-analysis.md">special_notes</template-output>
|
||||
<template-output file="project-workflow-analysis.md">technical_preferences</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Load appropriate instruction set and handle continuation">
|
||||
|
||||
<critical>Based on project type and level, load ONLY the needed instructions:</critical>
|
||||
|
||||
<check>If workflow_type == "gdd" (Game projects):</check>
|
||||
<action>LOAD: {installed_path}/gdd/instructions-gdd.md</action>
|
||||
<check>If continuing:</check>
|
||||
|
||||
- Load existing GDD.md if present
|
||||
- Check which sections are complete
|
||||
- Resume from last completed section
|
||||
- GDD workflow handles all game project levels internally
|
||||
|
||||
<check>If Level 0:</check>
|
||||
<action>LOAD: {installed_path}/tech-spec/instructions-sm.md</action>
|
||||
<check>If continuing:</check>
|
||||
|
||||
- Load existing tech-spec.md
|
||||
- Allow user to review and modify
|
||||
- Complete any missing sections
|
||||
|
||||
<check>If Level 1-2:</check>
|
||||
<action>LOAD: {installed_path}/prd/instructions-med.md</action>
|
||||
<check>If continuing:</check>
|
||||
|
||||
- Load existing PRD.md if present
|
||||
- Check which sections are complete
|
||||
- Resume from last completed section
|
||||
- If PRD done, show solutioning handoff instructions
|
||||
|
||||
<check>If Level 3-4:</check>
|
||||
<action>LOAD: {installed_path}/prd/instructions-lg.md</action>
|
||||
<check>If continuing:</check>
|
||||
|
||||
- Load existing PRD.md and epics.md
|
||||
- Identify last completed step (check template variables)
|
||||
- Resume from incomplete sections
|
||||
- If all done, show architect handoff instructions
|
||||
|
||||
<critical>Pass continuation context to loaded instruction set:</critical>
|
||||
|
||||
- continuation_mode: true/false
|
||||
- last_completed_step: {{step_number}}
|
||||
- existing_documents: {{document_list}}
|
||||
|
||||
<critical>The loaded instruction set should check continuation_mode and adjust accordingly</critical>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,517 +0,0 @@
|
||||
# Narrative Design Workflow
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already completed the GDD workflow</critical>
|
||||
<critical>This workflow creates detailed narrative content for story-driven games</critical>
|
||||
<critical>Uses narrative_template for output</critical>
|
||||
<critical>If users mention gameplay mechanics, note them but keep focus on narrative</critical>
|
||||
|
||||
<step n="1" goal="Load GDD context and assess narrative complexity">
|
||||
|
||||
<action>Load GDD.md from {output_folder}</action>
|
||||
<action>Extract game_type, game_name, and any narrative mentions</action>
|
||||
|
||||
<ask>What level of narrative complexity does your game have?
|
||||
|
||||
**Narrative Complexity:**
|
||||
|
||||
1. **Critical** - Story IS the game (Visual Novel, Text-Based Adventure)
|
||||
2. **Heavy** - Story drives the experience (Story-driven RPG, Narrative Adventure)
|
||||
3. **Moderate** - Story enhances gameplay (Metroidvania, Tactics RPG, Horror)
|
||||
4. **Light** - Story provides context (most other genres)
|
||||
|
||||
Your game type ({{game_type}}) suggests **{{suggested_complexity}}**. Confirm or adjust:</ask>
|
||||
|
||||
<action>Set narrative_complexity</action>
|
||||
|
||||
<check>If complexity == "Light":</check>
|
||||
<ask>Light narrative games usually don't need a full Narrative Design Document. Are you sure you want to continue?
|
||||
|
||||
- GDD story sections may be sufficient
|
||||
- Consider just expanding GDD narrative notes
|
||||
- Proceed with full narrative workflow
|
||||
|
||||
Your choice:</ask>
|
||||
|
||||
<action>Load narrative_template from workflow.yaml</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define narrative premise and themes">
|
||||
|
||||
<ask>Describe your narrative premise in 2-3 sentences.
|
||||
|
||||
This is the "elevator pitch" of your story.
|
||||
|
||||
Examples:
|
||||
|
||||
- "A young knight discovers they're the last hope to stop an ancient evil, but must choose between saving the kingdom or their own family."
|
||||
- "After a mysterious pandemic, survivors must navigate a world where telling the truth is deadly but lying corrupts your soul."
|
||||
|
||||
Your premise:</ask>
|
||||
|
||||
<template-output>narrative_premise</template-output>
|
||||
|
||||
<ask>What are the core themes of your narrative? (2-4 themes)
|
||||
|
||||
Themes are the underlying ideas/messages.
|
||||
|
||||
Examples: redemption, sacrifice, identity, corruption, hope vs. despair, nature vs. technology
|
||||
|
||||
Your themes:</ask>
|
||||
|
||||
<template-output>core_themes</template-output>
|
||||
|
||||
<ask>Describe the tone and atmosphere.
|
||||
|
||||
Consider: dark, hopeful, comedic, melancholic, mysterious, epic, intimate, etc.
|
||||
|
||||
Your tone:</ask>
|
||||
|
||||
<template-output>tone_atmosphere</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Define story structure">
|
||||
|
||||
<ask>What story structure are you using?
|
||||
|
||||
Common structures:
|
||||
|
||||
- **3-Act** (Setup, Confrontation, Resolution)
|
||||
- **Hero's Journey** (Campbell's monomyth)
|
||||
- **Kishōtenketsu** (4-act: Introduction, Development, Twist, Conclusion)
|
||||
- **Episodic** (Self-contained episodes with arc)
|
||||
- **Branching** (Multiple paths and endings)
|
||||
- **Freeform** (Player-driven narrative)
|
||||
|
||||
Your structure:</ask>
|
||||
|
||||
<template-output>story_type</template-output>
|
||||
|
||||
<ask>Break down your story into acts/sections.
|
||||
|
||||
For 3-Act:
|
||||
|
||||
- Act 1: Setup and inciting incident
|
||||
- Act 2: Rising action and midpoint
|
||||
- Act 3: Climax and resolution
|
||||
|
||||
Describe each act/section for your game:</ask>
|
||||
|
||||
<template-output>act_breakdown</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Define major story beats">
|
||||
|
||||
<ask>List the major story beats (10-20 key moments).
|
||||
|
||||
Story beats are significant events that drive the narrative forward.
|
||||
|
||||
Format:
|
||||
|
||||
1. [Beat name] - Brief description
|
||||
2. [Beat name] - Brief description
|
||||
...
|
||||
|
||||
Your story beats:</ask>
|
||||
|
||||
<template-output>story_beats</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
<ask>Describe the pacing and flow of your narrative.
|
||||
|
||||
Consider:
|
||||
|
||||
- Slow burn vs. fast-paced
|
||||
- Tension/release rhythm
|
||||
- Story-heavy vs. gameplay-heavy sections
|
||||
- Optional vs. required narrative content
|
||||
|
||||
Your pacing:</ask>
|
||||
|
||||
<template-output>pacing_flow</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Develop protagonist(s)">
|
||||
|
||||
<ask>Describe your protagonist(s).
|
||||
|
||||
For each protagonist include:
|
||||
|
||||
- Name and brief description
|
||||
- Background and motivation
|
||||
- Character arc (how they change)
|
||||
- Strengths and flaws
|
||||
- Relationships to other characters
|
||||
- Internal and external conflicts
|
||||
|
||||
Your protagonist(s):</ask>
|
||||
|
||||
<template-output>protagonists</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Develop antagonist(s)">
|
||||
|
||||
<ask>Describe your antagonist(s).
|
||||
|
||||
For each antagonist include:
|
||||
|
||||
- Name and brief description
|
||||
- Background and motivation
|
||||
- Goals (what they want)
|
||||
- Methods (how they pursue goals)
|
||||
- Relationship to protagonist
|
||||
- Sympathetic elements (if any)
|
||||
|
||||
Your antagonist(s):</ask>
|
||||
|
||||
<template-output>antagonists</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Develop supporting characters">
|
||||
|
||||
<ask>Describe supporting characters (allies, mentors, companions, NPCs).
|
||||
|
||||
For each character include:
|
||||
|
||||
- Name and role
|
||||
- Personality and traits
|
||||
- Relationship to protagonist
|
||||
- Function in story (mentor, foil, comic relief, etc.)
|
||||
- Key scenes/moments
|
||||
|
||||
Your supporting characters:</ask>
|
||||
|
||||
<template-output>supporting_characters</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Map character arcs">
|
||||
|
||||
<ask>Describe the character arcs for major characters.
|
||||
|
||||
Character arc: How does the character change from beginning to end?
|
||||
|
||||
For each arc:
|
||||
|
||||
- Starting state
|
||||
- Key transformation moments
|
||||
- Ending state
|
||||
- Lessons learned
|
||||
|
||||
Your character arcs:</ask>
|
||||
|
||||
<template-output>character_arcs</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Build world and lore">
|
||||
|
||||
<ask>Describe your world.
|
||||
|
||||
Include:
|
||||
|
||||
- Setting (time period, location, world type)
|
||||
- World rules (magic systems, technology level, societal norms)
|
||||
- Atmosphere and aesthetics
|
||||
- What makes this world unique
|
||||
|
||||
Your world:</ask>
|
||||
|
||||
<template-output>world_overview</template-output>
|
||||
|
||||
<ask>What is the history and backstory of your world?
|
||||
|
||||
- Major historical events
|
||||
- How did the world reach its current state?
|
||||
- Legends and myths
|
||||
- Past conflicts
|
||||
|
||||
Your history:</ask>
|
||||
|
||||
<template-output>history_backstory</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Define factions and locations">
|
||||
|
||||
<ask optional="true">Describe factions, organizations, or groups (if applicable).
|
||||
|
||||
For each:
|
||||
|
||||
- Name and purpose
|
||||
- Leadership and structure
|
||||
- Goals and methods
|
||||
- Relationships with other factions
|
||||
|
||||
Your factions:</ask>
|
||||
|
||||
<template-output>factions_organizations</template-output>
|
||||
|
||||
<ask>Describe key locations in your world.
|
||||
|
||||
For each location:
|
||||
|
||||
- Name and description
|
||||
- Narrative significance
|
||||
- Atmosphere and mood
|
||||
- Key events that occur there
|
||||
|
||||
Your locations:</ask>
|
||||
|
||||
<template-output>locations</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Define dialogue framework">
|
||||
|
||||
<ask>Describe your dialogue style.
|
||||
|
||||
Consider:
|
||||
|
||||
- Formal vs. casual
|
||||
- Period-appropriate vs. modern
|
||||
- Verbose vs. concise
|
||||
- Humor level
|
||||
- Profanity/mature language
|
||||
|
||||
Your dialogue style:</ask>
|
||||
|
||||
<template-output>dialogue_style</template-output>
|
||||
|
||||
<ask>List key conversations/dialogue moments.
|
||||
|
||||
Include:
|
||||
|
||||
- Who is involved
|
||||
- When it occurs
|
||||
- What's discussed
|
||||
- Narrative purpose
|
||||
- Emotional tone
|
||||
|
||||
Your key conversations:</ask>
|
||||
|
||||
<template-output>key_conversations</template-output>
|
||||
|
||||
<check>If game has branching dialogue:</check>
|
||||
<ask>Describe your branching dialogue system.
|
||||
|
||||
- How many branches/paths?
|
||||
- What determines branches? (stats, choices, flags)
|
||||
- Do branches converge?
|
||||
- How much unique dialogue?
|
||||
|
||||
Your branching system:</ask>
|
||||
|
||||
<template-output>branching_dialogue</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Environmental storytelling">
|
||||
|
||||
<ask>How will you tell story through the environment?
|
||||
|
||||
Visual storytelling:
|
||||
|
||||
- Set dressing and props
|
||||
- Environmental damage/aftermath
|
||||
- Visual symbolism
|
||||
- Color and lighting
|
||||
|
||||
Your visual storytelling:</ask>
|
||||
|
||||
<template-output>visual_storytelling</template-output>
|
||||
|
||||
<ask>How will audio contribute to storytelling?
|
||||
|
||||
- Ambient sounds
|
||||
- Music emotional cues
|
||||
- Voice acting
|
||||
- Audio logs/recordings
|
||||
|
||||
Your audio storytelling:</ask>
|
||||
|
||||
<template-output>audio_storytelling</template-output>
|
||||
|
||||
<ask optional="true">Will you have found documents (journals, notes, emails)?
|
||||
|
||||
If yes, describe:
|
||||
|
||||
- Types of documents
|
||||
- How many
|
||||
- What they reveal
|
||||
- Optional vs. required reading
|
||||
|
||||
Your found documents:</ask>
|
||||
|
||||
<template-output>found_documents</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="13" goal="Narrative delivery methods">
|
||||
|
||||
<ask>How will you deliver narrative content?
|
||||
|
||||
**Cutscenes/Cinematics:**
|
||||
|
||||
- How many?
|
||||
- Skippable?
|
||||
- Real-time or pre-rendered?
|
||||
- Average length
|
||||
|
||||
Your cutscenes:</ask>
|
||||
|
||||
<template-output>cutscenes</template-output>
|
||||
|
||||
<ask>How will you deliver story during gameplay?
|
||||
|
||||
- NPC conversations
|
||||
- Radio/comm chatter
|
||||
- Environmental cues
|
||||
- Player actions
|
||||
- Show vs. tell balance
|
||||
|
||||
Your in-game storytelling:</ask>
|
||||
|
||||
<template-output>ingame_storytelling</template-output>
|
||||
|
||||
<ask>What narrative content is optional?
|
||||
|
||||
- Side quests
|
||||
- Collectible lore
|
||||
- Optional conversations
|
||||
- Secret endings
|
||||
|
||||
Your optional content:</ask>
|
||||
|
||||
<template-output>optional_content</template-output>
|
||||
|
||||
<check>If multiple endings:</check>
|
||||
<ask>Describe your ending structure.
|
||||
|
||||
- How many endings?
|
||||
- What determines ending? (choices, stats, completion)
|
||||
- Ending variety (minor variations vs. drastically different)
|
||||
- True/golden ending?
|
||||
|
||||
Your endings:</ask>
|
||||
|
||||
<template-output>multiple_endings</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="14" goal="Gameplay integration">
|
||||
|
||||
<ask>How does narrative integrate with gameplay?
|
||||
|
||||
- Does story unlock mechanics?
|
||||
- Do mechanics reflect themes?
|
||||
- Ludonarrative harmony or dissonance?
|
||||
- Balance of story vs. gameplay
|
||||
|
||||
Your narrative-gameplay integration:</ask>
|
||||
|
||||
<template-output>narrative_gameplay</template-output>
|
||||
|
||||
<ask>How does story gate progression?
|
||||
|
||||
- Story-locked areas
|
||||
- Cutscene triggers
|
||||
- Mandatory story beats
|
||||
- Optional vs. required narrative
|
||||
|
||||
Your story gates:</ask>
|
||||
|
||||
<template-output>story_gates</template-output>
|
||||
|
||||
<ask>How much agency does the player have?
|
||||
|
||||
- Can player affect story?
|
||||
- Meaningful choices?
|
||||
- Role-playing freedom?
|
||||
- Predetermined vs. dynamic narrative
|
||||
|
||||
Your player agency:</ask>
|
||||
|
||||
<template-output>player_agency</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="15" goal="Production planning">
|
||||
|
||||
<ask>Estimate your writing scope.
|
||||
|
||||
- Word count estimate
|
||||
- Number of scenes/chapters
|
||||
- Dialogue lines estimate
|
||||
- Branching complexity
|
||||
|
||||
Your scope:</ask>
|
||||
|
||||
<template-output>writing_scope</template-output>
|
||||
|
||||
<ask>Localization considerations?
|
||||
|
||||
- Target languages
|
||||
- Cultural adaptation needs
|
||||
- Text expansion concerns
|
||||
- Dialogue recording implications
|
||||
|
||||
Your localization:</ask>
|
||||
|
||||
<template-output>localization</template-output>
|
||||
|
||||
<ask>Voice acting plans?
|
||||
|
||||
- Fully voiced, partially voiced, or text-only?
|
||||
- Number of characters needing voices
|
||||
- Dialogue volume
|
||||
- Budget considerations
|
||||
|
||||
Your voice acting:</ask>
|
||||
|
||||
<template-output>voice_acting</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="16" goal="Completion and next steps">
|
||||
|
||||
<action>Generate character relationship map (text-based diagram)</action>
|
||||
<template-output>relationship_map</template-output>
|
||||
|
||||
<action>Generate story timeline</action>
|
||||
<template-output>timeline</template-output>
|
||||
|
||||
<ask optional="true">Any references or inspirations to note?
|
||||
|
||||
- Books, movies, games that inspired you
|
||||
- Reference materials
|
||||
- Tone/theme references
|
||||
|
||||
Your references:</ask>
|
||||
|
||||
<template-output>references</template-output>
|
||||
|
||||
<ask>Narrative Design complete! Next steps:
|
||||
|
||||
1. Proceed to solutioning (technical architecture)
|
||||
2. Create detailed script/screenplay (outside workflow)
|
||||
3. Review narrative with team/stakeholders
|
||||
4. Exit workflow
|
||||
|
||||
Which would you like?</ask>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,195 +0,0 @@
|
||||
# {{game_name}} - Narrative Design Document
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Game Type:** {{game_type}}
|
||||
**Narrative Complexity:** {{narrative_complexity}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
### Narrative Premise
|
||||
|
||||
{{narrative_premise}}
|
||||
|
||||
### Core Themes
|
||||
|
||||
{{core_themes}}
|
||||
|
||||
### Tone and Atmosphere
|
||||
|
||||
{{tone_atmosphere}}
|
||||
|
||||
---
|
||||
|
||||
## Story Structure
|
||||
|
||||
### Story Type
|
||||
|
||||
{{story_type}}
|
||||
|
||||
**Structure used:** (3-act, hero's journey, kishōtenketsu, episodic, branching, etc.)
|
||||
|
||||
### Act Breakdown
|
||||
|
||||
{{act_breakdown}}
|
||||
|
||||
### Story Beats
|
||||
|
||||
{{story_beats}}
|
||||
|
||||
### Pacing and Flow
|
||||
|
||||
{{pacing_flow}}
|
||||
|
||||
---
|
||||
|
||||
## Characters
|
||||
|
||||
### Protagonist(s)
|
||||
|
||||
{{protagonists}}
|
||||
|
||||
### Antagonist(s)
|
||||
|
||||
{{antagonists}}
|
||||
|
||||
### Supporting Characters
|
||||
|
||||
{{supporting_characters}}
|
||||
|
||||
### Character Arcs
|
||||
|
||||
{{character_arcs}}
|
||||
|
||||
---
|
||||
|
||||
## World and Lore
|
||||
|
||||
### World Overview
|
||||
|
||||
{{world_overview}}
|
||||
|
||||
### History and Backstory
|
||||
|
||||
{{history_backstory}}
|
||||
|
||||
### Factions and Organizations
|
||||
|
||||
{{factions_organizations}}
|
||||
|
||||
### Locations
|
||||
|
||||
{{locations}}
|
||||
|
||||
### Cultural Elements
|
||||
|
||||
{{cultural_elements}}
|
||||
|
||||
---
|
||||
|
||||
## Dialogue Framework
|
||||
|
||||
### Dialogue Style
|
||||
|
||||
{{dialogue_style}}
|
||||
|
||||
### Key Conversations
|
||||
|
||||
{{key_conversations}}
|
||||
|
||||
### Branching Dialogue
|
||||
|
||||
{{branching_dialogue}}
|
||||
|
||||
### Voice and Characterization
|
||||
|
||||
{{voice_characterization}}
|
||||
|
||||
---
|
||||
|
||||
## Environmental Storytelling
|
||||
|
||||
### Visual Storytelling
|
||||
|
||||
{{visual_storytelling}}
|
||||
|
||||
### Audio Storytelling
|
||||
|
||||
{{audio_storytelling}}
|
||||
|
||||
### Found Documents
|
||||
|
||||
{{found_documents}}
|
||||
|
||||
### Environmental Clues
|
||||
|
||||
{{environmental_clues}}
|
||||
|
||||
---
|
||||
|
||||
## Narrative Delivery
|
||||
|
||||
### Cutscenes and Cinematics
|
||||
|
||||
{{cutscenes}}
|
||||
|
||||
### In-Game Storytelling
|
||||
|
||||
{{ingame_storytelling}}
|
||||
|
||||
### Optional Content
|
||||
|
||||
{{optional_content}}
|
||||
|
||||
### Multiple Endings
|
||||
|
||||
{{multiple_endings}}
|
||||
|
||||
---
|
||||
|
||||
## Integration with Gameplay
|
||||
|
||||
### Narrative-Gameplay Harmony
|
||||
|
||||
{{narrative_gameplay}}
|
||||
|
||||
### Story Gates
|
||||
|
||||
{{story_gates}}
|
||||
|
||||
### Player Agency
|
||||
|
||||
{{player_agency}}
|
||||
|
||||
---
|
||||
|
||||
## Production Notes
|
||||
|
||||
### Writing Scope
|
||||
|
||||
{{writing_scope}}
|
||||
|
||||
### Localization Considerations
|
||||
|
||||
{{localization}}
|
||||
|
||||
### Voice Acting
|
||||
|
||||
{{voice_acting}}
|
||||
|
||||
---
|
||||
|
||||
## Appendix
|
||||
|
||||
### Character Relationship Map
|
||||
|
||||
{{relationship_map}}
|
||||
|
||||
### Timeline
|
||||
|
||||
{{timeline}}
|
||||
|
||||
### References and Inspirations
|
||||
|
||||
{{references}}
|
||||
@@ -1,53 +0,0 @@
|
||||
# Project Workflow Analysis
|
||||
|
||||
**Date:** {{date}}
|
||||
**Project:** {{project_name}}
|
||||
**Analyst:** {{user_name}}
|
||||
|
||||
## Assessment Results
|
||||
|
||||
### Project Classification
|
||||
|
||||
- **Project Type:** {{project_type}}
|
||||
- **Project Level:** {{project_level}}
|
||||
- **Instruction Set:** {{instruction_set}}
|
||||
|
||||
### Scope Summary
|
||||
|
||||
- **Brief Description:** {{scope_description}}
|
||||
- **Estimated Stories:** {{story_count}}
|
||||
- **Estimated Epics:** {{epic_count}}
|
||||
- **Timeline:** {{timeline}}
|
||||
|
||||
### Context
|
||||
|
||||
- **Greenfield/Brownfield:** {{field_type}}
|
||||
- **Existing Documentation:** {{existing_docs}}
|
||||
- **Team Size:** {{team_size}}
|
||||
- **Deployment Intent:** {{deployment_intent}}
|
||||
|
||||
## Recommended Workflow Path
|
||||
|
||||
### Primary Outputs
|
||||
|
||||
{{expected_outputs}}
|
||||
|
||||
### Workflow Sequence
|
||||
|
||||
{{workflow_steps}}
|
||||
|
||||
### Next Actions
|
||||
|
||||
{{next_steps}}
|
||||
|
||||
## Special Considerations
|
||||
|
||||
{{special_notes}}
|
||||
|
||||
## Technical Preferences Captured
|
||||
|
||||
{{technical_preferences}}
|
||||
|
||||
---
|
||||
|
||||
_This analysis serves as the routing decision for the adaptive PRD workflow and will be referenced by future orchestration workflows._
|
||||
@@ -1,18 +0,0 @@
|
||||
# {{project_name}} - Epic Breakdown
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
**Project Level:** {{project_level}}
|
||||
**Target Scale:** {{target_scale}}
|
||||
|
||||
---
|
||||
|
||||
## Epic Overview
|
||||
|
||||
{{epic_overview}}
|
||||
|
||||
---
|
||||
|
||||
## Epic Details
|
||||
|
||||
{{epic_details}}
|
||||
@@ -1,267 +0,0 @@
|
||||
# PRD Workflow - Large Projects (Level 3-4)
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is the LARGE instruction set for Level 3-4 projects - full PRD + architect handoff</critical>
|
||||
<critical>Project analysis already completed - proceeding with comprehensive requirements</critical>
|
||||
<critical>NO TECH-SPEC - architecture handled by specialist workflow</critical>
|
||||
<critical>Uses prd_template for PRD output, epics_template for epics output</critical>
|
||||
<critical>If users mention technical details, append to technical_preferences with timestamp</critical>
|
||||
|
||||
<step n="1" goal="Load context and handle continuation">
|
||||
|
||||
<action>Load project-workflow-analysis.md</action>
|
||||
<action>Confirm Level 3-4 - Full product or platform</action>
|
||||
|
||||
<check>If continuation_mode == true:</check>
|
||||
<action>Load existing PRD.md and check completion status</action>
|
||||
<ask>Found existing work. Would you like to:
|
||||
|
||||
1. Review what's done and continue
|
||||
2. Modify existing sections
|
||||
3. Start fresh
|
||||
</ask>
|
||||
<action>If continuing, skip to first incomplete section</action>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for `product_brief`, `market_research`, and other docs.
|
||||
|
||||
<critical>For Level 3-4, Product Brief is STRONGLY recommended</critical>
|
||||
|
||||
<action>Load prd_template from workflow.yaml</action>
|
||||
|
||||
Get comprehensive description of the project vision.
|
||||
|
||||
<template-output>description</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define deployment intent and strategic goals">
|
||||
|
||||
<ask>What is the deployment intent?
|
||||
|
||||
- MVP for early users
|
||||
- Production SaaS/application
|
||||
- Enterprise system
|
||||
- Platform/ecosystem
|
||||
</ask>
|
||||
|
||||
<template-output>deployment_intent</template-output>
|
||||
|
||||
**Goal Guidelines**:
|
||||
|
||||
- Level 3: 3-5 strategic goals
|
||||
- Level 4: 5-7 strategic goals
|
||||
|
||||
Each goal should be measurable and outcome-focused.
|
||||
|
||||
<template-output>goals</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Comprehensive context">
|
||||
|
||||
1-2 paragraphs on problem, current situation, why now.
|
||||
|
||||
<template-output>context</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Comprehensive functional requirements">
|
||||
|
||||
**FR Guidelines**:
|
||||
|
||||
- Level 3: 12-20 FRs
|
||||
- Level 4: 20-30 FRs
|
||||
|
||||
Group related features logically.
|
||||
|
||||
<template-output>functional_requirements</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Comprehensive non-functional requirements">
|
||||
|
||||
Match NFRs to deployment intent (8-12 NFRs)
|
||||
|
||||
<template-output>non_functional_requirements</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Detailed user journeys">
|
||||
|
||||
**Journey Requirements**:
|
||||
|
||||
- Level 3: 2-3 detailed journeys
|
||||
- Level 4: 3-5 comprehensive journeys
|
||||
|
||||
Map complete user flows with decision points.
|
||||
|
||||
<template-output>user_journeys</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Comprehensive UX principles">
|
||||
|
||||
8-10 UX principles guiding all interface decisions.
|
||||
|
||||
<template-output>ux_principles</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Epic structure for phased delivery">
|
||||
|
||||
**Epic Guidelines**:
|
||||
|
||||
- Level 3: 2-5 epics (12-40 stories)
|
||||
- Level 4: 5+ epics (40+ stories)
|
||||
|
||||
Each epic delivers significant value.
|
||||
|
||||
<template-output>epics</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Generate detailed epic breakdown in epics.md">
|
||||
|
||||
<action>Load epics_template from workflow.yaml</action>
|
||||
|
||||
<critical>Create separate epics.md with full story hierarchy</critical>
|
||||
|
||||
<template-output file="epics.md">epic_overview</template-output>
|
||||
|
||||
<for-each epic="epic_list">
|
||||
|
||||
Generate Epic {{epic_number}} with expanded goals, capabilities, success criteria.
|
||||
|
||||
Generate all stories with:
|
||||
|
||||
- User story format
|
||||
- Prerequisites
|
||||
- Acceptance criteria (3-8 per story)
|
||||
- Technical notes (high-level only)
|
||||
|
||||
<template-output file="epics.md">epic\_{{epic_number}}\_details</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</for-each>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Document out of scope">
|
||||
|
||||
List features/ideas preserved for future phases.
|
||||
|
||||
<template-output>out_of_scope</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Document assumptions and dependencies">
|
||||
|
||||
Only document ACTUAL assumptions from discussion.
|
||||
|
||||
<template-output>assumptions_and_dependencies</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Generate architect handoff and next steps checklist">
|
||||
|
||||
## Next Steps for {{project_name}}
|
||||
|
||||
Since this is a Level {{project_level}} project, you need architecture before stories.
|
||||
|
||||
**Start new chat with architect and provide:**
|
||||
|
||||
1. This PRD: `{{default_output_file}}`
|
||||
2. Epic structure: `{{epics_output_file}}`
|
||||
3. Input documents: {{input_documents}}
|
||||
|
||||
**Ask architect to:**
|
||||
|
||||
- Run `architecture` workflow
|
||||
- Consider reference architectures
|
||||
- Generate solution fragments
|
||||
- Create architecture.md
|
||||
|
||||
## Complete Next Steps Checklist
|
||||
|
||||
<action>Generate comprehensive checklist based on project analysis</action>
|
||||
|
||||
### Phase 1: Architecture and Design
|
||||
|
||||
- [ ] **Run architecture workflow** (REQUIRED)
|
||||
- Command: `workflow architecture`
|
||||
- Input: PRD.md, epics.md
|
||||
- Output: architecture.md
|
||||
|
||||
<check>If project has significant UX/UI components (Level 3-4 typically does):</check>
|
||||
|
||||
- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems)
|
||||
- Command: `workflow plan-project` then select "UX specification"
|
||||
- Or continue within this workflow if UI-heavy
|
||||
- Input: PRD.md, epics.md, architecture.md (once available)
|
||||
- Output: ux-specification.md
|
||||
- Optional: AI Frontend Prompt for rapid prototyping
|
||||
- Note: Creates comprehensive UX/UI spec including IA, user flows, components
|
||||
|
||||
### Phase 2: Detailed Planning
|
||||
|
||||
- [ ] **Generate detailed user stories**
|
||||
- Command: `workflow generate-stories`
|
||||
- Input: epics.md + architecture.md
|
||||
- Output: user-stories.md with full acceptance criteria
|
||||
|
||||
- [ ] **Create technical design documents**
|
||||
- Database schema
|
||||
- API specifications
|
||||
- Integration points
|
||||
|
||||
- [ ] **Define testing strategy**
|
||||
- Unit test approach
|
||||
- Integration test plan
|
||||
- UAT criteria
|
||||
|
||||
### Phase 3: Development Preparation
|
||||
|
||||
- [ ] **Set up development environment**
|
||||
- Repository structure
|
||||
- CI/CD pipeline
|
||||
- Development tools
|
||||
|
||||
- [ ] **Create sprint plan**
|
||||
- Story prioritization
|
||||
- Sprint boundaries
|
||||
- Resource allocation
|
||||
|
||||
- [ ] **Establish monitoring and metrics**
|
||||
- Success metrics from PRD
|
||||
- Technical monitoring
|
||||
- User analytics
|
||||
|
||||
<ask>Project Planning Complete! Next immediate action:
|
||||
|
||||
1. Start architecture workflow
|
||||
2. Create UX specification (if UI-heavy project)
|
||||
3. Generate AI Frontend Prompt (if UX complete)
|
||||
4. Review all outputs with stakeholders
|
||||
5. Begin detailed story generation
|
||||
6. Exit workflow
|
||||
|
||||
Which would you like to proceed with?</ask>
|
||||
|
||||
<check>If user selects option 2:</check>
|
||||
<action>LOAD: {installed_path}/ux/instructions-ux.md</action>
|
||||
<action>Pass mode="integrated" with Level 3-4 context</action>
|
||||
|
||||
<check>If user selects option 3:</check>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,251 +0,0 @@
|
||||
# PRD Workflow - Medium Projects (Level 1-2)
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is the MEDIUM instruction set for Level 1-2 projects - minimal PRD + solutioning handoff</critical>
|
||||
<critical>Project analysis already completed - proceeding with focused requirements</critical>
|
||||
<critical>Uses prd_template for PRD output, epics_template for epics output</critical>
|
||||
<critical>NO TECH-SPEC - solutioning handled by specialist workflow</critical>
|
||||
<critical>If users mention technical details, append to technical_preferences with timestamp</critical>
|
||||
|
||||
<step n="1" goal="Load context and handle continuation">
|
||||
|
||||
<action>Load project-workflow-analysis.md</action>
|
||||
<action>Confirm Level 1-2 - Feature or small system</action>
|
||||
|
||||
<check>If continuation_mode == true:</check>
|
||||
<action>Load existing PRD.md and check completion status</action>
|
||||
<ask>Found existing work. Would you like to:
|
||||
|
||||
1. Review what's done and continue
|
||||
2. Modify existing sections
|
||||
3. Start fresh
|
||||
</ask>
|
||||
<action>If continuing, skip to first incomplete section</action>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for existing docs. Ask user if they have a Product Brief.
|
||||
|
||||
<action>Load prd_template from workflow.yaml</action>
|
||||
|
||||
<critical>Get the core idea of what they're building</critical>
|
||||
|
||||
<template-output>description</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define deployment intent and goals">
|
||||
|
||||
<ask>What is the deployment intent?
|
||||
|
||||
- Demo/POC
|
||||
- MVP for early users
|
||||
- Production app
|
||||
</ask>
|
||||
|
||||
<template-output>deployment_intent</template-output>
|
||||
|
||||
**Goal Guidelines**:
|
||||
|
||||
- Level 1: 1-2 primary goals
|
||||
- Level 2: 2-3 primary goals
|
||||
|
||||
<template-output>goals</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Brief context">
|
||||
|
||||
**Keep it brief**: 1 paragraph on why this matters now.
|
||||
|
||||
<template-output>context</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Functional requirements - focused set">
|
||||
|
||||
**FR Guidelines**:
|
||||
|
||||
- Level 1: 3-8 FRs
|
||||
- Level 2: 8-15 FRs
|
||||
|
||||
**Format**: `FR001: [user capability]`
|
||||
|
||||
<template-output>functional_requirements</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Non-functional requirements - essentials only">
|
||||
|
||||
Focus on critical NFRs only (3-5 max)
|
||||
|
||||
<template-output>non_functional_requirements</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Simple user journey" if="level >= 2">
|
||||
|
||||
- Level 2: 1 simple user journey for primary use case
|
||||
|
||||
<template-output>user_journeys</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Basic UX principles" optional="true">
|
||||
|
||||
3-5 key UX principles if relevant
|
||||
|
||||
<template-output>ux_principles</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Simple epic structure">
|
||||
|
||||
**Epic Guidelines**:
|
||||
|
||||
- Level 1: 1 epic with 1-10 stories
|
||||
- Level 2: 1-2 epics with 5-15 stories total
|
||||
|
||||
Create simple epic list with story titles.
|
||||
|
||||
<template-output>epics</template-output>
|
||||
|
||||
<action>Load epics_template from workflow.yaml</action>
|
||||
|
||||
Generate epic-stories.md with basic story structure.
|
||||
|
||||
<template-output file="epic-stories.md">epic_stories</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Document out of scope" optional="true">
|
||||
|
||||
List features/ideas preserved for future phases.
|
||||
|
||||
<template-output>out_of_scope</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Document assumptions and dependencies" optional="true">
|
||||
|
||||
Only document ACTUAL assumptions from discussion.
|
||||
|
||||
<template-output>assumptions_and_dependencies</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Validate cohesion" optional="true">
|
||||
|
||||
<action>Offer to run cohesion validation</action>
|
||||
|
||||
<ask>Planning complete! Before proceeding to next steps, would you like to validate project cohesion?
|
||||
|
||||
**Cohesion Validation** checks:
|
||||
|
||||
- PRD-Tech Spec alignment
|
||||
- Feature sequencing and dependencies
|
||||
- Infrastructure setup order (greenfield)
|
||||
- Integration risks and rollback plans (brownfield)
|
||||
- External dependencies properly planned
|
||||
- UI/UX considerations (if applicable)
|
||||
|
||||
Run cohesion validation? (y/n)</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
<action>Load {installed_path}/checklist.md</action>
|
||||
<action>Review all outputs against "Cohesion Validation (All Levels)" section</action>
|
||||
<action>Validate PRD sections, then cohesion sections A-H as applicable</action>
|
||||
<action>Apply Section B (Greenfield) or Section C (Brownfield) based on field_type</action>
|
||||
<action>Include Section E (UI/UX) if UI components exist</action>
|
||||
<action>Generate comprehensive validation report with findings</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Generate solutioning handoff and next steps checklist">
|
||||
|
||||
## Next Steps for {{project_name}}
|
||||
|
||||
Since this is a Level {{project_level}} project, you need solutioning before implementation.
|
||||
|
||||
**Start new chat with solutioning workflow and provide:**
|
||||
|
||||
1. This PRD: `{{default_output_file}}`
|
||||
2. Epic structure: `{{epics_output_file}}`
|
||||
3. Input documents: {{input_documents}}
|
||||
|
||||
**Ask solutioning workflow to:**
|
||||
|
||||
- Run `3-solutioning` workflow
|
||||
- Generate solution-architecture.md
|
||||
- Create per-epic tech specs
|
||||
|
||||
## Complete Next Steps Checklist
|
||||
|
||||
<action>Generate comprehensive checklist based on project analysis</action>
|
||||
|
||||
### Phase 1: Solution Architecture and Design
|
||||
|
||||
- [ ] **Run solutioning workflow** (REQUIRED)
|
||||
- Command: `workflow solution-architecture`
|
||||
- Input: PRD.md, epic-stories.md
|
||||
- Output: solution-architecture.md, tech-spec-epic-N.md files
|
||||
|
||||
<check>If project has significant UX/UI components (Level 1-2 with UI):</check>
|
||||
|
||||
- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems)
|
||||
- Command: `workflow plan-project` then select "UX specification"
|
||||
- Or continue within this workflow if UI-heavy
|
||||
- Input: PRD.md, epic-stories.md, solution-architecture.md (once available)
|
||||
- Output: ux-specification.md
|
||||
- Optional: AI Frontend Prompt for rapid prototyping
|
||||
- Note: Creates comprehensive UX/UI spec including IA, user flows, components
|
||||
|
||||
### Phase 2: Detailed Planning
|
||||
|
||||
- [ ] **Generate detailed user stories**
|
||||
- Command: `workflow generate-stories`
|
||||
- Input: epic-stories.md + solution-architecture.md
|
||||
- Output: user-stories.md with full acceptance criteria
|
||||
|
||||
- [ ] **Create technical design documents**
|
||||
- Database schema
|
||||
- API specifications
|
||||
- Integration points
|
||||
|
||||
### Phase 3: Development Preparation
|
||||
|
||||
- [ ] **Set up development environment**
|
||||
- Repository structure
|
||||
- CI/CD pipeline
|
||||
- Development tools
|
||||
|
||||
- [ ] **Create sprint plan**
|
||||
- Story prioritization
|
||||
- Sprint boundaries
|
||||
- Resource allocation
|
||||
|
||||
<ask>Project Planning Complete! Next immediate action:
|
||||
|
||||
1. Start solutioning workflow
|
||||
2. Create UX specification (if UI-heavy project)
|
||||
3. Generate AI Frontend Prompt (if UX complete)
|
||||
4. Review all outputs with stakeholders
|
||||
5. Begin detailed story generation
|
||||
6. Exit workflow
|
||||
|
||||
Which would you like to proceed with?</ask>
|
||||
|
||||
<check>If user selects option 2:</check>
|
||||
<action>LOAD: {installed_path}/ux/instructions-ux.md</action>
|
||||
<action>Pass mode="integrated" with Level 1-2 context</action>
|
||||
|
||||
<check>If user selects option 3:</check>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,73 +0,0 @@
|
||||
# {{project_name}} Product Requirements Document (PRD)
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
**Project Level:** {{project_level}}
|
||||
**Project Type:** {{project_type}}
|
||||
**Target Scale:** {{target_scale}}
|
||||
|
||||
---
|
||||
|
||||
## Description, Context and Goals
|
||||
|
||||
{{description}}
|
||||
|
||||
### Deployment Intent
|
||||
|
||||
{{deployment_intent}}
|
||||
|
||||
### Context
|
||||
|
||||
{{context}}
|
||||
|
||||
### Goals
|
||||
|
||||
{{goals}}
|
||||
|
||||
## Requirements
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
{{functional_requirements}}
|
||||
|
||||
### Non-Functional Requirements
|
||||
|
||||
{{non_functional_requirements}}
|
||||
|
||||
## User Journeys
|
||||
|
||||
{{user_journeys}}
|
||||
|
||||
## UX Design Principles
|
||||
|
||||
{{ux_principles}}
|
||||
|
||||
## Epics
|
||||
|
||||
{{epics}}
|
||||
|
||||
{{epic_note}}
|
||||
|
||||
## Out of Scope
|
||||
|
||||
{{out_of_scope}}
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
{{next_steps}}
|
||||
|
||||
## Document Status
|
||||
|
||||
- [ ] Goals and context validated with stakeholders
|
||||
- [ ] All functional requirements reviewed
|
||||
- [ ] User journeys cover all major personas
|
||||
- [ ] Epic structure approved for phased delivery
|
||||
- [ ] Ready for architecture phase
|
||||
|
||||
_Note: See technical-decisions.md for captured technical context_
|
||||
|
||||
---
|
||||
|
||||
_This PRD adapts to project level {{project_level}} - providing appropriate detail without overburden._
|
||||
@@ -1,137 +0,0 @@
|
||||
# PRD Workflow - Small Projects (Level 0)
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is the SMALL instruction set for Level 0 projects - tech-spec only</critical>
|
||||
<critical>Project analysis already completed - proceeding directly to technical specification</critical>
|
||||
<critical>NO PRD generated - uses tech_spec_template only</critical>
|
||||
|
||||
<step n="1" goal="Confirm project scope">
|
||||
|
||||
<action>Load project-workflow-analysis.md</action>
|
||||
<action>Confirm Level 0 - Single atomic change</action>
|
||||
|
||||
<ask>Please describe the specific change/fix you need to implement:</ask>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Generate DEFINITIVE tech spec">
|
||||
|
||||
<critical>Generate tech-spec.md - this is the TECHNICAL SOURCE OF TRUTH</critical>
|
||||
<critical>ALL TECHNICAL DECISIONS MUST BE DEFINITIVE - NO AMBIGUITY ALLOWED</critical>
|
||||
|
||||
<action>Initialize tech-spec.md using tech_spec_template from workflow.yaml</action>
|
||||
|
||||
<critical>DEFINITIVE DECISIONS REQUIRED:</critical>
|
||||
|
||||
**BAD Examples (NEVER DO THIS):**
|
||||
|
||||
- "Python 2 or 3" ❌
|
||||
- "Use a logger like pino or winston" ❌
|
||||
|
||||
**GOOD Examples (ALWAYS DO THIS):**
|
||||
|
||||
- "Python 3.11" ✅
|
||||
- "winston v3.8.2 for logging" ✅
|
||||
|
||||
**Source Tree Structure**: EXACT file changes needed
|
||||
<template-output file="tech-spec.md">source_tree</template-output>
|
||||
|
||||
**Technical Approach**: SPECIFIC implementation for the change
|
||||
<template-output file="tech-spec.md">technical_approach</template-output>
|
||||
|
||||
**Implementation Stack**: DEFINITIVE tools and versions
|
||||
<template-output file="tech-spec.md">implementation_stack</template-output>
|
||||
|
||||
**Technical Details**: PRECISE change details
|
||||
<template-output file="tech-spec.md">technical_details</template-output>
|
||||
|
||||
**Testing Approach**: How to verify the change
|
||||
<template-output file="tech-spec.md">testing_approach</template-output>
|
||||
|
||||
**Deployment Strategy**: How to deploy the change
|
||||
<template-output file="tech-spec.md">deployment_strategy</template-output>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Validate cohesion" optional="true">
|
||||
|
||||
<action>Offer to run cohesion validation</action>
|
||||
|
||||
<ask>Tech-spec complete! Before proceeding to implementation, would you like to validate project cohesion?
|
||||
|
||||
**Cohesion Validation** checks:
|
||||
|
||||
- Tech spec completeness and definitiveness
|
||||
- Feature sequencing and dependencies
|
||||
- External dependencies properly planned
|
||||
- User/agent responsibilities clear
|
||||
- Greenfield/brownfield-specific considerations
|
||||
|
||||
Run cohesion validation? (y/n)</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
<action>Load {installed_path}/checklist.md</action>
|
||||
<action>Review tech-spec.md against "Cohesion Validation (All Levels)" section</action>
|
||||
<action>Focus on Section A (Tech Spec), Section D (Feature Sequencing)</action>
|
||||
<action>Apply Section B (Greenfield) or Section C (Brownfield) based on field_type</action>
|
||||
<action>Generate validation report with findings</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Finalize and determine next steps">
|
||||
|
||||
<action>Confirm tech-spec is complete and definitive</action>
|
||||
<action>No PRD needed for Level 0</action>
|
||||
<action>Ready for implementation</action>
|
||||
|
||||
## Summary
|
||||
|
||||
- **Level 0 Output**: tech-spec.md only
|
||||
- **No PRD required**
|
||||
- **Direct to implementation**
|
||||
|
||||
## Next Steps Checklist
|
||||
|
||||
<action>Determine appropriate next steps for Level 0 atomic change</action>
|
||||
|
||||
<check>If change involves UI components:</check>
|
||||
|
||||
**Optional Next Steps:**
|
||||
|
||||
- [ ] **Create simple UX documentation** (if UI change is user-facing)
|
||||
- Note: Full instructions-ux workflow may be overkill for Level 0
|
||||
- Consider documenting just the specific UI change
|
||||
|
||||
- [ ] **Generate implementation task**
|
||||
- Command: `workflow task-generation`
|
||||
- Uses: tech-spec.md
|
||||
|
||||
<check>If change is backend/API only:</check>
|
||||
|
||||
**Recommended Next Steps:**
|
||||
|
||||
- [ ] **Create test plan** for the change
|
||||
- Unit tests for the specific change
|
||||
- Integration test if affects other components
|
||||
|
||||
- [ ] **Generate implementation task**
|
||||
- Command: `workflow task-generation`
|
||||
- Uses: tech-spec.md
|
||||
|
||||
<ask>Level 0 planning complete! Next action:
|
||||
|
||||
1. Proceed to implementation
|
||||
2. Generate development task
|
||||
3. Create test plan
|
||||
4. Exit workflow
|
||||
|
||||
Select option (1-4):</ask>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,59 +0,0 @@
|
||||
# {{project_name}} - Technical Specification
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
**Project Level:** {{project_level}}
|
||||
**Project Type:** {{project_type}}
|
||||
**Development Context:** {{development_context}}
|
||||
|
||||
---
|
||||
|
||||
## Source Tree Structure
|
||||
|
||||
{{source_tree}}
|
||||
|
||||
---
|
||||
|
||||
## Technical Approach
|
||||
|
||||
{{technical_approach}}
|
||||
|
||||
---
|
||||
|
||||
## Implementation Stack
|
||||
|
||||
{{implementation_stack}}
|
||||
|
||||
---
|
||||
|
||||
## Technical Details
|
||||
|
||||
{{technical_details}}
|
||||
|
||||
---
|
||||
|
||||
## Development Setup
|
||||
|
||||
{{development_setup}}
|
||||
|
||||
---
|
||||
|
||||
## Implementation Guide
|
||||
|
||||
{{implementation_guide}}
|
||||
|
||||
---
|
||||
|
||||
## Testing Approach
|
||||
|
||||
{{testing_approach}}
|
||||
|
||||
---
|
||||
|
||||
## Deployment Strategy
|
||||
|
||||
{{deployment_strategy}}
|
||||
|
||||
---
|
||||
|
||||
_This tech spec is for Level 0-2 projects (BMad Method v6). It provides the technical details needed for implementation. Level 3+ projects use the separate architecture workflow for comprehensive technical design._
|
||||
@@ -1,360 +0,0 @@
|
||||
# UX/UI Specification Workflow Instructions
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This workflow creates comprehensive UX/UI specifications - can run standalone or as part of plan-project</critical>
|
||||
<critical>Uses ux-spec-template.md for structured output generation</critical>
|
||||
<critical>Can optionally generate AI Frontend Prompts for tools like Vercel v0, Lovable.ai</critical>
|
||||
|
||||
<step n="1" goal="Load context and analyze project requirements">
|
||||
|
||||
<action>Determine workflow mode (standalone or integrated)</action>
|
||||
|
||||
<check>If mode="standalone":</check>
|
||||
<ask>Do you have an existing PRD or requirements document? (y/n)
|
||||
|
||||
If yes: Provide the path to the PRD
|
||||
If no: We'll gather basic requirements to create the UX spec
|
||||
</ask>
|
||||
|
||||
<check>If no PRD in standalone mode:</check>
|
||||
<ask>Let's gather essential information:
|
||||
|
||||
1. **Project Description**: What are you building?
|
||||
2. **Target Users**: Who will use this?
|
||||
3. **Core Features**: What are the main capabilities? (3-5 key features)
|
||||
4. **Platform**: Web, mobile, desktop, or multi-platform?
|
||||
5. **Existing Brand/Design**: Any existing style guide or brand to follow?
|
||||
</ask>
|
||||
|
||||
<check>If PRD exists or integrated mode:</check>
|
||||
<action>Load the following documents if available:</action>
|
||||
|
||||
- PRD.md (primary source for requirements and user journeys)
|
||||
- epics.md or epic-stories.md (helps understand feature grouping)
|
||||
- tech-spec.md (understand technical constraints)
|
||||
- architecture.md (if Level 3-4 project)
|
||||
- project-workflow-analysis.md (understand project level and scope)
|
||||
|
||||
<action>Analyze project for UX complexity:</action>
|
||||
|
||||
- Number of user-facing features
|
||||
- Types of users/personas mentioned
|
||||
- Interaction complexity
|
||||
- Platform requirements (web, mobile, desktop)
|
||||
|
||||
<action>Load ux-spec-template from workflow.yaml</action>
|
||||
|
||||
<template-output>project_context</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define UX goals and principles">
|
||||
|
||||
<ask>Let's establish the UX foundation. Based on the PRD:
|
||||
|
||||
**1. Target User Personas** (extract from PRD or define):
|
||||
|
||||
- Primary persona(s)
|
||||
- Secondary persona(s)
|
||||
- Their goals and pain points
|
||||
|
||||
**2. Key Usability Goals:**
|
||||
What does success look like for users?
|
||||
|
||||
- Ease of learning?
|
||||
- Efficiency for power users?
|
||||
- Error prevention?
|
||||
- Accessibility requirements?
|
||||
|
||||
**3. Core Design Principles** (3-5 principles):
|
||||
What will guide all design decisions?
|
||||
</ask>
|
||||
|
||||
<template-output>user_personas</template-output>
|
||||
<template-output>usability_goals</template-output>
|
||||
<template-output>design_principles</template-output>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Create information architecture">
|
||||
|
||||
<action>Based on functional requirements from PRD, create site/app structure</action>
|
||||
|
||||
**Create comprehensive site map showing:**
|
||||
|
||||
- All major sections/screens
|
||||
- Hierarchical relationships
|
||||
- Navigation paths
|
||||
|
||||
<template-output>site_map</template-output>
|
||||
|
||||
**Define navigation structure:**
|
||||
|
||||
- Primary navigation items
|
||||
- Secondary navigation approach
|
||||
- Mobile navigation strategy
|
||||
- Breadcrumb structure
|
||||
|
||||
<template-output>navigation_structure</template-output>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Design user flows for critical paths">
|
||||
|
||||
<action>Extract key user journeys from PRD</action>
|
||||
<action>For each critical user task, create detailed flow</action>
|
||||
|
||||
<for-each journey="user_journeys_from_prd">
|
||||
|
||||
**Flow: {{journey_name}}**
|
||||
|
||||
Define:
|
||||
|
||||
- User goal
|
||||
- Entry points
|
||||
- Step-by-step flow with decision points
|
||||
- Success criteria
|
||||
- Error states and edge cases
|
||||
|
||||
Create Mermaid diagram showing complete flow.
|
||||
|
||||
<template-output>user*flow*{{journey_number}}</template-output>
|
||||
|
||||
</for-each>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Define component library approach">
|
||||
|
||||
<ask>Component Library Strategy:
|
||||
|
||||
**1. Design System Approach:**
|
||||
|
||||
- [ ] Use existing system (Material UI, Ant Design, etc.)
|
||||
- [ ] Create custom component library
|
||||
- [ ] Hybrid approach
|
||||
|
||||
**2. If using existing, which one?**
|
||||
|
||||
**3. Core Components Needed** (based on PRD features):
|
||||
We'll need to define states and variants for key components.
|
||||
</ask>
|
||||
|
||||
<action>For primary components, define:</action>
|
||||
|
||||
- Component purpose
|
||||
- Variants needed
|
||||
- States (default, hover, active, disabled, error)
|
||||
- Usage guidelines
|
||||
|
||||
<template-output>design_system_approach</template-output>
|
||||
<template-output>core_components</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Establish visual design foundation">
|
||||
|
||||
<ask>Visual Design Foundation:
|
||||
|
||||
**1. Brand Guidelines:**
|
||||
Do you have existing brand guidelines to follow? (y/n)
|
||||
|
||||
**2. If yes, provide link or key elements.**
|
||||
|
||||
**3. If no, let's define basics:**
|
||||
|
||||
- Primary brand personality (professional, playful, minimal, bold)
|
||||
- Industry conventions to follow or break
|
||||
</ask>
|
||||
|
||||
<action>Define color palette with semantic meanings</action>
|
||||
|
||||
<template-output>color_palette</template-output>
|
||||
|
||||
<action>Define typography system</action>
|
||||
|
||||
<template-output>font_families</template-output>
|
||||
<template-output>type_scale</template-output>
|
||||
|
||||
<action>Define spacing and layout grid</action>
|
||||
|
||||
<template-output>spacing_layout</template-output>
|
||||
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Define responsive and accessibility strategy">
|
||||
|
||||
**Responsive Design:**
|
||||
|
||||
<action>Define breakpoints based on target devices from PRD</action>
|
||||
|
||||
<template-output>breakpoints</template-output>
|
||||
|
||||
<action>Define adaptation patterns for different screen sizes</action>
|
||||
|
||||
<template-output>adaptation_patterns</template-output>
|
||||
|
||||
**Accessibility Requirements:**
|
||||
|
||||
<action>Based on deployment intent from PRD, define compliance level</action>
|
||||
|
||||
<template-output>compliance_target</template-output>
|
||||
<template-output>accessibility_requirements</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Document interaction patterns" optional="true">
|
||||
|
||||
<ask>Would you like to define animation and micro-interactions? (y/n)
|
||||
|
||||
This is recommended for:
|
||||
|
||||
- Consumer-facing applications
|
||||
- Projects emphasizing user delight
|
||||
- Complex state transitions
|
||||
</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
|
||||
<action>Define motion principles</action>
|
||||
<template-output>motion_principles</template-output>
|
||||
|
||||
<action>Define key animations and transitions</action>
|
||||
<template-output>key_animations</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Create wireframes and design references" optional="true">
|
||||
|
||||
<ask>Design File Strategy:
|
||||
|
||||
**1. Will you be creating high-fidelity designs?**
|
||||
|
||||
- [ ] Yes, in Figma
|
||||
- [ ] Yes, in Sketch
|
||||
- [ ] Yes, in Adobe XD
|
||||
- [ ] No, development from spec
|
||||
- [ ] Other: **\_\_\_\_**
|
||||
|
||||
**2. For key screens, should we:**
|
||||
|
||||
- [ ] Reference design file locations
|
||||
- [ ] Create low-fi wireframe descriptions
|
||||
- [ ] Skip visual representations
|
||||
</ask>
|
||||
|
||||
<check>If design files will be created:</check>
|
||||
<template-output>design_files</template-output>
|
||||
|
||||
<check>If wireframe descriptions needed:</check>
|
||||
<for-each screen="key_screens">
|
||||
<template-output>screen*layout*{{screen_number}}</template-output>
|
||||
</for-each>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Generate next steps and output options">
|
||||
|
||||
## UX Specification Complete
|
||||
|
||||
<action>Generate specific next steps based on project level and outputs</action>
|
||||
|
||||
<template-output>immediate_actions</template-output>
|
||||
|
||||
**Design Handoff Checklist:**
|
||||
|
||||
- [ ] All user flows documented
|
||||
- [ ] Component inventory complete
|
||||
- [ ] Accessibility requirements defined
|
||||
- [ ] Responsive strategy clear
|
||||
- [ ] Brand guidelines incorporated
|
||||
- [ ] Performance goals established
|
||||
|
||||
<check>If Level 3-4 project:</check>
|
||||
|
||||
- [ ] Ready for detailed visual design
|
||||
- [ ] Frontend architecture can proceed
|
||||
- [ ] Story generation can include UX details
|
||||
|
||||
<check>If Level 1-2 project or standalone:</check>
|
||||
|
||||
- [ ] Development can proceed with spec
|
||||
- [ ] Component implementation order defined
|
||||
- [ ] MVP scope clear
|
||||
|
||||
<template-output>design_handoff_checklist</template-output>
|
||||
|
||||
<ask>UX Specification saved to {{ux_spec_file}}
|
||||
|
||||
**Additional Output Options:**
|
||||
|
||||
1. Generate AI Frontend Prompt (for Vercel v0, Lovable.ai, etc.)
|
||||
2. Review UX specification
|
||||
3. Create/update visual designs in design tool
|
||||
4. Return to planning workflow (if not standalone)
|
||||
5. Exit
|
||||
|
||||
Would you like to generate an AI Frontend Prompt? (y/n):</ask>
|
||||
|
||||
<check>If user selects yes or option 1:</check>
|
||||
<goto step="11">Generate AI Frontend Prompt</goto>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Generate AI Frontend Prompt" optional="true">
|
||||
|
||||
<action>Prepare context for AI Frontend Prompt generation</action>
|
||||
|
||||
<ask>What type of AI frontend generation are you targeting?
|
||||
|
||||
1. **Full application** - Complete multi-page application
|
||||
2. **Single page** - One complete page/screen
|
||||
3. **Component set** - Specific components or sections
|
||||
4. **Design system** - Component library setup
|
||||
|
||||
Select option (1-4):</ask>
|
||||
|
||||
<action>Gather UX spec details for prompt generation:</action>
|
||||
|
||||
- Design system approach
|
||||
- Color palette and typography
|
||||
- Key components and their states
|
||||
- User flows to implement
|
||||
- Responsive requirements
|
||||
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
|
||||
<action>Save AI Frontend Prompt to {{ai_frontend_prompt_file}}</action>
|
||||
|
||||
<ask>AI Frontend Prompt saved to {{ai_frontend_prompt_file}}
|
||||
|
||||
This prompt is optimized for:
|
||||
|
||||
- Vercel v0
|
||||
- Lovable.ai
|
||||
- Other AI frontend generation tools
|
||||
|
||||
**Remember**: AI-generated code requires careful review and testing!
|
||||
|
||||
Next actions:
|
||||
|
||||
1. Copy prompt to AI tool
|
||||
2. Return to UX specification
|
||||
3. Exit workflow
|
||||
|
||||
Select option (1-3):</ask>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,162 +0,0 @@
|
||||
# {{project_name}} UX/UI Specification
|
||||
|
||||
_Generated on {{date}} by {{user_name}}_
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{project_context}}
|
||||
|
||||
---
|
||||
|
||||
## 1. UX Goals and Principles
|
||||
|
||||
### 1.1 Target User Personas
|
||||
|
||||
{{user_personas}}
|
||||
|
||||
### 1.2 Usability Goals
|
||||
|
||||
{{usability_goals}}
|
||||
|
||||
### 1.3 Design Principles
|
||||
|
||||
{{design_principles}}
|
||||
|
||||
---
|
||||
|
||||
## 2. Information Architecture
|
||||
|
||||
### 2.1 Site Map
|
||||
|
||||
{{site_map}}
|
||||
|
||||
### 2.2 Navigation Structure
|
||||
|
||||
{{navigation_structure}}
|
||||
|
||||
---
|
||||
|
||||
## 3. User Flows
|
||||
|
||||
{{user_flow_1}}
|
||||
|
||||
{{user_flow_2}}
|
||||
|
||||
{{user_flow_3}}
|
||||
|
||||
{{user_flow_4}}
|
||||
|
||||
{{user_flow_5}}
|
||||
|
||||
---
|
||||
|
||||
## 4. Component Library and Design System
|
||||
|
||||
### 4.1 Design System Approach
|
||||
|
||||
{{design_system_approach}}
|
||||
|
||||
### 4.2 Core Components
|
||||
|
||||
{{core_components}}
|
||||
|
||||
---
|
||||
|
||||
## 5. Visual Design Foundation
|
||||
|
||||
### 5.1 Color Palette
|
||||
|
||||
{{color_palette}}
|
||||
|
||||
### 5.2 Typography
|
||||
|
||||
**Font Families:**
|
||||
{{font_families}}
|
||||
|
||||
**Type Scale:**
|
||||
{{type_scale}}
|
||||
|
||||
### 5.3 Spacing and Layout
|
||||
|
||||
{{spacing_layout}}
|
||||
|
||||
---
|
||||
|
||||
## 6. Responsive Design
|
||||
|
||||
### 6.1 Breakpoints
|
||||
|
||||
{{breakpoints}}
|
||||
|
||||
### 6.2 Adaptation Patterns
|
||||
|
||||
{{adaptation_patterns}}
|
||||
|
||||
---
|
||||
|
||||
## 7. Accessibility
|
||||
|
||||
### 7.1 Compliance Target
|
||||
|
||||
{{compliance_target}}
|
||||
|
||||
### 7.2 Key Requirements
|
||||
|
||||
{{accessibility_requirements}}
|
||||
|
||||
---
|
||||
|
||||
## 8. Interaction and Motion
|
||||
|
||||
### 8.1 Motion Principles
|
||||
|
||||
{{motion_principles}}
|
||||
|
||||
### 8.2 Key Animations
|
||||
|
||||
{{key_animations}}
|
||||
|
||||
---
|
||||
|
||||
## 9. Design Files and Wireframes
|
||||
|
||||
### 9.1 Design Files
|
||||
|
||||
{{design_files}}
|
||||
|
||||
### 9.2 Key Screen Layouts
|
||||
|
||||
{{screen_layout_1}}
|
||||
|
||||
{{screen_layout_2}}
|
||||
|
||||
{{screen_layout_3}}
|
||||
|
||||
---
|
||||
|
||||
## 10. Next Steps
|
||||
|
||||
### 10.1 Immediate Actions
|
||||
|
||||
{{immediate_actions}}
|
||||
|
||||
### 10.2 Design Handoff Checklist
|
||||
|
||||
{{design_handoff_checklist}}
|
||||
|
||||
---
|
||||
|
||||
## Appendix
|
||||
|
||||
### Related Documents
|
||||
|
||||
- PRD: `{{prd}}`
|
||||
- Epics: `{{epics}}`
|
||||
- Tech Spec: `{{tech_spec}}`
|
||||
- Architecture: `{{architecture}}`
|
||||
|
||||
### Version History
|
||||
|
||||
| Date | Version | Changes | Author |
|
||||
| -------- | ------- | --------------------- | ------------- |
|
||||
| {{date}} | 1.0 | Initial specification | {{user_name}} |
|
||||
@@ -1,60 +0,0 @@
|
||||
# Project Planning Workflow Configuration
|
||||
name: "plan-project"
|
||||
description: "Scale-adaptive project planning workflow for all project levels (0-4). Automatically adjusts outputs based on project scope - from single atomic changes (Level 0: tech-spec only) to enterprise platforms (Level 4: full PRD + epics). Level 2-4 route to 3-solutioning workflow for architecture and tech specs. Generates appropriate planning artifacts for each level."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmm/config.yaml"
|
||||
project_name: "{config_source}:project_name"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
date: system-generated
|
||||
|
||||
recommended_inputs:
|
||||
- product_brief: "{output_folder}/product-brief.md"
|
||||
- game_brief: "{output_folder}/game-brief.md"
|
||||
- market_research: "{output_folder}/market-research.md"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan"
|
||||
|
||||
# Templates - Load these only when the instructions request loading them
|
||||
prd_template: "{installed_path}/prd/prd-template.md"
|
||||
analysis_template: "{installed_path}/prd/analysis-template.md"
|
||||
epics_template: "{installed_path}/prd/epics-template.md"
|
||||
tech_spec_template: "{installed_path}/tech-spec/tech-spec-template.md"
|
||||
ux_spec_template: "{installed_path}/ux/ux-spec-template.md"
|
||||
gdd_template: "{installed_path}/gdd/gdd-template.md"
|
||||
game_types_csv: "{installed_path}/gdd/game-types.csv"
|
||||
narrative_template: "{installed_path}/narrative/narrative-template.md"
|
||||
|
||||
# Routing instructions - loads appropriate instruction set based on project level
|
||||
instructions: "{installed_path}/instructions-router.md"
|
||||
|
||||
# Output configuration
|
||||
analysis_file: "{output_folder}/project-workflow-analysis.md"
|
||||
default_output_file: "{output_folder}/PRD.md"
|
||||
gdd_output_file: "{output_folder}/GDD.md"
|
||||
epics_output_file: "{output_folder}/epics.md"
|
||||
tech_spec_file: "{output_folder}/tech-spec.md"
|
||||
ux_spec_file: "{output_folder}/ux-specification.md"
|
||||
narrative_design_file: "{output_folder}/narrative-design.md"
|
||||
ai_frontend_prompt_file: "{output_folder}/ai-frontend-prompt.md"
|
||||
validation_output_file: "{output_folder}/PRD-validation-report.md"
|
||||
|
||||
# Scale parameters - adaptive by project level
|
||||
scale_parameters:
|
||||
level_0: "Single atomic change, tech-spec only"
|
||||
level_1: "1-10 stories, 1 epic, minimal PRD + tech-spec"
|
||||
level_2: "5-15 stories, 1-2 epics, focused PRD + tech-spec"
|
||||
level_3: "12-40 stories, 2-5 epics, full PRD + architect handoff"
|
||||
level_4: "40+ stories, 5+ epics, enterprise PRD + architect handoff"
|
||||
|
||||
#Do not load these directly - instructions-router.md will load the proper file based on project type/level when needed
|
||||
instructions_sm: "{installed_path}/tech-spec/instructions-sm.md"
|
||||
instructions_med: "{installed_path}/prd/instructions-med.md"
|
||||
instructions_lg: "{installed_path}/prd/instructions-lg.md"
|
||||
instructions_ux: "{installed_path}/ux/instructions-ux.md"
|
||||
instructions_gdd: "{installed_path}/gdd/instructions-gdd.md"
|
||||
instructions_narrative: "{installed_path}/narrative/instructions-narrative.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
@@ -1,74 +0,0 @@
|
||||
# Architecture Decision Records
|
||||
|
||||
**Project:** {{project_name}}
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
This document captures all architectural decisions made during the solution architecture process. Each decision includes the context, options considered, chosen solution, and rationale.
|
||||
|
||||
---
|
||||
|
||||
## Decision Format
|
||||
|
||||
Each decision follows this structure:
|
||||
|
||||
### ADR-NNN: [Decision Title]
|
||||
|
||||
**Date:** YYYY-MM-DD
|
||||
**Status:** [Proposed | Accepted | Rejected | Superseded]
|
||||
**Decider:** [User | Agent | Collaborative]
|
||||
|
||||
**Context:**
|
||||
What is the issue we're trying to solve?
|
||||
|
||||
**Options Considered:**
|
||||
|
||||
1. Option A - [brief description]
|
||||
- Pros: ...
|
||||
- Cons: ...
|
||||
2. Option B - [brief description]
|
||||
- Pros: ...
|
||||
- Cons: ...
|
||||
3. Option C - [brief description]
|
||||
- Pros: ...
|
||||
- Cons: ...
|
||||
|
||||
**Decision:**
|
||||
We chose [Option X]
|
||||
|
||||
**Rationale:**
|
||||
Why we chose this option over others.
|
||||
|
||||
**Consequences:**
|
||||
|
||||
- Positive: ...
|
||||
- Negative: ...
|
||||
- Neutral: ...
|
||||
|
||||
**Rejected Options:**
|
||||
|
||||
- Option A rejected because: ...
|
||||
- Option B rejected because: ...
|
||||
|
||||
---
|
||||
|
||||
## Decisions
|
||||
|
||||
{{decisions_list}}
|
||||
|
||||
---
|
||||
|
||||
## Decision Index
|
||||
|
||||
| ID | Title | Status | Date | Decider |
|
||||
| --- | ----- | ------ | ---- | ------- |
|
||||
|
||||
{{decisions_index}}
|
||||
|
||||
---
|
||||
|
||||
_This document is generated and updated during the solution-architecture workflow_
|
||||
@@ -1,565 +0,0 @@
|
||||
# Solution Architecture Workflow
|
||||
|
||||
**Status:** Production-Ready | Scale-Adaptive Architecture Generation
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
This workflow generates comprehensive, scale-adaptive solution architecture documentation tailored to your project type, technology stack, and scale level (0-4).
|
||||
|
||||
**Unique Features:**
|
||||
|
||||
- ✅ **Scale-adaptive**: Level 0 = skip, Levels 1-4 = progressive depth
|
||||
- ✅ **Pattern-aware**: 171 technology combinations across 12 project types
|
||||
- ✅ **Template-driven**: 11 complete architecture document templates
|
||||
- ✅ **Engine-specific guidance**: Unity, Godot, Phaser, and more
|
||||
- ✅ **GDD/PRD aware**: Uses Game Design Doc for games, PRD for everything else
|
||||
- ✅ **ADR tracking**: Separate Architecture Decision Records document
|
||||
- ✅ **Specialist integration**: Pattern-specific specialist recommendations
|
||||
|
||||
---
|
||||
|
||||
## When to Use
|
||||
|
||||
Run this workflow **AFTER** completing:
|
||||
|
||||
| Prerequisite | Required For | Location |
|
||||
| -------------------------- | ----------------------------- | ------------------------------------ |
|
||||
| **plan-project workflow** | All projects | `/docs/project-workflow-analysis.md` |
|
||||
| **PRD with epics/stories** | Level 1+ projects | `/docs/PRD.md` |
|
||||
| **GDD (for games)** | Game projects | `/docs/GDD.md` or `/docs/PRD.md` |
|
||||
| **UX Specification** | UI projects (web/mobile/game) | `/docs/ux-specification.md` |
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
workflow solution-architecture
|
||||
```
|
||||
|
||||
**The workflow will:**
|
||||
|
||||
1. Load `project-workflow-analysis.md` (from plan-project)
|
||||
2. Check prerequisites (PRD/GDD, UX spec if needed)
|
||||
3. Read requirements (PRD for apps, GDD for games)
|
||||
4. Ask architecture pattern questions
|
||||
5. Load appropriate template and guide
|
||||
6. Generate architecture + ADR documents
|
||||
7. Run cohesion check validation
|
||||
|
||||
---
|
||||
|
||||
## Outputs
|
||||
|
||||
### Primary Documents
|
||||
|
||||
| File | Purpose | Notes |
|
||||
| --------------------------- | ------------------------------------ | --------------------------------------------------- |
|
||||
| `solution-architecture.md` | Complete architecture document | Pattern-specific sections |
|
||||
| `architecture-decisions.md` | Architecture Decision Records (ADRs) | Tracks all decisions, options considered, rationale |
|
||||
|
||||
### Validation Outputs
|
||||
|
||||
| File | Purpose |
|
||||
| -------------------------- | ----------------------------------- |
|
||||
| `cohesion-check-report.md` | Validates 100% FR/NFR/Epic coverage |
|
||||
| `epic-alignment-matrix.md` | Maps epics → components/tech/APIs |
|
||||
|
||||
---
|
||||
|
||||
## Project Types and Templates
|
||||
|
||||
### 12 Project Types Supported
|
||||
|
||||
| Type | Examples | Template | Guide Examples |
|
||||
| ------------- | ---------------------------- | --------------------------------- | -------------------- |
|
||||
| **web** | Next.js, Rails, Django | web-fullstack-architecture.md | (TBD) |
|
||||
| **mobile** | React Native, Flutter, Swift | mobile-app-architecture.md | (TBD) |
|
||||
| **game** | Unity, Godot, Phaser | game-engine-architecture.md | Unity, Godot, Phaser |
|
||||
| **embedded** | ESP32, STM32, Raspberry Pi | embedded-firmware-architecture.md | (TBD) |
|
||||
| **backend** | Express, FastAPI, gRPC | backend-service-architecture.md | (TBD) |
|
||||
| **data** | Spark, Airflow, MLflow | data-pipeline-architecture.md | (TBD) |
|
||||
| **cli** | Commander, Click, Cobra | cli-tool-architecture.md | (TBD) |
|
||||
| **desktop** | Electron, Tauri, Qt | desktop-app-architecture.md | (TBD) |
|
||||
| **library** | npm, PyPI, cargo | library-package-architecture.md | (TBD) |
|
||||
| **infra** | Terraform, K8s Operator | infrastructure-architecture.md | (TBD) |
|
||||
| **extension** | Chrome, VS Code plugins | desktop-app-architecture.md | (TBD) |
|
||||
|
||||
### 171 Technology Combinations
|
||||
|
||||
The workflow maintains a registry (`templates/registry.csv`) with 171 pre-defined technology stack combinations:
|
||||
|
||||
**Examples:**
|
||||
|
||||
- `web-nextjs-ssr-monorepo` → Next.js SSR, TypeScript, monorepo
|
||||
- `game-unity-3d` → Unity 3D, C#, monorepo
|
||||
- `mobile-react-native` → React Native, TypeScript, cross-platform
|
||||
- `backend-fastapi-rest` → FastAPI, Python, REST API
|
||||
- `data-ml-training` → PyTorch/TensorFlow, Python, ML pipeline
|
||||
|
||||
Each row maps to:
|
||||
|
||||
- **template_path**: Architecture document structure (11 templates)
|
||||
- **guide_path**: Engine/framework-specific guidance (optional)
|
||||
|
||||
---
|
||||
|
||||
## Architecture Flow
|
||||
|
||||
### Step 0: Prerequisites and Scale Check
|
||||
|
||||
Load `project-workflow-analysis.md`:
|
||||
|
||||
- Extract: `project_level` (0-4), `project_type` (web/game/mobile/etc.), `field_type` (greenfield/brownfield)
|
||||
- Validate: PRD exists, UX spec exists (if UI project)
|
||||
- **Skip if Level 0** (single atomic change)
|
||||
|
||||
### Step 1: Requirements Analysis
|
||||
|
||||
**For Games:**
|
||||
|
||||
- Read **GDD** (Game Design Document)
|
||||
- Extract: gameplay mechanics, engine (Unity/Godot/etc.), platform, multiplayer
|
||||
|
||||
**For Everything Else:**
|
||||
|
||||
- Read **PRD** (Product Requirements Document)
|
||||
- Extract: FRs, NFRs, epics, stories, integrations
|
||||
|
||||
**For UI Projects:**
|
||||
|
||||
- Read **UX Specification**
|
||||
- Extract: screens, flows, component patterns
|
||||
|
||||
### Step 2: User Skill Level
|
||||
|
||||
Ask user: Beginner / Intermediate / Expert
|
||||
|
||||
- Affects verbosity of generated architecture
|
||||
|
||||
### Step 3: Architecture Pattern
|
||||
|
||||
Determine:
|
||||
|
||||
- Architecture style (monolith, microservices, serverless, etc.)
|
||||
- Repository strategy (monorepo, polyrepo, hybrid)
|
||||
- Pattern-specific choices (SSR for web, native vs cross-platform for mobile)
|
||||
|
||||
### Step 4: Epic Analysis
|
||||
|
||||
Analyze PRD epics:
|
||||
|
||||
- Identify component boundaries
|
||||
- Map domain capabilities
|
||||
- Determine service boundaries (if microservices)
|
||||
|
||||
### Step 5: Project-Type Questions
|
||||
|
||||
Load: `project-types/{project_type}-questions.md`
|
||||
|
||||
- Ask project-type-specific questions (not yet engine-specific)
|
||||
|
||||
### Step 6: Load Template + Guide
|
||||
|
||||
**6.1: Search Registry**
|
||||
|
||||
```
|
||||
Read: templates/registry.csv
|
||||
Match WHERE:
|
||||
- project_types = {determined_type}
|
||||
- languages = {preferred_languages}
|
||||
- architecture_style = {determined_style}
|
||||
- tags overlap with {requirements}
|
||||
|
||||
Get: template_path, guide_path
|
||||
```
|
||||
|
||||
**6.2: Load Template**
|
||||
|
||||
```
|
||||
Read: templates/{template_path}
|
||||
Example: templates/game-engine-architecture.md
|
||||
|
||||
This is a COMPLETE document structure with:
|
||||
- Standard sections (exec summary, tech stack, data arch, etc.)
|
||||
- Pattern-specific sections (Gameplay Systems for games, SSR Strategy for web)
|
||||
- All {{placeholders}} to fill
|
||||
```
|
||||
|
||||
**6.3: Load Guide (if available)**
|
||||
|
||||
```
|
||||
IF guide_path not empty:
|
||||
Read: templates/{guide_path}
|
||||
Example: templates/game-engine-unity-guide.md
|
||||
|
||||
Guide contains:
|
||||
- Engine/framework-specific questions
|
||||
- Architecture patterns for this tech
|
||||
- Common pitfalls
|
||||
- Specialist recommendations
|
||||
- ADR templates
|
||||
```
|
||||
|
||||
**Example Flow for Unity Game:**
|
||||
|
||||
1. GDD says "Unity 2022 LTS"
|
||||
2. Registry match: `game-unity-3d` → `game-engine-architecture.md` + `game-engine-unity-guide.md`
|
||||
3. Load complete game architecture template
|
||||
4. Load Unity-specific guide
|
||||
5. Ask Unity-specific questions (MonoBehaviour vs ECS, ScriptableObjects, etc.)
|
||||
6. Fill template placeholders
|
||||
7. Generate `solution-architecture.md` + `architecture-decisions.md`
|
||||
|
||||
### Step 7: Cohesion Check
|
||||
|
||||
Validate architecture quality:
|
||||
|
||||
- 100% FR/NFR/Epic/Story coverage
|
||||
- Technology table has specific versions
|
||||
- No vagueness ("a library", "some framework")
|
||||
- Design-level only (no implementation code)
|
||||
- Generate Epic Alignment Matrix
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
/solution-architecture/
|
||||
├── README.md # This file
|
||||
├── workflow.yaml # Workflow configuration
|
||||
├── instructions.md # Main workflow logic
|
||||
├── checklist.md # Validation checklist
|
||||
├── ADR-template.md # ADR document template
|
||||
├── templates/ # Architecture templates and guides
|
||||
│ ├── registry.csv # 171 tech combinations → templates
|
||||
│ ├── game-engine-architecture.md # Complete game architecture doc
|
||||
│ ├── game-engine-unity-guide.md # Unity-specific guidance
|
||||
│ ├── game-engine-godot-guide.md # Godot-specific guidance
|
||||
│ ├── game-engine-web-guide.md # Phaser/PixiJS/Three.js guidance
|
||||
│ ├── web-fullstack-architecture.md
|
||||
│ ├── web-api-architecture.md
|
||||
│ ├── mobile-app-architecture.md
|
||||
│ ├── embedded-firmware-architecture.md
|
||||
│ ├── backend-service-architecture.md
|
||||
│ ├── data-pipeline-architecture.md
|
||||
│ ├── cli-tool-architecture.md
|
||||
│ ├── desktop-app-architecture.md
|
||||
│ ├── library-package-architecture.md
|
||||
│ └── infrastructure-architecture.md
|
||||
└── project-types/ # Project type detection and questions
|
||||
├── project-types.csv # 12 project types + detection keywords
|
||||
├── game-questions.md
|
||||
├── web-questions.md
|
||||
├── mobile-questions.md
|
||||
└── ... (12 question files)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Template System
|
||||
|
||||
### Complete, Standalone Templates
|
||||
|
||||
Each template in `templates/` is a **complete** architecture document structure:
|
||||
|
||||
**Standard Sections (all templates):**
|
||||
|
||||
1. Executive Summary
|
||||
2. Technology Stack and Decisions (required table)
|
||||
3. Architecture Overview
|
||||
4. Repository and Service Strategy
|
||||
5. Data Architecture
|
||||
6. Component and Integration Overview
|
||||
7-N. **Pattern-Specific Sections** (varies by template)
|
||||
N+1. Proposed Source Tree
|
||||
N+2. Getting Started (Human Setup)
|
||||
N+3. Implementation Patterns and Conventions (Agent Guidance)
|
||||
N+4. Testing Strategy
|
||||
N+5. Deployment and Operations
|
||||
N+6. Security
|
||||
N+7. Specialist Sections
|
||||
|
||||
**Pattern-Specific Sections Examples:**
|
||||
|
||||
**Game Engine Template:**
|
||||
|
||||
- Gameplay Systems (player controller, game state)
|
||||
- Scene Architecture
|
||||
- Asset Pipeline
|
||||
- Audio Architecture
|
||||
- Save System
|
||||
- Multiplayer Architecture (if applicable)
|
||||
|
||||
**Web Fullstack Template:**
|
||||
|
||||
- Frontend Architecture
|
||||
- Backend Architecture
|
||||
- API Design (REST/GraphQL/tRPC)
|
||||
- State Management
|
||||
- SSR/Caching Strategy
|
||||
- Performance Optimization
|
||||
|
||||
**Embedded Firmware Template:**
|
||||
|
||||
- Hardware Architecture
|
||||
- Communication Protocols
|
||||
- Power Management
|
||||
- Sensor/Actuator Integration
|
||||
- OTA Update Strategy
|
||||
|
||||
---
|
||||
|
||||
## Guide System
|
||||
|
||||
### Engine/Framework-Specific Guides
|
||||
|
||||
Guides are **workflow instruction documents** that:
|
||||
|
||||
- Ask engine-specific questions
|
||||
- Provide architecture pattern recommendations
|
||||
- Suggest what sections to emphasize
|
||||
- Define ADRs to create
|
||||
|
||||
**Guides are NOT:**
|
||||
|
||||
- ❌ Reference documentation (use official docs)
|
||||
- ❌ Tutorials (how to code)
|
||||
- ❌ API references
|
||||
|
||||
**Guides ARE:**
|
||||
|
||||
- ✅ Question flows for architecture decisions
|
||||
- ✅ Pattern recommendations specific to the tech
|
||||
- ✅ Common pitfalls to avoid
|
||||
- ✅ Specialist recommendations
|
||||
|
||||
**Example: game-engine-unity-guide.md**
|
||||
|
||||
```markdown
|
||||
## Unity Architecture Questions
|
||||
|
||||
- MonoBehaviour or ECS?
|
||||
- ScriptableObjects for game data?
|
||||
- Addressables or Resources?
|
||||
|
||||
## Unity Patterns
|
||||
|
||||
- Singleton GameManager (when to use)
|
||||
- Event-driven communication
|
||||
- Object pooling strategy
|
||||
|
||||
## Unity-Specific Sections to Include
|
||||
|
||||
- Unity Project Configuration
|
||||
- Scene Architecture
|
||||
- Component Organization
|
||||
- Package Dependencies
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
- Caching GetComponent calls
|
||||
- Avoiding empty Update methods
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ADR Tracking
|
||||
|
||||
Architecture Decision Records are maintained separately in `architecture-decisions.md`.
|
||||
|
||||
**ADR Format:**
|
||||
|
||||
```markdown
|
||||
### ADR-001: [Decision Title]
|
||||
|
||||
**Date:** YYYY-MM-DD
|
||||
**Status:** Accepted | Rejected | Superseded
|
||||
**Decider:** User | Agent | Collaborative
|
||||
|
||||
**Context:**
|
||||
What problem are we solving?
|
||||
|
||||
**Options Considered:**
|
||||
|
||||
1. Option A - pros/cons
|
||||
2. Option B - pros/cons
|
||||
3. Option C - pros/cons
|
||||
|
||||
**Decision:**
|
||||
We chose Option X
|
||||
|
||||
**Rationale:**
|
||||
Why we chose this over others
|
||||
|
||||
**Consequences:**
|
||||
|
||||
- Positive: ...
|
||||
- Negative: ...
|
||||
|
||||
**Rejected Options:**
|
||||
|
||||
- Option A rejected because: ...
|
||||
```
|
||||
|
||||
**ADRs are populated throughout the workflow** as decisions are made:
|
||||
|
||||
- Step 3: Architecture pattern ADR
|
||||
- Step 5: Technology selection ADRs
|
||||
- Step 6: Engine-specific ADRs (from guide)
|
||||
|
||||
---
|
||||
|
||||
## Scale-Adaptive Behavior
|
||||
|
||||
| Level | Project Size | Architecture Depth | Specialist Sections |
|
||||
| ----- | -------------------------------- | --------------------------- | -------------------------- |
|
||||
| **0** | Single task | Skip architecture | N/A |
|
||||
| **1** | Small feature (1-10 stories) | Lightweight, essential only | Inline guidance |
|
||||
| **2** | Small project (5-15 stories) | Standard depth | Inline guidance |
|
||||
| **3** | Standard project (12-40 stories) | Comprehensive | Specialist placeholders |
|
||||
| **4** | Ambitious product (40+ stories) | Comprehensive + specialists | Specialist recommendations |
|
||||
|
||||
---
|
||||
|
||||
## Specialist Integration
|
||||
|
||||
Pattern-specific specialists are recommended based on project characteristics:
|
||||
|
||||
**Game Projects:**
|
||||
|
||||
- Audio Designer (music, SFX, adaptive audio)
|
||||
- Performance Optimizer (profiling, optimization)
|
||||
- Multiplayer Architect (netcode, state sync)
|
||||
- Monetization Specialist (IAP, ads, economy)
|
||||
|
||||
**Web Projects:**
|
||||
|
||||
- Frontend Architect (component design, state management)
|
||||
- Backend Architect (API design, microservices)
|
||||
- DevOps Specialist (CI/CD, deployment)
|
||||
- Security Specialist (auth, authorization, secrets)
|
||||
|
||||
**Embedded Projects:**
|
||||
|
||||
- Hardware Integration (sensors, actuators, protocols)
|
||||
- Power Management (battery, sleep modes)
|
||||
- RF/Wireless (WiFi, BLE, LoRa)
|
||||
- Safety Certification (if required)
|
||||
|
||||
Specialists are documented with:
|
||||
|
||||
- When they're needed
|
||||
- What they're responsible for
|
||||
- How they integrate with the workflow
|
||||
|
||||
---
|
||||
|
||||
## Key Differences from Legacy HLA Workflow
|
||||
|
||||
| Aspect | Legacy HLA | New Solution Architecture |
|
||||
| ------------------- | --------------- | ----------------------------------------- |
|
||||
| **Templates** | Fixed structure | 11 complete templates, pattern-specific |
|
||||
| **Tech Selection** | Manual | 171 pre-defined combinations |
|
||||
| **Engine Guidance** | Generic | Engine-specific guides (Unity/Godot/etc.) |
|
||||
| **ADRs** | Inline | Separate document |
|
||||
| **GDD Support** | No | Yes, for game projects |
|
||||
| **Guides** | None | Pattern-specific workflow guidance |
|
||||
| **Scale** | One size | Adaptive Levels 0-4 |
|
||||
|
||||
---
|
||||
|
||||
## Validation and Quality Gates
|
||||
|
||||
### Cohesion Check (Step 7)
|
||||
|
||||
**Validates:**
|
||||
|
||||
- ✅ 100% FR coverage (or gaps documented)
|
||||
- ✅ 100% NFR coverage (or gaps documented)
|
||||
- ✅ Every epic has technical foundation
|
||||
- ✅ Every story can be implemented with current architecture
|
||||
- ✅ Technology table complete with specific versions
|
||||
- ✅ No vagueness detected
|
||||
- ✅ Design-level only (no over-implementation)
|
||||
|
||||
**Outputs:**
|
||||
|
||||
- `cohesion-check-report.md` - Pass/fail with detailed gaps
|
||||
- `epic-alignment-matrix.md` - Mapping validation
|
||||
|
||||
**If cohesion check fails:**
|
||||
|
||||
- Document gaps
|
||||
- Update architecture
|
||||
- Re-run check
|
||||
|
||||
---
|
||||
|
||||
## Getting Started for Implementers
|
||||
|
||||
### For Games:
|
||||
|
||||
1. Run `workflow plan-project` → Create GDD
|
||||
2. Specify engine in GDD (Unity/Godot/Phaser/etc.)
|
||||
3. Run `workflow solution-architecture`
|
||||
4. System detects engine from GDD
|
||||
5. Loads game-engine template + engine-specific guide
|
||||
6. Generates Unity/Godot/Phaser-specific architecture
|
||||
|
||||
### For Web Apps:
|
||||
|
||||
1. Run `workflow plan-project` → Create PRD
|
||||
2. Run `workflow ux-spec` → Create UX spec
|
||||
3. Run `workflow solution-architecture`
|
||||
4. Answer: SSR or SPA? Monolith or microservices?
|
||||
5. System loads web-fullstack template
|
||||
6. Generates framework-specific architecture
|
||||
|
||||
### For Other Projects:
|
||||
|
||||
1. Run `workflow plan-project` → Create PRD
|
||||
2. Run `workflow solution-architecture`
|
||||
3. Answer project-type questions
|
||||
4. System loads appropriate template
|
||||
5. Generates pattern-specific architecture
|
||||
|
||||
---
|
||||
|
||||
## Extending the System
|
||||
|
||||
### Adding a New Template
|
||||
|
||||
1. Create `templates/new-pattern-architecture.md`
|
||||
2. Include all standard sections + pattern-specific sections
|
||||
3. Add rows to `templates/registry.csv` pointing to new template
|
||||
|
||||
### Adding a New Guide
|
||||
|
||||
1. Create `templates/new-tech-guide.md`
|
||||
2. Include: questions, patterns, pitfalls, specialist recommendations
|
||||
3. Update `templates/registry.csv` with `guide_path` column
|
||||
|
||||
### Adding a New Project Type
|
||||
|
||||
1. Add row to `project-types/project-types.csv`
|
||||
2. Create `project-types/new-type-questions.md`
|
||||
3. Ensure templates exist for this type
|
||||
4. Update instructions.md if special handling needed (like GDD for games)
|
||||
|
||||
---
|
||||
|
||||
## Questions?
|
||||
|
||||
- **Validation:** See `checklist.md`
|
||||
- **Workflow Logic:** See `instructions.md`
|
||||
- **Configuration:** See `workflow.yaml`
|
||||
- **Registry Format:** See `templates/registry.csv`
|
||||
- **Example Guide:** See `templates/game-engine-unity-guide.md`
|
||||
|
||||
---
|
||||
|
||||
_This workflow replaces the legacy HLA workflow with a modern, scale-adaptive, pattern-aware architecture generation system._
|
||||
@@ -1,170 +0,0 @@
|
||||
# Solution Architecture Checklist
|
||||
|
||||
Use this checklist during workflow execution and review.
|
||||
|
||||
## Pre-Workflow
|
||||
|
||||
- [ ] analysis-template.md exists from plan-project phase
|
||||
- [ ] PRD exists with FRs, NFRs, epics, and stories (for Level 1+)
|
||||
- [ ] UX specification exists (for UI projects at Level 2+)
|
||||
- [ ] Project level determined (0-4)
|
||||
|
||||
## During Workflow
|
||||
|
||||
### Step 0: Scale Assessment
|
||||
|
||||
- [ ] Analysis template loaded
|
||||
- [ ] Project level extracted
|
||||
- [ ] Level 0 → Skip workflow OR Level 1-4 → Proceed
|
||||
|
||||
### Step 1: PRD Analysis
|
||||
|
||||
- [ ] All FRs extracted
|
||||
- [ ] All NFRs extracted
|
||||
- [ ] All epics/stories identified
|
||||
- [ ] Project type detected
|
||||
- [ ] Constraints identified
|
||||
|
||||
### Step 2: User Skill Level
|
||||
|
||||
- [ ] Skill level clarified (beginner/intermediate/expert)
|
||||
- [ ] Technical preferences captured
|
||||
|
||||
### Step 3: Stack Recommendation
|
||||
|
||||
- [ ] Reference architectures searched
|
||||
- [ ] Top 3 presented to user
|
||||
- [ ] Selection made (reference or custom)
|
||||
|
||||
### Step 4: Component Boundaries
|
||||
|
||||
- [ ] Epics analyzed
|
||||
- [ ] Component boundaries identified
|
||||
- [ ] Architecture style determined (monolith/microservices/etc.)
|
||||
- [ ] Repository strategy determined (monorepo/polyrepo)
|
||||
|
||||
### Step 5: Project-Type Questions
|
||||
|
||||
- [ ] Project-type questions loaded
|
||||
- [ ] Only unanswered questions asked (dynamic narrowing)
|
||||
- [ ] All decisions recorded
|
||||
|
||||
### Step 6: Architecture Generation
|
||||
|
||||
- [ ] Template sections determined dynamically
|
||||
- [ ] User approved section list
|
||||
- [ ] architecture.md generated with ALL sections
|
||||
- [ ] Technology and Library Decision Table included with specific versions
|
||||
- [ ] Proposed Source Tree included
|
||||
- [ ] Design-level only (no extensive code)
|
||||
- [ ] Output adapted to user skill level
|
||||
|
||||
### Step 7: Cohesion Check
|
||||
|
||||
- [ ] Requirements coverage validated (FRs, NFRs, epics, stories)
|
||||
- [ ] Technology table validated (no vagueness)
|
||||
- [ ] Code vs design balance checked
|
||||
- [ ] Epic Alignment Matrix generated (separate output)
|
||||
- [ ] Story readiness assessed (X of Y ready)
|
||||
- [ ] Vagueness detected and flagged
|
||||
- [ ] Over-specification detected and flagged
|
||||
- [ ] Cohesion check report generated
|
||||
- [ ] Issues addressed or acknowledged
|
||||
|
||||
### Step 7.5: Specialist Sections
|
||||
|
||||
- [ ] DevOps assessed (simple inline or complex placeholder)
|
||||
- [ ] Security assessed (simple inline or complex placeholder)
|
||||
- [ ] Testing assessed (simple inline or complex placeholder)
|
||||
- [ ] Specialist sections added to END of architecture.md
|
||||
|
||||
### Step 8: PRD Updates (Optional)
|
||||
|
||||
- [ ] Architectural discoveries identified
|
||||
- [ ] PRD updated if needed (enabler epics, story clarifications)
|
||||
|
||||
### Step 9: Tech-Spec Generation
|
||||
|
||||
- [ ] Tech-spec generated for each epic
|
||||
- [ ] Saved as tech-spec-epic-{{N}}.md
|
||||
- [ ] project-workflow-analysis.md updated
|
||||
|
||||
### Step 10: Polyrepo Strategy (Optional)
|
||||
|
||||
- [ ] Polyrepo identified (if applicable)
|
||||
- [ ] Documentation copying strategy determined
|
||||
- [ ] Full docs copied to all repos
|
||||
|
||||
### Step 11: Validation
|
||||
|
||||
- [ ] All required documents exist
|
||||
- [ ] All checklists passed
|
||||
- [ ] Completion summary generated
|
||||
|
||||
## Quality Gates
|
||||
|
||||
### Technology and Library Decision Table
|
||||
|
||||
- [ ] Table exists in architecture.md
|
||||
- [ ] ALL technologies have specific versions (e.g., "pino 8.17.0")
|
||||
- [ ] NO vague entries ("a logging library", "appropriate caching")
|
||||
- [ ] NO multi-option entries without decision ("Pino or Winston")
|
||||
- [ ] Grouped logically (core stack, libraries, devops)
|
||||
|
||||
### Proposed Source Tree
|
||||
|
||||
- [ ] Section exists in architecture.md
|
||||
- [ ] Complete directory structure shown
|
||||
- [ ] For polyrepo: ALL repo structures included
|
||||
- [ ] Matches technology stack conventions
|
||||
|
||||
### Cohesion Check Results
|
||||
|
||||
- [ ] 100% FR coverage OR gaps documented
|
||||
- [ ] 100% NFR coverage OR gaps documented
|
||||
- [ ] 100% epic coverage OR gaps documented
|
||||
- [ ] 100% story readiness OR gaps documented
|
||||
- [ ] Epic Alignment Matrix generated (separate file)
|
||||
- [ ] Readiness score ≥ 90% OR user accepted lower score
|
||||
|
||||
### Design vs Code Balance
|
||||
|
||||
- [ ] No code blocks > 10 lines
|
||||
- [ ] Focus on schemas, patterns, diagrams
|
||||
- [ ] No complete implementations
|
||||
|
||||
## Post-Workflow Outputs
|
||||
|
||||
### Required Files
|
||||
|
||||
- [ ] /docs/architecture.md (or solution-architecture.md)
|
||||
- [ ] /docs/cohesion-check-report.md
|
||||
- [ ] /docs/epic-alignment-matrix.md
|
||||
- [ ] /docs/tech-spec-epic-1.md
|
||||
- [ ] /docs/tech-spec-epic-2.md
|
||||
- [ ] /docs/tech-spec-epic-N.md (for all epics)
|
||||
|
||||
### Optional Files (if specialist placeholders created)
|
||||
|
||||
- [ ] Handoff instructions for devops-architecture workflow
|
||||
- [ ] Handoff instructions for security-architecture workflow
|
||||
- [ ] Handoff instructions for test-architect workflow
|
||||
|
||||
### Updated Files
|
||||
|
||||
- [ ] analysis-template.md (workflow status updated)
|
||||
- [ ] prd.md (if architectural discoveries required updates)
|
||||
|
||||
## Next Steps After Workflow
|
||||
|
||||
If specialist placeholders created:
|
||||
|
||||
- [ ] Run devops-architecture workflow (if placeholder)
|
||||
- [ ] Run security-architecture workflow (if placeholder)
|
||||
- [ ] Run test-architect workflow (if placeholder)
|
||||
|
||||
For implementation:
|
||||
|
||||
- [ ] Review all tech specs
|
||||
- [ ] Set up development environment per architecture
|
||||
- [ ] Begin epic implementation using tech specs
|
||||
@@ -1,661 +0,0 @@
|
||||
# Solution Architecture Workflow Instructions
|
||||
|
||||
This workflow generates scale-adaptive solution architecture documentation that replaces the legacy HLA workflow.
|
||||
|
||||
```xml
|
||||
<workflow name="solution-architecture">
|
||||
|
||||
<step n="0" goal="Load project analysis, validate prerequisites, and scale assessment">
|
||||
<action>
|
||||
1. Read project-workflow-analysis.md:
|
||||
Path: {{project_workflow_analysis_path}}
|
||||
|
||||
2. Extract:
|
||||
- project_level: {{0|1|2|3|4}}
|
||||
- field_type: {{greenfield|brownfield}}
|
||||
- project_type: {{web|mobile|embedded|game|library}}
|
||||
- has_user_interface: {{true|false}}
|
||||
- ui_complexity: {{none|simple|moderate|complex}}
|
||||
- ux_spec_path: /docs/ux-spec.md (if exists)
|
||||
- prd_status: {{complete|incomplete}}
|
||||
|
||||
3. Validate Prerequisites (BLOCKING):
|
||||
|
||||
Check 1: PRD complete?
|
||||
IF prd_status != complete:
|
||||
❌ STOP WORKFLOW
|
||||
Output: "PRD is required before solution architecture.
|
||||
|
||||
REQUIRED: Complete PRD with FRs, NFRs, epics, and stories.
|
||||
|
||||
Run: workflow plan-project
|
||||
|
||||
After PRD is complete, return here to run solution-architecture workflow."
|
||||
END
|
||||
|
||||
Check 2: UX Spec complete (if UI project)?
|
||||
IF has_user_interface == true AND ux_spec_missing:
|
||||
❌ STOP WORKFLOW
|
||||
Output: "UX Spec is required before solution architecture for UI projects.
|
||||
|
||||
REQUIRED: Complete UX specification before proceeding.
|
||||
|
||||
Run: workflow ux-spec
|
||||
|
||||
The UX spec will define:
|
||||
- Screen/page structure
|
||||
- Navigation flows
|
||||
- Key user journeys
|
||||
- UI/UX patterns and components
|
||||
- Responsive requirements
|
||||
- Accessibility requirements
|
||||
|
||||
Once complete, the UX spec will inform:
|
||||
- Frontend architecture and component structure
|
||||
- API design (driven by screen data needs)
|
||||
- State management strategy
|
||||
- Technology choices (component libraries, animation, etc.)
|
||||
- Performance requirements (lazy loading, code splitting)
|
||||
|
||||
After UX spec is complete at /docs/ux-spec.md, return here to run solution-architecture workflow."
|
||||
END
|
||||
|
||||
Check 3: All prerequisites met?
|
||||
IF all prerequisites met:
|
||||
✅ Prerequisites validated
|
||||
- PRD: complete
|
||||
- UX Spec: {{complete | not_applicable}}
|
||||
Proceeding with solution architecture workflow...
|
||||
|
||||
4. Determine workflow path:
|
||||
IF project_level == 0:
|
||||
- Skip solution architecture entirely
|
||||
- Output: "Level 0 project - validate/update tech-spec.md only"
|
||||
- STOP WORKFLOW
|
||||
ELSE:
|
||||
- Proceed with full solution architecture workflow
|
||||
</action>
|
||||
<template-output>prerequisites_and_scale_assessment</template-output>
|
||||
</step>
|
||||
|
||||
<step n="1" goal="Deep requirements document and spec analysis">
|
||||
<action>
|
||||
1. Determine requirements document type based on project_type:
|
||||
- IF project_type == "game":
|
||||
Primary Doc: Game Design Document (GDD)
|
||||
Path: {{gdd_path}} OR {{prd_path}}/GDD.md
|
||||
- ELSE:
|
||||
Primary Doc: Product Requirements Document (PRD)
|
||||
Path: {{prd_path}}
|
||||
|
||||
2. Read primary requirements document:
|
||||
Read: {{determined_path}}
|
||||
|
||||
Extract based on document type:
|
||||
|
||||
IF GDD (Game):
|
||||
- Game concept and genre
|
||||
- Core gameplay mechanics
|
||||
- Player progression systems
|
||||
- Game world/levels/scenes
|
||||
- Characters and entities
|
||||
- Win/loss conditions
|
||||
- Game modes (single-player, multiplayer, etc.)
|
||||
- Technical requirements (platform, performance targets)
|
||||
- Art/audio direction
|
||||
- Monetization (if applicable)
|
||||
|
||||
IF PRD (Non-Game):
|
||||
- All Functional Requirements (FRs)
|
||||
- All Non-Functional Requirements (NFRs)
|
||||
- All Epics with user stories
|
||||
- Technical constraints mentioned
|
||||
- Integrations required (payments, email, etc.)
|
||||
|
||||
3. Read UX Spec (if project has UI):
|
||||
IF has_user_interface == true:
|
||||
Read: {{ux_spec_path}}
|
||||
|
||||
Extract:
|
||||
- All screens/pages (list every screen defined)
|
||||
- Navigation structure (how screens connect, patterns)
|
||||
- Key user flows (auth, onboarding, checkout, core features)
|
||||
- UI complexity indicators:
|
||||
* Complex wizards/multi-step forms
|
||||
* Real-time updates/dashboards
|
||||
* Complex state machines
|
||||
* Rich interactions (drag-drop, animations)
|
||||
* Infinite scroll, virtualization needs
|
||||
- Component patterns (from design system/wireframes)
|
||||
- Responsive requirements (mobile-first, desktop-first, adaptive)
|
||||
- Accessibility requirements (WCAG level, screen reader support)
|
||||
- Design system/tokens (colors, typography, spacing if specified)
|
||||
- Performance requirements (page load times, frame rates)
|
||||
|
||||
4. Cross-reference requirements + specs:
|
||||
IF GDD + UX Spec (game with UI):
|
||||
- Each gameplay mechanic should have UI representation
|
||||
- Each scene/level should have visual design
|
||||
- Player controls mapped to UI elements
|
||||
|
||||
IF PRD + UX Spec (non-game):
|
||||
- Each epic should have corresponding screens/flows in UX spec
|
||||
- Each screen should support epic stories
|
||||
- FRs should have UI manifestation (where applicable)
|
||||
- NFRs (performance, accessibility) should inform UX patterns
|
||||
- Identify gaps: Epics without screens, screens without epic mapping
|
||||
|
||||
5. Detect characteristics:
|
||||
- Project type(s): web, mobile, embedded, game, library, desktop
|
||||
- UI complexity: simple (CRUD) | moderate (dashboards) | complex (wizards/real-time)
|
||||
- Architecture style hints: monolith, microservices, modular, etc.
|
||||
- Repository strategy hints: monorepo, polyrepo, hybrid
|
||||
- Special needs: real-time, event-driven, batch, offline-first
|
||||
|
||||
6. Identify what's already specified vs. unknown
|
||||
- Known: Technologies explicitly mentioned in PRD/UX spec
|
||||
- Unknown: Gaps that need decisions
|
||||
|
||||
Output summary:
|
||||
- Project understanding
|
||||
- UI/UX summary (if applicable):
|
||||
* Screen count: N screens
|
||||
* Navigation complexity: simple | moderate | complex
|
||||
* UI complexity: simple | moderate | complex
|
||||
* Key user flows documented
|
||||
- PRD-UX alignment check: Gaps identified (if any)
|
||||
</action>
|
||||
<template-output>prd_and_ux_analysis</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="User skill level and preference clarification">
|
||||
<ask>
|
||||
What's your experience level with {{project_type}} development?
|
||||
|
||||
1. Beginner - Need detailed explanations and guidance
|
||||
2. Intermediate - Some explanations helpful
|
||||
3. Expert - Concise output, minimal explanations
|
||||
|
||||
Your choice (1/2/3):
|
||||
</ask>
|
||||
|
||||
<action>
|
||||
Set user_skill_level variable for adaptive output:
|
||||
- beginner: Verbose explanations, examples, rationale for every decision
|
||||
- intermediate: Moderate explanations, key rationale, balanced detail
|
||||
- expert: Concise, decision-focused, minimal prose
|
||||
|
||||
This affects ALL subsequent output verbosity.
|
||||
</action>
|
||||
|
||||
<ask optional="true">
|
||||
Any technical preferences or constraints I should know?
|
||||
- Preferred languages/frameworks?
|
||||
- Required platforms/services?
|
||||
- Team expertise areas?
|
||||
- Existing infrastructure (brownfield)?
|
||||
|
||||
(Press enter to skip if none)
|
||||
</ask>
|
||||
|
||||
<action>
|
||||
Record preferences for narrowing recommendations.
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Determine architecture pattern">
|
||||
<action>
|
||||
Determine the architectural pattern based on requirements:
|
||||
|
||||
1. Architecture style:
|
||||
- Monolith (single application)
|
||||
- Microservices (multiple services)
|
||||
- Serverless (function-based)
|
||||
- Other (event-driven, JAMstack, etc.)
|
||||
|
||||
2. Repository strategy:
|
||||
- Monorepo (single repo)
|
||||
- Polyrepo (multiple repos)
|
||||
- Hybrid
|
||||
|
||||
3. Pattern-specific characteristics:
|
||||
- For web: SSR vs SPA vs API-only
|
||||
- For mobile: Native vs cross-platform vs hybrid vs PWA
|
||||
- For game: 2D vs 3D vs text-based vs web
|
||||
- For backend: REST vs GraphQL vs gRPC vs realtime
|
||||
- For data: ETL vs ML vs analytics vs streaming
|
||||
- Etc.
|
||||
</action>
|
||||
|
||||
<ask>
|
||||
Based on your requirements, I need to determine the architecture pattern:
|
||||
|
||||
1. Architecture style: {{suggested_style}} - Does this sound right? (or specify: monolith/microservices/serverless/other)
|
||||
|
||||
2. Repository strategy: {{suggested_repo_strategy}} - Monorepo or polyrepo?
|
||||
|
||||
{{project_type_specific_questions}}
|
||||
</ask>
|
||||
|
||||
<elicit-required/>
|
||||
<template-output>architecture_pattern</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Epic analysis and component boundaries">
|
||||
<action>
|
||||
1. Analyze each epic from PRD:
|
||||
- What domain capabilities does it require?
|
||||
- What data does it operate on?
|
||||
- What integrations does it need?
|
||||
|
||||
2. Identify natural component/service boundaries:
|
||||
- Vertical slices (epic-aligned features)
|
||||
- Shared infrastructure (auth, logging, etc.)
|
||||
- Integration points (external services)
|
||||
|
||||
3. Determine architecture style:
|
||||
- Single monolith vs. multiple services
|
||||
- Monorepo vs. polyrepo
|
||||
- Modular monolith vs. microservices
|
||||
|
||||
4. Map epics to proposed components (high-level only)
|
||||
</action>
|
||||
<template-output>component_boundaries</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Project-type-specific architecture questions">
|
||||
<action>
|
||||
1. Load project types registry:
|
||||
Read: {{installed_path}}/project-types/project-types.csv
|
||||
|
||||
2. Match detected project_type to CSV:
|
||||
- Use project_type from Step 1 (e.g., "web", "mobile", "backend")
|
||||
- Find matching row in CSV
|
||||
- Get question_file path
|
||||
|
||||
3. Load project-type-specific questions:
|
||||
Read: {{installed_path}}/project-types/{{question_file}}
|
||||
|
||||
4. Ask only UNANSWERED questions (dynamic narrowing):
|
||||
- Skip questions already answered by reference architecture
|
||||
- Skip questions already specified in PRD
|
||||
- Focus on gaps and ambiguities
|
||||
|
||||
5. Record all decisions with rationale
|
||||
|
||||
NOTE: For hybrid projects (e.g., "web + mobile"), load multiple question files
|
||||
</action>
|
||||
|
||||
<ask>
|
||||
{{project_type_specific_questions}}
|
||||
</ask>
|
||||
|
||||
<elicit-required/>
|
||||
<template-output>architecture_decisions</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Generate solution architecture document with dynamic template">
|
||||
<action>
|
||||
Sub-step 6.1: Load Appropriate Template
|
||||
|
||||
1. Analyze project to determine:
|
||||
- Project type(s): {{web|mobile|embedded|game|library|cli|desktop|data|backend|infra|extension}}
|
||||
- Architecture style: {{monolith|microservices|serverless|etc}}
|
||||
- Repository strategy: {{monorepo|polyrepo|hybrid}}
|
||||
- Primary language(s): {{TypeScript|Python|Rust|etc}}
|
||||
|
||||
2. Search template registry:
|
||||
Read: {{installed_path}}/templates/registry.csv
|
||||
|
||||
Filter WHERE:
|
||||
- project_types = {{project_type}}
|
||||
- architecture_style = {{determined_style}}
|
||||
- repo_strategy = {{determined_strategy}}
|
||||
- languages matches {{language_preference}} (if specified)
|
||||
- tags overlap with {{requirements}}
|
||||
|
||||
3. Select best matching row:
|
||||
Get {{template_path}} and {{guide_path}} from matched CSV row
|
||||
Example template: "web-fullstack-architecture.md", "game-engine-architecture.md", etc.
|
||||
Example guide: "game-engine-unity-guide.md", "game-engine-godot-guide.md", etc.
|
||||
|
||||
4. Load markdown template:
|
||||
Read: {{installed_path}}/templates/{{template_path}}
|
||||
|
||||
This template contains:
|
||||
- Complete document structure with all sections
|
||||
- {{placeholder}} variables to fill (e.g., {{project_name}}, {{framework}}, {{database_schema}})
|
||||
- Pattern-specific sections (e.g., SSR sections for web, gameplay sections for games)
|
||||
- Specialist recommendations (e.g., audio-designer for games, hardware-integration for embedded)
|
||||
|
||||
5. Load pattern-specific guide (if available):
|
||||
IF {{guide_path}} is not empty:
|
||||
Read: {{installed_path}}/templates/{{guide_path}}
|
||||
|
||||
This guide contains:
|
||||
- Engine/framework-specific questions
|
||||
- Technology-specific best practices
|
||||
- Common patterns and pitfalls
|
||||
- Specialist recommendations for this specific tech stack
|
||||
- Pattern-specific ADR examples
|
||||
|
||||
6. Present template to user:
|
||||
</action>
|
||||
|
||||
<ask>
|
||||
Based on your {{project_type}} {{architecture_style}} project, I've selected the "{{template_path}}" template.
|
||||
|
||||
This template includes {{section_count}} sections covering:
|
||||
{{brief_section_list}}
|
||||
|
||||
I will now fill in all the {{placeholder}} variables based on our previous discussions and requirements.
|
||||
|
||||
Options:
|
||||
1. Use this template (recommended)
|
||||
2. Use a different template (specify which one)
|
||||
3. Show me the full template structure first
|
||||
|
||||
Your choice (1/2/3):
|
||||
</ask>
|
||||
|
||||
<action>
|
||||
Sub-step 6.2: Fill Template Placeholders
|
||||
|
||||
6. Parse template to identify all {{placeholders}}
|
||||
|
||||
7. Fill each placeholder with appropriate content:
|
||||
- Use information from previous steps (PRD, UX spec, tech decisions)
|
||||
- Ask user for any missing information
|
||||
- Generate appropriate content based on user_skill_level
|
||||
|
||||
8. Generate final architecture.md document
|
||||
|
||||
CRITICAL REQUIREMENTS:
|
||||
- MUST include "Technology and Library Decisions" section with table:
|
||||
| Category | Technology | Version | Rationale |
|
||||
- ALL technologies with SPECIFIC versions (e.g., "pino 8.17.0")
|
||||
- NO vagueness ("a logging library" = FAIL)
|
||||
|
||||
- MUST include "Proposed Source Tree" section:
|
||||
- Complete directory/file structure
|
||||
- For polyrepo: show ALL repo structures
|
||||
|
||||
- Design-level only (NO extensive code implementations):
|
||||
- ✅ DO: Data model schemas, API contracts, diagrams, patterns
|
||||
- ❌ DON'T: 10+ line functions, complete components, detailed implementations
|
||||
|
||||
- Adapt verbosity to user_skill_level:
|
||||
- Beginner: Detailed explanations, examples, rationale
|
||||
- Intermediate: Key explanations, balanced
|
||||
- Expert: Concise, decision-focused
|
||||
|
||||
Common sections (adapt per project):
|
||||
1. Executive Summary
|
||||
2. Technology Stack and Decisions (TABLE REQUIRED)
|
||||
3. Repository and Service Architecture (mono/poly, monolith/microservices)
|
||||
4. System Architecture (diagrams)
|
||||
5. Data Architecture
|
||||
6. API/Interface Design (adapts: REST for web, protocols for embedded, etc.)
|
||||
7. Cross-Cutting Concerns
|
||||
8. Component and Integration Overview (NOT epic alignment - that's cohesion check)
|
||||
9. Architecture Decision Records
|
||||
10. Implementation Guidance
|
||||
11. Proposed Source Tree (REQUIRED)
|
||||
12-14. Specialist sections (DevOps, Security, Testing) - see Step 7.5
|
||||
|
||||
NOTE: Section list is DYNAMIC per project type. Embedded projects have different sections than web apps.
|
||||
</action>
|
||||
|
||||
<template-output>solution_architecture</template-output>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Solution architecture cohesion check (QUALITY GATE)">
|
||||
<action>
|
||||
CRITICAL: This is a validation quality gate before proceeding.
|
||||
|
||||
Run cohesion check validation inline (NO separate workflow for now):
|
||||
|
||||
1. Requirements Coverage:
|
||||
- Every FR mapped to components/technology?
|
||||
- Every NFR addressed in architecture?
|
||||
- Every epic has technical foundation?
|
||||
- Every story can be implemented with current architecture?
|
||||
|
||||
2. Technology and Library Table Validation:
|
||||
- Table exists?
|
||||
- All entries have specific versions?
|
||||
- No vague entries ("a library", "some framework")?
|
||||
- No multi-option entries without decision?
|
||||
|
||||
3. Code vs Design Balance:
|
||||
- Any sections with 10+ lines of code? (FLAG for removal)
|
||||
- Focus on design (schemas, patterns, diagrams)?
|
||||
|
||||
4. Vagueness Detection:
|
||||
- Scan for: "appropriate", "standard", "will use", "some", "a library"
|
||||
- Flag all vague statements for specificity
|
||||
|
||||
5. Generate Epic Alignment Matrix:
|
||||
| Epic | Stories | Components | Data Models | APIs | Integration Points | Status |
|
||||
|
||||
This matrix is SEPARATE OUTPUT (not in architecture.md)
|
||||
|
||||
6. Generate Cohesion Check Report with:
|
||||
- Executive summary (READY vs GAPS)
|
||||
- Requirements coverage table
|
||||
- Technology table validation
|
||||
- Epic Alignment Matrix
|
||||
- Story readiness (X of Y stories ready)
|
||||
- Vagueness detected
|
||||
- Over-specification detected
|
||||
- Recommendations (critical/important/nice-to-have)
|
||||
- Overall readiness score
|
||||
|
||||
7. Present report to user
|
||||
</action>
|
||||
|
||||
<template-output>cohesion_check_report</template-output>
|
||||
|
||||
<ask>
|
||||
Cohesion Check Results: {{readiness_score}}% ready
|
||||
|
||||
{{if_gaps_found}}
|
||||
Issues found:
|
||||
{{list_critical_issues}}
|
||||
|
||||
Options:
|
||||
1. I'll fix these issues now (update architecture.md)
|
||||
2. You'll fix them manually
|
||||
3. Proceed anyway (not recommended)
|
||||
|
||||
Your choice:
|
||||
{{/if}}
|
||||
|
||||
{{if_ready}}
|
||||
✅ Architecture is ready for specialist sections!
|
||||
Proceed? (y/n)
|
||||
{{/if}}
|
||||
</ask>
|
||||
|
||||
<action if="user_chooses_option_1">
|
||||
Update architecture.md to address critical issues, then re-validate.
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="7.5" goal="Scale-adaptive specialist section handling" optional="true">
|
||||
<action>
|
||||
For each specialist area (DevOps, Security, Testing), assess complexity:
|
||||
|
||||
DevOps Assessment:
|
||||
- Simple: Vercel/Heroku, 1-2 envs, simple CI/CD → Handle INLINE
|
||||
- Complex: K8s, 3+ envs, complex IaC, multi-region → Create PLACEHOLDER
|
||||
|
||||
Security Assessment:
|
||||
- Simple: Framework defaults, no compliance → Handle INLINE
|
||||
- Complex: HIPAA/PCI/SOC2, custom auth, high sensitivity → Create PLACEHOLDER
|
||||
|
||||
Testing Assessment:
|
||||
- Simple: Basic unit + E2E → Handle INLINE
|
||||
- Complex: Mission-critical UI, comprehensive coverage needed → Create PLACEHOLDER
|
||||
|
||||
For INLINE: Add 1-3 paragraph sections to architecture.md
|
||||
For PLACEHOLDER: Add handoff section with specialist agent invocation instructions
|
||||
</action>
|
||||
|
||||
<ask for_each="specialist_area">
|
||||
{{specialist_area}} Assessment: {{simple|complex}}
|
||||
|
||||
{{if_complex}}
|
||||
Recommendation: Engage {{specialist_area}} specialist agent after this document.
|
||||
|
||||
Options:
|
||||
1. Create placeholder, I'll engage specialist later (recommended)
|
||||
2. Attempt inline coverage now (may be less detailed)
|
||||
3. Skip (handle later)
|
||||
|
||||
Your choice:
|
||||
{{/if}}
|
||||
|
||||
{{if_simple}}
|
||||
I'll handle {{specialist_area}} inline with essentials.
|
||||
{{/if}}
|
||||
</ask>
|
||||
|
||||
<action>
|
||||
Update architecture.md with specialist sections (inline or placeholders) at the END of document.
|
||||
</action>
|
||||
|
||||
<template-output>specialist_sections</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="PRD epic/story updates (if needed)" optional="true">
|
||||
<check>
|
||||
Did cohesion check or architecture design reveal:
|
||||
- Missing enabler epics (e.g., "Infrastructure Setup")?
|
||||
- Story modifications needed?
|
||||
- New FRs/NFRs discovered?
|
||||
</check>
|
||||
|
||||
<ask if="changes_needed">
|
||||
Architecture design revealed some PRD updates needed:
|
||||
{{list_suggested_changes}}
|
||||
|
||||
Should I update the PRD? (y/n)
|
||||
</ask>
|
||||
|
||||
<action if="user_approves">
|
||||
Update PRD with architectural discoveries:
|
||||
- Add enabler epics if needed
|
||||
- Clarify stories based on architecture
|
||||
- Update tech-spec.md with architecture reference
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Tech-spec generation per epic (INTEGRATED)">
|
||||
<action>
|
||||
For each epic in PRD:
|
||||
1. Extract relevant architecture sections:
|
||||
- Technology stack (full table)
|
||||
- Components for this epic
|
||||
- Data models for this epic
|
||||
- APIs for this epic
|
||||
- Proposed source tree (relevant paths)
|
||||
- Implementation guidance
|
||||
|
||||
2. Generate tech-spec-epic-{{N}}.md using tech-spec workflow logic:
|
||||
Read: {project-root}/bmad/bmm/workflows/3-solutioning/tech-spec/instructions.md
|
||||
|
||||
Include:
|
||||
- Epic overview (from PRD)
|
||||
- Stories (from PRD)
|
||||
- Architecture extract (from solution-architecture.md)
|
||||
- Component-level technical decisions
|
||||
- Implementation notes
|
||||
- Testing approach
|
||||
|
||||
3. Save to: /docs/tech-spec-epic-{{N}}.md
|
||||
</action>
|
||||
|
||||
<template-output>tech_specs</template-output>
|
||||
|
||||
<action>
|
||||
Update project-workflow-analysis.md workflow status:
|
||||
- [x] Solution architecture generated
|
||||
- [x] Cohesion check passed
|
||||
- [x] Tech specs generated for all epics
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Polyrepo documentation strategy" optional="true">
|
||||
<check>
|
||||
Is this a polyrepo project (multiple repositories)?
|
||||
</check>
|
||||
|
||||
<action if="polyrepo">
|
||||
For polyrepo projects:
|
||||
|
||||
1. Identify all repositories from architecture:
|
||||
Example: frontend-repo, api-repo, worker-repo, mobile-repo
|
||||
|
||||
2. Strategy: Copy FULL documentation to ALL repos
|
||||
- architecture.md → Copy to each repo
|
||||
- tech-spec-epic-X.md → Copy to each repo (full set)
|
||||
- cohesion-check-report.md → Copy to each repo
|
||||
|
||||
3. Add repo-specific README pointing to docs:
|
||||
"See /docs/architecture.md for complete solution architecture"
|
||||
|
||||
4. Later phases extract per-epic and per-story contexts as needed
|
||||
|
||||
Rationale: Full context in every repo, extract focused contexts during implementation.
|
||||
</action>
|
||||
|
||||
<action if="monorepo">
|
||||
For monorepo projects:
|
||||
- All docs already in single /docs directory
|
||||
- No special strategy needed
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Validation and completion">
|
||||
<action>
|
||||
Final validation checklist:
|
||||
|
||||
- [x] architecture.md exists and is complete
|
||||
- [x] Technology and Library Decision Table has specific versions
|
||||
- [x] Proposed Source Tree section included
|
||||
- [x] Cohesion check passed (or issues addressed)
|
||||
- [x] Epic Alignment Matrix generated
|
||||
- [x] Specialist sections handled (inline or placeholder)
|
||||
- [x] Tech specs generated for all epics
|
||||
- [x] Analysis template updated
|
||||
|
||||
Generate completion summary:
|
||||
- Document locations
|
||||
- Key decisions made
|
||||
- Next steps (engage specialist agents if placeholders, begin implementation)
|
||||
</action>
|
||||
|
||||
<template-output>completion_summary</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Reference Documentation
|
||||
|
||||
For detailed design specification, rationale, examples, and edge cases, see:
|
||||
`./arch-plan.md` (when available in same directory)
|
||||
|
||||
Key sections:
|
||||
|
||||
- Key Design Decisions (15 critical requirements)
|
||||
- Step 6 - Architecture Generation (examples, guidance)
|
||||
- Step 7 - Cohesion Check (validation criteria, report format)
|
||||
- Dynamic Template Section Strategy
|
||||
- CSV Registry Examples
|
||||
|
||||
This instructions.md is the EXECUTABLE guide.
|
||||
arch-plan.md is the REFERENCE specification.
|
||||
@@ -1,490 +0,0 @@
|
||||
# Backend/API Service Architecture Questions
|
||||
|
||||
## Service Type and Architecture
|
||||
|
||||
1. **Service architecture:**
|
||||
- Monolithic API (single service)
|
||||
- Microservices (multiple independent services)
|
||||
- Modular monolith (single deployment, modular code)
|
||||
- Serverless (AWS Lambda, Cloud Functions, etc.)
|
||||
- Hybrid
|
||||
|
||||
2. **API paradigm:**
|
||||
- REST
|
||||
- GraphQL
|
||||
- gRPC
|
||||
- WebSocket (real-time)
|
||||
- Server-Sent Events (SSE)
|
||||
- Message-based (event-driven)
|
||||
- Multiple paradigms
|
||||
|
||||
3. **Communication patterns:**
|
||||
- Synchronous (request-response)
|
||||
- Asynchronous (message queues)
|
||||
- Event-driven (pub/sub)
|
||||
- Webhooks
|
||||
- Multiple patterns
|
||||
|
||||
## Framework and Language
|
||||
|
||||
4. **Backend language/framework:**
|
||||
- Node.js (Express, Fastify, NestJS, Hono)
|
||||
- Python (FastAPI, Django, Flask)
|
||||
- Go (Gin, Echo, Chi, standard lib)
|
||||
- Java/Kotlin (Spring Boot, Micronaut, Quarkus)
|
||||
- C# (.NET Core, ASP.NET)
|
||||
- Ruby (Rails, Sinatra)
|
||||
- Rust (Axum, Actix, Rocket)
|
||||
- PHP (Laravel, Symfony)
|
||||
- Elixir (Phoenix)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
5. **GraphQL implementation (if applicable):**
|
||||
- Apollo Server
|
||||
- GraphQL Yoga
|
||||
- Hasura (auto-generated)
|
||||
- Postgraphile
|
||||
- Custom
|
||||
- Not using GraphQL
|
||||
|
||||
6. **gRPC implementation (if applicable):**
|
||||
- Protocol Buffers
|
||||
- Language-specific gRPC libraries
|
||||
- Not using gRPC
|
||||
|
||||
## Database and Data Layer
|
||||
|
||||
7. **Primary database:**
|
||||
- PostgreSQL
|
||||
- MySQL/MariaDB
|
||||
- MongoDB
|
||||
- DynamoDB (AWS)
|
||||
- Firestore (Google)
|
||||
- CockroachDB
|
||||
- Cassandra
|
||||
- Redis (as primary)
|
||||
- Multiple databases (polyglot persistence)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
8. **Database access pattern:**
|
||||
- ORM (Prisma, TypeORM, SQLAlchemy, Hibernate, etc.)
|
||||
- Query builder (Knex, Kysely, jOOQ)
|
||||
- Raw SQL
|
||||
- Database SDK (Supabase, Firebase)
|
||||
- Mix
|
||||
|
||||
9. **Caching layer:**
|
||||
- Redis
|
||||
- Memcached
|
||||
- In-memory (application cache)
|
||||
- CDN caching (for static responses)
|
||||
- Database query cache
|
||||
- None needed
|
||||
|
||||
10. **Read replicas:**
|
||||
- Yes (separate read/write databases)
|
||||
- No (single database)
|
||||
- Planned for future
|
||||
|
||||
11. **Database sharding:**
|
||||
- Yes (horizontal partitioning)
|
||||
- No (single database)
|
||||
- Planned for scale
|
||||
|
||||
## Authentication and Authorization
|
||||
|
||||
12. **Authentication method:**
|
||||
- JWT (stateless)
|
||||
- Session-based (stateful)
|
||||
- OAuth2 provider (Auth0, Okta, Keycloak)
|
||||
- API keys
|
||||
- Mutual TLS (mTLS)
|
||||
- Multiple methods
|
||||
|
||||
13. **Authorization pattern:**
|
||||
- Role-Based Access Control (RBAC)
|
||||
- Attribute-Based Access Control (ABAC)
|
||||
- Access Control Lists (ACL)
|
||||
- Custom logic
|
||||
- None (open API)
|
||||
|
||||
14. **Identity provider:**
|
||||
- Self-managed (own user database)
|
||||
- Auth0
|
||||
- AWS Cognito
|
||||
- Firebase Auth
|
||||
- Keycloak
|
||||
- Azure AD / Entra ID
|
||||
- Okta
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Message Queue and Event Streaming
|
||||
|
||||
15. **Message queue (if needed):**
|
||||
- RabbitMQ
|
||||
- Apache Kafka
|
||||
- AWS SQS
|
||||
- Google Pub/Sub
|
||||
- Redis (pub/sub)
|
||||
- NATS
|
||||
- None needed
|
||||
- Other: **\_\_\_**
|
||||
|
||||
16. **Event streaming (if needed):**
|
||||
- Apache Kafka
|
||||
- AWS Kinesis
|
||||
- Azure Event Hubs
|
||||
- Redis Streams
|
||||
- None needed
|
||||
|
||||
17. **Background jobs:**
|
||||
- Queue-based (Bull, Celery, Sidekiq)
|
||||
- Cron-based (node-cron, APScheduler)
|
||||
- Serverless functions (scheduled Lambda)
|
||||
- None needed
|
||||
|
||||
## Service Communication (Microservices)
|
||||
|
||||
18. **Service mesh (if microservices):**
|
||||
- Istio
|
||||
- Linkerd
|
||||
- Consul
|
||||
- None (direct communication)
|
||||
- Not applicable
|
||||
|
||||
19. **Service discovery:**
|
||||
- Kubernetes DNS
|
||||
- Consul
|
||||
- etcd
|
||||
- AWS Cloud Map
|
||||
- Hardcoded (for now)
|
||||
- Not applicable
|
||||
|
||||
20. **Inter-service communication:**
|
||||
- HTTP/REST
|
||||
- gRPC
|
||||
- Message queue
|
||||
- Event bus
|
||||
- Not applicable
|
||||
|
||||
## API Design and Documentation
|
||||
|
||||
21. **API versioning:**
|
||||
- URL versioning (/v1/, /v2/)
|
||||
- Header versioning (Accept-Version)
|
||||
- No versioning (single version)
|
||||
- Semantic versioning
|
||||
|
||||
22. **API documentation:**
|
||||
- OpenAPI/Swagger
|
||||
- GraphQL introspection/playground
|
||||
- Postman collections
|
||||
- Custom docs
|
||||
- README only
|
||||
|
||||
23. **API testing tools:**
|
||||
- Postman
|
||||
- Insomnia
|
||||
- REST Client (VS Code)
|
||||
- cURL examples
|
||||
- Multiple tools
|
||||
|
||||
## Rate Limiting and Throttling
|
||||
|
||||
24. **Rate limiting:**
|
||||
- Per-user/API key
|
||||
- Per-IP
|
||||
- Global rate limit
|
||||
- Tiered (different limits per plan)
|
||||
- None (internal API)
|
||||
|
||||
25. **Rate limit implementation:**
|
||||
- Application-level (middleware)
|
||||
- API Gateway
|
||||
- Redis-based
|
||||
- None
|
||||
|
||||
## Data Validation and Processing
|
||||
|
||||
26. **Request validation:**
|
||||
- Schema validation (Zod, Joi, Yup, Pydantic)
|
||||
- Manual validation
|
||||
- Framework built-in
|
||||
- None
|
||||
|
||||
27. **Data serialization:**
|
||||
- JSON
|
||||
- Protocol Buffers
|
||||
- MessagePack
|
||||
- XML
|
||||
- Multiple formats
|
||||
|
||||
28. **File uploads (if applicable):**
|
||||
- Direct to server (local storage)
|
||||
- S3/Cloud storage
|
||||
- Presigned URLs (client direct upload)
|
||||
- None needed
|
||||
|
||||
## Error Handling and Resilience
|
||||
|
||||
29. **Error handling strategy:**
|
||||
- Standard HTTP status codes
|
||||
- Custom error codes
|
||||
- RFC 7807 (Problem Details)
|
||||
- GraphQL errors
|
||||
- Mix
|
||||
|
||||
30. **Circuit breaker (for external services):**
|
||||
- Yes (Hystrix, Resilience4j, Polly)
|
||||
- No (direct calls)
|
||||
- Not needed
|
||||
|
||||
31. **Retry logic:**
|
||||
- Exponential backoff
|
||||
- Fixed retries
|
||||
- No retries
|
||||
- Library-based (axios-retry, etc.)
|
||||
|
||||
32. **Graceful shutdown:**
|
||||
- Yes (drain connections, finish requests)
|
||||
- No (immediate shutdown)
|
||||
|
||||
## Observability
|
||||
|
||||
33. **Logging:**
|
||||
- Structured logging (JSON)
|
||||
- Plain text logs
|
||||
- Library: (Winston, Pino, Logrus, Zap, etc.)
|
||||
|
||||
34. **Log aggregation:**
|
||||
- ELK Stack (Elasticsearch, Logstash, Kibana)
|
||||
- Datadog
|
||||
- Splunk
|
||||
- CloudWatch Logs
|
||||
- Loki + Grafana
|
||||
- None (local logs)
|
||||
|
||||
35. **Metrics and Monitoring:**
|
||||
- Prometheus
|
||||
- Datadog
|
||||
- New Relic
|
||||
- Application Insights
|
||||
- CloudWatch
|
||||
- Grafana
|
||||
- None
|
||||
|
||||
36. **Distributed tracing:**
|
||||
- OpenTelemetry
|
||||
- Jaeger
|
||||
- Zipkin
|
||||
- Datadog APM
|
||||
- AWS X-Ray
|
||||
- None
|
||||
|
||||
37. **Health checks:**
|
||||
- Liveness probe (is service up?)
|
||||
- Readiness probe (can accept traffic?)
|
||||
- Startup probe
|
||||
- Dependency checks (database, cache, etc.)
|
||||
- None
|
||||
|
||||
38. **Alerting:**
|
||||
- PagerDuty
|
||||
- Opsgenie
|
||||
- Slack/Discord webhooks
|
||||
- Email
|
||||
- Custom
|
||||
- None
|
||||
|
||||
## Security
|
||||
|
||||
39. **HTTPS/TLS:**
|
||||
- Required (HTTPS only)
|
||||
- Optional (support both)
|
||||
- Terminated at load balancer
|
||||
|
||||
40. **CORS configuration:**
|
||||
- Specific origins (whitelist)
|
||||
- All origins (open)
|
||||
- None needed (same-origin clients)
|
||||
|
||||
41. **Security headers:**
|
||||
- Helmet.js or equivalent
|
||||
- Custom headers
|
||||
- None (basic)
|
||||
|
||||
42. **Input sanitization:**
|
||||
- SQL injection prevention (parameterized queries)
|
||||
- XSS prevention
|
||||
- CSRF protection
|
||||
- All of the above
|
||||
|
||||
43. **Secrets management:**
|
||||
- Environment variables
|
||||
- AWS Secrets Manager
|
||||
- HashiCorp Vault
|
||||
- Azure Key Vault
|
||||
- Kubernetes Secrets
|
||||
- Doppler
|
||||
- Other: **\_\_\_**
|
||||
|
||||
44. **Compliance requirements:**
|
||||
- GDPR
|
||||
- HIPAA
|
||||
- SOC 2
|
||||
- PCI DSS
|
||||
- None
|
||||
|
||||
## Deployment and Infrastructure
|
||||
|
||||
45. **Deployment platform:**
|
||||
- AWS (ECS, EKS, Lambda, Elastic Beanstalk)
|
||||
- Google Cloud (GKE, Cloud Run, App Engine)
|
||||
- Azure (AKS, App Service, Container Instances)
|
||||
- Kubernetes (self-hosted)
|
||||
- Docker Swarm
|
||||
- Heroku
|
||||
- Railway
|
||||
- Fly.io
|
||||
- Vercel/Netlify (serverless)
|
||||
- VPS (DigitalOcean, Linode)
|
||||
- On-premise
|
||||
- Other: **\_\_\_**
|
||||
|
||||
46. **Containerization:**
|
||||
- Docker
|
||||
- Podman
|
||||
- Not containerized (direct deployment)
|
||||
|
||||
47. **Orchestration:**
|
||||
- Kubernetes
|
||||
- Docker Compose (dev/small scale)
|
||||
- AWS ECS
|
||||
- Nomad
|
||||
- None (single server)
|
||||
|
||||
48. **Infrastructure as Code:**
|
||||
- Terraform
|
||||
- CloudFormation
|
||||
- Pulumi
|
||||
- Bicep (Azure)
|
||||
- CDK (AWS)
|
||||
- Ansible
|
||||
- Manual setup
|
||||
|
||||
49. **Load balancing:**
|
||||
- Application Load Balancer (AWS ALB, Azure App Gateway)
|
||||
- Nginx
|
||||
- HAProxy
|
||||
- Kubernetes Ingress
|
||||
- Traefik
|
||||
- Platform-managed
|
||||
- None (single instance)
|
||||
|
||||
50. **Auto-scaling:**
|
||||
- Horizontal (add more instances)
|
||||
- Vertical (increase instance size)
|
||||
- Serverless (automatic)
|
||||
- None (fixed capacity)
|
||||
|
||||
## CI/CD
|
||||
|
||||
51. **CI/CD platform:**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- CircleCI
|
||||
- Jenkins
|
||||
- AWS CodePipeline
|
||||
- Azure DevOps
|
||||
- Google Cloud Build
|
||||
- Other: **\_\_\_**
|
||||
|
||||
52. **Deployment strategy:**
|
||||
- Rolling deployment
|
||||
- Blue-green deployment
|
||||
- Canary deployment
|
||||
- Recreate (downtime)
|
||||
- Serverless (automatic)
|
||||
|
||||
53. **Testing in CI/CD:**
|
||||
- Unit tests
|
||||
- Integration tests
|
||||
- E2E tests
|
||||
- Load tests
|
||||
- Security scans
|
||||
- All of the above
|
||||
|
||||
## Performance
|
||||
|
||||
54. **Performance requirements:**
|
||||
- High throughput (1000+ req/s)
|
||||
- Moderate (100-1000 req/s)
|
||||
- Low (< 100 req/s)
|
||||
|
||||
55. **Latency requirements:**
|
||||
- Ultra-low (< 10ms)
|
||||
- Low (< 100ms)
|
||||
- Moderate (< 500ms)
|
||||
- No specific requirement
|
||||
|
||||
56. **Connection pooling:**
|
||||
- Database connection pool
|
||||
- HTTP connection pool (for external APIs)
|
||||
- None needed
|
||||
|
||||
57. **CDN (for static assets):**
|
||||
- CloudFront
|
||||
- Cloudflare
|
||||
- Fastly
|
||||
- None (dynamic only)
|
||||
|
||||
## Data and Storage
|
||||
|
||||
58. **File storage (if needed):**
|
||||
- AWS S3
|
||||
- Google Cloud Storage
|
||||
- Azure Blob Storage
|
||||
- MinIO (self-hosted)
|
||||
- Local filesystem
|
||||
- None needed
|
||||
|
||||
59. **Search functionality:**
|
||||
- Elasticsearch
|
||||
- Algolia
|
||||
- Meilisearch
|
||||
- Typesense
|
||||
- Database full-text search
|
||||
- None needed
|
||||
|
||||
60. **Data backup:**
|
||||
- Automated database backups
|
||||
- Point-in-time recovery
|
||||
- Manual backups
|
||||
- Cloud-provider managed
|
||||
- None (dev/test only)
|
||||
|
||||
## Additional Features
|
||||
|
||||
61. **Webhooks (outgoing):**
|
||||
- Yes (notify external systems)
|
||||
- No
|
||||
|
||||
62. **Scheduled tasks/Cron jobs:**
|
||||
- Yes (cleanup, reports, etc.)
|
||||
- No
|
||||
|
||||
63. **Multi-tenancy:**
|
||||
- Single tenant
|
||||
- Multi-tenant (shared database)
|
||||
- Multi-tenant (separate databases)
|
||||
- Not applicable
|
||||
|
||||
64. **Internationalization (i18n):**
|
||||
- Multiple languages/locales
|
||||
- English only
|
||||
- Not applicable
|
||||
|
||||
65. **Audit logging:**
|
||||
- Track all changes (who, what, when)
|
||||
- Critical operations only
|
||||
- None
|
||||
@@ -1,337 +0,0 @@
|
||||
# Command-Line Tool Architecture Questions
|
||||
|
||||
## Language and Runtime
|
||||
|
||||
1. **Primary language:**
|
||||
- Go (compiled, single binary, great for CLIs)
|
||||
- Rust (compiled, safe, performant)
|
||||
- Python (interpreted, easy distribution via pip)
|
||||
- Node.js/TypeScript (npm distribution)
|
||||
- Bash/Shell script (lightweight, ubiquitous)
|
||||
- Ruby (gem distribution)
|
||||
- Java/Kotlin (JVM, jar)
|
||||
- C/C++ (compiled, fastest)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
2. **Target platforms:**
|
||||
- Linux only
|
||||
- macOS only
|
||||
- Windows only
|
||||
- Linux + macOS
|
||||
- All three (Linux + macOS + Windows)
|
||||
- Specific Unix variants: **\_\_\_**
|
||||
|
||||
3. **Distribution method:**
|
||||
- Single binary (compiled)
|
||||
- Script (interpreted, needs runtime)
|
||||
- Package manager (npm, pip, gem, cargo, etc.)
|
||||
- Installer (brew, apt, yum, scoop, chocolatey)
|
||||
- Container (Docker)
|
||||
- Multiple methods
|
||||
|
||||
## CLI Architecture
|
||||
|
||||
4. **Command structure:**
|
||||
- Single command (e.g., `grep pattern file`)
|
||||
- Subcommands (e.g., `git commit`, `docker run`)
|
||||
- Hybrid (main command + subcommands)
|
||||
- Interactive shell (REPL)
|
||||
|
||||
5. **Argument parsing library:**
|
||||
- Go: cobra, cli, flag
|
||||
- Rust: clap, structopt
|
||||
- Python: argparse, click, typer
|
||||
- Node: commander, yargs, oclif
|
||||
- Bash: getopts, manual parsing
|
||||
- Other: **\_\_\_**
|
||||
|
||||
6. **Interactive mode:**
|
||||
- Non-interactive only (runs and exits)
|
||||
- Interactive prompts (inquirer, survey, etc.)
|
||||
- REPL/shell mode
|
||||
- Both modes supported
|
||||
|
||||
7. **Long-running process:**
|
||||
- Quick execution (completes immediately)
|
||||
- Long-running (daemon/service)
|
||||
- Can run in background
|
||||
- Watch mode (monitors and reacts)
|
||||
|
||||
## Input/Output
|
||||
|
||||
8. **Input sources:**
|
||||
- Command-line arguments
|
||||
- Flags/options
|
||||
- Environment variables
|
||||
- Config file (JSON, YAML, TOML, INI)
|
||||
- Interactive prompts
|
||||
- Stdin (pipe input)
|
||||
- Multiple sources
|
||||
|
||||
9. **Output format:**
|
||||
- Plain text (human-readable)
|
||||
- JSON
|
||||
- YAML
|
||||
- XML
|
||||
- CSV/TSV
|
||||
- Table format
|
||||
- User-selectable format
|
||||
- Multiple formats
|
||||
|
||||
10. **Output destination:**
|
||||
- Stdout (standard output)
|
||||
- Stderr (errors only)
|
||||
- File output
|
||||
- Multiple destinations
|
||||
- Quiet mode (no output)
|
||||
|
||||
11. **Colored output:**
|
||||
- ANSI color codes
|
||||
- Auto-detect TTY (color when terminal, plain when piped)
|
||||
- User-configurable (--color flag)
|
||||
- No colors (plain text only)
|
||||
|
||||
12. **Progress indication:**
|
||||
- Progress bars (for long operations)
|
||||
- Spinners (for waiting)
|
||||
- Step-by-step output
|
||||
- Verbose/debug logging
|
||||
- Silent mode option
|
||||
- None needed (fast operations)
|
||||
|
||||
## Configuration
|
||||
|
||||
13. **Configuration file:**
|
||||
- Required (must exist)
|
||||
- Optional (defaults if missing)
|
||||
- Not needed
|
||||
- Generated on first run
|
||||
|
||||
14. **Config file format:**
|
||||
- JSON
|
||||
- YAML
|
||||
- TOML
|
||||
- INI
|
||||
- Custom format
|
||||
- Multiple formats supported
|
||||
|
||||
15. **Config file location:**
|
||||
- Current directory (project-specific)
|
||||
- User home directory (~/.config, ~/.myapp)
|
||||
- System-wide (/etc/)
|
||||
- User-specified path
|
||||
- Multiple locations (cascade/merge)
|
||||
|
||||
16. **Environment variables:**
|
||||
- Used for configuration
|
||||
- Used for secrets/credentials
|
||||
- Used for runtime behavior
|
||||
- Not used
|
||||
|
||||
## Data and Storage
|
||||
|
||||
17. **Persistent data:**
|
||||
- Cache (temporary, can be deleted)
|
||||
- State (must persist)
|
||||
- User data (important)
|
||||
- No persistent data needed
|
||||
|
||||
18. **Data storage location:**
|
||||
- Standard OS locations (XDG Base Directory, AppData, etc.)
|
||||
- Current directory
|
||||
- User-specified
|
||||
- Temporary directory
|
||||
|
||||
19. **Database/Data format:**
|
||||
- SQLite
|
||||
- JSON files
|
||||
- Key-value store (BoltDB, etc.)
|
||||
- CSV/plain files
|
||||
- Remote database
|
||||
- None needed
|
||||
|
||||
## Execution Model
|
||||
|
||||
20. **Execution pattern:**
|
||||
- Run once and exit
|
||||
- Watch mode (monitor changes)
|
||||
- Server/daemon mode
|
||||
- Cron-style (scheduled)
|
||||
- Pipeline component (part of Unix pipeline)
|
||||
|
||||
21. **Concurrency:**
|
||||
- Single-threaded (sequential)
|
||||
- Multi-threaded (parallel operations)
|
||||
- Async I/O
|
||||
- Not applicable
|
||||
|
||||
22. **Signal handling:**
|
||||
- Graceful shutdown (SIGTERM, SIGINT)
|
||||
- Cleanup on exit
|
||||
- Not needed (quick exit)
|
||||
|
||||
## Networking (if applicable)
|
||||
|
||||
23. **Network operations:**
|
||||
- HTTP client (REST API calls)
|
||||
- WebSocket client
|
||||
- SSH client
|
||||
- Database connections
|
||||
- Other protocols: **\_\_\_**
|
||||
- No networking
|
||||
|
||||
24. **Authentication (if API calls):**
|
||||
- API keys (env vars, config)
|
||||
- OAuth2 flow
|
||||
- Username/password
|
||||
- Certificate-based
|
||||
- None needed
|
||||
|
||||
## Error Handling
|
||||
|
||||
25. **Error reporting:**
|
||||
- Stderr with error messages
|
||||
- Exit codes (0 = success, non-zero = error)
|
||||
- Detailed error messages
|
||||
- Stack traces (debug mode)
|
||||
- Simple messages (user-friendly)
|
||||
|
||||
26. **Exit codes:**
|
||||
- Standard (0 = success, 1 = error)
|
||||
- Multiple exit codes (different error types)
|
||||
- Documented exit codes
|
||||
|
||||
27. **Logging:**
|
||||
- Log levels (debug, info, warn, error)
|
||||
- Log file output
|
||||
- Stderr output
|
||||
- Configurable verbosity (--verbose, --quiet)
|
||||
- No logging (simple tool)
|
||||
|
||||
## Piping and Integration
|
||||
|
||||
28. **Stdin support:**
|
||||
- Reads from stdin (pipe input)
|
||||
- Optional stdin (file or stdin)
|
||||
- No stdin support
|
||||
|
||||
29. **Pipeline behavior:**
|
||||
- Filter (reads stdin, writes stdout)
|
||||
- Generator (no input, outputs data)
|
||||
- Consumer (reads input, no stdout)
|
||||
- Transformer (both input and output)
|
||||
|
||||
30. **Shell completion:**
|
||||
- Bash completion
|
||||
- Zsh completion
|
||||
- Fish completion
|
||||
- PowerShell completion
|
||||
- All shells
|
||||
- None
|
||||
|
||||
## Distribution and Installation
|
||||
|
||||
31. **Package managers:**
|
||||
- Homebrew (macOS/Linux)
|
||||
- apt (Debian/Ubuntu)
|
||||
- yum/dnf (RHEL/Fedora)
|
||||
- Chocolatey/Scoop (Windows)
|
||||
- npm/yarn (Node.js)
|
||||
- pip (Python)
|
||||
- cargo (Rust)
|
||||
- Multiple managers
|
||||
- Manual install only
|
||||
|
||||
32. **Installation method:**
|
||||
- Download binary (GitHub Releases)
|
||||
- Install script (curl | bash)
|
||||
- Package manager
|
||||
- Build from source
|
||||
- Container image
|
||||
- Multiple methods
|
||||
|
||||
33. **Binary distribution:**
|
||||
- Single binary (statically linked)
|
||||
- Multiple binaries (per platform)
|
||||
- With dependencies (bundled)
|
||||
|
||||
34. **Cross-compilation:**
|
||||
- Yes (build for all platforms from one machine)
|
||||
- No (need platform-specific builds)
|
||||
|
||||
## Updates
|
||||
|
||||
35. **Update mechanism:**
|
||||
- Self-update command
|
||||
- Package manager update
|
||||
- Manual download
|
||||
- No updates (stable tool)
|
||||
|
||||
36. **Version checking:**
|
||||
- Check for new versions on run
|
||||
- --version flag
|
||||
- No version tracking
|
||||
|
||||
## Documentation
|
||||
|
||||
37. **Help documentation:**
|
||||
- --help flag (inline help)
|
||||
- Man page
|
||||
- Online docs
|
||||
- README only
|
||||
- All of the above
|
||||
|
||||
38. **Examples/Tutorials:**
|
||||
- Built-in examples (--examples)
|
||||
- Online documentation
|
||||
- README with examples
|
||||
- None (self-explanatory)
|
||||
|
||||
## Testing
|
||||
|
||||
39. **Testing approach:**
|
||||
- Unit tests
|
||||
- Integration tests (full CLI execution)
|
||||
- Snapshot testing (output comparison)
|
||||
- Manual testing
|
||||
- All of the above
|
||||
|
||||
40. **CI/CD:**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- Travis CI
|
||||
- Cross-platform testing
|
||||
- Manual builds
|
||||
|
||||
## Performance
|
||||
|
||||
41. **Performance requirements:**
|
||||
- Must be fast (< 100ms)
|
||||
- Moderate (< 1s)
|
||||
- Can be slow (long-running tasks)
|
||||
|
||||
42. **Memory usage:**
|
||||
- Minimal (small files/data)
|
||||
- Streaming (large files, low memory)
|
||||
- Can use significant memory
|
||||
|
||||
## Special Features
|
||||
|
||||
43. **Watch mode:**
|
||||
- Monitor files/directories for changes
|
||||
- Auto-reload/re-run
|
||||
- Not needed
|
||||
|
||||
44. **Dry-run mode:**
|
||||
- Preview changes without applying
|
||||
- Not applicable
|
||||
|
||||
45. **Verbose/Debug mode:**
|
||||
- --verbose flag (detailed output)
|
||||
- --debug flag (even more detail)
|
||||
- Not needed
|
||||
|
||||
46. **Plugins/Extensions:**
|
||||
- Plugin system (user can extend)
|
||||
- Monolithic (no plugins)
|
||||
- Planned for future
|
||||
@@ -1,472 +0,0 @@
|
||||
# Data/Analytics/ML Project Architecture Questions
|
||||
|
||||
## Project Type and Scope
|
||||
|
||||
1. **Primary project focus:**
|
||||
- ETL/Data Pipeline (move and transform data)
|
||||
- Data Analytics (BI, dashboards, reports)
|
||||
- Machine Learning Training (build models)
|
||||
- Machine Learning Inference (serve predictions)
|
||||
- Data Warehouse/Lake (centralized data storage)
|
||||
- Real-time Stream Processing
|
||||
- Data Science Research/Exploration
|
||||
- Multiple focuses
|
||||
|
||||
2. **Scale of data:**
|
||||
- Small (< 1GB, single machine)
|
||||
- Medium (1GB - 1TB, can fit in memory with careful handling)
|
||||
- Large (1TB - 100TB, distributed processing needed)
|
||||
- Very Large (> 100TB, big data infrastructure)
|
||||
|
||||
3. **Data velocity:**
|
||||
- Batch (hourly, daily, weekly)
|
||||
- Micro-batch (every few minutes)
|
||||
- Near real-time (seconds)
|
||||
- Real-time streaming (milliseconds)
|
||||
- Mix
|
||||
|
||||
## Programming Language and Environment
|
||||
|
||||
4. **Primary language:**
|
||||
- Python (pandas, numpy, sklearn, pytorch, tensorflow)
|
||||
- R (tidyverse, caret)
|
||||
- Scala (Spark)
|
||||
- SQL (analytics, transformations)
|
||||
- Java (enterprise data pipelines)
|
||||
- Julia
|
||||
- Multiple languages
|
||||
|
||||
5. **Development environment:**
|
||||
- Jupyter Notebooks (exploration)
|
||||
- Production code (scripts/applications)
|
||||
- Both (notebooks for exploration, code for production)
|
||||
- Cloud notebooks (SageMaker, Vertex AI, Databricks)
|
||||
|
||||
6. **Transition from notebooks to production:**
|
||||
- Convert notebooks to scripts
|
||||
- Use notebooks in production (Papermill, nbconvert)
|
||||
- Keep separate (research vs production)
|
||||
|
||||
## Data Sources
|
||||
|
||||
7. **Data source types:**
|
||||
- Relational databases (PostgreSQL, MySQL, SQL Server)
|
||||
- NoSQL databases (MongoDB, Cassandra)
|
||||
- Data warehouses (Snowflake, BigQuery, Redshift)
|
||||
- APIs (REST, GraphQL)
|
||||
- Files (CSV, JSON, Parquet, Avro)
|
||||
- Streaming sources (Kafka, Kinesis, Pub/Sub)
|
||||
- Cloud storage (S3, GCS, Azure Blob)
|
||||
- SaaS platforms (Salesforce, HubSpot, etc.)
|
||||
- Multiple sources
|
||||
|
||||
8. **Data ingestion frequency:**
|
||||
- One-time load
|
||||
- Scheduled batch (daily, hourly)
|
||||
- Real-time/streaming
|
||||
- On-demand
|
||||
- Mix
|
||||
|
||||
9. **Data ingestion tools:**
|
||||
- Custom scripts (Python, SQL)
|
||||
- Airbyte
|
||||
- Fivetran
|
||||
- Stitch
|
||||
- Apache NiFi
|
||||
- Kafka Connect
|
||||
- Cloud-native (AWS DMS, Google Datastream)
|
||||
- Multiple tools
|
||||
|
||||
## Data Storage
|
||||
|
||||
10. **Primary data storage:**
|
||||
- Data Warehouse (Snowflake, BigQuery, Redshift, Synapse)
|
||||
- Data Lake (S3, GCS, ADLS with Parquet/Avro)
|
||||
- Lakehouse (Databricks, Delta Lake, Iceberg, Hudi)
|
||||
- Relational database
|
||||
- NoSQL database
|
||||
- File system
|
||||
- Multiple storage layers
|
||||
|
||||
11. **Storage format (for files):**
|
||||
- Parquet (columnar, optimized)
|
||||
- Avro (row-based, schema evolution)
|
||||
- ORC (columnar, Hive)
|
||||
- CSV (simple, human-readable)
|
||||
- JSON/JSONL
|
||||
- Delta Lake format
|
||||
- Iceberg format
|
||||
|
||||
12. **Data partitioning strategy:**
|
||||
- By date (year/month/day)
|
||||
- By category/dimension
|
||||
- By hash
|
||||
- No partitioning (small data)
|
||||
|
||||
13. **Data retention policy:**
|
||||
- Keep all data forever
|
||||
- Archive old data (move to cold storage)
|
||||
- Delete after X months/years
|
||||
- Compliance-driven retention
|
||||
|
||||
## Data Processing and Transformation
|
||||
|
||||
14. **Data processing framework:**
|
||||
- pandas (single machine)
|
||||
- Dask (parallel pandas)
|
||||
- Apache Spark (distributed)
|
||||
- Polars (fast, modern dataframes)
|
||||
- SQL (warehouse-native)
|
||||
- Apache Flink (streaming)
|
||||
- dbt (SQL transformations)
|
||||
- Custom code
|
||||
- Multiple frameworks
|
||||
|
||||
15. **Compute platform:**
|
||||
- Local machine (development)
|
||||
- Cloud VMs (EC2, Compute Engine)
|
||||
- Serverless (AWS Lambda, Cloud Functions)
|
||||
- Managed Spark (EMR, Dataproc, Synapse)
|
||||
- Databricks
|
||||
- Snowflake (warehouse compute)
|
||||
- Kubernetes (custom containers)
|
||||
- Multiple platforms
|
||||
|
||||
16. **ETL tool (if applicable):**
|
||||
- dbt (SQL transformations)
|
||||
- Apache Airflow (orchestration + code)
|
||||
- Dagster (data orchestration)
|
||||
- Prefect (workflow orchestration)
|
||||
- AWS Glue
|
||||
- Azure Data Factory
|
||||
- Google Dataflow
|
||||
- Custom scripts
|
||||
- None needed
|
||||
|
||||
17. **Data quality checks:**
|
||||
- Great Expectations
|
||||
- dbt tests
|
||||
- Custom validation scripts
|
||||
- Soda
|
||||
- Monte Carlo
|
||||
- None (trust source data)
|
||||
|
||||
18. **Schema management:**
|
||||
- Schema registry (Confluent, AWS Glue)
|
||||
- Version-controlled schema files
|
||||
- Database schema versioning
|
||||
- Ad-hoc (no formal schema)
|
||||
|
||||
## Machine Learning (if applicable)
|
||||
|
||||
19. **ML framework:**
|
||||
- scikit-learn (classical ML)
|
||||
- PyTorch (deep learning)
|
||||
- TensorFlow/Keras (deep learning)
|
||||
- XGBoost/LightGBM/CatBoost (gradient boosting)
|
||||
- Hugging Face Transformers (NLP)
|
||||
- spaCy (NLP)
|
||||
- Other: **\_\_\_**
|
||||
- Not applicable
|
||||
|
||||
20. **ML use case:**
|
||||
- Classification
|
||||
- Regression
|
||||
- Clustering
|
||||
- Recommendation
|
||||
- NLP (text analysis, generation)
|
||||
- Computer Vision
|
||||
- Time Series Forecasting
|
||||
- Anomaly Detection
|
||||
- Other: **\_\_\_**
|
||||
|
||||
21. **Model training infrastructure:**
|
||||
- Local machine (GPU/CPU)
|
||||
- Cloud VMs with GPU (EC2 P/G instances, GCE A2)
|
||||
- SageMaker
|
||||
- Vertex AI
|
||||
- Azure ML
|
||||
- Databricks ML
|
||||
- Lambda Labs / Paperspace
|
||||
- On-premise cluster
|
||||
|
||||
22. **Experiment tracking:**
|
||||
- MLflow
|
||||
- Weights and Biases
|
||||
- Neptune.ai
|
||||
- Comet
|
||||
- TensorBoard
|
||||
- SageMaker Experiments
|
||||
- Custom logging
|
||||
- None
|
||||
|
||||
23. **Model registry:**
|
||||
- MLflow Model Registry
|
||||
- SageMaker Model Registry
|
||||
- Vertex AI Model Registry
|
||||
- Custom (S3/GCS with metadata)
|
||||
- None
|
||||
|
||||
24. **Feature store:**
|
||||
- Feast
|
||||
- Tecton
|
||||
- SageMaker Feature Store
|
||||
- Databricks Feature Store
|
||||
- Vertex AI Feature Store
|
||||
- Custom (database + cache)
|
||||
- Not needed
|
||||
|
||||
25. **Hyperparameter tuning:**
|
||||
- Manual tuning
|
||||
- Grid search
|
||||
- Random search
|
||||
- Optuna / Hyperopt (Bayesian optimization)
|
||||
- SageMaker/Vertex AI tuning jobs
|
||||
- Ray Tune
|
||||
- Not needed
|
||||
|
||||
26. **Model serving (inference):**
|
||||
- Batch inference (process large datasets)
|
||||
- Real-time API (REST/gRPC)
|
||||
- Streaming inference (Kafka, Kinesis)
|
||||
- Edge deployment (mobile, IoT)
|
||||
- Not applicable (training only)
|
||||
|
||||
27. **Model serving platform (if real-time):**
|
||||
- FastAPI + container (self-hosted)
|
||||
- SageMaker Endpoints
|
||||
- Vertex AI Predictions
|
||||
- Azure ML Endpoints
|
||||
- Seldon Core
|
||||
- KServe
|
||||
- TensorFlow Serving
|
||||
- TorchServe
|
||||
- BentoML
|
||||
- Other: **\_\_\_**
|
||||
|
||||
28. **Model monitoring (in production):**
|
||||
- Data drift detection
|
||||
- Model performance monitoring
|
||||
- Prediction logging
|
||||
- A/B testing infrastructure
|
||||
- None (not in production yet)
|
||||
|
||||
29. **AutoML tools:**
|
||||
- H2O AutoML
|
||||
- Auto-sklearn
|
||||
- TPOT
|
||||
- SageMaker Autopilot
|
||||
- Vertex AI AutoML
|
||||
- Azure AutoML
|
||||
- Not using AutoML
|
||||
|
||||
## Orchestration and Workflow
|
||||
|
||||
30. **Workflow orchestration:**
|
||||
- Apache Airflow
|
||||
- Prefect
|
||||
- Dagster
|
||||
- Argo Workflows
|
||||
- Kubeflow Pipelines
|
||||
- AWS Step Functions
|
||||
- Azure Data Factory
|
||||
- Google Cloud Composer
|
||||
- dbt Cloud
|
||||
- Cron jobs (simple)
|
||||
- None (manual runs)
|
||||
|
||||
31. **Orchestration platform:**
|
||||
- Self-hosted (VMs, K8s)
|
||||
- Managed service (MWAA, Cloud Composer, Prefect Cloud)
|
||||
- Serverless
|
||||
- Multiple platforms
|
||||
|
||||
32. **Job scheduling:**
|
||||
- Time-based (daily, hourly)
|
||||
- Event-driven (S3 upload, database change)
|
||||
- Manual trigger
|
||||
- Continuous (always running)
|
||||
|
||||
33. **Dependency management:**
|
||||
- DAG-based (upstream/downstream tasks)
|
||||
- Data-driven (task runs when data available)
|
||||
- Simple sequential
|
||||
- None (independent tasks)
|
||||
|
||||
## Data Analytics and Visualization
|
||||
|
||||
34. **BI/Visualization tool:**
|
||||
- Tableau
|
||||
- Power BI
|
||||
- Looker / Looker Studio
|
||||
- Metabase
|
||||
- Superset
|
||||
- Redash
|
||||
- Grafana
|
||||
- Custom dashboards (Plotly Dash, Streamlit)
|
||||
- Jupyter notebooks
|
||||
- None needed
|
||||
|
||||
35. **Reporting frequency:**
|
||||
- Real-time dashboards
|
||||
- Daily reports
|
||||
- Weekly/Monthly reports
|
||||
- Ad-hoc queries
|
||||
- Multiple frequencies
|
||||
|
||||
36. **Query interface:**
|
||||
- SQL (direct database queries)
|
||||
- BI tool interface
|
||||
- API (programmatic access)
|
||||
- Notebooks
|
||||
- Multiple interfaces
|
||||
|
||||
## Data Governance and Security
|
||||
|
||||
37. **Data catalog:**
|
||||
- Amundsen
|
||||
- DataHub
|
||||
- AWS Glue Data Catalog
|
||||
- Azure Purview
|
||||
- Alation
|
||||
- Collibra
|
||||
- None (small team)
|
||||
|
||||
38. **Data lineage tracking:**
|
||||
- Automated (DataHub, Amundsen)
|
||||
- Manual documentation
|
||||
- Not tracked
|
||||
|
||||
39. **Access control:**
|
||||
- Row-level security (RLS)
|
||||
- Column-level security
|
||||
- Database/warehouse roles
|
||||
- IAM policies (cloud)
|
||||
- None (internal team only)
|
||||
|
||||
40. **PII/Sensitive data handling:**
|
||||
- Encryption at rest
|
||||
- Encryption in transit
|
||||
- Data masking
|
||||
- Tokenization
|
||||
- Compliance requirements (GDPR, HIPAA)
|
||||
- None (no sensitive data)
|
||||
|
||||
41. **Data versioning:**
|
||||
- DVC (Data Version Control)
|
||||
- LakeFS
|
||||
- Delta Lake time travel
|
||||
- Git LFS (for small data)
|
||||
- Manual snapshots
|
||||
- None
|
||||
|
||||
## Testing and Validation
|
||||
|
||||
42. **Data testing:**
|
||||
- Unit tests (transformation logic)
|
||||
- Integration tests (end-to-end pipeline)
|
||||
- Data quality tests
|
||||
- Schema validation
|
||||
- Manual validation
|
||||
- None
|
||||
|
||||
43. **ML model testing (if applicable):**
|
||||
- Unit tests (code)
|
||||
- Model validation (held-out test set)
|
||||
- Performance benchmarks
|
||||
- Fairness/bias testing
|
||||
- A/B testing in production
|
||||
- None
|
||||
|
||||
## Deployment and CI/CD
|
||||
|
||||
44. **Deployment strategy:**
|
||||
- GitOps (version-controlled config)
|
||||
- Manual deployment
|
||||
- CI/CD pipeline (GitHub Actions, GitLab CI)
|
||||
- Platform-specific (SageMaker, Vertex AI)
|
||||
- Terraform/IaC
|
||||
|
||||
45. **Environment separation:**
|
||||
- Dev / Staging / Production
|
||||
- Dev / Production only
|
||||
- Single environment
|
||||
|
||||
46. **Containerization:**
|
||||
- Docker
|
||||
- Not containerized (native environments)
|
||||
|
||||
## Monitoring and Observability
|
||||
|
||||
47. **Pipeline monitoring:**
|
||||
- Orchestrator built-in (Airflow UI, Prefect)
|
||||
- Custom dashboards
|
||||
- Alerts on failures
|
||||
- Data quality monitoring
|
||||
- None
|
||||
|
||||
48. **Performance monitoring:**
|
||||
- Query performance (slow queries)
|
||||
- Job duration tracking
|
||||
- Cost monitoring (cloud spend)
|
||||
- Resource utilization
|
||||
- None
|
||||
|
||||
49. **Alerting:**
|
||||
- Email
|
||||
- Slack/Discord
|
||||
- PagerDuty
|
||||
- Built-in orchestrator alerts
|
||||
- None
|
||||
|
||||
## Cost Optimization
|
||||
|
||||
50. **Cost considerations:**
|
||||
- Optimize warehouse queries
|
||||
- Auto-scaling clusters
|
||||
- Spot/preemptible instances
|
||||
- Storage tiering (hot/cold)
|
||||
- Cost monitoring dashboards
|
||||
- Not a priority
|
||||
|
||||
## Collaboration and Documentation
|
||||
|
||||
51. **Team collaboration:**
|
||||
- Git for code
|
||||
- Shared notebooks (JupyterHub, Databricks)
|
||||
- Documentation wiki
|
||||
- Slack/communication tools
|
||||
- Pair programming
|
||||
|
||||
52. **Documentation approach:**
|
||||
- README files
|
||||
- Docstrings in code
|
||||
- Notebooks with markdown
|
||||
- Confluence/Notion
|
||||
- Data catalog (self-documenting)
|
||||
- Minimal
|
||||
|
||||
53. **Code review process:**
|
||||
- Pull requests (required)
|
||||
- Peer review (optional)
|
||||
- No formal review
|
||||
|
||||
## Performance and Scale
|
||||
|
||||
54. **Performance requirements:**
|
||||
- Near real-time (< 1 minute latency)
|
||||
- Batch (hours acceptable)
|
||||
- Interactive queries (< 10 seconds)
|
||||
- No specific requirements
|
||||
|
||||
55. **Scalability needs:**
|
||||
- Must scale to 10x data volume
|
||||
- Current scale sufficient
|
||||
- Unknown (future growth)
|
||||
|
||||
56. **Query optimization:**
|
||||
- Indexing
|
||||
- Partitioning
|
||||
- Materialized views
|
||||
- Query caching
|
||||
- Not needed (fast enough)
|
||||
@@ -1,299 +0,0 @@
|
||||
# Desktop Application Architecture Questions
|
||||
|
||||
## Framework and Platform
|
||||
|
||||
1. **Primary framework:**
|
||||
- Electron (JavaScript/TypeScript, web tech, cross-platform)
|
||||
- Tauri (Rust backend, web frontend, lightweight)
|
||||
- .NET MAUI (C#, cross-platform, native UI)
|
||||
- Qt (C++/Python, cross-platform, native)
|
||||
- Flutter Desktop (Dart, cross-platform)
|
||||
- JavaFX (Java, cross-platform)
|
||||
- Swift/SwiftUI (macOS only)
|
||||
- WPF/WinUI 3 (Windows only, C#)
|
||||
- GTK (C/Python, Linux-focused)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
2. **Target platforms:**
|
||||
- Windows only
|
||||
- macOS only
|
||||
- Linux only
|
||||
- Windows + macOS
|
||||
- Windows + macOS + Linux (full cross-platform)
|
||||
- Specific Linux distros: **\_\_\_**
|
||||
|
||||
3. **UI approach:**
|
||||
- Native UI (platform-specific controls)
|
||||
- Web-based UI (HTML/CSS/JS in Electron/Tauri)
|
||||
- Custom-drawn UI (Canvas/OpenGL)
|
||||
- Hybrid (native shell + web content)
|
||||
|
||||
4. **Frontend framework (if web-based UI):**
|
||||
- React
|
||||
- Vue
|
||||
- Svelte
|
||||
- Angular
|
||||
- Vanilla JS
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Architecture
|
||||
|
||||
5. **Application architecture:**
|
||||
- Single-process (all in one)
|
||||
- Multi-process (main + renderer processes like Electron)
|
||||
- Multi-threaded (background workers)
|
||||
- Plugin-based (extensible architecture)
|
||||
|
||||
6. **Backend/Business logic:**
|
||||
- Embedded in app (monolithic)
|
||||
- Separate local service
|
||||
- Connects to remote API
|
||||
- Hybrid (local + remote)
|
||||
|
||||
7. **Database/Data storage:**
|
||||
- SQLite (local embedded database)
|
||||
- IndexedDB (if web-based)
|
||||
- File-based storage (JSON, custom)
|
||||
- LevelDB/RocksDB
|
||||
- Remote database only
|
||||
- No persistence needed
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## System Integration
|
||||
|
||||
8. **Operating system integration needs:**
|
||||
- File system access (read/write user files)
|
||||
- System tray/menu bar icon
|
||||
- Native notifications
|
||||
- Keyboard shortcuts (global hotkeys)
|
||||
- Clipboard integration
|
||||
- Drag-and-drop support
|
||||
- Context menu integration
|
||||
- File type associations
|
||||
- URL scheme handling (deep linking)
|
||||
- System dialogs (file picker, alerts)
|
||||
- None needed (basic app)
|
||||
|
||||
9. **Hardware access:**
|
||||
- Camera/Microphone
|
||||
- USB devices
|
||||
- Bluetooth
|
||||
- Printers
|
||||
- Scanners
|
||||
- Serial ports
|
||||
- GPU (for rendering/compute)
|
||||
- None needed
|
||||
|
||||
10. **System permissions required:**
|
||||
- Accessibility API (screen reading, input simulation)
|
||||
- Location services
|
||||
- Calendar/Contacts access
|
||||
- Network monitoring
|
||||
- Screen recording
|
||||
- Full disk access
|
||||
- None (sandboxed app)
|
||||
|
||||
## Updates and Distribution
|
||||
|
||||
11. **Auto-update mechanism:**
|
||||
- Electron's autoUpdater
|
||||
- Squirrel (Windows/Mac)
|
||||
- Sparkle (macOS)
|
||||
- Custom update server
|
||||
- App store updates only
|
||||
- Manual download/install
|
||||
- No updates (fixed version)
|
||||
|
||||
12. **Distribution method:**
|
||||
- Microsoft Store (Windows)
|
||||
- Mac App Store
|
||||
- Snap Store (Linux)
|
||||
- Flatpak (Linux)
|
||||
- Homebrew (macOS/Linux)
|
||||
- Direct download from website
|
||||
- Enterprise deployment (MSI, PKG)
|
||||
- Multiple channels
|
||||
|
||||
13. **Code signing:**
|
||||
- Yes - Windows (Authenticode)
|
||||
- Yes - macOS (Apple Developer)
|
||||
- Yes - both
|
||||
- No (development/internal only)
|
||||
|
||||
14. **Notarization (macOS):**
|
||||
- Required (public distribution)
|
||||
- Not needed (internal only)
|
||||
|
||||
## Packaging and Installation
|
||||
|
||||
15. **Windows installer:**
|
||||
- NSIS
|
||||
- Inno Setup
|
||||
- WiX Toolset (MSI)
|
||||
- Squirrel.Windows
|
||||
- MSIX (Windows 10+)
|
||||
- Portable (no installer)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
16. **macOS installer:**
|
||||
- DMG (drag-to-install)
|
||||
- PKG installer
|
||||
- Mac App Store
|
||||
- Homebrew Cask
|
||||
- Other: **\_\_\_**
|
||||
|
||||
17. **Linux packaging:**
|
||||
- AppImage (portable)
|
||||
- Snap
|
||||
- Flatpak
|
||||
- .deb (Debian/Ubuntu)
|
||||
- .rpm (Fedora/RHEL)
|
||||
- Tarball
|
||||
- AUR (Arch)
|
||||
- Multiple formats
|
||||
|
||||
## Configuration and Settings
|
||||
|
||||
18. **Settings storage:**
|
||||
- OS-specific (Registry on Windows, plist on macOS, config files on Linux)
|
||||
- JSON/YAML config file
|
||||
- SQLite database
|
||||
- Remote/cloud sync
|
||||
- Electron Store
|
||||
- Other: **\_\_\_**
|
||||
|
||||
19. **User data location:**
|
||||
- Application Support folder (standard OS location)
|
||||
- User documents folder
|
||||
- Custom location (user selectable)
|
||||
- Cloud storage integration
|
||||
|
||||
## Networking
|
||||
|
||||
20. **Network connectivity:**
|
||||
- Online-only (requires internet)
|
||||
- Offline-first (works without internet)
|
||||
- Hybrid (enhanced with internet)
|
||||
- No network needed
|
||||
|
||||
21. **Backend communication (if applicable):**
|
||||
- REST API
|
||||
- GraphQL
|
||||
- WebSocket
|
||||
- gRPC
|
||||
- Custom protocol
|
||||
- None
|
||||
|
||||
## Authentication and Security
|
||||
|
||||
22. **Authentication (if applicable):**
|
||||
- OAuth2 (Google, Microsoft, etc.)
|
||||
- Username/password with backend
|
||||
- SSO (enterprise)
|
||||
- OS-level authentication (biometric, Windows Hello)
|
||||
- No authentication needed
|
||||
|
||||
23. **Data security:**
|
||||
- Encrypt sensitive data at rest
|
||||
- OS keychain/credential manager
|
||||
- Custom encryption
|
||||
- No sensitive data
|
||||
|
||||
24. **Sandboxing:**
|
||||
- Fully sandboxed (Mac App Store requirement)
|
||||
- Partially sandboxed
|
||||
- Not sandboxed (legacy/compatibility)
|
||||
|
||||
## Performance and Resources
|
||||
|
||||
25. **Performance requirements:**
|
||||
- Lightweight (minimal resource usage)
|
||||
- Moderate (typical desktop app)
|
||||
- Resource-intensive (video editing, 3D, etc.)
|
||||
|
||||
26. **Background operation:**
|
||||
- Runs in background/system tray
|
||||
- Active window only
|
||||
- Can minimize to tray
|
||||
|
||||
27. **Multi-instance handling:**
|
||||
- Allow multiple instances
|
||||
- Single instance only
|
||||
- Single instance with IPC (communicate between instances)
|
||||
|
||||
## Development and Build
|
||||
|
||||
28. **Build tooling:**
|
||||
- electron-builder
|
||||
- electron-forge
|
||||
- Tauri CLI
|
||||
- .NET CLI
|
||||
- CMake (for C++/Qt)
|
||||
- Gradle (for Java)
|
||||
- Xcode (for macOS)
|
||||
- Visual Studio (for Windows)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
29. **Development environment:**
|
||||
- Cross-platform dev (can build on any OS)
|
||||
- Platform-specific (need macOS for Mac builds, etc.)
|
||||
|
||||
30. **CI/CD for builds:**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- CircleCI
|
||||
- Azure Pipelines
|
||||
- Custom
|
||||
- Manual builds
|
||||
|
||||
## Testing
|
||||
|
||||
31. **UI testing approach:**
|
||||
- Spectron (Electron)
|
||||
- Playwright
|
||||
- Selenium
|
||||
- Native UI testing (XCTest, UI Automation)
|
||||
- Manual testing only
|
||||
|
||||
32. **End-to-end testing:**
|
||||
- Yes (automated E2E tests)
|
||||
- Limited (smoke tests only)
|
||||
- Manual only
|
||||
|
||||
## Additional Features
|
||||
|
||||
33. **Internationalization (i18n):**
|
||||
- Multiple languages supported
|
||||
- English only
|
||||
- User-selectable language
|
||||
- OS language detection
|
||||
|
||||
34. **Accessibility:**
|
||||
- Full accessibility support (screen readers, keyboard nav)
|
||||
- Basic accessibility
|
||||
- Not a priority
|
||||
|
||||
35. **Crash reporting:**
|
||||
- Sentry
|
||||
- BugSnag
|
||||
- Crashpad (for native crashes)
|
||||
- Custom reporting
|
||||
- None
|
||||
|
||||
36. **Analytics/Telemetry:**
|
||||
- Google Analytics
|
||||
- Mixpanel
|
||||
- PostHog
|
||||
- Custom telemetry
|
||||
- No telemetry (privacy-focused)
|
||||
|
||||
37. **Licensing/DRM (if commercial):**
|
||||
- License key validation
|
||||
- Hardware-locked licenses
|
||||
- Subscription validation
|
||||
- None (free/open-source)
|
||||
|
||||
38. **Plugin/Extension system:**
|
||||
- Yes (user can install plugins)
|
||||
- No (monolithic app)
|
||||
- Planned for future
|
||||
@@ -1,118 +0,0 @@
|
||||
# Embedded System Architecture Questions
|
||||
|
||||
## Hardware Platform
|
||||
|
||||
1. **Microcontroller/SoC:**
|
||||
- ESP32 (WiFi/BLE, popular)
|
||||
- ESP8266 (WiFi, budget)
|
||||
- STM32 (ARM Cortex-M, powerful)
|
||||
- Arduino (AVR, beginner-friendly)
|
||||
- Raspberry Pi Pico (RP2040)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
2. **RTOS or Bare Metal:**
|
||||
- FreeRTOS (popular, tasks/queues)
|
||||
- Zephyr RTOS
|
||||
- Bare metal (no OS, full control)
|
||||
- Arduino framework
|
||||
- ESP-IDF
|
||||
- Other: **\_\_\_**
|
||||
|
||||
3. **Programming language:**
|
||||
- C
|
||||
- C++
|
||||
- MicroPython
|
||||
- Arduino (C++)
|
||||
- Rust
|
||||
|
||||
## Communication
|
||||
|
||||
4. **Primary communication protocol:**
|
||||
- MQTT (IoT messaging)
|
||||
- HTTP/HTTPS (REST APIs)
|
||||
- WebSockets
|
||||
- CoAP
|
||||
- Custom binary protocol
|
||||
|
||||
5. **Local communication (peripherals):**
|
||||
- UART (serial)
|
||||
- I2C (sensors)
|
||||
- SPI (high-speed devices)
|
||||
- GPIO (simple digital)
|
||||
- Analog (ADC)
|
||||
|
||||
6. **Wireless connectivity:**
|
||||
- WiFi
|
||||
- Bluetooth Classic
|
||||
- BLE (Bluetooth Low Energy)
|
||||
- LoRa/LoRaWAN
|
||||
- Zigbee
|
||||
- None (wired only)
|
||||
|
||||
## Cloud/Backend
|
||||
|
||||
7. **Cloud platform:** (if IoT project)
|
||||
- AWS IoT Core
|
||||
- Azure IoT Hub
|
||||
- Google Cloud IoT
|
||||
- Custom MQTT broker
|
||||
- ThingsBoard
|
||||
- None (local only)
|
||||
|
||||
## Power
|
||||
|
||||
8. **Power source:**
|
||||
- USB powered (5V constant)
|
||||
- Battery (need power management)
|
||||
- AC adapter
|
||||
- Solar
|
||||
- Other: **\_\_\_**
|
||||
|
||||
9. **Low power mode needed:**
|
||||
- Yes (battery-powered, deep sleep)
|
||||
- No (always powered)
|
||||
|
||||
## Storage
|
||||
|
||||
10. **Data persistence:**
|
||||
- EEPROM (small config)
|
||||
- Flash (larger data)
|
||||
- SD card
|
||||
- None needed
|
||||
- Cloud only
|
||||
|
||||
## Updates
|
||||
|
||||
11. **Firmware update strategy:**
|
||||
- OTA (Over-The-Air via WiFi)
|
||||
- USB/Serial upload
|
||||
- SD card
|
||||
- No updates (fixed firmware)
|
||||
|
||||
## Sensors/Actuators
|
||||
|
||||
12. **Sensors used:** (list)
|
||||
- Temperature (DHT22, DS18B20, etc.)
|
||||
- Humidity
|
||||
- Motion (PIR, accelerometer)
|
||||
- Light (LDR, photodiode)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
13. **Actuators used:** (list)
|
||||
- LEDs
|
||||
- Motors (DC, servo, stepper)
|
||||
- Relays
|
||||
- Display (LCD, OLED)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Real-Time Constraints
|
||||
|
||||
14. **Hard real-time requirements:**
|
||||
- Yes (must respond within X ms, critical)
|
||||
- Soft real-time (best effort)
|
||||
- No timing constraints
|
||||
|
||||
15. **Interrupt-driven or polling:**
|
||||
- Interrupts (responsive)
|
||||
- Polling (simpler)
|
||||
- Mix
|
||||
@@ -1,374 +0,0 @@
|
||||
# Browser Extension Architecture Questions
|
||||
|
||||
## Target Browsers
|
||||
|
||||
1. **Target browser(s):**
|
||||
- Chrome (most common)
|
||||
- Firefox
|
||||
- Edge (Chromium-based)
|
||||
- Safari
|
||||
- Opera
|
||||
- Brave
|
||||
- Multiple browsers (cross-browser)
|
||||
|
||||
2. **Manifest version:**
|
||||
- Manifest V3 (current standard, required for Chrome Web Store)
|
||||
- Manifest V2 (legacy, being phased out)
|
||||
- Both (transition period)
|
||||
|
||||
3. **Cross-browser compatibility:**
|
||||
- Chrome/Edge only (same codebase)
|
||||
- Chrome + Firefox (minor differences)
|
||||
- All major browsers (requires polyfills/adapters)
|
||||
|
||||
## Extension Type and Architecture
|
||||
|
||||
4. **Primary extension type:**
|
||||
- Browser Action (icon in toolbar)
|
||||
- Page Action (icon in address bar, page-specific)
|
||||
- Content Script (runs on web pages)
|
||||
- DevTools Extension (adds features to browser DevTools)
|
||||
- New Tab Override
|
||||
- Bookmarks/History extension
|
||||
- Multiple components
|
||||
|
||||
5. **Extension components needed:**
|
||||
- Background script/Service Worker (always running logic)
|
||||
- Content scripts (inject into web pages)
|
||||
- Popup UI (click toolbar icon)
|
||||
- Options page (settings/configuration)
|
||||
- Side panel (persistent panel, MV3)
|
||||
- DevTools page
|
||||
- New Tab page
|
||||
|
||||
6. **Content script injection:**
|
||||
- All pages (matches: <all_urls>)
|
||||
- Specific domains (matches: \*.example.com)
|
||||
- User-activated (inject on demand)
|
||||
- Not needed
|
||||
|
||||
## UI and Framework
|
||||
|
||||
7. **UI framework:**
|
||||
- Vanilla JS (no framework)
|
||||
- React
|
||||
- Vue
|
||||
- Svelte
|
||||
- Preact (lightweight React)
|
||||
- Web Components
|
||||
- Other: **\_\_\_**
|
||||
|
||||
8. **Build tooling:**
|
||||
- Webpack
|
||||
- Vite
|
||||
- Rollup
|
||||
- Parcel
|
||||
- esbuild
|
||||
- WXT (extension-specific)
|
||||
- Plasmo (extension framework)
|
||||
- None (plain JS)
|
||||
|
||||
9. **CSS framework:**
|
||||
- Tailwind CSS
|
||||
- CSS Modules
|
||||
- Styled Components
|
||||
- Plain CSS
|
||||
- Sass/SCSS
|
||||
- None (minimal styling)
|
||||
|
||||
10. **Popup UI:**
|
||||
- Simple (HTML + CSS)
|
||||
- Interactive (full app)
|
||||
- None (no popup)
|
||||
|
||||
11. **Options page:**
|
||||
- Simple form (HTML)
|
||||
- Full settings UI (framework-based)
|
||||
- Embedded in popup
|
||||
- None (no settings)
|
||||
|
||||
## Permissions
|
||||
|
||||
12. **Storage permissions:**
|
||||
- chrome.storage.local (local storage)
|
||||
- chrome.storage.sync (sync across devices)
|
||||
- IndexedDB
|
||||
- None (no data persistence)
|
||||
|
||||
13. **Host permissions (access to websites):**
|
||||
- Specific domains only
|
||||
- All URLs (<all_urls>)
|
||||
- ActiveTab only (current tab when clicked)
|
||||
- Optional permissions (user grants on demand)
|
||||
|
||||
14. **API permissions needed:**
|
||||
- tabs (query/manipulate tabs)
|
||||
- webRequest (intercept network requests)
|
||||
- cookies
|
||||
- history
|
||||
- bookmarks
|
||||
- downloads
|
||||
- notifications
|
||||
- contextMenus (right-click menu)
|
||||
- clipboardWrite/Read
|
||||
- identity (OAuth)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
15. **Sensitive permissions:**
|
||||
- webRequestBlocking (modify requests, requires justification)
|
||||
- declarativeNetRequest (MV3 alternative)
|
||||
- None
|
||||
|
||||
## Data and Storage
|
||||
|
||||
16. **Data storage:**
|
||||
- chrome.storage.local
|
||||
- chrome.storage.sync (synced across devices)
|
||||
- IndexedDB
|
||||
- localStorage (limited, not recommended)
|
||||
- Remote storage (own backend)
|
||||
- Multiple storage types
|
||||
|
||||
17. **Storage size:**
|
||||
- Small (< 100KB)
|
||||
- Medium (100KB - 5MB, storage.sync limit)
|
||||
- Large (> 5MB, need storage.local or IndexedDB)
|
||||
|
||||
18. **Data sync:**
|
||||
- Sync across user's devices (chrome.storage.sync)
|
||||
- Local only (storage.local)
|
||||
- Custom backend sync
|
||||
|
||||
## Communication
|
||||
|
||||
19. **Message passing (internal):**
|
||||
- Content script <-> Background script
|
||||
- Popup <-> Background script
|
||||
- Content script <-> Content script
|
||||
- Not needed
|
||||
|
||||
20. **Messaging library:**
|
||||
- Native chrome.runtime.sendMessage
|
||||
- Wrapper library (webext-bridge, etc.)
|
||||
- Custom messaging layer
|
||||
|
||||
21. **Backend communication:**
|
||||
- REST API
|
||||
- WebSocket
|
||||
- GraphQL
|
||||
- Firebase/Supabase
|
||||
- None (client-only extension)
|
||||
|
||||
## Web Integration
|
||||
|
||||
22. **DOM manipulation:**
|
||||
- Read DOM (observe, analyze)
|
||||
- Modify DOM (inject, hide, change elements)
|
||||
- Both
|
||||
- None (no content scripts)
|
||||
|
||||
23. **Page interaction method:**
|
||||
- Content scripts (extension context)
|
||||
- Injected scripts (page context, access page variables)
|
||||
- Both (communicate via postMessage)
|
||||
|
||||
24. **CSS injection:**
|
||||
- Inject custom styles
|
||||
- Override site styles
|
||||
- None
|
||||
|
||||
25. **Network request interception:**
|
||||
- Read requests (webRequest)
|
||||
- Block/modify requests (declarativeNetRequest in MV3)
|
||||
- Not needed
|
||||
|
||||
## Background Processing
|
||||
|
||||
26. **Background script type (MV3):**
|
||||
- Service Worker (MV3, event-driven, terminates when idle)
|
||||
- Background page (MV2, persistent)
|
||||
|
||||
27. **Background tasks:**
|
||||
- Event listeners (tabs, webRequest, etc.)
|
||||
- Periodic tasks (alarms)
|
||||
- Message routing (popup <-> content scripts)
|
||||
- API calls
|
||||
- None
|
||||
|
||||
28. **Persistent state (MV3 challenge):**
|
||||
- Store in chrome.storage (service worker can terminate)
|
||||
- Use alarms for periodic tasks
|
||||
- Not applicable (MV2 or stateless)
|
||||
|
||||
## Authentication
|
||||
|
||||
29. **User authentication:**
|
||||
- OAuth (chrome.identity API)
|
||||
- Custom login (username/password with backend)
|
||||
- API key
|
||||
- No authentication needed
|
||||
|
||||
30. **OAuth provider:**
|
||||
- Google
|
||||
- GitHub
|
||||
- Custom OAuth server
|
||||
- Not using OAuth
|
||||
|
||||
## Distribution
|
||||
|
||||
31. **Distribution method:**
|
||||
- Chrome Web Store (public)
|
||||
- Chrome Web Store (unlisted)
|
||||
- Firefox Add-ons (AMO)
|
||||
- Edge Add-ons Store
|
||||
- Self-hosted (enterprise, sideload)
|
||||
- Multiple stores
|
||||
|
||||
32. **Pricing model:**
|
||||
- Free
|
||||
- Freemium (basic free, premium paid)
|
||||
- Paid (one-time purchase)
|
||||
- Subscription
|
||||
- Enterprise licensing
|
||||
|
||||
33. **In-extension purchases:**
|
||||
- Via web (redirect to website)
|
||||
- Stripe integration
|
||||
- No purchases
|
||||
|
||||
## Privacy and Security
|
||||
|
||||
34. **User privacy:**
|
||||
- No data collection
|
||||
- Anonymous analytics
|
||||
- User data collected (with consent)
|
||||
- Data sent to server
|
||||
|
||||
35. **Content Security Policy (CSP):**
|
||||
- Default CSP (secure)
|
||||
- Custom CSP (if needed for external scripts)
|
||||
|
||||
36. **External scripts:**
|
||||
- None (all code bundled)
|
||||
- CDN scripts (requires CSP relaxation)
|
||||
- Inline scripts (avoid in MV3)
|
||||
|
||||
37. **Sensitive data handling:**
|
||||
- Encrypt stored data
|
||||
- Use native credential storage
|
||||
- No sensitive data
|
||||
|
||||
## Testing
|
||||
|
||||
38. **Testing approach:**
|
||||
- Manual testing (load unpacked)
|
||||
- Unit tests (Jest, Vitest)
|
||||
- E2E tests (Puppeteer, Playwright)
|
||||
- Cross-browser testing
|
||||
- Minimal testing
|
||||
|
||||
39. **Test automation:**
|
||||
- Automated tests in CI
|
||||
- Manual testing only
|
||||
|
||||
## Updates and Deployment
|
||||
|
||||
40. **Update strategy:**
|
||||
- Auto-update (store handles)
|
||||
- Manual updates (enterprise)
|
||||
|
||||
41. **Versioning:**
|
||||
- Semantic versioning (1.2.3)
|
||||
- Chrome Web Store version requirements
|
||||
|
||||
42. **CI/CD:**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- Manual builds/uploads
|
||||
- Web Store API (automated publishing)
|
||||
|
||||
## Features
|
||||
|
||||
43. **Context menu integration:**
|
||||
- Right-click menu items
|
||||
- Not needed
|
||||
|
||||
44. **Omnibox integration:**
|
||||
- Custom omnibox keyword
|
||||
- Not needed
|
||||
|
||||
45. **Browser notifications:**
|
||||
- Chrome notifications API
|
||||
- Not needed
|
||||
|
||||
46. **Keyboard shortcuts:**
|
||||
- chrome.commands API
|
||||
- Not needed
|
||||
|
||||
47. **Clipboard access:**
|
||||
- Read clipboard
|
||||
- Write to clipboard
|
||||
- Not needed
|
||||
|
||||
48. **Side panel (MV3):**
|
||||
- Persistent side panel UI
|
||||
- Not needed
|
||||
|
||||
49. **DevTools integration:**
|
||||
- Add DevTools panel
|
||||
- Not needed
|
||||
|
||||
50. **Internationalization (i18n):**
|
||||
- Multiple languages
|
||||
- English only
|
||||
|
||||
## Analytics and Monitoring
|
||||
|
||||
51. **Analytics:**
|
||||
- Google Analytics (with privacy considerations)
|
||||
- PostHog
|
||||
- Mixpanel
|
||||
- Custom analytics
|
||||
- None
|
||||
|
||||
52. **Error tracking:**
|
||||
- Sentry
|
||||
- Bugsnag
|
||||
- Custom error logging
|
||||
- None
|
||||
|
||||
53. **User feedback:**
|
||||
- In-extension feedback form
|
||||
- External form (website)
|
||||
- Email/support
|
||||
- None
|
||||
|
||||
## Performance
|
||||
|
||||
54. **Performance considerations:**
|
||||
- Minimal memory footprint
|
||||
- Lazy loading
|
||||
- Efficient DOM queries
|
||||
- Not a priority
|
||||
|
||||
55. **Bundle size:**
|
||||
- Keep small (< 1MB)
|
||||
- Moderate (1-5MB)
|
||||
- Large (> 5MB, media/assets)
|
||||
|
||||
## Compliance and Review
|
||||
|
||||
56. **Chrome Web Store review:**
|
||||
- Standard review (automated + manual)
|
||||
- Sensitive permissions (extra scrutiny)
|
||||
- Not yet submitted
|
||||
|
||||
57. **Privacy policy:**
|
||||
- Required (collecting data)
|
||||
- Not required (no data collection)
|
||||
- Already prepared
|
||||
|
||||
58. **Code obfuscation:**
|
||||
- Minified only
|
||||
- Not allowed (stores require readable code)
|
||||
- Using source maps
|
||||
@@ -1,133 +0,0 @@
|
||||
# Game Architecture Questions
|
||||
|
||||
## Engine and Platform
|
||||
|
||||
1. **Game engine:**
|
||||
- Unity (C#, versatile, large ecosystem)
|
||||
- Unreal Engine (C++, AAA graphics)
|
||||
- Godot (GDScript/C#, open-source)
|
||||
- Custom engine
|
||||
- Other: **\_\_\_**
|
||||
|
||||
2. **Target platforms:**
|
||||
- PC (Windows, Mac, Linux)
|
||||
- Mobile (iOS, Android)
|
||||
- Console (Xbox, PlayStation, Switch)
|
||||
- Web (WebGL)
|
||||
- Mix: **\_\_\_**
|
||||
|
||||
3. **2D or 3D:**
|
||||
- 2D
|
||||
- 3D
|
||||
- 2.5D (3D with 2D gameplay)
|
||||
|
||||
## Architecture Pattern
|
||||
|
||||
4. **Core architecture:**
|
||||
- ECS (Entity Component System) - Unity DOTS, Bevy
|
||||
- OOP (Object-Oriented) - Unity MonoBehaviours, Unreal Actors
|
||||
- Data-Oriented Design
|
||||
- Mix
|
||||
|
||||
5. **Scene structure:**
|
||||
- Single scene (load/unload prefabs)
|
||||
- Multi-scene (additive loading)
|
||||
- Scene per level
|
||||
|
||||
## Multiplayer (if applicable)
|
||||
|
||||
6. **Multiplayer type:**
|
||||
- Single-player only
|
||||
- Local multiplayer (same device/splitscreen)
|
||||
- Online multiplayer
|
||||
- Both local + online
|
||||
|
||||
7. **If online multiplayer - networking:**
|
||||
- Photon (popular, managed)
|
||||
- Mirror (Unity, open-source)
|
||||
- Netcode for GameObjects (Unity, official)
|
||||
- Unreal Replication
|
||||
- Custom netcode
|
||||
- Other: **\_\_\_**
|
||||
|
||||
8. **Multiplayer architecture:**
|
||||
- Client-Server (authoritative server)
|
||||
- Peer-to-Peer
|
||||
- Dedicated servers
|
||||
- Listen server (player hosts)
|
||||
|
||||
9. **Backend for multiplayer:**
|
||||
- PlayFab (Microsoft, game backend)
|
||||
- Nakama (open-source game server)
|
||||
- GameSparks (AWS)
|
||||
- Firebase
|
||||
- Custom backend
|
||||
|
||||
## Save System
|
||||
|
||||
10. **Save/persistence:**
|
||||
- Local only (PlayerPrefs, file)
|
||||
- Cloud save (Steam Cloud, PlayFab)
|
||||
- Both local + cloud sync
|
||||
- No saves needed
|
||||
|
||||
## Monetization (if applicable)
|
||||
|
||||
11. **Monetization model:**
|
||||
- Paid (one-time purchase)
|
||||
- Free-to-play + IAP
|
||||
- Free-to-play + Ads
|
||||
- Subscription
|
||||
- None (hobby/portfolio)
|
||||
|
||||
12. **If IAP - platform:**
|
||||
- Unity IAP (cross-platform)
|
||||
- Steam microtransactions
|
||||
- Mobile stores (App Store, Google Play)
|
||||
- Custom (virtual currency)
|
||||
|
||||
13. **If Ads:**
|
||||
- Unity Ads
|
||||
- AdMob (Google)
|
||||
- IronSource
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Assets
|
||||
|
||||
14. **Asset pipeline:**
|
||||
- Unity Asset Bundles
|
||||
- Unreal Pak files
|
||||
- Addressables (Unity)
|
||||
- Streaming from CDN
|
||||
- All assets in build
|
||||
|
||||
15. **Art creation tools:**
|
||||
- Blender (3D modeling)
|
||||
- Maya/3DS Max
|
||||
- Photoshop (textures)
|
||||
- Substance (materials)
|
||||
- Aseprite (pixel art)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Analytics and LiveOps
|
||||
|
||||
16. **Analytics:**
|
||||
- Unity Analytics
|
||||
- GameAnalytics
|
||||
- Firebase Analytics
|
||||
- PlayFab Analytics
|
||||
- None
|
||||
|
||||
17. **LiveOps/Events:**
|
||||
- Remote config (Unity, Firebase)
|
||||
- In-game events
|
||||
- Season passes
|
||||
- None (fixed content)
|
||||
|
||||
## Audio
|
||||
|
||||
18. **Audio middleware:**
|
||||
- Unity Audio (built-in)
|
||||
- FMOD
|
||||
- Wwise
|
||||
- Simple (no middleware)
|
||||
@@ -1,484 +0,0 @@
|
||||
# Infrastructure/DevOps Tool Architecture Questions
|
||||
|
||||
## Tool Type
|
||||
|
||||
1. **Primary tool category:**
|
||||
- Infrastructure as Code (IaC) module/provider
|
||||
- Kubernetes Operator
|
||||
- CI/CD plugin/action
|
||||
- Monitoring/Observability tool
|
||||
- Configuration management tool
|
||||
- Deployment automation tool
|
||||
- GitOps tool
|
||||
- Security/Compliance scanner
|
||||
- Cost optimization tool
|
||||
- Multi-tool platform
|
||||
|
||||
## Infrastructure as Code (IaC)
|
||||
|
||||
2. **IaC platform (if applicable):**
|
||||
- Terraform
|
||||
- Pulumi
|
||||
- CloudFormation (AWS)
|
||||
- Bicep (Azure)
|
||||
- CDK (AWS, TypeScript/Python)
|
||||
- CDKTF (Terraform with CDK)
|
||||
- Ansible
|
||||
- Chef
|
||||
- Puppet
|
||||
- Not applicable
|
||||
|
||||
3. **IaC language:**
|
||||
- HCL (Terraform)
|
||||
- TypeScript (Pulumi, CDK)
|
||||
- Python (Pulumi, CDK)
|
||||
- Go (Pulumi)
|
||||
- YAML (CloudFormation, Ansible)
|
||||
- JSON
|
||||
- Domain-specific language
|
||||
- Other: **\_\_\_**
|
||||
|
||||
4. **Terraform specifics (if applicable):**
|
||||
- Terraform module (reusable component)
|
||||
- Terraform provider (new resource types)
|
||||
- Terraform backend (state storage)
|
||||
- Not using Terraform
|
||||
|
||||
5. **Target cloud platforms:**
|
||||
- AWS
|
||||
- Azure
|
||||
- Google Cloud
|
||||
- Multi-cloud
|
||||
- On-premise (VMware, OpenStack)
|
||||
- Hybrid cloud
|
||||
- Kubernetes (cloud-agnostic)
|
||||
|
||||
## Kubernetes Operator (if applicable)
|
||||
|
||||
6. **Operator framework:**
|
||||
- Operator SDK (Go)
|
||||
- Kubebuilder (Go)
|
||||
- KUDO
|
||||
- Kopf (Python)
|
||||
- Java Operator SDK
|
||||
- Metacontroller
|
||||
- Custom (raw client-go)
|
||||
- Not applicable
|
||||
|
||||
7. **Operator type:**
|
||||
- Application operator (manage app lifecycle)
|
||||
- Infrastructure operator (manage resources)
|
||||
- Data operator (databases, queues)
|
||||
- Security operator
|
||||
- Other: **\_\_\_**
|
||||
|
||||
8. **Custom Resource Definitions (CRDs):**
|
||||
- Define new CRDs
|
||||
- Use existing CRDs
|
||||
- Multiple CRDs
|
||||
|
||||
9. **Operator scope:**
|
||||
- Namespace-scoped
|
||||
- Cluster-scoped
|
||||
- Both
|
||||
|
||||
10. **Reconciliation pattern:**
|
||||
- Level-based (check desired vs actual state)
|
||||
- Edge-triggered (react to changes)
|
||||
- Hybrid
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
11. **CI/CD platform (if plugin/action):**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- Jenkins
|
||||
- CircleCI
|
||||
- Azure DevOps
|
||||
- Bitbucket Pipelines
|
||||
- Drone CI
|
||||
- Tekton
|
||||
- Argo Workflows
|
||||
- Not applicable
|
||||
|
||||
12. **Plugin type (if CI/CD plugin):**
|
||||
- Build step
|
||||
- Test step
|
||||
- Deployment step
|
||||
- Security scan
|
||||
- Notification
|
||||
- Custom action
|
||||
- Not applicable
|
||||
|
||||
13. **GitHub Action specifics (if applicable):**
|
||||
- JavaScript action
|
||||
- Docker container action
|
||||
- Composite action (reusable workflow)
|
||||
- Not using GitHub Actions
|
||||
|
||||
## Configuration and State Management
|
||||
|
||||
14. **Configuration approach:**
|
||||
- Configuration files (YAML, JSON, HCL)
|
||||
|
||||
- Environment variables
|
||||
- Command-line flags
|
||||
- API-based configuration
|
||||
- Multiple methods
|
||||
|
||||
15. **State management:**
|
||||
- Stateless (idempotent operations)
|
||||
- Local state file
|
||||
- Remote state (S3, Consul, Terraform Cloud)
|
||||
- Database state
|
||||
- Kubernetes ConfigMaps/Secrets
|
||||
- Not applicable
|
||||
|
||||
16. **Secrets management:**
|
||||
- Vault (HashiCorp)
|
||||
- AWS Secrets Manager
|
||||
- Azure Key Vault
|
||||
- Google Secret Manager
|
||||
- Kubernetes Secrets
|
||||
- SOPS (encrypted files)
|
||||
- Sealed Secrets
|
||||
- External Secrets Operator
|
||||
- Environment variables
|
||||
- Not applicable
|
||||
|
||||
## Execution Model
|
||||
|
||||
17. **Execution pattern:**
|
||||
- CLI tool (run locally or in CI)
|
||||
- Kubernetes controller (runs in cluster)
|
||||
- Daemon/agent (runs on nodes/VMs)
|
||||
- Web service (API-driven)
|
||||
- Scheduled job (cron, K8s CronJob)
|
||||
- Event-driven (webhook, queue)
|
||||
|
||||
18. **Deployment model:**
|
||||
- Single binary (Go, Rust)
|
||||
- Container image
|
||||
- Script (Python, Bash)
|
||||
- Helm chart
|
||||
- Kustomize
|
||||
- Installed via package manager
|
||||
- Multiple deployment methods
|
||||
|
||||
19. **Concurrency:**
|
||||
- Single-threaded (sequential)
|
||||
- Multi-threaded (parallel operations)
|
||||
- Async I/O
|
||||
- Not applicable
|
||||
|
||||
## Resource Management
|
||||
|
||||
20. **Resources managed:**
|
||||
- Compute (VMs, containers, functions)
|
||||
- Networking (VPC, load balancers, DNS)
|
||||
- Storage (disks, buckets, databases)
|
||||
- Identity (IAM, service accounts)
|
||||
- Security (firewall, policies)
|
||||
- Kubernetes resources (pods, services, etc.)
|
||||
- Multiple resource types
|
||||
|
||||
21. **Resource lifecycle:**
|
||||
- Create/provision
|
||||
- Update/modify
|
||||
- Delete/destroy
|
||||
- Import existing resources
|
||||
- All of the above
|
||||
|
||||
22. **Dependency management:**
|
||||
- Explicit dependencies (depends_on)
|
||||
- Implicit dependencies (reference outputs)
|
||||
- DAG-based (topological sort)
|
||||
- None (independent resources)
|
||||
|
||||
## Language and Framework
|
||||
|
||||
23. **Implementation language:**
|
||||
- Go (common for K8s, CLI tools)
|
||||
- Python (scripting, automation)
|
||||
- TypeScript/JavaScript (Pulumi, CDK)
|
||||
- Rust (performance-critical tools)
|
||||
- Bash/Shell (simple scripts)
|
||||
- Java (enterprise tools)
|
||||
- Ruby (Chef, legacy tools)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
24. **Key libraries/SDKs:**
|
||||
- AWS SDK
|
||||
- Azure SDK
|
||||
- Google Cloud SDK
|
||||
- Kubernetes client-go
|
||||
- Terraform Plugin SDK
|
||||
- Ansible modules
|
||||
- Custom libraries
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## API and Integration
|
||||
|
||||
25. **API exposure:**
|
||||
- REST API
|
||||
- gRPC API
|
||||
- CLI only (no API)
|
||||
- Kubernetes API (CRDs)
|
||||
- Webhook receiver
|
||||
- Multiple interfaces
|
||||
|
||||
26. **External integrations:**
|
||||
- Cloud provider APIs (AWS, Azure, GCP)
|
||||
- Kubernetes API
|
||||
- Monitoring systems (Prometheus, Datadog)
|
||||
- Notification services (Slack, PagerDuty)
|
||||
- Version control (Git)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Idempotency and Safety
|
||||
|
||||
27. **Idempotency:**
|
||||
- Fully idempotent (safe to run multiple times)
|
||||
- Conditionally idempotent (with flags)
|
||||
- Not idempotent (manual cleanup needed)
|
||||
|
||||
28. **Dry-run/Plan mode:**
|
||||
- Yes (preview changes before applying)
|
||||
- No (immediate execution)
|
||||
|
||||
29. **Rollback capability:**
|
||||
- Automatic rollback on failure
|
||||
- Manual rollback (previous state)
|
||||
- No rollback (manual cleanup)
|
||||
|
||||
30. **Destructive operations:**
|
||||
- Confirmation required (--force flag)
|
||||
- Automatic (with safeguards)
|
||||
- Not applicable (read-only tool)
|
||||
|
||||
## Observability
|
||||
|
||||
31. **Logging:**
|
||||
- Structured logging (JSON)
|
||||
- Plain text logs
|
||||
- Library: (logrus, zap, winston, etc.)
|
||||
- Multiple log levels (debug, info, warn, error)
|
||||
|
||||
32. **Metrics:**
|
||||
- Prometheus metrics
|
||||
- CloudWatch metrics
|
||||
- Datadog metrics
|
||||
- Custom metrics
|
||||
- None
|
||||
|
||||
33. **Tracing:**
|
||||
- OpenTelemetry
|
||||
- Jaeger
|
||||
- Not applicable
|
||||
|
||||
34. **Health checks:**
|
||||
- Kubernetes liveness/readiness probes
|
||||
- HTTP health endpoint
|
||||
- Not applicable (CLI tool)
|
||||
|
||||
## Testing
|
||||
|
||||
35. **Testing approach:**
|
||||
- Unit tests (mock external APIs)
|
||||
- Integration tests (real cloud resources)
|
||||
- E2E tests (full workflow)
|
||||
- Contract tests (API compatibility)
|
||||
- Manual testing
|
||||
- All of the above
|
||||
|
||||
36. **Test environment:**
|
||||
- Local (mocked)
|
||||
- Dev/staging cloud account
|
||||
- Kind/minikube (for K8s)
|
||||
- Multiple environments
|
||||
|
||||
37. **Terraform testing (if applicable):**
|
||||
- Terratest (Go-based testing)
|
||||
- terraform validate
|
||||
- terraform plan (in CI)
|
||||
- Not applicable
|
||||
|
||||
38. **Kubernetes testing (if operator):**
|
||||
- Unit tests (Go testing)
|
||||
- envtest (fake API server)
|
||||
- Kind cluster (real cluster)
|
||||
- Not applicable
|
||||
|
||||
## Documentation
|
||||
|
||||
39. **Documentation format:**
|
||||
- README (basic)
|
||||
- Detailed docs (Markdown files)
|
||||
- Generated docs (godoc, Sphinx, etc.)
|
||||
- Doc website (MkDocs, Docusaurus)
|
||||
- Interactive examples
|
||||
- All of the above
|
||||
|
||||
40. **Usage examples:**
|
||||
- Code examples
|
||||
- Tutorial walkthroughs
|
||||
- Video demos
|
||||
- Sample configurations
|
||||
- Minimal (README only)
|
||||
|
||||
## Distribution
|
||||
|
||||
41. **Distribution method:**
|
||||
- GitHub Releases (binaries)
|
||||
- Package manager (homebrew, apt, yum)
|
||||
- Container registry (Docker Hub, ghcr.io)
|
||||
- Terraform Registry
|
||||
- Helm chart repository
|
||||
- Language package manager (npm, pip, gem)
|
||||
- Multiple methods
|
||||
|
||||
42. **Installation:**
|
||||
- Download binary
|
||||
- Package manager install
|
||||
- Helm install (for K8s)
|
||||
- Container image pull
|
||||
- Build from source
|
||||
- Multiple methods
|
||||
|
||||
43. **Versioning:**
|
||||
- Semantic versioning (semver)
|
||||
- Calendar versioning
|
||||
- API version compatibility
|
||||
|
||||
## Updates and Lifecycle
|
||||
|
||||
44. **Update mechanism:**
|
||||
- Manual download/install
|
||||
- Package manager update
|
||||
- Auto-update (self-update command)
|
||||
- Helm upgrade
|
||||
- Not applicable
|
||||
|
||||
45. **Backward compatibility:**
|
||||
- Fully backward compatible
|
||||
- Breaking changes documented
|
||||
- Migration guides provided
|
||||
|
||||
46. **Deprecation policy:**
|
||||
- Formal deprecation warnings
|
||||
- Support for N-1 versions
|
||||
- No formal policy
|
||||
|
||||
## Security
|
||||
|
||||
47. **Credentials handling:**
|
||||
- Environment variables
|
||||
- Config file (encrypted)
|
||||
- Cloud provider IAM (instance roles, IRSA)
|
||||
- Kubernetes ServiceAccount
|
||||
- Vault integration
|
||||
- Multiple methods
|
||||
|
||||
48. **Least privilege:**
|
||||
- Minimal permissions documented
|
||||
- Permission templates provided (IAM policies)
|
||||
- No specific guidance
|
||||
|
||||
49. **Code signing:**
|
||||
- Signed binaries
|
||||
- Container image signing (cosign)
|
||||
- Not signed
|
||||
|
||||
50. **Supply chain security:**
|
||||
- SBOM (Software Bill of Materials)
|
||||
- Provenance attestation
|
||||
- Dependency scanning
|
||||
- None
|
||||
|
||||
## Compliance and Governance
|
||||
|
||||
51. **Compliance focus:**
|
||||
- Policy enforcement (OPA, Kyverno)
|
||||
- Audit logging
|
||||
- Cost tagging
|
||||
- Security posture
|
||||
- Not applicable
|
||||
|
||||
52. **Policy as Code:**
|
||||
- OPA (Open Policy Agent)
|
||||
- Sentinel (Terraform)
|
||||
- Kyverno (Kubernetes)
|
||||
- Custom policies
|
||||
- Not applicable
|
||||
|
||||
53. **Audit trail:**
|
||||
- Change tracking
|
||||
- GitOps audit (Git history)
|
||||
- CloudTrail/Activity logs
|
||||
- Not applicable
|
||||
|
||||
## Performance and Scale
|
||||
|
||||
54. **Performance requirements:**
|
||||
- Fast execution (seconds)
|
||||
- Moderate (minutes)
|
||||
- Long-running (hours acceptable)
|
||||
- Background reconciliation (continuous)
|
||||
|
||||
55. **Scale considerations:**
|
||||
- Small scale (< 10 resources)
|
||||
- Medium (10-100 resources)
|
||||
- Large (100-1000 resources)
|
||||
- Very large (1000+ resources)
|
||||
|
||||
56. **Rate limiting:**
|
||||
- Respect cloud API limits
|
||||
- Configurable rate limits
|
||||
- Not applicable
|
||||
|
||||
## CI/CD and Automation
|
||||
|
||||
57. **CI/CD for the tool itself:**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- CircleCI
|
||||
- Custom
|
||||
- Manual builds
|
||||
|
||||
58. **Release automation:**
|
||||
- Automated releases (tags trigger build)
|
||||
- Manual releases
|
||||
- GoReleaser (for Go projects)
|
||||
- Semantic release
|
||||
|
||||
59. **Pre-commit hooks:**
|
||||
- Linting
|
||||
- Formatting
|
||||
- Security scans
|
||||
- None
|
||||
|
||||
## Community and Ecosystem
|
||||
|
||||
60. **Open source:**
|
||||
- Fully open source
|
||||
- Proprietary
|
||||
- Open core (free + paid features)
|
||||
|
||||
61. **License:**
|
||||
- MIT
|
||||
- Apache 2.0
|
||||
- GPL
|
||||
- Proprietary
|
||||
- Other: **\_\_\_**
|
||||
|
||||
62. **Community support:**
|
||||
- GitHub issues
|
||||
- Slack/Discord community
|
||||
- Forum
|
||||
- Commercial support
|
||||
- Minimal (internal tool)
|
||||
|
||||
63. **Plugin/Extension system:**
|
||||
- Extensible (plugins supported)
|
||||
- Monolithic
|
||||
- Planned for future
|
||||
@@ -1,146 +0,0 @@
|
||||
# Library/SDK Architecture Questions
|
||||
|
||||
## Language and Platform
|
||||
|
||||
1. **Primary language:**
|
||||
- TypeScript/JavaScript
|
||||
- Python
|
||||
- Rust
|
||||
- Go
|
||||
- Java/Kotlin
|
||||
- C#
|
||||
- Other: **\_\_\_**
|
||||
|
||||
2. **Target runtime:**
|
||||
- Node.js
|
||||
- Browser (frontend)
|
||||
- Both Node.js + Browser (isomorphic)
|
||||
- Deno
|
||||
- Bun
|
||||
- Python runtime
|
||||
- Other: **\_\_\_**
|
||||
|
||||
3. **Package registry:**
|
||||
- npm (JavaScript)
|
||||
- PyPI (Python)
|
||||
- crates.io (Rust)
|
||||
- Maven Central (Java)
|
||||
- NuGet (.NET)
|
||||
- Go modules
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## API Design
|
||||
|
||||
4. **Public API style:**
|
||||
- Functional (pure functions)
|
||||
- OOP (classes/instances)
|
||||
- Fluent/Builder pattern
|
||||
- Mix
|
||||
|
||||
5. **API surface size:**
|
||||
- Minimal (focused, single purpose)
|
||||
- Comprehensive (many features)
|
||||
|
||||
6. **Async handling:**
|
||||
- Promises (async/await)
|
||||
- Callbacks
|
||||
- Observables (RxJS)
|
||||
- Synchronous only
|
||||
- Mix
|
||||
|
||||
## Type Safety
|
||||
|
||||
7. **Type system:**
|
||||
- TypeScript (JavaScript)
|
||||
- Type hints (Python)
|
||||
- Strongly typed (Rust, Go, Java)
|
||||
- Runtime validation (Zod, Yup)
|
||||
- None (JavaScript)
|
||||
|
||||
8. **Type definitions:**
|
||||
- Bundled with package
|
||||
- @types package (DefinitelyTyped)
|
||||
- Not applicable
|
||||
|
||||
## Build and Distribution
|
||||
|
||||
9. **Build tool:**
|
||||
- tsup (TypeScript, simple)
|
||||
- esbuild (fast)
|
||||
- Rollup
|
||||
- Webpack
|
||||
- Vite
|
||||
- tsc (TypeScript compiler only)
|
||||
- Not needed (pure JS)
|
||||
|
||||
10. **Output format:**
|
||||
- ESM (modern)
|
||||
- CommonJS (Node.js)
|
||||
- UMD (universal)
|
||||
- Multiple formats
|
||||
|
||||
11. **Minification:**
|
||||
- Yes (production bundle)
|
||||
- No (source code)
|
||||
- Source + minified both
|
||||
|
||||
## Dependencies
|
||||
|
||||
12. **Dependency strategy:**
|
||||
- Zero dependencies (standalone)
|
||||
- Minimal dependencies
|
||||
- Standard dependencies OK
|
||||
|
||||
13. **Peer dependencies:**
|
||||
- Yes (e.g., React library requires React)
|
||||
- No
|
||||
|
||||
## Documentation
|
||||
|
||||
14. **Documentation approach:**
|
||||
- README only
|
||||
- API docs (JSDoc, TypeDoc)
|
||||
- Full docs site (VitePress, Docusaurus)
|
||||
- Examples repo
|
||||
- All of the above
|
||||
|
||||
## Testing
|
||||
|
||||
15. **Test framework:**
|
||||
- Jest (JavaScript)
|
||||
- Vitest (Vite-compatible)
|
||||
- Pytest (Python)
|
||||
- Cargo test (Rust)
|
||||
- Go test
|
||||
- Other: **\_\_\_**
|
||||
|
||||
16. **Test coverage goal:**
|
||||
- High (80%+)
|
||||
- Moderate (50-80%)
|
||||
- Critical paths only
|
||||
|
||||
## Versioning and Releases
|
||||
|
||||
17. **Versioning:**
|
||||
- Semantic versioning (semver)
|
||||
- Calendar versioning (calver)
|
||||
- Other
|
||||
|
||||
18. **Release automation:**
|
||||
- Changesets
|
||||
- Semantic Release
|
||||
- Manual
|
||||
- GitHub Releases
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Additional
|
||||
|
||||
19. **CLI included:** (if applicable)
|
||||
- Yes (command-line tool)
|
||||
- No (library only)
|
||||
|
||||
20. **Configuration:**
|
||||
- Config file (JSON, YAML)
|
||||
- Programmatic only
|
||||
- Both
|
||||
- None needed
|
||||
@@ -1,110 +0,0 @@
|
||||
# Mobile Project Architecture Questions
|
||||
|
||||
## Platform
|
||||
|
||||
1. **Target platforms:**
|
||||
- iOS only
|
||||
- Android only
|
||||
- Both iOS + Android
|
||||
|
||||
2. **Framework choice:**
|
||||
- React Native (JavaScript/TypeScript, large ecosystem)
|
||||
- Flutter (Dart, high performance, beautiful UI)
|
||||
- Native (Swift for iOS, Kotlin for Android)
|
||||
- Expo (React Native with managed workflow)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
3. **If React Native - workflow:**
|
||||
- Expo (managed, easier, some limitations)
|
||||
- React Native CLI (bare workflow, full control)
|
||||
|
||||
## Backend and Data
|
||||
|
||||
4. **Backend approach:**
|
||||
- Firebase (BaaS, real-time, easy)
|
||||
- Supabase (BaaS, PostgreSQL, open-source)
|
||||
- Custom API (REST/GraphQL)
|
||||
- AWS Amplify
|
||||
- Other BaaS: **\_\_\_**
|
||||
|
||||
5. **Local data persistence:**
|
||||
- AsyncStorage (simple key-value)
|
||||
- SQLite (relational, offline-first)
|
||||
- Realm (NoSQL, sync)
|
||||
- WatermelonDB (reactive, performance)
|
||||
- MMKV (fast key-value)
|
||||
|
||||
6. **State management:**
|
||||
- Redux Toolkit
|
||||
- Zustand
|
||||
- MobX
|
||||
- Context API + useReducer
|
||||
- Jotai/Recoil
|
||||
- React Query (server state)
|
||||
|
||||
## Navigation
|
||||
|
||||
7. **Navigation library:**
|
||||
- React Navigation (standard for RN)
|
||||
- Expo Router (file-based)
|
||||
- React Native Navigation (native navigation)
|
||||
|
||||
## Authentication
|
||||
|
||||
8. **Auth approach:**
|
||||
- Firebase Auth
|
||||
- Supabase Auth
|
||||
- Auth0
|
||||
- Social auth (Google, Apple, Facebook)
|
||||
- Custom
|
||||
- None
|
||||
|
||||
## Push Notifications
|
||||
|
||||
9. **Push notifications:** (if needed)
|
||||
- Firebase Cloud Messaging
|
||||
- Expo Notifications
|
||||
- OneSignal
|
||||
- AWS SNS
|
||||
- None needed
|
||||
|
||||
## Payments (if applicable)
|
||||
|
||||
10. **In-app purchases:**
|
||||
- RevenueCat (cross-platform, subscriptions)
|
||||
- expo-in-app-purchases
|
||||
- react-native-iap
|
||||
- Stripe (external payments)
|
||||
- None needed
|
||||
|
||||
## Additional
|
||||
|
||||
11. **Maps integration:** (if needed)
|
||||
- Google Maps
|
||||
- Apple Maps
|
||||
- Mapbox
|
||||
- None needed
|
||||
|
||||
12. **Analytics:**
|
||||
- Firebase Analytics
|
||||
- Amplitude
|
||||
- Mixpanel
|
||||
- PostHog
|
||||
- None needed
|
||||
|
||||
13. **Crash reporting:**
|
||||
- Sentry
|
||||
- Firebase Crashlytics
|
||||
- Bugsnag
|
||||
- None needed
|
||||
|
||||
14. **Offline-first requirement:**
|
||||
- Yes (sync when online)
|
||||
- No (online-only)
|
||||
- Partial (some features offline)
|
||||
|
||||
15. **App distribution:**
|
||||
- App Store + Google Play (public)
|
||||
- TestFlight + Internal Testing (beta)
|
||||
- Enterprise distribution
|
||||
- Expo EAS Build
|
||||
@@ -1,12 +0,0 @@
|
||||
project_type_id,display_name,question_file,description,characteristics,typical_stacks,detection_keywords
|
||||
web,Web Application,web-questions.md,"Web applications with frontend and/or backend components","has_ui,server_side,browser_based","Next.js+Supabase, React+Django, Vue+Rails","website,web app,frontend,backend,browser,responsive,SPA,SSR,API"
|
||||
mobile,Mobile Application,mobile-questions.md,"Native or cross-platform mobile applications for iOS/Android","has_ui,native_app,mobile_platform","React Native+Firebase, Flutter+Supabase","mobile,iOS,Android,app store,react native,flutter,smartphone,tablet"
|
||||
embedded,Embedded System,embedded-questions.md,"Embedded systems, IoT devices, and firmware","hardware,firmware,microcontroller,iot","ESP32+FreeRTOS+MQTT, STM32+Bare Metal","embedded,IoT,microcontroller,firmware,sensor,ESP32,Arduino,hardware,MQTT,real-time"
|
||||
game,Game,game-questions.md,"Video games for PC, console, mobile, or web","has_ui,real_time,game_engine,interactive","Unity+Photon+PlayFab, Godot+Nakama","game,unity,unreal,godot,multiplayer,gameplay,3D,2D,player,level"
|
||||
library,Library/SDK,library-questions.md,"Reusable libraries, SDKs, and packages","no_ui,package,reusable,developer_tool","TypeScript+tsup+npm, Python+pip","library,SDK,package,npm,pip,gem,cargo,reusable,API wrapper,utility"
|
||||
desktop,Desktop Application,desktop-questions.md,"Native desktop applications for Windows/Mac/Linux","has_ui,native_app,cross_platform,installable","Electron+React, Tauri+Svelte, .NET MAUI","desktop,Electron,Tauri,Windows,macOS,Linux,installer,native app,system tray"
|
||||
cli,Command-Line Tool,cli-questions.md,"Command-line tools and terminal applications","no_ui,terminal,executable,developer_tool","Go+cobra, Rust+clap, Python+click","CLI,command line,terminal,bash,shell,tool,utility,script,console"
|
||||
backend,Backend/API Service,backend-questions.md,"Backend services and APIs (no frontend)","no_ui,server_side,api,microservices","Node.js+Express+PostgreSQL, FastAPI+Redis","API,backend,microservice,REST,GraphQL,gRPC,server,service,endpoint,database"
|
||||
data,Data/Analytics/ML,data-questions.md,"Data pipelines, analytics, machine learning projects","data_pipeline,analytics,ml,batch_processing","Airflow+Spark+Snowflake, PyTorch+MLflow","ETL,data pipeline,analytics,machine learning,ML,AI,Spark,Airflow,model,dataset,training"
|
||||
extension,Browser Extension,extension-questions.md,"Browser extensions for Chrome, Firefox, Safari, etc.","has_ui,browser_specific,client_side","React+Manifest V3, Plasmo+TypeScript","browser extension,Chrome extension,Firefox addon,manifest,content script,popup"
|
||||
infra,Infrastructure/DevOps,infra-questions.md,"Infrastructure as Code, K8s operators, CI/CD plugins","automation,infrastructure,devops,tooling","Terraform+AWS, Kubernetes Operator (Go), GitHub Actions","Terraform,Kubernetes,operator,IaC,infrastructure,CI/CD,DevOps,automation,deployment"
|
||||
|
@@ -1,136 +0,0 @@
|
||||
# Web Project Architecture Questions
|
||||
|
||||
## Frontend
|
||||
|
||||
1. **Framework choice:**
|
||||
- Next.js (React, App Router, SSR)
|
||||
- React (SPA, client-only)
|
||||
- Vue 3 + Nuxt
|
||||
- Svelte + SvelteKit
|
||||
- Other: **\_\_\_**
|
||||
|
||||
2. **Styling approach:**
|
||||
- Tailwind CSS (utility-first)
|
||||
- CSS Modules
|
||||
- Styled Components (CSS-in-JS)
|
||||
- Sass/SCSS
|
||||
- Other: **\_\_\_**
|
||||
|
||||
3. **State management:** (if complex client state)
|
||||
- Zustand (lightweight)
|
||||
- Redux Toolkit
|
||||
- Jotai/Recoil (atomic)
|
||||
- Context API only
|
||||
- Server state only (React Query/SWR)
|
||||
|
||||
## Backend
|
||||
|
||||
4. **Backend approach:**
|
||||
- Next.js API Routes (integrated)
|
||||
- Express.js (Node.js)
|
||||
- Nest.js (Node.js, structured)
|
||||
- FastAPI (Python)
|
||||
- Django (Python)
|
||||
- Rails (Ruby)
|
||||
- Other: **\_\_\_**
|
||||
|
||||
5. **API paradigm:**
|
||||
- REST
|
||||
- GraphQL (Apollo, Relay)
|
||||
- tRPC (type-safe)
|
||||
- gRPC
|
||||
- Mix: **\_\_\_**
|
||||
|
||||
## Database
|
||||
|
||||
6. **Primary database:**
|
||||
- PostgreSQL (relational, ACID)
|
||||
- MySQL
|
||||
- MongoDB (document)
|
||||
- Supabase (PostgreSQL + backend services)
|
||||
- Firebase Firestore
|
||||
- Other: **\_\_\_**
|
||||
|
||||
7. **ORM/Query builder:**
|
||||
- Prisma (type-safe, modern)
|
||||
- Drizzle ORM
|
||||
- TypeORM
|
||||
- Sequelize
|
||||
- Mongoose (for MongoDB)
|
||||
- Raw SQL
|
||||
- Database client directly (Supabase SDK)
|
||||
|
||||
## Authentication
|
||||
|
||||
8. **Auth approach:**
|
||||
- Supabase Auth (managed, built-in)
|
||||
- Auth0 (managed, enterprise)
|
||||
- Clerk (managed, developer-friendly)
|
||||
- NextAuth.js (self-hosted)
|
||||
- Firebase Auth
|
||||
- Custom JWT implementation
|
||||
- Passport.js
|
||||
|
||||
## Deployment
|
||||
|
||||
9. **Hosting platform:**
|
||||
- Vercel (optimal for Next.js)
|
||||
- Netlify
|
||||
- AWS (EC2, ECS, Lambda)
|
||||
- Google Cloud
|
||||
- Heroku
|
||||
- Railway
|
||||
- Self-hosted
|
||||
|
||||
10. **CI/CD:**
|
||||
- GitHub Actions
|
||||
- GitLab CI
|
||||
- CircleCI
|
||||
- Vercel/Netlify auto-deploy
|
||||
- Other: **\_\_\_**
|
||||
|
||||
## Additional Services (if applicable)
|
||||
|
||||
11. **Email service:** (if transactional emails needed)
|
||||
- Resend (developer-friendly, modern)
|
||||
- SendGrid
|
||||
- AWS SES
|
||||
- Postmark
|
||||
- None needed
|
||||
|
||||
12. **Payment processing:** (if e-commerce/subscriptions)
|
||||
- Stripe (comprehensive)
|
||||
- Lemon Squeezy (SaaS-focused)
|
||||
- PayPal
|
||||
- Square
|
||||
- None needed
|
||||
|
||||
13. **File storage:** (if user uploads)
|
||||
- Supabase Storage
|
||||
- AWS S3
|
||||
- Cloudflare R2
|
||||
- Vercel Blob
|
||||
- Uploadthing
|
||||
- None needed
|
||||
|
||||
14. **Search:** (if full-text search beyond database)
|
||||
- Elasticsearch
|
||||
- Algolia
|
||||
- Meilisearch
|
||||
- Typesense
|
||||
- Database full-text (PostgreSQL)
|
||||
- None needed
|
||||
|
||||
15. **Caching:** (if performance critical)
|
||||
- Redis (external cache)
|
||||
- In-memory (Node.js cache)
|
||||
- CDN caching (Cloudflare/Vercel)
|
||||
- None needed
|
||||
|
||||
16. **Monitoring/Error Tracking:**
|
||||
- Sentry (error tracking)
|
||||
- PostHog (product analytics)
|
||||
- Datadog
|
||||
- LogRocket
|
||||
- Vercel Analytics
|
||||
- None needed
|
||||
@@ -1,195 +0,0 @@
|
||||
# Technical Specification Workflow
|
||||
|
||||
## Overview
|
||||
|
||||
Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping. Creates detailed implementation guidance that bridges business requirements with technical execution.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **PRD-Architecture Integration** - Synthesizes business requirements with technical constraints
|
||||
- **Traceability Mapping** - Links acceptance criteria to technical components and tests
|
||||
- **Multi-Input Support** - Leverages PRD, architecture, front-end specs, and brownfield notes
|
||||
- **Implementation Focus** - Provides concrete technical guidance for development teams
|
||||
- **Testing Integration** - Includes test strategy aligned with acceptance criteria
|
||||
- **Validation Ready** - Generates specifications suitable for architectural review
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Invocation
|
||||
|
||||
```bash
|
||||
workflow tech-spec
|
||||
```
|
||||
|
||||
### With Input Documents
|
||||
|
||||
```bash
|
||||
# With specific PRD and architecture
|
||||
workflow tech-spec --input prd.md --input architecture.md
|
||||
|
||||
# With comprehensive inputs
|
||||
workflow tech-spec --input prd.md --input architecture.md --input front-end-spec.md
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
- **output_folder**: Location for generated technical specification
|
||||
- **epic_id**: Used in output filename (extracted from PRD or prompted)
|
||||
- **recommended_inputs**: PRD, architecture, front-end spec, brownfield notes
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Files Included
|
||||
|
||||
```
|
||||
tech-spec/
|
||||
├── workflow.yaml # Configuration and metadata
|
||||
├── instructions.md # Step-by-step execution guide
|
||||
├── template.md # Technical specification structure
|
||||
├── checklist.md # Validation criteria
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Workflow Process
|
||||
|
||||
### Phase 1: Input Collection and Analysis (Steps 1-2)
|
||||
|
||||
- **Document Discovery**: Locates PRD and Architecture documents
|
||||
- **Epic Extraction**: Identifies epic title and ID from PRD content
|
||||
- **Template Initialization**: Creates tech-spec document from template
|
||||
- **Context Analysis**: Reviews complete PRD and architecture for alignment
|
||||
|
||||
### Phase 2: Technical Design Specification (Step 3)
|
||||
|
||||
- **Service Architecture**: Defines services/modules with responsibilities and interfaces
|
||||
- **Data Modeling**: Specifies entities, schemas, and relationships
|
||||
- **API Design**: Documents endpoints, request/response models, and error handling
|
||||
- **Workflow Definition**: Details sequence flows and data processing patterns
|
||||
|
||||
### Phase 3: Non-Functional Requirements (Step 4)
|
||||
|
||||
- **Performance Specs**: Defines measurable latency, throughput, and scalability targets
|
||||
- **Security Requirements**: Specifies authentication, authorization, and data protection
|
||||
- **Reliability Standards**: Documents availability, recovery, and degradation behavior
|
||||
- **Observability Framework**: Defines logging, metrics, and tracing requirements
|
||||
|
||||
### Phase 4: Dependencies and Integration (Step 5)
|
||||
|
||||
- **Dependency Analysis**: Scans repository for package manifests and frameworks
|
||||
- **Integration Mapping**: Identifies external systems and API dependencies
|
||||
- **Version Management**: Documents version constraints and compatibility requirements
|
||||
- **Infrastructure Needs**: Specifies deployment and runtime dependencies
|
||||
|
||||
### Phase 5: Acceptance and Testing (Step 6)
|
||||
|
||||
- **Criteria Normalization**: Extracts and refines acceptance criteria from PRD
|
||||
- **Traceability Matrix**: Maps acceptance criteria to technical components
|
||||
- **Test Strategy**: Defines testing approach for each acceptance criterion
|
||||
- **Component Mapping**: Links requirements to specific APIs and modules
|
||||
|
||||
### Phase 6: Risk and Validation (Steps 7-8)
|
||||
|
||||
- **Risk Assessment**: Identifies technical risks, assumptions, and open questions
|
||||
- **Mitigation Planning**: Provides strategies for addressing identified risks
|
||||
- **Quality Validation**: Ensures specification meets completeness criteria
|
||||
- **Checklist Verification**: Validates against workflow quality standards
|
||||
|
||||
## Output
|
||||
|
||||
### Generated Files
|
||||
|
||||
- **Primary output**: tech-spec-{epic_id}-{date}.md
|
||||
- **Traceability data**: Embedded mapping tables linking requirements to implementation
|
||||
|
||||
### Output Structure
|
||||
|
||||
1. **Overview and Scope** - Project context and boundaries
|
||||
2. **System Architecture Alignment** - Connection to high-level architecture
|
||||
3. **Detailed Design** - Services, data models, APIs, and workflows
|
||||
4. **Non-Functional Requirements** - Performance, security, reliability, observability
|
||||
5. **Dependencies and Integrations** - External systems and technical dependencies
|
||||
6. **Acceptance Criteria** - Testable requirements from PRD
|
||||
7. **Traceability Mapping** - Requirements-to-implementation mapping
|
||||
8. **Test Strategy** - Testing approach and framework alignment
|
||||
9. **Risks and Assumptions** - Technical risks and mitigation strategies
|
||||
|
||||
## Requirements
|
||||
|
||||
- **PRD Document**: Product Requirements Document with clear acceptance criteria
|
||||
- **Architecture Document**: High-level architecture or technical design
|
||||
- **Repository Access**: For dependency analysis and framework detection
|
||||
- **Epic Context**: Clear epic identification and scope definition
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Before Starting
|
||||
|
||||
1. **Validate Inputs**: Ensure PRD and architecture documents are complete and current
|
||||
2. **Review Requirements**: Confirm acceptance criteria are specific and testable
|
||||
3. **Check Dependencies**: Verify repository structure supports automated dependency analysis
|
||||
|
||||
### During Execution
|
||||
|
||||
1. **Maintain Traceability**: Ensure every acceptance criterion maps to implementation
|
||||
2. **Be Implementation-Specific**: Provide concrete technical guidance, not high-level concepts
|
||||
3. **Consider Constraints**: Factor in existing system limitations and brownfield challenges
|
||||
|
||||
### After Completion
|
||||
|
||||
1. **Architect Review**: Have technical lead validate design decisions
|
||||
2. **Developer Walkthrough**: Ensure implementation team understands specifications
|
||||
3. **Test Planning**: Use traceability matrix for test case development
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Issue**: Missing or incomplete technical details
|
||||
|
||||
- **Solution**: Review architecture document for implementation specifics
|
||||
- **Check**: Ensure PRD contains sufficient functional requirements detail
|
||||
|
||||
**Issue**: Acceptance criteria don't map cleanly to technical components
|
||||
|
||||
- **Solution**: Break down complex criteria into atomic, testable statements
|
||||
- **Check**: Verify PRD acceptance criteria are properly structured
|
||||
|
||||
**Issue**: Dependency analysis fails or is incomplete
|
||||
|
||||
- **Solution**: Check repository structure and manifest file locations
|
||||
- **Check**: Verify repository contains standard dependency files (package.json, etc.)
|
||||
|
||||
**Issue**: Non-functional requirements are too vague
|
||||
|
||||
- **Solution**: Extract specific performance and quality targets from architecture
|
||||
- **Check**: Ensure architecture document contains measurable NFR specifications
|
||||
|
||||
## Customization
|
||||
|
||||
To customize this workflow:
|
||||
|
||||
1. **Modify Template**: Update template.md to match organizational technical spec standards
|
||||
2. **Extend Dependencies**: Add support for additional package managers or frameworks
|
||||
3. **Enhance Validation**: Extend checklist.md with company-specific technical criteria
|
||||
4. **Add Sections**: Include additional technical concerns like DevOps or monitoring
|
||||
|
||||
## Version History
|
||||
|
||||
- **v6.0.0** - Comprehensive technical specification with traceability
|
||||
- PRD-Architecture integration
|
||||
- Automated dependency detection
|
||||
- Traceability mapping
|
||||
- Test strategy alignment
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Validate output using `checklist.md`
|
||||
- Ensure PRD and architecture documents are complete before starting
|
||||
- Consult BMAD documentation for technical specification standards
|
||||
|
||||
---
|
||||
|
||||
_Part of the BMad Method v6 - BMM (Method) Module_
|
||||
@@ -1,17 +0,0 @@
|
||||
# Tech Spec Validation Checklist
|
||||
|
||||
```xml
|
||||
<checklist id="bmad/bmm/workflows/3-solutioning/tech-spec/checklist">
|
||||
<item>Overview clearly ties to PRD goals</item>
|
||||
<item>Scope explicitly lists in-scope and out-of-scope</item>
|
||||
<item>Design lists all services/modules with responsibilities</item>
|
||||
<item>Data models include entities, fields, and relationships</item>
|
||||
<item>APIs/interfaces are specified with methods and schemas</item>
|
||||
<item>NFRs: performance, security, reliability, observability addressed</item>
|
||||
<item>Dependencies/integrations enumerated with versions where known</item>
|
||||
<item>Acceptance criteria are atomic and testable</item>
|
||||
<item>Traceability maps AC → Spec → Components → Tests</item>
|
||||
<item>Risks/assumptions/questions listed with mitigation/next steps</item>
|
||||
<item>Test strategy covers all ACs and critical paths</item>
|
||||
</checklist>
|
||||
```
|
||||
@@ -1,73 +0,0 @@
|
||||
<!-- BMAD BMM Tech Spec Workflow Instructions (v6) -->
|
||||
|
||||
```xml
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This workflow generates a comprehensive Technical Specification from PRD and Architecture, including detailed design, NFRs, acceptance criteria, and traceability mapping.</critical>
|
||||
<critical>Default execution mode: #yolo (non-interactive). If required inputs cannot be auto-discovered and {{non_interactive}} == true, HALT with a clear message listing missing documents; do not prompt.</critical>
|
||||
|
||||
<workflow>
|
||||
<step n="1" goal="Collect inputs and initialize">
|
||||
<action>Identify PRD and Architecture documents from recommended_inputs. Attempt to auto-discover at default paths.</action>
|
||||
<ask optional="true" if="{{non_interactive}} == false">If inputs are missing, ask the user for file paths.</ask>
|
||||
<check>If inputs are missing and {{non_interactive}} == true → HALT with a clear message listing missing documents.</check>
|
||||
<action>Extract {{epic_title}} and {{epic_id}} from PRD (or ASK if not present).</action>
|
||||
<action>Resolve output file path using workflow variables and initialize by writing the template.</action>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Overview and scope">
|
||||
<action>Read COMPLETE PRD and Architecture files.</action>
|
||||
<template-output file="{default_output_file}">
|
||||
Replace {{overview}} with a concise 1-2 paragraph summary referencing PRD context and goals
|
||||
Replace {{objectives_scope}} with explicit in-scope and out-of-scope bullets
|
||||
Replace {{system_arch_alignment}} with a short alignment summary to the architecture (components referenced, constraints)
|
||||
</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Detailed design">
|
||||
<action>Derive concrete implementation specifics from Architecture and PRD (NO invention).</action>
|
||||
<template-output file="{default_output_file}">
|
||||
Replace {{services_modules}} with a table or bullets listing services/modules with responsibilities, inputs/outputs, and owners
|
||||
Replace {{data_models}} with normalized data model definitions (entities, fields, types, relationships); include schema snippets where available
|
||||
Replace {{apis_interfaces}} with API endpoint specs or interface signatures (method, path, request/response models, error codes)
|
||||
Replace {{workflows_sequencing}} with sequence notes or diagrams-as-text (steps, actors, data flow)
|
||||
</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Non-functional requirements">
|
||||
<template-output file="{default_output_file}">
|
||||
Replace {{nfr_performance}} with measurable targets (latency, throughput); link to any performance requirements in PRD/Architecture
|
||||
Replace {{nfr_security}} with authn/z requirements, data handling, threat notes; cite source sections
|
||||
Replace {{nfr_reliability}} with availability, recovery, and degradation behavior
|
||||
Replace {{nfr_observability}} with logging, metrics, tracing requirements; name required signals
|
||||
</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Dependencies and integrations">
|
||||
<action>Scan repository for dependency manifests (e.g., package.json, pyproject.toml, go.mod, Unity Packages/manifest.json).</action>
|
||||
<template-output file="{default_output_file}">
|
||||
Replace {{dependencies_integrations}} with a structured list of dependencies and integration points with version or commit constraints when known
|
||||
</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Acceptance criteria and traceability">
|
||||
<action>Extract acceptance criteria from PRD; normalize into atomic, testable statements.</action>
|
||||
<template-output file="{default_output_file}">
|
||||
Replace {{acceptance_criteria}} with a numbered list of testable acceptance criteria
|
||||
Replace {{traceability_mapping}} with a table mapping: AC → Spec Section(s) → Component(s)/API(s) → Test Idea
|
||||
</template-output>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Risks and test strategy">
|
||||
<template-output file="{default_output_file}">
|
||||
Replace {{risks_assumptions_questions}} with explicit list (each item labeled as Risk/Assumption/Question) with mitigation or next step
|
||||
Replace {{test_strategy}} with a brief plan (test levels, frameworks, coverage of ACs, edge cases)
|
||||
</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Validate">
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using bmad/core/tasks/validate-workflow.md</invoke-task>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
```
|
||||
@@ -1,76 +0,0 @@
|
||||
# Technical Specification: {{epic_title}}
|
||||
|
||||
Date: {{date}}
|
||||
Author: {{user_name}}
|
||||
Epic ID: {{epic_id}}
|
||||
Status: Draft
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{{overview}}
|
||||
|
||||
## Objectives and Scope
|
||||
|
||||
{{objectives_scope}}
|
||||
|
||||
## System Architecture Alignment
|
||||
|
||||
{{system_arch_alignment}}
|
||||
|
||||
## Detailed Design
|
||||
|
||||
### Services and Modules
|
||||
|
||||
{{services_modules}}
|
||||
|
||||
### Data Models and Contracts
|
||||
|
||||
{{data_models}}
|
||||
|
||||
### APIs and Interfaces
|
||||
|
||||
{{apis_interfaces}}
|
||||
|
||||
### Workflows and Sequencing
|
||||
|
||||
{{workflows_sequencing}}
|
||||
|
||||
## Non-Functional Requirements
|
||||
|
||||
### Performance
|
||||
|
||||
{{nfr_performance}}
|
||||
|
||||
### Security
|
||||
|
||||
{{nfr_security}}
|
||||
|
||||
### Reliability/Availability
|
||||
|
||||
{{nfr_reliability}}
|
||||
|
||||
### Observability
|
||||
|
||||
{{nfr_observability}}
|
||||
|
||||
## Dependencies and Integrations
|
||||
|
||||
{{dependencies_integrations}}
|
||||
|
||||
## Acceptance Criteria (Authoritative)
|
||||
|
||||
{{acceptance_criteria}}
|
||||
|
||||
## Traceability Mapping
|
||||
|
||||
{{traceability_mapping}}
|
||||
|
||||
## Risks, Assumptions, Open Questions
|
||||
|
||||
{{risks_assumptions_questions}}
|
||||
|
||||
## Test Strategy Summary
|
||||
|
||||
{{test_strategy}}
|
||||
@@ -1,51 +0,0 @@
|
||||
name: tech-spec
|
||||
description: "Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping"
|
||||
author: "BMAD BMM"
|
||||
|
||||
# Critical variables
|
||||
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"
|
||||
date: system-generated
|
||||
|
||||
# Inputs expected (ask user if missing)
|
||||
recommended_inputs:
|
||||
- prd: "{project-root}/docs/prd.md"
|
||||
- architecture: "{project-root}/docs/architecture.md"
|
||||
- frontend_spec: "{project-root}/docs/front-end-spec.md"
|
||||
- brownfield_notes: "{project-root}/docs/brownfield-notes.md"
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/3-solutioning/tech-spec"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{project-root}/docs/tech-spec-epic-{{epic_id}}.md"
|
||||
|
||||
# Required tools
|
||||
required_tools:
|
||||
- list_files
|
||||
- file_info
|
||||
- read_file
|
||||
- write_file
|
||||
- search_repo
|
||||
- glob
|
||||
- parse_markdown
|
||||
|
||||
tags:
|
||||
- tech-spec
|
||||
- architecture
|
||||
- planning
|
||||
- bmad-v6
|
||||
|
||||
execution_hints:
|
||||
interactive: false
|
||||
autonomous: true
|
||||
iterative: true
|
||||
|
||||
# Variables
|
||||
variables:
|
||||
non_interactive: true
|
||||
@@ -1,66 +0,0 @@
|
||||
# {{TITLE}} Architecture Document
|
||||
|
||||
**Project:** {{project_name}}
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
## 1. Technology Stack and Decisions
|
||||
|
||||
### 1.1 Technology and Library Decision Table
|
||||
|
||||
{{technology_table}}
|
||||
|
||||
## 2. Architecture Overview
|
||||
|
||||
{{architecture_overview}}
|
||||
|
||||
## 3. Data Architecture
|
||||
|
||||
{{data_architecture}}
|
||||
|
||||
## 4. Component and Integration Overview
|
||||
|
||||
{{component_overview}}
|
||||
|
||||
## 5. Architecture Decision Records
|
||||
|
||||
{{architecture_decisions}}
|
||||
|
||||
## 6. Implementation Guidance
|
||||
|
||||
{{implementation_guidance}}
|
||||
|
||||
## 7. Proposed Source Tree
|
||||
|
||||
```
|
||||
{{source_tree}}
|
||||
```
|
||||
|
||||
## 8. Testing Strategy
|
||||
|
||||
{{testing_strategy}}
|
||||
{{testing_specialist_section}}
|
||||
|
||||
## 9. Deployment and Operations
|
||||
|
||||
{{deployment_operations}}
|
||||
{{devops_specialist_section}}
|
||||
|
||||
## 10. Security
|
||||
|
||||
{{security}}
|
||||
{{security_specialist_section}}
|
||||
|
||||
---
|
||||
|
||||
## Specialist Sections
|
||||
|
||||
{{specialist_sections_summary}}
|
||||
|
||||
---
|
||||
|
||||
_Generated using BMad Method Solution Architecture workflow_
|
||||
@@ -1,66 +0,0 @@
|
||||
# {{TITLE}} Architecture Document
|
||||
|
||||
**Project:** {{project_name}}
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
## 1. Technology Stack and Decisions
|
||||
|
||||
### 1.1 Technology and Library Decision Table
|
||||
|
||||
{{technology_table}}
|
||||
|
||||
## 2. Architecture Overview
|
||||
|
||||
{{architecture_overview}}
|
||||
|
||||
## 3. Data Architecture
|
||||
|
||||
{{data_architecture}}
|
||||
|
||||
## 4. Component and Integration Overview
|
||||
|
||||
{{component_overview}}
|
||||
|
||||
## 5. Architecture Decision Records
|
||||
|
||||
{{architecture_decisions}}
|
||||
|
||||
## 6. Implementation Guidance
|
||||
|
||||
{{implementation_guidance}}
|
||||
|
||||
## 7. Proposed Source Tree
|
||||
|
||||
```
|
||||
{{source_tree}}
|
||||
```
|
||||
|
||||
## 8. Testing Strategy
|
||||
|
||||
{{testing_strategy}}
|
||||
{{testing_specialist_section}}
|
||||
|
||||
## 9. Deployment and Operations
|
||||
|
||||
{{deployment_operations}}
|
||||
{{devops_specialist_section}}
|
||||
|
||||
## 10. Security
|
||||
|
||||
{{security}}
|
||||
{{security_specialist_section}}
|
||||
|
||||
---
|
||||
|
||||
## Specialist Sections
|
||||
|
||||
{{specialist_sections_summary}}
|
||||
|
||||
---
|
||||
|
||||
_Generated using BMad Method Solution Architecture workflow_
|
||||
@@ -1,66 +0,0 @@
|
||||
# {{TITLE}} Architecture Document
|
||||
|
||||
**Project:** {{project_name}}
|
||||
**Date:** {{date}}
|
||||
**Author:** {{user_name}}
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
## 1. Technology Stack and Decisions
|
||||
|
||||
### 1.1 Technology and Library Decision Table
|
||||
|
||||
{{technology_table}}
|
||||
|
||||
## 2. Architecture Overview
|
||||
|
||||
{{architecture_overview}}
|
||||
|
||||
## 3. Data Architecture
|
||||
|
||||
{{data_architecture}}
|
||||
|
||||
## 4. Component and Integration Overview
|
||||
|
||||
{{component_overview}}
|
||||
|
||||
## 5. Architecture Decision Records
|
||||
|
||||
{{architecture_decisions}}
|
||||
|
||||
## 6. Implementation Guidance
|
||||
|
||||
{{implementation_guidance}}
|
||||
|
||||
## 7. Proposed Source Tree
|
||||
|
||||
```
|
||||
{{source_tree}}
|
||||
```
|
||||
|
||||
## 8. Testing Strategy
|
||||
|
||||
{{testing_strategy}}
|
||||
{{testing_specialist_section}}
|
||||
|
||||
## 9. Deployment and Operations
|
||||
|
||||
{{deployment_operations}}
|
||||
{{devops_specialist_section}}
|
||||
|
||||
## 10. Security
|
||||
|
||||
{{security}}
|
||||
{{security_specialist_section}}
|
||||
|
||||
---
|
||||
|
||||
## Specialist Sections
|
||||
|
||||
{{specialist_sections_summary}}
|
||||
|
||||
---
|
||||
|
||||
_Generated using BMad Method Solution Architecture workflow_
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user