Historisch gewachsen?

Dokumentieren zählt nicht unbedingt zu den Lieblingsbeschäftigungen eines Entwicklers. Und dann auch noch Architektur? Kästchen, Linien, Wolken? Wirkungsvolle Architekturdokumentation ist kein stumpfes Vorlagenausfüllen, und schon gar keine bunte High-Level Powerpoint-Präsentation. Sie macht zentrale Entscheidungen auch später noch nachvollziehbar. Sie fördert die Kommunikation innerhalb der Entwicklung, holt Stakeholder ab und bindet Kunden, Fremdprojekte und neue Teammitglieder einfacher ein. Gerade für Neue im Team sollten Sie bessere Antworten parat haben als „Historisch gewachsen“.

Halten Sie Ihre Architekturansätze und Ideen wirkungsvoll fest, anstatt sie zu vergessen!

Um was es geht …

Besser spät als nie? Gute Dokumentationskonzepte unterstützen bereits beim Entwurf der Lösung. Also beim Strukturieren, beim Treffen von Technologieentscheidungen, beim Erarbeiten von Konzepten. Sie machen die Lösung anwendbar, nachvollziehbar und bewertbar. Und sie leiten bei der Umsetzung und Weiterentwicklung der Software.

Was gehört hinein? Zutaten für Architekturüberblicke

Um die Ziele zu erreichen sind Aspekte der Aufgabenstellung wie auch der Lösung festzuhalten. Architekturrelevante Anforderungen auf der einen, Lösungsdetails auf der anderen Seite. Eine gute Lösungsstrategie schlägt die Brücke zwischen Problemstellung und Lösungsansätzen. Neben textuellen Inhalten spielen graphische Inhalte (Diagramme) und damit verbunden Notationen eine wichtige Rolle.

In diesem Zusammenhang stellt sich in vielen Vorhaben die Werkzeugfrage. Wiki vs. UML-Tool vs. Visio vs. … — Typisch ist eine Werkzeugkette mit einer Kombination dieser Tools.

Mit arc42 in der Template-Falle? Zutaten Zielgruppen-gerecht in Form(en) bringen

Beim Anordnen der Inhalte helfen Gliederungsvorschlägen wie arc42 weiter. Unreflektiert angewendet stürzen sie Projekte mitunter in eine Aufwandsfalle. Der Schlüssel zum Erfolg liegt in der Zielgruppenorientierung, und dem Rekombinieren der Inhalte ausgerichtet an den Interessen dieser Zielgruppen in unterschiedlichen Formen. „Schreibe aus Sicht des Lesers“ ist das erste Gebot.
Typische Formen für Architekturüberblicke

Nützliche Publikationen, Vortragsmitschnitte und Downloads zum Thema Dokumentation:

Unser Buch zum Thema


Stefan Zörner hat seine Erfahrungen zum Thema Architekturdokumentation, gesammelt in vielen Einzelprojekten und zwei unternehmensweiten arc42-Einführungen, in diesem Buch zusammengetragen. mehr …

Blog-Serie zu Zutaten


Bei Hanser Update,  dem Blog des Hanser Fachbuch-Verlages, ist im Rahmen einer kleinen Serie ein Architekturüberblick für das Bildsystem Gradle entstanden. Angelehnt an die Starschnitte der Bravo gibt es alle 3-4 Wochen ein neues Puzzleteil. mehr …

Spicker zu Architekturüberblicken


Dieses vierseitige PDF unterstützt Sie dabei, die zentralen Punkte Ihrer Softwarearchitektur wirkungsvoll darzustellen. Ein solcher Architekturüberblick macht Ihre entscheidenden Lösungsansätze in kompakter Form nachvollziehbar. mehr …

Video mit Tipps & Tricks


JAXenter hat einen Vortrag von Stefan Zörner von der W-JAX 2015 auf Vimeo bereitgestellt: “So sieht’s aus! Architekturüberblicke – Tipps und Tricks”. mehr …

eBook: arc42 by Example


Das bei Leanpub erschienen englischsprachige eBook führt in arc42 ein und illustriert es mit verschiedenen Beispielen. Als PDF, ePUB, für Amazon Kindle, Tolino, etc. mehr …

Blog-Beitrag zur Toolfrage


Der Beitrag stellt die vier aktuell in Projekten am häufigsten eingesetzten Tools (bzw. Tool-Kategorien) für Architekturdokumentation vor und diskutiert ihre Stärken und Schwächen. mehr …

Ihr Nutzen

Gemeinsames Lösungsverständnis – Wirkt bereits im Entwurf
Zielgruppengerecht – Dokumentation unterstützt Kommunikation
Basis für Reflektion – Belastbare Grundlage, um Architekturen fundiert zu bewerten
Effizientere Einarbeitung – Neue im Team kommen schneller ins Tun
Konzeptionelle Integrität – Gleiche Probleme werden gleich gelöst
Wiederverwendung – Erprobte Lösungsansätze über Projektgrenzen hinweg

Produkte

Dokumentation unterstützt Kommunikation; unsere Expertise in diesem Bereich kommt daher in vielen unserer Einsätze zum Tragen. So ist es innerhalb Architektur-Reviews typisch, dass ein Architekturüberblick angefertigt oder zumindest geschärft wird. Mitunter ist Dokumentation aber auch Hauptthema eines Engagements. Hier konkrete Leistungen dieser Kategorie, die wir bereits erfolgreich bei Kunden durchgeführt haben.

Bestehendes nachdokumentieren: Coaching

(Coaching, projektbegleitend ab 3 Tage)
In der Theorie entsteht Architekturdokumentation bereits während des Entwurfes. Die Projektrealität sieht oft anders aus. Ihre auch? Wir unterstützen Sie dabei, im nachhinein eine passende Architekturdokumentation anzufertigen. Dazu ermitteln wir zunächst gemeinsam mit Ihnen die Zielgruppen und deren Informationsbedürfnisse, identifizieren die passenden Zutaten und Werkzeuge, und dokumentieren zusammen Ihre Lösung. Ganz pragmatisch und effizient.

Architekturdokumentation breit einführen

(Coaching, projektübergreifend ab 7 Tage)
Sie wollen Architekturdokumentation in Ihrer Organisation projektübergreifend vereinheitlichen? Eine Vorlage wie beispielsweise arc42 unternehmensweit einführen? Richtig angegangen erzielen Sie damit einen hohen Nutzen, da Synergien entstehen und Erfahrungen Wiederverwendung finden. Wenn Sie es falsch angehen, müssen Sie mit erheblichen Widerständen und verschenkten Aufwänden rechnen. Gehen wir es gemeinsam richtig an! Wir haben einschlägige Erfahrung bei dieser Aufgabe.

Stefan Zörner

Stefan Zörner

(Berater und Coach)

Sprechen Sie uns an!

Sie haben Fragen zum Thema? Zögern Sie nicht Kontakt mit uns aufzunehmen!

Email: stefan.zoerner@embarc.de
Xing: xing.to/szr
Twitter: @StefanZoerner