syncstorage-rs/docs/adr/template.md

[short title of solved problem and solution]

• Status: [proposed | rejected | accepted | deprecated | … | superseded by ADR-0005]
• Deciders: [list everyone involved in the decision]
• Date: [YYYY-MM-DD when the decision was last updated]

Technical Story: [description | ticket/issue URL]

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

1. [primary driver, e.g., a force, facing concern, …]
2. [secondary driver, e.g., a force, facing concern, …]
3. …

Considered Options

• A. [option A]
• B. [option B]
• C. [option C]
• D. …

Decision Outcome

Chosen option:

• A. "[option A]"

[justification. e.g., only option, which meets primary decision driver | which resolves a force or facing concern | … | comes out best (see below)].

Positive Consequences

• [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
• …

Negative Consequences

• [e.g., compromising quality attribute, follow-up decisions required, …]
• …

Pros and Cons of the Options

[option A]

[example | description | pointer to more information | …]

Pros

• [argument for]
• [argument for]
• …

Cons

• [argument against]
• …

[option B]

[example | description | pointer to more information | …]

Pros

• [argument for]
• [argument for]
• …

Cons

• [argument against]
• …

[option C]

[example | description | pointer to more information | …]

Pros

• [argument for]
• [argument for]
• …

Cons

• [argument against]
• …

Links

• [Link type] [Link to ADR]
• …