Schulung Software-Dokumentation mit Sphinx (S1292)

Die Dokumentation von Software muss heutzutage in verschiedenen Ausgabeformaten erstellt werden, um Anwendern sowohl ein gedrucktes Handbuch als auch eine Online-Hilfe zur Verfügung zu stellen. Eine gute Dokumentation gilt als Qualitätsmerkmal von Software und entscheidet nicht selten über den Erfolg eines Projekts. Ähnliche Anforderungen gelten für die Dokumentation zum Beispiel eines Qualitätsmanagementsystems nach ISO 9001 oder eines Information Security Management Systems ISMS nach ISO/IEC 27001:2013. Von Bedeutung ist hierbei auch die Revisionssicherheit, also zum Beispiel die Nachvollziehbarkeit von Änderungen.

Das Dokumentationssystem Sphinx gewährleistet im Zusammenspiel mit dem Versionskontrollsystem Git eine leichtgewichtige Lösung für diese Herausforderungen. Sphinx wurde ursprünglich zur Dokumentation von Python-Programmen entwickelt. Das Open-Source System kann aber auch Programme in anderen Programmiersprachen dokumentieren. Darüber hinaus ist es ganz allgemein als Single-Source Multi-Channel Publishing-Lösung
einsetzbar.