BA #018 Verständlich Schreiben für die Technische Dokumentation

Betriebsanleitungen lesen sich häufig wie rechtliche Regelwerke. Hauptsächlich deshalb, damit die Anleitung allen rechtlichen Bestimmungen entspricht.

Verständlich Schreiben für die Technische Dokumentation liegt nicht vielen Leuten. Nur wenige Techniker, die neue Produkte entwickeln, haben auch die Fähigkeit gute Texte zu schreiben. Daher gibt es Technische Redakteure und Redakteurinnen, welche die Anleitungstexte verfassen.

In der heutigen Zeit von Industrie 4.0 müssen Nutzerinformationen „just in time“ bereitstehen. Das lastet die Technische Redaktion eines Unternehmens sehr aus. Vielerorts kann die verschärfte Nachfrage nach Informationsprodukten zu einer Überlastung der Redaktion führen.

Die Texte sollen zu dem auch noch weniger starr wirken, sondern durch einen flexiblen Inhalt glänzen. Wie das alles schnell und verständlich aufgebaut sein soll, komme ich in dieser Folge zu sprechen und gebe einige Tipps zum verständlichen Schreiben.

Aufgrund der Masse an Informationen in einer Betriebsanleitung muss der Text sich einfach „scannen“ lassen. Ein Anwender der Anleitung ist ungeduldig und möchte schnell an seine gesuchte Information kommen. Daher steht die strukturelle Gliederung von Inhalten über allem anderen.

Alle 3 bis 5 Abschnitte sollten eine Zwischenüberschrift vorkommen, damit der Text schnell nach relevanten Informationen abgesucht werden kann. Ein Servicetechniker interessiert sich beispielsweise nur für ein bestimmtes Kapitel im Bereich der Wartung der Maschine oder Anlage. Vielleicht möchte er wissen, welches Bauteil er überprüfen muss. Ist die Technische Dokumentation gut gegliedert, findet der Techniker schnell den benötigten Wartungsplan und kann die gewünschte Information nachlesen.

Das schnelle Auffinden von Informationen ist natürlich nur möglich, wenn der Text folgende Kriterien aufweist.

• Strukturiert
• Verständlich
• Minimalistisch

Diese Kriterien sind auch für eine verständliche Anleitung zutreffend. Strukturiert als Aspekt haben wir gerade mit der Gliederung von Inhalten behandelt, kommen nun zur Verständlich und Minimalistisch.

Einen Text verständlich zu halten ist natürlich keine neumodische Erscheinung. Seit langem beschäftigten sich viele Theorien damit, welche Merkmale einen guten Informationstext ausmachen und diesen verständlich machen.

Auch im Bereich der Technischen Dokumentation gibt es einige Informationen, wie ein Anleitungstext verständlich geschrieben wird. Am bekanntesten sind wohl die Vorgaben aus der allgemeine Dokumentationsnorm DIN EN 82079-1, die eine Anleitung verständlich machen.

Wirklich spannend sind Anleitungstexte ja nicht. Deswegen ist auch sehr wichtig ein gewisses Interesse an den Inhalten zu wecken. Anschauliche Text wirken nun mal ansprechender als chaotische Satzkonstruktionen.

Lange Satzkonstruktionen mit mehreren Aussagen verwirren den Benutzer. Ein Satz sollte nicht mehr als eine Aussage enthalten. Lange Schachtelsätzen sollten daher vermieden werden. Eine gute Technische Redaktion spaltet unverständliche Bandwurmsätze in kleine Informationshappen auf. In der Kürze liegt die Würze, sagt ein bekanntes Sprichwort. Eine verständliche Satzlänge beträgt durchschnittlich 15 Wörter. Längere Sätze dürfen durchaus vorkommen. Entscheidend ist hier den richtigen Rhythmus zu finden. Bringen sie längere und kürzere Sätze abwechselnd in Ihren Text. Ab 30 Wörter ist ein Satz nur noch sehr schwer verständlich.

Formaler und unpersönlicher Satzbau sind keine interessanten Inhalte für den Leser. Dieser möchte gerne direkt angesprochen werden. Benutzen Sie Personalpronomen wie „Sie“ und „Ihr“.

• Achten Sie dabei, dass die Pronomen groß geschrieben sind.
• Verwenden Sie kein privates „Du“.
• Machen Sie den Text lebendiger, indem Sie Verben einfließen lassen.

Das klingt ansprechender als wenn die Sätze in einemunpersönlichen Passiv formuliert wären. Passiv eignet sich nur für Beschreibungen und Erklärungen, in denen die Benutzer nicht wichtig sind. Trotzdem sollte Passiv nicht im Überfluss verwendet werden, da die Sätze länger ausfallen und schwerfällig zu lesen sind. Mit dem Leser in Kontakt zu treten und eine aktive Schreibweise zu verwenden, ist daher immer die bessere Lösung.

In technischen Texten kommen häufig Nominalisierungen vor. Das ist wenn ein Verb durch ein Substantiv ersetzt wird und nur wenige Verben im Text vorkommen.

Durch Drucken der Taste „Start“, kann die Maschine gestartet werden

Hier sollte eine bessere Formulierung mit dem Einsatz von Verben gewählt werden, wie:

Drücken Sie die Taste „Start“, um die Maschine zu starten.

Man sieht, dass der Einsatz von Verben schon wichtig ist. Eine verständliche Schreibweise hängt sehr vom Zielpublikum und der Textfunktion ab. Das geschriebenen sollte nicht zu formal oder zu umgangssprachlich ausfallen.

Den Text mit unnötigen Füllwörtern auszustatten, gehört ebenfalls zu der Art die Verständlichkeit einer Anleitung eher zu verschlechtern als zu verbessern.

„Eigentlich“, „selbstverständlich“, „des weiteren“ und „gewissermaßen“ sind nur einige Beispiele für Füllwörter. Man erkennt diese Wörter daran, dass Sie keinen inhaltlichen Mehrwert bieten. Es empfiehlt sich eine Liste anzulegen, welche alle Floskeln enthält, die nicht in die Technische Dokumentation gehören.

Wenn etwas doppelt vorgeschrieben wird, heißt das nicht, dass es besser hält. Gemeint ist hierbei die Doppelte Verneinung. „Nichts Genaues weiß man nicht“ …. Ist solch ein Beispiel. Oder der Titel eines bekannten Liedes: „Keine Macht für Niemand“. Solche Konstrukte werden nicht gut vom Leser verstanden, daher sollte man in der Anleitung darauf verzichten.

Auch hierfür habe ich ein Beispiel:

Stellen Sie vor dem elektrischen Anschluss der Maschine sicher, dass die Leiter nicht kurzgeschlossen und geerdet sind.

Nun ist bei diesem Satz nicht ganz klar ob beides ausgeschlossen ist. Dürfen die Leiter nur nicht kurzgeschlossen sein oder auch nicht geerdet.

Hier wäre eine direkte Trennung anschaulicher. Man könnte beispielsweise eine Aufzählung wählen wie folgt:

 Stellen Sie vor dem Anschluss der Maschine sicher:

1. Die Leiter sind nicht kurgeschlossen
2. Die Leiter sind nicht geerdet

 Auch wenn diese Lösung nicht elegant ist und ein wenig lang ausfällt, ist diese Art der Darstellung gut verständlich.

Fachbegriffe in der Betriebsanleitung einheitlich zu benennen sorgt für Verständlichkeit und Eindeutigkeit. Die Begriffe sollten durchgängig in gleicher Weise verwendet werden.

Wenn Fremdwörter und/oder Fachbegriffe nicht zu vermeiden sind, gilt es diese konkret zu erläutern. Das Festlegen auf eine vorrangige Benennung von einem Fachausdruck ist auch als Terminologie bekannt.

Eine gleichbleibende Benennung ist eine Basis für Wiederverwendung, Konsistenz und Verständlichkeit der Fachbegriffe in einer Betriebsanleitung.

In der Produktentwicklung kommt es häufig genug vor, dass sich Inhalte und Fachausdrücke von Dokument zu Dokument unterscheiden. Die unterschiedliche Namensgebung sorgt dann für Verwirrung unter den Benutzern und Abteilungen. So könnte beispielsweise die Werbeabteilung des Herstellers annehmen, dass es sich um verschiedenen Produkte handelt, obwohl nur unterschiedliche Begriffe für dasselbe Produkt verwendet wurden. Daher ist es sinnvoll eine (Terminologie-)Datenbank mit verwendeten Fachbegriffen zu pflegen, um einheitlich und strukturiert arbeiten zu können.

Der Nutzer muss es mit der Anleitung möglich sein, die Maschine bzw. Anlage sicher zu bedienen. Die Nutzerinformationen soll dem Anwender vorgeben welche Arbeitsschritte er ausführen muss oder welches Verhalten er unterlassen muss.

Beim Schreiben der Anleitung muss man daher konkret bleiben hinsichtlich der Durchführung von Anweisungen. Hierbei ist es nicht sinnvoll, seinen Text mit Weichmachern auszustatten. Weichmacher sind Worte wie „sollen“ und „können“ und signalisieren nicht die notwendige Dringlichkeit der Anweisung. Daher sollte man auch auf die entsprechende Befehlsform zurückgreifen.

Gutes Beispiel für einen Weichmacher in der Anleitung ist folgender Satz:

Wenn der Kunststoffring beschädigt ist, sollte er ersetzt werden.

Sollte ersetzt werden, klingt so nach einem optionalen Schritt. Das muss ich ja nicht unbedingt machen.

Für diesen Satz ist eine bessere Formulierung zu wählen wie:

Ersetzen Sie den Kunststoffring, wenn er beschädigt ist.

In dieser Befehlsform leitet man den Benutzer genau an und gibt ihm nicht die Wahlmöglichkeit, wie das bei der Verwendung von Weichmachern in der Anweisung der Fall ist.

Kurz und prägnant die Anweisungen an den Benutzer weitergeben, dies ist der dritte Aspekt einer verständlichen Anleitung.

Keep it simple and stupid ist ein gutes Leitmotto, um dem Benutzer alle benötigten Inhalte zur Verfügung zu stellen. Wenn man die grundlegenden Regeln für die Erstellung einer Betriebsanleitung beachtet, hat man gute Texte mit denen man sicher anleiten kann.