Architecture Decision Record #helpdev-blog

0_ADR_README.md

Architecture Decision Record

An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant. An Architecturally Significant Requirement (ASR) is a requirement that has a measurable effect on a software system’s architecture and quality. An Architectural Decision Record (ADR) captures a single AD, such as often done when writing personal notes or meeting minutes; the collection of ADRs created and maintained in a project constitute its decision log. All these are within the topic of Architectural Knowledge Management (AKM). - https://adr.github.io/

Know more:

• https://www.youtube.com/watch?v=6H6zfCNeqek
• https://dzone.com/articles/defining-architecture-decision-record

ADR Tools

A command-line tool for working with a log of Architecture Decision Records (ADRs).

Install

Clone this repository in your machine:

cd /home/{yourUser}
git clone git@github.com:npryce/adr-tools.git

Add the src folder in your $PATH

Sample with bash:

cat ~/.bashrc

## add in last line:
export PATH=$PATH:/home/{yourUser}/adr-tools/src

Sample with fish:

cat ~/.config/fish/config.fish

set -x PATH $PATH /home/{yourUser}/adr-tools/src

Using

Already in your project folder:

Creating a structure folder (in this project its already created)

adr init doc/adr

Create an ADR

adr new {title}

It's done! Now, just edit the created file.

1_ADR_file:0001-teste.md

1. teste

Date: 2022-06-10

Status

Accepted

Context

The issue motivating this decision, and any context that influences or constrains the decision.

Decision

The change that we're proposing or have agreed to implement.

Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.