Documentation IT architecture

[heidivanparys]

It would be good if the IT architecture of the system could be documented in the manual. I made the following attempt, using the C4 model approach.

Any feedback on these diagrams would be very welcome, perhaps I understood certain parts in the wrong way.

[emanuelaepure10]

Dear @heidivanparys

This is so great what you have done here. Congratulations!

And a big Thank you

[oscar9]

Dear @heidivanparys

Many thanks for take your time to create these diagrams. We are going to include them in the documentation that we are updating. Do you still have the code that create these C4 models? In that case, could you share them with us? The diagrams in the roadmap are going to use the mermaid library to be drawn in GitHub. I’ve checked and found that they are also working in the support for C4 models. It would be great if we have the C4 diagram code so we can transform them in mermaid code. In the future, if this support become available, it will be easy to update the diagrams in case of change.

Thanks in advance

Best regards

[heidivanparys]

I used a custom-developed MDG for Sparx Enterprise Architect to create those diagrams.

What you need to see those diagrams in Enterprise Architect, provided that you have that tool:

• C4 MDG.txt: change extension to XML and import as MDG technology in EA
• make sure that both the C4 Model and Custom Diagram Style MDGs are enabled, see also screenshot below
• image assets.txt: change extension to XMI and import the package (contains some icons)
• it architecture re3gistry XMI.txt: change extension to XMI and import the package (contains the actual model)

I exported the descriptions of the different model elements to a CSV file, in case the EA model cannot be used, see re3gistry_descriptions.csv (but you'll still have to add the relations in your tool of choice).

[oscar9]

All the diagrams have been included in the developer documentation, soon they will be part of the master branch. Thanks for your collaboration.