Hand in Hand

Text: Claudia Sistig

Durch agile Methoden in der Softwareentwicklung werden kurze Reaktionszeiten und Flexibilität wichtig. Wie können die Anforderungen in den Alltag der Technischen Redaktion integriert werden? Eine Lösung ist die Automatisierung der Technischen Dokumentation durch Jenkins-Build-Jobs.

Vor welchen Anforderungen steht die Technische Dokumentation von Softwareprodukten? In den vergangenen Jahren hat die agile Softwareentwicklung viel in Bewegung gesetzt, im wahrsten Sinn. Um die vereinbarten Ziele innerhalb der Entwicklungsphase einzuhalten, muss die Dokumentation zeitgleich mit der Software fertiggestellt werden.

Die enge Verknüpfung von Entwicklung, Softwaretest und Technischer Dokumentation durch die gemeinsame Arbeit in einem Team und die damit entstehenden Abhängigkeiten erfordern die kontinuierliche Integration der Dokumentation in die Software. So lassen sich zeitnahe Tests ermöglichen und jeder Beteiligte hat jederzeit Zugriff auf den aktuellen Stand.

Die regelmäßige Abstimmung mit dem Kunden weckt bei diesem hohe Erwartungen und erfordert zum Beispiel kurze Reaktionszeiten bei neuen oder geänderten Dokumentationsformaten oder zusätzlichen Dokumenten. Beim ...