Leichtgewichtige Architekturdokumentation

Termine und Buchung

Softwarearchitekturen festhalten und kommunizieren

Erstelle und pflege nachvollziehbare Architekturdokumentation. Wähle zielgerichtete Formate und Werkzeuge für eine optimale Balance von Aufwand und Nutzen.

Dokumentation als Ballast? Ein wirkungsvolles Festhalten der Architektur hilft dir beim Entwurf der Software, leitet die Umsetzung und führt zu einer nachvollziehbaren und bewertbaren Lösung. Angemessene Dokumentation unterstützt den Austausch im Team und gegenüber Dritten. In diesem interaktiven Workshop erfährst du, wie die Dokumentation der Architektur von der lästigen Pflicht zu einem integralen Kommunikations- und Arbeitsmittel wird. Lerne, architekturrelevante Einflussfaktoren und zentrale Entscheidungen prägnant festzuhalten. Und erlebe, wie eine plausible Softwarearchitektur entsteht.

Grundlage für das Seminar ist das Buch „Softwarearchitekturen dokumentieren und kommunizieren – Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten“ (Hanser Verlag, 3. Auflage) unseres Trainers Stefan Zörner. Das Buch ist für jeden Teilnehmer im Seminarpreis enthalten (Gebundene Ausgabe und eBook).

Agenda

• Einstieg und Motivation: Welche Ziele verfolgst du mit Architekturdokumentation?

• Minimaler Architekturüberblick: Was gehört hinein? Wie fertigst du einen an?

• Zutaten einer Architekturdokumentation: Entscheidungen, Konzepte, Diagramme …

• Gliederungen: Vorteile von Templates, arc42 und Alternativen

• Vorgehen: Zielgruppen, Auswahl der Bestandteile, Dokumentieren vorher vs. danach

• Werkzeugfrage: Gängige Optionen, deren Stärken und Schwächen, typische Herausforderungen

• Dokumentation bewerten: Überprüfung auf Standardkonformität vs. Gebrauchstauglichkeit

Dein Nutzen

Zielgruppe

Dieser Workshop richtet sich an alle, die Softwarelösungen entwerfen und weiterentwickeln. Oder an ihrer Entstehung maßgeblich beteiligt sind, zum Beispiel in der Rolle eines Produktverantwortlichen. Die Teilnehmenden haben bereits praktische Erfahrungen in IT-Projekten gesammelt. Kenntnisse in einer bestimmten Technologie oder Programmiersprache sind nicht erforderlich. UML-Kenntnisse schaden nicht, sind aber keine zwingende Voraussetzung.

Lernziele

Deine Trainer:innen

Unsere Kund:innen sagen

Für viele Entwickler ist „Dokumentation“ zumeist ein recht trockenes Thema – dieses Klischee widerlegt Stefan Zörner in der ADOC-Schulung innerhalb von zwei Tagen (die wie im Flug vergangen sind) gründlich. Neben den üblichen Zutaten einer Architekturdokumentation und den gängigen Werkzeugen zur Erstellung solcher Dokumente, konnte ich vor allem meinem methodischen Werkzeugkasten um einiges erweitern. Und langweilig geworden ist mir (nicht zuletzt aufgrund Stefans lockerer Art und aufgrund des Austauschs mit den anderen Teilnehmern) nie – denn nicht jedes Klischee stimmt.

Reinlesen & Vertiefen

• 

  Documentation-as-Code einsetzen (Architektur-Spicker Nr. 15)

  Die Verwendung der gleichen Tools und Prozesse wie in der Softwareentwicklung ermöglich dir die effiziente Pflege von Dokumentation. Dieser Spicker erklärt dir die Idee und hilft dir beim Dokumentieren deiner Vorhaben. Hier geht es zum Spicker.

• 

  Softwarearchitekturen dokumentieren und kommunizieren

  Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten. Das Buch von Stefan Zörner zeigt, wie ihr die zentralen Lösungsansätze Eurer Softwaresysteme so festhalten könnt, dass sie Euch bei der Entwicklung und Weiterentwicklung helfen. Dabei betrachtet er sowohl die Situation, dass ihr ein neues Softwaresystem baut, als auch das „Nachdokumentieren“ bestehender Lösungen. Hanser Fachbuch, 3., überarbeitete und erweiterte Auflage (Dez 2021). Webseite zum Buch: swadok.de

• 

  Der Architekturüberblick (Architektur-Spicker Nr. 1)

  Dir oder Deinem Team fehlt ein kompakter Überblick zu Eurer bestehenden Softwarelösung? Du möchtest einem neuen Projektmitglied oder einem Kooperationspartner Eure Architektur erklären? Der Quelltext ist zu »ausführlich« … Die erste Ausgabe unseres Architektur-Spickers unterstützt Euch dabei, die zentralen Lösungsansätze Eurer Softwarearchitektur nachvollziehbar darzustellen. Nutzt die kompakt erläuterten Zutaten und füllt Euren Architekturüberblick mit Leben – pragmatisch und wirkungsvoll zugleich. Download & Infos

• 

  arc42 by Example

  Die Architektur von sechs realen Softwaresystemen, jeweils mit arc42 beschrieben. Dadurch können Sie anhand praktischer Beispiele sehen, wie sich arc42 anfühlt. Gerne genutzt, um die Einführung von arc42 in Teams oder Projekten zu unterstützen.

• 

  Softwarearchitekturen pragmatisch dokumentieren – Eine kompakte Einführung in arc42

  Effektiv, schmerzfrei und mit wenig Aufwand. Gernot Starke und Benjamin Wolf räumen mit einigen Vorurteilen gegen (technische) Dokumentation auf und zeigen Dir, wie Du auf einfache Weise zu vernünftiger (Architektur-)Dokumentation kommst.