22. Januar 2020 | Regionalgruppe Baden

Dokumentation automatisiert aus Quellcode erstellen

Veranstaltungsinformationen | Anmeldung

Neue Softwarefunktionen können Anwendern bereits nach Zwei-Wochen-Sprints zur Verfügung gestellt werden, wenn Software agil entwickelt wird. Um die Technische Dokumentation, die sich ständig ändert, auf dem aktuellen Stand zu halten, bieten sich Methoden für eine effiziente und zeitnahe Erstellung an. Technische Redakteure können den Aufwand für die Dokumentationserstellung verringern, indem sie vorhandene Inhalte wiederverwenden. So können zum Beispiel Informationen erneut genutzt werden, die im Quellcode einer Software enthalten sind. Dies hat den Vorteil, dass Informationen für die Technische Dokumentation nur einmal recherchiert und verifiziert werden müssen.

Bei einigen hundert bis tausenden Inhaltsbausteinen für eine Softwaredokumentation besteht bei der manuellen Inhaltserstellung die Herausforderung, den Überblick zu behalten und das erforderliche Personal bereitzustellen. Automatisierte Prozesse können die Arbeit von Technischen Redakteuren unterstützen und den manuellen Aufwand reduzieren. Dies ist möglich, wenn Inhalte bereits strukturiert vorliegen. Eine automatisierte Verarbeitung hat zudem den Vorteil, dass Skripte die Arbeit in reproduzierbarer Qualität wiederholen. Insgesamt spart Automatisierung Zeit, reduziert Kosten und sichert die Qualität und Konsistenz der Dokumentation.

Die Teilnehmer erfahren, wie Dokumentation automatisiert aus Quellcode erstellt werden kann. Verschiedene Lösungsansätze und die Herausforderungen werden vorgestellt. Anhand einer praktischen Vorführung wird gezeigt, wie Redakteure automatisiert Dokumentation aus Quellcode erstellen können. Die Teilnehmer lernen, welche Prozesse und Systeme dazu erforderlich sind. Sie sehen die Vorgehensweise, vom Verarbeiten des vorhandenen Quellcodes bis hin zur Ausgabe der fertigen Dokumentation.

Der Referent Christian Gödert ist Technische Redakteur (M.Sc.). Er studierte Technikjournalismus an der Hochschule Bonn-Rhein-Sieg, außerdem Kommunikation und Medienmanagement an der Hochschule Karlsruhe. Derzeit ist er Leiter der Technischen Dokumentation bei der simus systems GmbH mit Sitz in Karlsruhe. Er ist für die agile Erstellung von Softwaredokumentation verantwortlich und optimiert Dokumentationsprozesse. Sein Spezialgebiet ist die automatisierte Dokumentationserstellung aus Quellcode.