mirror of
https://gitlab.com/fabinfra/fabaccess/fabaccess-api.git
synced 2025-03-12 23:01:47 +01:00
23 lines
918 B
Markdown
23 lines
918 B
Markdown
# Use Markdown Architectural Decision Records (MADR)
|
||
|
||
## Context and Problem Statement
|
||
|
||
We want to record architectural decisions made in this project.
|
||
Which format and structure should these records follow?
|
||
|
||
## Considered Options
|
||
|
||
* [Markdown Architectural Decisions Record (MADR)](https://adr.github.io/madr/)
|
||
* Gitlab issues
|
||
* Formless – No conventions for file format and structure
|
||
|
||
## Decision Outcome
|
||
|
||
Chosen option: "Markdown Architectural Decisions Record (MADR)", because
|
||
|
||
* Markdown is an easy to write textual format requiring no tooling to be easily human readable
|
||
* Markdown is widely supported and is auto-rendered by all git hosting platforms considered
|
||
* Can be easily stored alongside the actual code and documentation since plain-text files play well with git
|
||
* Is not bound to a single hosting platform like Gitlab issues would be
|
||
* Gives a very sensible default template and format for us to use
|