Dev Codebase Onboarding Walkthrough
===================================

Create a codebase walkthrough guide for [project name] to help new developers understand the architecture.

Project details:
- Project: [name and purpose]
- Language: [primary language]
- Framework: [framework]
- Architecture pattern: [MVC/microservices/layered/hexagonal]
- Team: [size]

CODEBASE WALKTHROUGH

1. PROJECT OVERVIEW
   - What it does: [plain English description]
   - Who uses it: [users]
   - How it fits in the system: [context diagram]
   - Key business concepts: [domain glossary]

2. DIRECTORY STRUCTURE
   ```
   /project-root
   ├── /src
   │   ├── /controllers    # Request handlers
   │   ├── /services       # Business logic
   │   ├── /models         # Data models
   │   ├── /repositories   # Database access
   │   ├── /middleware     # Request processing
   │   └── /utils          # Shared utilities
   ├── /tests
   ├── /docs
   ├── /scripts
   ├── .env.example
   └── README.md
   ```

   KEY DIRECTORIES EXPLAINED
   - [/src/controllers]: [what goes here and why]
   - [/src/services]: [business logic layer]
   - [/src/models]: [data models/entities]

3. DATA FLOW
   Trace a typical request:

   1. HTTP request arrives at [entry point]
   2. [Middleware] processes: [auth/logging/parsing]
   3. [Router] directs to [Controller]
   4. [Controller] validates input
   5. [Service] executes business logic
   6. [Repository] queries database
   7. Response returned through layers

4. KEY CONCEPTS IN THIS CODEBASE

   [CONCEPT 1]
   - What it is: [explanation]
   - Where to find it: [file paths]
   - Example: [code snippet or reference]

   [CONCEPT 2]
   [Same format]

5. COMMON TASKS

   ADD A NEW API ENDPOINT
   1. Create route in [file]
   2. Create controller in [location]
   3. Create service method in [location]
   4. Add repository method if DB access needed
   5. Write tests in [location]
   6. Update API documentation

   ADD A DATABASE TABLE
   1. Create migration in [location]
   2. Create model in [location]
   3. Create repository in [location]
   4. Run: [migration command]

6. GOTCHAS AND TRIBAL KNOWLEDGE
   - [Gotcha 1]: [what to watch out for]
   - [Gotcha 2]: [non-obvious behavior]
   - [Pattern used]: [why we do it this way]

7. WHERE TO GET HELP
   - Slack: [#channel]
   - Documentation: [link]
   - Best person to ask for [topic]: [name]

Source: https://promptzyo.com/prompt/dev-codebase-onboarding-walkthrough