this post was submitted on 30 Apr 2024
15 points (85.7% liked)
Programming
17670 readers
319 users here now
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities [email protected]
founded 2 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Diagrams. Loads and loads of diagrams. One for each use-case.
Then I'd have one diagram to draw out dependencies between each service at the broadest level. Although depending on how messy your architecture is it can be very difficult to read, in my experience.
You do this all manually?
Anti Commercial-AI license
More or less. Either Excalidraw for your quick and dirty diagrams or I've used PlantUML + C4 Plug-in for your larger, more long lived diagrams with some success.
I just gave PlantUML + the C4 Plugin a try and generally liked it, thank you for the rec!
It seems like a good tool although it inherits all the joys and pains of automatic graph layout.
I think I’ll keep it in my arsenal for detailed diagrams that can handle being a little aesthetically wonky.
I hadn’t heard of C4 before and it seems like a solid idea.
I manually redraw my service architecture because I can create higher quality documentation than when trying to auto-generate it.
But you can get a baseline depending on which Cloud you use. For example, in AWS you can use workload discovery - that generates a system overview.
Yes, for example, if your build server exposes the API with an OpenAPI scheme, you can use the build server to generate a client library like a nuget or npn.
Then in the API consumer you can add a build step that checks if there are new version of the client library. Or setup dependabot that creates PRs to update those dependencies