Seminar | Softwaredokumentation mit Docs as code

Erlerne die Erstellung und Verwaltung von Softwaredokumentation mittels Docs-as-Code-Ansätzen.

Dauer

4 halbe Tage

Preis

1.649,- Euro zzgl. Mwst.

Jetzt Buchen

Die nächsten Termine:

Jeweils von 09:00 Uhr bis 13:30 Uhr (online)

Termin 3 | 2025

08.-11.12.2025
Termin 1 | 2026

23.-26.03.2026
Termin 2 | 2026

20.-23.07.2026
Termin 3 | 2026

05.-08.10.2026

Hier geht’s zur Anmeldung

Infos
Benefits
Ablauf
Downloads
FAQ

Welches Level ist dieser Kurs?

Dieses Seminar befindet sich auf Level 2 und richtet sich an Fortgeschrittene, die bereits Erfahrung in der Softwaredokumentation haben und nun lernen möchten, wie sie moderne Docs-as-Code-Praktiken anwenden, um ihre Dokumentation effizienter und skalierbarer zu gestalten.

Worum gehts?

In diesem Seminar geht es darum, wie du Softwaredokumentation nach dem Docs-as-Code-Ansatz erstellst und verwaltest. Du lernst, Dokumentation direkt im Code-Repository zu integrieren, um sie nahtlos mit der Entwicklung zu verzahnen. Der Fokus liegt auf Automatisierung, Versionskontrolle und dem Einsatz moderner Tools, um eine kontinuierliche Dokumentationsqualität sicherzustellen.

Welche Lektionen gibt es?

Einführung in Docs-as-Code:
- Was ist Docs-as-Code?
- Warum ist es relevant in der modernen Softwaredokumentation?
- Vorteile gegenüber traditionellen Dokumentationsmethoden
Grundlagen und Prinzipien
- Einsatz von Git für Dokumentationszwecke
- Pull Requests, Branching und Merge-Strategien
- Continuous Integration (CI) und Continious Deployment (CD) für Dokumentation
- Automatisierte Tests und Builds für Dokumentation
Tools und Technologien
- Markdown, reStructuredText, AsciiDoc
- Vergleich und Auswahl der geeigneten Sprache
- Dokumentationsgeneratoren: Sphinx, MkDocs, Jekyll – Einsatz und Konfiguration der Tools
- Versionskontrollsysteme: GitLab, GitHub, Bitbucket – Einrichtung und Verwaltung von Repositories
Praktische Anwendung
- Schritt-für-Schritt-Anleitung zur Erstellung einer Dokumentation von Grund auf
- Aufbau einer Pipeline für automatisierte Builds und Deployments
- Strukturierung und Organisation von Dokumentationsprojekten
- Wartung und Pflege von Dokumentation

Für wen ist der Kurs geeignet?

Dieses Seminar ist ideal für Technische Redakteur:innen, Entwickler:innen und Dokumentationsspezialist:innen, die bereits Erfahrung mit Softwaredokumentation haben und moderne, effiziente Ansätze zur Dokumentationserstellung erlernen möchten. Es richtet sich an alle, die die Vorteile des Docs-as-Code-Ansatzes nutzen wollen, um ihre Dokumentationsprozesse enger mit der Softwareentwicklung zu verknüpfen und durch Automatisierung und Versionskontrolle zu optimieren.

Die vorteile unserer Seminare auf einem Blick

Direkt anwendbares Wissen

Unsere Online-Seminare liefern dir nicht nur relevante Theorie, sondern auch praxisnahes Know-how, das du sofort in deinem Arbeitsalltag einsetzen kannst.

Interaktive Live-Sessions

Du bist aktiv dabei und kannst direkt Fragen stellen, diskutieren und von den Erfahrungen der Trainer:innen und anderen Teilnehmenden profitieren

Effizientes Lernen in Kleingruppen

Unsere Kurse bestehen aus maximal 12 Teilnehmenden, um ein effizientes Lernen zu ermöglichen und auf alle Fragen eingehen zu können.

Vom Raketenstart bis hin zur Mondlandung: So laufen unsere Seminare ab

Schritt 1

Für den Raketenstart anmelden

Melde dich zu einem für dich passenden Termin per Online-Formular zum Seminar an. Du erhältst dann von uns eine Anmeldebestätigung sowie den Zugangslink zum Kurs via Outlook.

Schritt 2

Am Seminartag per Teams einloggen

An den Seminartagen meldest du dich morgens pünktlich per Teams an. Wir machen ca. alle 90 Minuten eine kurze Pause, um sich zu erfrischen und mit neuer Energie durchzustarten.

Schritt 3

Teilnahmebestätigung & Feedback erhalten

Nach dem Seminar erhältst du deine Teilnahme-bescheinigung, die du stolz in deine Firma präsentieren kannst. Außerdem bitten wir dich um ein kurzes, anonymes Feedback.

Schritt 4

zum aufbauseminar anmelden

Um deine Skills und dein Wissen noch weiter auszubauen, empfehlen wir dir direkt mit einem Aufbauseminar weiter-zumachen. So wirst du zum richtigen Profi!

Brauchst du noch mehr Infos?

Hier haben wir dir noch ein paar Downloadmaterialien zusammengestellt:

Jetzt Herunterladen

Jetzt Herunterladen

Good-to-know

Docs-as-Code beschreibt einen modernen Ansatz zur Erstellung und Pflege von Softwaredokumentation, bei dem Dokumentation mit denselben Werkzeugen, Workflows und Prinzipien behandelt wird wie der Quellcode selbst. Das bedeutet, dass Inhalte in Textformaten wie Markdown, AsciiDoc oder reStructuredText geschrieben, in Versionskontrollsystemen wie Git verwaltet und über automatisierte Prozesse veröffentlicht werden. Ziel ist es, die Dokumentation eng in den Entwicklungsprozess zu integrieren, damit sie jederzeit aktuell, nachvollziehbar und effizient bearbeitbar ist.

In agilen und DevOps-orientierten Teams verändert sich Software kontinuierlich – Dokumentation muss mit dieser Geschwindigkeit Schritt halten. Der Docs-as-Code-Ansatz ermöglicht genau das: Durch Versionskontrolle, Branching, Pull Requests und Continuous Integration wird die Doku automatisch geprüft, versioniert und veröffentlicht. So wird die Qualität der Dokumentation messbar, Prozesse werden skalierbar und das Risiko veralteter Inhalte sinkt erheblich. Gleichzeitig erleichtert dieser Ansatz die Zusammenarbeit zwischen Entwickler:innen und Technischen Redakteur:innen.

Der größte Vorteil liegt in der Integration. Dokumentation wird kein nachgelagerter Schritt mehr, sondern Teil des Entwicklungszyklus. Änderungen sind transparent, nachvollziehbar und versioniert. Es lassen sich Review-Prozesse etablieren, die Fehler frühzeitig aufdecken. Inhalte sind durch strukturierte Formate leichter wiederverwendbar, automatisch testbar und für verschiedene Ausgabekanäle generierbar. Besonders bei technischen Produkten mit hoher Änderungsfrequenz verbessert sich dadurch nicht nur die Effizienz, sondern auch die Nutzerfreundlichkeit der Doku.

Die Einführung beginnt mit einem Kulturwandel: Dokumentation wird nicht länger als „notwendiges Übel“ betrachtet, sondern als integraler Bestandteil der Produktqualität. Unternehmen sollten klare Prozesse definieren, ein zentrales Repository für Dokumentation einrichten und geeignete Tools auswählen. Schulungen und Guidelines helfen, dass alle Beteiligten effektiv mitarbeiten können. Wichtig ist ein iterativer Einstieg: Zunächst mit einem Pilotprojekt, dann schrittweise skalierend – idealerweise mit Unterstützung durch erfahrene Berater:innen oder Fortbildungen.

Herausforderungen liegen vor allem in der Umstellung von bisherigen Arbeitsweisen. Wer aus klassischen DTP- oder CMS-Umgebungen kommt, muss sich mit textbasiertem Arbeiten, Git und Build-Prozessen vertraut machen. Auch die Toolauswahl kann komplex sein – nicht jedes Tool passt zu jedem Projekt. Zudem erfordert Docs-as-Code eine enge Abstimmung zwischen Redaktion, Entwicklung und ggf. DevOps. Doch der Aufwand lohnt sich: Nach der Einarbeitung überwiegen fast immer die Effizienzgewinne und die höhere Qualität der Doku.

Besonders geeignet ist der Ansatz für technische Produkte mit häufigen Änderungen, komplexer Codebasis oder vielen Stakeholdern – etwa Softwareplattformen, Developer-Dokumentationen, APIs, Microservices oder Open-Source-Projekte. Aber auch klassische Produktdokumentationen profitieren von Automatisierung, Versionierung und gemeinsamer Pflege. Letztlich ist Docs-as-Code überall dort sinnvoll, wo Teams effizient und konsistent dokumentieren möchten – unabhängig davon, ob sie agil, hybrid oder klassisch organisiert sind.