One part is to update documentation if the code itself is updated. This post will not go into the details of each of those diagram types because the PlantUML website does a pretty good job at describing sequence, component, activity and the other diagram types.Ī basic component diagram showing data flow can be built using the following markup: componentĪpp -> to love PlantUML 🤗 Versioning 📦Ī very important aspect for developing software and writing documentation is to keep it in sync. There are different diagram types available being described with custom syntax but following a common scheme. PlantUML Basics 👨🎨įor those that do not know PlantUML: It is an open source tool that allows you to define UML diagrams with plain text. Using it in different places and for various purposes I came across a bunch of issues that I want to share in this post. You can see it being used in my plantbuddy and techradar projects on GitHub.
Lately I have been using PlantUML extensively at work but also in my private projects.
I have been wanting to write this post for months.
This post covers PlantUML basics and how it can be used in GitLab or GitHub projects as well as a seamless local development environment using Visual Studio Code.
0 kommentar(er)
