Day 9

Project Context Documentation

Document your project's architecture so Claude always understands the big picture.

0 / 7 tasks

Why context matters

When Claude knows your project's structure, it writes code that fits — correct import paths, matching naming conventions, and implementations that work with your existing architecture. Without context, you get generic code you have to adapt manually.

Architecture section template

markdown

## Architecture

### Directory Structure
```
app/
  api/          # FastAPI routers (one file per resource)
  models/       # SQLAlchemy ORM models
  schemas/      # Pydantic request/response schemas
  services/     # Business logic (no DB access here)
  repositories/ # Database access layer
  core/         # Config, security, dependencies
  tests/        # pytest, mirrors app/ structure
```

### Key Patterns
- **Repository Pattern**: All DB queries go in `repositories/`
- **Service Layer**: Business logic in `services/`, injected into routes
- **Dependency Injection**: Use FastAPI `Depends()` for all shared resources
- **Async Everything**: All routes, services, and repos use `async/await`

### Authentication
- JWT tokens via `app/core/security.py`
- Current user available via `Depends(get_current_user)`
- Roles: `admin`, `editor`, `viewer`

Practice Tasks

0 / 7

Document directory structure easy

Add a directory map with one-line descriptions for each folder.

Document key patterns medium

Write explanations of 3-5 architectural patterns Claude should always follow.

Document authentication medium

Describe how auth works so Claude adds correct auth checks to new endpoints.

Document environment variables easy

List every env var with a description of what it controls.

Add debugging tips easy

Add a section with common debugging commands and how to run the test suite.

Document external services easy

List every third-party service/API and how your app integrates with it.

Test the context medium

Ask Claude to add a new endpoint. Verify it uses the correct directory, imports the right modules, and follows your patterns — without you explaining.

← Day 8: Writing Effective Instructions ↑ Module overview Day 10: Custom Slash Commands →