Feature/expansionpack 2d unity game dev (#332)
* Added 1.0 files * Converted agents, and templates to new format. Updated filenames to include extensions like in unity-2d-game-team.yaml, Updated some wordage in workflow, config, and increased minor version number * Forgot to remove unused startup section in game-sm since it's moved to activation-instructions, now fixed. * Updated verbosity for development workflow in development-guidenlines.md * built the web-dist files for the expansion pack * Synched with main repo and rebuilt dist * Added enforcement of game-design-checklist to designer persona * Updated with new changes to phaser epack that seem relevant to discussion we had on discord for summarizing documentation updates * updated dist build for our epack
This commit is contained in:
PinkyD
@@ -0,0 +1,201 @@
|
||||
# Game Design Document Quality Checklist
|
||||
|
||||
## Document Completeness
|
||||
|
||||
### Executive Summary
|
||||
|
||||
- [ ] **Core Concept** - Game concept is clearly explained in 2-3 sentences
|
||||
- [ ] **Target Audience** - Primary and secondary audiences defined with demographics
|
||||
- [ ] **Platform Requirements** - Technical platforms and requirements specified
|
||||
- [ ] **Unique Selling Points** - 3-5 key differentiators from competitors identified
|
||||
- [ ] **Technical Foundation** - Unity & C# requirements confirmed
|
||||
|
||||
### Game Design Foundation
|
||||
|
||||
- [ ] **Game Pillars** - 3-5 core design pillars defined and actionable
|
||||
- [ ] **Core Gameplay Loop** - 30-60 second loop documented with specific timings
|
||||
- [ ] **Win/Loss Conditions** - Clear victory and failure states defined
|
||||
- [ ] **Player Motivation** - Clear understanding of why players will engage
|
||||
- [ ] **Scope Realism** - Game scope is achievable with available resources
|
||||
|
||||
## Gameplay Mechanics
|
||||
|
||||
### Core Mechanics Documentation
|
||||
|
||||
- [ ] **Primary Mechanics** - 3-5 core mechanics detailed with implementation notes
|
||||
- [ ] **Mechanic Integration** - How mechanics work together is clear
|
||||
- [ ] **Player Input** - All input methods specified for each platform
|
||||
- [ ] **System Responses** - Game responses to player actions documented
|
||||
- [ ] **Performance Impact** - Performance considerations for each mechanic noted
|
||||
|
||||
### Controls and Interaction
|
||||
|
||||
- [ ] **Multi-Platform Controls** - Desktop, mobile, and gamepad controls defined
|
||||
- [ ] **Input Responsiveness** - Requirements for responsive game feel specified
|
||||
- [ ] **Accessibility Options** - Control customization and accessibility considered
|
||||
- [ ] **Touch Optimization** - Mobile-specific control adaptations designed
|
||||
- [ ] **Edge Case Handling** - Unusual input scenarios addressed
|
||||
|
||||
## Progression and Balance
|
||||
|
||||
### Player Progression
|
||||
|
||||
- [ ] **Progression Type** - Linear, branching, or metroidvania approach defined
|
||||
- [ ] **Key Milestones** - Major progression points documented
|
||||
- [ ] **Unlock System** - What players unlock and when is specified
|
||||
- [ ] **Difficulty Scaling** - How challenge increases over time is detailed
|
||||
- [ ] **Player Agency** - Meaningful player choices and consequences defined
|
||||
|
||||
### Game Balance
|
||||
|
||||
- [ ] **Balance Parameters** - Numeric values for key game systems provided
|
||||
- [ ] **Difficulty Curve** - Appropriate challenge progression designed
|
||||
- [ ] **Economy Design** - Resource systems balanced for engagement
|
||||
- [ ] **Player Testing** - Plan for validating balance through playtesting
|
||||
- [ ] **Iteration Framework** - Process for adjusting balance post-implementation
|
||||
|
||||
## Level Design Framework
|
||||
|
||||
### Level Structure
|
||||
|
||||
- [ ] **Level Types** - Different level categories defined with purposes
|
||||
- [ ] **Level Progression** - How players move through levels specified
|
||||
- [ ] **Duration Targets** - Expected play time for each level type
|
||||
- [ ] **Difficulty Distribution** - Appropriate challenge spread across levels
|
||||
- [ ] **Replay Value** - Elements that encourage repeated play designed
|
||||
|
||||
### Content Guidelines
|
||||
|
||||
- [ ] **Level Creation Rules** - Clear guidelines for level designers
|
||||
- [ ] **Mechanic Introduction** - How new mechanics are taught in levels
|
||||
- [ ] **Pacing Variety** - Mix of action, puzzle, and rest moments planned
|
||||
- [ ] **Secret Content** - Hidden areas and optional challenges designed
|
||||
- [ ] **Accessibility Options** - Multiple difficulty levels or assist modes considered
|
||||
|
||||
## Technical Implementation Readiness
|
||||
|
||||
### Performance Requirements
|
||||
|
||||
- [ ] **Frame Rate Targets** - Stable FPS target with minimum acceptable rates
|
||||
- [ ] **Memory Budgets** - Maximum memory usage limits defined
|
||||
- [ ] **Load Time Goals** - Acceptable loading times for different content
|
||||
- [ ] **Battery Optimization** - Mobile battery usage considerations addressed
|
||||
- [ ] **Scalability Plan** - How performance scales across different devices
|
||||
|
||||
### Platform Specifications
|
||||
|
||||
- [ ] **Desktop Requirements** - Minimum and recommended PC/Mac specs
|
||||
- [ ] **Mobile Optimization** - iOS and Android specific requirements
|
||||
- [ ] **Browser Compatibility** - Supported browsers and versions listed
|
||||
- [ ] **Cross-Platform Features** - Shared and platform-specific features identified
|
||||
- [ ] **Update Strategy** - Plan for post-launch updates and patches
|
||||
|
||||
### Asset Requirements
|
||||
|
||||
- [ ] **Art Style Definition** - Clear visual style with reference materials
|
||||
- [ ] **Asset Specifications** - Technical requirements for all asset types
|
||||
- [ ] **Audio Requirements** - Music and sound effect specifications
|
||||
- [ ] **UI/UX Guidelines** - User interface design principles established
|
||||
- [ ] **Localization Plan** - Text and cultural localization requirements
|
||||
|
||||
## Development Planning
|
||||
|
||||
### Implementation Phases
|
||||
|
||||
- [ ] **Phase Breakdown** - Development divided into logical phases
|
||||
- [ ] **Epic Definitions** - Major development epics identified
|
||||
- [ ] **Dependency Mapping** - Prerequisites between features documented
|
||||
- [ ] **Risk Assessment** - Technical and design risks identified with mitigation
|
||||
- [ ] **Milestone Planning** - Key deliverables and deadlines established
|
||||
|
||||
### Team Requirements
|
||||
|
||||
- [ ] **Role Definitions** - Required team roles and responsibilities
|
||||
- [ ] **Skill Requirements** - Technical skills needed for implementation
|
||||
- [ ] **Resource Allocation** - Time and effort estimates for major features
|
||||
- [ ] **External Dependencies** - Third-party tools, assets, or services needed
|
||||
- [ ] **Communication Plan** - How team members will coordinate work
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
### Success Metrics
|
||||
|
||||
- [ ] **Technical Metrics** - Measurable technical performance goals
|
||||
- [ ] **Gameplay Metrics** - Player engagement and retention targets
|
||||
- [ ] **Quality Benchmarks** - Standards for bug rates and polish level
|
||||
- [ ] **User Experience Goals** - Specific UX objectives and measurements
|
||||
- [ ] **Business Objectives** - Commercial or project success criteria
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
- [ ] **Playtesting Plan** - How and when player feedback will be gathered
|
||||
- [ ] **Technical Testing** - Performance and compatibility testing approach
|
||||
- [ ] **Balance Validation** - Methods for confirming game balance
|
||||
- [ ] **Accessibility Testing** - Plan for testing with diverse players
|
||||
- [ ] **Iteration Process** - How feedback will drive design improvements
|
||||
|
||||
## Documentation Quality
|
||||
|
||||
### Clarity and Completeness
|
||||
|
||||
- [ ] **Clear Writing** - All sections are well-written and understandable
|
||||
- [ ] **Complete Coverage** - No major game systems left undefined
|
||||
- [ ] **Actionable Detail** - Enough detail for developers to create implementation stories
|
||||
- [ ] **Consistent Terminology** - Game terms used consistently throughout
|
||||
- [ ] **Reference Materials** - Links to inspiration, research, and additional resources
|
||||
|
||||
### Maintainability
|
||||
|
||||
- [ ] **Version Control** - Change log established for tracking revisions
|
||||
- [ ] **Update Process** - Plan for maintaining document during development
|
||||
- [ ] **Team Access** - All team members can access and reference the document
|
||||
- [ ] **Search Functionality** - Document organized for easy reference and searching
|
||||
- [ ] **Living Document** - Process for incorporating feedback and changes
|
||||
|
||||
## Stakeholder Alignment
|
||||
|
||||
### Team Understanding
|
||||
|
||||
- [ ] **Shared Vision** - All team members understand and agree with the game vision
|
||||
- [ ] **Role Clarity** - Each team member understands their contribution
|
||||
- [ ] **Decision Framework** - Process for making design decisions during development
|
||||
- [ ] **Conflict Resolution** - Plan for resolving disagreements about design choices
|
||||
- [ ] **Communication Channels** - Regular meetings and feedback sessions planned
|
||||
|
||||
### External Validation
|
||||
|
||||
- [ ] **Market Validation** - Competitive analysis and market fit assessment
|
||||
- [ ] **Technical Validation** - Feasibility confirmed with technical team
|
||||
- [ ] **Resource Validation** - Required resources available and committed
|
||||
- [ ] **Timeline Validation** - Development schedule is realistic and achievable
|
||||
- [ ] **Quality Validation** - Quality standards align with available time and resources
|
||||
|
||||
## Final Readiness Assessment
|
||||
|
||||
### Implementation Preparedness
|
||||
|
||||
- [ ] **Story Creation Ready** - Document provides sufficient detail for story creation
|
||||
- [ ] **Architecture Alignment** - Game design aligns with technical capabilities
|
||||
- ] **Asset Production** - Asset requirements enable art and audio production
|
||||
- [ ] **Development Workflow** - Clear path from design to implementation
|
||||
- [ ] **Quality Assurance** - Testing and validation processes established
|
||||
|
||||
### Document Approval
|
||||
|
||||
- [ ] **Design Review Complete** - Document reviewed by all relevant stakeholders
|
||||
- [ ] **Technical Review Complete** - Technical feasibility confirmed
|
||||
- [ ] **Business Review Complete** - Project scope and goals approved
|
||||
- [ ] **Final Approval** - Document officially approved for implementation
|
||||
- [ ] **Baseline Established** - Current version established as development baseline
|
||||
|
||||
## Overall Assessment
|
||||
|
||||
**Document Quality Rating:** ⭐⭐⭐⭐⭐
|
||||
|
||||
**Ready for Development:** [ ] Yes [ ] No
|
||||
|
||||
**Key Recommendations:**
|
||||
_List any critical items that need attention before moving to implementation phase._
|
||||
|
||||
**Next Steps:**
|
||||
_Outline immediate next actions for the team based on this assessment._
|
||||
@@ -0,0 +1,160 @@
|
||||
# Game Development Story Definition of Done Checklist
|
||||
|
||||
## Story Completeness
|
||||
|
||||
### Basic Story Elements
|
||||
|
||||
- [ ] **Story Title** - Clear, descriptive title that identifies the feature
|
||||
- [ ] **Epic Assignment** - Story is properly assigned to relevant epic
|
||||
- [ ] **Priority Level** - Appropriate priority assigned (High/Medium/Low)
|
||||
- [ ] **Story Points** - Realistic estimation for implementation complexity
|
||||
- [ ] **Description** - Clear, concise description of what needs to be implemented
|
||||
|
||||
### Game Design Alignment
|
||||
|
||||
- [ ] **GDD Reference** - Specific Game Design Document section referenced
|
||||
- [ ] **Game Mechanic Context** - Clear connection to game mechanics defined in GDD
|
||||
- [ ] **Player Experience Goal** - Describes the intended player experience
|
||||
- [ ] **Balance Parameters** - Includes any relevant game balance values
|
||||
- [ ] **Design Intent** - Purpose and rationale for the feature is clear
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
### Architecture Compliance
|
||||
|
||||
- [ ] **File Organization** - Follows game architecture document structure (e.g., scripts, prefabs, scenes)
|
||||
- [ ] **Class Definitions** - C# classes and interfaces are properly defined
|
||||
- [ ] **Integration Points** - Clear specification of how feature integrates with existing systems
|
||||
- [ ] **Event Communication** - UnityEvents or C# events usage specified
|
||||
- [ ] **Dependencies** - All system dependencies clearly identified
|
||||
|
||||
### Unity Requirements
|
||||
|
||||
- [ ] **Scene Integration** - Specifies which scenes are affected and how
|
||||
- [ ] **Prefab Usage** - Proper use of prefabs for reusable GameObjects
|
||||
- [ ] **Component Design** - Logic is encapsulated in well-defined MonoBehaviour components
|
||||
- [ ] **Asset Requirements** - All needed assets (sprites, audio, materials) identified
|
||||
- [ ] **Performance Considerations** - Stable frame rate target and optimization requirements
|
||||
|
||||
### Code Quality Standards
|
||||
|
||||
- [ ] **C# Best Practices** - All code must comply with modern C# standards
|
||||
- [ ] **Error Handling** - Error scenarios and handling requirements specified
|
||||
- [ ] **Memory Management** - Coroutine and object lifecycle management requirements where needed
|
||||
- [ ] **Cross-Platform Support** - Desktop and mobile considerations addressed
|
||||
- [ ] **Code Organization** - Follows established Unity project structure
|
||||
|
||||
## Implementation Readiness
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- [ ] **Functional Requirements** - All functional acceptance criteria are specific and testable
|
||||
- [ ] **Technical Requirements** - Technical acceptance criteria are complete and verifiable
|
||||
- [ ] **Game Design Requirements** - Game-specific requirements match GDD specifications
|
||||
- [ ] **Performance Requirements** - Frame rate and memory usage criteria specified
|
||||
- [ ] **Completeness** - No acceptance criteria are vague or unmeasurable
|
||||
|
||||
### Implementation Tasks
|
||||
|
||||
- [ ] **Task Breakdown** - Story broken into specific, ordered implementation tasks
|
||||
- [ ] **Task Scope** - Each task is completable in 1-4 hours
|
||||
- [ ] **Task Clarity** - Each task has clear, actionable instructions
|
||||
- [ ] **File Specifications** - Exact file paths and purposes specified (e.g., `Scripts/Player/PlayerMovement.cs`)
|
||||
- [ ] **Development Flow** - Tasks follow logical implementation order
|
||||
|
||||
### Dependencies
|
||||
|
||||
- [ ] **Story Dependencies** - All prerequisite stories identified with IDs
|
||||
- [ ] **Technical Dependencies** - Required systems and files identified
|
||||
- [ ] **Asset Dependencies** - All needed assets specified with locations
|
||||
- [ ] **External Dependencies** - Any third-party or external requirements noted (e.g., Asset Store packages)
|
||||
- [ ] **Dependency Validation** - All dependencies are actually available
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
### Test Coverage
|
||||
|
||||
- [ ] **Unit Test Requirements** - Specific unit test files and scenarios defined for NUnit
|
||||
- [ ] **Integration Test Cases** - Integration testing with other game systems specified
|
||||
- [ ] **Manual Test Cases** - Game-specific manual testing procedures defined in the Unity Editor
|
||||
- [ ] **Performance Tests** - Frame rate and memory testing requirements specified
|
||||
- [ ] **Edge Case Testing** - Edge cases and error conditions covered
|
||||
|
||||
### Test Implementation
|
||||
|
||||
- [ ] **Test File Paths** - Exact test file locations specified (e.g., `Assets/Tests/EditMode`)
|
||||
- [ ] **Test Scenarios** - All test scenarios are complete and executable
|
||||
- [ ] **Expected Behaviors** - Clear expected outcomes for all tests defined
|
||||
- [ ] **Performance Metrics** - Specific performance targets for testing
|
||||
- [ ] **Test Data** - Any required test data or mock objects specified
|
||||
|
||||
## Game-Specific Quality
|
||||
|
||||
### Gameplay Implementation
|
||||
|
||||
- [ ] **Mechanic Accuracy** - Implementation matches GDD mechanic specifications
|
||||
- [ ] **Player Controls** - Input handling requirements are complete (e.g., Input System package)
|
||||
- [ ] **Game Feel** - Requirements for juice, feedback, and responsiveness specified
|
||||
- [ ] **Balance Implementation** - Numeric values and parameters from GDD included
|
||||
- [ ] **State Management** - Game state changes and persistence requirements defined
|
||||
|
||||
### User Experience
|
||||
|
||||
- [ ] **UI Requirements** - User interface elements and behaviors specified (e.g., UI Toolkit or UGUI)
|
||||
- [ ] **Audio Integration** - Sound effect and music requirements defined
|
||||
- [ ] **Visual Feedback** - Animation and visual effect requirements specified (e.g., Animator, Particle System)
|
||||
- [ ] **Accessibility** - Mobile touch and responsive design considerations
|
||||
- [ ] **Error Recovery** - User-facing error handling and recovery specified
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
- [ ] **Frame Rate Targets** - Specific FPS requirements for different platforms
|
||||
- [ ] **Memory Usage** - Memory consumption limits and monitoring requirements (e.g., Profiler)
|
||||
- [ ] **Asset Optimization** - Texture, audio, and data optimization requirements
|
||||
- [ ] **Mobile Considerations** - Touch controls and mobile performance requirements
|
||||
- [ ] **Loading Performance** - Asset loading and scene transition requirements
|
||||
|
||||
## Documentation and Communication
|
||||
|
||||
### Story Documentation
|
||||
|
||||
- [ ] **Implementation Notes** - Additional context and implementation guidance provided
|
||||
- [ ] **Design Decisions** - Key design choices documented with rationale
|
||||
- [ ] **Future Considerations** - Potential future enhancements or modifications noted
|
||||
- [ ] **Change Tracking** - Process for tracking any requirement changes during development
|
||||
- [ ] **Reference Materials** - Links to relevant GDD sections and architecture docs
|
||||
|
||||
### Developer Handoff
|
||||
|
||||
- [ ] **Immediate Actionability** - Developer can start implementation without additional questions
|
||||
- [ ] **Complete Context** - All necessary context provided within the story
|
||||
- [ ] **Clear Boundaries** - What is and isn't included in the story scope is clear
|
||||
- [ ] **Success Criteria** - Objective measures for story completion defined
|
||||
- [ ] **Communication Plan** - Process for developer questions and updates established
|
||||
|
||||
## Final Validation
|
||||
|
||||
### Story Readiness
|
||||
|
||||
- [ ] **No Ambiguity** - No sections require interpretation or additional design decisions
|
||||
- [ ] **Technical Completeness** - All technical requirements are specified and actionable
|
||||
- [ ] **Scope Appropriateness** - Story scope matches assigned story points
|
||||
- [ ] **Quality Standards** - Story meets all game development quality standards
|
||||
- [ ] **Review Completion** - Story has been reviewed for completeness and accuracy
|
||||
|
||||
### Implementation Preparedness
|
||||
|
||||
- [ ] **Environment Ready** - Development environment requirements specified (e.g., Unity version)
|
||||
- [ ] **Resources Available** - All required resources (assets, docs, dependencies) accessible
|
||||
- [ ] **Testing Prepared** - Testing environment and data requirements specified
|
||||
- [ ] **Definition of Done** - Clear, objective completion criteria established
|
||||
- [ ] **Handoff Complete** - Story is ready for developer assignment and implementation
|
||||
|
||||
## Checklist Completion
|
||||
|
||||
**Overall Story Quality:** ⭐⭐⭐⭐⭐
|
||||
|
||||
**Ready for Development:** [ ] Yes [ ] No
|
||||
|
||||
**Additional Notes:**
|
||||
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
||||
Reference in New Issue
Block a user