Beirat Online-Events: Docs as Code verständlich erklärt – und live erlebt!

Ein praxisnaher Einstieg in die Arbeitsweise der Zukunft

Was genau verbirgt sich hinter dem viel zitierten Begriff „Docs as Code“? Wann ist dieser Ansatz sinnvoll und wie sieht der konkrete Arbeitsprozess für Technische Redakteurinnen und Redakteure aus? Diesen Fragen widmete sich die gut besuchte Online-Veranstaltung „Docs as Code verständlich erklärt – und live erlebt!“, die am 16. September 2026 als Teil der tekom-Online-Reihe „Docs as Code“ stattfand. Referentin Elena Schweden (Hochschule Karlsruhe) gelang es, den Teilnehmenden in einem interaktiven Gesprächsformat die Grundlagen dieser Methode praxisnah und nachvollziehbar zu vermitteln.

Ein Gespräch auf Augenhöhe statt eines Folienvortrags

Das erklärte Ziel der Veranstaltung war es, Einsteigerinnen und Einsteigern die Scheu vor dem Thema zu nehmen. Statt einer reinen Präsentation entspann sich ein lebendiger Dialog, bei dem die Fragen und der Wissensstand des Publikums im Mittelpunkt standen. Die Referentin beantwortete dabei nicht nur die im Vorfeld eingereichten Fragen, sondern ging auch auf die zahlreichen Anmerkungen ein, die während der Veranstaltung im Chat aufkamen. Dieser rege Austausch, bei dem sich die Teilnehmenden auch gegenseitig unterstützten, trug maßgeblich zur positiven und lernförderlichen Atmosphäre bei.

Der Kern des Ansatzes: Dokumentation wie Software behandeln

Zu Beginn brachte Elena Schweden das Grundprinzip auf den Punkt: Bei „Docs as Code“ wird die Dokumentation exakt so wie Software-Quellcode behandelt. An die Stelle von spezialisierten Redaktionssystemen treten einfache Textdateien, die in einer leicht erlernbaren Auszeichnungssprache wie reStructuredText (RST) oder AsciiDoc verfasst werden. Die Verwaltung dieser Dateien erfolgt über ein Versionskontrollsystem wie Git, was eine lückenlose Nachverfolgung aller Änderungen ermöglicht. Die eigentliche „Magie“ entfaltet sich am Ende des Prozesses: Eine automatisierte Pipeline übernimmt die Erstellung der finalen Dokumente – seien es HTML-Webseiten oder PDF-Dateien.

Live-Demo: Der Redaktionsprozess Schritt für Schritt

Im Zentrum der Veranstaltung stand eine umfassende Live-Demo, die den gesamten redaktionellen Arbeitszyklus von der Idee bis zur Veröffentlichung abbildete. Anhand eines Beispielprojekts, das mit dem weit verbreiteten Werkzeug Sphinx umgesetzt wurde, konnten die Teilnehmenden jeden Schritt live nachvollziehen.

1. Der Ausgangspunkt: Das Repository auf GitHub
   Ausgangspunkt war ein zentrales Projekt-Verzeichnis, ein sogenanntes Repository, auf der Plattform GitHub. Elena Schweden zeigte, wie man dort zu Beginn einer Bearbeitung eine eigene Arbeitskopie, einen „Branch“, anlegt, um Änderungen sicher und isoliert vom Hauptbestand vornehmen zu können.
2. Die Bearbeitung: Im Editor der Wahl
   Anschließend wechselte die Referentin in eine lokale Entwicklungsumgebung (Visual Studio Code). Sie demonstrierte eindrucksvoll, dass für die Bearbeitung der Textdateien keine Kommandozeilen-Kenntnisse notwendig sind. Stattdessen wurden alle Aktionen wie das Synchronisieren mit dem Online-Repository über grafische Schaltflächen ausgeführt. Eine Live-Vorschau zeigte dabei stets die formatierte Ansicht des Dokuments direkt neben dem Quelltext.
3. Die Freigabe: Das digitale Vier-Augen-Prinzip
   Nachdem eine Änderung vorgenommen war, wurde der Kern des kollaborativen Arbeitens gezeigt: der Review-Prozess. Über einen sogenannten „Pull Request“ auf GitHub wurde eine andere Person zur Überprüfung der Änderungen eingeladen. Die übersichtliche Darstellung, bei der Ergänzungen grün und Löschungen rot markiert werden, machte den Vorteil dieses digitalen Vier-Augen-Prinzips sofort deutlich.
4. Die Automatisierung: Von der Freigabe zur fertigen Webseite
   Nach der Freigabe der Änderungen folgte der letzte, entscheidende Schritt. Durch das Zusammenführen des Arbeits-Branches mit dem Hauptbestand wurde im Hintergrund vollautomatisch eine Pipeline angestoßen. Diese übernahm den Bau der Dokumentations-Webseite und deren Veröffentlichung, ohne dass ein weiterer manueller Eingriff nötig war.

Fazit und Ausblick

Die Veranstaltung bot einen hervorragenden und praxisorientierten Einstieg in die Arbeitsweise von Docs as Code. Insbesondere die Live-Demo machte den Prozess greifbar und nahm vielen Teilnehmenden die Berührungsängste mit den zugehörigen Werkzeugen. Die abschließende, angeregte Diskussion zeigte das hohe Interesse an der strategischen Einordnung des Ansatzes, insbesondere im Vergleich zu klassischen Component-Content-Management-Systemen. Themen wie Wiederverwendung, Übersetzungs-Workflows und die Anbindung von Terminologie-Datenbanken wurden als zentrale Punkte für weiterführende Veranstaltungen identifiziert.

Weiterführende Links

• Die gezeigte Beispielseite:
  https://docs-as-code-demo.readthedocs.io/en/latest/
• Das dazugehörige Repository:
  https://github.com/abcbridge/docs-as-code-demo
• Docs-as-Code Guide:
  https://www.writethedocs.org/guide/docs-as-code/
• Docs-as-Code - klingt nur kompliziert:
  https://technischekommunikation.info/fachartikel/online-information/docs-as-code-klingt-nur-kompliziert-1183/