template-project/docs/ARCH.md

ARCH - [project name]

Architectural decisions and their reasoning. What components are used, how will they communicate, what libraries are chosen...

Overview

Short description of what we are building and its structure. 3-5 sentences.

Tech stack

Brief description of technologies to be used.

Example:

• Pyton 3.11+, Async support required
• Pytest 8.x, Testing

Commands

• Lint: "ruff check src/"
• Test: "pytest tests/ -x --tb=short"

File structure

Example: src/ main.py config.py

tests/ test_main.py

architectural decisions.

One section per non-obvious decision. What we choose, what we rejected, why.

Example:

Polling vs events

• Decision: Polling every 10s
• Options: Using interrupts
• Why?: More simple to implement.