C4-PlantUML
java
Our great sponsors
C4-PlantUML | java | |
---|---|---|
23 | 34 | |
5,994 | 947 | |
1.8% | 1.1% | |
7.1 | 8.9 | |
21 days ago | 17 days ago | |
PlantUML | Java | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
C4-PlantUML
-
Documentation as Code for Cloud - C4 Model & Structurizr
C4-PlantUML: Export your model as C4-PlantUML diagrams.
-
Which tools do you use to create diagrams?
PlantUML + C4 plugin;
-
Add quick sketches in emacs org mode
Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)
-
Architecture diagrams should be code
The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
-
C4 model for system architecture design
3️⃣ Text-based diagramming- C4-PlantUML
-
Ask HN: Confluence Alternative(s) Supporting Markdown?
> onboarding docs
yes, they're don't changing frequently
> system design docs
yes - see C4-PlantUML[1]
> meeting notes
no, unless they're directly code related like ADRs [2,3].
Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.
--
[1] https://github.com/plantuml-stdlib/C4-PlantUML
[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...
-
Do you take physical notes while working on your game? Or just play around and learn by doing?
I use a combination of: * Markdown (for notes and code blocks) * Mermaid markdown (for architectural diagrams in markdown documents) * PlantUML markdown (again for arch. docs in markdown, but mainly for C4 diagrams) * a Docker container to render PlantUML markdown to images * Joplin, installed on every device I regularly use * NextCloud, to store, secure, encrypt, and make available everywhere, the markdown notes managed by Joplin
- Diagram as Code
java
-
Documentation as Code for Cloud - C4 Model & Structurizr
Structurizr is used for describing and visualizing architecture using the C4 model. One of the main selling points is the fact you can define an entire (IT) architecture model using text. A typical model consists of:
-
Architecture diagrams enable better conversations
I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.
The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).
I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.
- Dynamically generate Cloud System Architecture diagram
-
Mastering Software Architecture Visualization with the C4 Model
Structurizr, available at https://structurizr.com/ and also has a free plan available with a single workspace available, is a tool that allows you to build out a C4 model using its Structurizr DSL to outline the Containers, Components, and Contexts of the architecture. It is a valuable tool for designing and visualizing a software architecture. In this example we'll build out a simple Machine Learning Pipeline, I mean a very basic one, featuring an ETL Pipeline and a model that trains images that classifies it as a image of planet earth or not. To begin, lets define our work space.
-
Top 9 software architecture tools
Structurizr builds upon "diagrams as code", allowing you to create multiple diagrams from a single model using a number of tools and programming languages.
-
Architecture diagrams should be code
- https://structurizr.com/ (by Simon Brown, the creator of the C4 model)
-
Launch HN: IcePanel (YC W23) – Onboard engineers with explorable system designs
As a customer since 2021, is this re-launch HN?
Loved the concept, found it fell over for real-sized things on even the most powerful machines, had to switch to Structurizr to do our C4 modeling: https://structurizr.com/
Was very disappointed, bet I'd get more devs to model architecture with this tool. If it's relaunching because perf problems were resolved, will look forward to try it again.
Depending on scope of people's needs, either highly recommended or, try it first.
Hats off to Victor for great support back then, and I see the docs are a reflection of that, like this section on embedding into popular tools:
https://docs.icepanel.io/features/sharing#embedding-share-li...
TL;DR: Helpful team, thoughtful UI, thoughtful docs, a product capability (c4 modeling) very worth understanding and using.
-
Keep your diagrams updated with continuous delivery
He built a tool called Structurizr for this.
-
D2 is now open source – a new, modern language that turns text to diagrams
Ah this is like https://structurizr.com which is based on C4.
What are some alternatives?
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
backstage - Backstage is an open platform for building developer portals
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
dsl - Structurizr DSL
c4-draw.io - Draw.io template/diagram containing C4 Model shapes. Drawio Diagrams.net
gcp-icons-for-plantuml - PlantUML sprites, macros, and other includes for Google Cloud Platform services and resources
plantuml-syntax - vim syntax file for plantuml
uml-reverse-mapper - Automatically generate class diagram from code. Supports Graphviz, PlantUML and Mermaid output formats.
diagrams - :art: Diagram as Code for prototyping cloud system architectures