yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-08-30 11:26:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add ADR template for transparent architecture decisions (#2072)

Browse Source 
* add adr template for decisions

* Add latest docstring and tutorial changes

* Add latest docstring and tutorial changes

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sara Zan <sara.zanzottera@deepset.ai>
This commit is contained in:
Malte Pietsch 2022-01-28 17:33:53 +01:00 committed by GitHub
parent 7764b6992c
commit ee6b8d0688
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/decisions/adr-template.md Normal file
View File

@ -0,0 +1,74 @@
# {short title of solved problem and solution}
* Status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)} <!-- optional -->
* Deciders: {list everyone involved in the decision} <!-- optional -->
* Date: {YYYY-MM-DD when the decision was last updated} <!-- optional -->
Technical Story: {description | ticket/issue URL} <!-- optional -->
## Context and Problem Statement
{Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.}
## Decision Drivers <!-- optional -->
* {driver 1, e.g., a force, facing concern, …}
* {driver 2, e.g., a force, facing concern, …}
* … <!-- numbers of drivers can vary -->
## Considered Options
* {option 1}
* {option 2}
* {option 3}
* … <!-- numbers of options can vary -->
## Decision Outcome
Chosen option: "{option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
### Positive Consequences <!-- optional -->
* {e.g., improvement of quality attribute satisfaction, follow-up decisions required, …}
* …
### Negative Consequences <!-- optional -->
* {e.g., compromising quality attribute, follow-up decisions required, …}
* …
## Pros and Cons of the Options <!-- optional -->
### {option 1}
{example | description | pointer to more information | …} <!-- optional -->
* Good, because {argument a}
* Good, because {argument b}
* Bad, because {argument c}
* … <!-- numbers of pros and cons can vary -->
### {option 2}
{example | description | pointer to more information | …} <!-- optional -->
* Good, because {argument a}
* Good, because {argument b}
* Bad, because {argument c}
* … <!-- numbers of pros and cons can vary -->
### {option 3}
{example | description | pointer to more information | …} <!-- optional -->
* Good, because {argument a}
* Good, because {argument b}
* Bad, because {argument c}
* … <!-- numbers of pros and cons can vary -->
## Links <!-- optional -->
* {Link type} {Link to ADR} <!-- example: Refined by [ADR-0005](0005-example.md) -->
* … <!-- numbers of links can vary -->
<!-- markdownlint-disable-file MD013 -->