11 September 2020

ADR (Architectural Decision Records)

The content of the ADR can have the following sections:

  1. Title - Title of the decision record.
  2. Decision - The decision that was made. For instance, use Elasticsearch for an enterprise-wide search API.
  3. Status - Status can be proposed, accepted or superseded. If you make any decisions and you need to change them later, you can simply add a new record with the changed status.
  4. Context - What is the context of this decision? It is important to capture the full context of the decision so that the reader knows the reasons behind it.
  5. Consequences - In this section, you can add what would happen if this decision is made. It is important to list all consequences, both positive and negative.

https://github.com/joelparkerhenderson/architecture_decision_record 

https://github.com/npryce/adr-tools

 UPDATE: 2 years later we see the same in AWS: https://www.infoq.com/news/2022/06/aws-adr-guide/

No comments :

My Blog List

Blog Archive

Disclaimer

The views expressed on this blog are my own and do not necessarily reflect the views of Oracle.