Skip to content

Files

Latest commit

 

History

History
19 lines (11 loc) · 1 KB

index.md

File metadata and controls

19 lines (11 loc) · 1 KB

ODRA Architecture Decision Records

Architecture Decision Records

Show Table Of Content

To manage application architecture decisions we use adr-tools.

  1. To instal on macOS run brew install adr-tools. Check here for other OS.

  2. To create new record run i.e: adr new Add History Tab. This will create a new, numbered ADR file in doc/adr/ directory

  3. Open created file, describe record context, decision that was made and possible consequeces.

  4. Run adr generate toc > doc/adr/toc.md to create/update Table of Content

  5. 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.