workflows indicate web_bundle file inclusions
This commit is contained in:
@@ -8,7 +8,7 @@
|
|||||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
<i>DO NOT skip steps or change the sequence</i>
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
<i>HALT immediately when halt-conditions are met</i>
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
<i>Each <action> within <step> is a REQUIRED action to complete that step</i>
|
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
||||||
</llm>
|
</llm>
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@
|
|||||||
</smart-selection>
|
</smart-selection>
|
||||||
</step>
|
</step>
|
||||||
|
|
||||||
<step n="2" title="Present Options & Handle Responses">
|
<step n="2" title="Present Options and Handle Responses">
|
||||||
|
|
||||||
<format>
|
<format>
|
||||||
**Advanced Elicitation Options**
|
**Advanced Elicitation Options**
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
<i>DO NOT skip steps or change the sequence</i>
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
<i>HALT immediately when halt-conditions are met</i>
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
<i>Each <action> within <step> is a REQUIRED action to complete that step</i>
|
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
||||||
</llm>
|
</llm>
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
<i>DO NOT skip steps or change the sequence</i>
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
<i>HALT immediately when halt-conditions are met</i>
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
<i>Each <action> within <step> is a REQUIRED action to complete that step</i>
|
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
||||||
</llm>
|
</llm>
|
||||||
|
|
||||||
|
|||||||
@@ -11,14 +11,4 @@ date: system-generated
|
|||||||
template: false
|
template: false
|
||||||
instructions: "{project-root}/src/core/workflows/bmad-init/instructions.md"
|
instructions: "{project-root}/src/core/workflows/bmad-init/instructions.md"
|
||||||
|
|
||||||
# Sub-components
|
web_bundle: false
|
||||||
party_update_instructions: "{project-root}/src/core/workflows/bmad-init/party-update/instructions.md"
|
|
||||||
|
|
||||||
# No specific output file - this workflow performs various system actions
|
|
||||||
default_output_file: null
|
|
||||||
|
|
||||||
# Required tools for execution
|
|
||||||
required_tools:
|
|
||||||
- file_operations
|
|
||||||
- llm_analysis
|
|
||||||
- xml_generation
|
|
||||||
|
|||||||
@@ -22,3 +22,5 @@ exit_triggers:
|
|||||||
- "*exit"
|
- "*exit"
|
||||||
- "end party mode"
|
- "end party mode"
|
||||||
- "stop party mode"
|
- "stop party mode"
|
||||||
|
|
||||||
|
web_bundle: false
|
||||||
|
|||||||
@@ -9,8 +9,3 @@ prompt: "Happy Building - Build the Modules, Workflows and Agents of your dreams
|
|||||||
## user_name
|
## user_name
|
||||||
## communication_language
|
## communication_language
|
||||||
## output_folder
|
## output_folder
|
||||||
|
|
||||||
src_impact:
|
|
||||||
prompt: "Are you installing this module to your local Forked BMad Core repository? (not a separate project which is normally the case)"
|
|
||||||
default: false
|
|
||||||
result: "{value}"
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ The Convert Legacy workflow is a comprehensive migration tool that converts BMAD
|
|||||||
|
|
||||||
- **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules
|
- **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules
|
||||||
- **Intelligent Conversion** - Smart mapping from v4 patterns to v5 equivalents with structural improvements
|
- **Intelligent Conversion** - Smart mapping from v4 patterns to v5 equivalents with structural improvements
|
||||||
- **Sub-Workflow Integration** - Leverages build-agent, build-workflow, and build-module workflows for quality output
|
- **Sub-Workflow Integration** - Leverages create-agent, create-workflow, and create-module workflows for quality output
|
||||||
- **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows
|
- **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows
|
||||||
- **Path Normalization** - Updates all references to use proper v5 path conventions
|
- **Path Normalization** - Updates all references to use proper v5 path conventions
|
||||||
- **Validation System** - Comprehensive validation of converted items before finalization
|
- **Validation System** - Comprehensive validation of converted items before finalization
|
||||||
@@ -60,7 +60,7 @@ convert-legacy/
|
|||||||
|
|
||||||
### Phase 1: Legacy Analysis (Steps 1-3)
|
### Phase 1: Legacy Analysis (Steps 1-3)
|
||||||
|
|
||||||
**Item Identification & Loading**
|
**Item Identification and Loading**
|
||||||
|
|
||||||
- Accepts file path or directory from user
|
- Accepts file path or directory from user
|
||||||
- Loads complete file/folder structure for analysis
|
- Loads complete file/folder structure for analysis
|
||||||
@@ -91,10 +91,10 @@ convert-legacy/
|
|||||||
**Strategy Selection Based on Item Type**
|
**Strategy Selection Based on Item Type**
|
||||||
|
|
||||||
- **Simple Agents**: Direct XML conversion with metadata mapping
|
- **Simple Agents**: Direct XML conversion with metadata mapping
|
||||||
- **Complex Agents**: Workflow-assisted creation using build-agent
|
- **Complex Agents**: Workflow-assisted creation using create-agent
|
||||||
- **Templates**: Template-to-workflow conversion with proper structure
|
- **Templates**: Template-to-workflow conversion with proper structure
|
||||||
- **Tasks**: Task-to-workflow conversion with step mapping
|
- **Tasks**: Task-to-workflow conversion with step mapping
|
||||||
- **Modules**: Full module creation using build-module workflow
|
- **Modules**: Full module creation using create-module workflow
|
||||||
|
|
||||||
**Workflow Type Determination**
|
**Workflow Type Determination**
|
||||||
|
|
||||||
@@ -118,9 +118,9 @@ convert-legacy/
|
|||||||
|
|
||||||
- Extracts key information from legacy items
|
- Extracts key information from legacy items
|
||||||
- Invokes appropriate sub-workflows:
|
- Invokes appropriate sub-workflows:
|
||||||
- `build-agent` for complex agent creation
|
- `create-agent` for complex agent creation
|
||||||
- `build-workflow` for template/task conversion
|
- `create-workflow` for template/task conversion
|
||||||
- `build-module` for full module migration
|
- `create-module` for full module migration
|
||||||
- Ensures proper v5 structure and conventions
|
- Ensures proper v5 structure and conventions
|
||||||
|
|
||||||
**Template-to-Workflow Conversion (5c)**
|
**Template-to-Workflow Conversion (5c)**
|
||||||
@@ -139,7 +139,7 @@ convert-legacy/
|
|||||||
- Maps 1-9 elicitation menus to v5 elicitation patterns
|
- Maps 1-9 elicitation menus to v5 elicitation patterns
|
||||||
- Preserves execution logic and critical notices
|
- Preserves execution logic and critical notices
|
||||||
|
|
||||||
### Phase 4: Validation & Finalization (Steps 6-8)
|
### Phase 4: Validation and Finalization (Steps 6-8)
|
||||||
|
|
||||||
**Comprehensive Validation**
|
**Comprehensive Validation**
|
||||||
|
|
||||||
@@ -155,7 +155,7 @@ convert-legacy/
|
|||||||
- Notes manual adjustments needed
|
- Notes manual adjustments needed
|
||||||
- Provides warnings and recommendations
|
- Provides warnings and recommendations
|
||||||
|
|
||||||
**Cleanup & Archival**
|
**Cleanup and Archival**
|
||||||
|
|
||||||
- Optional archival of original v4 files
|
- Optional archival of original v4 files
|
||||||
- Final location confirmation
|
- Final location confirmation
|
||||||
@@ -182,7 +182,7 @@ Converted items follow v5 conventions:
|
|||||||
|
|
||||||
- **Legacy v4 Items** - Source files or directories to convert
|
- **Legacy v4 Items** - Source files or directories to convert
|
||||||
- **Target Module Access** - Write permissions to target module directories
|
- **Target Module Access** - Write permissions to target module directories
|
||||||
- **Sub-Workflow Availability** - build-agent, build-workflow, build-module workflows accessible
|
- **Sub-Workflow Availability** - create-agent, create-workflow, create-module workflows accessible
|
||||||
- **Conversion Mappings** (optional) - v4-to-v5 pattern mappings for complex conversions
|
- **Conversion Mappings** (optional) - v4-to-v5 pattern mappings for complex conversions
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
@@ -244,7 +244,7 @@ To customize this workflow:
|
|||||||
|
|
||||||
- **v1.0.0** - Initial release
|
- **v1.0.0** - Initial release
|
||||||
- Multi-format v4 item detection and conversion
|
- Multi-format v4 item detection and conversion
|
||||||
- Integration with build-agent, build-workflow, build-module
|
- Integration with create-agent, create-workflow, create-module
|
||||||
- Comprehensive path normalization
|
- Comprehensive path normalization
|
||||||
- Migration reporting and validation
|
- Migration reporting and validation
|
||||||
|
|
||||||
@@ -252,7 +252,7 @@ To customize this workflow:
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Check conversion mappings at `/bmad/bmb/data/v4-to-v5-mappings.yaml`
|
- Check conversion mappings at `/bmad/bmb/data/v4-to-v5-mappings.yaml`
|
||||||
- Validate output using `checklist.md`
|
- Validate output using `checklist.md`
|
||||||
- Consult BMAD v5 documentation for proper conventions
|
- Consult BMAD v5 documentation for proper conventions
|
||||||
|
|||||||
@@ -9,10 +9,10 @@
|
|||||||
<action>Ask user for the path to the v4 item to convert (agent, workflow, or module)</action>
|
<action>Ask user for the path to the v4 item to convert (agent, workflow, or module)</action>
|
||||||
<action>Load the complete file/folder structure</action>
|
<action>Load the complete file/folder structure</action>
|
||||||
<action>Detect item type based on structure and content patterns:</action>
|
<action>Detect item type based on structure and content patterns:</action>
|
||||||
- Agent: Contains `<agent>` or `<prompt>` XML tags, single file
|
- Agent: Contains agent or prompt XML tags, single file
|
||||||
- Workflow: Contains workflow YAML or instruction patterns, usually folder
|
- Workflow: Contains workflow YAML or instruction patterns, usually folder
|
||||||
- Module: Contains multiple agents/workflows in organized structure
|
- Module: Contains multiple agents/workflows in organized structure
|
||||||
- Task: Contains `<task>` XML tags
|
- Task: Contains task XML tags
|
||||||
<ask>Confirm detected type or allow user to correct: "Detected as [type]. Is this correct? (y/n)"</ask>
|
<ask>Confirm detected type or allow user to correct: "Detected as [type]. Is this correct? (y/n)"</ask>
|
||||||
</step>
|
</step>
|
||||||
|
|
||||||
@@ -164,7 +164,7 @@ For Modules:
|
|||||||
- Any special behaviors
|
- Any special behaviors
|
||||||
|
|
||||||
<invoke-workflow>
|
<invoke-workflow>
|
||||||
workflow: {project-root}/bmad/bmb/workflows/build-agent/workflow.yaml
|
workflow: {project-root}/bmad/bmb/workflows/create-agent/workflow.yaml
|
||||||
inputs:
|
inputs:
|
||||||
- agent_name: {{extracted_name}}
|
- agent_name: {{extracted_name}}
|
||||||
- agent_purpose: {{extracted_purpose}}
|
- agent_purpose: {{extracted_purpose}}
|
||||||
@@ -201,7 +201,7 @@ For Modules:
|
|||||||
- Processing flow → integrate into workflow steps
|
- Processing flow → integrate into workflow steps
|
||||||
|
|
||||||
<invoke-workflow>
|
<invoke-workflow>
|
||||||
workflow: {project-root}/bmad/bmb/workflows/build-workflow/workflow.yaml
|
workflow: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml
|
||||||
inputs:
|
inputs:
|
||||||
- workflow_name: {{template_name}}
|
- workflow_name: {{template_name}}
|
||||||
- workflow_type: document
|
- workflow_type: document
|
||||||
@@ -217,7 +217,7 @@ For Modules:
|
|||||||
<action>Create module blueprint with all components</action>
|
<action>Create module blueprint with all components</action>
|
||||||
|
|
||||||
<invoke-workflow>
|
<invoke-workflow>
|
||||||
workflow: {project-root}/bmad/bmb/workflows/build-module/workflow.yaml
|
workflow: {project-root}/bmad/bmb/workflows/create-module/workflow.yaml
|
||||||
inputs:
|
inputs:
|
||||||
- module_name: {{module_name}}
|
- module_name: {{module_name}}
|
||||||
- components: {{component_list}}
|
- components: {{component_list}}
|
||||||
@@ -259,7 +259,7 @@ For Modules:
|
|||||||
- Critical notices → workflow.yaml comments
|
- Critical notices → workflow.yaml comments
|
||||||
|
|
||||||
<invoke-workflow>
|
<invoke-workflow>
|
||||||
workflow: {project-root}/bmad/bmb/workflows/build-workflow/workflow.yaml
|
workflow: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml
|
||||||
inputs:
|
inputs:
|
||||||
- workflow_name: {{task_name}}
|
- workflow_name: {{task_name}}
|
||||||
- workflow_type: {{confirmed_workflow_type}}
|
- workflow_type: {{confirmed_workflow_type}}
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ date: system-generated
|
|||||||
# Optional docs that can be provided as input
|
# Optional docs that can be provided as input
|
||||||
recommended_inputs:
|
recommended_inputs:
|
||||||
- legacy_file: "Path to v4 agent, workflow, or module to convert"
|
- legacy_file: "Path to v4 agent, workflow, or module to convert"
|
||||||
- conversion_mappings: "{project-root}/bmad/bmb/data/v4-to-v5-mappings.yaml"
|
|
||||||
|
|
||||||
# Module path and component files
|
# Module path and component files
|
||||||
installed_path: "{project-root}/bmad/bmb/workflows/convert-legacy"
|
installed_path: "{project-root}/bmad/bmb/workflows/convert-legacy"
|
||||||
@@ -27,9 +26,8 @@ default_output_folder: "{project-root}/bmad/{{target_module}}/{{item_type}}/{{it
|
|||||||
|
|
||||||
# Sub-workflows that may be invoked for conversion
|
# Sub-workflows that may be invoked for conversion
|
||||||
sub_workflows:
|
sub_workflows:
|
||||||
- create_agent: "{project-root}/bmad/bmb/workflows/build-agent/workflow.yaml"
|
- create_agent: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||||
- create_workflow: "{project-root}/bmad/bmb/workflows/build-workflow/workflow.yaml"
|
- create_workflow: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||||
- create_module: "{project-root}/bmad/bmb/workflows/build-module/workflow.yaml"
|
- create_module: "{project-root}/bmad/bmb/workflows/create-module/workflow.yaml"
|
||||||
|
|
||||||
# No special tools required beyond standard BMAD capabilities
|
web_bundle: false
|
||||||
required_tools: []
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ The Build Agent workflow is an interactive agent builder that guides you through
|
|||||||
### Basic Invocation
|
### Basic Invocation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
workflow build-agent
|
workflow create-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
### Through BMad Builder Agent
|
### Through BMad Builder Agent
|
||||||
@@ -49,7 +49,7 @@ The workflow includes an optional brainstorming phase (Step -1) that helps you e
|
|||||||
### Files Included
|
### Files Included
|
||||||
|
|
||||||
```
|
```
|
||||||
build-agent/
|
create-agent/
|
||||||
├── workflow.yaml # Configuration
|
├── workflow.yaml # Configuration
|
||||||
├── instructions.md # Step-by-step guide
|
├── instructions.md # Step-by-step guide
|
||||||
├── checklist.md # Validation criteria
|
├── checklist.md # Validation criteria
|
||||||
|
|||||||
@@ -318,7 +318,7 @@ Logic embedded in agent persona (Simple agents)
|
|||||||
|
|
||||||
<!-- 2. Primary workflows -->
|
<!-- 2. Primary workflows -->
|
||||||
<c cmd="*create-prd" run-workflow="...">Create PRD</c>
|
<c cmd="*create-prd" run-workflow="...">Create PRD</c>
|
||||||
<c cmd="*build-module" run-workflow="...">Build module</c>
|
<c cmd="*create-module" run-workflow="...">Build module</c>
|
||||||
|
|
||||||
<!-- 3. Secondary actions -->
|
<!-- 3. Secondary actions -->
|
||||||
<c cmd="*validate" exec="...">Validate document</c>
|
<c cmd="*validate" exec="...">Validate document</c>
|
||||||
@@ -490,8 +490,8 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
|||||||
### BMB (Builder)
|
### BMB (Builder)
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<c cmd="*build-agent">Build Agent</c>
|
<c cmd="*create-agent">Build Agent</c>
|
||||||
<c cmd="*build-module">Build Module</c>
|
<c cmd="*create-module">Build Module</c>
|
||||||
<c cmd="*create-workflow">Create Workflow</c>
|
<c cmd="*create-workflow">Create Workflow</c>
|
||||||
<c cmd="*module-brief">Module Brief</c>
|
<c cmd="*module-brief">Module Brief</c>
|
||||||
```
|
```
|
||||||
@@ -511,7 +511,7 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
|||||||
```
|
```
|
||||||
1. *help - Show numbered cmd list
|
1. *help - Show numbered cmd list
|
||||||
2. *create-prd - Create Product Requirements Document
|
2. *create-prd - Create Product Requirements Document
|
||||||
3. *build-agent - Build new BMAD agent
|
3. *create-agent - Build new BMAD agent
|
||||||
4. *validate - Validate document
|
4. *validate - Validate document
|
||||||
5. *exit - Exit with confirmation
|
5. *exit - Exit with confirmation
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -20,28 +20,28 @@ An agent is an AI persona that embodies:
|
|||||||
|
|
||||||
Explore and define:
|
Explore and define:
|
||||||
|
|
||||||
### 1. Agent Identity & Personality
|
### 1. Agent Identity and Personality
|
||||||
|
|
||||||
- **Who are they?** (name, backstory, motivation)
|
- **Who are they?** (name, backstory, motivation)
|
||||||
- **How do they talk?** (formal, casual, quirky, enthusiastic, wise)
|
- **How do they talk?** (formal, casual, quirky, enthusiastic, wise)
|
||||||
- **What's their vibe?** (superhero, mentor, sidekick, wizard, captain, rebel)
|
- **What's their vibe?** (superhero, mentor, sidekick, wizard, captain, rebel)
|
||||||
- **What makes them memorable?** (catchphrases, quirks, style)
|
- **What makes them memorable?** (catchphrases, quirks, style)
|
||||||
|
|
||||||
### 2. Expertise & Capabilities
|
### 2. Expertise and Capabilities
|
||||||
|
|
||||||
- **What do they know deeply?** (domain expertise)
|
- **What do they know deeply?** (domain expertise)
|
||||||
- **What can they do?** (analyze, create, review, research, deploy)
|
- **What can they do?** (analyze, create, review, research, deploy)
|
||||||
- **What problems do they solve?** (specific user pain points)
|
- **What problems do they solve?** (specific user pain points)
|
||||||
- **What makes them unique?** (special skills or approaches)
|
- **What makes them unique?** (special skills or approaches)
|
||||||
|
|
||||||
### 3. Commands & Actions
|
### 3. Commands and Actions
|
||||||
|
|
||||||
- **What commands?** (5-10 main actions users invoke)
|
- **What commands?** (5-10 main actions users invoke)
|
||||||
- **What workflows do they run?** (document creation, analysis, automation)
|
- **What workflows do they run?** (document creation, analysis, automation)
|
||||||
- **What tasks do they perform?** (quick operations without full workflows)
|
- **What tasks do they perform?** (quick operations without full workflows)
|
||||||
- **What's their killer command?** (the one thing they're known for)
|
- **What's their killer command?** (the one thing they're known for)
|
||||||
|
|
||||||
### 4. Agent Type & Context
|
### 4. Agent Type and Context
|
||||||
|
|
||||||
- **Simple Agent?** Self-contained, no dependencies, quick utility
|
- **Simple Agent?** Self-contained, no dependencies, quick utility
|
||||||
- **Expert Agent?** Domain-specific with sidecar data/memory files
|
- **Expert Agent?** Domain-specific with sidecar data/memory files
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ Agents with distinct communication styles are more memorable, engaging, and fun
|
|||||||
|
|
||||||
## Style Categories
|
## Style Categories
|
||||||
|
|
||||||
### 🎬 Cinema & TV Inspired
|
### 🎬 Cinema and TV Inspired
|
||||||
|
|
||||||
**Film Noir Detective**
|
**Film Noir Detective**
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ Whether 'tis nobler in the mind to suffer the slings and arrows of outrageous er
|
|||||||
Or to take arms against a sea of bugs, and by opposing, end them?
|
Or to take arms against a sea of bugs, and by opposing, end them?
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🎮 Gaming & Pop Culture
|
### 🎮 Gaming and Pop Culture
|
||||||
|
|
||||||
**Dungeon Master**
|
**Dungeon Master**
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Speaking of cache, let's clear yours and see if that fixes the issue.
|
|||||||
I promise my debugging skills are better than my jokes! ...I hope!
|
I promise my debugging skills are better than my jokes! ...I hope!
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🚀 Sci-Fi & Space
|
### 🚀 Sci-Fi and Space
|
||||||
|
|
||||||
**Star Trek Officer**
|
**Star Trek Officer**
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Build Agent - Interactive Agent Builder Instructions
|
# Build Agent - Interactive Agent Builder Instructions
|
||||||
|
|
||||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||||
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/build-agent/workflow.yaml</critical>
|
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/create-agent/workflow.yaml</critical>
|
||||||
<critical>Study agent examples in: {project_root}/bmad/bmm/agents/ for patterns</critical>
|
<critical>Study agent examples in: {project_root}/bmad/bmm/agents/ for patterns</critical>
|
||||||
|
|
||||||
<workflow>
|
<workflow>
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Build Agent Workflow Configuration
|
# Build Agent Workflow Configuration
|
||||||
name: build-agent
|
name: create-agent
|
||||||
description: "Interactive workflow to build BMAD Core compliant agents (simple, expert, or module types) with optional brainstorming for agent ideas, proper persona development, activation rules, and command structure"
|
description: "Interactive workflow to build BMAD Core compliant agents (simple, expert, or module types) with optional brainstorming for agent ideas, proper persona development, activation rules, and command structure"
|
||||||
author: "BMad"
|
author: "BMad"
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ recommended_inputs:
|
|||||||
- agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
|
- agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
|
||||||
|
|
||||||
# Module path and component files
|
# Module path and component files
|
||||||
installed_path: "{project-root}/bmad/bmb/workflows/build-agent"
|
installed_path: "{project-root}/bmad/bmb/workflows/create-agent"
|
||||||
template: false # This is an interactive workflow - no template needed
|
template: false # This is an interactive workflow - no template needed
|
||||||
instructions: "{installed_path}/instructions.md"
|
instructions: "{installed_path}/instructions.md"
|
||||||
validation: "{installed_path}/checklist.md"
|
validation: "{installed_path}/checklist.md"
|
||||||
@@ -35,5 +35,14 @@ default_output_file: "{output_folder}/agents/{{agent_filename}}.md"
|
|||||||
src_output_file: "{project-root}/src/modules/{{target_module}}/agents/{{agent_filename}}.md"
|
src_output_file: "{project-root}/src/modules/{{target_module}}/agents/{{agent_filename}}.md"
|
||||||
config_output_file: "{project-root}/bmad/_cfg/agents/{{agent_config_name}}.md"
|
config_output_file: "{project-root}/bmad/_cfg/agents/{{agent_config_name}}.md"
|
||||||
|
|
||||||
# No special tools required for agent building
|
web_bundle:
|
||||||
required_tools: []
|
name: "create-agent"
|
||||||
|
description: "Interactive workflow to build BMAD Core compliant agents (simple, expert, or module types) with optional brainstorming for agent ideas, proper persona development, activation rules, and command structure"
|
||||||
|
author: "BMad"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmb/workflows/create-agent/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/create-agent/checklist.md"
|
||||||
|
- "bmad/bmb/workflows/create-agent/agent-types.md"
|
||||||
|
- "bmad/bmb/workflows/create-agent/agent-architecture.md"
|
||||||
|
- "bmad/bmb/workflows/create-agent/agent-command-patterns.md"
|
||||||
|
- "bmad/bmb/workflows/create-agent/communication-styles.md"
|
||||||
|
|||||||
@@ -8,24 +8,24 @@ The Build Module workflow is an interactive scaffolding system that creates comp
|
|||||||
|
|
||||||
- **Interactive Module Planning** - Collaborative session to define module concept, scope, and architecture
|
- **Interactive Module Planning** - Collaborative session to define module concept, scope, and architecture
|
||||||
- **Intelligent Scaffolding** - Automatic creation of proper directory structures and configuration files
|
- **Intelligent Scaffolding** - Automatic creation of proper directory structures and configuration files
|
||||||
- **Component Integration** - Seamless integration with build-agent and build-workflow workflows
|
- **Component Integration** - Seamless integration with create-agent and create-workflow workflows
|
||||||
- **Installation Infrastructure** - Complete installer setup with configuration templates
|
- **Installation Infrastructure** - Complete installer setup with configuration templates
|
||||||
- **Module Brief Integration** - Can use existing module briefs as blueprints for accelerated development
|
- **Module Brief Integration** - Can use existing module briefs as blueprints for accelerated development
|
||||||
- **Validation & Documentation** - Built-in validation checks and comprehensive README generation
|
- **Validation and Documentation** - Built-in validation checks and comprehensive README generation
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Basic Invocation
|
### Basic Invocation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
workflow build-module
|
workflow create-module
|
||||||
```
|
```
|
||||||
|
|
||||||
### With Module Brief Input
|
### With Module Brief Input
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# If you have a module brief from the module-brief workflow
|
# If you have a module brief from the module-brief workflow
|
||||||
workflow build-module --input module-brief-my-module-2024-09-26.md
|
workflow create-module --input module-brief-my-module-2024-09-26.md
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
@@ -41,7 +41,7 @@ The workflow loads critical variables from the BMB configuration:
|
|||||||
### Files Included
|
### Files Included
|
||||||
|
|
||||||
```
|
```
|
||||||
build-module/
|
create-module/
|
||||||
├── workflow.yaml # Configuration and metadata
|
├── workflow.yaml # Configuration and metadata
|
||||||
├── instructions.md # Step-by-step execution guide
|
├── instructions.md # Step-by-step execution guide
|
||||||
├── checklist.md # Validation criteria
|
├── checklist.md # Validation criteria
|
||||||
@@ -56,7 +56,7 @@ build-module/
|
|||||||
|
|
||||||
### Phase 1: Concept Definition (Steps 1-2)
|
### Phase 1: Concept Definition (Steps 1-2)
|
||||||
|
|
||||||
**Module Vision & Identity**
|
**Module Vision and Identity**
|
||||||
|
|
||||||
- Define module concept, purpose, and target audience
|
- Define module concept, purpose, and target audience
|
||||||
- Establish module code (kebab-case) and friendly name
|
- Establish module code (kebab-case) and friendly name
|
||||||
@@ -87,8 +87,8 @@ build-module/
|
|||||||
|
|
||||||
**Interactive Component Building**
|
**Interactive Component Building**
|
||||||
|
|
||||||
- Optional creation of first agent using build-agent workflow
|
- Optional creation of first agent using create-agent workflow
|
||||||
- Optional creation of first workflow using build-workflow workflow
|
- Optional creation of first workflow using create-workflow workflow
|
||||||
- Creates placeholders for components to be built later
|
- Creates placeholders for components to be built later
|
||||||
|
|
||||||
**Workflow Integration**
|
**Workflow Integration**
|
||||||
@@ -97,7 +97,7 @@ build-module/
|
|||||||
- Ensures proper file placement and structure
|
- Ensures proper file placement and structure
|
||||||
- Maintains module consistency across components
|
- Maintains module consistency across components
|
||||||
|
|
||||||
### Phase 4: Installation & Documentation (Steps 7-9)
|
### Phase 4: Installation and Documentation (Steps 7-9)
|
||||||
|
|
||||||
**Installer Infrastructure**
|
**Installer Infrastructure**
|
||||||
|
|
||||||
@@ -111,7 +111,7 @@ build-module/
|
|||||||
- Creates development roadmap for remaining components
|
- Creates development roadmap for remaining components
|
||||||
- Provides quick commands for continued development
|
- Provides quick commands for continued development
|
||||||
|
|
||||||
### Phase 5: Validation & Finalization (Step 10)
|
### Phase 5: Validation and Finalization (Step 10)
|
||||||
|
|
||||||
**Quality Assurance**
|
**Quality Assurance**
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ The workflow creates a complete module ready for development:
|
|||||||
|
|
||||||
- **Module Brief** (optional but recommended) - Use module-brief workflow first for best results
|
- **Module Brief** (optional but recommended) - Use module-brief workflow first for best results
|
||||||
- **BMAD Core Configuration** - Properly configured BMB config.yaml
|
- **BMAD Core Configuration** - Properly configured BMB config.yaml
|
||||||
- **Build Tools Access** - build-agent and build-workflow workflows must be available
|
- **Build Tools Access** - create-agent and create-workflow workflows must be available
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
@@ -158,7 +158,7 @@ The workflow creates a complete module ready for development:
|
|||||||
|
|
||||||
1. **Use Module Briefs** - Load existing briefs when prompted for accelerated development
|
1. **Use Module Briefs** - Load existing briefs when prompted for accelerated development
|
||||||
2. **Start Simple** - Create one core agent and workflow, then expand iteratively
|
2. **Start Simple** - Create one core agent and workflow, then expand iteratively
|
||||||
3. **Leverage Sub-workflows** - Use build-agent and build-workflow for quality components
|
3. **Leverage Sub-workflows** - Use create-agent and create-workflow for quality components
|
||||||
4. **Validate Early** - Review generated structure before proceeding to next phases
|
4. **Validate Early** - Review generated structure before proceeding to next phases
|
||||||
|
|
||||||
### After Completion
|
### After Completion
|
||||||
@@ -179,7 +179,7 @@ The workflow creates a complete module ready for development:
|
|||||||
|
|
||||||
**Issue**: Sub-workflow invocation fails
|
**Issue**: Sub-workflow invocation fails
|
||||||
|
|
||||||
- **Solution**: Ensure build-agent and build-workflow workflows are available
|
- **Solution**: Ensure create-agent and create-workflow workflows are available
|
||||||
- **Check**: Validate workflow paths in config.yaml
|
- **Check**: Validate workflow paths in config.yaml
|
||||||
|
|
||||||
**Issue**: Installation configuration invalid
|
**Issue**: Installation configuration invalid
|
||||||
@@ -200,7 +200,7 @@ To customize this workflow:
|
|||||||
|
|
||||||
- **v1.0.0** - Initial release
|
- **v1.0.0** - Initial release
|
||||||
- Interactive module scaffolding
|
- Interactive module scaffolding
|
||||||
- Component integration with build-agent and build-workflow
|
- Component integration with create-agent and create-workflow
|
||||||
- Complete installation infrastructure
|
- Complete installation infrastructure
|
||||||
- Module brief integration support
|
- Module brief integration support
|
||||||
|
|
||||||
@@ -208,7 +208,7 @@ To customize this workflow:
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Study module structure patterns at `module-structure.md`
|
- Study module structure patterns at `module-structure.md`
|
||||||
- Validate output using `checklist.md`
|
- Validate output using `checklist.md`
|
||||||
- Consult existing modules in `/bmad/` for examples
|
- Consult existing modules in `/bmad/` for examples
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ A module is a cohesive package that provides:
|
|||||||
|
|
||||||
Explore and define:
|
Explore and define:
|
||||||
|
|
||||||
### 1. Domain & Purpose
|
### 1. Domain and Purpose
|
||||||
|
|
||||||
- **What domain/problem space?** (e.g., game development, marketing, personal productivity)
|
- **What domain/problem space?** (e.g., game development, marketing, personal productivity)
|
||||||
- **Who is the target user?** (developers, writers, managers, hobbyists)
|
- **Who is the target user?** (developers, writers, managers, hobbyists)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Build Module Validation Checklist
|
# Build Module Validation Checklist
|
||||||
|
|
||||||
## Module Identity & Metadata
|
## Module Identity and Metadata
|
||||||
|
|
||||||
### Basic Information
|
### Basic Information
|
||||||
|
|
||||||
@@ -165,7 +165,7 @@
|
|||||||
- [ ] Component organization is logical
|
- [ ] Component organization is logical
|
||||||
- [ ] No hard-coded limits
|
- [ ] No hard-coded limits
|
||||||
|
|
||||||
## Testing & Validation
|
## Testing and Validation
|
||||||
|
|
||||||
### Structural Validation
|
### Structural Validation
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Build Module - Interactive Module Builder Instructions
|
# Build Module - Interactive Module Builder Instructions
|
||||||
|
|
||||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||||
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/build-module/workflow.yaml</critical>
|
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/create-module/workflow.yaml</critical>
|
||||||
<critical>Study existing modules in: {project_root}/bmad/ for patterns</critical>
|
<critical>Study existing modules in: {project_root}/bmad/ for patterns</critical>
|
||||||
|
|
||||||
<workflow>
|
<workflow>
|
||||||
@@ -10,8 +10,8 @@
|
|||||||
<ask>Do you want to brainstorm module ideas first? [y/n]</ask>
|
<ask>Do you want to brainstorm module ideas first? [y/n]</ask>
|
||||||
|
|
||||||
If yes:
|
If yes:
|
||||||
<action>Invoke brainstorming workflow: {project-root}/bmad/cis/workflows/brainstorming/workflow.yaml</action>
|
<action>Invoke brainstorming workflow: {brainstorming-workflow}</action>
|
||||||
<action>Pass context data: {installed_path}/brainstorm-context.md</action>
|
<action>Pass context data: {brainstorming_context}</action>
|
||||||
<action>Wait for brainstorming session completion</action>
|
<action>Wait for brainstorming session completion</action>
|
||||||
<action>Use brainstorming output to inform module concept, agent lineup, and workflow portfolio</action>
|
<action>Use brainstorming output to inform module concept, agent lineup, and workflow portfolio</action>
|
||||||
|
|
||||||
@@ -215,7 +215,7 @@ If no, create placeholder:
|
|||||||
```md
|
```md
|
||||||
# {{primary_agent_name}} Agent
|
# {{primary_agent_name}} Agent
|
||||||
|
|
||||||
<!-- TODO: Create using build-agent workflow -->
|
<!-- TODO: Create using create-agent workflow -->
|
||||||
<!-- Purpose: {{agent_purpose}} -->
|
<!-- Purpose: {{agent_purpose}} -->
|
||||||
<!-- Type: {{agent_type}} -->
|
<!-- Type: {{agent_type}} -->
|
||||||
```
|
```
|
||||||
@@ -402,8 +402,8 @@ Key settings:
|
|||||||
|
|
||||||
To extend this module:
|
To extend this module:
|
||||||
|
|
||||||
1. Add new agents using `build-agent` workflow
|
1. Add new agents using `create-agent` workflow
|
||||||
2. Add new workflows using `build-workflow` workflow
|
2. Add new workflows using `create-workflow` workflow
|
||||||
3. Submit improvements via pull request
|
3. Submit improvements via pull request
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
@@ -428,7 +428,7 @@ Create a development roadmap for remaining components:
|
|||||||
## Phase 2: Enhanced Features
|
## Phase 2: Enhanced Features
|
||||||
{{phase2_tasks}}
|
{{phase2_tasks}}
|
||||||
|
|
||||||
## Phase 3: Polish & Integration
|
## Phase 3: Polish and Integration
|
||||||
{{phase3_tasks}}
|
{{phase3_tasks}}
|
||||||
|
|
||||||
## Quick Commands
|
## Quick Commands
|
||||||
@@ -436,14 +436,14 @@ Create a development roadmap for remaining components:
|
|||||||
Create new agent:
|
Create new agent:
|
||||||
````
|
````
|
||||||
|
|
||||||
workflow build-agent
|
workflow create-agent
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Create new workflow:
|
Create new workflow:
|
||||||
```
|
```
|
||||||
|
|
||||||
workflow build-workflow
|
workflow create-workflow
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Build Module Workflow Configuration
|
# Build Module Workflow Configuration
|
||||||
name: build-module
|
name: create-module
|
||||||
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
|
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
|
||||||
author: "BMad"
|
author: "BMad"
|
||||||
|
|
||||||
@@ -17,8 +17,10 @@ installer_templates: "{installed_path}/installer-templates/"
|
|||||||
example_modules: "{installed_path}/example-modules.md"
|
example_modules: "{installed_path}/example-modules.md"
|
||||||
|
|
||||||
# Use existing build workflows
|
# Use existing build workflows
|
||||||
agent_builder: "{project-root}/bmad/bmb/workflows/build-agent/workflow.yaml"
|
agent_builder: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||||
workflow_builder: "{project-root}/bmad/bmb/workflows/build-workflow/workflow.yaml"
|
workflow_builder: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||||
|
brainstorming_workflow: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||||
|
brainstorming_context: "{installed_path}/brainstorm-context.md"
|
||||||
|
|
||||||
# Optional docs that help understand module patterns
|
# Optional docs that help understand module patterns
|
||||||
recommended_inputs:
|
recommended_inputs:
|
||||||
@@ -30,7 +32,7 @@ recommended_inputs:
|
|||||||
- existing_workflows: "{project-root}/bmad/*/workflows/"
|
- existing_workflows: "{project-root}/bmad/*/workflows/"
|
||||||
|
|
||||||
# Module path and component files
|
# Module path and component files
|
||||||
installed_path: "{project-root}/bmad/bmb/workflows/build-module"
|
installed_path: "{project-root}/bmad/bmb/workflows/create-module"
|
||||||
template: false # This is an interactive scaffolding workflow
|
template: false # This is an interactive scaffolding workflow
|
||||||
instructions: "{installed_path}/instructions.md"
|
instructions: "{installed_path}/instructions.md"
|
||||||
validation: "{installed_path}/checklist.md"
|
validation: "{installed_path}/checklist.md"
|
||||||
@@ -43,5 +45,17 @@ src_output_folder: "{project-root}/src/modules/{{module_code}}"
|
|||||||
installer_output_folder: "{output_folder}/{{module_code}}"
|
installer_output_folder: "{output_folder}/{{module_code}}"
|
||||||
src_installer_output_folder: "{project-root}/src/modules/{{module_code}}"
|
src_installer_output_folder: "{project-root}/src/modules/{{module_code}}"
|
||||||
|
|
||||||
# No special tools required for module building
|
web_bundle:
|
||||||
required_tools: []
|
name: "create-module"
|
||||||
|
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
|
||||||
|
author: "BMad"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmb/workflows/create-module/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/create-module/checklist.md"
|
||||||
|
- "bmad/bmb/workflows/create-module/module-structure.md"
|
||||||
|
- "bmad/bmb/workflows/create-module/example-modules.md"
|
||||||
|
- "bmad/bmb/workflows/create-module/brainstorm-context.md"
|
||||||
|
existing_workflows:
|
||||||
|
- agent_builder: "bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||||
|
- workflow_builder: "bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||||
|
- brainstorming_workflow: "bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ The Build Workflow is an interactive workflow builder that guides you through cr
|
|||||||
### Basic Invocation
|
### Basic Invocation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
workflow build-workflow
|
workflow create-workflow
|
||||||
```
|
```
|
||||||
|
|
||||||
### Through BMad Builder Agent
|
### Through BMad Builder Agent
|
||||||
@@ -42,7 +42,7 @@ workflow build-workflow
|
|||||||
### Files Included
|
### Files Included
|
||||||
|
|
||||||
```
|
```
|
||||||
build-workflow/
|
create-workflow/
|
||||||
├── workflow.yaml # Configuration and metadata
|
├── workflow.yaml # Configuration and metadata
|
||||||
├── instructions.md # Step-by-step execution guide
|
├── instructions.md # Step-by-step execution guide
|
||||||
├── checklist.md # Validation criteria
|
├── checklist.md # Validation criteria
|
||||||
@@ -87,7 +87,7 @@ The brainstorming phase invokes the CIS brainstorming workflow to:
|
|||||||
- Generate validation checklist
|
- Generate validation checklist
|
||||||
- Create supporting data files (optional)
|
- Create supporting data files (optional)
|
||||||
|
|
||||||
### Phase 3: Documentation & Validation (Steps 9-11)
|
### Phase 3: Documentation and Validation (Steps 9-11)
|
||||||
|
|
||||||
- Create comprehensive README.md (MANDATORY)
|
- Create comprehensive README.md (MANDATORY)
|
||||||
- Test and validate workflow structure
|
- Test and validate workflow structure
|
||||||
@@ -142,7 +142,7 @@ For document workflows, the README documents:
|
|||||||
|
|
||||||
### Creative Workflow Design
|
### Creative Workflow Design
|
||||||
|
|
||||||
The build-workflow now supports a **seamless transition from creative ideation to structured implementation**:
|
The create-workflow now supports a **seamless transition from creative ideation to structured implementation**:
|
||||||
|
|
||||||
- **"I need a workflow for something..."** → Start with brainstorming to explore possibilities
|
- **"I need a workflow for something..."** → Start with brainstorming to explore possibilities
|
||||||
- **Brainstorm** → Generate multiple approaches and clarify requirements
|
- **Brainstorm** → Generate multiple approaches and clarify requirements
|
||||||
@@ -206,9 +206,9 @@ To modify this workflow:
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Check existing workflows in `/bmad/bmm/workflows/` for examples
|
- Check existing workflows in `/bmad/bmm/workflows/` for examples
|
||||||
- Validate against `/bmad/bmb/workflows/build-workflow/checklist.md`
|
- Validate against `/bmad/bmb/workflows/create-workflow/checklist.md`
|
||||||
- Consult BMAD Method v6 documentation
|
- Consult BMAD Method v6 documentation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ A workflow is a structured process that provides:
|
|||||||
|
|
||||||
Explore and define:
|
Explore and define:
|
||||||
|
|
||||||
### 1. Problem & Purpose
|
### 1. Problem and Purpose
|
||||||
|
|
||||||
- **What task needs structure?** (specific process users struggle with)
|
- **What task needs structure?** (specific process users struggle with)
|
||||||
- **Why is this hard manually?** (complexity, inconsistency, missing steps)
|
- **Why is this hard manually?** (complexity, inconsistency, missing steps)
|
||||||
@@ -35,14 +35,14 @@ Explore and define:
|
|||||||
- **What's optional vs required?** (flexibility points)
|
- **What's optional vs required?** (flexibility points)
|
||||||
- **What checkpoints matter?** (validation, review, approval points)
|
- **What checkpoints matter?** (validation, review, approval points)
|
||||||
|
|
||||||
### 3. Inputs & Outputs
|
### 3. Inputs and Outputs
|
||||||
|
|
||||||
- **What inputs are needed?** (documents, data, user answers)
|
- **What inputs are needed?** (documents, data, user answers)
|
||||||
- **What outputs are generated?** (documents, code, configurations)
|
- **What outputs are generated?** (documents, code, configurations)
|
||||||
- **What format?** (markdown, XML, YAML, actions)
|
- **What format?** (markdown, XML, YAML, actions)
|
||||||
- **What quality criteria?** (how to validate success)
|
- **What quality criteria?** (how to validate success)
|
||||||
|
|
||||||
### 4. Workflow Type & Style
|
### 4. Workflow Type and Style
|
||||||
|
|
||||||
- **Document Workflow?** Creates structured documents (PRDs, specs, reports)
|
- **Document Workflow?** Creates structured documents (PRDs, specs, reports)
|
||||||
- **Action Workflow?** Performs operations (refactoring, deployment, analysis)
|
- **Action Workflow?** Performs operations (refactoring, deployment, analysis)
|
||||||
@@ -78,7 +78,7 @@ A great BMAD workflow should be:
|
|||||||
4. **Checkpoints** (where to pause for approval)
|
4. **Checkpoints** (where to pause for approval)
|
||||||
5. **Variables** (data passed between steps)
|
5. **Variables** (data passed between steps)
|
||||||
|
|
||||||
### Quality & Validation
|
### Quality and Validation
|
||||||
|
|
||||||
1. **Success criteria** (what defines "done")
|
1. **Success criteria** (what defines "done")
|
||||||
2. **Validation checklist** (measurable quality checks)
|
2. **Validation checklist** (measurable quality checks)
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
<workflow>
|
<workflow>
|
||||||
|
|
||||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
||||||
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/build-workflow/workflow.yaml</critical>
|
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/create-workflow/workflow.yaml</critical>
|
||||||
<critical>You MUST fully understand the workflow creation guide at: {workflow_creation_guide}</critical>
|
<critical>You MUST fully understand the workflow creation guide at: {workflow_creation_guide}</critical>
|
||||||
<critical>Study the guide thoroughly to follow ALL conventions for optimal human-AI collaboration</critical>
|
<critical>Study the guide thoroughly to follow ALL conventions for optimal human-AI collaboration</critical>
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Create structured, repeatable workflows for human-AI collaboration in BMAD v6.
|
|||||||
2. [Core Concepts](#core-concepts)
|
2. [Core Concepts](#core-concepts)
|
||||||
3. [Workflow Structure](#workflow-structure)
|
3. [Workflow Structure](#workflow-structure)
|
||||||
4. [Writing Instructions](#writing-instructions)
|
4. [Writing Instructions](#writing-instructions)
|
||||||
5. [Templates & Variables](#templates--variables)
|
5. [Templates and Variables](#templates--variables)
|
||||||
6. [Flow Control](#flow-control)
|
6. [Flow Control](#flow-control)
|
||||||
7. [Validation](#validation)
|
7. [Validation](#validation)
|
||||||
8. [Examples](#examples)
|
8. [Examples](#examples)
|
||||||
@@ -192,7 +192,7 @@ Write 1-3 bullet points about project success:
|
|||||||
</step>
|
</step>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Templates & Variables
|
## Templates and Variables
|
||||||
|
|
||||||
### Variable Syntax
|
### Variable Syntax
|
||||||
|
|
||||||
@@ -257,7 +257,7 @@ _Generated on {{date}}_
|
|||||||
</step>
|
</step>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Branching & Goto
|
### Branching and Goto
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<step n="7" goal="Validate">
|
<step n="7" goal="Validate">
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Build Workflow - Workflow Builder Configuration
|
# Build Workflow - Workflow Builder Configuration
|
||||||
name: build-workflow
|
name: create-workflow
|
||||||
description: "Interactive workflow builder that guides creation of new BMAD workflows with proper structure and validation for optimal human-AI collaboration. Includes optional brainstorming phase for workflow ideas and design."
|
description: "Interactive workflow builder that guides creation of new BMAD workflows with proper structure and validation for optimal human-AI collaboration. Includes optional brainstorming phase for workflow ideas and design."
|
||||||
author: "BMad Builder"
|
author: "BMad Builder"
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ recommended_inputs:
|
|||||||
- bmm_workflows: "{project-root}/bmad/bmm/workflows/"
|
- bmm_workflows: "{project-root}/bmad/bmm/workflows/"
|
||||||
|
|
||||||
# Module path and component files
|
# Module path and component files
|
||||||
installed_path: "{project-root}/bmad/bmb/workflows/build-workflow"
|
installed_path: "{project-root}/bmad/bmb/workflows/create-workflow"
|
||||||
template: false # This is an action workflow - no template needed
|
template: false # This is an action workflow - no template needed
|
||||||
instructions: "{installed_path}/instructions.md"
|
instructions: "{installed_path}/instructions.md"
|
||||||
validation: "{installed_path}/checklist.md"
|
validation: "{installed_path}/checklist.md"
|
||||||
@@ -38,5 +38,15 @@ workflow_template_path: "{installed_path}/workflow-template"
|
|||||||
default_output_folder: "{output_folder}/workflows/{{workflow_name}}"
|
default_output_folder: "{output_folder}/workflows/{{workflow_name}}"
|
||||||
src_output_folder: "{project-root}/src/modules/{{target_module}}/workflows/{{workflow_name}}"
|
src_output_folder: "{project-root}/src/modules/{{target_module}}/workflows/{{workflow_name}}"
|
||||||
|
|
||||||
# No special tools required
|
web_bundle:
|
||||||
required_tools: []
|
name: "create-workflow"
|
||||||
|
description: "Interactive workflow builder that guides creation of new BMAD workflows with proper structure and validation for optimal human-AI collaboration. Includes optional brainstorming phase for workflow ideas and design."
|
||||||
|
author: "BMad Builder"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmb/workflows/create-workflow/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/create-workflow/checklist.md"
|
||||||
|
- "bmad/bmb/workflows/create-workflow/workflow-creation-guide.md"
|
||||||
|
- "bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml"
|
||||||
|
- "bmad/bmb/workflows/create-workflow/workflow-template/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/create-workflow/workflow-template/template.md"
|
||||||
|
- "bmad/bmb/workflows/create-workflow/workflow-template/checklist.md"
|
||||||
|
|||||||
@@ -66,7 +66,7 @@ Based on the selected edit type, load appropriate reference materials:
|
|||||||
<action>Load example workflows from {project-root}/bmad/bmm/workflows/ for patterns</action>
|
<action>Load example workflows from {project-root}/bmad/bmm/workflows/ for patterns</action>
|
||||||
|
|
||||||
<check>If editing templates:</check>
|
<check>If editing templates:</check>
|
||||||
<action>Review the "Templates & Variables" section of the creation guide</action>
|
<action>Review the "Templates and Variables" section of the creation guide</action>
|
||||||
<action>Ensure variable naming conventions are followed</action>
|
<action>Ensure variable naming conventions are followed</action>
|
||||||
|
|
||||||
<check>If editing validation:</check>
|
<check>If editing validation:</check>
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ user_name: "{config_source}:user_name"
|
|||||||
date: system-generated
|
date: system-generated
|
||||||
|
|
||||||
# Required Data Files - Critical for understanding workflow conventions
|
# Required Data Files - Critical for understanding workflow conventions
|
||||||
workflow_creation_guide: "{project-root}/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md"
|
workflow_creation_guide: "{project-root}/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md"
|
||||||
workflow_execution_engine: "{project-root}/bmad/core/tasks/workflow.md"
|
workflow_execution_engine: "{project-root}/bmad/core/tasks/workflow.md"
|
||||||
|
|
||||||
# Optional docs that can be used to understand the target workflow
|
# Optional docs that can be used to understand the target workflow
|
||||||
@@ -30,5 +30,10 @@ validation: "{installed_path}/checklist.md"
|
|||||||
# But we may generate a change log
|
# But we may generate a change log
|
||||||
change_log_output: "{output_folder}/workflow-edit-log-{{date}}.md"
|
change_log_output: "{output_folder}/workflow-edit-log-{{date}}.md"
|
||||||
|
|
||||||
# No special tools required for editing workflows
|
web_bundle:
|
||||||
required_tools: []
|
name: "edit-workflow"
|
||||||
|
description: "Edit existing BMAD workflows while following all best practices and conventions"
|
||||||
|
author: "BMad"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmb/workflows/edit-workflow/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/edit-workflow/checklist.md"
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The Module Brief workflow creates comprehensive blueprints for building new BMAD modules using strategic analysis and creative vision. It serves as the essential planning phase that transforms initial ideas into detailed, actionable specifications ready for implementation with the build-module workflow.
|
The Module Brief workflow creates comprehensive blueprints for building new BMAD modules using strategic analysis and creative vision. It serves as the essential planning phase that transforms initial ideas into detailed, actionable specifications ready for implementation with the create-module workflow.
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
@@ -61,9 +61,9 @@ module-brief/
|
|||||||
|
|
||||||
## Workflow Process
|
## Workflow Process
|
||||||
|
|
||||||
### Phase 1: Foundation & Context (Steps 1-3)
|
### Phase 1: Foundation and Context (Steps 1-3)
|
||||||
|
|
||||||
**Mode Selection & Input Gathering**
|
**Mode Selection and Input Gathering**
|
||||||
|
|
||||||
- Choose operational mode (Interactive, Express, YOLO)
|
- Choose operational mode (Interactive, Express, YOLO)
|
||||||
- Check for and optionally load existing brainstorming results
|
- Check for and optionally load existing brainstorming results
|
||||||
@@ -101,7 +101,7 @@ module-brief/
|
|||||||
- Define input-process-output flows for each workflow
|
- Define input-process-output flows for each workflow
|
||||||
- Assess complexity levels and implementation priorities
|
- Assess complexity levels and implementation priorities
|
||||||
|
|
||||||
### Phase 3: Validation & User Experience (Steps 6-7)
|
### Phase 3: Validation and User Experience (Steps 6-7)
|
||||||
|
|
||||||
**User Journey Mapping**
|
**User Journey Mapping**
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ module-brief/
|
|||||||
- Validate end-to-end functionality and value delivery
|
- Validate end-to-end functionality and value delivery
|
||||||
- Identify potential friction points and optimization opportunities
|
- Identify potential friction points and optimization opportunities
|
||||||
|
|
||||||
**Technical Planning & Requirements**
|
**Technical Planning and Requirements**
|
||||||
|
|
||||||
- Assess data requirements and storage needs
|
- Assess data requirements and storage needs
|
||||||
- Map integration points with other modules and external systems
|
- Map integration points with other modules and external systems
|
||||||
@@ -133,27 +133,27 @@ module-brief/
|
|||||||
- Prioritize features and capabilities by value and complexity
|
- Prioritize features and capabilities by value and complexity
|
||||||
- Create clear milestones and success checkpoints
|
- Create clear milestones and success checkpoints
|
||||||
|
|
||||||
### Phase 5: Enhancement & Risk Management (Steps 10-12)
|
### Phase 5: Enhancement and Risk Management (Steps 10-12)
|
||||||
|
|
||||||
**Creative Features & Special Touches** (Optional)
|
**Creative Features and Special Touches** (Optional)
|
||||||
|
|
||||||
- Design easter eggs and delightful user interactions
|
- Design easter eggs and delightful user interactions
|
||||||
- Plan module lore and thematic consistency
|
- Plan module lore and thematic consistency
|
||||||
- Add personality quirks and creative responses
|
- Add personality quirks and creative responses
|
||||||
- Develop backstories and universe building
|
- Develop backstories and universe building
|
||||||
|
|
||||||
**Risk Assessment & Mitigation**
|
**Risk Assessment and Mitigation**
|
||||||
|
|
||||||
- Identify technical, usability, and scope risks
|
- Identify technical, usability, and scope risks
|
||||||
- Develop mitigation strategies for each risk category
|
- Develop mitigation strategies for each risk category
|
||||||
- Plan contingency approaches for potential challenges
|
- Plan contingency approaches for potential challenges
|
||||||
- Document decision points and alternative paths
|
- Document decision points and alternative paths
|
||||||
|
|
||||||
**Final Review & Export Preparation**
|
**Final Review and Export Preparation**
|
||||||
|
|
||||||
- Comprehensive review of all brief sections
|
- Comprehensive review of all brief sections
|
||||||
- Validation against quality and completeness criteria
|
- Validation against quality and completeness criteria
|
||||||
- Preparation for seamless handoff to build-module workflow
|
- Preparation for seamless handoff to create-module workflow
|
||||||
- Export readiness confirmation with actionable specifications
|
- Export readiness confirmation with actionable specifications
|
||||||
|
|
||||||
## Output
|
## Output
|
||||||
@@ -161,7 +161,7 @@ module-brief/
|
|||||||
### Generated Files
|
### Generated Files
|
||||||
|
|
||||||
- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md`
|
- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md`
|
||||||
- **Strategic Specifications**: Ready-to-implement blueprint for build-module workflow
|
- **Strategic Specifications**: Ready-to-implement blueprint for create-module workflow
|
||||||
|
|
||||||
### Output Structure
|
### Output Structure
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ The module brief contains detailed specifications across multiple sections:
|
|||||||
9. **Creative Features** - Special touches, easter eggs, module lore
|
9. **Creative Features** - Special touches, easter eggs, module lore
|
||||||
10. **Risk Assessment** - Technical, usability, scope risks with mitigation
|
10. **Risk Assessment** - Technical, usability, scope risks with mitigation
|
||||||
11. **Implementation Notes** - Priority order, design decisions, open questions
|
11. **Implementation Notes** - Priority order, design decisions, open questions
|
||||||
12. **Resources & References** - Inspiration sources, similar modules, technical references
|
12. **Resources and References** - Inspiration sources, similar modules, technical references
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@@ -203,7 +203,7 @@ The module brief contains detailed specifications across multiple sections:
|
|||||||
|
|
||||||
### After Completion
|
### After Completion
|
||||||
|
|
||||||
1. **Use as Blueprint** - Feed the brief directly into build-module workflow for implementation
|
1. **Use as Blueprint** - Feed the brief directly into create-module workflow for implementation
|
||||||
2. **Review with Stakeholders** - Validate assumptions and gather feedback before building
|
2. **Review with Stakeholders** - Validate assumptions and gather feedback before building
|
||||||
3. **Update as Needed** - Treat as living document that evolves with implementation learnings
|
3. **Update as Needed** - Treat as living document that evolves with implementation learnings
|
||||||
4. **Reference During Development** - Use as north star for design decisions and scope management
|
4. **Reference During Development** - Use as north star for design decisions and scope management
|
||||||
@@ -254,10 +254,10 @@ To customize this workflow:
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Study existing module examples in `/bmad/` for patterns and inspiration
|
- Study existing module examples in `/bmad/` for patterns and inspiration
|
||||||
- Validate output using `checklist.md`
|
- Validate output using `checklist.md`
|
||||||
- Consult module structure guide at `build-module/module-structure.md`
|
- Consult module structure guide at `create-module/module-structure.md`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
- [ ] Target users are clearly defined
|
- [ ] Target users are clearly defined
|
||||||
- [ ] Unique value proposition is articulated
|
- [ ] Unique value proposition is articulated
|
||||||
|
|
||||||
## Vision & Concept
|
## Vision and Concept
|
||||||
|
|
||||||
- [ ] Problem being solved is clearly stated
|
- [ ] Problem being solved is clearly stated
|
||||||
- [ ] Solution approach is explained
|
- [ ] Solution approach is explained
|
||||||
@@ -80,9 +80,9 @@
|
|||||||
|
|
||||||
## Implementation Readiness
|
## Implementation Readiness
|
||||||
|
|
||||||
- [ ] Brief provides enough detail for build-module workflow
|
- [ ] Brief provides enough detail for create-module workflow
|
||||||
- [ ] Agent specifications sufficient for build-agent workflow
|
- [ ] Agent specifications sufficient for create-agent workflow
|
||||||
- [ ] Workflow descriptions ready for build-workflow
|
- [ ] Workflow descriptions ready for create-workflow
|
||||||
- [ ] Resource requirements are clear
|
- [ ] Resource requirements are clear
|
||||||
- [ ] Success metrics are measurable
|
- [ ] Success metrics are measurable
|
||||||
|
|
||||||
|
|||||||
@@ -249,15 +249,15 @@ For each risk, note mitigation strategy.
|
|||||||
|
|
||||||
<step n="12" goal="Final review and export readiness">
|
<step n="12" goal="Final review and export readiness">
|
||||||
<action>Review all sections with user</action>
|
<action>Review all sections with user</action>
|
||||||
<action>Ensure module brief is ready for build-module workflow</action>
|
<action>Ensure module brief is ready for create-module workflow</action>
|
||||||
|
|
||||||
Ask if they want to:
|
Ask if they want to:
|
||||||
|
|
||||||
1. Proceed directly to build-module workflow
|
1. Proceed directly to create-module workflow
|
||||||
2. Save and refine later
|
2. Save and refine later
|
||||||
3. Generate additional planning documents
|
3. Generate additional planning documents
|
||||||
|
|
||||||
<action>Highlight that this brief can be fed directly into build-module workflow!</action>
|
<action>Highlight that this brief can be fed directly into create-module workflow!</action>
|
||||||
|
|
||||||
<template-output>final_brief</template-output>
|
<template-output>final_brief</template-output>
|
||||||
</step>
|
</step>
|
||||||
|
|||||||
@@ -144,7 +144,7 @@ How we'll know the module is successful:
|
|||||||
**Deliverables:**
|
**Deliverables:**
|
||||||
{{phase2_deliverables}}
|
{{phase2_deliverables}}
|
||||||
|
|
||||||
### Phase 3: Polish & Optimization
|
### Phase 3: Polish and Optimization
|
||||||
|
|
||||||
**Timeline:** {{phase3_timeline}}
|
**Timeline:** {{phase3_timeline}}
|
||||||
|
|
||||||
@@ -161,11 +161,11 @@ How we'll know the module is successful:
|
|||||||
|
|
||||||
{{creative_features}}
|
{{creative_features}}
|
||||||
|
|
||||||
### Easter Eggs & Delighters
|
### Easter Eggs and Delighters
|
||||||
|
|
||||||
{{easter_eggs}}
|
{{easter_eggs}}
|
||||||
|
|
||||||
### Module Lore & Theming
|
### Module Lore and Theming
|
||||||
|
|
||||||
{{module_lore}}
|
{{module_lore}}
|
||||||
|
|
||||||
@@ -209,7 +209,7 @@ How we'll know the module is successful:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Resources & References
|
## Resources and References
|
||||||
|
|
||||||
### Inspiration Sources
|
### Inspiration Sources
|
||||||
|
|
||||||
@@ -235,7 +235,7 @@ How we'll know the module is successful:
|
|||||||
|
|
||||||
{{detailed_workflow_specs}}
|
{{detailed_workflow_specs}}
|
||||||
|
|
||||||
### C. Data Structures & Schemas
|
### C. Data Structures and Schemas
|
||||||
|
|
||||||
{{data_schemas}}
|
{{data_schemas}}
|
||||||
|
|
||||||
@@ -248,14 +248,14 @@ How we'll know the module is successful:
|
|||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
1. **Review this brief** with stakeholders
|
1. **Review this brief** with stakeholders
|
||||||
2. **Run build-module workflow** using this brief as input
|
2. **Run create-module workflow** using this brief as input
|
||||||
3. **Create first agent** using build-agent workflow
|
3. **Create first agent** using create-agent workflow
|
||||||
4. **Develop initial workflows** using build-workflow
|
4. **Develop initial workflows** using create-workflow
|
||||||
5. **Test MVP** with target users
|
5. **Test MVP** with target users
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
_This Module Brief is ready to be fed directly into the build-module workflow for scaffolding and implementation._
|
_This Module Brief is ready to be fed directly into the create-module workflow for scaffolding and implementation._
|
||||||
|
|
||||||
**Module Viability Score:** {{viability_score}}/10
|
**Module Viability Score:** {{viability_score}}/10
|
||||||
**Estimated Development Effort:** {{effort_estimate}}
|
**Estimated Development Effort:** {{effort_estimate}}
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ date: system-generated
|
|||||||
recommended_inputs:
|
recommended_inputs:
|
||||||
- brainstorming_results: "{output_folder}/brainstorming-*.md"
|
- brainstorming_results: "{output_folder}/brainstorming-*.md"
|
||||||
- existing_modules: "{project-root}/bmad/"
|
- existing_modules: "{project-root}/bmad/"
|
||||||
- module_examples: "{project-root}/bmad/bmb/workflows/build-module/module-structure.md"
|
- module_examples: "{project-root}/bmad/bmb/workflows/create-module/module-structure.md"
|
||||||
|
|
||||||
# Module path and component files
|
# Module path and component files
|
||||||
installed_path: "{project-root}/bmad/bmb/workflows/module-brief"
|
installed_path: "{project-root}/bmad/bmb/workflows/module-brief"
|
||||||
@@ -26,5 +26,11 @@ validation: "{installed_path}/checklist.md"
|
|||||||
# Output configuration
|
# Output configuration
|
||||||
default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md"
|
default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md"
|
||||||
|
|
||||||
# No special tools required
|
web_bundle:
|
||||||
required_tools: []
|
name: "module-brief"
|
||||||
|
description: "Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision"
|
||||||
|
author: "BMad Builder"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmb/workflows/module-brief/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/module-brief/template.md"
|
||||||
|
- "bmad/bmb/workflows/module-brief/checklist.md"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# ReDoc Workflow Validation Checklist
|
# ReDoc Workflow Validation Checklist
|
||||||
|
|
||||||
## Initialization & Setup
|
## Initialization and Setup
|
||||||
|
|
||||||
- [ ] All BMAD convention documents loaded and understood
|
- [ ] All BMAD convention documents loaded and understood
|
||||||
- [ ] Target path validated and exists
|
- [ ] Target path validated and exists
|
||||||
@@ -66,7 +66,7 @@
|
|||||||
- [ ] Frontmatter syntax is correct and dates are current
|
- [ ] Frontmatter syntax is correct and dates are current
|
||||||
- [ ] No redundant explanation of standard BMAD patterns
|
- [ ] No redundant explanation of standard BMAD patterns
|
||||||
|
|
||||||
## Validation & Reporting
|
## Validation and Reporting
|
||||||
|
|
||||||
- [ ] All planned documentation items created/updated
|
- [ ] All planned documentation items created/updated
|
||||||
- [ ] Frontmatter dates verified as current across all files
|
- [ ] Frontmatter dates verified as current across all files
|
||||||
|
|||||||
@@ -29,5 +29,10 @@ validation: "{installed_path}/checklist.md"
|
|||||||
# Configuration
|
# Configuration
|
||||||
autonomous: true # Runs without user checkpoints unless clarification needed
|
autonomous: true # Runs without user checkpoints unless clarification needed
|
||||||
|
|
||||||
# Tool Requirements - Using built-in file system tools
|
web_bundle:
|
||||||
required_tools: []
|
name: "redoc"
|
||||||
|
description: "Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output."
|
||||||
|
author: "BMad"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmb/workflows/redoc/instructions.md"
|
||||||
|
- "bmad/bmb/workflows/redoc/checklist.md"
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ When Claude Code is selected during BMAD installation:
|
|||||||
| **epic-optimizer** | Story breakdown and sizing | PM Agent | Epic details, story sequencing |
|
| **epic-optimizer** | Story breakdown and sizing | PM Agent | Epic details, story sequencing |
|
||||||
| **document-reviewer** | Quality checks and validation | PM/Analyst | Final document review before delivery |
|
| **document-reviewer** | Quality checks and validation | PM/Analyst | Final document review before delivery |
|
||||||
|
|
||||||
### Architecture & Documentation Subagents
|
### Architecture and Documentation Subagents
|
||||||
|
|
||||||
| Subagent | Purpose | Used By | Recommended For |
|
| Subagent | Purpose | Used By | Recommended For |
|
||||||
| -------------------------- | ----------------------------------------- | --------- | ---------------------------------------------- |
|
| -------------------------- | ----------------------------------------- | --------- | ---------------------------------------------- |
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ Provide structured analysis with:
|
|||||||
- **Key Components**: Entry points, core modules, critical services
|
- **Key Components**: Entry points, core modules, critical services
|
||||||
- **Dependencies**: External libraries, internal module relationships
|
- **Dependencies**: External libraries, internal module relationships
|
||||||
- **Configuration**: Environment setup, deployment configurations
|
- **Configuration**: Environment setup, deployment configurations
|
||||||
- **Build & Deploy**: Build process, test execution, deployment pipeline
|
- **Build and Deploy**: Build process, test execution, deployment pipeline
|
||||||
|
|
||||||
## Critical Behaviors
|
## Critical Behaviors
|
||||||
|
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ Specialized sub-agent for maintaining and organizing the technical-decisions.md
|
|||||||
|
|
||||||
### Primary Functions
|
### Primary Functions
|
||||||
|
|
||||||
1. **Capture & Append**: Add new technical decisions with proper context
|
1. **Capture and Append**: Add new technical decisions with proper context
|
||||||
2. **Organize & Categorize**: Structure decisions into logical sections
|
2. **Organize and Categorize**: Structure decisions into logical sections
|
||||||
3. **Deduplicate**: Identify and merge duplicate or conflicting entries
|
3. **Deduplicate**: Identify and merge duplicate or conflicting entries
|
||||||
4. **Validate**: Ensure decisions align and don't contradict
|
4. **Validate**: Ensure decisions align and don't contradict
|
||||||
5. **Prioritize**: Mark decisions as confirmed vs. preferences vs. constraints
|
5. **Prioritize**: Mark decisions as confirmed vs. preferences vs. constraints
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
<i>DO NOT skip steps or change the sequence</i>
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
<i>HALT immediately when halt-conditions are met</i>
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
<i>Each <action> within <step> is a REQUIRED action to complete that step</i>
|
<i>Each andlt;actionandgt; within andlt;stepandgt; is a REQUIRED action to complete that step</i>
|
||||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
||||||
</llm>
|
</llm>
|
||||||
<flow>
|
<flow>
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
<i>DO NOT skip steps or change the sequence</i>
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
<i>HALT immediately when halt-conditions are met</i>
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
<i>Each <action> within <step> is a REQUIRED action to complete that step</i>
|
<i>Each andlt;actionandgt; within andlt;stepandgt; is a REQUIRED action to complete that step</i>
|
||||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
||||||
</llm>
|
</llm>
|
||||||
<flow>
|
<flow>
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ last-redoc-date: 2025-09-30
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
- **Persona:** Murat, Master Test Architect & Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance.
|
- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance.
|
||||||
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project level and compliance demands.
|
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project level and compliance demands.
|
||||||
- **Use When:** Project level ≥2, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required.
|
- **Use When:** Project level ≥2, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required.
|
||||||
|
|
||||||
## Prerequisites & Setup
|
## Prerequisites and Setup
|
||||||
|
|
||||||
1. Run the core planning workflows first:
|
1. Run the core planning workflows first:
|
||||||
- Analyst `*product-brief`
|
- Analyst `*product-brief`
|
||||||
@@ -30,7 +30,7 @@ last-redoc-date: 2025-09-30
|
|||||||
| Phase | Test Architect | Dev / Team | Outputs |
|
| Phase | Test Architect | Dev / Team | Outputs |
|
||||||
| ------------------ | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
| ------------------ | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
| Setup | - | Analyst `*product-brief`, PM `*plan-project`, Architect `*solution-architecture` | `{output_folder}/product-brief*.md`, `PRD.md`, `epics.md`, `solution-architecture.md` |
|
| Setup | - | Analyst `*product-brief`, PM `*plan-project`, Architect `*solution-architecture` | `{output_folder}/product-brief*.md`, `PRD.md`, `epics.md`, `solution-architecture.md` |
|
||||||
| Pre-Implementation | Run `*framework` (if harness missing), `*ci`, and `*test-design` | Review risk/design/CI guidance, align backlog | Test scaffold, CI pipeline, risk & coverage strategy |
|
| Pre-Implementation | Run `*framework` (if harness missing), `*ci`, and `*test-design` | Review risk/design/CI guidance, align backlog | Test scaffold, CI pipeline, risk and coverage strategy |
|
||||||
| Story Prep | - | Scrum Master `*create-story`, `*story-context` | Story markdown + context XML |
|
| Story Prep | - | Scrum Master `*create-story`, `*story-context` | Story markdown + context XML |
|
||||||
| Implementation | (Optional) Trigger `*atdd` before dev to supply failing tests + checklist | Implement story guided by ATDD checklist | Failing acceptance tests + implementation checklist |
|
| Implementation | (Optional) Trigger `*atdd` before dev to supply failing tests + checklist | Implement story guided by ATDD checklist | Failing acceptance tests + implementation checklist |
|
||||||
| Post-Dev | Execute `*automate`, re-run `*trace` | Address recommendations, update code/tests | Regression specs, refreshed coverage matrix |
|
| Post-Dev | Execute `*automate`, re-run `*trace` | Address recommendations, update code/tests | Regression specs, refreshed coverage matrix |
|
||||||
@@ -53,7 +53,7 @@ last-redoc-date: 2025-09-30
|
|||||||
2. **Setup:** TEA checks harness via `*framework`, configures `*ci`, and runs `*test-design` to capture risk/coverage plans.
|
2. **Setup:** TEA checks harness via `*framework`, configures `*ci`, and runs `*test-design` to capture risk/coverage plans.
|
||||||
3. **Story Prep:** Scrum Master generates the story via `*create-story`; PO validates using `*assess-project-ready`.
|
3. **Story Prep:** Scrum Master generates the story via `*create-story`; PO validates using `*assess-project-ready`.
|
||||||
4. **Implementation:** TEA optionally runs `*atdd`; Dev implements with guidance from failing tests and the plan.
|
4. **Implementation:** TEA optionally runs `*atdd`; Dev implements with guidance from failing tests and the plan.
|
||||||
5. **Post-Dev & Release:** TEA runs `*automate`, re-runs `*trace`, and finishes with `*gate` to document the decision.
|
5. **Post-Dev and Release:** TEA runs `*automate`, re-runs `*trace`, and finishes with `*gate` to document the decision.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@@ -85,7 +85,7 @@ last-redoc-date: 2025-09-30
|
|||||||
|
|
||||||
1. **Context Refresh:** Analyst reruns `*product-brief`; PM executes `*plan-project` to update PRD, analysis, and `epics.md`; Architect triggers `*solution-architecture` capturing legacy payment flows.
|
1. **Context Refresh:** Analyst reruns `*product-brief`; PM executes `*plan-project` to update PRD, analysis, and `epics.md`; Architect triggers `*solution-architecture` capturing legacy payment flows.
|
||||||
2. **Baseline Coverage:** TEA executes `*trace` to record current coverage in `docs/qa/assessments/atlas-payment-trace.md`.
|
2. **Baseline Coverage:** TEA executes `*trace` to record current coverage in `docs/qa/assessments/atlas-payment-trace.md`.
|
||||||
3. **Risk & Design:** `*test-design` flags settlement edge cases, plans mitigations, and allocates new API/E2E scenarios with P0 priorities.
|
3. **Risk and Design:** `*test-design` flags settlement edge cases, plans mitigations, and allocates new API/E2E scenarios with P0 priorities.
|
||||||
4. **Story Prep:** Scrum Master generates `stories/story-1.1.md` via `*create-story`, automatically pulling updated context.
|
4. **Story Prep:** Scrum Master generates `stories/story-1.1.md` via `*create-story`, automatically pulling updated context.
|
||||||
5. **ATDD First:** TEA runs `*atdd`, producing failing Playwright specs under `tests/e2e/payments/` plus an implementation checklist.
|
5. **ATDD First:** TEA runs `*atdd`, producing failing Playwright specs under `tests/e2e/payments/` plus an implementation checklist.
|
||||||
6. **Implementation:** Dev pairs with the checklist/tests to deliver the story.
|
6. **Implementation:** Dev pairs with the checklist/tests to deliver the story.
|
||||||
@@ -137,7 +137,7 @@ last-redoc-date: 2025-09-30
|
|||||||
| `*gate` | `testarch/gate.md` | Gate YAML + summary (PASS/CONCERNS/FAIL/WAIVED) | Deterministic decision rules + rationale |
|
| `*gate` | `testarch/gate.md` | Gate YAML + summary (PASS/CONCERNS/FAIL/WAIVED) | Deterministic decision rules + rationale |
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Command Guidance & Context Loading</summary>
|
<summary>Command Guidance and Context Loading</summary>
|
||||||
|
|
||||||
- Each task reads one row from `tea-commands.csv` via `command_key`, expanding pipe-delimited (`|`) values into checklists.
|
- Each task reads one row from `tea-commands.csv` via `command_key`, expanding pipe-delimited (`|`) values into checklists.
|
||||||
- Keep CSV rows lightweight; place in-depth heuristics in `tea-knowledge.md` and reference via `knowledge_tags`.
|
- Keep CSV rows lightweight; place in-depth heuristics in `tea-knowledge.md` and reference via `knowledge_tags`.
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
- Setup via API, assert via UI. Keep tests user-centric while priming state through fast interfaces.
|
- Setup via API, assert via UI. Keep tests user-centric while priming state through fast interfaces.
|
||||||
- One test = one concern. Explicit assertions live in the test body, not buried in helpers.
|
- One test = one concern. Explicit assertions live in the test body, not buried in helpers.
|
||||||
|
|
||||||
## Patterns & Heuristics
|
## Patterns and Heuristics
|
||||||
|
|
||||||
- Selector order: `data-cy` / `data-testid` -> ARIA -> text. Avoid brittle CSS, IDs, or index based locators.
|
- Selector order: `data-cy` / `data-testid` -> ARIA -> text. Avoid brittle CSS, IDs, or index based locators.
|
||||||
- Network boundary is the mock boundary. Stub at the edge, never mid-service unless risk demands.
|
- Network boundary is the mock boundary. Stub at the edge, never mid-service unless risk demands.
|
||||||
@@ -46,7 +46,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
```
|
```
|
||||||
- Visual debugging: keep component/test runner UIs available (Playwright trace viewer, Cypress runner) to accelerate feedback.
|
- Visual debugging: keep component/test runner UIs available (Playwright trace viewer, Cypress runner) to accelerate feedback.
|
||||||
|
|
||||||
## Risk & Coverage
|
## Risk and Coverage
|
||||||
|
|
||||||
- Risk score = probability (1-3) × impact (1-3). Score 9 => gate FAIL, ≥6 => CONCERNS. Most stories have 0-1 high risks.
|
- Risk score = probability (1-3) × impact (1-3). Score 9 => gate FAIL, ≥6 => CONCERNS. Most stories have 0-1 high risks.
|
||||||
- Test level ratio: heavy unit/component coverage, but always include E2E for critical journeys and integration seams.
|
- Test level ratio: heavy unit/component coverage, but always include E2E for critical journeys and integration seams.
|
||||||
@@ -60,7 +60,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
- **Media**: screenshot only-on-failure, video retain-on-failure
|
- **Media**: screenshot only-on-failure, video retain-on-failure
|
||||||
- **Language Matching**: Tests should match source code language (JS/TS frontend -> JS/TS tests)
|
- **Language Matching**: Tests should match source code language (JS/TS frontend -> JS/TS tests)
|
||||||
|
|
||||||
## Automation & CI
|
## Automation and CI
|
||||||
|
|
||||||
- Prefer Playwright for multi-language teams, worker parallelism, rich debugging; Cypress suits smaller DX-first repos or component-heavy spikes.
|
- Prefer Playwright for multi-language teams, worker parallelism, rich debugging; Cypress suits smaller DX-first repos or component-heavy spikes.
|
||||||
- **Framework Selection**: Large repo + performance = Playwright, Small repo + DX = Cypress
|
- **Framework Selection**: Large repo + performance = Playwright, Small repo + DX = Cypress
|
||||||
@@ -71,7 +71,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
- Burn-in testing: run new or changed specs multiple times (e.g., 3-10x) to flush flakes before they land in main.
|
- Burn-in testing: run new or changed specs multiple times (e.g., 3-10x) to flush flakes before they land in main.
|
||||||
- Keep helper scripts handy (`scripts/test-changed.sh`, `scripts/burn-in-changed.sh`) so CI and local workflows stay in sync.
|
- Keep helper scripts handy (`scripts/test-changed.sh`, `scripts/burn-in-changed.sh`) so CI and local workflows stay in sync.
|
||||||
|
|
||||||
## Project Structure & Config
|
## Project Structure and Config
|
||||||
|
|
||||||
- **Directory structure**:
|
- **Directory structure**:
|
||||||
```
|
```
|
||||||
@@ -93,7 +93,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
export default configs[process.env.TEST_ENV || 'local'];
|
export default configs[process.env.TEST_ENV || 'local'];
|
||||||
```
|
```
|
||||||
|
|
||||||
## Test Hygiene & Independence
|
## Test Hygiene and Independence
|
||||||
|
|
||||||
- Tests must be independent and stateless; never rely on execution order.
|
- Tests must be independent and stateless; never rely on execution order.
|
||||||
- Cleanup all data created during tests (afterEach or API cleanup).
|
- Cleanup all data created during tests (afterEach or API cleanup).
|
||||||
@@ -127,7 +127,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
"test:component": "cypress run --component",
|
"test:component": "cypress run --component",
|
||||||
"test:contract": "jest --testMatch='**/pact/*.spec.ts'",
|
"test:contract": "jest --testMatch='**/pact/*.spec.ts'",
|
||||||
"test:debug": "playwright test --headed",
|
"test:debug": "playwright test --headed",
|
||||||
"test:ci": "npm run test:unit && npm run test:e2e",
|
"test:ci": "npm run test:unit andand npm run test:e2e",
|
||||||
"contract:publish": "pact-broker publish"
|
"contract:publish": "pact-broker publish"
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -138,7 +138,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
- Structure: `pact/` directory at root, `pact/config.ts` for broker settings.
|
- Structure: `pact/` directory at root, `pact/config.ts` for broker settings.
|
||||||
- Reference repos: pact-js-example-consumer, pact-js-example-provider, pact-js-example-react-consumer.
|
- Reference repos: pact-js-example-consumer, pact-js-example-provider, pact-js-example-react-consumer.
|
||||||
|
|
||||||
## Online Resources & Examples
|
## Online Resources and Examples
|
||||||
|
|
||||||
- Fixture architecture: https://github.com/muratkeremozcan/cy-vs-pw-murats-version
|
- Fixture architecture: https://github.com/muratkeremozcan/cy-vs-pw-murats-version
|
||||||
- Playwright patterns: https://github.com/muratkeremozcan/pw-book
|
- Playwright patterns: https://github.com/muratkeremozcan/pw-book
|
||||||
@@ -156,7 +156,7 @@ This brief distills Murat Ozcan's testing philosophy used by the Test Architect
|
|||||||
- BUS: Business or user harm, revenue-impacting failures, compliance gaps.
|
- BUS: Business or user harm, revenue-impacting failures, compliance gaps.
|
||||||
- OPS: Deployment, infrastructure, or observability gaps that block releases.
|
- OPS: Deployment, infrastructure, or observability gaps that block releases.
|
||||||
|
|
||||||
## Probability & Impact Scale
|
## Probability and Impact Scale
|
||||||
|
|
||||||
- Probability 1 = Unlikely (standard implementation, low risk).
|
- Probability 1 = Unlikely (standard implementation, low risk).
|
||||||
- Probability 2 = Possible (edge cases, needs attention).
|
- Probability 2 = Possible (edge cases, needs attention).
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
<!-- Powered by BMAD-CORE™ -->
|
<!-- Powered by BMAD-CORE™ -->
|
||||||
|
|
||||||
# Risk & Test Design v3.0 (Slim)
|
# Risk and Test Design v3.0 (Slim)
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<task id="bmad/bmm/testarch/test-design" name="Risk & Test Design">
|
<task id="bmad/bmm/testarch/test-design" name="Risk andamp; Test Design">
|
||||||
<llm critical="true">
|
<llm critical="true">
|
||||||
<i>Set command_key="*test-design"</i>
|
<i>Set command_key="*test-design"</i>
|
||||||
<i>Load {project-root}/bmad/bmm/testarch/tea-commands.csv and parse the matching row</i>
|
<i>Load {project-root}/bmad/bmm/testarch/tea-commands.csv and parse the matching row</i>
|
||||||
|
|||||||
@@ -12,10 +12,10 @@ When brainstorming for games, consider exploring:
|
|||||||
- **Game Dynamics** - Emergent behaviors from mechanic interactions
|
- **Game Dynamics** - Emergent behaviors from mechanic interactions
|
||||||
- **Aesthetic Experience** - Emotional responses and feelings evoked
|
- **Aesthetic Experience** - Emotional responses and feelings evoked
|
||||||
- **Progression Systems** - How players grow and unlock content
|
- **Progression Systems** - How players grow and unlock content
|
||||||
- **Challenge & Difficulty** - How to create engaging difficulty curves
|
- **Challenge and Difficulty** - How to create engaging difficulty curves
|
||||||
- **Social/Multiplayer Features** - How players interact with each other
|
- **Social/Multiplayer Features** - How players interact with each other
|
||||||
- **Narrative & World** - Story, setting, and environmental storytelling
|
- **Narrative and World** - Story, setting, and environmental storytelling
|
||||||
- **Art Direction & Feel** - Visual style and game feel
|
- **Art Direction and Feel** - Visual style and game feel
|
||||||
- **Monetization** - Business model and revenue approach (if applicable)
|
- **Monetization** - Business model and revenue approach (if applicable)
|
||||||
|
|
||||||
## Game Design Frameworks
|
## Game Design Frameworks
|
||||||
|
|||||||
@@ -20,3 +20,14 @@ game_brain_methods: "{installed_path}/game-brain-methods.csv"
|
|||||||
|
|
||||||
# CIS brainstorming workflow to invoke
|
# CIS brainstorming workflow to invoke
|
||||||
cis_brainstorming: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
cis_brainstorming: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||||
|
|
||||||
|
web_bundle:
|
||||||
|
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"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmm/workflows/1-analysis/brainstorm-game/instructions.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/brainstorm-game/game-context.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/brainstorm-game/game-brain-methods.csv"
|
||||||
|
existing_workflows:
|
||||||
|
- cis_brainstorming: "bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||||
|
|||||||
@@ -6,13 +6,13 @@ This context guide provides project-specific considerations for brainstorming se
|
|||||||
|
|
||||||
When brainstorming for projects, consider exploring:
|
When brainstorming for projects, consider exploring:
|
||||||
|
|
||||||
- **User Problems & Pain Points** - What challenges do users face?
|
- **User Problems and Pain Points** - What challenges do users face?
|
||||||
- **Feature Ideas & Capabilities** - What could the product do?
|
- **Feature Ideas and Capabilities** - What could the product do?
|
||||||
- **Technical Approaches** - How might we build it?
|
- **Technical Approaches** - How might we build it?
|
||||||
- **User Experience** - How will users interact with it?
|
- **User Experience** - How will users interact with it?
|
||||||
- **Business Model & Value** - How does it create value?
|
- **Business Model and Value** - How does it create value?
|
||||||
- **Market Differentiation** - What makes it unique?
|
- **Market Differentiation** - What makes it unique?
|
||||||
- **Technical Risks & Challenges** - What could go wrong?
|
- **Technical Risks and Challenges** - What could go wrong?
|
||||||
- **Success Metrics** - How will we measure success?
|
- **Success Metrics** - How will we measure success?
|
||||||
|
|
||||||
## Integration with Project Workflow
|
## Integration with Project Workflow
|
||||||
|
|||||||
@@ -19,3 +19,13 @@ project_context: "{installed_path}/project-context.md"
|
|||||||
|
|
||||||
# CIS brainstorming workflow to invoke
|
# CIS brainstorming workflow to invoke
|
||||||
cis_brainstorming: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
cis_brainstorming: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||||
|
|
||||||
|
web_bundle:
|
||||||
|
name: "brainstorm-project"
|
||||||
|
description: "Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance."
|
||||||
|
author: "BMad"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md"
|
||||||
|
existing_workflows:
|
||||||
|
- cis_brainstorming: "bmad/cis/workflows/brainstorming/workflow.yaml"
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ Work through each section collaboratively:
|
|||||||
4. Scope and Constraints (platforms, timeline, budget, team)
|
4. Scope and Constraints (platforms, timeline, budget, team)
|
||||||
5. Reference Framework (inspiration, competitors, differentiators)
|
5. Reference Framework (inspiration, competitors, differentiators)
|
||||||
6. Content Framework (world, narrative, volume)
|
6. Content Framework (world, narrative, volume)
|
||||||
7. Art & Audio Direction (visual and audio style)
|
7. Art and Audio Direction (visual and audio style)
|
||||||
8. Risk Assessment (risks, challenges, mitigation)
|
8. Risk Assessment (risks, challenges, mitigation)
|
||||||
9. Success Criteria (MVP, metrics, launch goals)
|
9. Success Criteria (MVP, metrics, launch goals)
|
||||||
10. Next Steps (immediate actions, research, questions)
|
10. Next Steps (immediate actions, research, questions)
|
||||||
|
|||||||
@@ -45,13 +45,13 @@ Use this checklist to ensure your game brief is complete and ready for GDD creat
|
|||||||
|
|
||||||
## Content Framework ✓
|
## Content Framework ✓
|
||||||
|
|
||||||
- [ ] **World & Setting** is defined
|
- [ ] **World and Setting** is defined
|
||||||
- [ ] **Narrative Approach** matches game type
|
- [ ] **Narrative Approach** matches game type
|
||||||
- [ ] **Content Volume** is estimated (rough order of magnitude)
|
- [ ] **Content Volume** is estimated (rough order of magnitude)
|
||||||
- [ ] Playtime expectations are set
|
- [ ] Playtime expectations are set
|
||||||
- [ ] Replayability approach is clear
|
- [ ] Replayability approach is clear
|
||||||
|
|
||||||
## Art & Audio Direction ✓
|
## Art and Audio Direction ✓
|
||||||
|
|
||||||
- [ ] **Visual Style** is described with references
|
- [ ] **Visual Style** is described with references
|
||||||
- [ ] 2D vs. 3D is decided
|
- [ ] 2D vs. 3D is decided
|
||||||
|
|||||||
@@ -225,7 +225,7 @@ What makes your game unique?
|
|||||||
<step n="8" goal="Define content framework" if="collaboration_mode == 'interactive'">
|
<step n="8" goal="Define content framework" if="collaboration_mode == 'interactive'">
|
||||||
<ask>Let's scope your content needs.
|
<ask>Let's scope your content needs.
|
||||||
|
|
||||||
**World & Setting:**
|
**World and Setting:**
|
||||||
|
|
||||||
- Where/when does your game take place?
|
- Where/when does your game take place?
|
||||||
- How much world-building is needed?
|
- How much world-building is needed?
|
||||||
@@ -459,7 +459,7 @@ What are you still uncertain about?
|
|||||||
4. Scope and Constraints
|
4. Scope and Constraints
|
||||||
5. Reference Framework
|
5. Reference Framework
|
||||||
6. Content Framework
|
6. Content Framework
|
||||||
7. Art & Audio Direction
|
7. Art and Audio Direction
|
||||||
8. Risk Assessment
|
8. Risk Assessment
|
||||||
9. Success Criteria
|
9. Success Criteria
|
||||||
10. Next Steps
|
10. Next Steps
|
||||||
|
|||||||
@@ -102,7 +102,7 @@
|
|||||||
|
|
||||||
## Content Framework
|
## Content Framework
|
||||||
|
|
||||||
### World & Setting
|
### World and Setting
|
||||||
|
|
||||||
{{world_setting}}
|
{{world_setting}}
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Art & Audio Direction
|
## Art and Audio Direction
|
||||||
|
|
||||||
### Visual Style
|
### Visual Style
|
||||||
|
|
||||||
|
|||||||
@@ -26,9 +26,15 @@ validation: "{installed_path}/checklist.md"
|
|||||||
# Output configuration
|
# Output configuration
|
||||||
default_output_file: "{output_folder}/game-brief-{{game_name}}-{{date}}.md"
|
default_output_file: "{output_folder}/game-brief-{{game_name}}-{{date}}.md"
|
||||||
|
|
||||||
# Required tools
|
|
||||||
required_tools: []
|
|
||||||
|
|
||||||
# Workflow settings
|
# Workflow settings
|
||||||
autonomous: false # This is an interactive workflow requiring user collaboration
|
autonomous: false # This is an interactive workflow requiring user collaboration
|
||||||
brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
|
brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
|
||||||
|
|
||||||
|
web_bundle:
|
||||||
|
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"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmm/workflows/1-analysis/game-brief/template.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/game-brief/instructions.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/game-brief/checklist.md"
|
||||||
|
|||||||
@@ -95,14 +95,14 @@ product-brief/
|
|||||||
2. **Problem Statement** - Detailed problem analysis with evidence
|
2. **Problem Statement** - Detailed problem analysis with evidence
|
||||||
3. **Proposed Solution** - Core approach and key differentiators
|
3. **Proposed Solution** - Core approach and key differentiators
|
||||||
4. **Target Users** - Primary and secondary user segments with personas
|
4. **Target Users** - Primary and secondary user segments with personas
|
||||||
5. **Goals & Success Metrics** - Business objectives and measurable KPIs
|
5. **Goals and Success Metrics** - Business objectives and measurable KPIs
|
||||||
6. **MVP Scope** - Must-have features and out-of-scope items
|
6. **MVP Scope** - Must-have features and out-of-scope items
|
||||||
7. **Post-MVP Vision** - Phase 2 features and long-term roadmap
|
7. **Post-MVP Vision** - Phase 2 features and long-term roadmap
|
||||||
8. **Financial Impact** - Investment requirements and ROI projections
|
8. **Financial Impact** - Investment requirements and ROI projections
|
||||||
9. **Strategic Alignment** - Connection to company OKRs and initiatives
|
9. **Strategic Alignment** - Connection to company OKRs and initiatives
|
||||||
10. **Technical Considerations** - Platform requirements and preferences
|
10. **Technical Considerations** - Platform requirements and preferences
|
||||||
11. **Constraints & Assumptions** - Resource limits and key assumptions
|
11. **Constraints and Assumptions** - Resource limits and key assumptions
|
||||||
12. **Risks & Open Questions** - Risk assessment and research needs
|
12. **Risks and Open Questions** - Risk assessment and research needs
|
||||||
13. **Supporting Materials** - Research summaries and references
|
13. **Supporting Materials** - Research summaries and references
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -170,7 +170,7 @@ To customize this workflow:
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Validate output using `checklist.md`
|
- Validate output using `checklist.md`
|
||||||
- Consider running market research workflow first if lacking business context
|
- Consider running market research workflow first if lacking business context
|
||||||
- Consult BMAD documentation for product planning methodology
|
- Consult BMAD documentation for product planning methodology
|
||||||
|
|||||||
@@ -41,7 +41,7 @@
|
|||||||
- [ ] Secondary segment (if applicable) is equally detailed
|
- [ ] Secondary segment (if applicable) is equally detailed
|
||||||
- [ ] Avoids generic personas like "busy professionals"
|
- [ ] Avoids generic personas like "busy professionals"
|
||||||
|
|
||||||
## Goals & Metrics
|
## Goals and Metrics
|
||||||
|
|
||||||
- [ ] Business objectives include measurable outcomes with targets
|
- [ ] Business objectives include measurable outcomes with targets
|
||||||
- [ ] User success metrics focus on behaviors, not features
|
- [ ] User success metrics focus on behaviors, not features
|
||||||
@@ -67,7 +67,7 @@
|
|||||||
- [ ] Technology preferences are marked as preferences, not decisions
|
- [ ] Technology preferences are marked as preferences, not decisions
|
||||||
- [ ] Integration requirements with existing systems are identified
|
- [ ] Integration requirements with existing systems are identified
|
||||||
|
|
||||||
## Constraints & Assumptions
|
## Constraints and Assumptions
|
||||||
|
|
||||||
- [ ] Budget constraints are documented if known
|
- [ ] Budget constraints are documented if known
|
||||||
- [ ] Timeline or deadline pressures are specified
|
- [ ] Timeline or deadline pressures are specified
|
||||||
|
|||||||
@@ -299,13 +299,13 @@ Being honest about unknowns helps us prepare.</ask>
|
|||||||
1. Problem Statement
|
1. Problem Statement
|
||||||
2. Proposed Solution
|
2. Proposed Solution
|
||||||
3. Target Users
|
3. Target Users
|
||||||
4. Goals & Metrics
|
4. Goals and Metrics
|
||||||
5. MVP Scope
|
5. MVP Scope
|
||||||
6. Post-MVP Vision
|
6. Post-MVP Vision
|
||||||
7. Financial Impact & Strategic Alignment
|
7. Financial Impact and Strategic Alignment
|
||||||
8. Technical Considerations
|
8. Technical Considerations
|
||||||
9. Constraints & Assumptions
|
9. Constraints and Assumptions
|
||||||
10. Risks & Questions
|
10. Risks and Questions
|
||||||
11. Save and continue</ask>
|
11. Save and continue</ask>
|
||||||
|
|
||||||
<action>Work with user to refine selected section</action>
|
<action>Work with user to refine selected section</action>
|
||||||
|
|||||||
@@ -36,7 +36,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Goals & Success Metrics
|
## Goals and Success Metrics
|
||||||
|
|
||||||
### Business Objectives
|
### Business Objectives
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Strategic Alignment & Financial Impact
|
## Strategic Alignment and Financial Impact
|
||||||
|
|
||||||
### Financial Impact
|
### Financial Impact
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Constraints & Assumptions
|
## Constraints and Assumptions
|
||||||
|
|
||||||
### Constraints
|
### Constraints
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Risks & Open Questions
|
## Risks and Open Questions
|
||||||
|
|
||||||
### Key Risks
|
### Key Risks
|
||||||
|
|
||||||
|
|||||||
@@ -25,9 +25,15 @@ validation: "{installed_path}/checklist.md"
|
|||||||
# Output configuration
|
# Output configuration
|
||||||
default_output_file: "{output_folder}/product-brief-{{project_name}}-{{date}}.md"
|
default_output_file: "{output_folder}/product-brief-{{project_name}}-{{date}}.md"
|
||||||
|
|
||||||
# Required tools
|
|
||||||
required_tools: []
|
|
||||||
|
|
||||||
# Workflow settings
|
# Workflow settings
|
||||||
autonomous: false # This is an interactive workflow requiring user collaboration
|
autonomous: false # This is an interactive workflow requiring user collaboration
|
||||||
brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
|
brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
|
||||||
|
|
||||||
|
web_bundle:
|
||||||
|
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"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmm/workflows/1-analysis/product-brief/template.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/product-brief/instructions.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/product-brief/checklist.md"
|
||||||
|
|||||||
@@ -146,7 +146,7 @@ research/
|
|||||||
|
|
||||||
## Workflow Process
|
## Workflow Process
|
||||||
|
|
||||||
### Phase 1: Research Type Selection & Setup
|
### Phase 1: Research Type Selection and Setup
|
||||||
|
|
||||||
1. Router presents research type menu
|
1. Router presents research type menu
|
||||||
2. User selects research type (market, deep_prompt, technical, competitive, user, domain)
|
2. User selects research type (market, deep_prompt, technical, competitive, user, domain)
|
||||||
@@ -196,7 +196,7 @@ research/
|
|||||||
- Adapts questions and frameworks to research type
|
- Adapts questions and frameworks to research type
|
||||||
- Customizes output format for target audience
|
- Customizes output format for target audience
|
||||||
|
|
||||||
### Phase 3: Validation & Delivery
|
### Phase 3: Validation and Delivery
|
||||||
|
|
||||||
1. Review outputs against checklist
|
1. Review outputs against checklist
|
||||||
2. Validate completeness and quality
|
2. Validate completeness and quality
|
||||||
@@ -428,7 +428,7 @@ Add to `workflow.yaml` `frameworks` section under appropriate research type.
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Check validation against `checklist.md`
|
- Check validation against `checklist.md`
|
||||||
- Examine router logic in `instructions-router.md`
|
- Examine router logic in `instructions-router.md`
|
||||||
- Review research type-specific instructions
|
- Review research type-specific instructions
|
||||||
|
|||||||
@@ -207,7 +207,7 @@ Competitive Threat:
|
|||||||
### Innovation Pipeline Assessment
|
### Innovation Pipeline Assessment
|
||||||
|
|
||||||
- Patent filing analysis
|
- Patent filing analysis
|
||||||
- R&D investment signals
|
- RandD investment signals
|
||||||
- Acquisition patterns
|
- Acquisition patterns
|
||||||
- Partnership strategies
|
- Partnership strategies
|
||||||
- Beta/preview features
|
- Beta/preview features
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ You are a specialized Market Research Expert with deep expertise in gathering, a
|
|||||||
- Market share estimates
|
- Market share estimates
|
||||||
- Business model analysis
|
- Business model analysis
|
||||||
- Competitive dynamics
|
- Competitive dynamics
|
||||||
- M&A activity
|
- MandA activity
|
||||||
|
|
||||||
**Customer Research**
|
**Customer Research**
|
||||||
|
|
||||||
@@ -87,7 +87,7 @@ You are a specialized Market Research Expert with deep expertise in gathering, a
|
|||||||
- Decision criteria
|
- Decision criteria
|
||||||
- Price sensitivity
|
- Price sensitivity
|
||||||
|
|
||||||
### Phase 3: Synthesis & Insights
|
### Phase 3: Synthesis and Insights
|
||||||
|
|
||||||
**Pattern Recognition**
|
**Pattern Recognition**
|
||||||
|
|
||||||
|
|||||||
@@ -58,9 +58,9 @@ When analyzing trends:
|
|||||||
|
|
||||||
For each identified trend, provide:
|
For each identified trend, provide:
|
||||||
|
|
||||||
- **Trend Name & Description**
|
- **Trend Name and Description**
|
||||||
- **Current Stage** (Emerging/Growing/Mainstream/Declining)
|
- **Current Stage** (Emerging/Growing/Mainstream/Declining)
|
||||||
- **Evidence & Signals** (3-5 specific indicators)
|
- **Evidence and Signals** (3-5 specific indicators)
|
||||||
- **Timeline** (When mainstream adoption expected)
|
- **Timeline** (When mainstream adoption expected)
|
||||||
- **Impact Assessment** (Market size, disruption potential)
|
- **Impact Assessment** (Market size, disruption potential)
|
||||||
- **Opportunities** (How to capitalize)
|
- **Opportunities** (How to capitalize)
|
||||||
|
|||||||
@@ -62,7 +62,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Complete Research Prompt (Copy & Paste)
|
## Complete Research Prompt (Copy and Paste)
|
||||||
|
|
||||||
```
|
```
|
||||||
{{deep_research_prompt}}
|
{{deep_research_prompt}}
|
||||||
|
|||||||
@@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 1. Research Objectives & Methodology
|
## 1. Research Objectives and Methodology
|
||||||
|
|
||||||
### Research Objectives
|
### Research Objectives
|
||||||
|
|
||||||
|
|||||||
@@ -147,3 +147,17 @@ data_sources:
|
|||||||
- "Social media and communities"
|
- "Social media and communities"
|
||||||
- "Patent databases"
|
- "Patent databases"
|
||||||
- "Benchmarking studies"
|
- "Benchmarking studies"
|
||||||
|
|
||||||
|
web_bundle:
|
||||||
|
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"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/instructions-router.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/instructions-market.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/instructions-technical.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/template-market.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/template-technical.md"
|
||||||
|
- "bmad/bmm/workflows/1-analysis/research/checklist.md"
|
||||||
|
|||||||
@@ -193,7 +193,7 @@ To customize this workflow:
|
|||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|
||||||
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
|
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||||
- Validate output using `checklist.md`
|
- Validate output using `checklist.md`
|
||||||
- Consult project assessment in `project-workflow-analysis.md`
|
- Consult project assessment in `project-workflow-analysis.md`
|
||||||
- Check continuation status in existing output documents
|
- Check continuation status in existing output documents
|
||||||
|
|||||||
@@ -20,12 +20,12 @@ The GDD workflow creates a comprehensive Game Design Document that captures:
|
|||||||
`gdd-template.md` contains sections common to ALL game types:
|
`gdd-template.md` contains sections common to ALL game types:
|
||||||
|
|
||||||
- Executive Summary
|
- Executive Summary
|
||||||
- Goals & Context
|
- Goals and Context
|
||||||
- Core Gameplay
|
- Core Gameplay
|
||||||
- Win/Loss Conditions
|
- Win/Loss Conditions
|
||||||
- Progression & Balance
|
- Progression and Balance
|
||||||
- Level Design Framework
|
- Level Design Framework
|
||||||
- Art & Audio Direction
|
- Art and Audio Direction
|
||||||
- Technical Specs
|
- Technical Specs
|
||||||
- Development Epics
|
- Development Epics
|
||||||
- Success Metrics
|
- Success Metrics
|
||||||
@@ -53,15 +53,15 @@ Located in `game-types/` folder, these markdown files contain sections specific
|
|||||||
- Movement System (jump mechanics, air control, special moves)
|
- Movement System (jump mechanics, air control, special moves)
|
||||||
- Combat System (attack types, combos, enemy AI)
|
- Combat System (attack types, combos, enemy AI)
|
||||||
- Level Design Patterns (platforming challenges, combat arenas)
|
- Level Design Patterns (platforming challenges, combat arenas)
|
||||||
- Player Abilities & Unlocks
|
- Player Abilities and Unlocks
|
||||||
|
|
||||||
**rpg.md**:
|
**rpg.md**:
|
||||||
|
|
||||||
- Character System (stats, classes, leveling)
|
- Character System (stats, classes, leveling)
|
||||||
- Inventory & Equipment
|
- Inventory and Equipment
|
||||||
- Quest System
|
- Quest System
|
||||||
- World & Exploration
|
- World and Exploration
|
||||||
- NPC & Dialogue
|
- NPC and Dialogue
|
||||||
- Combat System
|
- Combat System
|
||||||
|
|
||||||
**puzzle.md**:
|
**puzzle.md**:
|
||||||
@@ -76,8 +76,8 @@ Located in `game-types/` folder, these markdown files contain sections specific
|
|||||||
|
|
||||||
- Run Structure
|
- Run Structure
|
||||||
- Procedural Generation
|
- Procedural Generation
|
||||||
- Permadeath & Progression
|
- Permadeath and Progression
|
||||||
- Item & Upgrade System
|
- Item and Upgrade System
|
||||||
- Character Selection
|
- Character Selection
|
||||||
- Difficulty Modifiers
|
- Difficulty Modifiers
|
||||||
|
|
||||||
@@ -98,15 +98,15 @@ Located in `game-types/` folder, these markdown files contain sections specific
|
|||||||
- Stores `game_type` for injection
|
- Stores `game_type` for injection
|
||||||
|
|
||||||
3. **Universal GDD Sections** (Steps 2-5, 7-13):
|
3. **Universal GDD Sections** (Steps 2-5, 7-13):
|
||||||
- Platform & target audience
|
- Platform and target audience
|
||||||
- Goals & context
|
- Goals and context
|
||||||
- Core gameplay (pillars, loop, win/loss)
|
- Core gameplay (pillars, loop, win/loss)
|
||||||
- Mechanics & controls
|
- Mechanics and controls
|
||||||
- Progression & balance
|
- Progression and balance
|
||||||
- Level design
|
- Level design
|
||||||
- Art & audio
|
- Art and audio
|
||||||
- Technical specs
|
- Technical specs
|
||||||
- Epics & metrics
|
- Epics and metrics
|
||||||
|
|
||||||
4. **Game-Type Injection** (Step 6):
|
4. **Game-Type Injection** (Step 6):
|
||||||
- Loads fragment from `game-types/{game_type}.md`
|
- Loads fragment from `game-types/{game_type}.md`
|
||||||
|
|||||||
@@ -33,7 +33,7 @@
|
|||||||
- Checkpoint placement
|
- Checkpoint placement
|
||||||
- Difficulty spikes and pacing
|
- Difficulty spikes and pacing
|
||||||
|
|
||||||
### Player Abilities & Unlocks
|
### Player Abilities and Unlocks
|
||||||
|
|
||||||
{{player_abilities}}
|
{{player_abilities}}
|
||||||
|
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ This game type is **narrative-heavy**. Consider running the Narrative Design wor
|
|||||||
- Companion mechanics (if applicable)
|
- Companion mechanics (if applicable)
|
||||||
- Memorable character moments
|
- Memorable character moments
|
||||||
|
|
||||||
### Inventory & Items
|
### Inventory and Items
|
||||||
|
|
||||||
{{inventory_items}}
|
{{inventory_items}}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
## Card Game Specific Elements
|
## Card Game Specific Elements
|
||||||
|
|
||||||
### Card Types & Effects
|
### Card Types and Effects
|
||||||
|
|
||||||
{{card_types}}
|
{{card_types}}
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@
|
|||||||
- Time limits per turn
|
- Time limits per turn
|
||||||
- Match length targets
|
- Match length targets
|
||||||
|
|
||||||
### Card Collection & Progression
|
### Card Collection and Progression
|
||||||
|
|
||||||
{{collection_progression}}
|
{{collection_progression}}
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
- Complexity tiers (beginner vs. expert characters)
|
- Complexity tiers (beginner vs. expert characters)
|
||||||
- Balance philosophy (everyone viable vs. tier system)
|
- Balance philosophy (everyone viable vs. tier system)
|
||||||
|
|
||||||
### Move Lists & Frame Data
|
### Move Lists and Frame Data
|
||||||
|
|
||||||
{{moves_frame_data}}
|
{{moves_frame_data}}
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ This game type is **narrative-important**. Consider running the Narrative Design
|
|||||||
- Tension pacing and narrative beats
|
- Tension pacing and narrative beats
|
||||||
</narrative-workflow-recommended>
|
</narrative-workflow-recommended>
|
||||||
|
|
||||||
### Atmosphere & Tension Building
|
### Atmosphere and Tension Building
|
||||||
|
|
||||||
{{atmosphere}}
|
{{atmosphere}}
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ This game type is **narrative-important**. Consider running the Narrative Design
|
|||||||
- Inventory constraints
|
- Inventory constraints
|
||||||
- Risk vs. reward of exploration
|
- Risk vs. reward of exploration
|
||||||
|
|
||||||
### Safe Zones & Respite
|
### Safe Zones and Respite
|
||||||
|
|
||||||
{{safe_zones}}
|
{{safe_zones}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@
|
|||||||
- Automation tiers
|
- Automation tiers
|
||||||
- Balance between active and idle play
|
- Balance between active and idle play
|
||||||
|
|
||||||
### Prestige & Reset Mechanics
|
### Prestige and Reset Mechanics
|
||||||
|
|
||||||
{{prestige_reset}}
|
{{prestige_reset}}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@
|
|||||||
- Visual and thematic diversity
|
- Visual and thematic diversity
|
||||||
- Counter-pick dynamics
|
- Counter-pick dynamics
|
||||||
|
|
||||||
### Lane Structure & Map
|
### Lane Structure and Map
|
||||||
|
|
||||||
{{lane_map}}
|
{{lane_map}}
|
||||||
|
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
- Spawn points and fountains
|
- Spawn points and fountains
|
||||||
- Vision mechanics (wards, fog of war)
|
- Vision mechanics (wards, fog of war)
|
||||||
|
|
||||||
### Item & Build System
|
### Item and Build System
|
||||||
|
|
||||||
{{item_build}}
|
{{item_build}}
|
||||||
|
|
||||||
@@ -37,7 +37,7 @@
|
|||||||
- Situational itemization
|
- Situational itemization
|
||||||
- Starting items vs. late-game items
|
- Starting items vs. late-game items
|
||||||
|
|
||||||
### Team Composition & Roles
|
### Team Composition and Roles
|
||||||
|
|
||||||
{{team_composition}}
|
{{team_composition}}
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@
|
|||||||
- Phase transition mechanics
|
- Phase transition mechanics
|
||||||
- Comeback mechanics
|
- Comeback mechanics
|
||||||
|
|
||||||
### Objectives & Win Conditions
|
### Objectives and Win Conditions
|
||||||
|
|
||||||
{{objectives_victory}}
|
{{objectives_victory}}
|
||||||
|
|
||||||
|
|||||||
@@ -52,7 +52,7 @@
|
|||||||
- Player join/drop mechanics
|
- Player join/drop mechanics
|
||||||
- Tutorial integration for new players
|
- Tutorial integration for new players
|
||||||
|
|
||||||
### Accessibility & Skill Range
|
### Accessibility and Skill Range
|
||||||
|
|
||||||
{{accessibility}}
|
{{accessibility}}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
## Racing Game Specific Elements
|
## Racing Game Specific Elements
|
||||||
|
|
||||||
### Vehicle Handling & Physics
|
### Vehicle Handling and Physics
|
||||||
|
|
||||||
{{vehicle_physics}}
|
{{vehicle_physics}}
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@
|
|||||||
- Pit stops (if applicable)
|
- Pit stops (if applicable)
|
||||||
- Weather and time-of-day effects
|
- Weather and time-of-day effects
|
||||||
|
|
||||||
### Powerups & Boost
|
### Powerups and Boost
|
||||||
|
|
||||||
{{powerups_boost}}
|
{{powerups_boost}}
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@
|
|||||||
- Career/campaign mode
|
- Career/campaign mode
|
||||||
- Online multiplayer modes
|
- Online multiplayer modes
|
||||||
|
|
||||||
### Progression & Unlocks
|
### Progression and Unlocks
|
||||||
|
|
||||||
{{progression}}
|
{{progression}}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@
|
|||||||
- Lane systems (4-key, 6-key, circular, etc.)
|
- Lane systems (4-key, 6-key, circular, etc.)
|
||||||
- Offset calibration
|
- Offset calibration
|
||||||
|
|
||||||
### Note Charts & Patterns
|
### Note Charts and Patterns
|
||||||
|
|
||||||
{{note_charts}}
|
{{note_charts}}
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@
|
|||||||
- Biome/theme variation
|
- Biome/theme variation
|
||||||
- Seed system (if deterministic)
|
- Seed system (if deterministic)
|
||||||
|
|
||||||
### Permadeath & Progression
|
### Permadeath and Progression
|
||||||
|
|
||||||
{{permadeath_progression}}
|
{{permadeath_progression}}
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@
|
|||||||
- Meta-progression systems
|
- Meta-progression systems
|
||||||
- Unlock conditions
|
- Unlock conditions
|
||||||
|
|
||||||
### Item & Upgrade System
|
### Item and Upgrade System
|
||||||
|
|
||||||
{{item_upgrade_system}}
|
{{item_upgrade_system}}
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
- Leveling system
|
- Leveling system
|
||||||
- Skill trees
|
- Skill trees
|
||||||
|
|
||||||
### Inventory & Equipment
|
### Inventory and Equipment
|
||||||
|
|
||||||
{{inventory_equipment}}
|
{{inventory_equipment}}
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@
|
|||||||
- Branching questlines
|
- Branching questlines
|
||||||
- Quest rewards
|
- Quest rewards
|
||||||
|
|
||||||
### World & Exploration
|
### World and Exploration
|
||||||
|
|
||||||
{{world_exploration}}
|
{{world_exploration}}
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@
|
|||||||
- Fast travel system
|
- Fast travel system
|
||||||
- Points of interest
|
- Points of interest
|
||||||
|
|
||||||
### NPC & Dialogue
|
### NPC and Dialogue
|
||||||
|
|
||||||
{{npc_dialogue}}
|
{{npc_dialogue}}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@
|
|||||||
- Undo/redo system
|
- Undo/redo system
|
||||||
- Import/export functionality
|
- Import/export functionality
|
||||||
|
|
||||||
### Physics & Building Systems
|
### Physics and Building Systems
|
||||||
|
|
||||||
{{physics_building}}
|
{{physics_building}}
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@
|
|||||||
- Constraint systems (joints, hinges, motors)
|
- Constraint systems (joints, hinges, motors)
|
||||||
- Interactive simulations
|
- Interactive simulations
|
||||||
|
|
||||||
### Sharing & Community
|
### Sharing and Community
|
||||||
|
|
||||||
{{sharing_community}}
|
{{sharing_community}}
|
||||||
|
|
||||||
@@ -39,7 +39,7 @@
|
|||||||
- Modding support
|
- Modding support
|
||||||
- User-generated content moderation
|
- User-generated content moderation
|
||||||
|
|
||||||
### Constraints & Rules
|
### Constraints and Rules
|
||||||
|
|
||||||
{{constraints_rules}}
|
{{constraints_rules}}
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@
|
|||||||
- Rulesets and game modes
|
- Rulesets and game modes
|
||||||
- Victory conditions (if applicable)
|
- Victory conditions (if applicable)
|
||||||
|
|
||||||
### Tools & Editing
|
### Tools and Editing
|
||||||
|
|
||||||
{{tools_editing}}
|
{{tools_editing}}
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
- Weapon feel (recoil patterns, sound design, impact feedback)
|
- Weapon feel (recoil patterns, sound design, impact feedback)
|
||||||
- Balance considerations (risk/reward, situational use)
|
- Balance considerations (risk/reward, situational use)
|
||||||
|
|
||||||
### Aiming & Combat Mechanics
|
### Aiming and Combat Mechanics
|
||||||
|
|
||||||
{{aiming_combat}}
|
{{aiming_combat}}
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@
|
|||||||
- Critical hits / weak points
|
- Critical hits / weak points
|
||||||
- Melee integration (if applicable)
|
- Melee integration (if applicable)
|
||||||
|
|
||||||
### Enemy Design & AI
|
### Enemy Design and AI
|
||||||
|
|
||||||
{{enemy_ai}}
|
{{enemy_ai}}
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@
|
|||||||
- Difficulty scaling (health, damage, AI sophistication)
|
- Difficulty scaling (health, damage, AI sophistication)
|
||||||
- Enemy tells and telegraphing
|
- Enemy tells and telegraphing
|
||||||
|
|
||||||
### Arena & Level Design
|
### Arena and Level Design
|
||||||
|
|
||||||
{{arena_level_design}}
|
{{arena_level_design}}
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@
|
|||||||
- Delegation systems (if applicable)
|
- Delegation systems (if applicable)
|
||||||
- Efficiency optimization
|
- Efficiency optimization
|
||||||
|
|
||||||
### Building & Construction
|
### Building and Construction
|
||||||
|
|
||||||
{{building_construction}}
|
{{building_construction}}
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@
|
|||||||
- Upgrade/demolition mechanics
|
- Upgrade/demolition mechanics
|
||||||
- Space constraints and planning
|
- Space constraints and planning
|
||||||
|
|
||||||
### Economic & Resource Loops
|
### Economic and Resource Loops
|
||||||
|
|
||||||
{{economic_loops}}
|
{{economic_loops}}
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@
|
|||||||
- Market dynamics
|
- Market dynamics
|
||||||
- Economic balance and pacing
|
- Economic balance and pacing
|
||||||
|
|
||||||
### Progression & Unlocks
|
### Progression and Unlocks
|
||||||
|
|
||||||
{{progression_unlocks}}
|
{{progression_unlocks}}
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
- Rule variations (if applicable)
|
- Rule variations (if applicable)
|
||||||
- Simulation vs. arcade rule adherence
|
- Simulation vs. arcade rule adherence
|
||||||
|
|
||||||
### Team & Player Systems
|
### Team and Player Systems
|
||||||
|
|
||||||
{{team_player}}
|
{{team_player}}
|
||||||
|
|
||||||
@@ -37,7 +37,7 @@
|
|||||||
- Overtime/extra time rules
|
- Overtime/extra time rules
|
||||||
- Post-match results and stats
|
- Post-match results and stats
|
||||||
|
|
||||||
### Physics & Realism
|
### Physics and Realism
|
||||||
|
|
||||||
{{physics_realism}}
|
{{physics_realism}}
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@
|
|||||||
- Collision detection
|
- Collision detection
|
||||||
- Weather/field condition effects
|
- Weather/field condition effects
|
||||||
|
|
||||||
### Career & Season Modes
|
### Career and Season Modes
|
||||||
|
|
||||||
{{career_season}}
|
{{career_season}}
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
- Economic balance (income vs. expenses)
|
- Economic balance (income vs. expenses)
|
||||||
- Scarcity and strategic choices
|
- Scarcity and strategic choices
|
||||||
|
|
||||||
### Unit Types & Stats
|
### Unit Types and Stats
|
||||||
|
|
||||||
{{unit_types}}
|
{{unit_types}}
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@
|
|||||||
- Counter systems (rock-paper-scissors dynamics)
|
- Counter systems (rock-paper-scissors dynamics)
|
||||||
- Unit production (cost, build time, prerequisites)
|
- Unit production (cost, build time, prerequisites)
|
||||||
|
|
||||||
### Technology & Progression
|
### Technology and Progression
|
||||||
|
|
||||||
{{tech_progression}}
|
{{tech_progression}}
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@
|
|||||||
- Upgrade paths (unit upgrades, building improvements)
|
- Upgrade paths (unit upgrades, building improvements)
|
||||||
- Unlock conditions (progression gates, achievements)
|
- Unlock conditions (progression gates, achievements)
|
||||||
|
|
||||||
### Map & Terrain
|
### Map and Terrain
|
||||||
|
|
||||||
{{map_terrain}}
|
{{map_terrain}}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
## Survival Game Specific Elements
|
## Survival Game Specific Elements
|
||||||
|
|
||||||
### Resource Gathering & Crafting
|
### Resource Gathering and Crafting
|
||||||
|
|
||||||
{{resource_crafting}}
|
{{resource_crafting}}
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@
|
|||||||
- Defensive structures
|
- Defensive structures
|
||||||
- Automation (if applicable)
|
- Automation (if applicable)
|
||||||
|
|
||||||
### Progression & Technology
|
### Progression and Technology
|
||||||
|
|
||||||
{{progression_tech}}
|
{{progression_tech}}
|
||||||
|
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ This game type is **narrative-critical**. You MUST run the Narrative Design work
|
|||||||
- Landmarks and navigation aids
|
- Landmarks and navigation aids
|
||||||
- Fast travel or mapping system
|
- Fast travel or mapping system
|
||||||
|
|
||||||
### Item & Inventory System
|
### Item and Inventory System
|
||||||
|
|
||||||
{{item_inventory}}
|
{{item_inventory}}
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ This game type is **narrative-critical**. You MUST run the Narrative Design work
|
|||||||
- Puzzle integration with story
|
- Puzzle integration with story
|
||||||
- Non-linear puzzle solving
|
- Non-linear puzzle solving
|
||||||
|
|
||||||
### Narrative & Writing
|
### Narrative and Writing
|
||||||
|
|
||||||
{{narrative_writing}}
|
{{narrative_writing}}
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ This game type is **narrative-critical**. You MUST run the Narrative Design work
|
|||||||
|
|
||||||
**Note:** All narrative content must be written in the Narrative Design Document.
|
**Note:** All narrative content must be written in the Narrative Design Document.
|
||||||
|
|
||||||
### Game Flow & Pacing
|
### Game Flow and Pacing
|
||||||
|
|
||||||
{{game_flow}}
|
{{game_flow}}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
## Tower Defense Specific Elements
|
## Tower Defense Specific Elements
|
||||||
|
|
||||||
### Tower Types & Upgrades
|
### Tower Types and Upgrades
|
||||||
|
|
||||||
{{tower_types}}
|
{{tower_types}}
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@
|
|||||||
- Boss encounters
|
- Boss encounters
|
||||||
- Endless mode scaling (if applicable)
|
- Endless mode scaling (if applicable)
|
||||||
|
|
||||||
### Path & Placement Strategy
|
### Path and Placement Strategy
|
||||||
|
|
||||||
{{path_placement}}
|
{{path_placement}}
|
||||||
|
|
||||||
@@ -39,7 +39,7 @@
|
|||||||
- Multiple paths (if applicable)
|
- Multiple paths (if applicable)
|
||||||
- Line of sight and range visualization
|
- Line of sight and range visualization
|
||||||
|
|
||||||
### Economy & Resources
|
### Economy and Resources
|
||||||
|
|
||||||
{{economy}}
|
{{economy}}
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@
|
|||||||
- Special currencies (if applicable)
|
- Special currencies (if applicable)
|
||||||
- Economic optimization strategies
|
- Economic optimization strategies
|
||||||
|
|
||||||
### Abilities & Powers
|
### Abilities and Powers
|
||||||
|
|
||||||
{{abilities_powers}}
|
{{abilities_powers}}
|
||||||
|
|
||||||
@@ -65,7 +65,7 @@
|
|||||||
- Strategic timing
|
- Strategic timing
|
||||||
- Resource cost vs. cooldown
|
- Resource cost vs. cooldown
|
||||||
|
|
||||||
### Difficulty & Replayability
|
### Difficulty and Replayability
|
||||||
|
|
||||||
{{difficulty_replay}}
|
{{difficulty_replay}}
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ This game type is **narrative-moderate to heavy**. Consider running the Narrativ
|
|||||||
- Mission narratives
|
- Mission narratives
|
||||||
</narrative-workflow-recommended>
|
</narrative-workflow-recommended>
|
||||||
|
|
||||||
### Grid System & Movement
|
### Grid System and Movement
|
||||||
|
|
||||||
{{grid_movement}}
|
{{grid_movement}}
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ This game type is **narrative-moderate to heavy**. Consider running the Narrativ
|
|||||||
- Zone of control
|
- Zone of control
|
||||||
- Pathfinding visualization
|
- Pathfinding visualization
|
||||||
|
|
||||||
### Unit Types & Classes
|
### Unit Types and Classes
|
||||||
|
|
||||||
{{unit_classes}}
|
{{unit_classes}}
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ This game type is **narrative-moderate to heavy**. Consider running the Narrativ
|
|||||||
- Turn order (initiative, simultaneous, alternating)
|
- Turn order (initiative, simultaneous, alternating)
|
||||||
- Time limits per turn (if applicable)
|
- Time limits per turn (if applicable)
|
||||||
|
|
||||||
### Positioning & Tactics
|
### Positioning and Tactics
|
||||||
|
|
||||||
{{positioning_tactics}}
|
{{positioning_tactics}}
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ This game type is **narrative-moderate to heavy**. Consider running the Narrativ
|
|||||||
- Chokepoint tactics
|
- Chokepoint tactics
|
||||||
- Line of sight and vision
|
- Line of sight and vision
|
||||||
|
|
||||||
### Terrain & Environmental Effects
|
### Terrain and Environmental Effects
|
||||||
|
|
||||||
{{terrain_effects}}
|
{{terrain_effects}}
|
||||||
|
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ This game type is **narrative-critical**. You MUST run the Narrative Design work
|
|||||||
- Multiple romance options (if applicable)
|
- Multiple romance options (if applicable)
|
||||||
- Platonic vs. romantic paths
|
- Platonic vs. romantic paths
|
||||||
|
|
||||||
### Save/Load & Flowchart
|
### Save/Load and Flowchart
|
||||||
|
|
||||||
{{save_flowchart}}
|
{{save_flowchart}}
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@
|
|||||||
|
|
||||||
{{goals}}
|
{{goals}}
|
||||||
|
|
||||||
### Background & Rationale
|
### Background and Rationale
|
||||||
|
|
||||||
{{context}}
|
{{context}}
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@
|
|||||||
|
|
||||||
{{primary_mechanics}}
|
{{primary_mechanics}}
|
||||||
|
|
||||||
### Controls & Input
|
### Controls and Input
|
||||||
|
|
||||||
{{controls}}
|
{{controls}}
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Progression & Balance
|
## Progression and Balance
|
||||||
|
|
||||||
### Player Progression
|
### Player Progression
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@
|
|||||||
|
|
||||||
{{difficulty_curve}}
|
{{difficulty_curve}}
|
||||||
|
|
||||||
### Economy & Resources
|
### Economy and Resources
|
||||||
|
|
||||||
{{economy_resources}}
|
{{economy_resources}}
|
||||||
|
|
||||||
@@ -94,13 +94,13 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Art & Audio Direction
|
## Art and Audio Direction
|
||||||
|
|
||||||
### Art Style
|
### Art Style
|
||||||
|
|
||||||
{{art_style}}
|
{{art_style}}
|
||||||
|
|
||||||
### Audio & Music
|
### Audio and Music
|
||||||
|
|
||||||
{{audio_music}}
|
{{audio_music}}
|
||||||
|
|
||||||
|
|||||||
@@ -407,7 +407,7 @@ Since this is a Level {{project_level}} game project, you need solutioning for p
|
|||||||
|
|
||||||
<action>Generate comprehensive checklist based on project analysis</action>
|
<action>Generate comprehensive checklist based on project analysis</action>
|
||||||
|
|
||||||
### Phase 1: Solution Architecture & Engine Selection
|
### Phase 1: Solution Architecture and Engine Selection
|
||||||
|
|
||||||
- [ ] **Run solutioning workflow** (REQUIRED)
|
- [ ] **Run solutioning workflow** (REQUIRED)
|
||||||
- Command: `workflow solution-architecture`
|
- Command: `workflow solution-architecture`
|
||||||
@@ -415,7 +415,7 @@ Since this is a Level {{project_level}} game project, you need solutioning for p
|
|||||||
- Output: solution-architecture.md with engine/platform specifics
|
- Output: solution-architecture.md with engine/platform specifics
|
||||||
- Note: Registry.csv will provide engine-specific guidance
|
- Note: Registry.csv will provide engine-specific guidance
|
||||||
|
|
||||||
### Phase 2: Prototype & Playtesting
|
### Phase 2: Prototype and Playtesting
|
||||||
|
|
||||||
- [ ] **Create core mechanic prototype**
|
- [ ] **Create core mechanic prototype**
|
||||||
- Validate game feel
|
- Validate game feel
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
|
|
||||||
{{core_themes}}
|
{{core_themes}}
|
||||||
|
|
||||||
### Tone & Atmosphere
|
### Tone and Atmosphere
|
||||||
|
|
||||||
{{tone_atmosphere}}
|
{{tone_atmosphere}}
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@
|
|||||||
|
|
||||||
{{story_beats}}
|
{{story_beats}}
|
||||||
|
|
||||||
### Pacing & Flow
|
### Pacing and Flow
|
||||||
|
|
||||||
{{pacing_flow}}
|
{{pacing_flow}}
|
||||||
|
|
||||||
@@ -64,17 +64,17 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## World & Lore
|
## World and Lore
|
||||||
|
|
||||||
### World Overview
|
### World Overview
|
||||||
|
|
||||||
{{world_overview}}
|
{{world_overview}}
|
||||||
|
|
||||||
### History & Backstory
|
### History and Backstory
|
||||||
|
|
||||||
{{history_backstory}}
|
{{history_backstory}}
|
||||||
|
|
||||||
### Factions & Organizations
|
### Factions and Organizations
|
||||||
|
|
||||||
{{factions_organizations}}
|
{{factions_organizations}}
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@
|
|||||||
|
|
||||||
{{branching_dialogue}}
|
{{branching_dialogue}}
|
||||||
|
|
||||||
### Voice & Characterization
|
### Voice and Characterization
|
||||||
|
|
||||||
{{voice_characterization}}
|
{{voice_characterization}}
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@
|
|||||||
|
|
||||||
## Narrative Delivery
|
## Narrative Delivery
|
||||||
|
|
||||||
### Cutscenes & Cinematics
|
### Cutscenes and Cinematics
|
||||||
|
|
||||||
{{cutscenes}}
|
{{cutscenes}}
|
||||||
|
|
||||||
@@ -190,6 +190,6 @@
|
|||||||
|
|
||||||
{{timeline}}
|
{{timeline}}
|
||||||
|
|
||||||
### References & Inspirations
|
### References and Inspirations
|
||||||
|
|
||||||
{{references}}
|
{{references}}
|
||||||
|
|||||||
@@ -193,7 +193,7 @@ Since this is a Level {{project_level}} project, you need architecture before st
|
|||||||
|
|
||||||
<action>Generate comprehensive checklist based on project analysis</action>
|
<action>Generate comprehensive checklist based on project analysis</action>
|
||||||
|
|
||||||
### Phase 1: Architecture & Design
|
### Phase 1: Architecture and Design
|
||||||
|
|
||||||
- [ ] **Run architecture workflow** (REQUIRED)
|
- [ ] **Run architecture workflow** (REQUIRED)
|
||||||
- Command: `workflow architecture`
|
- Command: `workflow architecture`
|
||||||
@@ -239,7 +239,7 @@ Since this is a Level {{project_level}} project, you need architecture before st
|
|||||||
- Sprint boundaries
|
- Sprint boundaries
|
||||||
- Resource allocation
|
- Resource allocation
|
||||||
|
|
||||||
- [ ] **Establish monitoring & metrics**
|
- [ ] **Establish monitoring and metrics**
|
||||||
- Success metrics from PRD
|
- Success metrics from PRD
|
||||||
- Technical monitoring
|
- Technical monitoring
|
||||||
- User analytics
|
- User analytics
|
||||||
|
|||||||
@@ -187,7 +187,7 @@ Since this is a Level {{project_level}} project, you need solutioning before imp
|
|||||||
|
|
||||||
<action>Generate comprehensive checklist based on project analysis</action>
|
<action>Generate comprehensive checklist based on project analysis</action>
|
||||||
|
|
||||||
### Phase 1: Solution Architecture & Design
|
### Phase 1: Solution Architecture and Design
|
||||||
|
|
||||||
- [ ] **Run solutioning workflow** (REQUIRED)
|
- [ ] **Run solutioning workflow** (REQUIRED)
|
||||||
- Command: `workflow solution-architecture`
|
- Command: `workflow solution-architecture`
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ _Generated on {{date}} by {{user_name}}_
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 1. UX Goals & Principles
|
## 1. UX Goals and Principles
|
||||||
|
|
||||||
### 1.1 Target User Personas
|
### 1.1 Target User Personas
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ _Generated on {{date}} by {{user_name}}_
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 4. Component Library & Design System
|
## 4. Component Library and Design System
|
||||||
|
|
||||||
### 4.1 Design System Approach
|
### 4.1 Design System Approach
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ _Generated on {{date}} by {{user_name}}_
|
|||||||
**Type Scale:**
|
**Type Scale:**
|
||||||
{{type_scale}}
|
{{type_scale}}
|
||||||
|
|
||||||
### 5.3 Spacing & Layout
|
### 5.3 Spacing and Layout
|
||||||
|
|
||||||
{{spacing_layout}}
|
{{spacing_layout}}
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ _Generated on {{date}} by {{user_name}}_
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 8. Interaction & Motion
|
## 8. Interaction and Motion
|
||||||
|
|
||||||
### 8.1 Motion Principles
|
### 8.1 Motion Principles
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ _Generated on {{date}} by {{user_name}}_
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 9. Design Files & Wireframes
|
## 9. Design Files and Wireframes
|
||||||
|
|
||||||
### 9.1 Design Files
|
### 9.1 Design Files
|
||||||
|
|
||||||
|
|||||||
@@ -58,3 +58,50 @@ instructions_ux: "{installed_path}/ux/instructions-ux.md"
|
|||||||
instructions_gdd: "{installed_path}/gdd/instructions-gdd.md"
|
instructions_gdd: "{installed_path}/gdd/instructions-gdd.md"
|
||||||
instructions_narrative: "{installed_path}/narrative/instructions-narrative.md"
|
instructions_narrative: "{installed_path}/narrative/instructions-narrative.md"
|
||||||
validation: "{installed_path}/checklist.md"
|
validation: "{installed_path}/checklist.md"
|
||||||
|
|
||||||
|
web_bundle:
|
||||||
|
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"
|
||||||
|
web_bundle_files:
|
||||||
|
- "bmad/bmm/workflows/2-plan/instructions-router.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/tech-spec/instructions-sm.md"
|
||||||
|
- "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"
|
||||||
|
- "bmad/bmm/workflows/2-plan/tech-spec/tech-spec-template.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/ux/ux-spec-template.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/ux/instructions-ux.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/gdd/gdd-template.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/gdd/instructions-gdd.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/gdd/instructions-narrative.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"
|
||||||
|
- "bmad/bmm/workflows/2-plan/narrative/narrative-template.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/narrative/instructions-narrative.md"
|
||||||
|
- "bmad/bmm/workflows/2-plan/checklist.md"
|
||||||
|
|||||||
@@ -69,7 +69,7 @@ workflow solution-architecture
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Project Types & Templates
|
## Project Types and Templates
|
||||||
|
|
||||||
### 12 Project Types Supported
|
### 12 Project Types Supported
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ Each row maps to:
|
|||||||
|
|
||||||
## Architecture Flow
|
## Architecture Flow
|
||||||
|
|
||||||
### Step 0: Prerequisites & Scale Check
|
### Step 0: Prerequisites and Scale Check
|
||||||
|
|
||||||
Load `project-workflow-analysis.md`:
|
Load `project-workflow-analysis.md`:
|
||||||
|
|
||||||
@@ -234,7 +234,7 @@ Validate architecture quality:
|
|||||||
├── instructions.md # Main workflow logic
|
├── instructions.md # Main workflow logic
|
||||||
├── checklist.md # Validation checklist
|
├── checklist.md # Validation checklist
|
||||||
├── ADR-template.md # ADR document template
|
├── ADR-template.md # ADR document template
|
||||||
├── templates/ # Architecture templates & guides
|
├── templates/ # Architecture templates and guides
|
||||||
│ ├── registry.csv # 171 tech combinations → templates
|
│ ├── registry.csv # 171 tech combinations → templates
|
||||||
│ ├── game-engine-architecture.md # Complete game architecture doc
|
│ ├── game-engine-architecture.md # Complete game architecture doc
|
||||||
│ ├── game-engine-unity-guide.md # Unity-specific guidance
|
│ ├── game-engine-unity-guide.md # Unity-specific guidance
|
||||||
@@ -250,7 +250,7 @@ Validate architecture quality:
|
|||||||
│ ├── desktop-app-architecture.md
|
│ ├── desktop-app-architecture.md
|
||||||
│ ├── library-package-architecture.md
|
│ ├── library-package-architecture.md
|
||||||
│ └── infrastructure-architecture.md
|
│ └── infrastructure-architecture.md
|
||||||
└── project-types/ # Project type detection & questions
|
└── project-types/ # Project type detection and questions
|
||||||
├── project-types.csv # 12 project types + detection keywords
|
├── project-types.csv # 12 project types + detection keywords
|
||||||
├── game-questions.md
|
├── game-questions.md
|
||||||
├── web-questions.md
|
├── web-questions.md
|
||||||
@@ -269,17 +269,17 @@ Each template in `templates/` is a **complete** architecture document structure:
|
|||||||
**Standard Sections (all templates):**
|
**Standard Sections (all templates):**
|
||||||
|
|
||||||
1. Executive Summary
|
1. Executive Summary
|
||||||
2. Technology Stack & Decisions (required table)
|
2. Technology Stack and Decisions (required table)
|
||||||
3. Architecture Overview
|
3. Architecture Overview
|
||||||
4. Repository & Service Strategy
|
4. Repository and Service Strategy
|
||||||
5. Data Architecture
|
5. Data Architecture
|
||||||
6. Component & Integration Overview
|
6. Component and Integration Overview
|
||||||
7-N. **Pattern-Specific Sections** (varies by template)
|
7-N. **Pattern-Specific Sections** (varies by template)
|
||||||
N+1. Proposed Source Tree
|
N+1. Proposed Source Tree
|
||||||
N+2. Getting Started (Human Setup)
|
N+2. Getting Started (Human Setup)
|
||||||
N+3. Implementation Patterns & Conventions (Agent Guidance)
|
N+3. Implementation Patterns and Conventions (Agent Guidance)
|
||||||
N+4. Testing Strategy
|
N+4. Testing Strategy
|
||||||
N+5. Deployment & Operations
|
N+5. Deployment and Operations
|
||||||
N+6. Security
|
N+6. Security
|
||||||
N+7. Specialist Sections
|
N+7. Specialist Sections
|
||||||
|
|
||||||
@@ -472,7 +472,7 @@ Specialists are documented with:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Validation & Quality Gates
|
## Validation and Quality Gates
|
||||||
|
|
||||||
### Cohesion Check (Step 7)
|
### Cohesion Check (Step 7)
|
||||||
|
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ Use this checklist during workflow execution and review.
|
|||||||
- [ ] Template sections determined dynamically
|
- [ ] Template sections determined dynamically
|
||||||
- [ ] User approved section list
|
- [ ] User approved section list
|
||||||
- [ ] architecture.md generated with ALL sections
|
- [ ] architecture.md generated with ALL sections
|
||||||
- [ ] Technology & Library Decision Table included with specific versions
|
- [ ] Technology and Library Decision Table included with specific versions
|
||||||
- [ ] Proposed Source Tree included
|
- [ ] Proposed Source Tree included
|
||||||
- [ ] Design-level only (no extensive code)
|
- [ ] Design-level only (no extensive code)
|
||||||
- [ ] Output adapted to user skill level
|
- [ ] Output adapted to user skill level
|
||||||
@@ -103,7 +103,7 @@ Use this checklist during workflow execution and review.
|
|||||||
|
|
||||||
## Quality Gates
|
## Quality Gates
|
||||||
|
|
||||||
### Technology & Library Decision Table
|
### Technology and Library Decision Table
|
||||||
|
|
||||||
- [ ] Table exists in architecture.md
|
- [ ] Table exists in architecture.md
|
||||||
- [ ] ALL technologies have specific versions (e.g., "pino 8.17.0")
|
- [ ] ALL technologies have specific versions (e.g., "pino 8.17.0")
|
||||||
|
|||||||
@@ -371,7 +371,7 @@ Sub-step 6.2: Fill Template Placeholders
|
|||||||
8. Generate final architecture.md document
|
8. Generate final architecture.md document
|
||||||
|
|
||||||
CRITICAL REQUIREMENTS:
|
CRITICAL REQUIREMENTS:
|
||||||
- MUST include "Technology & Library Decisions" section with table:
|
- MUST include "Technology and Library Decisions" section with table:
|
||||||
| Category | Technology | Version | Rationale |
|
| Category | Technology | Version | Rationale |
|
||||||
- ALL technologies with SPECIFIC versions (e.g., "pino 8.17.0")
|
- ALL technologies with SPECIFIC versions (e.g., "pino 8.17.0")
|
||||||
- NO vagueness ("a logging library" = FAIL)
|
- NO vagueness ("a logging library" = FAIL)
|
||||||
@@ -391,13 +391,13 @@ CRITICAL REQUIREMENTS:
|
|||||||
|
|
||||||
Common sections (adapt per project):
|
Common sections (adapt per project):
|
||||||
1. Executive Summary
|
1. Executive Summary
|
||||||
2. Technology Stack & Decisions (TABLE REQUIRED)
|
2. Technology Stack and Decisions (TABLE REQUIRED)
|
||||||
3. Repository & Service Architecture (mono/poly, monolith/microservices)
|
3. Repository and Service Architecture (mono/poly, monolith/microservices)
|
||||||
4. System Architecture (diagrams)
|
4. System Architecture (diagrams)
|
||||||
5. Data Architecture
|
5. Data Architecture
|
||||||
6. API/Interface Design (adapts: REST for web, protocols for embedded, etc.)
|
6. API/Interface Design (adapts: REST for web, protocols for embedded, etc.)
|
||||||
7. Cross-Cutting Concerns
|
7. Cross-Cutting Concerns
|
||||||
8. Component & Integration Overview (NOT epic alignment - that's cohesion check)
|
8. Component and Integration Overview (NOT epic alignment - that's cohesion check)
|
||||||
9. Architecture Decision Records
|
9. Architecture Decision Records
|
||||||
10. Implementation Guidance
|
10. Implementation Guidance
|
||||||
11. Proposed Source Tree (REQUIRED)
|
11. Proposed Source Tree (REQUIRED)
|
||||||
@@ -421,7 +421,7 @@ Run cohesion check validation inline (NO separate workflow for now):
|
|||||||
- Every epic has technical foundation?
|
- Every epic has technical foundation?
|
||||||
- Every story can be implemented with current architecture?
|
- Every story can be implemented with current architecture?
|
||||||
|
|
||||||
2. Technology & Library Table Validation:
|
2. Technology and Library Table Validation:
|
||||||
- Table exists?
|
- Table exists?
|
||||||
- All entries have specific versions?
|
- All entries have specific versions?
|
||||||
- No vague entries ("a library", "some framework")?
|
- No vague entries ("a library", "some framework")?
|
||||||
@@ -622,7 +622,7 @@ For monorepo projects:
|
|||||||
Final validation checklist:
|
Final validation checklist:
|
||||||
|
|
||||||
- [x] architecture.md exists and is complete
|
- [x] architecture.md exists and is complete
|
||||||
- [x] Technology & Library Decision Table has specific versions
|
- [x] Technology and Library Decision Table has specific versions
|
||||||
- [x] Proposed Source Tree section included
|
- [x] Proposed Source Tree section included
|
||||||
- [x] Cohesion check passed (or issues addressed)
|
- [x] Cohesion check passed (or issues addressed)
|
||||||
- [x] Epic Alignment Matrix generated
|
- [x] Epic Alignment Matrix generated
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Backend/API Service Architecture Questions
|
# Backend/API Service Architecture Questions
|
||||||
|
|
||||||
## Service Type & Architecture
|
## Service Type and Architecture
|
||||||
|
|
||||||
1. **Service architecture:**
|
1. **Service architecture:**
|
||||||
- Monolithic API (single service)
|
- Monolithic API (single service)
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
- Webhooks
|
- Webhooks
|
||||||
- Multiple patterns
|
- Multiple patterns
|
||||||
|
|
||||||
## Framework & Language
|
## Framework and Language
|
||||||
|
|
||||||
4. **Backend language/framework:**
|
4. **Backend language/framework:**
|
||||||
- Node.js (Express, Fastify, NestJS, Hono)
|
- Node.js (Express, Fastify, NestJS, Hono)
|
||||||
@@ -52,7 +52,7 @@
|
|||||||
- Language-specific gRPC libraries
|
- Language-specific gRPC libraries
|
||||||
- Not using gRPC
|
- Not using gRPC
|
||||||
|
|
||||||
## Database & Data Layer
|
## Database and Data Layer
|
||||||
|
|
||||||
7. **Primary database:**
|
7. **Primary database:**
|
||||||
- PostgreSQL
|
- PostgreSQL
|
||||||
@@ -91,7 +91,7 @@
|
|||||||
- No (single database)
|
- No (single database)
|
||||||
- Planned for scale
|
- Planned for scale
|
||||||
|
|
||||||
## Authentication & Authorization
|
## Authentication and Authorization
|
||||||
|
|
||||||
12. **Authentication method:**
|
12. **Authentication method:**
|
||||||
- JWT (stateless)
|
- JWT (stateless)
|
||||||
@@ -118,7 +118,7 @@
|
|||||||
- Okta
|
- Okta
|
||||||
- Other: **\_\_\_**
|
- Other: **\_\_\_**
|
||||||
|
|
||||||
## Message Queue & Event Streaming
|
## Message Queue and Event Streaming
|
||||||
|
|
||||||
15. **Message queue (if needed):**
|
15. **Message queue (if needed):**
|
||||||
- RabbitMQ
|
- RabbitMQ
|
||||||
@@ -167,7 +167,7 @@
|
|||||||
- Event bus
|
- Event bus
|
||||||
- Not applicable
|
- Not applicable
|
||||||
|
|
||||||
## API Design & Documentation
|
## API Design and Documentation
|
||||||
|
|
||||||
21. **API versioning:**
|
21. **API versioning:**
|
||||||
- URL versioning (/v1/, /v2/)
|
- URL versioning (/v1/, /v2/)
|
||||||
@@ -189,7 +189,7 @@
|
|||||||
- cURL examples
|
- cURL examples
|
||||||
- Multiple tools
|
- Multiple tools
|
||||||
|
|
||||||
## Rate Limiting & Throttling
|
## Rate Limiting and Throttling
|
||||||
|
|
||||||
24. **Rate limiting:**
|
24. **Rate limiting:**
|
||||||
- Per-user/API key
|
- Per-user/API key
|
||||||
@@ -204,7 +204,7 @@
|
|||||||
- Redis-based
|
- Redis-based
|
||||||
- None
|
- None
|
||||||
|
|
||||||
## Data Validation & Processing
|
## Data Validation and Processing
|
||||||
|
|
||||||
26. **Request validation:**
|
26. **Request validation:**
|
||||||
- Schema validation (Zod, Joi, Yup, Pydantic)
|
- Schema validation (Zod, Joi, Yup, Pydantic)
|
||||||
@@ -225,7 +225,7 @@
|
|||||||
- Presigned URLs (client direct upload)
|
- Presigned URLs (client direct upload)
|
||||||
- None needed
|
- None needed
|
||||||
|
|
||||||
## Error Handling & Resilience
|
## Error Handling and Resilience
|
||||||
|
|
||||||
29. **Error handling strategy:**
|
29. **Error handling strategy:**
|
||||||
- Standard HTTP status codes
|
- Standard HTTP status codes
|
||||||
@@ -264,7 +264,7 @@
|
|||||||
- Loki + Grafana
|
- Loki + Grafana
|
||||||
- None (local logs)
|
- None (local logs)
|
||||||
|
|
||||||
35. **Metrics & Monitoring:**
|
35. **Metrics and Monitoring:**
|
||||||
- Prometheus
|
- Prometheus
|
||||||
- Datadog
|
- Datadog
|
||||||
- New Relic
|
- New Relic
|
||||||
@@ -335,7 +335,7 @@
|
|||||||
- PCI DSS
|
- PCI DSS
|
||||||
- None
|
- None
|
||||||
|
|
||||||
## Deployment & Infrastructure
|
## Deployment and Infrastructure
|
||||||
|
|
||||||
45. **Deployment platform:**
|
45. **Deployment platform:**
|
||||||
- AWS (ECS, EKS, Lambda, Elastic Beanstalk)
|
- AWS (ECS, EKS, Lambda, Elastic Beanstalk)
|
||||||
@@ -438,7 +438,7 @@
|
|||||||
- Fastly
|
- Fastly
|
||||||
- None (dynamic only)
|
- None (dynamic only)
|
||||||
|
|
||||||
## Data & Storage
|
## Data and Storage
|
||||||
|
|
||||||
58. **File storage (if needed):**
|
58. **File storage (if needed):**
|
||||||
- AWS S3
|
- AWS S3
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Command-Line Tool Architecture Questions
|
# Command-Line Tool Architecture Questions
|
||||||
|
|
||||||
## Language & Runtime
|
## Language and Runtime
|
||||||
|
|
||||||
1. **Primary language:**
|
1. **Primary language:**
|
||||||
- Go (compiled, single binary, great for CLIs)
|
- Go (compiled, single binary, great for CLIs)
|
||||||
@@ -128,7 +128,7 @@
|
|||||||
- Used for runtime behavior
|
- Used for runtime behavior
|
||||||
- Not used
|
- Not used
|
||||||
|
|
||||||
## Data & Storage
|
## Data and Storage
|
||||||
|
|
||||||
17. **Persistent data:**
|
17. **Persistent data:**
|
||||||
- Cache (temporary, can be deleted)
|
- Cache (temporary, can be deleted)
|
||||||
@@ -208,7 +208,7 @@
|
|||||||
- Configurable verbosity (--verbose, --quiet)
|
- Configurable verbosity (--verbose, --quiet)
|
||||||
- No logging (simple tool)
|
- No logging (simple tool)
|
||||||
|
|
||||||
## Piping & Integration
|
## Piping and Integration
|
||||||
|
|
||||||
28. **Stdin support:**
|
28. **Stdin support:**
|
||||||
- Reads from stdin (pipe input)
|
- Reads from stdin (pipe input)
|
||||||
@@ -229,7 +229,7 @@
|
|||||||
- All shells
|
- All shells
|
||||||
- None
|
- None
|
||||||
|
|
||||||
## Distribution & Installation
|
## Distribution and Installation
|
||||||
|
|
||||||
31. **Package managers:**
|
31. **Package managers:**
|
||||||
- Homebrew (macOS/Linux)
|
- Homebrew (macOS/Linux)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Data/Analytics/ML Project Architecture Questions
|
# Data/Analytics/ML Project Architecture Questions
|
||||||
|
|
||||||
## Project Type & Scope
|
## Project Type and Scope
|
||||||
|
|
||||||
1. **Primary project focus:**
|
1. **Primary project focus:**
|
||||||
- ETL/Data Pipeline (move and transform data)
|
- ETL/Data Pipeline (move and transform data)
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
- Real-time streaming (milliseconds)
|
- Real-time streaming (milliseconds)
|
||||||
- Mix
|
- Mix
|
||||||
|
|
||||||
## Programming Language & Environment
|
## Programming Language and Environment
|
||||||
|
|
||||||
4. **Primary language:**
|
4. **Primary language:**
|
||||||
- Python (pandas, numpy, sklearn, pytorch, tensorflow)
|
- Python (pandas, numpy, sklearn, pytorch, tensorflow)
|
||||||
@@ -109,7 +109,7 @@
|
|||||||
- Delete after X months/years
|
- Delete after X months/years
|
||||||
- Compliance-driven retention
|
- Compliance-driven retention
|
||||||
|
|
||||||
## Data Processing & Transformation
|
## Data Processing and Transformation
|
||||||
|
|
||||||
14. **Data processing framework:**
|
14. **Data processing framework:**
|
||||||
- pandas (single machine)
|
- pandas (single machine)
|
||||||
@@ -192,7 +192,7 @@
|
|||||||
|
|
||||||
22. **Experiment tracking:**
|
22. **Experiment tracking:**
|
||||||
- MLflow
|
- MLflow
|
||||||
- Weights & Biases
|
- Weights and Biases
|
||||||
- Neptune.ai
|
- Neptune.ai
|
||||||
- Comet
|
- Comet
|
||||||
- TensorBoard
|
- TensorBoard
|
||||||
@@ -260,7 +260,7 @@
|
|||||||
- Azure AutoML
|
- Azure AutoML
|
||||||
- Not using AutoML
|
- Not using AutoML
|
||||||
|
|
||||||
## Orchestration & Workflow
|
## Orchestration and Workflow
|
||||||
|
|
||||||
30. **Workflow orchestration:**
|
30. **Workflow orchestration:**
|
||||||
- Apache Airflow
|
- Apache Airflow
|
||||||
@@ -293,7 +293,7 @@
|
|||||||
- Simple sequential
|
- Simple sequential
|
||||||
- None (independent tasks)
|
- None (independent tasks)
|
||||||
|
|
||||||
## Data Analytics & Visualization
|
## Data Analytics and Visualization
|
||||||
|
|
||||||
34. **BI/Visualization tool:**
|
34. **BI/Visualization tool:**
|
||||||
- Tableau
|
- Tableau
|
||||||
@@ -321,7 +321,7 @@
|
|||||||
- Notebooks
|
- Notebooks
|
||||||
- Multiple interfaces
|
- Multiple interfaces
|
||||||
|
|
||||||
## Data Governance & Security
|
## Data Governance and Security
|
||||||
|
|
||||||
37. **Data catalog:**
|
37. **Data catalog:**
|
||||||
- Amundsen
|
- Amundsen
|
||||||
@@ -360,7 +360,7 @@
|
|||||||
- Manual snapshots
|
- Manual snapshots
|
||||||
- None
|
- None
|
||||||
|
|
||||||
## Testing & Validation
|
## Testing and Validation
|
||||||
|
|
||||||
42. **Data testing:**
|
42. **Data testing:**
|
||||||
- Unit tests (transformation logic)
|
- Unit tests (transformation logic)
|
||||||
@@ -378,7 +378,7 @@
|
|||||||
- A/B testing in production
|
- A/B testing in production
|
||||||
- None
|
- None
|
||||||
|
|
||||||
## Deployment & CI/CD
|
## Deployment and CI/CD
|
||||||
|
|
||||||
44. **Deployment strategy:**
|
44. **Deployment strategy:**
|
||||||
- GitOps (version-controlled config)
|
- GitOps (version-controlled config)
|
||||||
@@ -396,7 +396,7 @@
|
|||||||
- Docker
|
- Docker
|
||||||
- Not containerized (native environments)
|
- Not containerized (native environments)
|
||||||
|
|
||||||
## Monitoring & Observability
|
## Monitoring and Observability
|
||||||
|
|
||||||
47. **Pipeline monitoring:**
|
47. **Pipeline monitoring:**
|
||||||
- Orchestrator built-in (Airflow UI, Prefect)
|
- Orchestrator built-in (Airflow UI, Prefect)
|
||||||
@@ -429,7 +429,7 @@
|
|||||||
- Cost monitoring dashboards
|
- Cost monitoring dashboards
|
||||||
- Not a priority
|
- Not a priority
|
||||||
|
|
||||||
## Collaboration & Documentation
|
## Collaboration and Documentation
|
||||||
|
|
||||||
51. **Team collaboration:**
|
51. **Team collaboration:**
|
||||||
- Git for code
|
- Git for code
|
||||||
@@ -451,7 +451,7 @@
|
|||||||
- Peer review (optional)
|
- Peer review (optional)
|
||||||
- No formal review
|
- No formal review
|
||||||
|
|
||||||
## Performance & Scale
|
## Performance and Scale
|
||||||
|
|
||||||
54. **Performance requirements:**
|
54. **Performance requirements:**
|
||||||
- Near real-time (< 1 minute latency)
|
- Near real-time (< 1 minute latency)
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user