BASTA! Spring 2014 Countdown

Arc42 ist die Antwort auf alle Architekturfragen
Kommentare

Dokumentationen werden im Projektalltag oft ignoriert. Zu teuer, zu langwierig, keine Lust – hierfür kann es viele Gründe geben. Auf der BASTA! Spring 2014 stellt André Krämer (Software, Training & Consulting/www.IT-Visions.de) jedoch Arc42 vor, eine Vorlage, mit der Architektur-Dokumentationen erheblich leichter von der Hand gehen. Uns hat er bereits im Vorfeld einige Fragen beantwortet.

Windows Developer: Auf der BASTA! Spring 2014 hältst du eine Session, in der du über die Dokumentation von Softwarearchitekturen sprichst. Erkläre uns doch einmal, wieso es so wichtig ist, seine Architektur zu dokumentieren.

André Krämer: Kurz gesagt: Die Dokumentation der Software-Architektur spart Kosten, je nach Projektumfang und Komplexität sogar in erheblichen Maßen. Auf den ersten Blick mag diese Aussage zwar etwas widersinnig klingen, schließlich ist es ja mit einem gewissen Aufwand verbunden, das Architekturdokument zu schreiben. Wenn wir uns aber nun vor Augen führen, wie die Situation in mittleren bis großen Softwareprojekten ist, dann ist es doch eher die Regel als die Ausnahme, dass sich die Teamzusammenstellung während der Projektlaufzeit verändert. Im Idealfall kommen neue Mitarbeiter hinzu. Wenn die Softwarearchitektur nicht dokumentiert wurde, bedeutet dies, dass sie jedem neuen Teammitglied persönlich bis ins kleinste Detail erläutert werden muss. Diese Erklärungen bremsen die bestehenden Teammitglieder aus, da sie sich die Zeit nehmen müssen, um den neuen Kollegen einzuarbeiten. Selbstverständlich kann man solche Aufgaben dem Projekt nicht produktiv zuordnen, es wird ja kein Mehrwert geschaffen. Stattdessen wird das Projekt unnötig mit Kosten belastet.

Das nächste Problem tritt auf, nachdem die Entwicklung der Software abgeschlossen ist. Die Software geht nun in die Wartungsphase. In vielen Fällen wird die Pflege und Weiterentwicklung ab diesem Zeitpunkt nicht mehr vom ursprünglichen Entwicklungsteam durchgeführt. Ein Grund hierfür könnte sein, dass das ursprüngliche Team anschließend ein neues Projekt umsetzt, ein anderer, dass einige der Entwickler und Architekten zwischenzeitlich den Arbeitgeber gewechselt haben. Im ersten Fall fällt eine zeitaufwändige und somit teure Übergabe des ursprünglichen Teams an das Wartungsteam an. Der zweite Fall ist sogar noch kostenintensiver. Hier muss man nämlich zum einen die Zeit einkalkulieren, die das neue Team zum Erforschen der Architektur benötigt, zum anderen aber auch natürlich die Zeit, bis Änderungen an der Software in hochwertiger Qualität vorgenommen werden können.

Ich denke die meisten Entwickler kennen das Problem, dass man bestehenden Code bzw. eine Architektur ohne vernünftige Übergabe und Dokumentation zunächst falsch interpretiert und ein System während xdieser Phase durch Änderungen im besten Fall verschlimmbessert.

Natürlich kann man nicht alle diese Probleme durch eine Dokumentation lösen, aber man kann sie damit zumindest merklich abschwächen.

Windows Developer: Und wieso wird das in einigen Unternehmen immer noch nicht gemacht?

André Krämer: Dafür gibt es viele Gründe. Viele sehen die Dokumentation der Architektur als zeitaufwändig, teuer, unnötig an, weil alle Beteiligten sowieso wissen, wie das System funktioniert. Gerne versteckt man sich auch unter dem Deckmantel der Agilität, denn in agilen Projekten dokumentiert man ja sowieso so wenig wie möglich. Es gibt aber natürlich auch ganz persönliche Gründe, die gegen eine Dokumentation sprechen. Viele Architekten und natürlich auch Entwickler schreiben halt doch lieber Quellcode als Word-Dokumente. Aber selbst wenn der Wille prinzipiell vorhanden wäre, fällt die Dokumentation vielleicht auch einfach mangelnder Erfahrung in diesem Bereich zum Opfer. Es nicht leicht, sich eine gute Struktur für eine Dokumentation zu überlegen. Unter Umständen findet man gar keinen rechten Anfang und fühlt sich durch eine gewisse Ratlosigkeit blockiert.

Windows Developer: An dieser Stelle bringst du Arc42 ins Spiel. Worum handelt es sich hierbei genau?

André Krämer: Gerade beim letzten Punkt hilft eine gute Vorlage, an der man sich orientieren kann, natürlich ungemein. Zum einen kann man die Struktur übernehmen, zum anderen sieht man auch, welche Bereiche in welcher Form und mit welchem Detailgrad ausgefüllt werden sollten. Eine solche Vorlage zur Dokumentation von Softwarearchitekturen, für die es auch einige Beispiele gibt, ist die frei verfügbare Vorlage Arc42 von Dr. Gernot Starke und Dr. Peter Hruschka. Sie steht unter einer Creative-Commons-Lizenz und kann somit kostenfrei in eigenen Projekten genutzt werden. Sie enthält eine Struktur mit den wichtigsten Kapiteln einer Architektur-Dokumentation. Zu jedem dieser Kapitel gibt es dann noch detaillierte Hinweise, wie der entsprechende Abschnitt auszufüllen ist.

Windows Developer: Erkläre doch mal allen, die „Per Anhalter durch die Galaxis“ nicht gelesen haben, die Bedeutung der Zahl 42 und wie sich diese Bedeutung auf das von dir vorgestellte Produkt übertragen lässt.

André Krämer: Da ich „Per Anhalter durch die Galaxis“ weder gesehen, gehört noch gelesen habe, bin ich mit Sicherheit der Falsche, um diese Frage zu beantworten. Soweit ich weiß, ist eines der berühmtesten Zitate jedoch „die Antwort lautet 42“. Gefragt wurde relativ unspezifisch nach „dem Leben, dem Universum und dem ganzen Rest“. Somit ist 42 die Antwort auf die Frage aller Fragen. Da sich Arc42 aus Architektur und 42 zusammensetzt, ist Arc42 ist somit die Antwort auf alle Architekturfragen.

Windows Developer: Können derartige Vorlagen auch Nachteile haben?

André Krämer: Natürlich! Und zwar dann, wenn man sich zu strikt und ohne Nachzudenken an die Vorlage hält. Das Template versteht sich als Baukasten, aus dem man sich bedienen kann. Ausfüllen sollte man nur die Kapitel, die für das eigene Projekt auch Sinn machen. Gerade wenn man die Vorlage als exakt einzuhaltende Vorgabe sieht, läuft man Gefahr, viel zu viel Zeit und Arbeit in die Dokumentation zu stecken. Als Faustregel sollte immer gelten: Die Dokumentation sollte so kurz wie möglich sein. Lange Dokumente liest sowieso niemand.

Windows Developer: Vielen Dank für das Gespräch, André. Wir sehen uns auf der BASTA!

© André KrämerAndré Krämer ist selbstständiger Entwickler, Trainer, Berater und Partner im www.IT-Visions.de-Expertennetzwerk. Seine Schwerpunkte sind Webanwendungen mit ASP.NET und JavaScript, Apps für Windows 8, TX Text Control und Infragistics NetAdvantage. Als einer der Leiter und Gründer der .NET User Group Koblenz wurde er für sein Community Engagement 2009 in das Microsoft-CLIP-Programm aufgenommen und mit dem Infragistics MVP Award ausgezeichnet. Seit Juli 2013 ist er außerdem TX Text Control MVP und Microsoft MVP für Client Development. André Krämer ist regelmäßiger Autor für diverse Fachmagazine, häufiger Sprecher auf Entwicklerkonferenzen und User-Group-Treffen und Autor mehrerer Videotrainings bei video2brain. Aktuell schreibt er an zwei Büchern über Windows-8-App-Entwicklung, die beim Hanser Verlag erscheinen werden.

Unsere Redaktion empfiehlt:

Relevante Beiträge

Meinungen zu diesem Beitrag

X
- Gib Deinen Standort ein -
- or -