Beispieldokumentationen
Die ADF-Dokumentationsvorlage in voller Aktion erleben
Die folgenden Beispiele verwenden die ADF-Dokumentationsvorlage und modellieren die Diagramme entsprechend der ADF-Sichten-Methode.
Beispiel 1: What2Eat
What2Eat ist eine einfache App zur Anzeige des Tagesessens in der Mensa der Universität Kaiserslautern. Sie dient als Beispiel für Architekturdesign (Teil der Vorlesung „SWAR-WIN: Softwarearchitektur“ von Prof. Dr. Johannes C. Schneider an der HTWG Konstanz). Das beschriebene System ist sehr einfach, hat aber einen Scope, der architektonisch gerade schon etwas interessant ist (zwei externe “Systeme”) sowie Bezug zu typischen betrieblichen Informationssystemen (Schichtenarchitektur und REST-Schnittstelle). Die Dokumentation ist in englischer Sprache verfasst.
Beispiel 2: Dokchess
Dokchess ist eine Schach-Engine und dient in Stefan Zörners Buch “Softwarearchitekturen dokumentieren und kommunizieren: Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten” als Beispiel für eine Architekturdokumentation nach der arc42-Vorlage. Im Jahr 2025 hat Johannes Schneider eine zweite Version dieser Dokumentation im Format der ADF-Dokumentationsvorlage erstellt. Der textuelle Inhalt ist in großen Teilen gleich, so dass man hier gut arc42 und ADF miteinander vergleichen kann. Die Dokumentation ist in deutscher Sprache verfasst.
Beispiel 3: Marktplatz Deutschland.Digital
Das Projekt Marktplatz Deutschland.Digital beschäftigt sich mit Daseinsvorsorge im ländlichen Raum durch Digitalisierung und hat dazu unter anderem eine Plattform entwickelt, auf der verschiedene Anbieter digitale Lösungen für Kommunen zur Verfügung gestellt werden können. Im Zuge des Ausbaus der Architekturdokumentation des Projekts haben die Entwickler:innen im Projekt einen kleinen Teil von Marktplatz Deutschland.Digital ausgewählt, für den sie beispielhaft die Anwendung der ADF-Dokumentationsvorlage sowie Documentation-as-Code und Diagrams-as-Code ausprobiert haben. Der Marktplatz-Service ist ein mit Spring-Boot umgesetztes REST-Backend mit Datenbankanbindung, bei dem Marktplatz-Einträge erstellt, veröffentlicht und abgerufen werden können. Die Dokumentation ist in deutscher Sprache verfasst.
Beispiel 4: Continuous Feedback For Exercises (CoFFE)
Das CoFFE-Projekt zielt darauf ab, ein automatisiertes Feedback-System mit Reporting zu entwickeln, das Student:innen und Dozent:innen bei der Bearbeitung und Bewertung von Übungsaufgaben in Informatik-Lehrveranstaltungen unterstützt. Im Rahmen des Projekts wurde eine Dokumentation mit Hilfe der ADF-Dokumentationsvorlage erstellt (in deutscher Sprache).