Architecture Decision Records¶
This directory contains Architecture Decision Records (ADRs) - documents that capture important architectural decisions made during the development of paper-scanner.
What is an ADR?¶
An ADR is a short text file in a specific format that captures: - Status: The decision state (Proposed, Accepted, Deprecated, Superseded) - Context: The issue or problem we're addressing - Decision: What we decided to do - Consequences: The results and implications of this decision - Alternatives: Other options we considered
Creating New ADRs¶
When proposing a significant architectural decision:
- Copy
0000-template.mdto a new file with the next sequence number - Fill in the template sections
- Submit as part of code review
- Once accepted, update status from "Proposed" to "Accepted"
ADR Naming Convention¶
Files are named: NNNN-short-description.md
Where:
- NNNN is the sequence number (0001, 0002, etc.)
- short-description is a hyphenated brief description
Current ADRs¶
Records are listed below in reverse chronological order:
| # | Title | Status | Date |
|---|---|---|---|
| 0001 | Pipeline Architecture with Three-Level Config | Accepted | 2025-01-01 |