In den letzten Zügen unserer Dokumentation brauchten wir für die Software-Dokumentation noch einige Grafiken und Diagramme. Zuerst habe ich mich an einem UML-Klassendiagramm versucht – so wie wir es gelernt haben. Dabei habe ich jedoch schnell gemerkt, dass das nicht so aussagekräftig ist, gerade was die Funktionalität angeht. Um diese noch deutlicher darzustellen habe ich ein weiteres Diagramm erstellt, aus welchem gut erkennbar ist, welche Status wie zusammenhängen und auch was mit ihnen nach dem Versenden via MQTT geschieht. Außerdem wollte ich noch ein Diagramm einbringen, aus welchem man erkennen kann welche Komponenten wir verbaut haben und welche Funktion diese in unserem Fall erfüllen. Dafür habe ich ebenfalls ein Klassendiagram erstellt, welches ich jedoch deutlich vereinfacht habe, da hier die Übersichtlichkeit im Vordergrund stehen sollte. Abschließend haben wir uns entschieden noch ein kleines Diagramm zur Darstellung der verwendeten Schnittstellen in die Dokumentation zu übernehmen.

Die Herausforderung bei der Erstellung dieser Diagramme war, dass ich das System bereits recht gut verinnerlicht hatte, aber es trotzdem verständlich und korrekt darstellen musste. Tatsächlich hatte ich immer das Gefühl mich genau dazwischen zu bewegen: Entweder ein Modell ist syntaktisch und technisch korrekt oder gut verständlich. Die Lösung mehrere Darstellungen einzubringen, halte ich für gelungen und gefällt mir gut.