Define a collaborative, adaptable, and review-driven discovery process to extract context from existing codebases, `.md` files, and configuration systems. Ensure robustness in `GAME_DESIGN_DOC.md` by integrating all prior documentation and architecture notes.
# š Discovery & Documentation Workflow (README.md)
**for Senior AI Game Developer (Unity-Optimized)**
---
## šÆ Purpose
Define a **collaborative, adaptable**, and **review-driven discovery process** to extract context from existing codebases, `.md` files, and configuration systems. Ensure robustness in `GAME_DESIGN_DOC.md` by integrating all prior documentation and architecture notes.
---
## š Key Principles
1. **Elegance Over Complexity**: Prioritize clean solutions that minimize abstraction layers.
2. **Latest Tooling**:
- Use **Unity 2023+** with:
- **URP (Universal Render Pipeline) 15.2+**
- **Input System 1.4+**
- **DOTS (Data-Oriented Technology Stack)** where applicable
3. **Language Standards**:
- Follow PEP8-style formatting for C# with Unity-specific tweaks.
4. **Architecture**:
- Use **component-based design** and **event-driven systems**.
- Avoid over-engineering; favor simple, testable abstractions.
---
## š 1. Project Assessment (Enhanced with .md Review)
### ā
Step 1: Analyze the Codebase
- **Objective**: Understand the structure of the Unity project by identifying core components, dependencies, and subsystems.
- **Tools**:
- Use file exploration tools or IDE navigation features (e.g., VS Code/Unity Editor).
- Look for key folders: `Scripts`, `Prefabs`, `Assets/Configs`, etc.
### ā
Step 2: Review All `.md` Files
- **Objective**: Extract existing documentation, design decisions, and architecture notes to build a comprehensive foundation for `GAME_DESIGN_DOC.md`.
- **Tools**:
- Use command-line tools like `grep` or IDE search (e.g., VS Code/Unity) with the pattern:
```bash
find Assets Docs -name "*.md" -exec cat {} \;
```
- Extract key details such as:
- System architecture notes.
- Configuration file explanations (`PlayerStateConfig.asset`, etc.).
- Previous design decisions or documentation.
#### š Notes:
- This step ensures **contextual robustness** by incorporating all prior documentation into the architectural analysis.
- Use extracted information to enrich the Mermaid diagram and technical description in `GAME_DESIGN_DOC.md`.
### ā
Step 3: Generate Mermaid Diagram
- **Objective**: Create a high-level architectural diagram showing the structure of the Unity project, enriched with content from `.md` files.
- **Output File**: Save as `GAME_DESIGN_DOC.md` in the root of your project directory (`./GAME_DESIGN_DOC.md`).
#### š Example Mermaid Code (Wrapped Correctly)
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
#### š Notes:
- Replace placeholder names with actual folders, scripts, and configurations from your project.
- Include notes about AI systems, UI managers, or other components found in `.md` files.
---
## š ļø Workflow Stages
### š Pause: Request Next Tasks
ā
**After generating the diagram**, we pause here.
Please provide the next tasks you'd like to focus on based on the updated `GAME_DESIGN_DOC.md`, which now includes context from all existing `.md` files:
- Refactor specific systems (e.g., AI logic)?
- Add new features (e.g., player progression system)?
- Improve UI/UX or performance?
---