-
Notifications
You must be signed in to change notification settings - Fork 524
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0932788
commit dbaacfe
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Architecture Decision Records | ||
|
||
We will maintain Architecture Decision Records (ADRs) in our FHIR Server repository, placing each one under `doc/arch/adr-<000>-<short-title>.md`. We have chosen to write these records using Markdown. | ||
|
||
Each ADR will be assigned a unique, sequential number that will never be reused. If a decision is later reversed, changed or evolved, the original record will remain in place but will be marked as superseded. Even though it’s no longer valid, it is still historically important. | ||
|
||
We will keep the ADR structure simple, with just a few sections in this example template: | ||
|
||
``` | ||
# Title | ||
Each ADR should have a short, descriptive phrase, such as “ADR 001: Database Schema Changes for Version 1.5.0” or “ADR 009: Introducing Polly for Retry Logic”. | ||
## Context | ||
Summarize the relevant factors (technological, organizational, or other) that influence this decision. Present these factors neutrally, highlighting any tensions or constraints that shaped the solution. | ||
## Decision | ||
Clearly state the chosen approach or solution in active voice (for example, “We will…”). Describe the rationale and what will be implemented as a result. | ||
## Status | ||
Indicate whether this decision is proposed, accepted, deprecated, or superseded (with a reference to the new ADR if applicable). | ||
## Consequences | ||
Outline the outcomes of applying this decision. Include all effects—beneficial, adverse, or neutral—since these will affect the project over time. | ||
``` | ||
|
||
This is inspired by [documenting architecture decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions). |