C4 – Documentation to blow (up) your mind!

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 Softwarearchitektur-Dokumentation, 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, die bei Bedarf manuell optimiert werden können. Durch diesen Ansatz, der Docs-as-Code auf ein neues Level hebt, kann man Prinzipien wie DRY ("Don't repeat yourself") 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!

Speaker

 

Charlotte Scharbert
Charlotte Scharbert arbeitet als technische Dokumentatorin bei der pharma mall. Dort betreut sie die Dokumentation der Software und hat C4 eingeführt, um die Architektur-Doku zu vereinfachen und zu vereinheitlichen. Ursprünglich hat Charlotte eine Ausbildung im Bereich Software-Entwicklung gemacht, merkte aber schon bei der Abschlussarbeit, dass ihr das Dokumentieren eigentlich mehr Spaß bereitet als das Entwickeln. Sie wechselte dann von der Software-Entwicklung zur Dokumentation und versucht nun, das Thema Software-Dokumentation populärer zu machen und zu zeigen, dass Doku nicht aufwändig und lästig sein muss.

betterCode-Newsletter

Du möchtest über die betterCode() ArchDoc und weitere unserer betterCode()-Events auf dem Laufenden gehalten werden?

 

Anmelden