Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 2.83 KB

template.md

File metadata and controls

95 lines (60 loc) · 2.83 KB
Raw

NUMBER. TITLE

Date: DATE Status: status

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

  • [driver 1, e.g., a force, facing concern, …]
  • [driver 2, e.g., a force, facing concern, …]
  • …

Considered Options

  • [option 1]
  • [option 2]
  • [option 3]
  • …

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

  • [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 1]

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

  • Good, because [argument a]
  • Good, because [argument b]
  • Bad, because [argument c]
  • …

[option 2]

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

  • Good, because [argument a]
  • Good, because [argument b]
  • Bad, because [argument c]
  • …

[option 3]

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

  • Good, because [argument a]
  • Good, because [argument b]
  • Bad, because [argument c]
  • …

Code Examples

[If relevant / it would help the discussion, please provide code examples here that would help in comparing the various options on the table.

A few possible options for doing this:

  • A link to a gist or proof of concept repository
  • A separate code block using github code fencing
  • If necessary, you can add a new folder within the docs/decisions directory titled 000X-decision-name-files and add necessary code files there. Ideally use the same mechanism for storing all files related to a decision - the below examples are meant to show the full set of different options ]

Option 1 Code Example 

console.log('Hello, World!');

Option 2 Code Example

Link to gist

Option 3 Code Example

local link to file

Links

  • [Link type](link to adr)
  • …