-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
create ADR for Architectural Diagram tool (#43)
create ADR for Architectural Diagram tool
- Loading branch information
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,6 @@ venv | |
.venv | ||
build | ||
site | ||
|
||
.idea/ | ||
.cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: 0008 Architectural Diagram Tooling | ||
adr: | ||
author: Laurens Weijs | ||
created: 04-Mar-2024 | ||
status: accepted | ||
--- | ||
|
||
## Context | ||
|
||
To communicate our designs in a graphical manner, it is of importance to draw architectural diagrams. For this we use | ||
tooling, that supports us in our work. We need to have something that is written so that it can be processed | ||
by both people and machine, and we want to have version control on our diagrams. | ||
|
||
## Decision | ||
|
||
We will write our architectural diagrams in Markdown-like (.mmmd) in the [Mermaid Syntax](https://mermaid.js.org/intro/syntax-reference.html) | ||
to edit these diagrams one can use the various [plugins](https://mermaid.js.org/ecosystem/integrations-community.html). | ||
For each project where it is needed, we will add the diagrams in the repository of the subject. The level of detail we | ||
will provide in the diagrams is according to the [C4-model](http://mermaid.js.org/syntax/c4.html) metamodel on | ||
architecture diagramming. | ||
|
||
## Consequences | ||
|
||
**Standardized Workflow**: By maintaining architecture as code, it will be standardized in our workflow. | ||
|
||
**Version control on diagrams**: By using version control, we will be able to collaborate easier on the diagrams, and we | ||
will be able to see the history of them. | ||
|
||
**Diagrams are in .md format**: By storing our diagrams next to our code, it will be where you need it the most. |