Dokumentationen in der Software-Entwicklung Teil 2

[Teil 1 | Teil 2 | Teil 3 | Teil 4 | Teil 5]

Benutzerhandbuch

Diese Dokumentation ist das eigentliche Kompendium, das Nachschlagewerk für alle Arten von Fragen, die während der Arbeit mit der Software auftauchen. Bei professionellen Software-Produkten, z.B. Kompilern für die Software-Entwicklung oder Betriebssystemen, Datenbanken, handelte es sich dann um voluminöse Wälzer in der Regel auf Englisch, da die Hersteller ihren Firmensitz in den USA haben.


Seitdem auf Client-Server-Systemen mit grafischen Benutzeroberflächen gearbeitet wird, liegen die Benutzerhandbücher zum einen als komplette digitale Version, die zu längerer Lektüre einlädt, zum anderen als kontextsensitive Version vor, die bei aktuellen Problemen helfen soll. Für beide Versionen wird derselbe Text verwendet. Eine sehr schöne Möglichkeit der Präsentation komplexer Sachverhalte ist deren Darstellung im Wikipedia-Format. Dieses erlaubt auch größere graphische Anteile als das stark eingeschränkte HELP-Format.


Betriebshandbuch

Betriebshandbücher im Bereich der Software umfassen größere IT-Einheiten, die teils in kleinere unterteilt und untereinander vernetzt sind. Ein klassisches Beispiel ist die Informationstechnik eines Krankenhauses, die aus mehreren Software-Einheiten besteht: das Krankenhaus-Informationssystem mit der Patientendaten-Verwaltung, Radiologie-Informationssystem, Laborinformationssystem usw. Spezialisierte Software für das OP-Management, Intensivmedizin, für Versorgung und Pflege ergänzen den Komplex.


Für die Nutzer dieser Software liegen auf dem hausinternen Netz jeweils Dokumentationen vor, die für jede einzelne Maske des Software-Bausteins genau die Eingaben beschreiben. Um eine solche Dokumentation zu erstellen, sind zusätzlich zu den Qualifikationen eines Technischen Redakteurs vor allem fachliche Kenntnisse gefordert.


Technische Dokumentation

Die Technische Dokumentation einer Software ist bestimmt für die Entwickler, die diese warten und weiterentwickeln sollen. Ihre Basis sind die Kommentare, die in die einzelnen Software-Module, also in den Code, eingebaut werden. Weiterhin beschreibt sie das Zusammenspiel der Module, die Funktionalitäten, das Datenmodell, mit dem die Software arbeitet, die Schnittstellen, über die die Software mit anderen IT-Einheiten kommuniziert.


Datenbank-Dokumentation

Software, die auf umfangreiche Daten in einer Datenbank zugreift, benötigt in der Regel eine Dokumentation dieser Datenbank. Sie kann Teil der Technischen Dokumentation sein oder eine eigene Handbuchkategorie. Ein Krankenhaus-Informationssystem zum Beispiel umfasst meist eine Vielzahl von Datenbank-Tabellen, deren Strukturen, Datentypen, Wertebereiche usw. einer genauen Beschreibung bedürfen. Außerdem muss die Abhängigkeit der Tabellen dokumentiert sein, am besten grafisch an Hand des Entity Relationship Diagramms. Auch diese Art der Dokumentation ist eher für Entwickler sowie für den Datenbank-Administrator bestimmt.


Datenbank- und Technische Dokumentation müssen mit jeder Änderung in der Datenbank oder in Software fortgeschrieben werden.

Die beschriebenen Dokumentationsarten existieren weitgehend neben der Software, auch wenn sie über Hot Keys oder Fragezeichen-Buttons aus ihr erreichbar sind, zumindest die Hilfetexte für den Benutzer.

Weiter über die Dokumentationen in der Software-Entwicklung Teil 3.


[Teil 1 | Teil 2 | Teil 3 | Teil 4 | Teil 5]
Aufsätze zur Sprache
In einer Fachzeitschrift für gesundes Katzenfutter las ich neulich eine Glosse, die die laxe Einstellung eines Teils der schreibenden Zunft zur Rechtschreibreform widerspiegelt:

"Warum ist die Rechtschreibung reformiert worden? -
Um die Zahl der studierfähigen Abgänger der allgemeinbildenden Schulen erhöhen zu können. Die Rechtschreibreform hat einen Teil der Rechtschreibfehler, die Schüler vorher gemacht haben, zur schriftsprachlichen Norm erhoben und damit wegrationalisiert. Jetzt kann jeder, der weiß, wie man einen Kugelschreiber festhält, das Abitur machen und hinterher Journalist werden. Vorsorglich haben die Zeitungen und Zeitschriften schon mal die RSR bei sich eingeführt. Für hartnäckige Fälle gibt es Jobs in der Politik, zum Beispiel im Kultusministerium, oder beim Institut für Deutsche Sprache oder beim Privatfernsehen."

Die Rechtschreibreform wurde und wird leider von fast allen Schriftstellern und der überwiegenden Mehrheit der Sprachwissenschaftler abgelehnt. Nach neusten Umfragen sollen nur 8% der Befragten sich positiv zur Rechtschreibreform geäußert haben, die meisten Bundesbürger verwenden die alte Rechtschreibung - oder keine.

Siehe auch "Die Rechtschreibreform ist endgültig gescheitert".

Die damalige Präsidentin der Kultusministerkonferenz, Johanna Wanka, sagte 2005 dem Spiegel: „Die Kultusminister wissen längst, dass die Rechtschreibreform falsch war. Aus Gründen der Staatsräson ist sie nicht zurückgenommen worden.“ (Wikipedia, Johanna Wanka)
Dem ist nichts hinzuzufügen. Inzwischen wacht die Deutsche Presseagentur über eine einheitliche Schreibweise in Deutschland, in der Schweiz ist die Schweizer Orthographische Konferenz zuständig, an der auch Sprachwissenschaftler beteiligt sind.