MODULE_NAME
One-sentence description of what this module does.
Overview
Describe the module's purpose, the business problem it solves, and its scope within the platform. Keep it to 2-3 paragraphs maximum.
Key Concepts
| Concept | Description |
|---|---|
| Term 1 | What it means in this module's context |
| Term 2 | What it means in this module's context |
Data Flow
Describe or diagram how data moves through the system for this module's main use case.
Database
Tables
| Table | Purpose |
|---|---|
table_name | What this table stores |
Key Relationships
Describe the main relationships between tables relevant to this module.
Key Decisions
Document the important design decisions and trade-offs made during development. This is the most valuable section — explain the "why", not just the "what".
| Decision | Reasoning | Alternatives Considered |
|---|---|---|
| What was decided | Why this approach was chosen | What else was considered |
Dependencies
- Internal: Other modules this depends on
- External: Third-party services or libraries specific to this module
Related Documentation
- User Guide:
/guide/modules/MODULE_NAME— End-user instructions - API Endpoints:
./api— Endpoint reference for this module - UI Screens:
./ui— Frontend screens and flows