Skip to content

Commit 2184237

Browse files
jakereifershiranrTessFerrandez
authored
Add recommendation to store exported images along with code file for preferred diagram tooling (microsoft#856)
* Add simple edits to tooling * nit wording edits Co-authored-by: Shiran Rubin <[email protected]> Co-authored-by: Tess Ferrandez <[email protected]>
1 parent 3005b6c commit 2184237

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/design/design-reviews/recipes/preferred-diagram-tooling.md

+3
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,6 @@ Furthermore, it can be edited within VSCode very easily using the [Draw.io Integ
1010

1111
This tooling can be used like Visio or LucidChart, without the licensing/remote storage concerns.
1212
Furthermore, Diagrams.net has a collection of Azure/Office/Microsoft icons, as well as other well-known tech, so it is not only useful for swimlanes and flow diagrams, but also for architecture diagrams.
13+
14+
Furthermore, we recommend storing the exported PNG images from these diagrams in the repo along with the .drawio files so they can easily be referenced in documentation and more easily reviewed during PRs.
15+
Lastly, while diagrams.net is generally preferred, if any other diagraming tooling is used that can generate diagram images from code, both the diagram file and the image file should be stored together in the repo for the above reasons.

0 commit comments

Comments
 (0)