fix: correct YAML indentation and template references, rebuild dist
- Fixed YAML indentation error in dev.md (coding_standards_awareness) - Fixed template reference: projectbrief-tmpl.yaml → project-brief-tmpl.yaml - Updated in analyst.md - Updated in bmad-orchestrator.md - Rebuilt dist/ folder with all updates from previous commit This ensures the web bundles are synchronized with all the framework enhancements including Memory Bank, ADRs, Sprint workflows, and new data files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
ded53af686
commit
7cd0dd61a3
|
|
@ -84,7 +84,7 @@ dependencies:
|
||||||
- market-research-tmpl.yaml
|
- market-research-tmpl.yaml
|
||||||
- competitor-analysis-tmpl.yaml
|
- competitor-analysis-tmpl.yaml
|
||||||
- brainstorming-output-tmpl.yaml
|
- brainstorming-output-tmpl.yaml
|
||||||
- projectbrief-tmpl.yaml
|
- project-brief-tmpl.yaml
|
||||||
- productContext-tmpl.yaml
|
- productContext-tmpl.yaml
|
||||||
data:
|
data:
|
||||||
- bmad-kb.md
|
- bmad-kb.md
|
||||||
|
|
|
||||||
|
|
@ -179,7 +179,7 @@ dependencies:
|
||||||
templates:
|
templates:
|
||||||
- adr-tmpl.yaml
|
- adr-tmpl.yaml
|
||||||
- dev-journal-tmpl.yaml
|
- dev-journal-tmpl.yaml
|
||||||
- projectbrief-tmpl.yaml
|
- project-brief-tmpl.yaml
|
||||||
- productContext-tmpl.yaml
|
- productContext-tmpl.yaml
|
||||||
- systemPatterns-tmpl.yaml
|
- systemPatterns-tmpl.yaml
|
||||||
- techContext-tmpl.yaml
|
- techContext-tmpl.yaml
|
||||||
|
|
|
||||||
|
|
@ -64,9 +64,10 @@ core_principles:
|
||||||
- Numbered Options - Always use numbered lists when presenting choices to the user
|
- Numbered Options - Always use numbered lists when presenting choices to the user
|
||||||
- Session Documentation - Create dev journal entries for significant development sessions
|
- Session Documentation - Create dev journal entries for significant development sessions
|
||||||
- Knowledge Preservation - Document decisions, patterns, and learnings for future reference
|
- Knowledge Preservation - Document decisions, patterns, and learnings for future reference
|
||||||
coding_standards_awareness:
|
|
||||||
- Apply all coding standards from data/coding-standards.md
|
coding_standards_awareness:
|
||||||
- Follow security principles [SFT], [IV], [RL], [RLS] by default
|
- Apply all coding standards from data/coding-standards.md
|
||||||
|
- Follow security principles [SFT], [IV], [RL], [RLS] by default
|
||||||
- Maintain code quality standards [DRY], [SF], [RP], [CA]
|
- Maintain code quality standards [DRY], [SF], [RP], [CA]
|
||||||
- Use conventional commit format [CD] for all commits
|
- Use conventional commit format [CD] for all commits
|
||||||
- Write testable code [TDT] with appropriate test coverage
|
- Write testable code [TDT] with appropriate test coverage
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -73,6 +73,13 @@ persona:
|
||||||
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
||||||
- Continuous Improvement - Balance perfection with pragmatism
|
- Continuous Improvement - Balance perfection with pragmatism
|
||||||
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
||||||
|
coding_standards_awareness:
|
||||||
|
- Apply all coding standards from data/coding-standards.md during reviews
|
||||||
|
- Enforce security principles [SFT], [IV], [RL], [RLS] in all code
|
||||||
|
- Verify code quality standards [DRY], [SF], [RP], [CA] are met
|
||||||
|
- Check for proper error handling [REH] and resource management [RM]
|
||||||
|
- Ensure twelve-factor principles compliance for cloud-native apps
|
||||||
|
- Validate testing standards [TDT] and test coverage
|
||||||
story-file-permissions:
|
story-file-permissions:
|
||||||
- CRITICAL: When reviewing stories, you are ONLY authorized to update the "QA Results" section of story files
|
- CRITICAL: When reviewing stories, you are ONLY authorized to update the "QA Results" section of story files
|
||||||
- CRITICAL: DO NOT modify any other sections including Status, Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Testing, Dev Agent Record, Change Log, or any other sections
|
- CRITICAL: DO NOT modify any other sections including Status, Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Testing, Dev Agent Record, Change Log, or any other sections
|
||||||
|
|
@ -80,13 +87,14 @@ story-file-permissions:
|
||||||
commands:
|
commands:
|
||||||
- help: Show numbered list of the following commands to allow selection
|
- help: Show numbered list of the following commands to allow selection
|
||||||
- review {story}: execute the task review-story for the highest sequence story in docs/stories unless another is specified - keep any specified technical-preferences in mind as needed
|
- review {story}: execute the task review-story for the highest sequence story in docs/stories unless another is specified - keep any specified technical-preferences in mind as needed
|
||||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
||||||
- exit: Say goodbye as the QA Engineer, and then abandon inhabiting this persona
|
- exit: Say goodbye as the QA Engineer, and then abandon inhabiting this persona
|
||||||
dependencies:
|
dependencies:
|
||||||
tasks:
|
tasks:
|
||||||
- review-story.md
|
- review-story.md
|
||||||
data:
|
data:
|
||||||
- technical-preferences.md
|
- technical-preferences.md
|
||||||
|
- coding-standards.md
|
||||||
|
- twelve-factor-principles.md
|
||||||
templates:
|
templates:
|
||||||
- story-tmpl.yaml
|
- story-tmpl.yaml
|
||||||
```
|
```
|
||||||
|
|
@ -255,7 +263,7 @@ workflow:
|
||||||
elicitation: advanced-elicitation
|
elicitation: advanced-elicitation
|
||||||
|
|
||||||
agent_config:
|
agent_config:
|
||||||
editable_sections:
|
editable_sections:
|
||||||
- Status
|
- Status
|
||||||
- Story
|
- Story
|
||||||
- Acceptance Criteria
|
- Acceptance Criteria
|
||||||
|
|
@ -272,7 +280,7 @@ sections:
|
||||||
instruction: Select the current status of the story
|
instruction: Select the current status of the story
|
||||||
owner: scrum-master
|
owner: scrum-master
|
||||||
editors: [scrum-master, dev-agent]
|
editors: [scrum-master, dev-agent]
|
||||||
|
|
||||||
- id: story
|
- id: story
|
||||||
title: Story
|
title: Story
|
||||||
type: template-text
|
type: template-text
|
||||||
|
|
@ -284,7 +292,7 @@ sections:
|
||||||
elicit: true
|
elicit: true
|
||||||
owner: scrum-master
|
owner: scrum-master
|
||||||
editors: [scrum-master]
|
editors: [scrum-master]
|
||||||
|
|
||||||
- id: acceptance-criteria
|
- id: acceptance-criteria
|
||||||
title: Acceptance Criteria
|
title: Acceptance Criteria
|
||||||
type: numbered-list
|
type: numbered-list
|
||||||
|
|
@ -292,7 +300,7 @@ sections:
|
||||||
elicit: true
|
elicit: true
|
||||||
owner: scrum-master
|
owner: scrum-master
|
||||||
editors: [scrum-master]
|
editors: [scrum-master]
|
||||||
|
|
||||||
- id: tasks-subtasks
|
- id: tasks-subtasks
|
||||||
title: Tasks / Subtasks
|
title: Tasks / Subtasks
|
||||||
type: bullet-list
|
type: bullet-list
|
||||||
|
|
@ -309,7 +317,7 @@ sections:
|
||||||
elicit: true
|
elicit: true
|
||||||
owner: scrum-master
|
owner: scrum-master
|
||||||
editors: [scrum-master, dev-agent]
|
editors: [scrum-master, dev-agent]
|
||||||
|
|
||||||
- id: dev-notes
|
- id: dev-notes
|
||||||
title: Dev Notes
|
title: Dev Notes
|
||||||
instruction: |
|
instruction: |
|
||||||
|
|
@ -333,7 +341,7 @@ sections:
|
||||||
elicit: true
|
elicit: true
|
||||||
owner: scrum-master
|
owner: scrum-master
|
||||||
editors: [scrum-master]
|
editors: [scrum-master]
|
||||||
|
|
||||||
- id: change-log
|
- id: change-log
|
||||||
title: Change Log
|
title: Change Log
|
||||||
type: table
|
type: table
|
||||||
|
|
@ -341,7 +349,7 @@ sections:
|
||||||
instruction: Track changes made to this story document
|
instruction: Track changes made to this story document
|
||||||
owner: scrum-master
|
owner: scrum-master
|
||||||
editors: [scrum-master, dev-agent, qa-agent]
|
editors: [scrum-master, dev-agent, qa-agent]
|
||||||
|
|
||||||
- id: dev-agent-record
|
- id: dev-agent-record
|
||||||
title: Dev Agent Record
|
title: Dev Agent Record
|
||||||
instruction: This section is populated by the development agent during implementation
|
instruction: This section is populated by the development agent during implementation
|
||||||
|
|
@ -354,25 +362,25 @@ sections:
|
||||||
instruction: Record the specific AI agent model and version used for development
|
instruction: Record the specific AI agent model and version used for development
|
||||||
owner: dev-agent
|
owner: dev-agent
|
||||||
editors: [dev-agent]
|
editors: [dev-agent]
|
||||||
|
|
||||||
- id: debug-log-references
|
- id: debug-log-references
|
||||||
title: Debug Log References
|
title: Debug Log References
|
||||||
instruction: Reference any debug logs or traces generated during development
|
instruction: Reference any debug logs or traces generated during development
|
||||||
owner: dev-agent
|
owner: dev-agent
|
||||||
editors: [dev-agent]
|
editors: [dev-agent]
|
||||||
|
|
||||||
- id: completion-notes
|
- id: completion-notes
|
||||||
title: Completion Notes List
|
title: Completion Notes List
|
||||||
instruction: Notes about the completion of tasks and any issues encountered
|
instruction: Notes about the completion of tasks and any issues encountered
|
||||||
owner: dev-agent
|
owner: dev-agent
|
||||||
editors: [dev-agent]
|
editors: [dev-agent]
|
||||||
|
|
||||||
- id: file-list
|
- id: file-list
|
||||||
title: File List
|
title: File List
|
||||||
instruction: List all files created, modified, or affected during story implementation
|
instruction: List all files created, modified, or affected during story implementation
|
||||||
owner: dev-agent
|
owner: dev-agent
|
||||||
editors: [dev-agent]
|
editors: [dev-agent]
|
||||||
|
|
||||||
- id: qa-results
|
- id: qa-results
|
||||||
title: QA Results
|
title: QA Results
|
||||||
instruction: Results from QA Agent QA review of the completed story implementation
|
instruction: Results from QA Agent QA review of the completed story implementation
|
||||||
|
|
@ -381,7 +389,264 @@ sections:
|
||||||
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
|
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
|
||||||
|
|
||||||
==================== START: .bmad-core/data/technical-preferences.md ====================
|
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# Technical Preferences and Architectural Principles
|
||||||
|
|
||||||
|
## Core Principles References
|
||||||
|
|
||||||
|
The following technical principles and standards apply to all BMAD projects:
|
||||||
|
|
||||||
|
### 1. Coding Standards
|
||||||
|
- **Reference:** `coding-standards.md`
|
||||||
|
- **Purpose:** Fundamental coding principles, security practices, and quality standards
|
||||||
|
- **Key Areas:** Code simplicity, dependency management, security, testing, commit standards
|
||||||
|
|
||||||
|
### 2. Twelve-Factor App Principles
|
||||||
|
- **Reference:** `twelve-factor-principles.md`
|
||||||
|
- **Purpose:** Cloud-native application development principles
|
||||||
|
- **Key Areas:** Codebase management, dependencies, config, backing services, build/release/run
|
||||||
|
|
||||||
|
### 3. Microservice Patterns
|
||||||
|
- **Reference:** `microservice-patterns.md`
|
||||||
|
- **Purpose:** Patterns for distributed system architecture
|
||||||
|
- **Key Areas:** Service decomposition, communication patterns, data management, resilience
|
||||||
|
|
||||||
|
## Application Guidelines
|
||||||
|
|
||||||
|
1. **During Architecture Design:**
|
||||||
|
- Apply twelve-factor principles for cloud-native applications
|
||||||
|
- Consider microservice patterns for complex distributed systems
|
||||||
|
- Document pattern choices in Architecture Decision Records (ADRs)
|
||||||
|
|
||||||
|
2. **During Implementation:**
|
||||||
|
- Follow coding standards for all code generation
|
||||||
|
- Apply security principles by default
|
||||||
|
- Ensure testability and maintainability
|
||||||
|
|
||||||
|
3. **Technology Selection:**
|
||||||
|
- Prefer simple, proven solutions over complex ones
|
||||||
|
- Minimize dependencies unless explicitly justified
|
||||||
|
- Consider operational complexity alongside technical capabilities
|
||||||
|
|
||||||
|
## User-Defined Preferences
|
||||||
|
|
||||||
|
_Add project-specific technical preferences below:_
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: .bmad-core/data/technical-preferences.md ====================
|
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||||
|
|
||||||
|
==================== START: .bmad-core/data/coding-standards.md ====================
|
||||||
|
# Coding Standards and Principles
|
||||||
|
|
||||||
|
> **Purpose:** This document defines the core coding standards and principles that apply to all development work in BMAD projects. These are fundamental rules of software craftsmanship that ensure consistency, quality, and maintainability.
|
||||||
|
|
||||||
|
## Core Coding Principles
|
||||||
|
|
||||||
|
### Simplicity and Readability
|
||||||
|
- **[SF] Simplicity First:** Always choose the simplest viable solution. Complex patterns require explicit justification.
|
||||||
|
- **[RP] Readability Priority:** Code must be immediately understandable by both humans and AI.
|
||||||
|
- **[CA] Clean Architecture:** Generate cleanly formatted, logically structured code with consistent patterns.
|
||||||
|
|
||||||
|
### Dependency Management
|
||||||
|
- **[DM] Dependency Minimalism:** No new libraries without explicit request or compelling justification.
|
||||||
|
- **[DM-1] Security Reviews:** Review third-party dependencies for vulnerabilities quarterly.
|
||||||
|
- **[DM-2] Package Verification:** Prefer signed or verified packages.
|
||||||
|
- **[DM-3] Cleanup:** Remove unused or outdated dependencies promptly.
|
||||||
|
- **[DM-4] Documentation:** Document dependency updates in changelog.
|
||||||
|
|
||||||
|
### Development Workflow
|
||||||
|
- **[WF-FOCUS] Task Focus:** Focus on areas of code relevant to the task.
|
||||||
|
- **[WF-SCOPE] Scope Control:** Do not touch code unrelated to the task.
|
||||||
|
- **[WF-TEST] Testing:** Write thorough tests for all major functionality.
|
||||||
|
- **[WF-ARCH] Architecture Stability:** Avoid major changes to working patterns unless explicitly requested.
|
||||||
|
- **[WF-IMPACT] Impact Analysis:** Consider effects on other methods and code areas.
|
||||||
|
|
||||||
|
### Code Quality Standards
|
||||||
|
- **[DRY] DRY Principle:** No duplicate code. Reuse or extend existing functionality.
|
||||||
|
- **[REH] Error Handling:** Robust error handling for all edge cases and external interactions.
|
||||||
|
- **[CSD] Code Smell Detection:** Proactively identify and refactor:
|
||||||
|
- Functions exceeding 30 lines
|
||||||
|
- Files exceeding 300 lines
|
||||||
|
- Nested conditionals beyond 2 levels
|
||||||
|
- Classes with more than 5 public methods
|
||||||
|
|
||||||
|
### Security Principles
|
||||||
|
- **[IV] Input Validation:** All external data must be validated before processing.
|
||||||
|
- **[SFT] Security-First:** Implement proper authentication, authorization, and data protection.
|
||||||
|
- **[RL] Rate Limiting:** Rate limit all API endpoints.
|
||||||
|
- **[RLS] Row-Level Security:** Use row-level security always.
|
||||||
|
- **[CAP] Captcha Protection:** Captcha on all auth routes/signup pages.
|
||||||
|
- **[WAF] WAF Protection:** Enable attack challenge on hosting WAF when available.
|
||||||
|
- **[SEC-1] Sensitive Files:** DO NOT read or modify without prior approval:
|
||||||
|
- .env files
|
||||||
|
- */config/secrets.*
|
||||||
|
- Any file containing API keys or credentials
|
||||||
|
|
||||||
|
### Performance and Resources
|
||||||
|
- **[PA] Performance Awareness:** Consider computational complexity and resource usage.
|
||||||
|
- **[RM] Resource Management:** Close connections and free resources appropriately.
|
||||||
|
- **[CMV] Constants Over Magic Values:** No magic strings or numbers. Use named constants.
|
||||||
|
|
||||||
|
### Commit Standards
|
||||||
|
- **[AC] Atomic Changes:** Make small, self-contained modifications.
|
||||||
|
- **[CD] Commit Discipline:** Use conventional commit format:
|
||||||
|
```
|
||||||
|
type(scope): concise description
|
||||||
|
|
||||||
|
[optional body with details]
|
||||||
|
|
||||||
|
[optional footer with breaking changes/issue references]
|
||||||
|
```
|
||||||
|
Types: feat, fix, docs, style, refactor, perf, test, chore
|
||||||
|
|
||||||
|
### Testing Standards
|
||||||
|
- **[TDT] Test-Driven Thinking:** Design all code to be easily testable from inception.
|
||||||
|
- **[ISA] Industry Standards:** Follow established conventions for the language and tech stack.
|
||||||
|
|
||||||
|
## Application to AI Development
|
||||||
|
|
||||||
|
### Communication Guidelines
|
||||||
|
- **[RAT] Rule Application Tracking:** Tag rule applications with abbreviations (e.g., [SF], [DRY]).
|
||||||
|
- **[EDC] Explanation Depth Control:** Scale explanation detail based on complexity.
|
||||||
|
- **[AS] Alternative Suggestions:** Offer alternative approaches with pros/cons when relevant.
|
||||||
|
- **[KBT] Knowledge Boundary Transparency:** Clearly communicate capability limits.
|
||||||
|
|
||||||
|
### Context Management
|
||||||
|
- **[TR] Transparent Reasoning:** Explicitly reference which rules influenced decisions.
|
||||||
|
- **[CWM] Context Window Management:** Be mindful of AI context limitations.
|
||||||
|
- **[SD] Strategic Documentation:** Comment only complex logic or critical functions.
|
||||||
|
|
||||||
|
## Integration with BMAD Workflows
|
||||||
|
|
||||||
|
These coding standards should be:
|
||||||
|
1. Referenced during architecture design decisions
|
||||||
|
2. Applied during story implementation
|
||||||
|
3. Validated during code reviews
|
||||||
|
4. Enforced through automated tooling where possible
|
||||||
|
5. Updated based on team learnings and retrospectives
|
||||||
|
==================== END: .bmad-core/data/coding-standards.md ====================
|
||||||
|
|
||||||
|
==================== START: .bmad-core/data/twelve-factor-principles.md ====================
|
||||||
|
# Twelve-Factor App Principles
|
||||||
|
|
||||||
|
> **Purpose:** This document provides the definitive set of rules based on the Twelve-Factor App methodology. These principles are mandatory for ensuring applications are built as scalable, resilient, and maintainable cloud-native services.
|
||||||
|
|
||||||
|
## The Twelve Factors
|
||||||
|
|
||||||
|
### I. Codebase
|
||||||
|
- A single, version-controlled codebase must represent one application
|
||||||
|
- All code for a specific application belongs to this single codebase
|
||||||
|
- Shared functionality must be factored into versioned libraries
|
||||||
|
- One codebase produces multiple deploys (development, staging, production)
|
||||||
|
|
||||||
|
### II. Dependencies
|
||||||
|
- Explicitly declare all dependencies via manifest files (e.g., package.json, requirements.txt)
|
||||||
|
- Never rely on implicit existence of system-wide packages
|
||||||
|
- Application must run in isolated environment with only declared dependencies
|
||||||
|
|
||||||
|
### III. Config
|
||||||
|
- Strict separation between code and configuration
|
||||||
|
- All deploy-varying config must be read from environment variables
|
||||||
|
- Never hardcode environment-specific values in source code
|
||||||
|
- Codebase must be runnable anywhere with correct environment variables
|
||||||
|
|
||||||
|
### IV. Backing Services
|
||||||
|
- Treat all backing services as attached, swappable resources
|
||||||
|
- Connect via locators/credentials stored in environment variables
|
||||||
|
- Code must be agnostic to whether service is local or third-party
|
||||||
|
- Examples: databases, message queues, caches, external APIs
|
||||||
|
|
||||||
|
### V. Build, Release, Run
|
||||||
|
Maintain strict three-stage separation:
|
||||||
|
- **Build:** Convert code repo into executable bundle
|
||||||
|
- **Release:** Combine build with environment-specific config
|
||||||
|
- **Run:** Execute release in target environment
|
||||||
|
- Releases must be immutable with unique IDs
|
||||||
|
- Any change requires new release
|
||||||
|
|
||||||
|
### VI. Processes
|
||||||
|
- Execute as stateless, share-nothing processes
|
||||||
|
- Persistent data must be stored in stateful backing service
|
||||||
|
- Never assume local memory/disk state available across requests
|
||||||
|
- Process state is ephemeral
|
||||||
|
|
||||||
|
### VII. Port Binding
|
||||||
|
- Application must be self-contained
|
||||||
|
- Export services by binding to port specified via configuration
|
||||||
|
- Do not rely on runtime injection of webserver
|
||||||
|
- Application brings its own webserver library
|
||||||
|
|
||||||
|
### VIII. Concurrency
|
||||||
|
- Scale out horizontally by adding concurrent processes
|
||||||
|
- Assign different workload types to different process types
|
||||||
|
- Use process manager for lifecycle management
|
||||||
|
- Design for horizontal scaling from the start
|
||||||
|
|
||||||
|
### IX. Disposability
|
||||||
|
- Processes must be disposable (start/stop quickly)
|
||||||
|
- Minimize startup time for fast elastic scaling
|
||||||
|
- Graceful shutdown on SIGTERM
|
||||||
|
- Robust against sudden death (crash-only design)
|
||||||
|
|
||||||
|
### X. Dev/Prod Parity
|
||||||
|
Keep environments as similar as possible:
|
||||||
|
- Same programming language versions
|
||||||
|
- Same system tooling
|
||||||
|
- Same backing service types and versions
|
||||||
|
- Minimize time, personnel, and tool gaps
|
||||||
|
|
||||||
|
### XI. Logs
|
||||||
|
- Treat logs as event streams
|
||||||
|
- Never write to or manage log files directly
|
||||||
|
- Write unbuffered to stdout
|
||||||
|
- Execution environment handles collection and routing
|
||||||
|
|
||||||
|
### XII. Admin Processes
|
||||||
|
- Run admin tasks as one-off processes
|
||||||
|
- Use identical environment as long-running processes
|
||||||
|
- Ship admin scripts with application code
|
||||||
|
- Use same dependency and config management
|
||||||
|
|
||||||
|
## Additional Cloud-Native Principles
|
||||||
|
|
||||||
|
### Containerization
|
||||||
|
- **[SVC] Service as Container:** Package services as container images
|
||||||
|
- Encapsulate technology stack in containers
|
||||||
|
- Ensure consistent deployment across environments
|
||||||
|
|
||||||
|
### Serverless Options
|
||||||
|
- **[SRL] Serverless Deployment:** Consider serverless platforms when appropriate
|
||||||
|
- Abstract away infrastructure management
|
||||||
|
- Focus on business logic over infrastructure
|
||||||
|
|
||||||
|
### Observability
|
||||||
|
- Implement comprehensive monitoring and metrics
|
||||||
|
- Use distributed tracing for microservices
|
||||||
|
- Ensure all services are observable by default
|
||||||
|
|
||||||
|
### Security
|
||||||
|
- Security must be built-in, not bolted-on
|
||||||
|
- Use principle of least privilege
|
||||||
|
- Implement defense in depth
|
||||||
|
- Regular security audits and updates
|
||||||
|
|
||||||
|
## AI/Agent Safeguards
|
||||||
|
- All AI-generated code must be reviewed before production
|
||||||
|
- Escalate ambiguous or risky decisions for approval
|
||||||
|
- Log all significant AI-suggested changes
|
||||||
|
- Never overwrite .env files without confirmation
|
||||||
|
|
||||||
|
## Environmental Sustainability
|
||||||
|
- Optimize compute resources
|
||||||
|
- Minimize infrastructure waste
|
||||||
|
- Prefer energy-efficient solutions
|
||||||
|
- Consider environmental impact in technical decisions
|
||||||
|
|
||||||
|
## Integration with BMAD
|
||||||
|
|
||||||
|
These principles should be:
|
||||||
|
1. Applied during architecture design
|
||||||
|
2. Validated during implementation
|
||||||
|
3. Enforced through CI/CD pipelines
|
||||||
|
4. Reviewed during architectural decision records (ADRs)
|
||||||
|
5. Considered in all technical decisions
|
||||||
|
==================== END: .bmad-core/data/twelve-factor-principles.md ====================
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -73,15 +73,12 @@ persona:
|
||||||
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
||||||
commands:
|
commands:
|
||||||
- help: Show numbered list of the following commands to allow selection
|
- help: Show numbered list of the following commands to allow selection
|
||||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
- create-front-end-spec: run task create-doc.md with template front-end-spec-tmpl.yaml
|
||||||
- generate-ui-prompt: Create AI frontend generation prompt
|
- generate-ui-prompt: Run task generate-ai-frontend-prompt.md
|
||||||
- research {topic}: Execute create-deep-research-prompt task to generate a prompt to init UX deep research
|
|
||||||
- execute-checklist {checklist}: Run task execute-checklist (default->po-master-checklist)
|
|
||||||
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
||||||
dependencies:
|
dependencies:
|
||||||
tasks:
|
tasks:
|
||||||
- generate-ai-frontend-prompt.md
|
- generate-ai-frontend-prompt.md
|
||||||
- create-deep-research-prompt.md
|
|
||||||
- create-doc.md
|
- create-doc.md
|
||||||
- execute-checklist.md
|
- execute-checklist.md
|
||||||
templates:
|
templates:
|
||||||
|
|
@ -145,298 +142,6 @@ You will now synthesize the inputs and the above principles into a final, compre
|
||||||
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
||||||
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||||
|
|
||||||
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
|
||||||
# Create Deep Research Prompt Task
|
|
||||||
|
|
||||||
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
Generate well-structured research prompts that:
|
|
||||||
|
|
||||||
- Define clear research objectives and scope
|
|
||||||
- Specify appropriate research methodologies
|
|
||||||
- Outline expected deliverables and formats
|
|
||||||
- Guide systematic investigation of complex topics
|
|
||||||
- Ensure actionable insights are captured
|
|
||||||
|
|
||||||
## Research Type Selection
|
|
||||||
|
|
||||||
CRITICAL: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.
|
|
||||||
|
|
||||||
### 1. Research Focus Options
|
|
||||||
|
|
||||||
Present these numbered options to the user:
|
|
||||||
|
|
||||||
1. **Product Validation Research**
|
|
||||||
|
|
||||||
- Validate product hypotheses and market fit
|
|
||||||
- Test assumptions about user needs and solutions
|
|
||||||
- Assess technical and business feasibility
|
|
||||||
- Identify risks and mitigation strategies
|
|
||||||
|
|
||||||
2. **Market Opportunity Research**
|
|
||||||
|
|
||||||
- Analyze market size and growth potential
|
|
||||||
- Identify market segments and dynamics
|
|
||||||
- Assess market entry strategies
|
|
||||||
- Evaluate timing and market readiness
|
|
||||||
|
|
||||||
3. **User & Customer Research**
|
|
||||||
|
|
||||||
- Deep dive into user personas and behaviors
|
|
||||||
- Understand jobs-to-be-done and pain points
|
|
||||||
- Map customer journeys and touchpoints
|
|
||||||
- Analyze willingness to pay and value perception
|
|
||||||
|
|
||||||
4. **Competitive Intelligence Research**
|
|
||||||
|
|
||||||
- Detailed competitor analysis and positioning
|
|
||||||
- Feature and capability comparisons
|
|
||||||
- Business model and strategy analysis
|
|
||||||
- Identify competitive advantages and gaps
|
|
||||||
|
|
||||||
5. **Technology & Innovation Research**
|
|
||||||
|
|
||||||
- Assess technology trends and possibilities
|
|
||||||
- Evaluate technical approaches and architectures
|
|
||||||
- Identify emerging technologies and disruptions
|
|
||||||
- Analyze build vs. buy vs. partner options
|
|
||||||
|
|
||||||
6. **Industry & Ecosystem Research**
|
|
||||||
|
|
||||||
- Map industry value chains and dynamics
|
|
||||||
- Identify key players and relationships
|
|
||||||
- Analyze regulatory and compliance factors
|
|
||||||
- Understand partnership opportunities
|
|
||||||
|
|
||||||
7. **Strategic Options Research**
|
|
||||||
|
|
||||||
- Evaluate different strategic directions
|
|
||||||
- Assess business model alternatives
|
|
||||||
- Analyze go-to-market strategies
|
|
||||||
- Consider expansion and scaling paths
|
|
||||||
|
|
||||||
8. **Risk & Feasibility Research**
|
|
||||||
|
|
||||||
- Identify and assess various risk factors
|
|
||||||
- Evaluate implementation challenges
|
|
||||||
- Analyze resource requirements
|
|
||||||
- Consider regulatory and legal implications
|
|
||||||
|
|
||||||
9. **Custom Research Focus**
|
|
||||||
|
|
||||||
- User-defined research objectives
|
|
||||||
- Specialized domain investigation
|
|
||||||
- Cross-functional research needs
|
|
||||||
|
|
||||||
### 2. Input Processing
|
|
||||||
|
|
||||||
**If Project Brief provided:**
|
|
||||||
|
|
||||||
- Extract key product concepts and goals
|
|
||||||
- Identify target users and use cases
|
|
||||||
- Note technical constraints and preferences
|
|
||||||
- Highlight uncertainties and assumptions
|
|
||||||
|
|
||||||
**If Brainstorming Results provided:**
|
|
||||||
|
|
||||||
- Synthesize main ideas and themes
|
|
||||||
- Identify areas needing validation
|
|
||||||
- Extract hypotheses to test
|
|
||||||
- Note creative directions to explore
|
|
||||||
|
|
||||||
**If Market Research provided:**
|
|
||||||
|
|
||||||
- Build on identified opportunities
|
|
||||||
- Deepen specific market insights
|
|
||||||
- Validate initial findings
|
|
||||||
- Explore adjacent possibilities
|
|
||||||
|
|
||||||
**If Starting Fresh:**
|
|
||||||
|
|
||||||
- Gather essential context through questions
|
|
||||||
- Define the problem space
|
|
||||||
- Clarify research objectives
|
|
||||||
- Establish success criteria
|
|
||||||
|
|
||||||
## Process
|
|
||||||
|
|
||||||
### 3. Research Prompt Structure
|
|
||||||
|
|
||||||
CRITICAL: collaboratively develop a comprehensive research prompt with these components.
|
|
||||||
|
|
||||||
#### A. Research Objectives
|
|
||||||
|
|
||||||
CRITICAL: collaborate with the user to articulate clear, specific objectives for the research.
|
|
||||||
|
|
||||||
- Primary research goal and purpose
|
|
||||||
- Key decisions the research will inform
|
|
||||||
- Success criteria for the research
|
|
||||||
- Constraints and boundaries
|
|
||||||
|
|
||||||
#### B. Research Questions
|
|
||||||
|
|
||||||
CRITICAL: collaborate with the user to develop specific, actionable research questions organized by theme.
|
|
||||||
|
|
||||||
**Core Questions:**
|
|
||||||
|
|
||||||
- Central questions that must be answered
|
|
||||||
- Priority ranking of questions
|
|
||||||
- Dependencies between questions
|
|
||||||
|
|
||||||
**Supporting Questions:**
|
|
||||||
|
|
||||||
- Additional context-building questions
|
|
||||||
- Nice-to-have insights
|
|
||||||
- Future-looking considerations
|
|
||||||
|
|
||||||
#### C. Research Methodology
|
|
||||||
|
|
||||||
**Data Collection Methods:**
|
|
||||||
|
|
||||||
- Secondary research sources
|
|
||||||
- Primary research approaches (if applicable)
|
|
||||||
- Data quality requirements
|
|
||||||
- Source credibility criteria
|
|
||||||
|
|
||||||
**Analysis Frameworks:**
|
|
||||||
|
|
||||||
- Specific frameworks to apply
|
|
||||||
- Comparison criteria
|
|
||||||
- Evaluation methodologies
|
|
||||||
- Synthesis approaches
|
|
||||||
|
|
||||||
#### D. Output Requirements
|
|
||||||
|
|
||||||
**Format Specifications:**
|
|
||||||
|
|
||||||
- Executive summary requirements
|
|
||||||
- Detailed findings structure
|
|
||||||
- Visual/tabular presentations
|
|
||||||
- Supporting documentation
|
|
||||||
|
|
||||||
**Key Deliverables:**
|
|
||||||
|
|
||||||
- Must-have sections and insights
|
|
||||||
- Decision-support elements
|
|
||||||
- Action-oriented recommendations
|
|
||||||
- Risk and uncertainty documentation
|
|
||||||
|
|
||||||
### 4. Prompt Generation
|
|
||||||
|
|
||||||
**Research Prompt Template:**
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## Research Objective
|
|
||||||
|
|
||||||
[Clear statement of what this research aims to achieve]
|
|
||||||
|
|
||||||
## Background Context
|
|
||||||
|
|
||||||
[Relevant information from project brief, brainstorming, or other inputs]
|
|
||||||
|
|
||||||
## Research Questions
|
|
||||||
|
|
||||||
### Primary Questions (Must Answer)
|
|
||||||
|
|
||||||
1. [Specific, actionable question]
|
|
||||||
2. [Specific, actionable question]
|
|
||||||
...
|
|
||||||
|
|
||||||
### Secondary Questions (Nice to Have)
|
|
||||||
|
|
||||||
1. [Supporting question]
|
|
||||||
2. [Supporting question]
|
|
||||||
...
|
|
||||||
|
|
||||||
## Research Methodology
|
|
||||||
|
|
||||||
### Information Sources
|
|
||||||
|
|
||||||
- [Specific source types and priorities]
|
|
||||||
|
|
||||||
### Analysis Frameworks
|
|
||||||
|
|
||||||
- [Specific frameworks to apply]
|
|
||||||
|
|
||||||
### Data Requirements
|
|
||||||
|
|
||||||
- [Quality, recency, credibility needs]
|
|
||||||
|
|
||||||
## Expected Deliverables
|
|
||||||
|
|
||||||
### Executive Summary
|
|
||||||
|
|
||||||
- Key findings and insights
|
|
||||||
- Critical implications
|
|
||||||
- Recommended actions
|
|
||||||
|
|
||||||
### Detailed Analysis
|
|
||||||
|
|
||||||
[Specific sections needed based on research type]
|
|
||||||
|
|
||||||
### Supporting Materials
|
|
||||||
|
|
||||||
- Data tables
|
|
||||||
- Comparison matrices
|
|
||||||
- Source documentation
|
|
||||||
|
|
||||||
## Success Criteria
|
|
||||||
|
|
||||||
[How to evaluate if research achieved its objectives]
|
|
||||||
|
|
||||||
## Timeline and Priority
|
|
||||||
|
|
||||||
[If applicable, any time constraints or phasing]
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5. Review and Refinement
|
|
||||||
|
|
||||||
1. **Present Complete Prompt**
|
|
||||||
|
|
||||||
- Show the full research prompt
|
|
||||||
- Explain key elements and rationale
|
|
||||||
- Highlight any assumptions made
|
|
||||||
|
|
||||||
2. **Gather Feedback**
|
|
||||||
|
|
||||||
- Are the objectives clear and correct?
|
|
||||||
- Do the questions address all concerns?
|
|
||||||
- Is the scope appropriate?
|
|
||||||
- Are output requirements sufficient?
|
|
||||||
|
|
||||||
3. **Refine as Needed**
|
|
||||||
- Incorporate user feedback
|
|
||||||
- Adjust scope or focus
|
|
||||||
- Add missing elements
|
|
||||||
- Clarify ambiguities
|
|
||||||
|
|
||||||
### 6. Next Steps Guidance
|
|
||||||
|
|
||||||
**Execution Options:**
|
|
||||||
|
|
||||||
1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
|
|
||||||
2. **Guide Human Research**: Use as a framework for manual research efforts
|
|
||||||
3. **Hybrid Approach**: Combine AI and human research using this structure
|
|
||||||
|
|
||||||
**Integration Points:**
|
|
||||||
|
|
||||||
- How findings will feed into next phases
|
|
||||||
- Which team members should review results
|
|
||||||
- How to validate findings
|
|
||||||
- When to revisit or expand research
|
|
||||||
|
|
||||||
## Important Notes
|
|
||||||
|
|
||||||
- The quality of the research prompt directly impacts the quality of insights gathered
|
|
||||||
- Be specific rather than general in research questions
|
|
||||||
- Consider both current state and future implications
|
|
||||||
- Balance comprehensiveness with focus
|
|
||||||
- Document assumptions and limitations clearly
|
|
||||||
- Plan for iterative refinement based on initial findings
|
|
||||||
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
|
||||||
|
|
||||||
==================== START: .bmad-core/tasks/create-doc.md ====================
|
==================== START: .bmad-core/tasks/create-doc.md ====================
|
||||||
# Create Document from Template (YAML Driven)
|
# Create Document from Template (YAML Driven)
|
||||||
|
|
||||||
|
|
@ -656,7 +361,7 @@ sections:
|
||||||
title: Introduction
|
title: Introduction
|
||||||
instruction: |
|
instruction: |
|
||||||
Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.
|
Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.
|
||||||
|
|
||||||
Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
||||||
content: |
|
content: |
|
||||||
This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{project_name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
|
This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{project_name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
|
||||||
|
|
@ -665,7 +370,7 @@ sections:
|
||||||
title: Overall UX Goals & Principles
|
title: Overall UX Goals & Principles
|
||||||
instruction: |
|
instruction: |
|
||||||
Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
||||||
|
|
||||||
1. Target User Personas - elicit details or confirm existing ones from PRD
|
1. Target User Personas - elicit details or confirm existing ones from PRD
|
||||||
2. Key Usability Goals - understand what success looks like for users
|
2. Key Usability Goals - understand what success looks like for users
|
||||||
3. Core Design Principles - establish 3-5 guiding principles
|
3. Core Design Principles - establish 3-5 guiding principles
|
||||||
|
|
@ -706,7 +411,7 @@ sections:
|
||||||
title: Information Architecture (IA)
|
title: Information Architecture (IA)
|
||||||
instruction: |
|
instruction: |
|
||||||
Collaborate with the user to create a comprehensive information architecture:
|
Collaborate with the user to create a comprehensive information architecture:
|
||||||
|
|
||||||
1. Build a Site Map or Screen Inventory showing all major areas
|
1. Build a Site Map or Screen Inventory showing all major areas
|
||||||
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
||||||
3. Use Mermaid diagrams for visual representation
|
3. Use Mermaid diagrams for visual representation
|
||||||
|
|
@ -736,22 +441,22 @@ sections:
|
||||||
title: Navigation Structure
|
title: Navigation Structure
|
||||||
template: |
|
template: |
|
||||||
**Primary Navigation:** {{primary_nav_description}}
|
**Primary Navigation:** {{primary_nav_description}}
|
||||||
|
|
||||||
**Secondary Navigation:** {{secondary_nav_description}}
|
**Secondary Navigation:** {{secondary_nav_description}}
|
||||||
|
|
||||||
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
||||||
|
|
||||||
- id: user-flows
|
- id: user-flows
|
||||||
title: User Flows
|
title: User Flows
|
||||||
instruction: |
|
instruction: |
|
||||||
For each critical user task identified in the PRD:
|
For each critical user task identified in the PRD:
|
||||||
|
|
||||||
1. Define the user's goal clearly
|
1. Define the user's goal clearly
|
||||||
2. Map out all steps including decision points
|
2. Map out all steps including decision points
|
||||||
3. Consider edge cases and error states
|
3. Consider edge cases and error states
|
||||||
4. Use Mermaid flow diagrams for clarity
|
4. Use Mermaid flow diagrams for clarity
|
||||||
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
||||||
|
|
||||||
Create subsections for each major flow.
|
Create subsections for each major flow.
|
||||||
elicit: true
|
elicit: true
|
||||||
repeatable: true
|
repeatable: true
|
||||||
|
|
@ -760,9 +465,9 @@ sections:
|
||||||
title: "{{flow_name}}"
|
title: "{{flow_name}}"
|
||||||
template: |
|
template: |
|
||||||
**User Goal:** {{flow_goal}}
|
**User Goal:** {{flow_goal}}
|
||||||
|
|
||||||
**Entry Points:** {{entry_points}}
|
**Entry Points:** {{entry_points}}
|
||||||
|
|
||||||
**Success Criteria:** {{success_criteria}}
|
**Success Criteria:** {{success_criteria}}
|
||||||
sections:
|
sections:
|
||||||
- id: flow-diagram
|
- id: flow-diagram
|
||||||
|
|
@ -793,14 +498,14 @@ sections:
|
||||||
title: "{{screen_name}}"
|
title: "{{screen_name}}"
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** {{screen_purpose}}
|
**Purpose:** {{screen_purpose}}
|
||||||
|
|
||||||
**Key Elements:**
|
**Key Elements:**
|
||||||
- {{element_1}}
|
- {{element_1}}
|
||||||
- {{element_2}}
|
- {{element_2}}
|
||||||
- {{element_3}}
|
- {{element_3}}
|
||||||
|
|
||||||
**Interaction Notes:** {{interaction_notes}}
|
**Interaction Notes:** {{interaction_notes}}
|
||||||
|
|
||||||
**Design File Reference:** {{specific_frame_link}}
|
**Design File Reference:** {{specific_frame_link}}
|
||||||
|
|
||||||
- id: component-library
|
- id: component-library
|
||||||
|
|
@ -819,11 +524,11 @@ sections:
|
||||||
title: "{{component_name}}"
|
title: "{{component_name}}"
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** {{component_purpose}}
|
**Purpose:** {{component_purpose}}
|
||||||
|
|
||||||
**Variants:** {{component_variants}}
|
**Variants:** {{component_variants}}
|
||||||
|
|
||||||
**States:** {{component_states}}
|
**States:** {{component_states}}
|
||||||
|
|
||||||
**Usage Guidelines:** {{usage_guidelines}}
|
**Usage Guidelines:** {{usage_guidelines}}
|
||||||
|
|
||||||
- id: branding-style
|
- id: branding-style
|
||||||
|
|
@ -869,13 +574,13 @@ sections:
|
||||||
title: Iconography
|
title: Iconography
|
||||||
template: |
|
template: |
|
||||||
**Icon Library:** {{icon_library}}
|
**Icon Library:** {{icon_library}}
|
||||||
|
|
||||||
**Usage Guidelines:** {{icon_guidelines}}
|
**Usage Guidelines:** {{icon_guidelines}}
|
||||||
- id: spacing-layout
|
- id: spacing-layout
|
||||||
title: Spacing & Layout
|
title: Spacing & Layout
|
||||||
template: |
|
template: |
|
||||||
**Grid System:** {{grid_system}}
|
**Grid System:** {{grid_system}}
|
||||||
|
|
||||||
**Spacing Scale:** {{spacing_scale}}
|
**Spacing Scale:** {{spacing_scale}}
|
||||||
|
|
||||||
- id: accessibility
|
- id: accessibility
|
||||||
|
|
@ -893,12 +598,12 @@ sections:
|
||||||
- Color contrast ratios: {{contrast_requirements}}
|
- Color contrast ratios: {{contrast_requirements}}
|
||||||
- Focus indicators: {{focus_requirements}}
|
- Focus indicators: {{focus_requirements}}
|
||||||
- Text sizing: {{text_requirements}}
|
- Text sizing: {{text_requirements}}
|
||||||
|
|
||||||
**Interaction:**
|
**Interaction:**
|
||||||
- Keyboard navigation: {{keyboard_requirements}}
|
- Keyboard navigation: {{keyboard_requirements}}
|
||||||
- Screen reader support: {{screen_reader_requirements}}
|
- Screen reader support: {{screen_reader_requirements}}
|
||||||
- Touch targets: {{touch_requirements}}
|
- Touch targets: {{touch_requirements}}
|
||||||
|
|
||||||
**Content:**
|
**Content:**
|
||||||
- Alternative text: {{alt_text_requirements}}
|
- Alternative text: {{alt_text_requirements}}
|
||||||
- Heading structure: {{heading_requirements}}
|
- Heading structure: {{heading_requirements}}
|
||||||
|
|
@ -925,11 +630,11 @@ sections:
|
||||||
title: Adaptation Patterns
|
title: Adaptation Patterns
|
||||||
template: |
|
template: |
|
||||||
**Layout Changes:** {{layout_adaptations}}
|
**Layout Changes:** {{layout_adaptations}}
|
||||||
|
|
||||||
**Navigation Changes:** {{nav_adaptations}}
|
**Navigation Changes:** {{nav_adaptations}}
|
||||||
|
|
||||||
**Content Priority:** {{content_adaptations}}
|
**Content Priority:** {{content_adaptations}}
|
||||||
|
|
||||||
**Interaction Changes:** {{interaction_adaptations}}
|
**Interaction Changes:** {{interaction_adaptations}}
|
||||||
|
|
||||||
- id: animation
|
- id: animation
|
||||||
|
|
@ -963,7 +668,7 @@ sections:
|
||||||
title: Next Steps
|
title: Next Steps
|
||||||
instruction: |
|
instruction: |
|
||||||
After completing the UI/UX specification:
|
After completing the UI/UX specification:
|
||||||
|
|
||||||
1. Recommend review with stakeholders
|
1. Recommend review with stakeholders
|
||||||
2. Suggest creating/updating visual designs in design tool
|
2. Suggest creating/updating visual designs in design tool
|
||||||
3. Prepare for handoff to Design Architect for frontend architecture
|
3. Prepare for handoff to Design Architect for frontend architecture
|
||||||
|
|
@ -990,7 +695,47 @@ sections:
|
||||||
==================== END: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
|
==================== END: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
|
||||||
|
|
||||||
==================== START: .bmad-core/data/technical-preferences.md ====================
|
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# Technical Preferences and Architectural Principles
|
||||||
|
|
||||||
|
## Core Principles References
|
||||||
|
|
||||||
|
The following technical principles and standards apply to all BMAD projects:
|
||||||
|
|
||||||
|
### 1. Coding Standards
|
||||||
|
- **Reference:** `coding-standards.md`
|
||||||
|
- **Purpose:** Fundamental coding principles, security practices, and quality standards
|
||||||
|
- **Key Areas:** Code simplicity, dependency management, security, testing, commit standards
|
||||||
|
|
||||||
|
### 2. Twelve-Factor App Principles
|
||||||
|
- **Reference:** `twelve-factor-principles.md`
|
||||||
|
- **Purpose:** Cloud-native application development principles
|
||||||
|
- **Key Areas:** Codebase management, dependencies, config, backing services, build/release/run
|
||||||
|
|
||||||
|
### 3. Microservice Patterns
|
||||||
|
- **Reference:** `microservice-patterns.md`
|
||||||
|
- **Purpose:** Patterns for distributed system architecture
|
||||||
|
- **Key Areas:** Service decomposition, communication patterns, data management, resilience
|
||||||
|
|
||||||
|
## Application Guidelines
|
||||||
|
|
||||||
|
1. **During Architecture Design:**
|
||||||
|
- Apply twelve-factor principles for cloud-native applications
|
||||||
|
- Consider microservice patterns for complex distributed systems
|
||||||
|
- Document pattern choices in Architecture Decision Records (ADRs)
|
||||||
|
|
||||||
|
2. **During Implementation:**
|
||||||
|
- Follow coding standards for all code generation
|
||||||
|
- Apply security principles by default
|
||||||
|
- Ensure testability and maintainability
|
||||||
|
|
||||||
|
3. **Technology Selection:**
|
||||||
|
- Prefer simple, proven solutions over complex ones
|
||||||
|
- Minimize dependencies unless explicitly justified
|
||||||
|
- Consider operational complexity alongside technical capabilities
|
||||||
|
|
||||||
|
## User-Defined Preferences
|
||||||
|
|
||||||
|
_Add project-specific technical preferences below:_
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: .bmad-core/data/technical-preferences.md ====================
|
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||||
|
|
|
||||||
|
|
@ -1028,7 +1028,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
||||||
|
|
||||||
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
||||||
|
|
||||||
- id: executive-summary
|
- id: executive-summary
|
||||||
|
|
@ -1073,7 +1073,7 @@ sections:
|
||||||
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
||||||
template: |
|
template: |
|
||||||
**Primary Loop ({{duration}} seconds):**
|
**Primary Loop ({{duration}} seconds):**
|
||||||
|
|
||||||
1. {{action_1}} ({{time_1}}s)
|
1. {{action_1}} ({{time_1}}s)
|
||||||
2. {{action_2}} ({{time_2}}s)
|
2. {{action_2}} ({{time_2}}s)
|
||||||
3. {{action_3}} ({{time_3}}s)
|
3. {{action_3}} ({{time_3}}s)
|
||||||
|
|
@ -1083,12 +1083,12 @@ sections:
|
||||||
instruction: Clearly define success and failure states
|
instruction: Clearly define success and failure states
|
||||||
template: |
|
template: |
|
||||||
**Victory Conditions:**
|
**Victory Conditions:**
|
||||||
|
|
||||||
- {{win_condition_1}}
|
- {{win_condition_1}}
|
||||||
- {{win_condition_2}}
|
- {{win_condition_2}}
|
||||||
|
|
||||||
**Failure States:**
|
**Failure States:**
|
||||||
|
|
||||||
- {{loss_condition_1}}
|
- {{loss_condition_1}}
|
||||||
- {{loss_condition_2}}
|
- {{loss_condition_2}}
|
||||||
|
|
||||||
|
|
@ -1104,17 +1104,17 @@ sections:
|
||||||
title: "{{mechanic_name}}"
|
title: "{{mechanic_name}}"
|
||||||
template: |
|
template: |
|
||||||
**Description:** {{detailed_description}}
|
**Description:** {{detailed_description}}
|
||||||
|
|
||||||
**Player Input:** {{input_method}}
|
**Player Input:** {{input_method}}
|
||||||
|
|
||||||
**System Response:** {{game_response}}
|
**System Response:** {{game_response}}
|
||||||
|
|
||||||
**Implementation Notes:**
|
**Implementation Notes:**
|
||||||
|
|
||||||
- {{tech_requirement_1}}
|
- {{tech_requirement_1}}
|
||||||
- {{tech_requirement_2}}
|
- {{tech_requirement_2}}
|
||||||
- {{performance_consideration}}
|
- {{performance_consideration}}
|
||||||
|
|
||||||
**Dependencies:** {{other_mechanics_needed}}
|
**Dependencies:** {{other_mechanics_needed}}
|
||||||
- id: controls
|
- id: controls
|
||||||
title: Controls
|
title: Controls
|
||||||
|
|
@ -1133,9 +1133,9 @@ sections:
|
||||||
title: Player Progression
|
title: Player Progression
|
||||||
template: |
|
template: |
|
||||||
**Progression Type:** {{linear|branching|metroidvania}}
|
**Progression Type:** {{linear|branching|metroidvania}}
|
||||||
|
|
||||||
**Key Milestones:**
|
**Key Milestones:**
|
||||||
|
|
||||||
1. **{{milestone_1}}** - {{unlock_description}}
|
1. **{{milestone_1}}** - {{unlock_description}}
|
||||||
2. **{{milestone_2}}** - {{unlock_description}}
|
2. **{{milestone_2}}** - {{unlock_description}}
|
||||||
3. **{{milestone_3}}** - {{unlock_description}}
|
3. **{{milestone_3}}** - {{unlock_description}}
|
||||||
|
|
@ -1172,9 +1172,9 @@ sections:
|
||||||
**Duration:** {{target_time}}
|
**Duration:** {{target_time}}
|
||||||
**Key Elements:** {{required_mechanics}}
|
**Key Elements:** {{required_mechanics}}
|
||||||
**Difficulty:** {{relative_difficulty}}
|
**Difficulty:** {{relative_difficulty}}
|
||||||
|
|
||||||
**Structure Template:**
|
**Structure Template:**
|
||||||
|
|
||||||
- Introduction: {{intro_description}}
|
- Introduction: {{intro_description}}
|
||||||
- Challenge: {{main_challenge}}
|
- Challenge: {{main_challenge}}
|
||||||
- Resolution: {{completion_requirement}}
|
- Resolution: {{completion_requirement}}
|
||||||
|
|
@ -1200,13 +1200,13 @@ sections:
|
||||||
title: Platform Specific
|
title: Platform Specific
|
||||||
template: |
|
template: |
|
||||||
**Desktop:**
|
**Desktop:**
|
||||||
|
|
||||||
- Resolution: {{min_resolution}} - {{max_resolution}}
|
- Resolution: {{min_resolution}} - {{max_resolution}}
|
||||||
- Input: Keyboard, Mouse, Gamepad
|
- Input: Keyboard, Mouse, Gamepad
|
||||||
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
||||||
|
|
||||||
**Mobile:**
|
**Mobile:**
|
||||||
|
|
||||||
- Resolution: {{mobile_min}} - {{mobile_max}}
|
- Resolution: {{mobile_min}} - {{mobile_max}}
|
||||||
- Input: Touch, Tilt (optional)
|
- Input: Touch, Tilt (optional)
|
||||||
- OS: iOS 13+, Android 8+
|
- OS: iOS 13+, Android 8+
|
||||||
|
|
@ -1215,14 +1215,14 @@ sections:
|
||||||
instruction: Define asset specifications for the art and audio teams
|
instruction: Define asset specifications for the art and audio teams
|
||||||
template: |
|
template: |
|
||||||
**Visual Assets:**
|
**Visual Assets:**
|
||||||
|
|
||||||
- Art Style: {{style_description}}
|
- Art Style: {{style_description}}
|
||||||
- Color Palette: {{color_specification}}
|
- Color Palette: {{color_specification}}
|
||||||
- Animation: {{animation_requirements}}
|
- Animation: {{animation_requirements}}
|
||||||
- UI Resolution: {{ui_specs}}
|
- UI Resolution: {{ui_specs}}
|
||||||
|
|
||||||
**Audio Assets:**
|
**Audio Assets:**
|
||||||
|
|
||||||
- Music Style: {{music_genre}}
|
- Music Style: {{music_genre}}
|
||||||
- Sound Effects: {{sfx_requirements}}
|
- Sound Effects: {{sfx_requirements}}
|
||||||
- Voice Acting: {{voice_needs}}
|
- Voice Acting: {{voice_needs}}
|
||||||
|
|
@ -1235,7 +1235,7 @@ sections:
|
||||||
title: Engine Configuration
|
title: Engine Configuration
|
||||||
template: |
|
template: |
|
||||||
**Phaser 3 Setup:**
|
**Phaser 3 Setup:**
|
||||||
|
|
||||||
- TypeScript: Strict mode enabled
|
- TypeScript: Strict mode enabled
|
||||||
- Physics: {{physics_system}} (Arcade/Matter)
|
- Physics: {{physics_system}} (Arcade/Matter)
|
||||||
- Renderer: WebGL with Canvas fallback
|
- Renderer: WebGL with Canvas fallback
|
||||||
|
|
@ -1244,7 +1244,7 @@ sections:
|
||||||
title: Code Architecture
|
title: Code Architecture
|
||||||
template: |
|
template: |
|
||||||
**Required Systems:**
|
**Required Systems:**
|
||||||
|
|
||||||
- Scene Management
|
- Scene Management
|
||||||
- State Management
|
- State Management
|
||||||
- Asset Loading
|
- Asset Loading
|
||||||
|
|
@ -1256,7 +1256,7 @@ sections:
|
||||||
title: Data Management
|
title: Data Management
|
||||||
template: |
|
template: |
|
||||||
**Save Data:**
|
**Save Data:**
|
||||||
|
|
||||||
- Progress tracking
|
- Progress tracking
|
||||||
- Settings persistence
|
- Settings persistence
|
||||||
- Statistics collection
|
- Statistics collection
|
||||||
|
|
@ -1374,7 +1374,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
||||||
|
|
||||||
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
|
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
|
||||||
|
|
||||||
- id: introduction
|
- id: introduction
|
||||||
|
|
@ -1382,7 +1382,7 @@ sections:
|
||||||
instruction: Establish the purpose and scope of level design for this game
|
instruction: Establish the purpose and scope of level design for this game
|
||||||
content: |
|
content: |
|
||||||
This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
||||||
|
|
||||||
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
||||||
sections:
|
sections:
|
||||||
- id: change-log
|
- id: change-log
|
||||||
|
|
@ -1429,29 +1429,29 @@ sections:
|
||||||
title: "{{category_name}} Levels"
|
title: "{{category_name}} Levels"
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** {{gameplay_purpose}}
|
**Purpose:** {{gameplay_purpose}}
|
||||||
|
|
||||||
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
||||||
|
|
||||||
**Difficulty Range:** {{difficulty_scale}}
|
**Difficulty Range:** {{difficulty_scale}}
|
||||||
|
|
||||||
**Key Mechanics Featured:**
|
**Key Mechanics Featured:**
|
||||||
|
|
||||||
- {{mechanic_1}} - {{usage_description}}
|
- {{mechanic_1}} - {{usage_description}}
|
||||||
- {{mechanic_2}} - {{usage_description}}
|
- {{mechanic_2}} - {{usage_description}}
|
||||||
|
|
||||||
**Player Objectives:**
|
**Player Objectives:**
|
||||||
|
|
||||||
- Primary: {{primary_objective}}
|
- Primary: {{primary_objective}}
|
||||||
- Secondary: {{secondary_objective}}
|
- Secondary: {{secondary_objective}}
|
||||||
- Hidden: {{secret_objective}}
|
- Hidden: {{secret_objective}}
|
||||||
|
|
||||||
**Success Criteria:**
|
**Success Criteria:**
|
||||||
|
|
||||||
- {{completion_requirement_1}}
|
- {{completion_requirement_1}}
|
||||||
- {{completion_requirement_2}}
|
- {{completion_requirement_2}}
|
||||||
|
|
||||||
**Technical Requirements:**
|
**Technical Requirements:**
|
||||||
|
|
||||||
- Maximum entities: {{entity_limit}}
|
- Maximum entities: {{entity_limit}}
|
||||||
- Performance target: {{fps_target}} FPS
|
- Performance target: {{fps_target}} FPS
|
||||||
- Memory budget: {{memory_limit}}MB
|
- Memory budget: {{memory_limit}}MB
|
||||||
|
|
@ -1466,11 +1466,11 @@ sections:
|
||||||
instruction: Based on GDD requirements, define the overall level organization
|
instruction: Based on GDD requirements, define the overall level organization
|
||||||
template: |
|
template: |
|
||||||
**Organization Type:** {{linear|hub_world|open_world}}
|
**Organization Type:** {{linear|hub_world|open_world}}
|
||||||
|
|
||||||
**Total Level Count:** {{number}}
|
**Total Level Count:** {{number}}
|
||||||
|
|
||||||
**World Breakdown:**
|
**World Breakdown:**
|
||||||
|
|
||||||
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||||
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||||
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||||
|
|
@ -1505,7 +1505,7 @@ sections:
|
||||||
instruction: Define how players access new levels
|
instruction: Define how players access new levels
|
||||||
template: |
|
template: |
|
||||||
**Progression Gates:**
|
**Progression Gates:**
|
||||||
|
|
||||||
- Linear progression: Complete previous level
|
- Linear progression: Complete previous level
|
||||||
- Star requirements: {{star_count}} stars to unlock
|
- Star requirements: {{star_count}} stars to unlock
|
||||||
- Skill gates: Demonstrate {{skill_requirement}}
|
- Skill gates: Demonstrate {{skill_requirement}}
|
||||||
|
|
@ -1520,17 +1520,17 @@ sections:
|
||||||
instruction: Define all environmental components that can be used in levels
|
instruction: Define all environmental components that can be used in levels
|
||||||
template: |
|
template: |
|
||||||
**Terrain Types:**
|
**Terrain Types:**
|
||||||
|
|
||||||
- {{terrain_1}}: {{properties_and_usage}}
|
- {{terrain_1}}: {{properties_and_usage}}
|
||||||
- {{terrain_2}}: {{properties_and_usage}}
|
- {{terrain_2}}: {{properties_and_usage}}
|
||||||
|
|
||||||
**Interactive Objects:**
|
**Interactive Objects:**
|
||||||
|
|
||||||
- {{object_1}}: {{behavior_and_purpose}}
|
- {{object_1}}: {{behavior_and_purpose}}
|
||||||
- {{object_2}}: {{behavior_and_purpose}}
|
- {{object_2}}: {{behavior_and_purpose}}
|
||||||
|
|
||||||
**Hazards and Obstacles:**
|
**Hazards and Obstacles:**
|
||||||
|
|
||||||
- {{hazard_1}}: {{damage_and_behavior}}
|
- {{hazard_1}}: {{damage_and_behavior}}
|
||||||
- {{hazard_2}}: {{damage_and_behavior}}
|
- {{hazard_2}}: {{damage_and_behavior}}
|
||||||
- id: collectibles-rewards
|
- id: collectibles-rewards
|
||||||
|
|
@ -1538,18 +1538,18 @@ sections:
|
||||||
instruction: Define all collectible items and their placement rules
|
instruction: Define all collectible items and their placement rules
|
||||||
template: |
|
template: |
|
||||||
**Collectible Types:**
|
**Collectible Types:**
|
||||||
|
|
||||||
- {{collectible_1}}: {{value_and_purpose}}
|
- {{collectible_1}}: {{value_and_purpose}}
|
||||||
- {{collectible_2}}: {{value_and_purpose}}
|
- {{collectible_2}}: {{value_and_purpose}}
|
||||||
|
|
||||||
**Placement Guidelines:**
|
**Placement Guidelines:**
|
||||||
|
|
||||||
- Mandatory collectibles: {{placement_rules}}
|
- Mandatory collectibles: {{placement_rules}}
|
||||||
- Optional collectibles: {{placement_rules}}
|
- Optional collectibles: {{placement_rules}}
|
||||||
- Secret collectibles: {{placement_rules}}
|
- Secret collectibles: {{placement_rules}}
|
||||||
|
|
||||||
**Reward Distribution:**
|
**Reward Distribution:**
|
||||||
|
|
||||||
- Easy to find: {{percentage}}%
|
- Easy to find: {{percentage}}%
|
||||||
- Moderate challenge: {{percentage}}%
|
- Moderate challenge: {{percentage}}%
|
||||||
- High skill required: {{percentage}}%
|
- High skill required: {{percentage}}%
|
||||||
|
|
@ -1558,18 +1558,18 @@ sections:
|
||||||
instruction: Define how enemies should be placed and balanced in levels
|
instruction: Define how enemies should be placed and balanced in levels
|
||||||
template: |
|
template: |
|
||||||
**Enemy Categories:**
|
**Enemy Categories:**
|
||||||
|
|
||||||
- {{enemy_type_1}}: {{behavior_and_usage}}
|
- {{enemy_type_1}}: {{behavior_and_usage}}
|
||||||
- {{enemy_type_2}}: {{behavior_and_usage}}
|
- {{enemy_type_2}}: {{behavior_and_usage}}
|
||||||
|
|
||||||
**Placement Principles:**
|
**Placement Principles:**
|
||||||
|
|
||||||
- Introduction encounters: {{guideline}}
|
- Introduction encounters: {{guideline}}
|
||||||
- Standard encounters: {{guideline}}
|
- Standard encounters: {{guideline}}
|
||||||
- Challenge encounters: {{guideline}}
|
- Challenge encounters: {{guideline}}
|
||||||
|
|
||||||
**Difficulty Scaling:**
|
**Difficulty Scaling:**
|
||||||
|
|
||||||
- Enemy count progression: {{scaling_rule}}
|
- Enemy count progression: {{scaling_rule}}
|
||||||
- Enemy type introduction: {{pacing_rule}}
|
- Enemy type introduction: {{pacing_rule}}
|
||||||
- Encounter complexity: {{complexity_rule}}
|
- Encounter complexity: {{complexity_rule}}
|
||||||
|
|
@ -1582,14 +1582,14 @@ sections:
|
||||||
title: Level Layout Principles
|
title: Level Layout Principles
|
||||||
template: |
|
template: |
|
||||||
**Spatial Design:**
|
**Spatial Design:**
|
||||||
|
|
||||||
- Grid size: {{grid_dimensions}}
|
- Grid size: {{grid_dimensions}}
|
||||||
- Minimum path width: {{width_units}}
|
- Minimum path width: {{width_units}}
|
||||||
- Maximum vertical distance: {{height_units}}
|
- Maximum vertical distance: {{height_units}}
|
||||||
- Safe zones placement: {{safety_guidelines}}
|
- Safe zones placement: {{safety_guidelines}}
|
||||||
|
|
||||||
**Navigation Design:**
|
**Navigation Design:**
|
||||||
|
|
||||||
- Clear path indication: {{visual_cues}}
|
- Clear path indication: {{visual_cues}}
|
||||||
- Landmark placement: {{landmark_rules}}
|
- Landmark placement: {{landmark_rules}}
|
||||||
- Dead end avoidance: {{dead_end_policy}}
|
- Dead end avoidance: {{dead_end_policy}}
|
||||||
|
|
@ -1599,13 +1599,13 @@ sections:
|
||||||
instruction: Define how to control the rhythm and pace of gameplay within levels
|
instruction: Define how to control the rhythm and pace of gameplay within levels
|
||||||
template: |
|
template: |
|
||||||
**Action Sequences:**
|
**Action Sequences:**
|
||||||
|
|
||||||
- High intensity duration: {{max_duration}}
|
- High intensity duration: {{max_duration}}
|
||||||
- Rest period requirement: {{min_rest_time}}
|
- Rest period requirement: {{min_rest_time}}
|
||||||
- Intensity variation: {{pacing_pattern}}
|
- Intensity variation: {{pacing_pattern}}
|
||||||
|
|
||||||
**Learning Sequences:**
|
**Learning Sequences:**
|
||||||
|
|
||||||
- New mechanic introduction: {{teaching_method}}
|
- New mechanic introduction: {{teaching_method}}
|
||||||
- Practice opportunity: {{practice_duration}}
|
- Practice opportunity: {{practice_duration}}
|
||||||
- Skill application: {{application_context}}
|
- Skill application: {{application_context}}
|
||||||
|
|
@ -1614,14 +1614,14 @@ sections:
|
||||||
instruction: Define how to create appropriate challenges for each level type
|
instruction: Define how to create appropriate challenges for each level type
|
||||||
template: |
|
template: |
|
||||||
**Challenge Types:**
|
**Challenge Types:**
|
||||||
|
|
||||||
- Execution challenges: {{skill_requirements}}
|
- Execution challenges: {{skill_requirements}}
|
||||||
- Puzzle challenges: {{complexity_guidelines}}
|
- Puzzle challenges: {{complexity_guidelines}}
|
||||||
- Time challenges: {{time_pressure_rules}}
|
- Time challenges: {{time_pressure_rules}}
|
||||||
- Resource challenges: {{resource_management}}
|
- Resource challenges: {{resource_management}}
|
||||||
|
|
||||||
**Difficulty Calibration:**
|
**Difficulty Calibration:**
|
||||||
|
|
||||||
- Skill check frequency: {{frequency_guidelines}}
|
- Skill check frequency: {{frequency_guidelines}}
|
||||||
- Failure recovery: {{retry_mechanics}}
|
- Failure recovery: {{retry_mechanics}}
|
||||||
- Hint system integration: {{help_system}}
|
- Hint system integration: {{help_system}}
|
||||||
|
|
@ -1635,7 +1635,7 @@ sections:
|
||||||
instruction: Define how level data should be structured for implementation
|
instruction: Define how level data should be structured for implementation
|
||||||
template: |
|
template: |
|
||||||
**Level File Format:**
|
**Level File Format:**
|
||||||
|
|
||||||
- Data format: {{json|yaml|custom}}
|
- Data format: {{json|yaml|custom}}
|
||||||
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
||||||
- Data organization: {{structure_description}}
|
- Data organization: {{structure_description}}
|
||||||
|
|
@ -1673,14 +1673,14 @@ sections:
|
||||||
instruction: Define how level assets are organized and loaded
|
instruction: Define how level assets are organized and loaded
|
||||||
template: |
|
template: |
|
||||||
**Tilemap Requirements:**
|
**Tilemap Requirements:**
|
||||||
|
|
||||||
- Tile size: {{tile_dimensions}}px
|
- Tile size: {{tile_dimensions}}px
|
||||||
- Tileset organization: {{tileset_structure}}
|
- Tileset organization: {{tileset_structure}}
|
||||||
- Layer organization: {{layer_system}}
|
- Layer organization: {{layer_system}}
|
||||||
- Collision data: {{collision_format}}
|
- Collision data: {{collision_format}}
|
||||||
|
|
||||||
**Audio Integration:**
|
**Audio Integration:**
|
||||||
|
|
||||||
- Background music: {{music_requirements}}
|
- Background music: {{music_requirements}}
|
||||||
- Ambient sounds: {{ambient_system}}
|
- Ambient sounds: {{ambient_system}}
|
||||||
- Dynamic audio: {{dynamic_audio_rules}}
|
- Dynamic audio: {{dynamic_audio_rules}}
|
||||||
|
|
@ -1689,19 +1689,19 @@ sections:
|
||||||
instruction: Define performance requirements for level systems
|
instruction: Define performance requirements for level systems
|
||||||
template: |
|
template: |
|
||||||
**Entity Limits:**
|
**Entity Limits:**
|
||||||
|
|
||||||
- Maximum active entities: {{entity_limit}}
|
- Maximum active entities: {{entity_limit}}
|
||||||
- Maximum particles: {{particle_limit}}
|
- Maximum particles: {{particle_limit}}
|
||||||
- Maximum audio sources: {{audio_limit}}
|
- Maximum audio sources: {{audio_limit}}
|
||||||
|
|
||||||
**Memory Management:**
|
**Memory Management:**
|
||||||
|
|
||||||
- Texture memory budget: {{texture_memory}}MB
|
- Texture memory budget: {{texture_memory}}MB
|
||||||
- Audio memory budget: {{audio_memory}}MB
|
- Audio memory budget: {{audio_memory}}MB
|
||||||
- Level loading time: <{{load_time}}s
|
- Level loading time: <{{load_time}}s
|
||||||
|
|
||||||
**Culling and LOD:**
|
**Culling and LOD:**
|
||||||
|
|
||||||
- Off-screen culling: {{culling_distance}}
|
- Off-screen culling: {{culling_distance}}
|
||||||
- Level-of-detail rules: {{lod_system}}
|
- Level-of-detail rules: {{lod_system}}
|
||||||
- Asset streaming: {{streaming_requirements}}
|
- Asset streaming: {{streaming_requirements}}
|
||||||
|
|
@ -1714,13 +1714,13 @@ sections:
|
||||||
title: Automated Testing
|
title: Automated Testing
|
||||||
template: |
|
template: |
|
||||||
**Performance Testing:**
|
**Performance Testing:**
|
||||||
|
|
||||||
- Frame rate validation: Maintain {{fps_target}} FPS
|
- Frame rate validation: Maintain {{fps_target}} FPS
|
||||||
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
||||||
- Loading time verification: Complete in <{{load_time}}s
|
- Loading time verification: Complete in <{{load_time}}s
|
||||||
|
|
||||||
**Gameplay Testing:**
|
**Gameplay Testing:**
|
||||||
|
|
||||||
- Completion path validation: All objectives achievable
|
- Completion path validation: All objectives achievable
|
||||||
- Collectible accessibility: All items reachable
|
- Collectible accessibility: All items reachable
|
||||||
- Softlock prevention: No unwinnable states
|
- Softlock prevention: No unwinnable states
|
||||||
|
|
@ -1748,14 +1748,14 @@ sections:
|
||||||
title: Balance Validation
|
title: Balance Validation
|
||||||
template: |
|
template: |
|
||||||
**Metrics Collection:**
|
**Metrics Collection:**
|
||||||
|
|
||||||
- Completion rate: Target {{completion_percentage}}%
|
- Completion rate: Target {{completion_percentage}}%
|
||||||
- Average completion time: {{target_time}} ± {{variance}}
|
- Average completion time: {{target_time}} ± {{variance}}
|
||||||
- Death count per level: <{{max_deaths}}
|
- Death count per level: <{{max_deaths}}
|
||||||
- Collectible discovery rate: {{discovery_percentage}}%
|
- Collectible discovery rate: {{discovery_percentage}}%
|
||||||
|
|
||||||
**Iteration Guidelines:**
|
**Iteration Guidelines:**
|
||||||
|
|
||||||
- Adjustment criteria: {{criteria_for_changes}}
|
- Adjustment criteria: {{criteria_for_changes}}
|
||||||
- Testing sample size: {{minimum_testers}}
|
- Testing sample size: {{minimum_testers}}
|
||||||
- Validation period: {{testing_duration}}
|
- Validation period: {{testing_duration}}
|
||||||
|
|
@ -1768,14 +1768,14 @@ sections:
|
||||||
title: Design Phase
|
title: Design Phase
|
||||||
template: |
|
template: |
|
||||||
**Concept Development:**
|
**Concept Development:**
|
||||||
|
|
||||||
1. Define level purpose and goals
|
1. Define level purpose and goals
|
||||||
2. Create rough layout sketch
|
2. Create rough layout sketch
|
||||||
3. Identify key mechanics and challenges
|
3. Identify key mechanics and challenges
|
||||||
4. Estimate difficulty and duration
|
4. Estimate difficulty and duration
|
||||||
|
|
||||||
**Documentation Requirements:**
|
**Documentation Requirements:**
|
||||||
|
|
||||||
- Level design brief
|
- Level design brief
|
||||||
- Layout diagrams
|
- Layout diagrams
|
||||||
- Mechanic integration notes
|
- Mechanic integration notes
|
||||||
|
|
@ -1784,15 +1784,15 @@ sections:
|
||||||
title: Implementation Phase
|
title: Implementation Phase
|
||||||
template: |
|
template: |
|
||||||
**Technical Implementation:**
|
**Technical Implementation:**
|
||||||
|
|
||||||
1. Create level data file
|
1. Create level data file
|
||||||
2. Build tilemap and layout
|
2. Build tilemap and layout
|
||||||
3. Place entities and objects
|
3. Place entities and objects
|
||||||
4. Configure level logic and triggers
|
4. Configure level logic and triggers
|
||||||
5. Integrate audio and visual effects
|
5. Integrate audio and visual effects
|
||||||
|
|
||||||
**Quality Assurance:**
|
**Quality Assurance:**
|
||||||
|
|
||||||
1. Automated testing execution
|
1. Automated testing execution
|
||||||
2. Internal playtesting
|
2. Internal playtesting
|
||||||
3. Performance validation
|
3. Performance validation
|
||||||
|
|
@ -1801,14 +1801,14 @@ sections:
|
||||||
title: Integration Phase
|
title: Integration Phase
|
||||||
template: |
|
template: |
|
||||||
**Game Integration:**
|
**Game Integration:**
|
||||||
|
|
||||||
1. Level progression integration
|
1. Level progression integration
|
||||||
2. Save system compatibility
|
2. Save system compatibility
|
||||||
3. Analytics integration
|
3. Analytics integration
|
||||||
4. Achievement system integration
|
4. Achievement system integration
|
||||||
|
|
||||||
**Final Validation:**
|
**Final Validation:**
|
||||||
|
|
||||||
1. Full game context testing
|
1. Full game context testing
|
||||||
2. Performance regression testing
|
2. Performance regression testing
|
||||||
3. Platform compatibility verification
|
3. Platform compatibility verification
|
||||||
|
|
@ -1861,7 +1861,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
||||||
|
|
||||||
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
||||||
|
|
||||||
- id: game-vision
|
- id: game-vision
|
||||||
|
|
@ -1918,7 +1918,7 @@ sections:
|
||||||
repeatable: true
|
repeatable: true
|
||||||
template: |
|
template: |
|
||||||
**Core Mechanic: {{mechanic_name}}**
|
**Core Mechanic: {{mechanic_name}}**
|
||||||
|
|
||||||
- **Description:** {{how_it_works}}
|
- **Description:** {{how_it_works}}
|
||||||
- **Player Value:** {{why_its_fun}}
|
- **Player Value:** {{why_its_fun}}
|
||||||
- **Implementation Scope:** {{complexity_estimate}}
|
- **Implementation Scope:** {{complexity_estimate}}
|
||||||
|
|
@ -1945,12 +1945,12 @@ sections:
|
||||||
title: Technical Constraints
|
title: Technical Constraints
|
||||||
template: |
|
template: |
|
||||||
**Platform Requirements:**
|
**Platform Requirements:**
|
||||||
|
|
||||||
- Primary: {{platform_1}} - {{requirements}}
|
- Primary: {{platform_1}} - {{requirements}}
|
||||||
- Secondary: {{platform_2}} - {{requirements}}
|
- Secondary: {{platform_2}} - {{requirements}}
|
||||||
|
|
||||||
**Technical Specifications:**
|
**Technical Specifications:**
|
||||||
|
|
||||||
- Engine: Phaser 3 + TypeScript
|
- Engine: Phaser 3 + TypeScript
|
||||||
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
||||||
- Memory Budget: <{{memory_limit}}MB
|
- Memory Budget: <{{memory_limit}}MB
|
||||||
|
|
@ -1988,10 +1988,10 @@ sections:
|
||||||
title: Competitive Analysis
|
title: Competitive Analysis
|
||||||
template: |
|
template: |
|
||||||
**Direct Competitors:**
|
**Direct Competitors:**
|
||||||
|
|
||||||
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
||||||
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
||||||
|
|
||||||
**Differentiation Strategy:**
|
**Differentiation Strategy:**
|
||||||
{{how_we_differ_and_why_thats_valuable}}
|
{{how_we_differ_and_why_thats_valuable}}
|
||||||
- id: market-opportunity
|
- id: market-opportunity
|
||||||
|
|
@ -2015,16 +2015,16 @@ sections:
|
||||||
title: Content Categories
|
title: Content Categories
|
||||||
template: |
|
template: |
|
||||||
**Core Content:**
|
**Core Content:**
|
||||||
|
|
||||||
- {{content_type_1}}: {{quantity_and_description}}
|
- {{content_type_1}}: {{quantity_and_description}}
|
||||||
- {{content_type_2}}: {{quantity_and_description}}
|
- {{content_type_2}}: {{quantity_and_description}}
|
||||||
|
|
||||||
**Optional Content:**
|
**Optional Content:**
|
||||||
|
|
||||||
- {{optional_content_type}}: {{quantity_and_description}}
|
- {{optional_content_type}}: {{quantity_and_description}}
|
||||||
|
|
||||||
**Replay Elements:**
|
**Replay Elements:**
|
||||||
|
|
||||||
- {{replayability_features}}
|
- {{replayability_features}}
|
||||||
- id: difficulty-accessibility
|
- id: difficulty-accessibility
|
||||||
title: Difficulty and Accessibility
|
title: Difficulty and Accessibility
|
||||||
|
|
@ -2091,13 +2091,13 @@ sections:
|
||||||
title: Player Experience Metrics
|
title: Player Experience Metrics
|
||||||
template: |
|
template: |
|
||||||
**Engagement Goals:**
|
**Engagement Goals:**
|
||||||
|
|
||||||
- Tutorial completion rate: >{{percentage}}%
|
- Tutorial completion rate: >{{percentage}}%
|
||||||
- Average session length: {{duration}} minutes
|
- Average session length: {{duration}} minutes
|
||||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
||||||
|
|
||||||
**Quality Benchmarks:**
|
**Quality Benchmarks:**
|
||||||
|
|
||||||
- Player satisfaction: >{{rating}}/10
|
- Player satisfaction: >{{rating}}/10
|
||||||
- Completion rate: >{{percentage}}%
|
- Completion rate: >{{percentage}}%
|
||||||
- Technical performance: {{fps_target}} FPS consistent
|
- Technical performance: {{fps_target}} FPS consistent
|
||||||
|
|
@ -2105,13 +2105,13 @@ sections:
|
||||||
title: Development Metrics
|
title: Development Metrics
|
||||||
template: |
|
template: |
|
||||||
**Technical Targets:**
|
**Technical Targets:**
|
||||||
|
|
||||||
- Zero critical bugs at launch
|
- Zero critical bugs at launch
|
||||||
- Performance targets met on all platforms
|
- Performance targets met on all platforms
|
||||||
- Load times under {{seconds}}s
|
- Load times under {{seconds}}s
|
||||||
|
|
||||||
**Process Goals:**
|
**Process Goals:**
|
||||||
|
|
||||||
- Development timeline adherence
|
- Development timeline adherence
|
||||||
- Feature scope completion
|
- Feature scope completion
|
||||||
- Quality assurance standards
|
- Quality assurance standards
|
||||||
|
|
@ -2120,7 +2120,7 @@ sections:
|
||||||
condition: has_business_goals
|
condition: has_business_goals
|
||||||
template: |
|
template: |
|
||||||
**Commercial Goals:**
|
**Commercial Goals:**
|
||||||
|
|
||||||
- {{revenue_target}} in first {{time_period}}
|
- {{revenue_target}} in first {{time_period}}
|
||||||
- {{user_acquisition_target}} players in first {{time_period}}
|
- {{user_acquisition_target}} players in first {{time_period}}
|
||||||
- {{retention_target}} monthly active users
|
- {{retention_target}} monthly active users
|
||||||
|
|
@ -2173,12 +2173,12 @@ sections:
|
||||||
title: Validation Plan
|
title: Validation Plan
|
||||||
template: |
|
template: |
|
||||||
**Concept Testing:**
|
**Concept Testing:**
|
||||||
|
|
||||||
- {{validation_method_1}} - {{timeline}}
|
- {{validation_method_1}} - {{timeline}}
|
||||||
- {{validation_method_2}} - {{timeline}}
|
- {{validation_method_2}} - {{timeline}}
|
||||||
|
|
||||||
**Prototype Testing:**
|
**Prototype Testing:**
|
||||||
|
|
||||||
- {{testing_approach}} - {{timeline}}
|
- {{testing_approach}} - {{timeline}}
|
||||||
- {{feedback_collection_method}} - {{timeline}}
|
- {{feedback_collection_method}} - {{timeline}}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -214,7 +214,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
||||||
|
|
||||||
If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.
|
If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.
|
||||||
|
|
||||||
- id: introduction
|
- id: introduction
|
||||||
|
|
@ -222,7 +222,7 @@ sections:
|
||||||
instruction: Establish the document's purpose and scope for game development
|
instruction: Establish the document's purpose and scope for game development
|
||||||
content: |
|
content: |
|
||||||
This document outlines the complete technical architecture for {{game_title}}, a 2D game built with Phaser 3 and TypeScript. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
|
This document outlines the complete technical architecture for {{game_title}}, a 2D game built with Phaser 3 and TypeScript. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
|
||||||
|
|
||||||
This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining 60 FPS performance and cross-platform compatibility.
|
This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining 60 FPS performance and cross-platform compatibility.
|
||||||
sections:
|
sections:
|
||||||
- id: change-log
|
- id: change-log
|
||||||
|
|
@ -241,7 +241,7 @@ sections:
|
||||||
title: Architecture Summary
|
title: Architecture Summary
|
||||||
instruction: |
|
instruction: |
|
||||||
Provide a comprehensive overview covering:
|
Provide a comprehensive overview covering:
|
||||||
|
|
||||||
- Game engine choice and configuration
|
- Game engine choice and configuration
|
||||||
- Project structure and organization
|
- Project structure and organization
|
||||||
- Key systems and their interactions
|
- Key systems and their interactions
|
||||||
|
|
@ -329,23 +329,23 @@ sections:
|
||||||
title: Scene Management System
|
title: Scene Management System
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** Handle game flow and scene transitions
|
**Purpose:** Handle game flow and scene transitions
|
||||||
|
|
||||||
**Key Components:**
|
**Key Components:**
|
||||||
|
|
||||||
- Scene loading and unloading
|
- Scene loading and unloading
|
||||||
- Data passing between scenes
|
- Data passing between scenes
|
||||||
- Transition effects
|
- Transition effects
|
||||||
- Memory management
|
- Memory management
|
||||||
|
|
||||||
**Implementation Requirements:**
|
**Implementation Requirements:**
|
||||||
|
|
||||||
- Preload scene for asset loading
|
- Preload scene for asset loading
|
||||||
- Menu system with navigation
|
- Menu system with navigation
|
||||||
- Gameplay scenes with state management
|
- Gameplay scenes with state management
|
||||||
- Pause/resume functionality
|
- Pause/resume functionality
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/scenes/BootScene.ts`
|
- `src/scenes/BootScene.ts`
|
||||||
- `src/scenes/PreloadScene.ts`
|
- `src/scenes/PreloadScene.ts`
|
||||||
- `src/scenes/MenuScene.ts`
|
- `src/scenes/MenuScene.ts`
|
||||||
|
|
@ -355,23 +355,23 @@ sections:
|
||||||
title: Game State Management
|
title: Game State Management
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** Track player progress and game status
|
**Purpose:** Track player progress and game status
|
||||||
|
|
||||||
**State Categories:**
|
**State Categories:**
|
||||||
|
|
||||||
- Player progress (levels, unlocks)
|
- Player progress (levels, unlocks)
|
||||||
- Game settings (audio, controls)
|
- Game settings (audio, controls)
|
||||||
- Session data (current level, score)
|
- Session data (current level, score)
|
||||||
- Persistent data (achievements, statistics)
|
- Persistent data (achievements, statistics)
|
||||||
|
|
||||||
**Implementation Requirements:**
|
**Implementation Requirements:**
|
||||||
|
|
||||||
- Save/load system with localStorage
|
- Save/load system with localStorage
|
||||||
- State validation and error recovery
|
- State validation and error recovery
|
||||||
- Cross-session data persistence
|
- Cross-session data persistence
|
||||||
- Settings management
|
- Settings management
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/GameState.ts`
|
- `src/systems/GameState.ts`
|
||||||
- `src/systems/SaveManager.ts`
|
- `src/systems/SaveManager.ts`
|
||||||
- `src/types/GameData.ts`
|
- `src/types/GameData.ts`
|
||||||
|
|
@ -379,23 +379,23 @@ sections:
|
||||||
title: Asset Management System
|
title: Asset Management System
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** Efficient loading and management of game assets
|
**Purpose:** Efficient loading and management of game assets
|
||||||
|
|
||||||
**Asset Categories:**
|
**Asset Categories:**
|
||||||
|
|
||||||
- Sprite sheets and animations
|
- Sprite sheets and animations
|
||||||
- Audio files and music
|
- Audio files and music
|
||||||
- Level data and configurations
|
- Level data and configurations
|
||||||
- UI assets and fonts
|
- UI assets and fonts
|
||||||
|
|
||||||
**Implementation Requirements:**
|
**Implementation Requirements:**
|
||||||
|
|
||||||
- Progressive loading strategy
|
- Progressive loading strategy
|
||||||
- Asset caching and optimization
|
- Asset caching and optimization
|
||||||
- Error handling for failed loads
|
- Error handling for failed loads
|
||||||
- Memory management for large assets
|
- Memory management for large assets
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/AssetManager.ts`
|
- `src/systems/AssetManager.ts`
|
||||||
- `src/config/AssetConfig.ts`
|
- `src/config/AssetConfig.ts`
|
||||||
- `src/utils/AssetLoader.ts`
|
- `src/utils/AssetLoader.ts`
|
||||||
|
|
@ -403,23 +403,23 @@ sections:
|
||||||
title: Input Management System
|
title: Input Management System
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** Handle all player input across platforms
|
**Purpose:** Handle all player input across platforms
|
||||||
|
|
||||||
**Input Types:**
|
**Input Types:**
|
||||||
|
|
||||||
- Keyboard controls
|
- Keyboard controls
|
||||||
- Mouse/pointer interaction
|
- Mouse/pointer interaction
|
||||||
- Touch gestures (mobile)
|
- Touch gestures (mobile)
|
||||||
- Gamepad support (optional)
|
- Gamepad support (optional)
|
||||||
|
|
||||||
**Implementation Requirements:**
|
**Implementation Requirements:**
|
||||||
|
|
||||||
- Input mapping and configuration
|
- Input mapping and configuration
|
||||||
- Touch-friendly mobile controls
|
- Touch-friendly mobile controls
|
||||||
- Input buffering for responsive gameplay
|
- Input buffering for responsive gameplay
|
||||||
- Customizable control schemes
|
- Customizable control schemes
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/InputManager.ts`
|
- `src/systems/InputManager.ts`
|
||||||
- `src/utils/TouchControls.ts`
|
- `src/utils/TouchControls.ts`
|
||||||
- `src/types/InputTypes.ts`
|
- `src/types/InputTypes.ts`
|
||||||
|
|
@ -432,19 +432,19 @@ sections:
|
||||||
title: "{{mechanic_name}} System"
|
title: "{{mechanic_name}} System"
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** {{system_purpose}}
|
**Purpose:** {{system_purpose}}
|
||||||
|
|
||||||
**Core Functionality:**
|
**Core Functionality:**
|
||||||
|
|
||||||
- {{feature_1}}
|
- {{feature_1}}
|
||||||
- {{feature_2}}
|
- {{feature_2}}
|
||||||
- {{feature_3}}
|
- {{feature_3}}
|
||||||
|
|
||||||
**Dependencies:** {{required_systems}}
|
**Dependencies:** {{required_systems}}
|
||||||
|
|
||||||
**Performance Considerations:** {{optimization_notes}}
|
**Performance Considerations:** {{optimization_notes}}
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/{{system_name}}.ts`
|
- `src/systems/{{system_name}}.ts`
|
||||||
- `src/gameObjects/{{related_object}}.ts`
|
- `src/gameObjects/{{related_object}}.ts`
|
||||||
- `src/types/{{system_types}}.ts`
|
- `src/types/{{system_types}}.ts`
|
||||||
|
|
@ -452,65 +452,65 @@ sections:
|
||||||
title: Physics & Collision System
|
title: Physics & Collision System
|
||||||
template: |
|
template: |
|
||||||
**Physics Engine:** {{physics_choice}} (Arcade Physics/Matter.js)
|
**Physics Engine:** {{physics_choice}} (Arcade Physics/Matter.js)
|
||||||
|
|
||||||
**Collision Categories:**
|
**Collision Categories:**
|
||||||
|
|
||||||
- Player collision
|
- Player collision
|
||||||
- Enemy interactions
|
- Enemy interactions
|
||||||
- Environmental objects
|
- Environmental objects
|
||||||
- Collectibles and items
|
- Collectibles and items
|
||||||
|
|
||||||
**Implementation Requirements:**
|
**Implementation Requirements:**
|
||||||
|
|
||||||
- Optimized collision detection
|
- Optimized collision detection
|
||||||
- Physics body management
|
- Physics body management
|
||||||
- Collision callbacks and events
|
- Collision callbacks and events
|
||||||
- Performance monitoring
|
- Performance monitoring
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/PhysicsManager.ts`
|
- `src/systems/PhysicsManager.ts`
|
||||||
- `src/utils/CollisionGroups.ts`
|
- `src/utils/CollisionGroups.ts`
|
||||||
- id: audio-system
|
- id: audio-system
|
||||||
title: Audio System
|
title: Audio System
|
||||||
template: |
|
template: |
|
||||||
**Audio Requirements:**
|
**Audio Requirements:**
|
||||||
|
|
||||||
- Background music with looping
|
- Background music with looping
|
||||||
- Sound effects for actions
|
- Sound effects for actions
|
||||||
- Audio settings and volume control
|
- Audio settings and volume control
|
||||||
- Mobile audio optimization
|
- Mobile audio optimization
|
||||||
|
|
||||||
**Implementation Features:**
|
**Implementation Features:**
|
||||||
|
|
||||||
- Audio sprite management
|
- Audio sprite management
|
||||||
- Dynamic music system
|
- Dynamic music system
|
||||||
- Spatial audio (if applicable)
|
- Spatial audio (if applicable)
|
||||||
- Audio pooling for performance
|
- Audio pooling for performance
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/AudioManager.ts`
|
- `src/systems/AudioManager.ts`
|
||||||
- `src/config/AudioConfig.ts`
|
- `src/config/AudioConfig.ts`
|
||||||
- id: ui-system
|
- id: ui-system
|
||||||
title: UI System
|
title: UI System
|
||||||
template: |
|
template: |
|
||||||
**UI Components:**
|
**UI Components:**
|
||||||
|
|
||||||
- HUD elements (score, health, etc.)
|
- HUD elements (score, health, etc.)
|
||||||
- Menu navigation
|
- Menu navigation
|
||||||
- Modal dialogs
|
- Modal dialogs
|
||||||
- Settings screens
|
- Settings screens
|
||||||
|
|
||||||
**Implementation Requirements:**
|
**Implementation Requirements:**
|
||||||
|
|
||||||
- Responsive layout system
|
- Responsive layout system
|
||||||
- Touch-friendly interface
|
- Touch-friendly interface
|
||||||
- Keyboard navigation support
|
- Keyboard navigation support
|
||||||
- Animation and transitions
|
- Animation and transitions
|
||||||
|
|
||||||
**Files to Create:**
|
**Files to Create:**
|
||||||
|
|
||||||
- `src/systems/UIManager.ts`
|
- `src/systems/UIManager.ts`
|
||||||
- `src/gameObjects/UI/`
|
- `src/gameObjects/UI/`
|
||||||
- `src/types/UITypes.ts`
|
- `src/types/UITypes.ts`
|
||||||
|
|
|
||||||
|
|
@ -419,13 +419,13 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||||
|
|
||||||
Before starting, ensure you have access to:
|
Before starting, ensure you have access to:
|
||||||
|
|
||||||
- Game Design Document (GDD)
|
- Game Design Document (GDD)
|
||||||
- Game Architecture Document
|
- Game Architecture Document
|
||||||
- Any existing stories in this epic
|
- Any existing stories in this epic
|
||||||
|
|
||||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
||||||
|
|
||||||
- id: story-header
|
- id: story-header
|
||||||
|
|
@ -474,12 +474,12 @@ sections:
|
||||||
title: Files to Create/Modify
|
title: Files to Create/Modify
|
||||||
template: |
|
template: |
|
||||||
**New Files:**
|
**New Files:**
|
||||||
|
|
||||||
- `{{file_path_1}}` - {{purpose}}
|
- `{{file_path_1}}` - {{purpose}}
|
||||||
- `{{file_path_2}}` - {{purpose}}
|
- `{{file_path_2}}` - {{purpose}}
|
||||||
|
|
||||||
**Modified Files:**
|
**Modified Files:**
|
||||||
|
|
||||||
- `{{existing_file_1}}` - {{changes_needed}}
|
- `{{existing_file_1}}` - {{changes_needed}}
|
||||||
- `{{existing_file_2}}` - {{changes_needed}}
|
- `{{existing_file_2}}` - {{changes_needed}}
|
||||||
- id: class-interface-definitions
|
- id: class-interface-definitions
|
||||||
|
|
@ -494,15 +494,15 @@ sections:
|
||||||
{{property_2}}: {{type}};
|
{{property_2}}: {{type}};
|
||||||
{{method_1}}({{params}}): {{return_type}};
|
{{method_1}}({{params}}): {{return_type}};
|
||||||
}
|
}
|
||||||
|
|
||||||
// {{class_name}}
|
// {{class_name}}
|
||||||
class {{class_name}} extends {{phaser_class}} {
|
class {{class_name}} extends {{phaser_class}} {
|
||||||
private {{property}}: {{type}};
|
private {{property}}: {{type}};
|
||||||
|
|
||||||
constructor({{params}}) {
|
constructor({{params}}) {
|
||||||
// Implementation requirements
|
// Implementation requirements
|
||||||
}
|
}
|
||||||
|
|
||||||
public {{method}}({{params}}): {{return_type}} {
|
public {{method}}({{params}}): {{return_type}} {
|
||||||
// Method requirements
|
// Method requirements
|
||||||
}
|
}
|
||||||
|
|
@ -512,15 +512,15 @@ sections:
|
||||||
instruction: Specify how this feature integrates with existing systems
|
instruction: Specify how this feature integrates with existing systems
|
||||||
template: |
|
template: |
|
||||||
**Scene Integration:**
|
**Scene Integration:**
|
||||||
|
|
||||||
- {{scene_name}}: {{integration_details}}
|
- {{scene_name}}: {{integration_details}}
|
||||||
|
|
||||||
**System Dependencies:**
|
**System Dependencies:**
|
||||||
|
|
||||||
- {{system_name}}: {{dependency_description}}
|
- {{system_name}}: {{dependency_description}}
|
||||||
|
|
||||||
**Event Communication:**
|
**Event Communication:**
|
||||||
|
|
||||||
- Emits: `{{event_name}}` when {{condition}}
|
- Emits: `{{event_name}}` when {{condition}}
|
||||||
- Listens: `{{event_name}}` to {{response}}
|
- Listens: `{{event_name}}` to {{response}}
|
||||||
|
|
||||||
|
|
@ -532,7 +532,7 @@ sections:
|
||||||
title: Dev Agent Record
|
title: Dev Agent Record
|
||||||
template: |
|
template: |
|
||||||
**Tasks:**
|
**Tasks:**
|
||||||
|
|
||||||
- [ ] {{task_1_description}}
|
- [ ] {{task_1_description}}
|
||||||
- [ ] {{task_2_description}}
|
- [ ] {{task_2_description}}
|
||||||
- [ ] {{task_3_description}}
|
- [ ] {{task_3_description}}
|
||||||
|
|
@ -540,18 +540,18 @@ sections:
|
||||||
- [ ] Write unit tests for {{component}}
|
- [ ] Write unit tests for {{component}}
|
||||||
- [ ] Integration testing with {{related_system}}
|
- [ ] Integration testing with {{related_system}}
|
||||||
- [ ] Performance testing and optimization
|
- [ ] Performance testing and optimization
|
||||||
|
|
||||||
**Debug Log:**
|
**Debug Log:**
|
||||||
| Task | File | Change | Reverted? |
|
| Task | File | Change | Reverted? |
|
||||||
|------|------|--------|-----------|
|
|------|------|--------|-----------|
|
||||||
| | | | |
|
| | | | |
|
||||||
|
|
||||||
**Completion Notes:**
|
**Completion Notes:**
|
||||||
|
|
||||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||||
|
|
||||||
**Change Log:**
|
**Change Log:**
|
||||||
|
|
||||||
<!-- Only requirement changes during implementation -->
|
<!-- Only requirement changes during implementation -->
|
||||||
|
|
||||||
- id: game-design-context
|
- id: game-design-context
|
||||||
|
|
@ -559,13 +559,13 @@ sections:
|
||||||
instruction: Reference the specific sections of the GDD that this story implements
|
instruction: Reference the specific sections of the GDD that this story implements
|
||||||
template: |
|
template: |
|
||||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||||
|
|
||||||
**Game Mechanic:** {{mechanic_name}}
|
**Game Mechanic:** {{mechanic_name}}
|
||||||
|
|
||||||
**Player Experience Goal:** {{experience_description}}
|
**Player Experience Goal:** {{experience_description}}
|
||||||
|
|
||||||
**Balance Parameters:**
|
**Balance Parameters:**
|
||||||
|
|
||||||
- {{parameter_1}}: {{value_or_range}}
|
- {{parameter_1}}: {{value_or_range}}
|
||||||
- {{parameter_2}}: {{value_or_range}}
|
- {{parameter_2}}: {{value_or_range}}
|
||||||
|
|
||||||
|
|
@ -577,11 +577,11 @@ sections:
|
||||||
title: Unit Tests
|
title: Unit Tests
|
||||||
template: |
|
template: |
|
||||||
**Test Files:**
|
**Test Files:**
|
||||||
|
|
||||||
- `tests/{{component_name}}.test.ts`
|
- `tests/{{component_name}}.test.ts`
|
||||||
|
|
||||||
**Test Scenarios:**
|
**Test Scenarios:**
|
||||||
|
|
||||||
- {{test_scenario_1}}
|
- {{test_scenario_1}}
|
||||||
- {{test_scenario_2}}
|
- {{test_scenario_2}}
|
||||||
- {{edge_case_test}}
|
- {{edge_case_test}}
|
||||||
|
|
@ -589,12 +589,12 @@ sections:
|
||||||
title: Game Testing
|
title: Game Testing
|
||||||
template: |
|
template: |
|
||||||
**Manual Test Cases:**
|
**Manual Test Cases:**
|
||||||
|
|
||||||
1. {{test_case_1_description}}
|
1. {{test_case_1_description}}
|
||||||
|
|
||||||
- Expected: {{expected_behavior}}
|
- Expected: {{expected_behavior}}
|
||||||
- Performance: {{performance_expectation}}
|
- Performance: {{performance_expectation}}
|
||||||
|
|
||||||
2. {{test_case_2_description}}
|
2. {{test_case_2_description}}
|
||||||
- Expected: {{expected_behavior}}
|
- Expected: {{expected_behavior}}
|
||||||
- Edge Case: {{edge_case_handling}}
|
- Edge Case: {{edge_case_handling}}
|
||||||
|
|
@ -602,7 +602,7 @@ sections:
|
||||||
title: Performance Tests
|
title: Performance Tests
|
||||||
template: |
|
template: |
|
||||||
**Metrics to Verify:**
|
**Metrics to Verify:**
|
||||||
|
|
||||||
- Frame rate maintains {{fps_target}} FPS
|
- Frame rate maintains {{fps_target}} FPS
|
||||||
- Memory usage stays under {{memory_limit}}MB
|
- Memory usage stays under {{memory_limit}}MB
|
||||||
- {{feature_specific_performance_metric}}
|
- {{feature_specific_performance_metric}}
|
||||||
|
|
@ -612,15 +612,15 @@ sections:
|
||||||
instruction: List any dependencies that must be completed before this story can be implemented
|
instruction: List any dependencies that must be completed before this story can be implemented
|
||||||
template: |
|
template: |
|
||||||
**Story Dependencies:**
|
**Story Dependencies:**
|
||||||
|
|
||||||
- {{story_id}}: {{dependency_description}}
|
- {{story_id}}: {{dependency_description}}
|
||||||
|
|
||||||
**Technical Dependencies:**
|
**Technical Dependencies:**
|
||||||
|
|
||||||
- {{system_or_file}}: {{requirement}}
|
- {{system_or_file}}: {{requirement}}
|
||||||
|
|
||||||
**Asset Dependencies:**
|
**Asset Dependencies:**
|
||||||
|
|
||||||
- {{asset_type}}: {{asset_description}}
|
- {{asset_type}}: {{asset_description}}
|
||||||
- Location: `{{asset_path}}`
|
- Location: `{{asset_path}}`
|
||||||
|
|
||||||
|
|
@ -643,17 +643,17 @@ sections:
|
||||||
instruction: Any additional context, design decisions, or implementation notes
|
instruction: Any additional context, design decisions, or implementation notes
|
||||||
template: |
|
template: |
|
||||||
**Implementation Notes:**
|
**Implementation Notes:**
|
||||||
|
|
||||||
- {{note_1}}
|
- {{note_1}}
|
||||||
- {{note_2}}
|
- {{note_2}}
|
||||||
|
|
||||||
**Design Decisions:**
|
**Design Decisions:**
|
||||||
|
|
||||||
- {{decision_1}}: {{rationale}}
|
- {{decision_1}}: {{rationale}}
|
||||||
- {{decision_2}}: {{rationale}}
|
- {{decision_2}}: {{rationale}}
|
||||||
|
|
||||||
**Future Considerations:**
|
**Future Considerations:**
|
||||||
|
|
||||||
- {{future_enhancement_1}}
|
- {{future_enhancement_1}}
|
||||||
- {{future_optimization_1}}
|
- {{future_optimization_1}}
|
||||||
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
|
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1029,7 +1029,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
||||||
|
|
||||||
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
||||||
|
|
||||||
- id: executive-summary
|
- id: executive-summary
|
||||||
|
|
@ -1074,7 +1074,7 @@ sections:
|
||||||
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
||||||
template: |
|
template: |
|
||||||
**Primary Loop ({{duration}} seconds):**
|
**Primary Loop ({{duration}} seconds):**
|
||||||
|
|
||||||
1. {{action_1}} ({{time_1}}s)
|
1. {{action_1}} ({{time_1}}s)
|
||||||
2. {{action_2}} ({{time_2}}s)
|
2. {{action_2}} ({{time_2}}s)
|
||||||
3. {{action_3}} ({{time_3}}s)
|
3. {{action_3}} ({{time_3}}s)
|
||||||
|
|
@ -1084,12 +1084,12 @@ sections:
|
||||||
instruction: Clearly define success and failure states
|
instruction: Clearly define success and failure states
|
||||||
template: |
|
template: |
|
||||||
**Victory Conditions:**
|
**Victory Conditions:**
|
||||||
|
|
||||||
- {{win_condition_1}}
|
- {{win_condition_1}}
|
||||||
- {{win_condition_2}}
|
- {{win_condition_2}}
|
||||||
|
|
||||||
**Failure States:**
|
**Failure States:**
|
||||||
|
|
||||||
- {{loss_condition_1}}
|
- {{loss_condition_1}}
|
||||||
- {{loss_condition_2}}
|
- {{loss_condition_2}}
|
||||||
|
|
||||||
|
|
@ -1105,17 +1105,17 @@ sections:
|
||||||
title: "{{mechanic_name}}"
|
title: "{{mechanic_name}}"
|
||||||
template: |
|
template: |
|
||||||
**Description:** {{detailed_description}}
|
**Description:** {{detailed_description}}
|
||||||
|
|
||||||
**Player Input:** {{input_method}}
|
**Player Input:** {{input_method}}
|
||||||
|
|
||||||
**System Response:** {{game_response}}
|
**System Response:** {{game_response}}
|
||||||
|
|
||||||
**Implementation Notes:**
|
**Implementation Notes:**
|
||||||
|
|
||||||
- {{tech_requirement_1}}
|
- {{tech_requirement_1}}
|
||||||
- {{tech_requirement_2}}
|
- {{tech_requirement_2}}
|
||||||
- {{performance_consideration}}
|
- {{performance_consideration}}
|
||||||
|
|
||||||
**Dependencies:** {{other_mechanics_needed}}
|
**Dependencies:** {{other_mechanics_needed}}
|
||||||
- id: controls
|
- id: controls
|
||||||
title: Controls
|
title: Controls
|
||||||
|
|
@ -1134,9 +1134,9 @@ sections:
|
||||||
title: Player Progression
|
title: Player Progression
|
||||||
template: |
|
template: |
|
||||||
**Progression Type:** {{linear|branching|metroidvania}}
|
**Progression Type:** {{linear|branching|metroidvania}}
|
||||||
|
|
||||||
**Key Milestones:**
|
**Key Milestones:**
|
||||||
|
|
||||||
1. **{{milestone_1}}** - {{unlock_description}}
|
1. **{{milestone_1}}** - {{unlock_description}}
|
||||||
2. **{{milestone_2}}** - {{unlock_description}}
|
2. **{{milestone_2}}** - {{unlock_description}}
|
||||||
3. **{{milestone_3}}** - {{unlock_description}}
|
3. **{{milestone_3}}** - {{unlock_description}}
|
||||||
|
|
@ -1173,9 +1173,9 @@ sections:
|
||||||
**Duration:** {{target_time}}
|
**Duration:** {{target_time}}
|
||||||
**Key Elements:** {{required_mechanics}}
|
**Key Elements:** {{required_mechanics}}
|
||||||
**Difficulty:** {{relative_difficulty}}
|
**Difficulty:** {{relative_difficulty}}
|
||||||
|
|
||||||
**Structure Template:**
|
**Structure Template:**
|
||||||
|
|
||||||
- Introduction: {{intro_description}}
|
- Introduction: {{intro_description}}
|
||||||
- Challenge: {{main_challenge}}
|
- Challenge: {{main_challenge}}
|
||||||
- Resolution: {{completion_requirement}}
|
- Resolution: {{completion_requirement}}
|
||||||
|
|
@ -1201,13 +1201,13 @@ sections:
|
||||||
title: Platform Specific
|
title: Platform Specific
|
||||||
template: |
|
template: |
|
||||||
**Desktop:**
|
**Desktop:**
|
||||||
|
|
||||||
- Resolution: {{min_resolution}} - {{max_resolution}}
|
- Resolution: {{min_resolution}} - {{max_resolution}}
|
||||||
- Input: Keyboard, Mouse, Gamepad
|
- Input: Keyboard, Mouse, Gamepad
|
||||||
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
||||||
|
|
||||||
**Mobile:**
|
**Mobile:**
|
||||||
|
|
||||||
- Resolution: {{mobile_min}} - {{mobile_max}}
|
- Resolution: {{mobile_min}} - {{mobile_max}}
|
||||||
- Input: Touch, Tilt (optional)
|
- Input: Touch, Tilt (optional)
|
||||||
- OS: iOS 13+, Android 8+
|
- OS: iOS 13+, Android 8+
|
||||||
|
|
@ -1216,14 +1216,14 @@ sections:
|
||||||
instruction: Define asset specifications for the art and audio teams
|
instruction: Define asset specifications for the art and audio teams
|
||||||
template: |
|
template: |
|
||||||
**Visual Assets:**
|
**Visual Assets:**
|
||||||
|
|
||||||
- Art Style: {{style_description}}
|
- Art Style: {{style_description}}
|
||||||
- Color Palette: {{color_specification}}
|
- Color Palette: {{color_specification}}
|
||||||
- Animation: {{animation_requirements}}
|
- Animation: {{animation_requirements}}
|
||||||
- UI Resolution: {{ui_specs}}
|
- UI Resolution: {{ui_specs}}
|
||||||
|
|
||||||
**Audio Assets:**
|
**Audio Assets:**
|
||||||
|
|
||||||
- Music Style: {{music_genre}}
|
- Music Style: {{music_genre}}
|
||||||
- Sound Effects: {{sfx_requirements}}
|
- Sound Effects: {{sfx_requirements}}
|
||||||
- Voice Acting: {{voice_needs}}
|
- Voice Acting: {{voice_needs}}
|
||||||
|
|
@ -1245,7 +1245,7 @@ sections:
|
||||||
title: Code Architecture
|
title: Code Architecture
|
||||||
template: |
|
template: |
|
||||||
**Required Systems:**
|
**Required Systems:**
|
||||||
|
|
||||||
- Scene Management
|
- Scene Management
|
||||||
- State Management
|
- State Management
|
||||||
- Asset Loading
|
- Asset Loading
|
||||||
|
|
@ -1257,7 +1257,7 @@ sections:
|
||||||
title: Data Management
|
title: Data Management
|
||||||
template: |
|
template: |
|
||||||
**Save Data:**
|
**Save Data:**
|
||||||
|
|
||||||
- Progress tracking
|
- Progress tracking
|
||||||
- Settings persistence
|
- Settings persistence
|
||||||
- Statistics collection
|
- Statistics collection
|
||||||
|
|
@ -1375,7 +1375,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
||||||
|
|
||||||
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
|
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
|
||||||
|
|
||||||
- id: introduction
|
- id: introduction
|
||||||
|
|
@ -1383,7 +1383,7 @@ sections:
|
||||||
instruction: Establish the purpose and scope of level design for this game
|
instruction: Establish the purpose and scope of level design for this game
|
||||||
content: |
|
content: |
|
||||||
This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
||||||
|
|
||||||
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
||||||
sections:
|
sections:
|
||||||
- id: change-log
|
- id: change-log
|
||||||
|
|
@ -1430,29 +1430,29 @@ sections:
|
||||||
title: "{{category_name}} Levels"
|
title: "{{category_name}} Levels"
|
||||||
template: |
|
template: |
|
||||||
**Purpose:** {{gameplay_purpose}}
|
**Purpose:** {{gameplay_purpose}}
|
||||||
|
|
||||||
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
||||||
|
|
||||||
**Difficulty Range:** {{difficulty_scale}}
|
**Difficulty Range:** {{difficulty_scale}}
|
||||||
|
|
||||||
**Key Mechanics Featured:**
|
**Key Mechanics Featured:**
|
||||||
|
|
||||||
- {{mechanic_1}} - {{usage_description}}
|
- {{mechanic_1}} - {{usage_description}}
|
||||||
- {{mechanic_2}} - {{usage_description}}
|
- {{mechanic_2}} - {{usage_description}}
|
||||||
|
|
||||||
**Player Objectives:**
|
**Player Objectives:**
|
||||||
|
|
||||||
- Primary: {{primary_objective}}
|
- Primary: {{primary_objective}}
|
||||||
- Secondary: {{secondary_objective}}
|
- Secondary: {{secondary_objective}}
|
||||||
- Hidden: {{secret_objective}}
|
- Hidden: {{secret_objective}}
|
||||||
|
|
||||||
**Success Criteria:**
|
**Success Criteria:**
|
||||||
|
|
||||||
- {{completion_requirement_1}}
|
- {{completion_requirement_1}}
|
||||||
- {{completion_requirement_2}}
|
- {{completion_requirement_2}}
|
||||||
|
|
||||||
**Technical Requirements:**
|
**Technical Requirements:**
|
||||||
|
|
||||||
- Maximum entities: {{entity_limit}}
|
- Maximum entities: {{entity_limit}}
|
||||||
- Performance target: {{fps_target}} FPS
|
- Performance target: {{fps_target}} FPS
|
||||||
- Memory budget: {{memory_limit}}MB
|
- Memory budget: {{memory_limit}}MB
|
||||||
|
|
@ -1467,11 +1467,11 @@ sections:
|
||||||
instruction: Based on GDD requirements, define the overall level organization
|
instruction: Based on GDD requirements, define the overall level organization
|
||||||
template: |
|
template: |
|
||||||
**Organization Type:** {{linear|hub_world|open_world}}
|
**Organization Type:** {{linear|hub_world|open_world}}
|
||||||
|
|
||||||
**Total Level Count:** {{number}}
|
**Total Level Count:** {{number}}
|
||||||
|
|
||||||
**World Breakdown:**
|
**World Breakdown:**
|
||||||
|
|
||||||
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||||
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||||
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||||
|
|
@ -1506,7 +1506,7 @@ sections:
|
||||||
instruction: Define how players access new levels
|
instruction: Define how players access new levels
|
||||||
template: |
|
template: |
|
||||||
**Progression Gates:**
|
**Progression Gates:**
|
||||||
|
|
||||||
- Linear progression: Complete previous level
|
- Linear progression: Complete previous level
|
||||||
- Star requirements: {{star_count}} stars to unlock
|
- Star requirements: {{star_count}} stars to unlock
|
||||||
- Skill gates: Demonstrate {{skill_requirement}}
|
- Skill gates: Demonstrate {{skill_requirement}}
|
||||||
|
|
@ -1521,17 +1521,17 @@ sections:
|
||||||
instruction: Define all environmental components that can be used in levels
|
instruction: Define all environmental components that can be used in levels
|
||||||
template: |
|
template: |
|
||||||
**Terrain Types:**
|
**Terrain Types:**
|
||||||
|
|
||||||
- {{terrain_1}}: {{properties_and_usage}}
|
- {{terrain_1}}: {{properties_and_usage}}
|
||||||
- {{terrain_2}}: {{properties_and_usage}}
|
- {{terrain_2}}: {{properties_and_usage}}
|
||||||
|
|
||||||
**Interactive Objects:**
|
**Interactive Objects:**
|
||||||
|
|
||||||
- {{object_1}}: {{behavior_and_purpose}}
|
- {{object_1}}: {{behavior_and_purpose}}
|
||||||
- {{object_2}}: {{behavior_and_purpose}}
|
- {{object_2}}: {{behavior_and_purpose}}
|
||||||
|
|
||||||
**Hazards and Obstacles:**
|
**Hazards and Obstacles:**
|
||||||
|
|
||||||
- {{hazard_1}}: {{damage_and_behavior}}
|
- {{hazard_1}}: {{damage_and_behavior}}
|
||||||
- {{hazard_2}}: {{damage_and_behavior}}
|
- {{hazard_2}}: {{damage_and_behavior}}
|
||||||
- id: collectibles-rewards
|
- id: collectibles-rewards
|
||||||
|
|
@ -1539,18 +1539,18 @@ sections:
|
||||||
instruction: Define all collectible items and their placement rules
|
instruction: Define all collectible items and their placement rules
|
||||||
template: |
|
template: |
|
||||||
**Collectible Types:**
|
**Collectible Types:**
|
||||||
|
|
||||||
- {{collectible_1}}: {{value_and_purpose}}
|
- {{collectible_1}}: {{value_and_purpose}}
|
||||||
- {{collectible_2}}: {{value_and_purpose}}
|
- {{collectible_2}}: {{value_and_purpose}}
|
||||||
|
|
||||||
**Placement Guidelines:**
|
**Placement Guidelines:**
|
||||||
|
|
||||||
- Mandatory collectibles: {{placement_rules}}
|
- Mandatory collectibles: {{placement_rules}}
|
||||||
- Optional collectibles: {{placement_rules}}
|
- Optional collectibles: {{placement_rules}}
|
||||||
- Secret collectibles: {{placement_rules}}
|
- Secret collectibles: {{placement_rules}}
|
||||||
|
|
||||||
**Reward Distribution:**
|
**Reward Distribution:**
|
||||||
|
|
||||||
- Easy to find: {{percentage}}%
|
- Easy to find: {{percentage}}%
|
||||||
- Moderate challenge: {{percentage}}%
|
- Moderate challenge: {{percentage}}%
|
||||||
- High skill required: {{percentage}}%
|
- High skill required: {{percentage}}%
|
||||||
|
|
@ -1559,18 +1559,18 @@ sections:
|
||||||
instruction: Define how enemies should be placed and balanced in levels
|
instruction: Define how enemies should be placed and balanced in levels
|
||||||
template: |
|
template: |
|
||||||
**Enemy Categories:**
|
**Enemy Categories:**
|
||||||
|
|
||||||
- {{enemy_type_1}}: {{behavior_and_usage}}
|
- {{enemy_type_1}}: {{behavior_and_usage}}
|
||||||
- {{enemy_type_2}}: {{behavior_and_usage}}
|
- {{enemy_type_2}}: {{behavior_and_usage}}
|
||||||
|
|
||||||
**Placement Principles:**
|
**Placement Principles:**
|
||||||
|
|
||||||
- Introduction encounters: {{guideline}}
|
- Introduction encounters: {{guideline}}
|
||||||
- Standard encounters: {{guideline}}
|
- Standard encounters: {{guideline}}
|
||||||
- Challenge encounters: {{guideline}}
|
- Challenge encounters: {{guideline}}
|
||||||
|
|
||||||
**Difficulty Scaling:**
|
**Difficulty Scaling:**
|
||||||
|
|
||||||
- Enemy count progression: {{scaling_rule}}
|
- Enemy count progression: {{scaling_rule}}
|
||||||
- Enemy type introduction: {{pacing_rule}}
|
- Enemy type introduction: {{pacing_rule}}
|
||||||
- Encounter complexity: {{complexity_rule}}
|
- Encounter complexity: {{complexity_rule}}
|
||||||
|
|
@ -1583,14 +1583,14 @@ sections:
|
||||||
title: Level Layout Principles
|
title: Level Layout Principles
|
||||||
template: |
|
template: |
|
||||||
**Spatial Design:**
|
**Spatial Design:**
|
||||||
|
|
||||||
- Grid size: {{grid_dimensions}}
|
- Grid size: {{grid_dimensions}}
|
||||||
- Minimum path width: {{width_units}}
|
- Minimum path width: {{width_units}}
|
||||||
- Maximum vertical distance: {{height_units}}
|
- Maximum vertical distance: {{height_units}}
|
||||||
- Safe zones placement: {{safety_guidelines}}
|
- Safe zones placement: {{safety_guidelines}}
|
||||||
|
|
||||||
**Navigation Design:**
|
**Navigation Design:**
|
||||||
|
|
||||||
- Clear path indication: {{visual_cues}}
|
- Clear path indication: {{visual_cues}}
|
||||||
- Landmark placement: {{landmark_rules}}
|
- Landmark placement: {{landmark_rules}}
|
||||||
- Dead end avoidance: {{dead_end_policy}}
|
- Dead end avoidance: {{dead_end_policy}}
|
||||||
|
|
@ -1600,13 +1600,13 @@ sections:
|
||||||
instruction: Define how to control the rhythm and pace of gameplay within levels
|
instruction: Define how to control the rhythm and pace of gameplay within levels
|
||||||
template: |
|
template: |
|
||||||
**Action Sequences:**
|
**Action Sequences:**
|
||||||
|
|
||||||
- High intensity duration: {{max_duration}}
|
- High intensity duration: {{max_duration}}
|
||||||
- Rest period requirement: {{min_rest_time}}
|
- Rest period requirement: {{min_rest_time}}
|
||||||
- Intensity variation: {{pacing_pattern}}
|
- Intensity variation: {{pacing_pattern}}
|
||||||
|
|
||||||
**Learning Sequences:**
|
**Learning Sequences:**
|
||||||
|
|
||||||
- New mechanic introduction: {{teaching_method}}
|
- New mechanic introduction: {{teaching_method}}
|
||||||
- Practice opportunity: {{practice_duration}}
|
- Practice opportunity: {{practice_duration}}
|
||||||
- Skill application: {{application_context}}
|
- Skill application: {{application_context}}
|
||||||
|
|
@ -1615,14 +1615,14 @@ sections:
|
||||||
instruction: Define how to create appropriate challenges for each level type
|
instruction: Define how to create appropriate challenges for each level type
|
||||||
template: |
|
template: |
|
||||||
**Challenge Types:**
|
**Challenge Types:**
|
||||||
|
|
||||||
- Execution challenges: {{skill_requirements}}
|
- Execution challenges: {{skill_requirements}}
|
||||||
- Puzzle challenges: {{complexity_guidelines}}
|
- Puzzle challenges: {{complexity_guidelines}}
|
||||||
- Time challenges: {{time_pressure_rules}}
|
- Time challenges: {{time_pressure_rules}}
|
||||||
- Resource challenges: {{resource_management}}
|
- Resource challenges: {{resource_management}}
|
||||||
|
|
||||||
**Difficulty Calibration:**
|
**Difficulty Calibration:**
|
||||||
|
|
||||||
- Skill check frequency: {{frequency_guidelines}}
|
- Skill check frequency: {{frequency_guidelines}}
|
||||||
- Failure recovery: {{retry_mechanics}}
|
- Failure recovery: {{retry_mechanics}}
|
||||||
- Hint system integration: {{help_system}}
|
- Hint system integration: {{help_system}}
|
||||||
|
|
@ -1636,7 +1636,7 @@ sections:
|
||||||
instruction: Define how level data should be structured for implementation
|
instruction: Define how level data should be structured for implementation
|
||||||
template: |
|
template: |
|
||||||
**Level File Format:**
|
**Level File Format:**
|
||||||
|
|
||||||
- Data format: {{json|yaml|custom}}
|
- Data format: {{json|yaml|custom}}
|
||||||
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
||||||
- Data organization: {{structure_description}}
|
- Data organization: {{structure_description}}
|
||||||
|
|
@ -1674,14 +1674,14 @@ sections:
|
||||||
instruction: Define how level assets are organized and loaded
|
instruction: Define how level assets are organized and loaded
|
||||||
template: |
|
template: |
|
||||||
**Tilemap Requirements:**
|
**Tilemap Requirements:**
|
||||||
|
|
||||||
- Tile size: {{tile_dimensions}}px
|
- Tile size: {{tile_dimensions}}px
|
||||||
- Tileset organization: {{tileset_structure}}
|
- Tileset organization: {{tileset_structure}}
|
||||||
- Layer organization: {{layer_system}}
|
- Layer organization: {{layer_system}}
|
||||||
- Collision data: {{collision_format}}
|
- Collision data: {{collision_format}}
|
||||||
|
|
||||||
**Audio Integration:**
|
**Audio Integration:**
|
||||||
|
|
||||||
- Background music: {{music_requirements}}
|
- Background music: {{music_requirements}}
|
||||||
- Ambient sounds: {{ambient_system}}
|
- Ambient sounds: {{ambient_system}}
|
||||||
- Dynamic audio: {{dynamic_audio_rules}}
|
- Dynamic audio: {{dynamic_audio_rules}}
|
||||||
|
|
@ -1690,19 +1690,19 @@ sections:
|
||||||
instruction: Define performance requirements for level systems
|
instruction: Define performance requirements for level systems
|
||||||
template: |
|
template: |
|
||||||
**Entity Limits:**
|
**Entity Limits:**
|
||||||
|
|
||||||
- Maximum active entities: {{entity_limit}}
|
- Maximum active entities: {{entity_limit}}
|
||||||
- Maximum particles: {{particle_limit}}
|
- Maximum particles: {{particle_limit}}
|
||||||
- Maximum audio sources: {{audio_limit}}
|
- Maximum audio sources: {{audio_limit}}
|
||||||
|
|
||||||
**Memory Management:**
|
**Memory Management:**
|
||||||
|
|
||||||
- Texture memory budget: {{texture_memory}}MB
|
- Texture memory budget: {{texture_memory}}MB
|
||||||
- Audio memory budget: {{audio_memory}}MB
|
- Audio memory budget: {{audio_memory}}MB
|
||||||
- Level loading time: <{{load_time}}s
|
- Level loading time: <{{load_time}}s
|
||||||
|
|
||||||
**Culling and LOD:**
|
**Culling and LOD:**
|
||||||
|
|
||||||
- Off-screen culling: {{culling_distance}}
|
- Off-screen culling: {{culling_distance}}
|
||||||
- Level-of-detail rules: {{lod_system}}
|
- Level-of-detail rules: {{lod_system}}
|
||||||
- Asset streaming: {{streaming_requirements}}
|
- Asset streaming: {{streaming_requirements}}
|
||||||
|
|
@ -1715,13 +1715,13 @@ sections:
|
||||||
title: Automated Testing
|
title: Automated Testing
|
||||||
template: |
|
template: |
|
||||||
**Performance Testing:**
|
**Performance Testing:**
|
||||||
|
|
||||||
- Frame rate validation: Maintain {{fps_target}} FPS
|
- Frame rate validation: Maintain {{fps_target}} FPS
|
||||||
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
||||||
- Loading time verification: Complete in <{{load_time}}s
|
- Loading time verification: Complete in <{{load_time}}s
|
||||||
|
|
||||||
**Gameplay Testing:**
|
**Gameplay Testing:**
|
||||||
|
|
||||||
- Completion path validation: All objectives achievable
|
- Completion path validation: All objectives achievable
|
||||||
- Collectible accessibility: All items reachable
|
- Collectible accessibility: All items reachable
|
||||||
- Softlock prevention: No unwinnable states
|
- Softlock prevention: No unwinnable states
|
||||||
|
|
@ -1749,14 +1749,14 @@ sections:
|
||||||
title: Balance Validation
|
title: Balance Validation
|
||||||
template: |
|
template: |
|
||||||
**Metrics Collection:**
|
**Metrics Collection:**
|
||||||
|
|
||||||
- Completion rate: Target {{completion_percentage}}%
|
- Completion rate: Target {{completion_percentage}}%
|
||||||
- Average completion time: {{target_time}} ± {{variance}}
|
- Average completion time: {{target_time}} ± {{variance}}
|
||||||
- Death count per level: <{{max_deaths}}
|
- Death count per level: <{{max_deaths}}
|
||||||
- Collectible discovery rate: {{discovery_percentage}}%
|
- Collectible discovery rate: {{discovery_percentage}}%
|
||||||
|
|
||||||
**Iteration Guidelines:**
|
**Iteration Guidelines:**
|
||||||
|
|
||||||
- Adjustment criteria: {{criteria_for_changes}}
|
- Adjustment criteria: {{criteria_for_changes}}
|
||||||
- Testing sample size: {{minimum_testers}}
|
- Testing sample size: {{minimum_testers}}
|
||||||
- Validation period: {{testing_duration}}
|
- Validation period: {{testing_duration}}
|
||||||
|
|
@ -1769,14 +1769,14 @@ sections:
|
||||||
title: Design Phase
|
title: Design Phase
|
||||||
template: |
|
template: |
|
||||||
**Concept Development:**
|
**Concept Development:**
|
||||||
|
|
||||||
1. Define level purpose and goals
|
1. Define level purpose and goals
|
||||||
2. Create rough layout sketch
|
2. Create rough layout sketch
|
||||||
3. Identify key mechanics and challenges
|
3. Identify key mechanics and challenges
|
||||||
4. Estimate difficulty and duration
|
4. Estimate difficulty and duration
|
||||||
|
|
||||||
**Documentation Requirements:**
|
**Documentation Requirements:**
|
||||||
|
|
||||||
- Level design brief
|
- Level design brief
|
||||||
- Layout diagrams
|
- Layout diagrams
|
||||||
- Mechanic integration notes
|
- Mechanic integration notes
|
||||||
|
|
@ -1785,15 +1785,15 @@ sections:
|
||||||
title: Implementation Phase
|
title: Implementation Phase
|
||||||
template: |
|
template: |
|
||||||
**Technical Implementation:**
|
**Technical Implementation:**
|
||||||
|
|
||||||
1. Create level data file
|
1. Create level data file
|
||||||
2. Build tilemap and layout
|
2. Build tilemap and layout
|
||||||
3. Place entities and objects
|
3. Place entities and objects
|
||||||
4. Configure level logic and triggers
|
4. Configure level logic and triggers
|
||||||
5. Integrate audio and visual effects
|
5. Integrate audio and visual effects
|
||||||
|
|
||||||
**Quality Assurance:**
|
**Quality Assurance:**
|
||||||
|
|
||||||
1. Automated testing execution
|
1. Automated testing execution
|
||||||
2. Internal playtesting
|
2. Internal playtesting
|
||||||
3. Performance validation
|
3. Performance validation
|
||||||
|
|
@ -1802,14 +1802,14 @@ sections:
|
||||||
title: Integration Phase
|
title: Integration Phase
|
||||||
template: |
|
template: |
|
||||||
**Game Integration:**
|
**Game Integration:**
|
||||||
|
|
||||||
1. Level progression integration
|
1. Level progression integration
|
||||||
2. Save system compatibility
|
2. Save system compatibility
|
||||||
3. Analytics integration
|
3. Analytics integration
|
||||||
4. Achievement system integration
|
4. Achievement system integration
|
||||||
|
|
||||||
**Final Validation:**
|
**Final Validation:**
|
||||||
|
|
||||||
1. Full game context testing
|
1. Full game context testing
|
||||||
2. Performance regression testing
|
2. Performance regression testing
|
||||||
3. Platform compatibility verification
|
3. Platform compatibility verification
|
||||||
|
|
@ -1862,7 +1862,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
||||||
|
|
||||||
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
||||||
|
|
||||||
- id: game-vision
|
- id: game-vision
|
||||||
|
|
@ -1919,7 +1919,7 @@ sections:
|
||||||
repeatable: true
|
repeatable: true
|
||||||
template: |
|
template: |
|
||||||
**Core Mechanic: {{mechanic_name}}**
|
**Core Mechanic: {{mechanic_name}}**
|
||||||
|
|
||||||
- **Description:** {{how_it_works}}
|
- **Description:** {{how_it_works}}
|
||||||
- **Player Value:** {{why_its_fun}}
|
- **Player Value:** {{why_its_fun}}
|
||||||
- **Implementation Scope:** {{complexity_estimate}}
|
- **Implementation Scope:** {{complexity_estimate}}
|
||||||
|
|
@ -1946,12 +1946,12 @@ sections:
|
||||||
title: Technical Constraints
|
title: Technical Constraints
|
||||||
template: |
|
template: |
|
||||||
**Platform Requirements:**
|
**Platform Requirements:**
|
||||||
|
|
||||||
- Primary: {{platform_1}} - {{requirements}}
|
- Primary: {{platform_1}} - {{requirements}}
|
||||||
- Secondary: {{platform_2}} - {{requirements}}
|
- Secondary: {{platform_2}} - {{requirements}}
|
||||||
|
|
||||||
**Technical Specifications:**
|
**Technical Specifications:**
|
||||||
|
|
||||||
- Engine: Unity & C#
|
- Engine: Unity & C#
|
||||||
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
||||||
- Memory Budget: <{{memory_limit}}MB
|
- Memory Budget: <{{memory_limit}}MB
|
||||||
|
|
@ -1989,10 +1989,10 @@ sections:
|
||||||
title: Competitive Analysis
|
title: Competitive Analysis
|
||||||
template: |
|
template: |
|
||||||
**Direct Competitors:**
|
**Direct Competitors:**
|
||||||
|
|
||||||
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
||||||
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
||||||
|
|
||||||
**Differentiation Strategy:**
|
**Differentiation Strategy:**
|
||||||
{{how_we_differ_and_why_thats_valuable}}
|
{{how_we_differ_and_why_thats_valuable}}
|
||||||
- id: market-opportunity
|
- id: market-opportunity
|
||||||
|
|
@ -2016,16 +2016,16 @@ sections:
|
||||||
title: Content Categories
|
title: Content Categories
|
||||||
template: |
|
template: |
|
||||||
**Core Content:**
|
**Core Content:**
|
||||||
|
|
||||||
- {{content_type_1}}: {{quantity_and_description}}
|
- {{content_type_1}}: {{quantity_and_description}}
|
||||||
- {{content_type_2}}: {{quantity_and_description}}
|
- {{content_type_2}}: {{quantity_and_description}}
|
||||||
|
|
||||||
**Optional Content:**
|
**Optional Content:**
|
||||||
|
|
||||||
- {{optional_content_type}}: {{quantity_and_description}}
|
- {{optional_content_type}}: {{quantity_and_description}}
|
||||||
|
|
||||||
**Replay Elements:**
|
**Replay Elements:**
|
||||||
|
|
||||||
- {{replayability_features}}
|
- {{replayability_features}}
|
||||||
- id: difficulty-accessibility
|
- id: difficulty-accessibility
|
||||||
title: Difficulty and Accessibility
|
title: Difficulty and Accessibility
|
||||||
|
|
@ -2092,13 +2092,13 @@ sections:
|
||||||
title: Player Experience Metrics
|
title: Player Experience Metrics
|
||||||
template: |
|
template: |
|
||||||
**Engagement Goals:**
|
**Engagement Goals:**
|
||||||
|
|
||||||
- Tutorial completion rate: >{{percentage}}%
|
- Tutorial completion rate: >{{percentage}}%
|
||||||
- Average session length: {{duration}} minutes
|
- Average session length: {{duration}} minutes
|
||||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
||||||
|
|
||||||
**Quality Benchmarks:**
|
**Quality Benchmarks:**
|
||||||
|
|
||||||
- Player satisfaction: >{{rating}}/10
|
- Player satisfaction: >{{rating}}/10
|
||||||
- Completion rate: >{{percentage}}%
|
- Completion rate: >{{percentage}}%
|
||||||
- Technical performance: {{fps_target}} FPS consistent
|
- Technical performance: {{fps_target}} FPS consistent
|
||||||
|
|
@ -2106,13 +2106,13 @@ sections:
|
||||||
title: Development Metrics
|
title: Development Metrics
|
||||||
template: |
|
template: |
|
||||||
**Technical Targets:**
|
**Technical Targets:**
|
||||||
|
|
||||||
- Zero critical bugs at launch
|
- Zero critical bugs at launch
|
||||||
- Performance targets met on all platforms
|
- Performance targets met on all platforms
|
||||||
- Load times under {{seconds}}s
|
- Load times under {{seconds}}s
|
||||||
|
|
||||||
**Process Goals:**
|
**Process Goals:**
|
||||||
|
|
||||||
- Development timeline adherence
|
- Development timeline adherence
|
||||||
- Feature scope completion
|
- Feature scope completion
|
||||||
- Quality assurance standards
|
- Quality assurance standards
|
||||||
|
|
@ -2121,7 +2121,7 @@ sections:
|
||||||
condition: has_business_goals
|
condition: has_business_goals
|
||||||
template: |
|
template: |
|
||||||
**Commercial Goals:**
|
**Commercial Goals:**
|
||||||
|
|
||||||
- {{revenue_target}} in first {{time_period}}
|
- {{revenue_target}} in first {{time_period}}
|
||||||
- {{user_acquisition_target}} players in first {{time_period}}
|
- {{user_acquisition_target}} players in first {{time_period}}
|
||||||
- {{retention_target}} monthly active users
|
- {{retention_target}} monthly active users
|
||||||
|
|
@ -2174,12 +2174,12 @@ sections:
|
||||||
title: Validation Plan
|
title: Validation Plan
|
||||||
template: |
|
template: |
|
||||||
**Concept Testing:**
|
**Concept Testing:**
|
||||||
|
|
||||||
- {{validation_method_1}} - {{timeline}}
|
- {{validation_method_1}} - {{timeline}}
|
||||||
- {{validation_method_2}} - {{timeline}}
|
- {{validation_method_2}} - {{timeline}}
|
||||||
|
|
||||||
**Prototype Testing:**
|
**Prototype Testing:**
|
||||||
|
|
||||||
- {{testing_approach}} - {{timeline}}
|
- {{testing_approach}} - {{timeline}}
|
||||||
- {{feedback_collection_method}} - {{timeline}}
|
- {{feedback_collection_method}} - {{timeline}}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -420,13 +420,13 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||||
|
|
||||||
Before starting, ensure you have access to:
|
Before starting, ensure you have access to:
|
||||||
|
|
||||||
- Game Design Document (GDD)
|
- Game Design Document (GDD)
|
||||||
- Game Architecture Document
|
- Game Architecture Document
|
||||||
- Any existing stories in this epic
|
- Any existing stories in this epic
|
||||||
|
|
||||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
||||||
|
|
||||||
- id: story-header
|
- id: story-header
|
||||||
|
|
@ -475,12 +475,12 @@ sections:
|
||||||
title: Files to Create/Modify
|
title: Files to Create/Modify
|
||||||
template: |
|
template: |
|
||||||
**New Files:**
|
**New Files:**
|
||||||
|
|
||||||
- `{{file_path_1}}` - {{purpose}}
|
- `{{file_path_1}}` - {{purpose}}
|
||||||
- `{{file_path_2}}` - {{purpose}}
|
- `{{file_path_2}}` - {{purpose}}
|
||||||
|
|
||||||
**Modified Files:**
|
**Modified Files:**
|
||||||
|
|
||||||
- `{{existing_file_1}}` - {{changes_needed}}
|
- `{{existing_file_1}}` - {{changes_needed}}
|
||||||
- `{{existing_file_2}}` - {{changes_needed}}
|
- `{{existing_file_2}}` - {{changes_needed}}
|
||||||
- id: class-interface-definitions
|
- id: class-interface-definitions
|
||||||
|
|
@ -563,13 +563,13 @@ sections:
|
||||||
instruction: Reference the specific sections of the GDD that this story implements
|
instruction: Reference the specific sections of the GDD that this story implements
|
||||||
template: |
|
template: |
|
||||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||||
|
|
||||||
**Game Mechanic:** {{mechanic_name}}
|
**Game Mechanic:** {{mechanic_name}}
|
||||||
|
|
||||||
**Player Experience Goal:** {{experience_description}}
|
**Player Experience Goal:** {{experience_description}}
|
||||||
|
|
||||||
**Balance Parameters:**
|
**Balance Parameters:**
|
||||||
|
|
||||||
- {{parameter_1}}: {{value_or_range}}
|
- {{parameter_1}}: {{value_or_range}}
|
||||||
- {{parameter_2}}: {{value_or_range}}
|
- {{parameter_2}}: {{value_or_range}}
|
||||||
|
|
||||||
|
|
@ -616,15 +616,15 @@ sections:
|
||||||
instruction: List any dependencies that must be completed before this story can be implemented
|
instruction: List any dependencies that must be completed before this story can be implemented
|
||||||
template: |
|
template: |
|
||||||
**Story Dependencies:**
|
**Story Dependencies:**
|
||||||
|
|
||||||
- {{story_id}}: {{dependency_description}}
|
- {{story_id}}: {{dependency_description}}
|
||||||
|
|
||||||
**Technical Dependencies:**
|
**Technical Dependencies:**
|
||||||
|
|
||||||
- {{system_or_file}}: {{requirement}}
|
- {{system_or_file}}: {{requirement}}
|
||||||
|
|
||||||
**Asset Dependencies:**
|
**Asset Dependencies:**
|
||||||
|
|
||||||
- {{asset_type}}: {{asset_description}}
|
- {{asset_type}}: {{asset_description}}
|
||||||
- Location: `{{asset_path}}`
|
- Location: `{{asset_path}}`
|
||||||
|
|
||||||
|
|
@ -647,17 +647,17 @@ sections:
|
||||||
instruction: Any additional context, design decisions, or implementation notes
|
instruction: Any additional context, design decisions, or implementation notes
|
||||||
template: |
|
template: |
|
||||||
**Implementation Notes:**
|
**Implementation Notes:**
|
||||||
|
|
||||||
- {{note_1}}
|
- {{note_1}}
|
||||||
- {{note_2}}
|
- {{note_2}}
|
||||||
|
|
||||||
**Design Decisions:**
|
**Design Decisions:**
|
||||||
|
|
||||||
- {{decision_1}}: {{rationale}}
|
- {{decision_1}}: {{rationale}}
|
||||||
- {{decision_2}}: {{rationale}}
|
- {{decision_2}}: {{rationale}}
|
||||||
|
|
||||||
**Future Considerations:**
|
**Future Considerations:**
|
||||||
|
|
||||||
- {{future_enhancement_1}}
|
- {{future_enhancement_1}}
|
||||||
- {{future_optimization_1}}
|
- {{future_optimization_1}}
|
||||||
==================== END: .bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml ====================
|
==================== END: .bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml ====================
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -554,18 +554,18 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
Initial Setup
|
Initial Setup
|
||||||
|
|
||||||
1. Replace {{project_name}} with the actual project name throughout the document
|
1. Replace {{project_name}} with the actual project name throughout the document
|
||||||
2. Gather and review required inputs:
|
2. Gather and review required inputs:
|
||||||
- Product Requirements Document (PRD) - Required for business needs and scale requirements
|
- Product Requirements Document (PRD) - Required for business needs and scale requirements
|
||||||
- Main System Architecture - Required for infrastructure dependencies
|
- Main System Architecture - Required for infrastructure dependencies
|
||||||
- Technical Preferences/Tech Stack Document - Required for technology choices
|
- Technical Preferences/Tech Stack Document - Required for technology choices
|
||||||
- PRD Technical Assumptions - Required for cross-referencing repository and service architecture
|
- PRD Technical Assumptions - Required for cross-referencing repository and service architecture
|
||||||
|
|
||||||
If any required documents are missing, ask user: "I need the following documents to create a comprehensive infrastructure architecture: [list missing]. Would you like to proceed with available information or provide the missing documents first?"
|
If any required documents are missing, ask user: "I need the following documents to create a comprehensive infrastructure architecture: [list missing]. Would you like to proceed with available information or provide the missing documents first?"
|
||||||
|
|
||||||
3. <critical_rule>Cross-reference with PRD Technical Assumptions to ensure infrastructure decisions align with repository and service architecture decisions made in the system architecture.</critical_rule>
|
3. <critical_rule>Cross-reference with PRD Technical Assumptions to ensure infrastructure decisions align with repository and service architecture decisions made in the system architecture.</critical_rule>
|
||||||
|
|
||||||
Output file location: `docs/infrastructure-architecture.md`
|
Output file location: `docs/infrastructure-architecture.md`
|
||||||
|
|
||||||
- id: infrastructure-overview
|
- id: infrastructure-overview
|
||||||
|
|
@ -594,7 +594,7 @@ sections:
|
||||||
- Repository Structure
|
- Repository Structure
|
||||||
- State Management
|
- State Management
|
||||||
- Dependency Management
|
- Dependency Management
|
||||||
|
|
||||||
<critical_rule>All infrastructure must be defined as code. No manual resource creation in production environments.</critical_rule>
|
<critical_rule>All infrastructure must be defined as code. No manual resource creation in production environments.</critical_rule>
|
||||||
|
|
||||||
- id: environment-configuration
|
- id: environment-configuration
|
||||||
|
|
@ -630,7 +630,7 @@ sections:
|
||||||
title: Network Architecture
|
title: Network Architecture
|
||||||
instruction: |
|
instruction: |
|
||||||
Design network topology considering security zones, traffic patterns, and compliance requirements. Reference main architecture for service communication patterns.
|
Design network topology considering security zones, traffic patterns, and compliance requirements. Reference main architecture for service communication patterns.
|
||||||
|
|
||||||
Create Mermaid diagram showing:
|
Create Mermaid diagram showing:
|
||||||
- VPC/Network structure
|
- VPC/Network structure
|
||||||
- Security zones and boundaries
|
- Security zones and boundaries
|
||||||
|
|
@ -693,7 +693,7 @@ sections:
|
||||||
title: Data Resources
|
title: Data Resources
|
||||||
instruction: |
|
instruction: |
|
||||||
Design data infrastructure based on data architecture from main system design. Consider data volumes, access patterns, compliance, and recovery requirements.
|
Design data infrastructure based on data architecture from main system design. Consider data volumes, access patterns, compliance, and recovery requirements.
|
||||||
|
|
||||||
Create data flow diagram showing:
|
Create data flow diagram showing:
|
||||||
- Database topology
|
- Database topology
|
||||||
- Replication patterns
|
- Replication patterns
|
||||||
|
|
@ -714,7 +714,7 @@ sections:
|
||||||
- Data Encryption
|
- Data Encryption
|
||||||
- Compliance Controls
|
- Compliance Controls
|
||||||
- Security Scanning & Monitoring
|
- Security Scanning & Monitoring
|
||||||
|
|
||||||
<critical_rule>Apply principle of least privilege for all access controls. Document all security exceptions with business justification.</critical_rule>
|
<critical_rule>Apply principle of least privilege for all access controls. Document all security exceptions with business justification.</critical_rule>
|
||||||
|
|
||||||
- id: shared-responsibility
|
- id: shared-responsibility
|
||||||
|
|
@ -750,7 +750,7 @@ sections:
|
||||||
title: CI/CD Pipeline
|
title: CI/CD Pipeline
|
||||||
instruction: |
|
instruction: |
|
||||||
Design deployment pipeline that balances speed with safety. Include progressive deployment strategies and automated quality gates.
|
Design deployment pipeline that balances speed with safety. Include progressive deployment strategies and automated quality gates.
|
||||||
|
|
||||||
Create pipeline diagram showing:
|
Create pipeline diagram showing:
|
||||||
- Build stages
|
- Build stages
|
||||||
- Test gates
|
- Test gates
|
||||||
|
|
@ -781,7 +781,7 @@ sections:
|
||||||
- Recovery Procedures
|
- Recovery Procedures
|
||||||
- RTO & RPO Targets
|
- RTO & RPO Targets
|
||||||
- DR Testing Approach
|
- DR Testing Approach
|
||||||
|
|
||||||
<critical_rule>DR procedures must be tested at least quarterly. Document test results and improvement actions.</critical_rule>
|
<critical_rule>DR procedures must be tested at least quarterly. Document test results and improvement actions.</critical_rule>
|
||||||
|
|
||||||
- id: cost-optimization
|
- id: cost-optimization
|
||||||
|
|
@ -823,15 +823,15 @@ sections:
|
||||||
title: DevOps/Platform Feasibility Review
|
title: DevOps/Platform Feasibility Review
|
||||||
instruction: |
|
instruction: |
|
||||||
CRITICAL STEP - Present architectural blueprint summary to DevOps/Platform Engineering Agent for feasibility review. Request specific feedback on:
|
CRITICAL STEP - Present architectural blueprint summary to DevOps/Platform Engineering Agent for feasibility review. Request specific feedback on:
|
||||||
|
|
||||||
- **Operational Complexity:** Are the proposed patterns implementable with current tooling and expertise?
|
- **Operational Complexity:** Are the proposed patterns implementable with current tooling and expertise?
|
||||||
- **Resource Constraints:** Do infrastructure requirements align with available resources and budgets?
|
- **Resource Constraints:** Do infrastructure requirements align with available resources and budgets?
|
||||||
- **Security Implementation:** Are security patterns achievable with current security toolchain?
|
- **Security Implementation:** Are security patterns achievable with current security toolchain?
|
||||||
- **Operational Overhead:** Will the proposed architecture create excessive operational burden?
|
- **Operational Overhead:** Will the proposed architecture create excessive operational burden?
|
||||||
- **Technology Constraints:** Are selected technologies compatible with existing infrastructure?
|
- **Technology Constraints:** Are selected technologies compatible with existing infrastructure?
|
||||||
|
|
||||||
Document all feasibility feedback and concerns raised. Iterate on architectural decisions based on operational constraints and feedback.
|
Document all feasibility feedback and concerns raised. Iterate on architectural decisions based on operational constraints and feedback.
|
||||||
|
|
||||||
<critical_rule>Address all critical feasibility concerns before proceeding to final architecture documentation. If critical blockers identified, revise architecture before continuing.</critical_rule>
|
<critical_rule>Address all critical feasibility concerns before proceeding to final architecture documentation. If critical blockers identified, revise architecture before continuing.</critical_rule>
|
||||||
sections:
|
sections:
|
||||||
- id: feasibility-results
|
- id: feasibility-results
|
||||||
|
|
@ -849,7 +849,7 @@ sections:
|
||||||
title: Validation Framework
|
title: Validation Framework
|
||||||
content: |
|
content: |
|
||||||
This infrastructure architecture will be validated using the comprehensive `infrastructure-checklist.md`, with particular focus on Section 12: Architecture Documentation Validation. The checklist ensures:
|
This infrastructure architecture will be validated using the comprehensive `infrastructure-checklist.md`, with particular focus on Section 12: Architecture Documentation Validation. The checklist ensures:
|
||||||
|
|
||||||
- Completeness of architecture documentation
|
- Completeness of architecture documentation
|
||||||
- Consistency with broader system architecture
|
- Consistency with broader system architecture
|
||||||
- Appropriate level of detail for different stakeholders
|
- Appropriate level of detail for different stakeholders
|
||||||
|
|
@ -859,12 +859,12 @@ sections:
|
||||||
title: Validation Process
|
title: Validation Process
|
||||||
content: |
|
content: |
|
||||||
The architecture documentation validation should be performed:
|
The architecture documentation validation should be performed:
|
||||||
|
|
||||||
- After initial architecture development
|
- After initial architecture development
|
||||||
- After significant architecture changes
|
- After significant architecture changes
|
||||||
- Before major implementation phases
|
- Before major implementation phases
|
||||||
- During periodic architecture reviews
|
- During periodic architecture reviews
|
||||||
|
|
||||||
The Platform Engineer should use the infrastructure checklist to systematically validate all aspects of this architecture document.
|
The Platform Engineer should use the infrastructure checklist to systematically validate all aspects of this architecture document.
|
||||||
|
|
||||||
- id: implementation-handoff
|
- id: implementation-handoff
|
||||||
|
|
@ -875,7 +875,7 @@ sections:
|
||||||
title: Architecture Decision Records (ADRs)
|
title: Architecture Decision Records (ADRs)
|
||||||
content: |
|
content: |
|
||||||
Create ADRs for key infrastructure decisions:
|
Create ADRs for key infrastructure decisions:
|
||||||
|
|
||||||
- Cloud provider selection rationale
|
- Cloud provider selection rationale
|
||||||
- Container orchestration platform choice
|
- Container orchestration platform choice
|
||||||
- Networking architecture decisions
|
- Networking architecture decisions
|
||||||
|
|
@ -885,7 +885,7 @@ sections:
|
||||||
title: Implementation Validation Criteria
|
title: Implementation Validation Criteria
|
||||||
content: |
|
content: |
|
||||||
Define specific criteria for validating correct implementation:
|
Define specific criteria for validating correct implementation:
|
||||||
|
|
||||||
- Infrastructure as Code quality gates
|
- Infrastructure as Code quality gates
|
||||||
- Security compliance checkpoints
|
- Security compliance checkpoints
|
||||||
- Performance benchmarks
|
- Performance benchmarks
|
||||||
|
|
@ -945,7 +945,7 @@ sections:
|
||||||
instruction: Final Review - Ensure all sections are complete and consistent. Verify feasibility review was conducted and all concerns addressed. Apply final validation against infrastructure checklist.
|
instruction: Final Review - Ensure all sections are complete and consistent. Verify feasibility review was conducted and all concerns addressed. Apply final validation against infrastructure checklist.
|
||||||
content: |
|
content: |
|
||||||
---
|
---
|
||||||
|
|
||||||
_Document Version: 1.0_
|
_Document Version: 1.0_
|
||||||
_Last Updated: {{current_date}}_
|
_Last Updated: {{current_date}}_
|
||||||
_Next Review: {{review_date}}_
|
_Next Review: {{review_date}}_
|
||||||
|
|
@ -982,7 +982,7 @@ sections:
|
||||||
- id: initial-setup
|
- id: initial-setup
|
||||||
instruction: |
|
instruction: |
|
||||||
Initial Setup
|
Initial Setup
|
||||||
|
|
||||||
1. Replace {{project_name}} with the actual project name throughout the document
|
1. Replace {{project_name}} with the actual project name throughout the document
|
||||||
2. Gather and review required inputs:
|
2. Gather and review required inputs:
|
||||||
- **Infrastructure Architecture Document** (Primary input - REQUIRED)
|
- **Infrastructure Architecture Document** (Primary input - REQUIRED)
|
||||||
|
|
@ -991,10 +991,10 @@ sections:
|
||||||
- Technology Stack Document
|
- Technology Stack Document
|
||||||
- Infrastructure Checklist
|
- Infrastructure Checklist
|
||||||
- NOTE: If Infrastructure Architecture Document is missing, HALT and request: "I need the Infrastructure Architecture Document to proceed with platform implementation. This document defines the infrastructure design that we'll be implementing."
|
- NOTE: If Infrastructure Architecture Document is missing, HALT and request: "I need the Infrastructure Architecture Document to proceed with platform implementation. This document defines the infrastructure design that we'll be implementing."
|
||||||
|
|
||||||
3. Validate that the infrastructure architecture has been reviewed and approved
|
3. Validate that the infrastructure architecture has been reviewed and approved
|
||||||
4. <critical_rule>All platform implementation must align with the approved infrastructure architecture. Any deviations require architect approval.</critical_rule>
|
4. <critical_rule>All platform implementation must align with the approved infrastructure architecture. Any deviations require architect approval.</critical_rule>
|
||||||
|
|
||||||
Output file location: `docs/platform-infrastructure/platform-implementation.md`
|
Output file location: `docs/platform-infrastructure/platform-implementation.md`
|
||||||
|
|
||||||
- id: executive-summary
|
- id: executive-summary
|
||||||
|
|
@ -1067,7 +1067,7 @@ sections:
|
||||||
# Example Terraform for VPC setup
|
# Example Terraform for VPC setup
|
||||||
module "vpc" {
|
module "vpc" {
|
||||||
source = "./modules/vpc"
|
source = "./modules/vpc"
|
||||||
|
|
||||||
cidr_block = "{{vpc_cidr}}"
|
cidr_block = "{{vpc_cidr}}"
|
||||||
availability_zones = {{availability_zones}}
|
availability_zones = {{availability_zones}}
|
||||||
public_subnets = {{public_subnets}}
|
public_subnets = {{public_subnets}}
|
||||||
|
|
@ -1462,7 +1462,7 @@ sections:
|
||||||
// K6 Load Test Example
|
// K6 Load Test Example
|
||||||
import http from 'k6/http';
|
import http from 'k6/http';
|
||||||
import { check } from 'k6';
|
import { check } from 'k6';
|
||||||
|
|
||||||
export let options = {
|
export let options = {
|
||||||
stages: [
|
stages: [
|
||||||
{ duration: '5m', target: {{target_users}} },
|
{ duration: '5m', target: {{target_users}} },
|
||||||
|
|
@ -1576,7 +1576,7 @@ sections:
|
||||||
instruction: Final Review - Ensure all platform layers are properly implemented, integrated, and documented. Verify that the implementation fully supports the BMAD methodology and all agent workflows. Confirm successful validation against the infrastructure checklist.
|
instruction: Final Review - Ensure all platform layers are properly implemented, integrated, and documented. Verify that the implementation fully supports the BMAD methodology and all agent workflows. Confirm successful validation against the infrastructure checklist.
|
||||||
content: |
|
content: |
|
||||||
---
|
---
|
||||||
|
|
||||||
_Platform Version: 1.0_
|
_Platform Version: 1.0_
|
||||||
_Implementation Date: {{implementation_date}}_
|
_Implementation Date: {{implementation_date}}_
|
||||||
_Next Review: {{review_date}}_
|
_Next Review: {{review_date}}_
|
||||||
|
|
@ -2071,7 +2071,47 @@ This checklist serves as a comprehensive framework for validating infrastructure
|
||||||
==================== END: .bmad-infrastructure-devops/checklists/infrastructure-checklist.md ====================
|
==================== END: .bmad-infrastructure-devops/checklists/infrastructure-checklist.md ====================
|
||||||
|
|
||||||
==================== START: .bmad-infrastructure-devops/data/technical-preferences.md ====================
|
==================== START: .bmad-infrastructure-devops/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# Technical Preferences and Architectural Principles
|
||||||
|
|
||||||
|
## Core Principles References
|
||||||
|
|
||||||
|
The following technical principles and standards apply to all BMAD projects:
|
||||||
|
|
||||||
|
### 1. Coding Standards
|
||||||
|
- **Reference:** `coding-standards.md`
|
||||||
|
- **Purpose:** Fundamental coding principles, security practices, and quality standards
|
||||||
|
- **Key Areas:** Code simplicity, dependency management, security, testing, commit standards
|
||||||
|
|
||||||
|
### 2. Twelve-Factor App Principles
|
||||||
|
- **Reference:** `twelve-factor-principles.md`
|
||||||
|
- **Purpose:** Cloud-native application development principles
|
||||||
|
- **Key Areas:** Codebase management, dependencies, config, backing services, build/release/run
|
||||||
|
|
||||||
|
### 3. Microservice Patterns
|
||||||
|
- **Reference:** `microservice-patterns.md`
|
||||||
|
- **Purpose:** Patterns for distributed system architecture
|
||||||
|
- **Key Areas:** Service decomposition, communication patterns, data management, resilience
|
||||||
|
|
||||||
|
## Application Guidelines
|
||||||
|
|
||||||
|
1. **During Architecture Design:**
|
||||||
|
- Apply twelve-factor principles for cloud-native applications
|
||||||
|
- Consider microservice patterns for complex distributed systems
|
||||||
|
- Document pattern choices in Architecture Decision Records (ADRs)
|
||||||
|
|
||||||
|
2. **During Implementation:**
|
||||||
|
- Follow coding standards for all code generation
|
||||||
|
- Apply security principles by default
|
||||||
|
- Ensure testability and maintainability
|
||||||
|
|
||||||
|
3. **Technology Selection:**
|
||||||
|
- Prefer simple, proven solutions over complex ones
|
||||||
|
- Minimize dependencies unless explicitly justified
|
||||||
|
- Consider operational complexity alongside technical capabilities
|
||||||
|
|
||||||
|
## User-Defined Preferences
|
||||||
|
|
||||||
|
_Add project-specific technical preferences below:_
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: .bmad-infrastructure-devops/data/technical-preferences.md ====================
|
==================== END: .bmad-infrastructure-devops/data/technical-preferences.md ====================
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue