Le Hoang Nam
419a93837f
- Updated the title to "Overview & Purpose" for better context. - Refined the purpose section to emphasize the document's role as a central reference for game development workflows. - Introduced a new section outlining the document's scope and expected benefits for development teams, code delivery, and the organization. - Streamlined content by removing outdated sections and consolidating key workflow components. - Added clear headings and bullet points for improved readability and navigation.
75 lines
2.9 KiB
Markdown
75 lines
2.9 KiB
Markdown
---
|
|
id: 01-overview
|
|
title: Overview
|
|
---
|
|
|
|
# Overview & Purpose
|
|
|
|
## Document Purpose
|
|
|
|
This development workflow document serves as the **central reference guide** for all developers involved in our **game development process**. It defines standardized practices, procedures, and guidelines to ensure consistency, efficiency, and high-quality delivery across all projects.
|
|
|
|
### Why This Document Exists
|
|
- **Game Development Standardization** → Provides uniform processes across projects.
|
|
- **Rapid Onboarding** → Helps new team members quickly learn workflows.
|
|
- **Quality Assurance** → Enforces practices that maintain technical and delivery standards.
|
|
|
|
---
|
|
|
|
## Document Scope
|
|
|
|
### What This Workflow Covers
|
|
|
|
🔄 **Version Control & Branching Strategy**
|
|
- Git workflow and branching model for game development
|
|
- Branch naming conventions and protection rules
|
|
- Merge strategies and conflict resolution
|
|
- Code versioning and change tracking
|
|
|
|
🔍 **Code Review & Quality Assurance**
|
|
- Pull request process and review guidelines
|
|
- Code quality standards and best practices
|
|
- Automated testing and quality gates
|
|
- Security checks and compliance validation
|
|
|
|
📝 **Code Standards & Conventions**
|
|
- Coding style guidelines and formatting rules
|
|
- Naming conventions for variables, functions, and classes
|
|
- Documentation standards and comment requirements
|
|
- Code organization and structure guidelines
|
|
- Language-specific best practices and patterns
|
|
|
|
🚀 **Continuous Integration / Continuous Deployment (CI/CD)**
|
|
- Automated build and testing pipelines
|
|
- Game build automation for Web, Mobile, and Desktop platforms
|
|
- Deployment processes and environment management
|
|
- Rollback procedures and monitoring
|
|
|
|
---
|
|
|
|
## Expected Benefits
|
|
|
|
### For Development Teams
|
|
- **Faster Onboarding** → New members quickly understand workflows.
|
|
- **Consistent Code Quality** → Standardized reviews improve maintainability.
|
|
- **Reduced Conflicts** → Clear branching prevents merge issues.
|
|
- **Automated Quality Gates** → CI/CD pipelines catch issues early.
|
|
- **Code Consistency** → Shared conventions improve readability.
|
|
- **Faster Development** → Less decision overhead, smoother collaboration.
|
|
|
|
### For Code Delivery
|
|
- **Predictable Releases** → Structured CI/CD ensures reliable deployments.
|
|
- **Reduced Bugs** → Automated tests prevent regressions.
|
|
- **Faster Delivery** → Streamlined pipelines shorten release cycles.
|
|
- **Better Traceability** → Gitflow tracks all code changes.
|
|
- **Maintainable Code** → Consistency simplifies future updates.
|
|
- **Reduced Technical Debt** → Standards discourage poor practices.
|
|
|
|
### For the Organization
|
|
- **Scalability** → Processes work across projects and teams
|
|
- **Code Reusability** → Shared practices support component reuse
|
|
- **Knowledge Retention** → Documented processes preserve expertise
|
|
- **Risk Reduction** → Clear workflows reduce release and operational risks
|
|
|
|
---
|