Neu im Programm: Documentation-as-Code mit Falk Sippach Mehr

Documentation-as-Code

Training Softwarearchitekturdokumentation praktisch mit Entwicklerwerkzeugen umsetzen - 2 Tage

Termine und Buchung

Beschreibung

Architektur-Dokumentation wird sehr oft stiefmütterlich behandelt. Dabei unterstützt das Dokumentieren bei der Entwurfsarbeit, schafft Transparenz bzw. Leitplanken für die Umsetzung, Wartung und Bewertung der Softwarearchitektur. Einerseits ist es aber nicht einfach, die wichtigen Informationen aus dem Entwurf der Softwarearchitektur strukturiert und leicht verständlich festzuhalten. Andererseits enden die meisten Versuche, auf der Suche nach einer praktikablen Handhabung zur Erstellung und Pflege, in der WYSIWYG-Hölle einer Textverarbeitung oder im tiefen Schlund eines Wikis. Dieses Seminar zeigt aufbauend auf leichtgewichtigen Tools und Textformaten die Erstellung einer möglichst redundanzfreien Dokumentation, die für verschiedene Zielgruppen optimiert und in ansprechenden Formaten kontinuierlich ausgeliefert werden kann.

Agenda

  • Einführung in Documentation-as-Code und das Fallbeispiel
  • Aufgabenstellung und Rahmenbedingungen festhalten
  • Qualitätsziele und -szenarien dokumentieren
  • Kontextabgrenzung graphisch aufbereiten
  • Entscheidungen treffen, festhalten und Lösungsansätze bzw. Konzepte dokumentieren
  • Aufzeigen der fachlichen Zerlegung in der Bausteinsicht
  • Darstellen von Schnittstellen in der Laufzeit- und Verteilungssicht
  • Weiterführende Themen wie Microsites und Im- und Export-Format

Dein Nutzen

Moderne, effektive und pragmatische Dokumentation der Softwarearchitektur

Einfache Erstellung und Pflege dank leichtgewichtiger Werkzeuge

Optisch ansprechende und leicht zu pflegende Diagramme und Grafiken

Zielgruppenorientiertes Kombinieren von redundanzfreien und generierten Inhalten

Importieren von Informationen aus bestehenden Quellen und Export in Dokumenten-Management-Systeme

Einbinden der Dokumentationserstellung in die kollaborativen Softwareentwicklungsprozesse

Kontinuierliche Auslieferung der stets aktuellen Dokumentation

Austausch zu aktuellen Trends bei den Tools und den Markup-Sprachen

Zielgruppe

Dieser interaktive Workshop richtet sich an alle, die Softwarelösungen qualitativ hochwertig dokumentieren wollen und einen technischen Background haben. Also Entwickler:innen, Architekt:innen und auch Produktverantwortliche. 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

Einsetzen leichtgewichtiger Text- und Grafikformate, nahtloses Einbinden in den Entwickler-Werkzeugkasten

Einbinden der Dokumentationserstellung in das automatisierte Build-Management

Erstellen aussagekräftiger Diagramme und Grafiken

Regelmäßiges Ausgeben der Dokumentation, orientiert an Zielgruppen und in flexiblen Formaten

Vermeiden von Redundanzen, Generieren von Dokumentation aus dem Quellcode und Modellen

Einsammeln und Einarbeiten von Feedback sowie nahtlose Integration in die Software-Entwicklungsprozesse

Deine Trainer:innen

Falk Sippach

Architekturbewertungen, Java Experte

Online-Termine

Termine auf Anfrage

Vor-Ort-Termine

Event-Ticketing-Software von pretix

Inhouse Training

Du kannst dieses Training auch als Inhouse-Training exklusiv für Dein Team buchen. Bitte nutze dafür unser Anfrage-Formular.

Jetzt anfragen