Copy this template into a new project folder and replace bracketed placeholders with project-specific details. Keep the section structure so all references stay consistent across teams.
Add one-line statement for the project objective and expected outcome.
List primary user groups for this project.
Summarize 2-3 key capabilities this project delivers.
Document the main design principle guiding implementation decisions.
Describe the main entity and what data it represents.
Describe secondary entity and ownership boundaries.
Explain lifecycle records and state changes.
Document event, queue, or sync unit if applicable.
Define access levels and permission-sensitive operations.
| Repo | Responsibility | Key Focus | Run Command |
|---|---|---|---|
| backend | API and core business logic | Replace with project-specific responsibilities | [backend run command] |
| frontend | Web interface and operations workflows | Replace with project-specific responsibilities | [frontend run command] |
| mobile | Mobile companion and field operations | Replace with project-specific responsibilities | [mobile run command] |
| pages | Project references and documentation | Shared team docs, project overview, links and guidance | Static hosting |
Describe the first operational step for this project workflow.
Describe the validation or processing step.
Describe persistence, handoff, or integration behavior.
Describe visibility, notifications, and follow-up actions.
Capture the most important data integrity rule for this project.
Document offline or retry behavior and idempotency expectations.
List authentication and authorization requirements.
List logs, health checks, and monitoring standards.