ArchitekturDoku in 7 Schritten


Von: Matthias Bohlen
Betr.: Architekturdoku leicht erstellen, kommunizieren und pflegen

Liebe Kollegen Softwarearchitekten (m/w),

warum sollte die Erstellung und Wartung von Dokumentation für die Softwarearchitektur eigentlich schwierig und aufwändig sein? Kann man das nicht auch anders machen? Und warum wird sie so selten gelesen und genutzt? Da stimmt doch mit der bisherigen Art und Weise, Doku zu machen, etwas nicht!

Ändern wir es. Lassen Sie uns gemeinsam Doku machen, die lebendig geschrieben ist, gern gelesenund gut verstanden wird. Wie das gehen soll? Lesen Sie weiter!

Architektur Doku ist cool

Doku erleichtert die Einarbeitung neuer Mitarbeiter, die erfahrenen Leute brauchen nicht alles 10x zu sagen. Doku beantwortet die Frage, warum das System ist wie es ist. Code und Tests tun das nicht. Doku macht Architektur bewertbar: Leistet unsere Architektur eigentlich, was sie soll?

Doku hilft, Fehler zu vermeiden, indem sie sagt, wozu eine Komponente gedacht war, also: was man dort an Code einbauen darf und was nicht. Doku hilft beim Denken. Wenn sich etwas nicht aufschreiben lässt, ist es wahrscheinlich zu kompliziert gedacht!

Und das Wichtigste: Doku unterstützt die Kommunikation im Projekt. Wenn man Architektur aufschreibt, kann man sich über sie streiten und sich auf sie einigen. Wenn nicht, hat jeder seine eigene Vorstellung von der Architektur.

Ich habe etwas für Sie vorbereitet

In einer 7-Schritte-Anleitung, die Sie kostenlos herunterladen können, zeige ich Ihnen, was Sie tun müssen, damit Ihr Dokumentationsvorhaben ein Erfolg wird. Sie erfahren, wie Sie Ihre Leser-Zielgruppen so ansprechen, dass die Doku wirklich gelesen und genutzt wird. Damit Ihre Doku nicht auf irgendeiner Festplatte verstaubt, sondern die Architekturarbeit aktiv unterstützt, Leitplanken für die Entwickler bei der Umsetzung bildet und Ihre Architektur dadurch nachvollziehbar und bewertbar wird.

Was in "7 Schritte" drinsteht

  • Die Vorteile, die Architekturdokumentation für Sie und Ihr Vorhaben hat
  • Die typischen Ausreden und Probleme, warum Architektur nicht dokumentiert wird
  • Die sieben bewährten Schritte, mit denen es Ihnen wesentlich leichter fallen und sogar Freude machen wird, zu dokumentieren
  • Ein Tipp für ein einfaches System, mit dem Sie in Zukunft Ihre Doku erfolgreich erstellen können

Laden Sie sich die Anleitung herunter.

Hier geht's zum Download »

Ich freue mich darauf, Ihnen den Weg zu guter Doku zeigen zu können. Damit Sie Systeme entwerfen, die rocken.

Oder?

Matthias Bohlen