Architecture Decision Records (ADRs)
This directory contains Architecture Decision Records (ADRs) for significant architectural decisions in the Dossier project.
What is an ADR?
An Architecture Decision Record captures an important architectural decision made along with its context and consequences.
ADR Format
Each ADR follows this structure:
# ADR-NNNN: Title
## Status
[Proposed | Accepted | Deprecated | Superseded by ADR-XXXX]
## Context
What is the issue that we're seeing that is motivating this decision or change?
## Decision
What is the change that we're proposing and/or doing?
## Consequences
What becomes easier or more difficult to do because of this change?Creating a New ADR
- Copy the template:
cp ../../../rfcs/0000-template.md NNNN-your-decision.md - Use the next available number (NNNN)
- Write a descriptive title (use kebab-case)
- Fill in all sections
- Submit as part of your PR
Index of ADRs
No ADRs yet - this is a new addition to the project structure.
Examples of Good ADR Topics
- Choice of programming language or framework
- Database selection
- Authentication/authorization approach
- API design patterns
- Build and deployment strategies
- Cryptographic algorithms and key management
Resources
Rendered from docs/architecture/adr/README.md in the repository. Edit it there.