Dokumentationen in der Software-Entwicklung

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

Anders als bei Geräten, Maschinen, Automobilen usw. sind Dokumentationen von Software immer auch deren Teil. Sicherlich gibt es gedruckte Handbücher, aber bei der Arbeit mit der Software ist es bequemer, im Arbeitsprozess schnell auf ein aktuelles Kapitel der Software-Dokumentation zuzugreifen, das sich direkt auf diesen Arbeitsprozess bezieht, anstatt umständlich und zeitaufwendig in einem dicken Wälzer zu schmökern, der u.U. ein unzureichendes Schlagwortregister aufweist.


Eine solche kontextsensitive Online-Hilfe ist zwar kein Ersatz für die komplette Benutzerdokumentation, aber eine Unterstützung des Nutzers unmittelbar dort, wo dieser Hilfe benötigt, und daher von hohem Stellenwert.

Die Benutzerdokumentationen von Software liegen oft in unterschiedlichen Varianten vor:


Installationsdokumentation

Sie wird benötigt, wenn – in der Regel durch Administratoren usw. - eine komplexere Software auf einem Arbeitsplatzrechner oder in einem Netzwerk eingerichtet werden muss. Von einer Installation durch einen IT-Laien wird gewöhnlich abgeraten, weil er die Tragweite von Parametern, die bei der Installation einzustellen sind, nicht abschätzen kann.


Standardsoftware – z.B. ein Bildbearbeitungs- oder Textverarbeitungsprogramm – benötigt meist keine spezielle IT-Ausbildung. Die Parameter, die anzugeben sind, erschließen sich sofort, etwa die Wahl der Sprache, bei umfangreicheren Software-Paketen die Abwahl nicht benötigter Module. Moderne Anwendungen werden in der Regel mit eigenem Installationsprogramm installiert, die die Betriebssystemversion, den verfügbaren Plattenplatz, den Installationsort usw. selbständig abprüfen. Hier beschränkt sich eine Installationsdokumentation, sofern sie überhaupt als eigenständiges Dokument - meist im PDF-Format - vorliegt, auf Angaben zu den Systemvoraussetzungen für die einwandfreie Lauffähigkeit des Programms und ähnliches.


Bemühungen um eine "intuitive" Bedienbarkeit von Software haben letztlich zum Ziel, alles vor dem Nutzer zu verstecken, was nicht direkt mit der produktiven Verwendung der Software zu tun hat. Software, die ausschließlich von Experten oder Sachbearbeitern verwendet wird, bedarf solcher Gestaltungsüberlegungen nicht. Hier kommt es darauf an, sich wiederholende funktionelle Abläufe so zu gestalten, dass sie zeitoptimiert durchgeführt werden können, ohne dass die Qualität der Arbeit vermindert wird.

Einführungsdokumentation

Sie ist vor allem für Benutzer wichtig, die die Software zum ersten Mal benutzen oder wenn die Benutzeroberfläche der Software gegenüber der Vorversion drastisch geändert wurde (Beispiel: Umstieg von Microsoft Office 2003 auf 2007, mit dem als neue Benutzerphilosophie das Ribbon-Konzept eingeführt wurde).


Für Benutzer, die noch nie ihre Fotos mit einem Bildbearbeitungsprogramm bearbeitet haben, ist der Zugang zu einer Software wie Paint Shop Pro oder Photoshop zusätzlich fachlich erschwert. Sie müssen überhaupt erst einmal in die Welt der Bildbearbeitung, wenn nicht sogar der Fotografie hineinfinden.


Meistens legen die Software-Firmen ihrer Standardsoftware keine ausführliche Einarbeitungsdokumentation bei. Diese beschränkt sich auf die Einführung der Funktionalität der Software. Um sich auch fachlich in das Gebiet einzuarbeiten, wird dem Nutzer die Anschaffung von Tutorien empfohlen, wie sie in Buchform auf dem Markt vorhanden sind.


Außerhalb der Welt der Massen-Standardsoftware existiert die Welt der fachlichen Spezialsoftware, darunter auch solche, die den Rang von Standardsoftware hat (z.B. SAP-Produkte, CAD-Programme, CRM-Produkte). Die meisten dieser Software-Produkte werden von professionellen Bedienern verwendet, die in speziellen Schulungen in den Gebrauch eingewiesen wurden. Aber auch sie benötigen Nachschlagewerke.


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


[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.