Skip to content

Intro

ADR-0000000: Template

  • Type:
  • Status:
  • Dependency:
  • Derived from:
  • Decision for:

Context and Problem Statement

What triggered this ADR?

  • Why do we talk about this?
  • What is blocked if we do not decide?
  • How does the backlog relate to this ADR?

Who is affected

Which teams, services, layers, ... are affected?

Considered scenarios

Describe all scenarios relevant. In-scope and out-of-scope

Out of scope

Is there anything out of scope? Why?

Problem Statement

Describe the question we need to answer? What do we need to decide?

Decision Outcome

Decision title/summary

Brief description of the decision taken including: - What was decided - What does the decision mean for stakeholders

Action Items

  • CloudApp: Link to Backlog item including a brief description
  • Service: Link to Backlog item including a brief description
  • System architecture: Link to Backlog item including a brief description

Decision Drivers

Quality attributes and stakeholders are taken from the "Quality Tree" document provided by system test. Only a subset is listed below. Add additional as required e.g. from the ilities list https://en.wikipedia.org/wiki/List_of_system_quality_attributes

For the decision outcome, please mark the options in the header row, for which is decided for / not decided for:

  • decided for: unicode char ✅ visualizes as ✅
  • not decided for: unicode char ❌ visualizes as ❌
Quality Attribute Stakeholder Context Decision Driver AS-IS ❌ O1: Name ✅ O2: Name
Availability Who? Where? What? (only brief description) - / O / + - / O / + - / O / +
Compatibility
Complexity
Configurability
Cost
Evolvability
Fault tolerance
Freedom from Risk
Functional suitability
Maintainability
Operability
Portability
Recoverability
Reliability
Reusability
Robustness
Scalability
Security
Testability
Throughput
Usability

Rational QualityA

Describe what you mean with the quality attributes, stakeholders, context. Give ideal and worst examples to convey a feeling of what it means. Description: What is it about. Ideal: What would be ideal? Examples. Worst: What is worst? Examples

Rational QualityB

Describe what you mean with the quality attributes, stakeholders, context. Give ideal and worst examples to convey a feeling of what it means. Description: What is it about. Ideal: What would be ideal? Examples. Worst: What is worst? Examples

Pros and Cons of the Options

AS-IS

What is today's as-is situation? Describe situation today

Option 1: Name

Description of option with its details Based on the quality attributes, evaluate the option and add rating.

Quality Attribute Rating Evaluation
Complexity 0 Many tables to maintain is cumbersome. But it helps to structure the thoughts and presentation.

Option 2: Name

...

MKDOCs Markdown