Live-Online: iSAQB® Architekturdokumentation (ADOC): Architekturen dokumentieren und kommunizieren (CPSA Advanced Level)

In diesem Seminar lernst du praxisorientiert, Architekturdokumentationen zu erstellen, zu optimieren und die Qualität zu sichern. Du erwirbst Kenntnisse in Notationen, Werkzeugen und Methoden zur Dokumentation von Architekturentscheidungen und Qualitätsanforderungen und kannst passende Werkzeuge auswählen. Am Ende bist du in der Lage, Architekturdokumentationen für mittlere bis große IT-Systeme zu erstellen.

Grundbegriffe von Softwarearchitekturdokumentation

• Nutzen, Ziele und Anforderungen von Stakeholder:innen.
• Notationen (UML, BPMN) und Einfluss von Entwicklungsmethoden.

Dokumentation und Vorgehen:

• Strukturierung und Erstellung von Architekturdokumentationen.
• Standardisierte Vorlagen (arc42, C4, IEEE 1471).

Bestandteile von Architekturdokumentationen:

• Architekturentscheidungen, Architektursichten, Qualitätsanforderungen.
• Konsistenz und Nachvollziehbarkeit der Dokumentation.

Werkzeuge:

• Analoge und digitale Werkzeuge zur Dokumentation.
• Modellierungswerkzeuge, Wikis, Versionskontrolle, Textverarbeitung.

Bewertung der Dokumentation:

• Review-Methoden, Checklisten, Qualitätssicherung.

Beispiele für Dokumentation von Softwarearchitekturen:

• Vorstellung und Analyse realer Architekturdokumentationen.
• Vergleich unterschiedlicher Dokumentationsansätze.
• Diskussion von Vor- und Nachteilen verschiedener Dokumentationsmethoden.

Anforderungen: 

Du solltest Grundlagenwissen aus dem CPSA-F (z. B. Sichten, Entwurfsentscheidungen, Randbedingungen) mitbringen.

• Idealerweise hast du bereits Erfahrung in der Erstellung und Pflege technischer Dokumentationen.
• Du verfügst über ein grundlegendes Verständnis typischer Herausforderungen wie der Auswahl von Notationen und der Integration von Werkzeugen.
• Erfahrungen in der Zusammenarbeit bei der Dokumentation sind von Vorteil.
• Kenntnisse in Versionierung und Dokumentationsprozessen erleichtern dir den Einstieg.

Technische Anforderungen: 

Es gibt keine speziellen Anforderungen an die Schulungsumgebung, da die Übungen mit Cloud- und Web-basierten Tools wie Miro, Draw.io und Plattformen wie Jupyter oder HuggingFace stattfinden, hier wird nur eine stabile und ausreichend schnelle Internetverbindung benötigt.

• Du lernst, Softwarearchitekturen systematisch zu dokumentieren.
• Du kannst bestehende Dokumentationen bewerten und gezielt verbessern.
• Du berücksichtigst unterschiedliche Bedürfnisse und passt die Dokumentation entsprechend an.
• Du nutzt Werkzeuge und Templates (z. B. arc42, C4) zur effizienten Erstellung.
• Du erhältst praxisnahe Beispiele und Techniken zur Bewältigung realer Herausforderungen.
• Du verwendest Reviews und Feedback, um die Dokumentationsqualität zu erhöhen.

Deine Vorteile auf einem Blick: 

• Strukturierte und effiziente Dokumentation: Klare und nachvollziehbare Architekturaufzeichnungen für alle Stakeholder.
• Qualitätssteigerung: Verbesserte Konsistenz und Nachvollziehbarkeit durch bewährte Methoden und Werkzeuge.
• Optimierte Zusammenarbeit: Einheitliche Dokumentationsstandards erleichtern die Teamkommunikation und Abstimmung.