Ausführbare Dokumentation – Architekturregeln mit Docs-as-Code festhalten und testen

Es ist kein Mythos, dass eine gute Architekturdokumentation ein Garant für erfolgreiche Softwareprojekte ist. Die Kunst und Herausforderung zugleich ist es jedoch, den Aufwand überschaubar und mit geeigneten Konzepten die Dokumentation lebendig zu halten. Leichtgewichtige Methoden, Vorlagen und Werkzeuge aus dem Docs-as-Code-Umfeld bringen das Dokumentieren näher an den Sourcecode und unterstützen Entwicklungsteams bei der Erstellung einer hochwertigen Architekturdokumentation. Leider veraltet Dokumentation auch sehr schnell.

In diesem Vortrag betrachten wir daher, wie wir eine selbst validierende, ausführbare Dokumentation nutzen können, um die Qualitätsansprüche der Softwarearchitektur wiederkehrend zu prüfen und mit Fitness Functions abzusichern.

Dazu machen wir Architekturkonzepte im Code sichtbar, zum Beispiel mit xMolecules und ContextMapper, binden Software-Analysewerkzeuge wie jQAssistant ein und führen regelmäßig programmatische Tests beispielsweise mit ArchUnit aus - für einen kontinuierlichen Abgleich der Soll- und Ist-Struktur. Ihr könnt diese Ideen in Eure Projekte übertragen, Eure Architekturdokumentation wird dadurch lebendig und Teil Eurer kontinuierlichen Qualitätsmaßnahmen.