Lerne, wie du als Softwarearchitekt:in im Zeitalter von Coding Agents die Kontrolle behältst.
🔎 Entdecke unser neues Training: Architektur im Kontext Agentischer Entwicklung.
socreatory Training

Documentation-as-Code

Grundlagen
2 Tage
12
Sitze
Deutsch und Englisch
Online und Präsenz
Auf Anfrage verfügbar

Auch als Inhouse-Training

Wir führen dieses Training auch exklusiv für dein Team durch, online oder vor Ort.
Inhouse-Angebote

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

Agenda

  • Einführung in Documentation-as-Code und unser Fallbeispiel
  • Ablage in der Versionsverwaltung
  • Notwendige Werkzeuge und Integration ins Build-Management
  • Einsatz von Markup-Sprachen
  • Modularisierung der Dokumentation
  • Effektive Erstellung von Diagrammen (PlantUML, Kroki.io, Diagrams.net, …)
  • Erzeugung von zielgruppenorientierten Ergebnisformaten
  • Einbinden vorhandener Informationen zur Vermeidung von Redundanzen (Quellcode, Modelle, …)
  • Weiterführende Themen wie Microsites und Im- und Export-Formate

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.

Beschreibung

Architektur-Dokumentation wird sehr oft stiefmütterlich behandelt. Die Gründe dafür sind vielfältig und unter anderem in der Verwendung unpraktikabler Werkzeuge und Formate zu finden. Beim Docs-as-Code-Ansatz wird Dokumentation wie Quellcode behandelt. Dokumente werden in leichtgewichtigen Text- und Grafikformaten erstellt, nahe beim Sourcecode in beispielsweise Git-Repos abgelegt und versioniert sowie in automatisierten Build-Prozessen verarbeitet. Dieses Seminar zeigt aufbauend auf schlanken Tools und Markup-Sprachen die Erstellung einer möglichst redundanzfreien Dokumentation, die für verschiedene Zielgruppen optimiert und in ansprechenden Formaten kontinuierlich ausgeliefert werden kann.

Trainer:innen

Falk Sippach

Softwarearchitekt und Berater bei embarc

Schwerpunkte

Architekturbewertungen, Java Experte

Ralf D. Müller

Trainer bei socreatory

Schwerpunkte

Docs-as-Code, Softwaredokumentation

Mehr zum Thema

Documentation-as-Code (Architektur-Spicker Nr. 15)

Die Verwendung der gleichen Tools und Prozesse wie in der Softwareentwicklung ermöglich dir die effiziente Pflege von Dokumentation. Dieser Spicker erklärt dir die Idee und hilft dir beim Dokumentieren deiner Vorhaben.

Falk Sippach
Stefan Zörner

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

Relevante weitere Trainings

iSAQB® training
Zertifikat

iSAQB® CPSA-A® ADOC

0
Technology
20
Methodology
20
Communication
Grundlagen
Fortgeschritten
2 Tage
12
Sitze
Deutsch und Englisch
Online und Präsenz
ab 1.385,00 €

Häufig gestellte Fragen

Wie viele Teilnehmer:innen sind maximal im Training?

In den meisten Trainings beschränken wir die maximale Zahl an Teilnehmer:innen auf 12 Personen pro Trainer:in. So können wir gewährleisten, dass du bestmöglich betreut wirst.

Gibt es bei Präsenztrainings Verpflegung?

Natürlich ist bei unseren Präsenztrainings für dein leibliches Wohl gesorgt. In der Regel gibt es pro Tag zweimal Snacks und ein Mittagessen. Selbstverständlich stehen auch Getränke für dich zur Verfügung.

Wo finde ich Informationen zu meinem bereits gebuchten Training?

Alle Informationen rund um dein Training findest du in unserem socreatory Navigator.

Hier findest du neben nützlichen Links und Informationen bei Präsenztrainings den konkreten Ort des Trainings und bei Online-Trainings den Link zum Videocall.

Wann und wie bekomme ich nach dem Training meine Teilnahmebestätigung?

Wenn du mindestens 75% der Zeit anwesend warst, erhältst du eine Teilnahmebestätigung von uns. Diese kannst du dir wenige Tage nach dem Training in unserem socreatory Navigator herunterladen.

Warum socreatory?

Neben der Expertise unserer Trainer:innen und dem vielfältigen Trainingsangebot haben wir noch weitere Argumente für den Besuch eines Trainings bei uns.

Alle Vorteile immer zur Hand – lade dir unser Angebot herunter!

Einzigartige Vielfalt

Wir bieten dir das umfangreichste Trainingsangebot für Softwarearchitektur im deutschsprachigen Raum – akkreditiert und zertifiziert vom iSAQB®.

Geballte IT-Kompetenz

Unsere erfahrenen Trainer:innen sind bekannte Größen in der Branche und haben 80 Prozent der Modul-Lehrpläne inhaltlich wie didaktisch mitentwickelt.

Praxisnahes Lernerlebnis

Wir legen größten Wert auf interaktive und begeisternde Wissensvermittlung. Damit alle Teilnehmenden das Erlernte direkt in die Praxis umsetzen können.

Faires Preismodell

Schon ab zwei Teilnehmenden aus deinem Unternehmen reduziert sich der Gesamtpreis. Zudem profitierst du von Early-Bird-Preisen und großer Planungssicherheit.

Suchst du Trainings für dein Team?

Entfalte das Potenzial deines Teams mit unseren spezialisierten Kursen zur Softwarearchitektur. Wir bieten eine Vielzahl von Optionen an, von fundierten iSAQB®-Schulungen bis hin zu maßgeschneiderten Workshops, die genau auf die Bedürfnisse deines Unternehmens zugeschnitten sind. Erfahre, wie diese Trainings die Kompetenzen deines Teams verbessern können, und nutze attraktive Gruppen- und Paketrabatte, um den Nutzen deiner Investition zu maximieren.