Download als PDFSchulung: Moderne Softwarearchitekturdokumentation

Kurs-IDDauerPreisNächste TermineVeranstal­tungsortDFG
EADOC2 Tage1.500 EUR27.05. - 28.05.2019
30.09. - 01.10.2019
Mannheim
Mannheim

Preise pro Person zzgl. MwSt., Inhouse Seminare auf Anfrage.

Seminarbeschreibung

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.

Kurs-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

Zielgruppe

Softwarearchitekten, Projektleiter, Entwickler

Voraussetzung für Seminar-Teilnahme

Grundlegende Kenntnisse in der Softwarearchitektur und der Entwicklung von Anwendungen.

Seminar-Dauer

2 Tage, 1. Tag 10:00 bis 17:00 Uhr, Folgetag(e) 9:00 bis 16:30 Uhr

Teilnehmerzahl

min. 1, max. 8 Personen

Vorteile einer Seminar-Teilnahme

  • Erfahren Sie, wie man schlank und doch effizient dokumentiert
  • Probieren Sie aus, wie man Dokumentationen optimal in den Entwicklungsprozess integriert
  • Wir zeigen, wie man Dokumentation aktuell hält und regelmäßig validiert
  • Unsere Kurs-Unterlagen sind immer auf dem aktuellsten Stand

Termine für Seminar: Moderne Softwarearchitekturdokumentation

Seminar-TerminDauerDFGOrtPreisSeminar-Anmeldung
27.05. - 28.05.20192Mannheim1.500 EUROnlineFax
30.09. - 01.10.20192Mannheim1.500 EUROnlineFax

Preis pro Person zzgl. MwSt. inkl. Unterlagen, Zertifikat, Tagesverpflegung, Getränke, Obst und Snacks.

Inhouse-Kurse

Alle unsere Seminare können wir Ihnen auch für eine Durchführung in Ihrem Hause anbieten. Hierbei können die Inhalte aller unserer Seminare beliebig für Ihr individuelles Training zu einem Wunschseminar zusammengestellt werden.

Rabatte, Durchführungsgarantie und AGBs

Wir beraten Sie gern
Infomail
Anja Fassott
+49 621 71839-12
Offene Termine
27.05. - 28.05.Anmelden
30.09. - 01.10.Anmelden
   
Fax-Formular:Anmelden

✱  Durch­führungs­garantie

Inhouse Kurse
Alle Seminare sind auch Inhouse möglich.
Einzelschulung
Sie wollen die volle Aufmerksamkeit?!
In unseren Einzelschulungen haben Sie den Trainer ganz für sich alleine.
Zum Geschaeftsbreich Competence Center
Schulung
Interessieren könnten Sie auch unsere Seminare Architektur Katas zum Training agiler Teams oder Java im Web für Architekten.

Service

Competence Center

Schulung