Qualitätskriterien für Technische Dokumentation

Ihr Produkt kann das beste der Welt sein, aber wenn der Kunde aufgrund einer schlechten Anleitung nicht damit zurechtkommt und dadurch extrem unzufrieden ist, nützt Ihnen das vermutlich wenig. Damit dies nicht zur bitteren Realität wird, haben wir für Sie ein paar hilfreiche Tipps zusammengestellt.

Die Anleitung fällt in den Bereich der externen Technischen Dokumentation. Bei dieser handelt es sich um betriebsexterne Dokumente, die an den Produktanwender weitergegeben werden. Betriebsinterne Dokumente hingegen, die interne Technische Dokumentation, werden hier nicht thematisiert. An sie werden zurecht völlig andere Qualitätsanforderungen als an die Benutzerdokumentation gestellt.

7 Schritte sind zur Entstehung von Benutzerinformation notwendig

Genau wie Ihr Produkt durchläuft auch die dazugehörige Dokumentation verschiedene Entstehungsphasen. Daher beginnt gute Qualität schon lange vor der Veröffentlichung eines Benutzerhandbuchs. Die folgenden sieben wichtigen Schritte gehören dazu und dienen als Gedankenstütze:

1. Planung
2. Recherche
3. Gestaltung
4. Redaktion
5. Qualitätssicherung
6. Übersetzung
7. Veröffentlichung

Um einen hohen Qualitätsstandard in der Technischen Dokumentation zu schaffen, gilt es grundsätzlich auf eine klare Struktur zu achten und wichtige Merkmale im Vorfeld zu definieren, d. h. eine Standardisierung einzuführen. Die Erstellung und Verwendung von Checklisten für diese Prozesse haben sich als äußerst nützlich erwiesen und helfen außerdem dabei diese reproduzierbaren Abläufe überprüfbar zu machen. So kann Qualität auf einem bestimmten Level geschaffen und gleichzeitig deren Konsistenz regelmäßig geprüft werden.

Was macht gute Technische Dokumentation aus?

Zum einen soll die Technische Dokumentation Vertrauen beim Anwender schaffen und dafür sorgen, dass das Leistungsspektrum eines Produkts in vollem Maße ausgeschöpft wird. Je zufriedener der Kunde, desto besser für Sie und Ihr Produkt.

Zum anderen muss die Technische Dokumentation alle relevanten Gesetze und Verordnungen erfüllen, sowie Anforderungen aus Normen und Technischen Regeln berücksichtigen. Darüber hinaus muss sie unmissverständlich formuliert sein, damit keine unnötigen Haftungsrisiken entstehen.

Manchem Hersteller ist es besonders wichtig, dass die Technische Dokumentation möglichst wenig Geld und Eigenleistung kostet. Anderen Herstellern ist wichtiger, dass ihre Betriebsanleitung dafür sorgt, dass keine unangenehmen Besuche von Behörden oder Rechtsanwälten wegen Produkthaftung erfolgen.

Und der Betreiber bzw. die Servicefirmen? Für sie ist die Technische Dokumentation dann gut, wenn sie verständlich und präzise umgehend dafür sorgt, dass man weiß, was genau in welcher Situation zu tun und / oder zu unterlassen ist. Praktisch muss sie sein und dafür sorgen, dass für die Dauer des Produktlebens keine hohen Kosten oder gar andere Probleme entstehen.

Diese 5 Kriterien lassen eine hohe Qualität Ihrer Technischen Dokumentation vermuten:

• Übersichtliches Layout, welches das Auffinden der Informationen erleichtert, z. B. über Inhalt- und Stichwortverzeichnis
• Fachlich richtige Anweisungen und nachvollziehbare Reihenfolge (1. Erst dies, 2. Dann das, 3. Danach jenes, etc.)
• Einheitliche Sprache / Terminologie
• Korrekte Rechtschreibung, Grammatik und Orthografie
• Einheitliche Darstellung von Grafiken inkl. Bildunterschrift

Tipps zur Verbesserung der Technischen Dokumentation

Im besten Fall kann man mit einer gelungenen Technischen Dokumentation alle Parteien zufriedenstellen. Damit das gelingt, haben wir hier noch ein paar Tipps, wie die Technische Dokumentation verbessert werden kann:

• Publikum berücksichtigen
  Behalten Sie immer im Hinterkopf, für welche Zielgruppe die Dokumentation erstellt wird. Welche Kenntnisse und Erwartungen haben diese Menschen?
• Ziel im Blick behalten
  Vergessen Sie nicht, worum es bei der Dokumentation geht und welche Inhalte Sie genau vermitteln wollen: wie ihr Produkt sicher und effektiv genutzt wird.
• Technische Dokumentation leicht auffindbar machen
  Wählen Sie die passende Bereitstellungsform der Benutzerdokumentation für Ihre Zielgruppe, z. B. Print, Online-Hilfe, ePub, etc.
• Aussagekräftige Titel und Untertitel auswählen
  Nachvollziehbare Organisation und Struktur helfen bei der Navigation durch die Dokumentation, neben einem Inhaltsverzeichnis kann ein Stichwortverzeichnis wahre Wunder bewirken.
• Informationen übersichtlich gestalten
  Erschlagen Sie den Nutzer nicht mit einer sogenannten "Wall-of-text", sondern helfen Sie ihm durch Gestaltungselemente, die der Übersichtlichkeit dienen. Hierzu zählen:
  • Titel und Untertitel,
  • Listen,
  • Infokästen,
  • Zusammenfassungen,
  • Inhalts- und Stichwortverzeichnis.
• Suchfunktion integrieren
  Kommen Sie, wenn möglich, dem gebräuchlichen Suchverhalten Ihrer Nutzer entgegen.
• Beispiele integrieren
  Realitätsbezogene Beispiele helfen dem Benutzer Informationen besser zu behalten und den Einsatzzweck genauer zu erkennen.
• Screenshots nutzen
  Gerade bei Technischer Dokumentation von Software sind Erklärungen anhand des Bildschrims sehr hilfreich. Durch geschickte Screenshots weiß der Anwender gleich, ob er auf dem richtigen Weg ist.
• Videos einbinden
  Sie können helfen bestimmte Vorgänge besser nachzuverfolgen. Beispielsweise bei Software helfen auch Tutorials, die auf Screencasts basieren, sich schnell in das Thema einzufinden.

Welche Kriterien können also, objektiv betrachtet, angewendet werden um die Qualität einer Technischen Dokumentation zu beurteilen? Hierzu ein paar konkrete Beispiele, die Sie mit Werten hinterlegen können, um Ihre Checkliste zur Technischen Dokumentation zu erstellen:

• Vorhandensein und Anwendung eines Redaktionsleitfadens
  (Schafft eine Homogenität in der Gesamtdarstellung, obwohl mehr als eine Peson daran gearbeitet hat.)
• Fachliche Korrektheit (Maßstab z. B. x Korrekturen aus der Entwicklung)
• Korrekt verwendete Rechtschreibung / Grammatik (wurde vor dem Lektorat die Rechtschreibprüfung des verwendeten Programms genutzt, etc.)
• Verwendung einer konsistenten Terminologie (entweder manuell stichprobenartig geprüft oder mit geeigneten Tools)
• Einheitlicher Umgang mit Abkürzungen (z. B. wurden alle Abkürzungen in einem Abkürzungsverzeichnis gefunden und erklärt)
• Einheitliche Darstellung bei Bildverwendung und Bildbeschriftungen (z. B. wurden Hervorhebungen immer auf die gleiche Art gemacht, sind Screenshots immer nur im Ganzen oder nur im Detail verwendet oder wird Foto / 3D-Rendering / Strichzeichnung gemischt oder einheitlich vewendet)
• Überprüfung von Formalitäten wie z. B.:
  • Aktualität der Datums
  • Korrektheit der Versionsnummer
  • Vollständigkeit und Aktualität des Inhaltsverzeichnisses
  • Vollständige Übernahme der Sicherheitshinweise aus der Risikobeurteilung
  • Prüfen der Inhalte von Kopf- und Fußzeile

Last but not Least: Hilfe!

Sie sehen schon, die Anforderungen bzw. Wünsche, sind vielfältig. Gute Technische Dokumentation muss nicht exorbitant teuer sein. Wird sie, bestenfalls von Anfang an, richtig gemacht, dann ist die Einhaltung eines Standards wesentlich leichter als jedes Mal wieder von vorne zu beginnen. Auch Aktualisierungen und andere Anpassungen können so leichter realisiert werden.

Wenn Sie also selbst weder die Zeit noch die personellen Ressourcen bereitstellen können, um eine qualitativ hochwertige, Technische Dokumentation zu bieten und kontinuierlich zu gewährleisten, dann holen Sie sich Hilfe! Beauftragen Sie mit den Handbuch Experten einen Dienstleister für Technische Dokumentation, der seit über 30 Jahren Erfahrung in diesem Bereich hat und sich bestens mit Standardisierung auskennt. Wir erleichtern Ihnen die Arbeit, damit Sie den Kopf wieder für das Wesentliche frei haben – Ihre Produkte.