Praktisches & Grundsätzliches zur Informatik

-- Software Dokumentation: Mindestumfang, Gestaltungsform, Konzeptdokumentation, Test Ergebnis Dokumentation

Was kennzeichnet gute Software-Dokumentation?

Moderne Software-Systeme sind — mindestens aus Sicht ihrer Ersteller und Betreiber — äußerst komplexe Gebilde, die zudem noch ständig korrigiert, erweitert oder einer sich ändernden Umgebung angepasst werden müssen.

Software nach Zweck und innerem Aufbau gut verständlich zu halten

Es lohnt sich somit, darüber nachzudenken, wie Software-Dokumentation nach Umfang, Form und Struktur gestaltet sein muss, um ausreichend nützlich sein zu können, d.h. um die notwendige Fortent­wicklung der Software nicht zu behindern, allzu teuer oder gar unmöglich zu machen.

Notwendiger Umfang akzeptabler Software-Dokumentation


Siehe auch: Was die Rechtsprechung dazu sagt und eine Grundsatzentscheidung.

Wer ein Softwareprodukt entwickeln lässt, sollte darauf achten, dass zusammen mit dem Programm an ihn auch ausgeliefert werden:

Auch Testtreiber als Software-Dokumentation zu sehen, erscheint zunächst ungewöhnlich, macht aber Sinn, da nur über sie der Grad an Fehlerfreiheit feststellbar ist. Ihn erkennen zu können, ist wichtig, da über den ganzen Lebenszyklus der Software hinweg zu starkes Absinken ihrer Fehlerfreiheit möglichst umgehend erkennbar sein muss.

Insgesamt gilt:

Wissenswertes zu "Test Ergebnis Dokumentation, Konzeptdokumentation, Gestaltungsform, -- Software Dokumentation: Mindestumfang" zusammengestellt durch Gebhard Greiter.
tags: Dokumentation1gegreit Testtreiber1gegreit Konzeptdokumentation1gegreit