Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Architecture diagrams in C4 plantuml based files #60

Merged
merged 8 commits into from
Jul 29, 2021
Merged

Conversation

exu
Copy link
Member

@exu exu commented Jul 26, 2021

Hi @olensmar let's discuss such form of archietcture diagrams after your return from vacation:
I've used https://c4model.com/ here (was using when doing architecture stuff in Kinguin)

To sum up some pros and cons how I see them:

Pros:

  • everything is code - refactoring is easy, you can use your editor to edit everything
  • you can automate generation of diagrams
  • you don't need to be artist to make nice diagrams - only code
  • 4 levels of details (like real map from top level view to small parts) - I've omit code diagrams as it should be autogenerated.
  • live preview in VSCode when writing stuff
  • speed (a lot faster to do things after some training)
  • a lot of diagram types
  • can be scripted / automated easily
  • it's text :D

Cons:

  • maybe autogeneration of diagram has less control over elements position

@exu exu requested a review from olensmar July 26, 2021 10:35
@exu exu self-assigned this Jul 26, 2021
@olensmar
Copy link
Member

@exu did you add "service under test" components? (i couldn't find them in the diagrams...)

@exu
Copy link
Member Author

exu commented Jul 29, 2021

Yes in added SUT commit should be present

@olensmar
Copy link
Member

ok - perhaps you need to regenerate the diagrams - i can't find SUT in any of them!?

@exu
Copy link
Member Author

exu commented Jul 29, 2021 via email

@exu exu merged commit eb0c289 into main Jul 29, 2021
@exu exu deleted the jacek/feature/c4 branch July 29, 2021 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants