Überspringen zu Hauptinhalt

RA #004 Technische Dokumentation schreiben – Tipps & Tricks

RA #004 Technische Dokumentation Schreiben – Tipps & Tricks

Eine Dokumentation schreiben ist eine Herausforderung. Diese soll nicht zu aufgebläht daher kommen aber doch alles notwendige Wissen vermitteln. Mit Hilfe einiger weniger Regeln gelingt Ihnen auch dieser Spagat zwischen Umfang und Verständlichkeit.

Das wichtigste zuerst

Eine wichtige Regel im Schreiben für so ziemlich jede Textart ist, dass der interessanteste und wichtigste Inhalt an den Anfang gehört. Die ersten Sätze sollen den Leser abholen und seine Neugier wecken.

Der Leser möchte in der Dokumentation seine W-Fragen (wer, was, wann, wo, wie, warum) beantwortet haben. Und dies natürlich mit einem möglichst geringen Zeitaufwand. Die richtigen Details daher kurz und treffend zu beschreiben machen eine gute Dokumentation aus.

Um dies zu erreichen, sollte man zuerst vor dem Schreiben nachdenken, was man eigentlich für wen schreiben möchte. Das fängt schon dabei an, wie die einzelnen Sätze formuliert sind.

Kurze Sätze und einfachen Satzbau

Umso komplizierte die Satzkonstruktion ist, desto weniger verstehen die Leser die Inhalte. Allgemeine Verständlichkeit ist jedoch ein wichtiges Ziel in der Erstellung von redaktionellen Inhalten. Eine Betriebsanleitung für eine Maschine, welcher der Bediener nicht versteht, ist nicht gerade vorteilhaft für den Hersteller der Maschine. Im Gegenteil, dies kann sogar als ein Produktfehler im Sinne des Produktsicherheitsgesetz es gesehen werden.

Kommen wir aber wieder zum Satzbau. Dieser muss von der Zielgruppe verstanden werden. Viele Nebensätze und Einschübe erschweren die Verständlichkeit des Textes. Daher sollte man Nebensätze eher in Hauptsätze umwandeln. Ein Einschub gehört entweder ans Ende eines Satzes oder bildet wiederum einen eigenen Satz.

Schreibe auch entlang deines roten Fadens, um den Leser nicht zu oft auf andere Inhalte umzuleiten. Im Falle der Betriebsanleitung sollte der Verfasser in einem Satz auch nur maximal eine Handlungsanweisung aufführen. Formuliere dabei in kurzen und prägnanten Sätzen deine Inhalte. Dein Text sollte nur wenige sehr lange Sätze beinhalten. Weniger Worte für einen Satz sind meisten mehr. Sätze mit mehr als 20 Wörtern sind zudem nicht verständlich.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Auf den Stil kommt es an

Aber auch der Stil beim Erstellen von Texten ist wichtig. Nur lange Sätze ermüden den Leser. Viele kurz geschriebene Sätze nacheinander sind aufdringlich. Auf den Mix kommt es an. Die Abwechslung von langen und kurzen Sätzen lockert den geschriebenen Text auf.

Neben der Variierung der Satzlängen, gibt es natürlich noch weitere Stilregeln beim Schreiben zu beachten. Ich komme nun im Folgenden auf einige dieser Regeln zu sprechen.

Textorganisation

Eine logische Struktur und Abfolge der Inhalt ist das A und O jeden Textes. Die Organisation des Textes gehört zu den wichtigsten Regeln. Wo fange ich mit dem Erklären an, was darf ich von meinen Lesern erwarten und wie genau muss ich Dinge im Detail erklären.

Der Leser soll die Struktur des Textes schnell erfassen können. Daher ist es sinnvoll, diese am Anfang explizit in knapper Form aufzuschreiben.

  • Wie sind beispielsweise Handlungsschritte gekennzeichnet?
  • Was bedeuten fett gekennzeichnete oder kursiv dargestellte Begriffe?

Gerade durch Aufzählungen erlaubt man dem Leser sich durch den Text „querzulesen“. In der Technischen Dokumentation steht meisten mehr Text als der Leser benötigt. Umso schneller sich ein Leser durch die Inhalte querlesen kann, um nur seine benötigten Information zu finden, desto qualitativ besser empfindet der Leser auch die Dokumentation.

Wähle die richtige Überschrift

Der erste Blick des Benutzers fällt fast immer auf das Inhaltsverzeichnis in eine Technische Dokumentation. Der Nutzer möchte nur einen Teil der Informationen wirklich lesen. Deswegen sucht man seine gewünschten Informationen erst im Inhaltsverzeichnis und „navigiert“ dann zu der betreffenden Stelle bzw. Seite.

Innerhalb des Textes lockern kleinere Zwischenüberschriften über einzelnen Absätzen den Text auf und machen Ihn leichter lesbar.

Schreibe im aktiven Schreibstil

Die Technische Dokumentation sollte auch in einem aktiven Schreibstil verfasst sein. Die passive Schreibweise ist in der deutschen Grammatik auch als „Leideform“ bekannt. Aussagen in Betriebsanleitungen lassen sich gut aktiv ausdrücken wie z.B.: „Beachten Sie die Sicherheitshinweise in dieser Anleitung.“

Spreche den Leser an

Der Leser sollte sich auch angesprochen fühlen. Verschanzen Sie sich beim Text verfassen nicht hinter einer unpersönlichen Ausdrucksweise. Eine Anweisung wie „Der Schalter ist zu drücken“ ist für den Leser nicht sonderlich ansprechend. Wird er hingegen direkt mit „Drücken Sie den Schalter“ aufgefordert, fühlen Sie sich als Leser auch mehr angesprochen und handeln auch dementsprechend.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Die richtigen Verben wählen

Mit den richtigen Verben kann der Leser gut angeleitet werden. Verben sind zudem besser wie Substantive.

Betrachten wir doch die Aussage:

Ein Erfordernis für den Start der Maschine ist die Betätigung des Hauptschalters.

Diese Anweisung ist mit einem Verb natürlich viel verständlicher zu lesen als mit einem Substantiv.

Um die Maschine zu starten, bestätigen Sie den Hauptschalter.

Das klingt doch viel besser, oder?

Falls Sie doch Substantive verwenden, gibt es auch hier bestimmte Feinheiten zu beachten. Formulierungen wie „kann“, „muss“ oder „soll“ haben so Ihre Tücken in der Technischen Dokumentation. Der Begriff „Kann“ lässt dem Benutzer die Option eine Aktion vorzunehmen oder nicht. „Soll“ stellt eine Empfehlung dar, ist also ebenfalls nur optional. Das „Muss“ hingegen ist verpflichtend, der Nutzer muss den beschriebenen Vorgang durchführen.

Als Beispiel führe ich hier eine Voraussetzung für die Reinigung einer Maschine auf:

Die Maschine muss vor Reinigungsarbeiten ausgeschaltet werden.

Dem Leser wird durch diese Aussage vermittelt, dass diese Voraussetzung zwingend gilt. Das Ausschalten der Maschine vor der Reinigung ist keine Wahloption.

Weitere Feinheiten in der Textgestaltung

Neben dem Einsatz von Verben und Substantiven gibt es auch weitere Feinheiten bezüglich der Textgestaltung zu beachten. Ziel der Informationsvermittlung ist es ja in einfachem, verständlichem und interessantem Deutsch die benötigten Technischen Informationen zu vermitteln.

Ausdrücke in Form von Fach- und Fremdwörtern können den Leser ablenken und irritieren. Das führt im schlimmsten Fall dazu, dass er den Text außer Acht lässt oder aufhört ihn zu lesen. Anstatt einen Kauderwelsch-Begriff zu verwenden, gibt es sicher eine Möglichkeit diesen Ausdruck in einem verständlichem Deutsch abzubilden.

Ein Beispiel hierfür:

In der User-Datenbank kann man den Workflow managen.

Das lässt sich so doch auch gut ausdrücken:

In der Benutzerdatenbank lässt sich der Arbeitsablauf verwalten

Auch sollte nach Möglichkeit keine Abkürzungen und Akronyme verwendet werden. Wenn sich diese nicht vermeiden lassen, sind diese bei der ersten Nennung zu erläutern. Beispielsweise kann der Begriff dann in Klammern hinter der Abkürzung stehen oder die Abkürzung steht in Klammern nach dem Begriff. Ein Glossar bietet sich im Falle einer Betriebsanleitung ebenfalls an, wenn viele Abkürzungen darin vorkommen.

Doppelten Inhalt gilt es zudem auch zu vermeiden. Eine häufige Verwendung von den gleichen Warnungen ist ein Beispiel für übertriebenes Warnen. Dies steht für einen schlechten Stil in einer Betriebsanleitung, da dies nicht die Aufmerksamkeit des Lesers fördert.

Zusammenfassung

Bevor dieser Folge zu Ende geht, möchte ich noch die wichtigsten Punkte zusammenfassen.

  1. Orientierte dich an der Message deines Textes
    Dein Text soll die üblichen W-Fragen des Benutzers (wer, was, wann, wo, wie, warum) beantworten
  2. Denke an deine Leser
    Schreibe entsprechend deiner Zielgruppe und leite diese mittels einem roten Faden durch das Dokument
  3. Schreibe wie Du sprichst und feile das Ergebnis dann aus
    Bringe mit den vorgestellten Stilregeln deinen Text in eine klare Struktur
  4. Halte dich nicht zu fest an eine Regel
    Die sture Einhaltung aller Stilregeln kann auch zu schlechten Resultaten führen. Es ist wichtig eine Korrektheit anzustreben, jedoch sollte man offen für abweichende Lösungen sein, die am angemessensten erscheinen. Ausnahmen bestätigen bekannter Weise die Regel.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen