|
Checkliste zur Beurteilung und Verbesserung der Qualität Technischer Dokumentation, insbes. Technischer Dokumentation für Software (Software-Dokumentation) wie Handbücher, Online-Hilfen sowie interaktiver Demos und Tutorials.
Wenn Sie vor der Herausforderung stehen ein Handbuch oder eine Online-Hilfe prüfen zu müssen, die Sie oder ein Kollege selbst geschrieben haben, ist es schwierig, einen neutralen kritischen Blick zu bewahren. Die folgende Fragenliste möchte Ihnen helfen, die wichtigsten potenziellen Schwachstellen dabei nicht aus den Augen zu verlieren.
Die wenigsten Benutzer interessieren sich dafür, wie Ihr Produkt funktioniert – auch wenn Sie als Entwickler und Hersteller zu Recht stolz darauf sind. Benutzer wollen ganz einfach schnell und unkompliziert zum Ziel kommen und lesen Technische Dokumentation oder Online-Hilfen nur, 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 der Benutzer wissen will (= 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 sauber durch Zwischenüberschriften untergliedert? Oder gibt es lange, unübersichtliche Textabschnitte? |
| ▪ | Wird in jedem Absatz nur ein Thema behandelt oder sind die Inhalte vermischt? |
| ▪ | Sind Handlungsanleitungen nummeriert und klar als solche erkennbar? |
| ▪ | Kann der Benutzer gezielt ausschließlich das lesen, was ihn in einer bestimmten Situation interessiert: Einführung, schrittweise Anleitung oder Detailinformation? Oder sind die Informationstypen vermischt, so dass jeder Benutzer immer alles lesen 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 die Möglichkeiten des Mediums, wie z.B. Interaktion, Animation, Personalisierung? |
|
| ▪ | Gibt es ein benutzerfreundliches, klar durchdachtes Navigationskonzept, oder gibt es Links / Querverweise "von überall nach überall"? |
| ▪ | 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 der Benutzer entscheiden muss? |
|
| ▪ | Vermittelt der Text Vertrauen, Zuversicht und Sicherheit, oder wirkt er eher einschüchternd? |
| ▪ | Wird der 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?) |
| ▪ | Dieselbe Regel gilt auch für Links einer Online-Hilfe. Sind sie so eindeutig formuliert, dass der Benutzer bereits vor dem Anklicken erkennen kann, ob sich der Exkurs lohnt? |
|
| ▪ | Folgt die gesamte Dokumentation zu einer Produktfamilie einem einheitlichen Konzept, oder muss sich der 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 dem Leser die Suche und Informationsaufnahme so einfach wie möglich? Ist es möglich, auch nur 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? |
| ▪ | Trägt 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 Sourcing", d.h. die zukünftige Ausgabe in weiteren Ausgabemedien, Formaten und Versionen? |
|
Schlüsselwörter zu dieser Seite: Technische Dokumentation - Software-Dokumentation - Softwaredokumentation - Benutzerdokumentation - Handbuch - Handbücher - Benutzerhandbuch - Benutzerhandbücher - Online-Hilfe - Online-Hilfen - Onlinehilfe - Onlinehilfen - Qualität - Qualitätssicherung - Qualitätsmerkmale - Qualitätskennzeichen - Qualitätskriterien - Checkliste - Kriterienkatalog - Schwachstellen - Analyse - Usability - Benutzerfreundlichkeit - benutzerfreundlich - Anwenderfreundlichkeit - anwenderfreundlich - Verständlichkeit - verständlich.
|
