Zum Inhalt springen

Verständliche Anleitungen

Unternehmen geben jedes Jahr viel Geld aus, um ihre Produkte zu dokumentieren und mit ihren Kunden zu kommunizieren. Die Technische Dokumentation ist Teil des Produkts und ihre Qualität beeinflusst oft die Meinung, die der Kunde vom Produkt hat. Hat die Dokumentation Mängel oder ist sie schwer verständlich, dann leidet das Image des Produkts und manchmal auch das des Herstellers darunter. Das ist insbesondere der Fall, wenn es sich um Verbraucher handelt, die Konsumgüter, Haushaltsgeräte oder Autos kaufen.

Bei manch einer Dokumentation wurde offensichtlich die Rechnung ohne den Leser gemacht, wie es diese Meldung aus einem Artikel der Zeitung Die Zeit (Ausgabe vom 11.09.2015) zeigt: "Doch ausgerechnet bei der Erklärung der Möglichkeiten, die sich aus der Verbindung des Autos mit dem Internet ergeben, schneidet nur Volvo mit einem Wert von 18,5 Punkten positiv ab. Durchschnittlich schafften die elf bewerteten Hersteller nur 9,4 Punkte. Zu den schlecht bewerteten Marken gehört auch Audi. Die Ingolstädter belegen mit 4,7 Punkten den letzten Platz in dieser Kategorie. Mercedes kommt nur auf 6,9 Punkte."

Was sind die wichtigsten Fehler, die ein Autor bei guter Vorbereitung vermeiden kann?

  1. Die Zielgruppe falsch einschätzen: Der Autor oder der Entwickler ist in der Regel mit dem Produkt und den angewandten Verfahren sehr gut vertraut und hat zudem firmeninternes Wissen, das für den Endbenutzer nicht zugänglich ist. Das kann dazu führen, dass er zu viel an Vorkenntnissen oder an Produktkenntnissen voraussetzt. Die Fehleinschätzung der Zielgruppe kann ebenfalls etwas mit der Sprache, mit der Wortwahl, mit der Syntax zu tun haben. Auch hier ist es besser, im Zweifel eher auf eine einfache, neutrale und leicht verständliche Sprache zu setzen.
  2. Der Autor verwendet unbekannte oder schwierige Fachwörter ohne Erläuterung. Natürlich kommt keine Anleitung ohne Fachwörter aus. Je spezifischer und komplexer das Produkt, desto größer ist die Wahrscheinlichkeit, dass Fachwörter, die der Kunde nicht kennt, zum Einsatz kommen. Daher ist es angebracht, erstens in einem kleinen Glossar die wichtigsten Fachtermini zu erläutern und zweitens im Suchindex auch gebräuchliche Synonyme aufzunehmen, damit der Kunde zu seiner Information kommt ("LED" siehe "Leuchtdiode").
  3. In manchen Branchen wird sehr gerne mit Anglizismen gearbeitet. Inzwischen belegen viele Studien, dass ein großer Teil der Bevölkerung Anglizismen oft falsch oder gar nicht versteht. Es empfiehlt sich deswegen, möglichst auf Anglizismen zu verzichten, und wenn sich dies nicht vermeiden lässt, zumindest diese zu erklären. Z. B.: Was ist ein "Trackpad" im Satz "Das Magic Trackpad arbeitet mit Bluetooth Technologie"? Wer hier übrigens nach "Übersetzungen" aus dem "Denglischen" sucht, findet welche auf der Webseite des Verein Deutsche Sprache e.V. (www.vds-ev.de).
  4. Es ist gute Praxis, auf einen einfachen Satzbau zu achten und Sätze zu vermeiden, die entweder zu lang sind (Empfehlung: Nicht mehr als 15 Wörter pro Satz) oder mehr als einen Nebensatz haben.
  5. Besonders störend für den Leser (und auch für die Übersetzer) ist die uneinheitliche Verwendung der Terminologie bzw. der unpräzise Einsatz von Fachtermini ("Einheit" statt "Steuereinheit").
  6. Manche Texte verwenden hölzerne Floskeln (wie "Lösung herbeiführen") oder Füllwörter ("eigentlich"), die die Verständlichkeit der Texte erschweren.

Es gibt eine ganze Reihe von Empfehlungen oder Verfahren, die der Autor nutzen kann, um Schwachstellen in seiner Dokumentation zu finden. Zuerst einmal ist die Leitlinie der tekom Regelbasiertes Schreiben (zweite erweiterte Auflage 2013) besonders zu empfehlen. In dieser Leitlinie hat eine Gruppe von Experten aus der technischen Kommunikation ein umfangreiches Regelwerk mit über 160 Regeln für die Optimierung von Dokumentationen ausgearbeitet. Auf knapp 170 Seiten stehen Empfehlungen zur Informationsstruktur, zum Satzbau, zur Wortwahl, zum Stil und zur Typografie sowie Ratschläge für übersetzungsgerechtes Schreiben. Der Leitfaden enthält viele positive und negative Beispiele, die dem Autor auf sehr pragmatische Weise helfen, Schwachstellen in seiner Dokumentation zu finden. Wer diese Empfehlungen beherzigt, wird auf jeden Fall die Qualität seiner Dokumentation wesentlich verbessern können.

Einen weiteren interessanten Ansatz bietet die Verwendung eines Verständlichkeitsindexes, der durchaus maßgeschneidert werden kann und maschinenlesbare Textkriterien berücksichtigt wie:

  • die durchschnittliche Satzlänge
  • die durchschnittliche Wortlänge
  • den Wortschatzreichtum (was Linguisten "Type-Token-Relation" nennen, d. h. Verhältnis der einzelnen Wortformen zur Gesamtzahl an Wörtern im Text. Je niedriger diese Zahl, desto verständlicher die Sprache.)
  • den Stil (Verwendung von Verben im Passiv. Konstruktionen mit Modalverben wie "wurde", "wird"…)

Zu einer einfachen Messung der Lesbarkeit von Texten braucht man nicht zwangsläufig eine teure Software anzuschaffen. Einige Funktionen sind bereits in Programmen wie Microsoft Word vorhanden. In Office 2010 befindet sich z. B. eine solche Funktion unter Datei > Optionen > Dokumentenprüfung. Man braucht dazu nur im Abschnitt Rechtschreib- und Grammatikkorrektur in Word das Kontrollkästchen Lesbarkeitsstatistik zu aktivieren. Hier kann die gelieferte Statistik als Referenzwert helfen, um den aktuellen Schwierigkeitsgrad eines Textes zu messen und um anschließend Fortschritte zu dokumentieren.

Da die Besonderheiten der Inhalte, der Produkte und der Zielgruppe(n) für die Bewertung der Lesbarkeit eine wichtige Rolle spielt, müssen diese Faktoren individuell festgelegt werden (z. B. abweichende Vorgaben für die maximale Satzlänge). Sie können im Redaktionsleitfaden aufgenommen werden.

Es gibt am Markt einige Qualitätssicherungsprogramme in verschiedenen Preisklassen, mit denen Autoren nach unerwünschten Wörtern oder zu lange Sätze suchen können. Die D.O.G. GmbH hat z. B. das relativ preiswerte ErrorSpy für Autoren als Add-on für MS-Word entwickelt. Programme wie Acrolinx (www.acrolinx.de) liegen im obersten Preissegment und bieten Funktionen wie die Analyse von Satzstrukturen auf der Basis selbstdefinierter Regeln.

Der Aufwand, auf regelmäßiger Basis die Lesbarkeit von Dokumentationen Publikationen zu prüfen, lohnt sich auf jeden Fall. Das Ergebnis ist eine klare unmissverständliche Kommunikation und zufriedene Kunden. Der Nebeneffekt ist, dass Texte mit kurzen Sätzen, mit einem einfacheren standardisierten Wortschatz sich besser wieder verwenden und übersetzen lassen, was beim Einsatz von Content-Management- und Translation-Memory-Systemen ein entscheidender Kostenvorteil ist.

Kommentare