IHK-Magazin Stuttgart, 07/2004

Dokumentation als Visitenkarte des Produkts

Gute und verständliche Handbücher sind die Visitenkarte jedes erklärungsbedürftigen Produktes. Denn anhand ihrer Qualität beurteilen viele Kunden – wenn auch unbewusst – das ganze Produkt. Schließlich läuft der Erstkontakt mit dem interessierten Kunden über die Bedienungsanleitung. Aber wie erstellt man ein gutes Handbuch?

Grundlage eines zielgruppenkonformen Handbuches ist eine vollständige interne Dokumentation. Viele Unternehmen kümmern sich aber erst dann um die Dokumentation, wenn das Produkt fix und fertig ist. Dabei erleichtert eine Projekt begleitende Dokumentation die Arbeit und spart später Nerven. Denn wird mit der Dokumentation erst kurz vor der Auslieferung begonnen, liegen oft wichtige Informationen nicht mehr vor. Zum Beispiel, weil der Systemarchitekt als „Alleinwissender” nicht mehr im Projekt tätig ist und keine Aufzeichnungen hinterlassen hat. Zeit- und kostenintensiv müssen dann die verlorenen Informationen besorgt werden, oder man gibt sich mit einer lückenhaften und oberflächlichen nachträglich erstellten Dokumentation zufrieden. Das rächt sich jedoch schnell, beispielsweise wenn Entscheidungsgrundlagen fehlen, was im schlechtesten Fall zum Scheitern des Projekts führen kann. Schlechte Dokumentationen erschweren auch bei einem Systemausfall die Fehlerdiagnose und -behebung. Das kann intern zu Ausfallzeiten und kundenseitig zu Schadenersatzforderungen führen. Und schlechte interne Dokumentationen führen zu schlechten Handbüchern.

Ein weiteres Problem vieler Anwendungshandbücher besteht darin, dass sie häufig nicht aus der Sicht des Benutzers, sondern der des Entwicklers geschrieben sind. Das liegt daran, dass Entwickler eine Innensicht auf die Anwendung haben und dazu neigen, die Funktionen technisch detailliert, aber ohne Anwenderbezug zu beschreiben. Der Kunde will aber nicht wissen, wie und warum etwas gemacht wurde, sondern wie es funktioniert! Hier können Spezialisten für technische Kommunikation helfen, die sich besser in den Endbenutzer hineinversetzen können, da sie die Anwendung von seinem Standpunkt aus betrachten.

Das beginnt schon bei der äußeren Form: Mangelnde Koordination und uneinheitliches Design sorgen für Verwirrung. Eigentlich einfache Fragen müssen immer wieder von neuem via Hotline geklärt werden. Nicht wenige „FAQs” würden nie auftreten, wenn die Anleitung sorgfältiger erstellt würde!

Nicht unterschätzt werden dürfen auch die Kosten, die auf Grund fehlerhafter Anleitungen aus der Produkthaftung drohen. Haftungsausschluss, Copyright- und Datenschutz-bestimmungen – wer sich hier nicht mit den neuesten gesetzlichen Bestimmungen auskennt, kann böse Überraschungen erleben.

Bevor eine Anwenderdokumentation in Druck geht, sollte sie darum auf jeden Fall von einem potenziellen Nutzer gelesen werden, der nicht unmittelbar an der Entwicklung beteiligt war. Eine Checkliste (siehe Kasten) kann dabei nützlich sein.

1. Äußere Form
Sind das Druckformat und die Bindung gut zu handhaben?
Ist genügend Platz zwischen der Bindung und dem Text?
Ist die Schriftart und -größe gut lesbar?
Ist die Dokumentation frei von Rechtschreibfehlern?
Sind Farben und Schattierungen einheitlich und unaufdringlich?
Werden die Corporate-Design-Regeln eingehalten?

2. Stil
Haben alle Verben die aktive Form?
Ist der Schreibstil klar und flüssig?
Wurde in Anleitungen der Imperativ verwendet?
Besteht der Text aus kurzen, gut lesbaren Absätzen?
Ist die Gliederung übersichtlich?

3. Strukturierung
Sind die Informationen einheitlich strukturiert?
Sind Themengebiete kurz gefasst, prägnant und in sich abgeschlossen?
Sind verwandte Themen gleich aufgebaut?
Stehen Informationen, die voraussichtlich am häufigsten gelesen werden, am Anfang?

4. Richtigkeit
Entsprechen alle dargestellten Sachverhalte den Tatsachen?
Ist die Dokumentation auf dem aktuellen Stand?

5. Nachvollziehbarkeit
Orientiert sich die Anleitung an den Bedürfnissen des Benutzers?
Wurden Fachbegriffe konsistent angewendet?
Entsprechen sie dem Kenntnisstand des Lesers?
Beziehen sich die Beispiele auf realistische Situationen?
Wurden Konventionen für die Darstellung erläutert?
Ergänzen die Grafiken und Bilder den Text?

6. Wiederauffindbarkeit
Ist das Inhaltsverzeichnis leicht verständlich?
Wurden Fachbegriffe in einem Glossar definiert?
Sind im Stichwortverzeichnis Wörter aufgeführt, nach welchen der Leser voraussichtlich suchen wird?
Sind alle Querverweise – auch zu anderen Dokumenten – richtig?

7. Dokumentenverwaltung
Existiert ein Literaturverzeichnis zu verwandten Themen?
Geht die Produktversion und die Ausgabe aus dem Dokumententitel hervor?
Deckt die Dokumentation den gesamten Produktzyklus ab (Installation, Verwendung, Wartung)?
Werden die Dokumente regelmäßig gesichert?
Können frühere Versionen der Dokumente wieder hergestellt werden?
Wurden Konventionen zur Benennung von Dokumentdateien und Ablageverzeichnissen festgelegt?

8. Rechtliche Hinweise
Wurde eine Copyright-Notiz aufgenommen?
Ist ein Haftungsausschluss enthalten?
Wurden für den Inhalt die Datenschutzbestimmungen eingehalten?
Wurden Marken und Warenzeichen anderer Firmen korrekt ausgezeichnet?