generated from Lerking/python-repo-template
36 lines
853 B
Markdown
36 lines
853 B
Markdown
# Architecture
|
|
|
|
> Keep this page in sync with the "Architecture & Design" section of the project
|
|
> specification. The specification captures the *decision*; this page captures the
|
|
> *current, evolving state* of the system for people working in the codebase day to day.
|
|
|
|
## Overview
|
|
|
|
One paragraph: what the major pieces are and how they fit together. Include or link a
|
|
diagram.
|
|
|
|
## Components
|
|
|
|
| Component | Responsibility | Depends on |
|
|
|---|---|---|
|
|
| | | |
|
|
|
|
## Data flow
|
|
|
|
Describe how data moves through the system, from input to output.
|
|
|
|
## External dependencies
|
|
|
|
| Dependency | Purpose | Notes |
|
|
|---|---|---|
|
|
| | | |
|
|
|
|
## Key design decisions
|
|
|
|
A short log of significant decisions and the reasoning behind them (an ADR-style list is
|
|
fine here if you don't have a separate `docs/adr/` folder).
|
|
|
|
| Decision | Date | Reasoning |
|
|
|---|---|---|
|
|
| | | |
|