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
Jared Corduan
committed
Dec 2, 2022
1 parent
50addb0
commit 289e1a3
Showing
2 changed files
with
35 additions
and
1 deletion.
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
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,30 @@ | ||
--- | ||
slug: 1 | ||
title: | | ||
1. Record Architecture Decisions | ||
authors: [] | ||
tags: [Accepted] | ||
--- | ||
|
||
## Status | ||
|
||
Accepted | ||
|
||
## Context | ||
|
||
We are in search for a means to describe our technical architecture. | ||
|
||
We prefer light-weight documentation methods which accomodate change easily. | ||
|
||
The [Hydra team](https://github.com/input-output-hk/hydra) | ||
has had success with the solution described below. | ||
See the [Hydra ADR 1](https://github.com/input-output-hk/hydra/blob/master/docs/adr/2021-06-05_001-record-architectural-decisions.md). | ||
|
||
## Decision | ||
|
||
* We will use _Architecture Decision Records_, as described by Michael Nygard in this [article](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). | ||
* We will follow the convention of storing those ADRs as Markdown formatted documents stored under `docs/adr` directory, as exemplified in Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools). This does not imply we will be using `adr-tools` itself. | ||
|
||
## Consequences | ||
|
||
See Michael Nygard's article, linked above. |