Dokumentation von Forschungssoftware

In Leitlinie 12 ist die umfassende Dokumentation von Informationen, die für das Zustandekommen eines Forschungsergebnisses relevant sind, als elementarer Bestandteil guter wissenschaftlicher Praxis verankert. Nachvollziehbarkeit, Reproduzierbarkeit und Replizierbarkeit prinzipiell zu ermöglichen, ist auch bei der Verwendung und Entwicklung von Forschungssoftware ein wichtiges Anliegen. Jede verwendete Forschungssoftware sollte daher umfassend in die Dokumentation der Projektergebnisse einbezogen werden (inkl. Versionsangabe, Parametrisierungen, Test-/Trainingsdatensätze etc.) und entsprechend der fachlichen Gepflogenheiten zitiert werden. Diese Dokumentation sollte in den Forschungsprozess eingebettet und nachvollziehbar sein. Schließlich soll sie mit oder innerhalb der Textdokumentation veröffentlicht werden, damit auch diese Ergebnisse von der wissenschaftlichen Gemeinschaft überprüft werden können.

Es kann Fälle geben, in denen Forschungssoftware aufgrund von fachlichen oder technischen Gründen nur unvollständig dokumentiert werden kann, beispielsweise bei einer Mischung von kommerziellen und selbst erstellten Komponenten oder bei Fällen, in denen eine fast beliebig große Zahl an Beschreibungsparametern genutzt wird. Entscheidend ist in diesen Fällen, dass die in Bezug auf die Forschungsfragestellung relevanten Eigenschaften und Parameter der Software und, wann immer möglich, auch der Quellcode selbst dokumentiert werden.

Damit Dokumentation und Zitation von selbst entwickelter Forschungssoftware gelingen, sollte auf eine möglichst automatisierte und standardisierte Metadatenerstellung geachtet werden. Dazu sollte die Möglichkeit der Verknüpfung mit elektronischen Notiz- bzw. Laborbüchern genutzt und für Software passende Publikationsorgane gewählt werden. Darüber hinaus bietet es sich ab einem höheren Technologielevel, einer größeren Bedeutung für die Nutzer*innen oder einem größeren Umfang an, die Forschungssoftware zu registrieren.