Automatisch zur Doku

Text: Christian Gödert

Das Unternehmen Abusix entwickelt seine Software nach agilen Methoden. Damit die Technische Redaktion Schritt hält, entsteht die Dokumentation direkt aus dem Quelltext. Möglich macht es ein Prozess, der die Informationen aus dem Quelltext über XML nach DITA transformiert.

Inhaltsübersicht

Lesedauer: 11:59 Minuten

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 [1].

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 Quelltext einer Software enthalten sind. Dies hat den Vorteil, dass Informationen für die Technische Dokumentation nur einmal recherchiert und verifiziert werden müssen.

Automatisierung vorteilhaft

Bei einigen hundert bis tausenden Inhaltsbausteinen für eine Softwaredokumentation besteht bei der manuellen Inhaltserstellung die Herausforderung, den Überblick zu behalten und das ...