PlantUML – Making Complicated Diagrams Simpler

plantuml-title

A colleague at work recently told me that I should check out PlantUML. His advice is usually good, and this is no exception.

PlantUML uses a relatively simple text language to describe the desired diagram, then makes generation of the image as simple as processing the UML file. It’s easy to try online at http://plantuml.com/ where there is a text editor with real time image updates as you add more content.

Sequence Diagrams

Sequence diagrams are probably the simplest to build, and are absurdly fast to create. Here’s a simple example of a TCP exchange:

plantuml-tcpTo create this, I used the following PlantUML:

You’re not limited to two endpoints, of course:

plantuml-gossip

Use Case Diagrams

Here’s a simple use case with Fred and Joe again:

plantuml-reprimandThe PlantUML to generate this was:

The use of --> as the arrow from Fred to HR makes the line vertical rather than horizontal. You can actually use -left->, -right->, -up-> and -down->, to explicitly select a direction. There isn’t fine control over placement of objects and lines, but using options like line direction and note positioning, it is possible to manipulate the appearance to some degree.

Activity Diagrams

Here’s an easy way to build those process flows you’re asked to create for ISO27001 and the like:

plantuml-process

This image, while demonstrating a few new features also shows how the inability to finely control the label “Request Complete?” means that we are at the mercy of the underlying GraphViz layout engine, which is not always perfect.

Other Types

PlantUML also offers other diagram types not shown here, including:

  • Class diagram
  • Component diagram
  • State diagram
  • Deployment diagram
  • Object diagram
  • Wireframe graphical interface (mock up UI)

Export

PlantUML can export to PNG, SVG and LaTeX formats, and for sequence diagrams –with some effort– you can generate an ASCII art version, so for those of you writing an RFC right now, this may make your life simpler.

Alternatively you could just use the online interactive tool and copy the resulting image from the web page.

My 2 Bits

This is a fun tool! Anybody who has used GraphViz before will be familiar with the agony of seeing an almost but not quite perfect diagram being generated, and as PlantUML uses GraphViz under the covers, you should expect the same here. That said, with a little effort (and occasionally some text padding), the results can be quite impressive for such a small outlay of effort. I’m particularly impressed at the ease with which a sequence diagram can be created; I’ll be using that in the future.

If you try it out, let me know what you think!

Be the first to comment

Leave a Reply

Your email address will not be published.


*


 

This site uses Akismet to reduce spam. Learn how your comment data is processed.