Mit lebendiger Architekturdokumentation und jQAssistant zum perfekten System

- Workshop -

Architektur und Dokumentation im Einklang mit den Anforderungen – von Anfang an!

Geht es Ihnen auch so? Sie arbeiten an einem Softwaresystem und wollen es möglichst perfekt umsetzen: Angefangen bei der Definition der Architektur, über die Dokumentation und Umsetzung bis hin zur Kontrolle der Einhaltung der Architektur. Jedoch wird der Projektalltag Sie und insbesondere Ihr perfektes Softwaresystem früher oder später einholen. Bereits nach wenigen Monaten stehen Sie dann vor den gleichen Problemen, vor denen Sie auch bei den letzten Systemen standen: Schlechte Wartbarkeit, mangelhafte Testbarkeit, komplizierte Releaseprozesse und Probleme in der Produktion, welche aufgrund komplexer Codestrukturen und unvollständiger Dokumentation nur schwer gelöst werden können. Und nun? Wir haben den Ausweg aus diesem Teufelskreis.

In diesem Workshop zeigen wir Ihnen nicht, wie wir langweilige Dokumentation schreiben, die bereits beim Erstellen schon wieder veraltet ist. Stattdessen wissen Sie nach dem Workshop, wie Sie Ihre Architekturdokumentation mit technischen Finessen lebendig und aktuell halten, um langfristig davon zu profitieren. Sie lernen Mittel und Wege – wie Arc42 und jQAssistant – kennen, um Softwaresysteme rund um Qualitätsziele und Fachlichkeit nachhaltig zu entwerfen, umzusetzen und vor dem Verfall zu sichern.

Lassen Sie uns gemeinsam den Traum vom perfekten System für Neu- und Bestandssysteme verwirklichen.

Zielgruppe

Wer sollte teilnehmen?

Alle Entwickler und Architekten, die wissen möchten, wie sie Architektur und Dokumentation richtig und nachhaltig mit modernen Tools im eigenen Projekt umsetzen können. Dabei profitieren sowohl Neu- als auch Bestandsprojekte maximal von den übertragbaren Vorlagen, Methoden und Tools.

Vorkenntnisse und Anforderungen

Was wird benötigt?

  • sicherer Umgang mit einer IDE und Git
  • solides Wissen über Java
  • eigenes entwicklungsgeeignetes Notebook mit IDE

Inhalte

Der zweitägige Workshop erarbeitet am Beispielprojekt ausgehend von fachlichen Anforderungen unterschiedliche Dokumentations- und Codeartefakte und zeigt, wie sich diese zwei Welten miteinander optimal verbinden lassen. Konkrete Inhalte sind:

Entwurf und Dokumentation der fachlichen Architektur

  • Verstehen fachlicher Anforderungen und Use Cases
  • Entwurf und Dokumentation fachlicher Dekompositionen der Problemdomäne
  • Ansätze u. a.: Domain Storytelling, Context Mapping, Event Storming

Entwurf und Dokumentation der technischen Architektur

  • Identifikation von Qualitätszielen und Ableitung technischer Anforderungen aus diesen
  • Entwurf und Dokumentation der Architektur auf verschiedenen Abstraktionsebenen
  • Definition relevanter Architekturkonzepte und -regeln
  • Ansätze u. a.: ISO 25010, C4-Model, PlantUML

Kommunikation der Architektur

  • Festhalten getroffener Entscheidungen und Gründe für diese
  • Erarbeitung von Entwicklungsrichtlinien zur konsistenten und korrekten Umsetzung der Architektur
  • Ansätze u. a.: Arc42, Architecture Decision Records, Architekturexpliziter Code

Abgleich von Soll- und Ist-Architektur zur Vermeidung von Abweichungen

  • Anreicherung der Dokumentation um Möglichkeiten zur Validierung der Implementierung gegen den dokumentierten Soll-Zustand
  • Generierung von Dokumentation auf Basis tatsächlich implementierter Strukturen
  • Ansätze u. a.: Lebendige Dokumentation, jQAssistant

Ihr Ansprechpartner

Abbildung: Stephan Pirnbaum

Ihr Ansprechpartner

Stephan Pirnbaum

Telefon: +49 351 3209230
E-Mail: stephan.pirnbaum@buschmais.com