workflows added to sub items in plan project phase. updated single action checks to be ifs on the action.
This commit is contained in:
Brian Madison
@@ -15,49 +15,48 @@
|
||||
<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:
|
||||
<check if="continuation_mode == true">
|
||||
<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>
|
||||
|
||||
1. Review what's done and continue
|
||||
2. Modify existing sections
|
||||
3. Start fresh
|
||||
</ask>
|
||||
<action>If continuing, skip to first incomplete section</action>
|
||||
<action if="new or starting fresh">Check or existing game-brief in output_folder</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:
|
||||
<check if="game-brief exists">
|
||||
<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
|
||||
</ask>
|
||||
</check>
|
||||
|
||||
Your choice:</ask>
|
||||
<check if="using game-brief">
|
||||
<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>
|
||||
|
||||
<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>
|
||||
</check>
|
||||
|
||||
<check>If no game-brief was loaded:</check>
|
||||
<ask>Describe your game in 1-2 sentences:
|
||||
|
||||
What is it about? What does the player do?</ask>
|
||||
<check if="no game-brief was loaded">
|
||||
<ask>Describe your game. What is it about? What does the player do? What is the Genre or type?</ask>
|
||||
|
||||
<action>Analyze description to determine game type</action>
|
||||
<action>Map to closest game_types.csv id or use "custom"</action>
|
||||
</check>
|
||||
|
||||
<check>Else (game-brief was loaded):</check>
|
||||
<action>Use game concept from brief to determine game type</action>
|
||||
<check if="else (game-brief was loaded)">
|
||||
<action>Use game concept from brief to determine game type</action>
|
||||
|
||||
<ask optional="true">I've identified this as a **{{game_type}}** game. Is that correct?
|
||||
|
||||
If not, briefly describe what type it should be:</ask>
|
||||
<ask optional="true">
|
||||
I've identified this as a **{{game_type}}** game. Is that correct?
|
||||
If not, briefly describe what type it should be:
|
||||
</ask>
|
||||
|
||||
<action>Map selection to game_types.csv id</action>
|
||||
<action>Load corresponding fragment file from game-types/ folder</action>
|
||||
@@ -68,6 +67,7 @@ If not, briefly describe what type it should be:</ask>
|
||||
Get core game concept and vision.
|
||||
|
||||
<template-output>description</template-output>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -383,14 +383,16 @@ Your metrics:</ask>
|
||||
|
||||
<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>
|
||||
<check if="fragment had <narrative-workflow-critical> or <narrative-workflow-recommended>">
|
||||
<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.
|
||||
</check>
|
||||
|
||||
<check if="needs_narrative == true">
|
||||
<ask>This game type ({{game_type}}) is **{{narrative_importance}}** for narrative.
|
||||
|
||||
Your game would benefit from a Narrative Design Document to detail:
|
||||
|
||||
@@ -408,10 +410,12 @@ Would you like to create a Narrative Design Document now?
|
||||
|
||||
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>
|
||||
</check>
|
||||
|
||||
<check if="user selects option 1 or fuzzy indicates wanting to create the narrative design document">
|
||||
<invoke-workflow>{project-root}/bmad/bmm/workflows/2-plan/narrative/workflow.yaml</invoke-workflow>
|
||||
<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.
|
||||
|
||||
@@ -476,7 +480,9 @@ Since this is a Level {{project_level}} game project, you need solutioning for p
|
||||
|
||||
<ask>GDD Complete! Next immediate action:
|
||||
|
||||
<check>If needs_narrative == true:</check>
|
||||
</check>
|
||||
|
||||
<check if="needs_narrative == true">
|
||||
|
||||
1. Create Narrative Design Document (recommended for {{game_type}})
|
||||
2. Start solutioning workflow (engine/architecture)
|
||||
@@ -485,7 +491,9 @@ Since this is a Level {{project_level}} game project, you need solutioning for p
|
||||
5. Review GDD with team/stakeholders
|
||||
6. Exit workflow
|
||||
|
||||
<check>Else:</check>
|
||||
</check>
|
||||
|
||||
<check if="else">
|
||||
|
||||
1. Start solutioning workflow (engine/architecture)
|
||||
2. Create prototype build
|
||||
@@ -494,10 +502,12 @@ Since this is a Level {{project_level}} game project, you need solutioning for p
|
||||
5. Exit workflow
|
||||
|
||||
Which would you like to proceed with?</ask>
|
||||
</check>
|
||||
|
||||
<check>If user selects narrative option:</check>
|
||||
<action>LOAD: {installed_path}/narrative/instructions-narrative.md</action>
|
||||
<action>Pass GDD context to narrative workflow</action>
|
||||
<check if="user selects narrative option">
|
||||
<invoke-workflow>{project-root}/bmad/bmm/workflows/2-plan/narrative/workflow.yaml</invoke-workflow>
|
||||
<action>Pass GDD context to narrative workflow</action>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
99
src/modules/bmm/workflows/2-plan/gdd/workflow.yaml
Normal file
99
src/modules/bmm/workflows/2-plan/gdd/workflow.yaml
Normal file
@@ -0,0 +1,99 @@
|
||||
# Game Design Document (GDD) Workflow
|
||||
name: gdd
|
||||
description: "Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance."
|
||||
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
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan/gdd"
|
||||
instructions: "{installed_path}/instructions-gdd.md"
|
||||
template: "{installed_path}/gdd-template.md"
|
||||
game_types_csv: "{installed_path}/game-types.csv"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/GDD.md"
|
||||
|
||||
# Game type references (loaded based on game type selection)
|
||||
game_type_guides: "{installed_path}/game-types/"
|
||||
|
||||
# Recommended input documents
|
||||
recommended_inputs:
|
||||
- game_brief: "{output_folder}/game-brief.md"
|
||||
- narrative_design: "{output_folder}/narrative-design.md"
|
||||
- market_research: "{output_folder}/market-research.md"
|
||||
|
||||
# Claude Code integration points
|
||||
claude_code_enhancements:
|
||||
- injection_point: "game-design-subagents"
|
||||
- available_subagents:
|
||||
- game-designer: "Core game mechanics and systems design"
|
||||
- game-architect: "Technical architecture for game systems"
|
||||
- user-researcher: "Player experience and engagement"
|
||||
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential design process
|
||||
|
||||
# Game frameworks available
|
||||
frameworks:
|
||||
- "MDA Framework (Mechanics, Dynamics, Aesthetics)"
|
||||
- "Core Loop Design"
|
||||
- "Progression Systems"
|
||||
- "Economy Design"
|
||||
- "Difficulty Curves"
|
||||
- "Player Psychology"
|
||||
- "Game Feel and Juice"
|
||||
|
||||
web_bundle:
|
||||
name: "gdd"
|
||||
description: "Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmm/workflows/2-plan/gdd/instructions-gdd.md"
|
||||
use_advanced_elicitation: true
|
||||
web_bundle_files:
|
||||
- "bmad/bmm/workflows/2-plan/gdd/instructions-gdd.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/gdd-template.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types.csv"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/action-platformer.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/adventure.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/card-game.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/fighting.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/horror.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/idle-incremental.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/metroidvania.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/moba.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/party-game.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/puzzle.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/racing.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/rhythm.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/roguelike.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/rpg.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/sandbox.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/shooter.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/simulation.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/sports.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/strategy.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/survival.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/text-based.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/tower-defense.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/turn-based-tactics.md"
|
||||
- "bmad/bmm/workflows/2-plan/gdd/game-types/visual-novel.md"
|
||||
# Game frameworks available
|
||||
frameworks:
|
||||
- "MDA Framework (Mechanics, Dynamics, Aesthetics)"
|
||||
- "Core Loop Design"
|
||||
- "Progression Systems"
|
||||
- "Economy Design"
|
||||
- "Difficulty Curves"
|
||||
- "Player Psychology"
|
||||
- "Game Feel and Juice"
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential design process
|
||||
@@ -10,9 +10,9 @@
|
||||
|
||||
<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>
|
||||
<check if="exists">
|
||||
<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
|
||||
@@ -30,8 +30,11 @@ Options:
|
||||
3. Review and modify previous analysis
|
||||
</ask>
|
||||
|
||||
<check>If not exists or starting fresh:</check>
|
||||
<action>Proceed to assessment</action>
|
||||
</check>
|
||||
|
||||
<check if="not exists or starting fresh">
|
||||
<action>Proceed to assessment</action>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -49,18 +52,21 @@ Options:
|
||||
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>
|
||||
<action>Capture user selection as {{planning_type}}</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='{{planning_type}} == "2" OR "UX/UI specification only"'>
|
||||
<invoke-workflow>{installed_path}/ux/workflow.yaml</invoke-workflow>
|
||||
<action>Pass mode="standalone" to UX workflow</action>
|
||||
<action>Exit router workflow (skip remaining steps)</action>
|
||||
</check>
|
||||
|
||||
<check>If "Tech spec only" or "Full project planning":</check>
|
||||
<action>Continue to step 3 for project assessment</action>
|
||||
<check if='{{planning_type}} == "4" OR "Generate AI Frontend Prompt"'>
|
||||
<action>Check for existing UX spec or PRD</action>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
<action>Exit router workflow after prompt generation</action>
|
||||
</check>
|
||||
|
||||
<action if='{{planning_type}} == "1" OR "3" OR "Tech spec only" OR "Full project planning"'>Continue to step 3 for project assessment</action>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -89,10 +95,11 @@ c. Working with messy/legacy code (needs refactoring)
|
||||
|
||||
<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>
|
||||
<check if='project_type == "game"'>
|
||||
<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>
|
||||
</check>
|
||||
|
||||
<action>Else, based on their description, analyze and suggest scope level:</action>
|
||||
|
||||
@@ -174,48 +181,33 @@ Generate comprehensive analysis with all assessment data.
|
||||
|
||||
<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>
|
||||
<check if='workflow_type == "gdd"'>
|
||||
<invoke-workflow>{installed_path}/gdd/workflow.yaml</invoke-workflow>
|
||||
<action>GDD workflow handles all game project levels internally</action>
|
||||
</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">
|
||||
<invoke-workflow>{installed_path}/tech-spec/workflow.yaml</invoke-workflow>
|
||||
</check>
|
||||
|
||||
<check>If Level 0:</check>
|
||||
<action>LOAD: {installed_path}/tech-spec/instructions-sm.md</action>
|
||||
<check>If continuing:</check>
|
||||
<check if="Level 1-2">
|
||||
<invoke-workflow>{installed_path}/prd/workflow.yaml</invoke-workflow>
|
||||
<action>Pass level context to PRD workflow (loads instructions-med.md)</action>
|
||||
</check>
|
||||
|
||||
- Load existing tech-spec.md
|
||||
- Allow user to review and modify
|
||||
- Complete any missing sections
|
||||
<check if="Level 3-4">
|
||||
<invoke-workflow>{installed_path}/prd/workflow.yaml</invoke-workflow>
|
||||
<action>Pass level context to PRD workflow (loads instructions-lg.md)</action>
|
||||
</check>
|
||||
|
||||
<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>
|
||||
<critical>Pass continuation context to invoked workflow:</critical>
|
||||
|
||||
- continuation_mode: true/false
|
||||
- last_completed_step: {{step_number}}
|
||||
- existing_documents: {{document_list}}
|
||||
- project_level: {{level}}
|
||||
|
||||
<critical>The loaded instruction set should check continuation_mode and adjust accordingly</critical>
|
||||
<critical>The invoked workflow's instruction set should check continuation_mode and adjust accordingly</critical>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
<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>
|
||||
<critical>Facilitate good brainstorming techniques throughout with the user, pushing them to come up with much of the narrative you will help weave together. The goal is for the user to feel that they crafted the narrative and story arc unless they push you to do it all or indicate YOLO</critical>
|
||||
|
||||
<step n="1" goal="Load GDD context and assess narrative complexity">
|
||||
|
||||
@@ -26,7 +27,7 @@ Your game type ({{game_type}}) suggests **{{suggested_complexity}}**. Confirm or
|
||||
|
||||
<action>Set narrative_complexity</action>
|
||||
|
||||
<check>If complexity == "Light":</check>
|
||||
<check if="complexity == "Light"">
|
||||
<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
|
||||
@@ -37,6 +38,8 @@ Your choice:</ask>
|
||||
|
||||
<action>Load narrative_template from workflow.yaml</action>
|
||||
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define narrative premise and themes">
|
||||
@@ -304,8 +307,8 @@ Your key conversations:</ask>
|
||||
|
||||
<template-output>key_conversations</template-output>
|
||||
|
||||
<check>If game has branching dialogue:</check>
|
||||
<ask>Describe your branching dialogue system.
|
||||
<check if="game has branching dialogue">
|
||||
<ask>Describe your branching dialogue system.
|
||||
|
||||
- How many branches/paths?
|
||||
- What determines branches? (stats, choices, flags)
|
||||
@@ -315,6 +318,7 @@ Your key conversations:</ask>
|
||||
Your branching system:</ask>
|
||||
|
||||
<template-output>branching_dialogue</template-output>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -397,8 +401,8 @@ Your optional content:</ask>
|
||||
|
||||
<template-output>optional_content</template-output>
|
||||
|
||||
<check>If multiple endings:</check>
|
||||
<ask>Describe your ending structure.
|
||||
<check if="multiple endings">
|
||||
<ask>Describe your ending structure.
|
||||
|
||||
- How many endings?
|
||||
- What determines ending? (choices, stats, completion)
|
||||
@@ -408,6 +412,7 @@ Your optional content:</ask>
|
||||
Your endings:</ask>
|
||||
|
||||
<template-output>multiple_endings</template-output>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
63
src/modules/bmm/workflows/2-plan/narrative/workflow.yaml
Normal file
63
src/modules/bmm/workflows/2-plan/narrative/workflow.yaml
Normal file
@@ -0,0 +1,63 @@
|
||||
# Narrative Design Workflow
|
||||
name: narrative
|
||||
description: "Narrative design workflow for story-driven games and applications. Creates comprehensive narrative documentation including story structure, character arcs, dialogue systems, and narrative implementation guidance."
|
||||
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
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan/narrative"
|
||||
instructions: "{installed_path}/instructions-narrative.md"
|
||||
template: "{installed_path}/narrative-template.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/narrative-design.md"
|
||||
|
||||
# Recommended input documents
|
||||
recommended_inputs:
|
||||
- game_brief: "{output_folder}/game-brief.md"
|
||||
- gdd: "{output_folder}/GDD.md"
|
||||
- product_brief: "{output_folder}/product-brief.md"
|
||||
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential narrative development
|
||||
|
||||
# Narrative frameworks available
|
||||
frameworks:
|
||||
- "Hero's Journey"
|
||||
- "Three-Act Structure"
|
||||
- "Character Arc Development"
|
||||
- "Branching Narrative Design"
|
||||
- "Environmental Storytelling"
|
||||
- "Dialogue Systems"
|
||||
- "Narrative Pacing"
|
||||
|
||||
web_bundle:
|
||||
name: "narrative"
|
||||
description: "Narrative design workflow for story-driven games and applications. Creates comprehensive narrative documentation including story structure, character arcs, dialogue systems, and narrative implementation guidance."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmm/workflows/2-plan/narrative/instructions-narrative.md"
|
||||
use_advanced_elicitation: true
|
||||
web_bundle_files:
|
||||
- "bmad/bmm/workflows/2-plan/narrative/instructions-narrative.md"
|
||||
- "bmad/bmm/workflows/2-plan/narrative/narrative-template.md"
|
||||
recommended_inputs: "PRD, Product Brief, Brain Storming Report, GDD"
|
||||
# Narrative frameworks available
|
||||
frameworks:
|
||||
- "Hero's Journey"
|
||||
- "Three-Act Structure"
|
||||
- "Character Arc Development"
|
||||
- "Branching Narrative Design"
|
||||
- "Environmental Storytelling"
|
||||
- "Dialogue Systems"
|
||||
- "Narrative Pacing"
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential narrative development
|
||||
@@ -15,18 +15,19 @@
|
||||
<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:
|
||||
<check if="continuation_mode == true">
|
||||
<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>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for `product_brief`, `market_research`, and other docs.
|
||||
<check if="new or starting fresh">
|
||||
Check `output_folder` for `product_brief`, `market_research`, and other docs.
|
||||
|
||||
<critical>For Level 3-4, Product Brief is STRONGLY recommended</critical>
|
||||
|
||||
@@ -35,6 +36,7 @@ Check `output_folder` for `product_brief`, `market_research`, and other docs.
|
||||
Get comprehensive description of the project vision.
|
||||
|
||||
<template-output>description</template-output>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -200,15 +202,10 @@ Since this is a Level {{project_level}} project, you need architecture before st
|
||||
- Input: PRD.md, epics.md
|
||||
- Output: architecture.md
|
||||
|
||||
<check>If project has significant UX/UI components (Level 3-4 typically does):</check>
|
||||
<check if="project has significant UX/UI components (Level 3-4 typically does)">
|
||||
|
||||
- [ ] **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
|
||||
- [ ] **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
|
||||
</check>
|
||||
|
||||
### Phase 2: Detailed Planning
|
||||
|
||||
@@ -246,7 +243,7 @@ Since this is a Level {{project_level}} project, you need architecture before st
|
||||
|
||||
<ask>Project Planning Complete! Next immediate action:
|
||||
|
||||
1. Start architecture workflow
|
||||
1. Start architecture workflow with the architect in a new context window
|
||||
2. Create UX specification (if UI-heavy project)
|
||||
3. Generate AI Frontend Prompt (if UX complete)
|
||||
4. Review all outputs with stakeholders
|
||||
@@ -255,12 +252,14 @@ Since this is a Level {{project_level}} project, you need architecture before st
|
||||
|
||||
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 2">
|
||||
<invoke-workflow>{project-root}/bmad/bmm/workflows/2-plan/ux/workflow.yaml</invoke-workflow>
|
||||
<action>Pass mode="integrated" with Level 3-4 context</action>
|
||||
</check>
|
||||
|
||||
<check>If user selects option 3:</check>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
<check if="user selects option 3">
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
@@ -15,24 +15,25 @@
|
||||
<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:
|
||||
<check if="continuation_mode == true">
|
||||
<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>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for existing docs. Ask user if they have a Product Brief.
|
||||
<check if="new or starting fresh">
|
||||
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>
|
||||
<critical>Discuss with them to get the core idea of what they're building</critical>
|
||||
|
||||
<template-output>description</template-output>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -155,13 +156,15 @@ Only document ACTUAL assumptions from discussion.
|
||||
|
||||
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>
|
||||
<check if="yes">
|
||||
<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>
|
||||
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -194,15 +197,10 @@ Since this is a Level {{project_level}} project, you need solutioning before imp
|
||||
- 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>
|
||||
<check if="project has significant UX/UI components (Level 1-2 with UI)">
|
||||
|
||||
- [ ] **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
|
||||
- [ ] **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
|
||||
</check>
|
||||
|
||||
### Phase 2: Detailed Planning
|
||||
|
||||
@@ -239,12 +237,16 @@ Since this is a Level {{project_level}} project, you need solutioning before imp
|
||||
|
||||
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 2">
|
||||
<invoke-workflow>{project-root}/bmad/bmm/workflows/2-plan/ux/workflow.yaml</invoke-workflow>
|
||||
<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>
|
||||
</check>
|
||||
|
||||
<check if="user selects option 3">
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
95
src/modules/bmm/workflows/2-plan/prd/workflow.yaml
Normal file
95
src/modules/bmm/workflows/2-plan/prd/workflow.yaml
Normal file
@@ -0,0 +1,95 @@
|
||||
# Product Requirements Document (PRD) Workflow
|
||||
name: prd
|
||||
description: "Scale-adaptive PRD workflow for project levels 1-4. Level 1-2: focused PRD + solutioning handoff. Level 3-4: full PRD with epics + architect handoff. Automatically adjusts scope based on project complexity."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
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
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan/prd"
|
||||
|
||||
# Instructions - routes to appropriate level-based instructions
|
||||
instructions_med: "{installed_path}/instructions-med.md" # Level 1-2
|
||||
instructions_lg: "{installed_path}/instructions-lg.md" # Level 3-4
|
||||
|
||||
# Templates
|
||||
prd_template: "{installed_path}/prd-template.md"
|
||||
analysis_template: "{installed_path}/analysis-template.md"
|
||||
epics_template: "{installed_path}/epics-template.md"
|
||||
|
||||
# Output configuration
|
||||
analysis_file: "{output_folder}/project-workflow-analysis.md"
|
||||
default_output_file: "{output_folder}/PRD.md"
|
||||
epics_output_file: "{output_folder}/epics.md"
|
||||
validation_output_file: "{output_folder}/PRD-validation-report.md"
|
||||
|
||||
# Recommended input documents
|
||||
recommended_inputs:
|
||||
- product_brief: "{output_folder}/product-brief.md"
|
||||
- market_research: "{output_folder}/market-research.md"
|
||||
|
||||
# Scale parameters - adaptive by project level
|
||||
scale_parameters:
|
||||
level_1: "1-10 stories, 1 epic, minimal PRD + solutioning handoff"
|
||||
level_2: "5-15 stories, 1-2 epics, focused PRD + solutioning handoff"
|
||||
level_3: "12-40 stories, 2-5 epics, full PRD + architect handoff"
|
||||
level_4: "40+ stories, 5+ epics, enterprise PRD + architect handoff"
|
||||
|
||||
# Claude Code integration points
|
||||
claude_code_enhancements:
|
||||
- injection_point: "prd-subagents"
|
||||
- available_subagents:
|
||||
- requirements-analyst: "Requirements analysis and refinement"
|
||||
- user-journey-mapper: "User journey and epic boundaries"
|
||||
- epic-optimizer: "Epic scope optimization"
|
||||
- document-reviewer: "PRD quality validation"
|
||||
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential planning process
|
||||
|
||||
# Product frameworks available
|
||||
frameworks:
|
||||
- "Jobs-to-be-Done"
|
||||
- "User Story Mapping"
|
||||
- "Epic Decomposition"
|
||||
- "Acceptance Criteria"
|
||||
- "MoSCoW Prioritization"
|
||||
|
||||
web_bundle:
|
||||
name: "prd"
|
||||
description: "Scale-adaptive PRD workflow for project levels 1-4. Level 1-2: focused PRD + solutioning handoff. Level 3-4: full PRD with epics + architect handoff. Automatically adjusts scope based on project complexity."
|
||||
author: "BMad"
|
||||
# Note: Router workflow will load appropriate instructions based on level
|
||||
instructions_med: "bmad/bmm/workflows/2-plan/prd/instructions-med.md"
|
||||
instructions_lg: "bmad/bmm/workflows/2-plan/prd/instructions-lg.md"
|
||||
use_advanced_elicitation: true
|
||||
web_bundle_files:
|
||||
- "bmad/bmm/workflows/2-plan/prd/instructions-med.md"
|
||||
- "bmad/bmm/workflows/2-plan/prd/instructions-lg.md"
|
||||
- "bmad/bmm/workflows/2-plan/prd/prd-template.md"
|
||||
- "bmad/bmm/workflows/2-plan/prd/analysis-template.md"
|
||||
- "bmad/bmm/workflows/2-plan/prd/epics-template.md"
|
||||
# Scale parameters - adaptive by project level
|
||||
scale_parameters:
|
||||
level_1: "1-10 stories, 1 epic, minimal PRD + solutioning handoff"
|
||||
level_2: "5-15 stories, 1-2 epics, focused PRD + solutioning handoff"
|
||||
level_3: "12-40 stories, 2-5 epics, full PRD + architect handoff"
|
||||
level_4: "40+ stories, 5+ epics, enterprise PRD + architect handoff"
|
||||
# Product frameworks available
|
||||
frameworks:
|
||||
- "Jobs-to-be-Done"
|
||||
- "User Story Mapping"
|
||||
- "Epic Decomposition"
|
||||
- "Acceptance Criteria"
|
||||
- "MoSCoW Prioritization"
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential planning process
|
||||
@@ -74,12 +74,13 @@
|
||||
|
||||
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>
|
||||
<check if="yes">
|
||||
<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>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -99,19 +100,19 @@ Run cohesion validation? (y/n)</ask>
|
||||
|
||||
<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
|
||||
<check if="change involves UI components">
|
||||
- [ ] **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
|
||||
</check>
|
||||
|
||||
- [ ] **Generate implementation task**
|
||||
- Command: `workflow task-generation`
|
||||
- Uses: tech-spec.md
|
||||
|
||||
<check>If change is backend/API only:</check>
|
||||
<check if="change is backend/API only">
|
||||
|
||||
**Recommended Next Steps:**
|
||||
|
||||
@@ -132,6 +133,8 @@ Run cohesion validation? (y/n)</ask>
|
||||
|
||||
Select option (1-4):</ask>
|
||||
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
|
||||
64
src/modules/bmm/workflows/2-plan/tech-spec/workflow.yaml
Normal file
64
src/modules/bmm/workflows/2-plan/tech-spec/workflow.yaml
Normal file
@@ -0,0 +1,64 @@
|
||||
# Technical Specification Workflow (Level 0)
|
||||
name: tech-spec-sm
|
||||
description: "Technical specification workflow for Level 0 projects (single atomic changes). Creates focused tech spec for bug fixes, single endpoint additions, or small isolated changes. Tech-spec only - no PRD needed."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
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
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan/tech-spec"
|
||||
instructions: "{installed_path}/instructions-sm.md"
|
||||
template: "{installed_path}/tech-spec-template.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/tech-spec.md"
|
||||
|
||||
# Recommended input documents (optional for Level 0)
|
||||
recommended_inputs:
|
||||
- bug_report: "Bug description or issue ticket"
|
||||
- feature_request: "Brief feature description"
|
||||
|
||||
# Claude Code integration points
|
||||
claude_code_enhancements:
|
||||
- injection_point: "tech-spec-subagents"
|
||||
- available_subagents:
|
||||
- technical-evaluator: "Technology assessment and feasibility"
|
||||
- codebase-analyzer: "Existing code analysis"
|
||||
- pattern-detector: "Identify coding patterns to follow"
|
||||
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential specification
|
||||
|
||||
# Technical frameworks available
|
||||
frameworks:
|
||||
- "Technical Design Patterns"
|
||||
- "API Design Principles"
|
||||
- "Code Organization Standards"
|
||||
- "Testing Strategies"
|
||||
|
||||
web_bundle:
|
||||
name: "tech-spec-sm"
|
||||
description: "Technical specification workflow for Level 0 projects (single atomic changes). Creates focused tech spec for bug fixes, single endpoint additions, or small isolated changes. Tech-spec only - no PRD needed."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmm/workflows/2-plan/tech-spec/instructions-sm.md"
|
||||
use_advanced_elicitation: true
|
||||
web_bundle_files:
|
||||
- "bmad/bmm/workflows/2-plan/tech-spec/instructions-sm.md"
|
||||
- "bmad/bmm/workflows/2-plan/tech-spec/tech-spec-template.md"
|
||||
# Technical frameworks available
|
||||
frameworks:
|
||||
- "Technical Design Patterns"
|
||||
- "API Design Principles"
|
||||
- "Code Organization Standards"
|
||||
- "Testing Strategies"
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential specification
|
||||
@@ -12,15 +12,16 @@
|
||||
|
||||
<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)
|
||||
<check if="mode is standalone">
|
||||
<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>
|
||||
|
||||
<check>If no PRD in standalone mode:</check>
|
||||
<ask>Let's gather essential information:
|
||||
<check if="no PRD in standalone mode">
|
||||
<ask>Let's gather essential information:
|
||||
|
||||
1. **Project Description**: What are you building?
|
||||
2. **Target Users**: Who will use this?
|
||||
@@ -28,9 +29,10 @@ If no: We'll gather basic requirements to create the UX spec
|
||||
4. **Platform**: Web, mobile, desktop, or multi-platform?
|
||||
5. **Existing Brand/Design**: Any existing style guide or brand to follow?
|
||||
</ask>
|
||||
</check>
|
||||
|
||||
<check>If PRD exists or integrated mode:</check>
|
||||
<action>Load the following documents if available:</action>
|
||||
<check if="PRD exists or integrated mode">
|
||||
<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)
|
||||
@@ -38,6 +40,8 @@ If no: We'll gather basic requirements to create the UX spec
|
||||
- architecture.md (if Level 3-4 project)
|
||||
- project-workflow-analysis.md (understand project level and scope)
|
||||
|
||||
</check>
|
||||
|
||||
<action>Analyze project for UX complexity:</action>
|
||||
|
||||
- Number of user-facing features
|
||||
@@ -225,13 +229,14 @@ This is recommended for:
|
||||
- Complex state transitions
|
||||
</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
<check if="yes or fuzzy match the user wants to define animation or micro interactions">
|
||||
|
||||
<action>Define motion principles</action>
|
||||
<template-output>motion_principles</template-output>
|
||||
|
||||
<action>Define key animations and transitions</action>
|
||||
<template-output>key_animations</template-output>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -241,26 +246,26 @@ This is recommended for:
|
||||
|
||||
**1. Will you be creating high-fidelity designs?**
|
||||
|
||||
- [ ] Yes, in Figma
|
||||
- [ ] Yes, in Sketch
|
||||
- [ ] Yes, in Adobe XD
|
||||
- [ ] No, development from spec
|
||||
- [ ] Other: **\_\_\_\_**
|
||||
- Yes, in Figma
|
||||
- Yes, in Sketch
|
||||
- Yes, in Adobe XD
|
||||
- No, development from spec
|
||||
- Other (describe)
|
||||
|
||||
**2. For key screens, should we:**
|
||||
|
||||
- [ ] Reference design file locations
|
||||
- [ ] Create low-fi wireframe descriptions
|
||||
- [ ] Skip visual representations
|
||||
</ask>
|
||||
- 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>
|
||||
<template-output if="design files will be created">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>
|
||||
<check if="wireframe descriptions needed">
|
||||
<for-each screen="key_screens">
|
||||
<template-output>screen*layout*{{screen_number}}</template-output>
|
||||
</for-each>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -281,17 +286,18 @@ This is recommended for:
|
||||
- [ ] Brand guidelines incorporated
|
||||
- [ ] Performance goals established
|
||||
|
||||
<check>If Level 3-4 project:</check>
|
||||
<check if="Level 3-4 project">
|
||||
- [ ] Ready for detailed visual design
|
||||
- [ ] Frontend architecture can proceed
|
||||
- [ ] Story generation can include UX details
|
||||
</check>
|
||||
|
||||
- [ ] Ready for detailed visual design
|
||||
- [ ] Frontend architecture can proceed
|
||||
- [ ] Story generation can include UX details
|
||||
<check if="Level 1-2 project or standalone">
|
||||
- [ ] Development can proceed with spec
|
||||
- [ ] Component implementation order defined
|
||||
- [ ] MVP scope clear
|
||||
|
||||
<check>If Level 1-2 project or standalone:</check>
|
||||
|
||||
- [ ] Development can proceed with spec
|
||||
- [ ] Component implementation order defined
|
||||
- [ ] MVP scope clear
|
||||
</check>
|
||||
|
||||
<template-output>design_handoff_checklist</template-output>
|
||||
|
||||
@@ -307,8 +313,9 @@ This is recommended for:
|
||||
|
||||
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>
|
||||
<check if="user selects yes or option 1">
|
||||
<goto step="11">Generate AI Frontend Prompt</goto>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
71
src/modules/bmm/workflows/2-plan/ux/workflow.yaml
Normal file
71
src/modules/bmm/workflows/2-plan/ux/workflow.yaml
Normal file
@@ -0,0 +1,71 @@
|
||||
# UX/UI Specification Workflow
|
||||
name: ux-spec
|
||||
description: "UX/UI specification workflow for defining user experience and interface design. Creates comprehensive UX documentation including wireframes, user flows, component specifications, and design system guidelines."
|
||||
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
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan/ux"
|
||||
instructions: "{installed_path}/instructions-ux.md"
|
||||
template: "{installed_path}/ux-spec-template.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/ux-specification.md"
|
||||
ai_frontend_prompt_file: "{output_folder}/ai-frontend-prompt.md"
|
||||
|
||||
# Recommended input documents
|
||||
recommended_inputs:
|
||||
- prd: "{output_folder}/PRD.md"
|
||||
- product_brief: "{output_folder}/product-brief.md"
|
||||
- gdd: "{output_folder}/GDD.md"
|
||||
|
||||
# Claude Code integration points
|
||||
claude_code_enhancements:
|
||||
- injection_point: "ux-subagents"
|
||||
- available_subagents:
|
||||
- ux-expert: "User experience design and best practices"
|
||||
- user-researcher: "User research and persona development"
|
||||
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential UX design process
|
||||
|
||||
# UX frameworks available
|
||||
frameworks:
|
||||
- "User-Centered Design"
|
||||
- "Design System Principles"
|
||||
- "Accessibility (WCAG)"
|
||||
- "Responsive Design"
|
||||
- "Component-Based Design"
|
||||
- "Atomic Design"
|
||||
- "Material Design / Human Interface Guidelines"
|
||||
|
||||
web_bundle:
|
||||
name: "ux-spec"
|
||||
description: "UX/UI specification workflow for defining user experience and interface design. Creates comprehensive UX documentation including wireframes, user flows, component specifications, and design system guidelines."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmm/workflows/2-plan/ux/instructions-ux.md"
|
||||
use_advanced_elicitation: true
|
||||
web_bundle_files:
|
||||
- "bmad/bmm/workflows/2-plan/ux/instructions-ux.md"
|
||||
- "bmad/bmm/workflows/2-plan/ux/ux-spec-template.md"
|
||||
recommended_inputs: "PRD, Product Brief, Brain Storming Report, GDD"
|
||||
# UX frameworks available
|
||||
frameworks:
|
||||
- "User-Centered Design"
|
||||
- "Design System Principles"
|
||||
- "Accessibility (WCAG)"
|
||||
- "Responsive Design"
|
||||
- "Component-Based Design"
|
||||
- "Atomic Design"
|
||||
- "Material Design / Human Interface Guidelines"
|
||||
# Workflow configuration
|
||||
interactive: true # User checkpoints throughout
|
||||
autonomous: false # Requires user input
|
||||
allow_parallel: false # Sequential UX design process
|
||||
@@ -18,6 +18,13 @@ recommended_inputs:
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/2-plan"
|
||||
|
||||
# Sub-workflow references - Router invokes these workflows based on project type/level
|
||||
workflow_gdd: "{installed_path}/gdd/workflow.yaml"
|
||||
workflow_prd: "{installed_path}/prd/workflow.yaml"
|
||||
workflow_narrative: "{installed_path}/narrative/workflow.yaml"
|
||||
workflow_tech_spec: "{installed_path}/tech-spec/workflow.yaml"
|
||||
workflow_ux: "{installed_path}/ux/workflow.yaml"
|
||||
|
||||
# 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"
|
||||
|
||||
Reference in New Issue
Block a user