Software-Tipps
Software > Software-Tipps > Softwaredokumentation > Programmdokumentation

Offener Quellcode und Programmdokumentation


Ermitteln und Einstufen auf einen offenen Quellcode

Der Quellcode ist ein Programmcode in Form eines für Menschen lesbaren Textes. Er ist in einer bestimmten Programmiersprache1 verfasst und kann in einen für Computer lesbaren Code übersetzt werden.

Der Begriff “Open Source” wird meist zur Kennzeichnung sogenannter freier Software verwendet.2 Im Software-Tipps Bereich zu den Softwarekosten und Benutzerlizenzen finden Sie mehr zum Thema „Open Software Lizenzen“. Mit einem offenen Quellcode ist im Folgenden die reine Einsicht in den Quellcode einer Software zur Dokumentation gemeint. Es bedeutet nicht, dass man diesen Quellcode verändern oder beliebig weitergeben kann.

Vor- und Nachteile von Quellcode zur Dokumentation der Software

Vorteile von offenem Quellcode:

  • Der Quellcode ist die ursprüngliche Form der Software, an der Programmierer direkt arbeiten. Er beschreibt Abläufe, Berechnungen und Verfahren der Software am genauesten.
  • Er schafft Vertrauen, weil auch versteckte Funktionen sichtbar wären
  • Durch Quellcode wird eine gewisse Sicherheit suggeriert, weil man die theoretische Option hat, dass man beim Ausscheiden des Anbieters die Software weiter warten und nutzen kann.
  • Die Aktualität ist im Vergleich zu anderen angefertigten Dokumentationsmitteln höher

Nachteile von offenem Quellcode:

  • Der Quellcode ist nur für Programmierer, welche die betreffende Programmiersprache beherrschen, verständlich. Enthaltene Kommentare müssen nicht zwangsläufig mit dem Programmcode übereinstimmen.
  • Die Herausgabe des Quellcodes ist für die meisten Anbieter eher unüblich, weil die Missbrauchsgefahr groß ist.
  • In der Regel ist der Quellcode so umfangreich und komplex, dass auch ein geübter Programmierer eine lange Einarbeitungszeit braucht, um diesen zu verstehen.
  • Leserlicher und verständlicher beschreiben etwa Datenflusspläne, Entscheidungstabellen, Diagramme, Struktogramme und Formeln die Software.

Die Diskussion um offenen Quellcode wird neuerdings durch eine Vielzahl neuerer mobiler Betriebssysteme und Systemsoftware verstärkt, weil gegenüber diesen zum Teil sehr komplexen Systemen ein gewisses Misstrauen entgegen gebracht wird. Die Uneindeutigkeit der Datenspeicherung (online versus offline), automatische Updates und Auslagerungen in die Cloud mit ständigen Online-Zugriffen werfen Fragen bezüglich des Datenschutzes und der Datensicherheit auf. Offener Quellcode kann hier helfen, die Transparenz und das Vertrauen zu erhöhen. Betriebliche Software und Branchenlösungen sind meist konservativer und folgen nicht unmittelbar jedem Trend, so dass Bedenken bezüglich Datenschutz und Datensicherheit bezüglich verborgener Funktionen eher selten sind.

In den meisten Fällen dürfte der offene Quellcode für den Anwender eine eher unzweckmäßige Form der Programmdokumentation sein.

Geeignetere Dokumentationsmittel sind:

Struktogramme3 und Datenflusspläne

Zur Darstellung von Abläufen eines Computerprogramms eignen sich strukturierte Ablaufpläne wie etwa Struktogramme und Datenflusspläne. Beide Diagrammtypen können grobe Abläufe oder detaillierte Algorithmen übersichtlich darstellen.

Entscheidungstabellen4

Um komplizierte Regelwerke übersichtlich darzustellen, bieten sich Entscheidungstabellen an. Bestimmte Bedingungen werden über Regeln mit bestimmten Aktionen verbunden.

Formeln und Diagramme

Einfache Berechnungen können gut durch mathematische Formeln dargestellt werden. Formeln sollten nachvollziehbar und erklärt sein. Diagramme und Skizzen veranschaulichen Teilbereiche der Software auf anschauliche Art und Weise.

1 z.B. Java, C++, PHP, C/AL, u.v.m.
vgl. auch Wikipedia, Liste von Programmiersprachen, aufgerufen am 29.09.2022
2 vgl. Wikipedia, Open Source, aufgerufen am 29.09.2022
3 vgl. auch Jochen Pellatz, Struktogramme lesen, verstehen und entwickeln, aufgerufen am 29.09.2022
vgl. auch Wikipedia, Nassi-Shneiderman-Diagramm, aufgerufen am 29.09.2022
4 vgl. Bundesministerium des Innern, Entscheidungstabellen, aufgerufen am 29.09.2022
Abkürzungen:
PHP: PHP: Hypertext Preprocessor
u.v.m.: und vieles mehr
vgl.: vergleiche