Die Entwicklung einer Forschungssoftware soll angemessen dokumentiert werden. Entwickler:innen sollen ihren Code von Anfang an dokumentieren (z. B. Funktionen beschreiben). Neben der Code-Dokumentation sind folgende Arten von Dokumentationen wesentlich:
eine grundlegende Beschreibung der Ziele und Funktionen der Software
die Erfassung von (standardisierten) Metadaten zur Software
ein Nutzerhandbuch und Einstiegs-Tutorial
ein Entwicklerhandbuch und Installationshinweise
die Dokumentation von Dependencies
Umsetzung
Ausführliche Dokumentation und Beschreibung der Software
Erstellung von (standardisierten) Dokumenten wie README, CONTRIBUTING, LICENSE
Code-Dokumentation je nach Programmiersprache mit Frameworks wie Doxygen, JavaDoc, pydoc
Dokumentation kann mit u. a. KI-Unterstützung generiert werden.
Schnelle Entwicklungen im Bereich der KI führen zu der Annahme, dass in Zukunft umgekehrt Code aus Dokumentation erzeugt werden kann und Code damit einen flüchtigen Charakter erhält. Dadurch verschiebt sich der Fokus bei der Dokumentation, der Code wird zum Nebenprodukt.
Checks können überprüfen, ob Dokumentation existiert, jedoch nicht deren Qualität beurteilen.