PlantUML - Schreiben statt malen

Fr, 28. Mai 2021, Ralf Hersel

In der TALK-Gruppe von GNU/Linux.ch gab es in dieser Woche eine Diskussion über Werkzeuge, mit denen man Diagramme erstellen kann. Dort wurden die üblichen Verdächtigen empfohlen, wie z. B. yEd, Dia oder das Draw-Modul von LibreOffice. Neben dem herkömmlichen Zeichnen von Diagrammen, gibt es noch einen anderen Ansatz, den ich vorstellen möchte. Nämlich das deskriptive Erstellen von technischen Grafiken.

Die Bildschirmaufnahme lässt erahnen, worum es hierbei geht. Anstatt ein Diagramm zu zeichnen, wird es durch eine Art Pseudo-Code beschrieben. Das Diagramm wird dann automatisch aus der Beschreibung generiert. Daraus ergeben sich viele Vorteile:

  • Fokussierung auf den Inhalt und nicht auf Layout und Design
  • Syntaktische Korrektheit des Diagramms
  • Leichtes Ändern und Reproduzieren eines bestehenden Diagramms
  • Unabhängigkeit von einem bestimmen Zeichen-Werkzeug

Auf der Seite PlantUML findet man alle Informationen, die für den Einsatz dieser Technik nötig sind. Die unterstützten Diagrammarten gehen weit über die UML-Notation hinaus. Wer möchte, kann sogar Gantt-Charts und MindMaps erstellen. Eine Empfehlung zum Ausprobieren dieses Konzeptes ist die Seite PlantText, in der auch der Screenshot für diesen Artikel erstellt wurde. In dem Dropdown-Menü (links oben) werden Beispiele zu den unterstützten Diagrammtypen gezeigt.

Wer Gefallen an dieser Art der Diagrammerstellung gefunden hat, kann PlantUML auch lokal installieren, bzw. eine Integration in andere Werkzeuge verwenden. Die Software ist in den Repositories der gängigen Distributionen enthalten und kann z. B. mit sudo apt install plantuml installiert werden. Ein Diagramm beschreibt man dann in einer Textdatei und lässt die Zeichnung (gleichnamige PNG-Datei) mit einem solchen Befehl erzeugen: plantuml diagram.txt

Auf der Seite des Projektes findet man Angaben zu weiteren Client oder zur Integration, beispielsweise in DokuWiki.

Quelle: https://plantuml.com/de/