|
Woran erkennen Sie eine gute Technische Dokumentation (Software-Dokumentation)? Was sind Qualitätskennzeichen verständlicher, anwenderfreundlicher Handbücher, Online-Hilfen, Screencasts, Demos und Tutorials?
Anhand welcher Qualitätskriterien erkennen Sie eine gute Technische Dokumentation oder eine gute Online-Hilfe, wenn Sie selbst kein Dokumentationsexperte sind? Woran können Sie die Qualität dessen beurteilen, was Ihnen ein Dokumentations-Dienstleister anbietet oder liefert?
Der wichtigste Punkt gleich vorweg: Schließen Sie nicht von sich selbst auf die Benutzer Ihrer Produkte. Sie selbst kennen Ihr Produkt bereits – neue Benutzer noch nicht.
Die wenigsten Benutzer interessieren sich dafür, wie Ihr Produkt funktioniert – auch wenn Sie als Entwickler zu Recht stolz darauf sind. Benutzer wollen ganz einfach schnell und unkompliziert zum Ziel kommen und lesen Benutzerhandbücher und Online-Hilfen nur dann, wenn Sie ein konkretes Problem vor Augen haben. Dieses Problem müssen sie in der Dokumentation wiederfinden.
| ▪ | Entspricht der Aufbau der Dokumentation der technischen Architektur Ihres Produkts (= schlecht) oder spiegeln die Themen die Aufgaben und Ziele der Benutzer wider (=gut)? |
| ▪ | Enthält die Dokumentation das, was Sie sagen möchten (= schlecht) oder das, was die Benutzer wissen wollen (= gut)? |
| ▪ | Wird beschrieben, was der Benutzer ohnehin am Produkt sieht (schlecht), oder das, was er nicht sieht (= gut)? Wird das Produkt beschrieben (= schlecht) oder seine Anwendung (= gut)? |
|
| ▪ | Ist die Gliederung flach, einfach und übersichtlich? Oder gibt es Kapitel, Unterkapitel, Unterunterkapitel, Unterunterunterkapitel, …? |
| ▪ | Entspricht die Reihenfolge der Kapitel der Häufigkeit, in der die Kapitel benötigt werden? Steht das Wichtigere vor dem Unwichtigeren, das Allgemeine vor dem Speziellen? |
|
| ▪ | Ist der Text klar durch Zwischenüberschriften untergliedert? Oder gibt es lange, unübersichtliche „Textwüsten“? |
| ▪ | Wird in jedem Absatz nur ein Thema behandelt oder sind die Inhalte wild vermischt? |
| ▪ | Sind Handlungsanleitungen nummeriert und klar als solche erkennbar? |
| ▪ | Können Benutzer gezielt das lesen, was sie in einer bestimmten Situation interessiert: Einführung, schrittweise Anleitung oder Detailinformation? Oder sind die Informationstypen bunt gemischt, so dass immer alles gelesen werden muss? |
|
| ▪ | Wie eng und mediengerecht ist die Anbindung einer Online-Dokumentation an die Software? Lässt sich lediglich eine PDF-Datei aufrufen? Oder ist die Online-Hilfe kontextsensitiv oder sogar direkt in die Software-Oberfläche integriert („embedded“)? |
| ▪ | Ist eine Online-Hilfe lediglich ein „Handbuch am Bildschirm“, oder nutzt sie tatsächlich die Möglichkeiten des Online-Mediums, wie Interaktion, Animation, Personalisierung? |
|
| ▪ | Gibt es ein benutzerfreundliches, klar durchdachtes Navigationskonzept, oder gibt es Links / Querverweise „von überall nach überall“? |
| ▪ | Enthält jedes Topic einer Online-Hilfe sinnvolle Informationen, oder gibt es weitgehend inhaltsleere Topics, die die Benutzer lediglich weiter verweisen und „von Pontius zu Pilatus schicken“? |
| ▪ | Existiert ein redaktionell bearbeiteter Index oder nur ein automatisch generierter Index? |
| ▪ | Enthält der Index auch Synonyme? (Beispiel: Würde ein Thema „Auto“ auch unter „Fahrzeug“, „PKW“ oder „Kfz“ gefunden?) |
| ▪ | Ist der Index mehrstufig und sind alle Indexbegriffe eindeutig, oder gibt es zu einzelnen Begriffen mehrere Zielstellen, zwischen denen sich die Benutzer entscheiden müssen? |
|
| ▪ | Vermittelt der Text Vertrauen, Zuversicht und Sicherheit, oder wirkt er eher einschüchternd? |
| ▪ | Werden die Leser direkt angesprochen (Beispiel: „Klicken Sie …“) oder gibt es unpersönliche Formulierungen bei denen unklar bleibt, wer handelt (Beispiel: „Es muss … durchgeführt werden“)? |
| ▪ | Gibt es unpräzise Formulierungen, aus denen nicht eindeutig hervorgeht ob zwingend gehandelt werden muss, oder ob optional gehandelt werden kann („eventuell“, „sollte“)? |
| ▪ | Sind alle Überschriften eindeutig formuliert, so dass sich bereits im Vorfeld der Inhalt eines Themas eindeutig erkennen lässt? Oder muss der Benutzer jedes Thema zunächst einmal anlesen, um zu sehen, ob der Inhalt für ihn überhaupt relevant ist? (Beispiel: Ein Thema heißt lediglich „Überblick“. Überblick über was?) |
| ▪ | Sind alle Links so eindeutig formuliert, dass die Benutzer bereits vor dem Anklicken erkennen können, ob sich sich lohnt, ihnen zu folgen? |
|
| ▪ | Folgt die gesamte Dokumentation zu einer Produktfamilie einem einheitlichen Konzept, oder müssen sich die Benutzer überall erneut zurechtfinden? |
| ▪ | Werden Fachbegriffe und Bezeichnungen konsistent verwendet, oder heißt ein und dieselbe Sache einmal so und später wieder anders? |
| ▪ | Entsprechen die in der Dokumentation verwendeten Begriffe denen, die sich auch auf dem Gerät bzw. in der Software wiederfinden? |
|
| ▪ | Machen Struktur und Formulierung den Lesern das Finden und Verstehen der gebotenen Informationen leicht? Ist es möglich, auch punktuell auf einzelne Informationen zuzugreifen? |
| ▪ | Steht die wichtigste Information am Anfang? |
| ▪ | Steht die Information, die alle Benutzer brauchen vor der Information, die nur wenige Benutzer interessiert? |
| ▪ | Stehen häufig benötigte Informationen vor seltener benötigten Informationen? |
| ▪ | Stehen allgemeingültige Informationen vor Informationen für Spezialfälle? |
| ▪ | Steht inhaltlich Zusammengehöriges auch räumlich zusammen? |
| ▪ | Stehen die Schlüsselbegriffe im Satz möglichst weit vorne? |
| ▪ | Sind die Sätze kurz und einfach? Können auch Nicht-Muttersprachler den Text verstehen? |
| ▪ | Beinhaltet jeder Satz nur eine Information? |
| ▪ | Wird auf inhaltslose Füllwörter und Floskeln verzichtet? |
|
| ▪ | Wirkt das Layout professionell und funktional? Oder ist es bunt und überladen und lenkt von den eigentlichen Inhalten ab? |
| ▪ | Unterstützt das Layout ein schnelles Überfliegen und Querlesen? |
| ▪ | Werden in einer Online-Dokumentation bildschirmtaugliche, serifenlose Schriftarten verwendet? |
| ▪ | Bleiben in einer Online-Dokumentation Unterstreichungen ausschließlich der Auszeichnung von Links vorbehalten? Kann der Benutzer auf einen Blick erkennen, was anklickbar ist und was nicht? |
|
| ▪ | Wird die Dokumentation mit einem geeigneten Autorensystem erstellt oder „von Hand zusammengestrickt“? Kann die Dokumentation mit wenig Aufwand überarbeitet und neu produziert werden? Wurden z.B. für Seitenumbrüche bereits im Autorensystem automatische Regeln hinterlegt, oder muss bei jeder Überarbeitung und Übersetzung manuell layoutet werden? |
| ▪ | Sind Autorensystem und Format zukunftssicher? |
| ▪ | Wird beim Schreiben auf Lokalisierbarkeit und Übersetzungsfreundlichkeit geachtet? |
| ▪ | Unterstützen Format, Autorensystem und Dokumentaufbau Single Source Publishing, also die zukünftige Ausgabe in weiteren Ausgabemedien, Formaten und Versionen? |
|
Schlüsselwörter zu dieser Seite: Technische Dokumentation - Software-Dokumentation - Softwaredokumentation - Benutzerdokumentation - Dokumentation - Doku - Handbuch - Benutzerhandbuch - Online-Hilfe - Onlinehilfe - Qualität - Qualitätssicherung - Qualitätsmerkmale - Qualitätskennzeichen - Qualitätskriterien - Qualitätsmanagement - Checkliste - Schwachstellen - Analyse - Usability - Benutzerfreundlichkeit - Anwenderfreundlichkeit - Verständlichkeit.
|
