Methodik & PraxisMethodik & Praxis

Documentation to blow (up) your mind!

Architekturdokumentation
C4
Diagrams-as-Code
Docs-As-Code

Abstract


Mi. 16:40 - 17:25 Uhr | 2024

Dokumentation ist aufwendig zu erstellen, noch aufwendiger zu pflegen und oft hört man die Ausrede: Guter Code dokumentiert sich selbst! Dass das nicht so sein muss und wie Doku nicht zum Selbstzweck wird, ist Inhalt dieses Vortrages.
Das C4-Modell von Simon Brown bietet eine frische Perspektive auf die Software-Architekturdokumentation, indem es verständliche, zielgruppengerechte Diagramme ermöglicht – eine willkommene Abkehr von komplexen Standards wie UML. Ein Schlüsselelement von C4 ist der ‚diagrams-as-code 2.0‘-Ansatz, der die Dokumentation nicht nur in Form von Code ermöglicht, sondern daraus automatisiert Diagramme erzeugt, welche bei Bedarf manuell optimiert werden können. Durch diesen Ansatz, der docs-as-code auf ein neues Level hebt, kann man Prinzipien wie DRY auch auf die Doku anwenden, was sich wiederum positiv auf den Pflegeaufwand auswirkt.
Was C4 alles kann, was nicht und wie es bei uns zum essenziellen Bestandteil der Doku wurde: C4 – Documentation to blow (up) your mind!

Non-Sponsored TalkAnfängerDeutsch
Charlotte Scharbert

Charlotte Scharbert

pharma-mall.de

Zunächst im Bereich Software-Entwicklung tätig, wechselte Charlotte dann in den Bereich der Dokumentation und arbeitet nun als technischer Dokumentator bei der pharma mall, einer der größten IT-Dienstleister der Pharmabranche. Ihr Anliegen ist es, das Thema Software-Dokumentation populärer zu machen und zu zeigen, dass Doku nicht aufwendig und lästig sein muss.