initial commit
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
# Architecture: [Project Name]
|
||||
|
||||
## Problem and context
|
||||
What problem this solves and for whom.
|
||||
|
||||
## Goals and non-goals
|
||||
Numbered goals with measurable criteria. Explicit non-goals.
|
||||
|
||||
## Repository structure
|
||||
Directory layout with one-line descriptions.
|
||||
|
||||
## System overview
|
||||
One paragraph, then a Mermaid component diagram showing major components,
|
||||
responsibilities, and communication paths.
|
||||
|
||||
## Technology stack
|
||||
| Component | Technology | Version | Rationale |
|
||||
|
||||
## Module boundaries
|
||||
For each module: what it owns, its public interface, and what it must NOT do.
|
||||
Communication patterns between modules (sync/async, events, RPC).
|
||||
|
||||
## Key architectural decisions
|
||||
For each important decision:
|
||||
- **Decision:** what was chosen
|
||||
- **Alternatives considered:** what else was evaluated
|
||||
- **Rationale:** why this option
|
||||
|
||||
## Constraints and conventions
|
||||
Tech stack rules, naming conventions, forbidden libraries, project-wide patterns.
|
||||
|
||||
## Open questions
|
||||
Only unresolved items that must be decided later.
|
||||
Reference in New Issue
Block a user