To manage application architecture decisions we use adr-tools.
-
To instal on macOS run
brew install adr-tools
. Check here for other OS. -
To create new record run i.e:
adr new Add History Tab
. This will create a new, numbered ADR file indoc/adr/
directory -
Open created file, describe record context, decision that was made and possible consequeces.
-
Run
adr generate toc > doc/adr/toc.md
to create/update Table of Content -
Run
adr generate graph | dot -Tjpg > doc/adr/graph.jpg
to create graph.jpg image of decision records You might need to install Graphviz - Graph Visualization Software to generate image.