Softwaredokumentation

Software wird immer komplexer, ihr Aufbau ist oft modular, ihre Funktionen lassen sich individuell konfigurieren, noch dazu lässt sich die Bedienoberfläche an die jeweiligen Bedürfnisse anpassen. Anders als Hardware, die unveränderbar ist, ist Software maximal flexibel. Diese Komplexität und Flexibilität macht die Beschreibung einer Software nicht gerade einfach.

Es ist kaum möglich, die Struktur einer Software in einem klassisch strukturierten Benutzerhandbuch abzubilden. Versucht man es dennoch, verliert man sich in vielen Kapitelebenen, mit der Folge, dass die Informationen nur schwer gefunden werden können. Andere Lösungen sind gefragt.

Die gute Nachricht: Software, die gut gemacht ist, lässt sich einfach, wenn nicht gar intuitiv bedienen. Die Bedienoberfläche gibt genug Hinweise. Felder haben Namen, und diese Namen verraten, welche Eingaben erwartet werden. Zudem ist Software fehlertolerant; eine falsche Eingabe wird von der Software abgefangen, sie gibt dann sogar Hinweise auf den korrekten Wertebereich. Mit anderen Worten: Die Software bringt einen großen Teil ihrer Dokumentation bereits mit, sie ist in Form von Beschriftungen und Symbolen in die Bedienoberfläche integriert. Nur der Rest muss beschrieben werden, das, was nicht offensichtlich ist, was Fragen aufwirft.

Nutzerinnen und Nutzer wollen wissen, was die Software kann, sie möchten das große Ganze verstehen und die Besonderheiten erfahren. Nicht alle Funktionen und Optionen sind auf den ersten Blick ersichtlich, manches versteckt sich in anderen Ebenen, in Kontextmenüs oder Dialogfenstern. Auch Abhängigkeiten sind nicht offensichtlich, etwa wenn sich die Einstellung für einen Parameter auf andere Parameter auswirkt. All das muss beschrieben werden, und zwar so, dass es schnell gefunden werden kann.

Beim Umgang mit Software bildet sich in den Köpfen ein mentales Modell, das nach und nach verfeinert wird. Das mentale Modell versetzt die Anwenderinnen und Anwender in die Lage, sich in der Software zurechtzufinden. Sobald sie den Aufbau verinnerlicht haben, kommen sie ohne Hilfe klar. Aufgabe der Dokumentation ist es daher in erster Linie, die User und Userinnen beim Bilden eines mentalen Modells zu unterstützen und ihnen dadurch schnell zu Erfolgserlebnissen zu verhelfen.

Folgende Aspekte muss die Technische Redaktion bedenken, wenn sie eine Softwaredokumentation erstellt:

  • Egal ob großes Softwarepaket oder kleine App, Technische Redakteure müssen abwägen, was die Dokumentation leisten muss, ob ein klassisches Handbuch oder eine kontextsensitive Onlinehilfe mehr Nutzen verspricht.
  • Technische Redakteure müssen die geeignetste Methode für die Beschreibung auswählen: Schritt-für-Schritt-Anleitung versus Funktionsbeschreibung, Multimediales Funktionsdesign (MMFD) versus Every Page is Page One (EPPO), sequenzielle Beschreibung versus Hypertext.
  • Technische Redakteure müssen die Hilfetexte zielgruppengerecht erstellen, diese bei Bedarf mit Grafiken, Animationen oder Videos anreichern.
  • Technische Redakteure können gedruckte Handbücher liefern oder die Inhalte in einer Onlinehilfe bereitstellen. Manchmal ist auch ein Medienmix sinnvoll: Schulungsunterlagen für die ersten Schritte auf Papier und detaillierte Hilfetexte für Fortgeschrittene online.
  • Sobald die Software in einer neuen Version vorliegt, müssen Technische Redakteure die Dokumentation aktualisieren, damit nach jedem Update auch die Dokumentation up to date ist.