Moderne Softwarearchitekturdokumentation
Man kann zwar an vielen Stellen nachlesen, wie man Architekturdokumentation strukturiert. Aber auf der Suche nach einer praktikablen Handhabung zur Erstellung und Pflege enden die meisten Versuche in der WYSIWYG-Hölle einer Textverarbeitung oder im tiefen Schlund eines Wikis. Dieses Seminar zeigt aufbauend auf bestehenden Tools und Textformaten die Erstellung einer möglichst redundanzfreien Dokumentation, die für verschiedene Zielgruppen optimiert in ansprechenden Formaten ausgeliefert werden kann.
Anhand von vielen praktischen Übungen geht es um Begriffe wie Continuous Documentation und Documentation as Code. Das Ziel ist die moderne, effektive und pragmatische Dokumentation von Softwarearchitektur, das Generieren von Inhalten aus dem Modell, Datenbankschema und Sourcecode, die strukturierte Ablage inklusive Versionier- und Historisierbarkeit und die Verwendung bzw. Erstellung von aussagekräftigen und einfach wartbaren Grafiken.
Agile Entwicklungsteams können so die Dokumentationsarbeit in ihre täglichen Aufgaben integrieren und jederzeit aktuelle, umfassende und gut strukturierte Dokumente ausliefern. Zudem lässt sich die Erstellung der Dokumentation in den Reviewprozess integrieren und so stetig verbessern und weiterentwickeln.
Dauer
2 Tage
Ziel
- Erfahre, wie man schlank und doch effizient dokumentiert
- Probiere aus, wie man Dokumentationen optimal in den Entwicklungsprozess integriert
- Wir zeigen, wie man Dokumentation aktuell hält und regelmäßig validiert
Zielgruppe
Softwarearchitekten, Projektleiter, Entwickler
Inhalt
Einführung
- Vorgehensweisen und Sichten
- Probleme mit klassischen Dokumentationsansätzen
- Strukturierung von Architekturdokumentation (arc42)
Leichtgewichtige Markupsprachen
- Markdown
- AsciiDoc
- Integration von Templates (Corporate Design)
- Werkzeuge zur Erstellung und Voransicht
Documentation as Code
- Ablage im Code-Repo
- Integration in die tägliche Entwicklungsarbeit
- Versionierung und Historisierung
Continuous Documenation
- Automatisierung
- Build-Management
- Dokumentations-Workflow
- Dokumentations-Reviews
Einbetten und Generieren von Inhalten
- Beschreibung von APIs
- Einbetten von Sourcecode
- Generieren von Inhalten
- Erstellung von Präsentationen
- Validierung der generierten Inhalte
Einbetten von Grafiken
- Werkzeuge zur Erstellung von Grafiken
- Textbasierte Grafiken mit PlantUML, ditaa und Graphviz dot
- Einbetten in Markup-Sprachen
- Generieren von Diagrammen
Lebendige Dokumentation
- Effektive Erstellung
- Ausführbare Dokumentation
- Testen der APIs
- Testen und Dokumentieren von Architekturregeln
Fazit und Ausblick
- Rolle Dokumentationsverantwortlicher
- Nutzungsszenarien
- Integration mit Wikis/Blogs
- Best Practices
Voraussetzungen
Grundlegende Kenntnisse in der Softwarearchitektur und der Entwicklung von Anwendungen.
OIO Training

OIO Orientation in Objects GmbH, das Expertenhaus für Java und JavaScript aus Mannheim, gehört seit Mai 2018 zur Trivadis Gruppe. Gemeinsam stärken und erweitern wir unser Angebot im Bereich Java und agiler Softwareentwicklung. Dieses Training wurde von OIO entwickelt und wird von den neuen Kollegen abgehalten.
Unser Qualitätsversprechen
Kontakt zu unserem Service Center
+49 (0) 711 90363245
+41 (0) 584 595795
+43 (01) 33 2353160
+41 (0) 584 595454
Ort | Termin | Sprache | Preis | |
---|---|---|---|---|
Inhouse-Trainings auf Anfrage! | Anfrage |
Referenten
Anfrage zum exklusiven Inhouse-Training
Zufriedenheits- & Qualitätsgarantie
Jedes einzelne Training wird bei Abschluss durch die Teilnehmer auf den Ebenen:
- Eignung des Schulungsraumes
- Eignung des Arbeitsplatzes
- Funktionsfähigkeit der technischen Ausrüstung
- Zufriedenheit über den gesamten Kurs / das gesamte Seminar
in unserem Feedbacksystem „TRIVALUATION“ zur Qualitätssicherung erhoben. So stellen wir die hohe Qualität und Zufriedenheit unserer geschätzten Kunden permanent sicher. Wir freuen uns über die Gesamtbewertung von 9,3 von 10 Punkten durch unsere zahlreichen begeisterten Kunden.
Erfolgsgarantie
Trivadis garantiert den Erfolg deines Trainings. Nach deinem Training sind in der Praxis noch weitere Fragen aufgetaucht? Du möchtest einzelne Übungen noch einmal in der Lab-Umgebung wiederholen?
Unsere Erfolgsgarantie gibt dir bis zu 6 Monate nach dem Besuch eines Trainings die Möglichkeit zur kostenlosen Wiederholung einzelner Tage oder des gesamten Trainings. Die Kursunterlagen bringst du einfach vom vorherigen Training selbst mit.