Software dokumentieren

Softwaredokumentation ist vielfältig: Aus der Software aufrufbare Online-Hilfen, spezielle Tutorials oder gedruckte Bedienhandbücher sind möglich. Zur Softwaredokumentation gehören aber auch die Inhalte auf Displays und Oberflächen von elektronischen Geräten sowie User Interface-Texte auf Benutzeroberflächen.

Online-Hilfen: Wie erstellt man eigentlich Softwaredokumentation?

Wodurch zeichnet sich eine gute Softwaredokumentation, besser: eine Online-Hilfe, aus? Um die Benutzer beim Umgang mit der Software optimal zu unterstützen, deckt die Online-Hilfe spezifische Arbeitskontexte ab. Die Online-Hilfe stellt die jeweils benötigten Informationen aufgabenorientiert zur Verfügung, damit Anwender auf offene Fragen ohne großen Suchaufwand Antworten finden. Die Online-Hilfe sollte zugänglich sein und jederzeit leicht auffindbar. Ideal ist es, wenn sie mit der Software zusammen ausgeliefert wird. Mit Hilfe-Schaltflächen oder der F1-Taste rufen Benutzer die Online-Hilfe auf.

Der Aufbau der Softwaredokumentation richtet sich nach den Aufgaben, die Anwender lösen müssen. Sie sollte auf deren spezifische Fähigkeiten und Bedürfnisse zugeschnitten werden. Idealerweise sollte die Softwaredokumentation alle Fragen beantworten und helfen, die Software vollständig zu nutzen.

Da die Softwaredokumentation online angeboten wird, können bei der Entwicklung eine Reihe von Funktionen eingesetzt werden, die Anwender effizient leiten.

Merkmale von Softwaredokumentation:

Kontextsensitivität
Die Kontextsensitive Online-Hilfe liefert Informationen zum speziellen Nutzungskontext, in dem sich Benutzer gerade befinden. In der Regel handelt es sich dabei um Beschreibungen einzelner Elemente der Software wie Schaltflächen oder Dialoge. Der Hilfetext ist damit passgenau, allerdings auch sehr spezifisch und kleinteilig.
Modularisierung
Die Online-Hilfe wird topic-orientiert erstellt, d.h. die Inhalte sind in Module aufgeteilt, die jeweils ein in sich abgeschlossenes Thema behandeln. Weitere relevante Themen lassen sich durch Links auf die entsprechenden Topics anzeigen. Damit sollen Benutzer genau die für sie passenden Informationen erhalten. Modularisierung wird nicht nur beim Erstellen von Softwaredokumentation eingesetzt, sondern generell dann, wenn es um die Wiederverwendung von bestimmten Inhalten geht.
Hypertextualität
Online-Hilfen sind Hypertext-Gebilde, d.h. sie bestehen aus einer netzartigen Struktur von Topics, die durch Links verknüpft sind. Damit unterscheidet sich die Softwaredokumentation grundlegend von linear aufgebauten Dokumenten, die der klassischen Buchstruktur folgen: Die Benutzer können Informationen in beliebiger, selbstgewählter Reihenfolge aufrufen. Hierzu stehen ihnen entsprechende Navigationswerkzeuge zur Verfügung. Auch Medien außerhalb der Online-Hilfe können verlinkt werden und so zum Mehrwert beitragen.
Navigation
Neben den Links gibt es weitere Elemente, die die Navigation in Online-Hilfen unterstützen:
Breadcrumbs: Benutzer erhalten eine Orientierungshilfe, mit der sie den zurückgelegten Weg in der Online-Hilfe nachverfolgen und die aktuelle Position in der Online-Hilfe sehen können
Backtracking: Benutzer können schrittweise zu bereits besuchten Topics zurückgehen
Lesezeichen oder Bookmarks: Benutzer können sich Marken setzen, um für sie relevante Inhalte leichter wieder auffindbar zu machen
Drop-Down und Embedded Text
Redakteure können Informationen mit Drop Down-Funktionen oder mit Embedded Text erweitern. Mit diesen Funktionalitäten können Benutzer Zusatzinformationen in der Online-Hilfe ein- oder ausklappen. So bestimmen Benutzer selbst, wieviel Informationen sie konsumieren wollen: sich rasch einen Überblick verschaffen oder sich tiefgehend mit einem Thema beschäftigen.
Kommentar- und Feedbackfunktion
Feedback und konstruktive Kommentare helfen Ihnen dabei, den Kontakt zum Benutzer zu halten und ungeahnte schwierige Themen in der Dokumentation ausführlicher zu beschreiben.
Screenshots
Um die Dokumentation möglichst anschaulich zu gestalten, bindet man Screenshots in die Online-Hilfe ein. Dabei gibt es einiges zu beachten.
Screenshots in Softwaredokumentation

Softwaredokumentation

Texte auf der Benutzeroberfläche: User Interface-Texte als Teil der Softwaredokumentation

Inhalte auf Displays von elektronischen Geräten und User Interface-Texte gehören zur Softwaredokumentation und sollten verständlich, konsistent und korrekt sein, um die sichere Bedienung durch die Anwender zu gewährleisten. Unternehmen räumen der Benutzeroberfläche eine immer höhere Priorität ein, um den Anwendern eine optimale Benutzererfahrung zu schaffen. Mit diesem Ziel eines positiven Gesamterlebnisses werden die Benutzer und deren Bedürfnisse mehr und mehr in den Mittelpunkt gestellt.

Entwickler erstellen sie und Technische Redakteure bearbeiten sie anschließend. Dabei gibt es Regeln zu beachten.

Anwender lesen User Interface-Texte anders als Fließtext, zum Beispiel in der Online-Hilfe. Sie lesen nicht von links oben nach rechts unten, sondern sie überfliegen das gesamte User Interface und erfassen dabei die Texte und die Schaltflächen. Sie lesen nicht, sie scannen. Ein weiterer Unterschied zum Lesen eines normalen Fließtextes besteht darin, dass Anwender sofort aufhören zu lesen, wenn sie wissen, wie sie ihr Ziel erreichen.

Oft ist sehr wenig Platz auf der Benutzeroberfläche vorhanden. Daher müssen diese Hilfetexte besonders kurz, prägnant und konsistent sein. Konsistente Beschriftungen auf Schaltflächen und anderen Elementen des User Interfaces sind unerlässlich für die Usability.

Meldungstexte, Bestätigungsdialoge sowie Anleitungstexte, die auf dem User Interface angezeigt werden, sind bei Technischen Redakteuren in guten Händen. Sie prüfen, ob sie konsistent und gut verständlich sind. Fehlermeldungen sollten besonders informativ sein. Sie beschreiben nicht nur den Fehler, sondern sie erklären auch, wie Benutzer ihn beheben können. Für User Interface-Texte gilt, was für den gesamten Content eines Unternehmens gilt: Die Terminologie muss stimmen.

Wodurch zeichnen sich die Texte des User Interfaces aus?

Checkliste, die Ihnen bei der Erstellung von User Interface-Texten Ihrer Softwaredokumentation hilft:

Terminologie beachten. Keine internen Ausdrücke benutzen.
So wenig Wörter wie möglich verwenden
Bei ganzen Sätzen: Keine Passivsätze
Bei Handlungsanleitungen den typischen Aufbau dieser Textsorte umsetzen.
Übersetzungen sind in den Zielsprachen eventuell länger. Extra Platz für Übersetzungen einplanen.
Regeln für Groß- und Kleinschreibung sowie für Interpunktion festlegen. Es ist sinnvoll, diese Regeln im Redaktionsleitfaden festzuhalten.
Informative Fehlermeldungen formulieren. Was ist der Fehler? Wie wird er behoben?

Wir dokumentieren Ihre Software. Als Lieferant und zuverlässiger Dienstleister arbeitet people text mit dem Autorensystem Ihrer Wahl, um Ihre Software zu dokumentieren. Unsere Technischen Redakteure sind es gewöhnt, sich rasch in die redaktionellen Prozesse unserer Kunden einzugliedern. So verläuft das Dokumentieren Ihrer Software, zum Beispiel Online-Hilfen oder anderer Dokumentationen, reibungslos.