feat: hold structurizr

[edubacco]

It's a long time we do not update them.

Even the last ArCo group used a different tool to document their vision of the desired architecture (see https://github.com/casavo/community-of-practice/tree/master/software-architecture/diagrams)

If we don't use it, let's hold it.

[pikachuCa]

we are using https://diagrams.mingrammer.com/docs/getting-started/installation on our side.

Maybe we could keep just one ?

[xpepper]

It's a long time we do not update them.

Even the last ArCo group used a different tool to document their vision of the desired architecture (see https://github.com/casavo/community-of-practice/tree/master/software-architecture/diagrams)

If we don't use it, let's hold it.

I agree to put in on "Hold".
We could also add that we're holding this because... ? E.g. it's a PITA to keep updated? It's not so easy to view (and hurts the browser resources...)

[xpepper]

we are using https://diagrams.mingrammer.com/docs/getting-started/installation on our side.

Maybe we could keep just one ?

Is an alternative to Structuriz? What are its main benefits?

[pferretti]

@edubacco if this is the repo for our architectural diagrams, I agree that we are not using Structurizr (the last commit on master is more or less 7 month ago). So for me it's ok to put this on hold.

I think Excalidraw is a very good tool, very straightforward for drawing diagrams. However, I think it can only be a temporary substitute, because although the Excalidraw files are plain-text and therefore versionable, the sources are not suitable to be edited by a human.

We can evaluate the tool we use in Paris Squad, proposed by @pikachuCa.

In my opinion, a tool for drawing architectural diagrams must:

• be immediate in use, at least for a software engineer
• offer plain-text output, thus easily versionable
• offer output that is easily editable by a human being
• offer output that is automatically generated by the sources, that is comprehensible (and possibly pleasant to read)

Basically, friction in the use of the tool must be minimal, so that teams are incentivised to keep architectural diagrams up-to-date. In addition, the fact that the diagram is generated from the sources minimises the cognitive load for those who design/update the diagram, as they have to deal with the content, not the form.

What do you think @edubacco @pikachuCa @xpepper @dottiOliviero @YoannDelpierre @moebiusmania @enricobenetti ?

[dottiOliviero]

if i try to open one i get

I think it works locally. We can put it on Hold and specify that we need to find a substitute, with the characteristics that @pferretti listed above.

[xpepper]

I agree to put this on HOLD.

[xpepper]

@edubacco if this is the repo for our architectural diagrams, I agree that we are not using Structurizr (the last commit on master is more or less 7 month ago). So for me it's ok to put this on hold.

I think Excalidraw is a very good tool, very straightforward for drawing diagrams. However, I think it can only be a temporary substitute, because although the Excalidraw files are plain-text and therefore versionable, the sources are not suitable to be edited by a human.

We can evaluate the tool we use in Paris Squad, proposed by @pikachuCa.

In my opinion, a tool for drawing architectural diagrams must:

• be immediate in use, at least for a software engineer
• offer plain-text output, thus easily versionable
• offer output that is easily editable by a human being
• offer output that is automatically generated by the sources, that is comprehensible (and possibly pleasant to read)

Basically, friction in the use of the tool must be minimal, so that teams are incentivised to keep architectural diagrams up-to-date. In addition, the fact that the diagram is generated from the sources minimises the cognitive load for those who design/update the diagram, as they have to deal with the content, not the form.

What do you think @edubacco @pikachuCa @xpepper @dottiOliviero @YoannDelpierre @moebiusmania @enricobenetti ?

About the alternatives to Structurizr, I would also propose Mermaid (https://mermaid.js.org), which supports C4 (https://mermaid.js.org/syntax/c4.html#c4-diagrams) and keeps being updated with new formats...

Having said this, if we already tested https://diagrams.mingrammer.com and we're having good feedbacks, it's ok to use it... we could put "Diagrams" in "Trial" (in another PR?) maybe @edubacco @pikachuCa ?

[edubacco]

@edubacco if this is the repo for our architectural diagrams, I agree that we are not using Structurizr (the last commit on master is more or less 7 month ago). So for me it's ok to put this on hold.

I think Excalidraw is a very good tool, very straightforward for drawing diagrams. However, I think it can only be a temporary substitute, because although the Excalidraw files are plain-text and therefore versionable, the sources are not suitable to be edited by a human.

We can evaluate the tool we use in Paris Squad, proposed by @pikachuCa.

In my opinion, a tool for drawing architectural diagrams must:

• be immediate in use, at least for a software engineer
• offer plain-text output, thus easily versionable
• offer output that is easily editable by a human being
• offer output that is automatically generated by the sources, that is comprehensible (and possibly pleasant to read)

Basically, friction in the use of the tool must be minimal, so that teams are incentivised to keep architectural diagrams up-to-date. In addition, the fact that the diagram is generated from the sources minimises the cognitive load for those who design/update the diagram, as they have to deal with the content, not the form.

What do you think @edubacco @pikachuCa @xpepper @dottiOliviero @YoannDelpierre @moebiusmania @enricobenetti ?

I totally agree.

I do not have experience with mermaid, nor with mingrammer. But if we have minegrammer already up and running, we should add it to the radar and try it also on casavo side.