Technische Dokumentation schreiben: Schritt für Schritt zum Glück

Wie gelingt es, sich verständlich auszudrücken? Diese Frage hat sich schon Martin Luther gestellt. Seine Antwort: „…die Kinder auf den Gassen, den gemeinen Mann auf dem Markt drum fragen und denselbigen aufs Maul sehen, wie sie reden…“ [1] Vielleicht würden wir das heute etwas anders formulieren, aber im Prinzip trifft es den Kern. Achten Sie auf Ihre Zielgruppe, deren Vorkenntnisse und Reaktionen und Sie werden eine Technische Dokumentation schreiben, die alle glücklich macht.

 

 

Technische Dokumentation schreiben – worüber reden wir eigentlich?

 

Die Aufgaben der Technischen Dokumentation sind vielfältig. Sie begleitet die innerbetrieblichen Projekte, informiert die Öffentlichkeit über Erzeugnisse und erstellt die Unterlagen für den Gebrauch der Produkte. Die Nutzungs-Unterlagen haben einen besonderen Stellenwert. Bedienungs-, Montage- und Wartungsanleitungen müssen darlegen, wie die entsprechenden Arbeiten ablaufen sollen und wie die Sicherheit dabei gewahrt wird. Deshalb unterliegt dieser Bereich der Technischen Dokumentation klaren gesetzlichen Vorschriften (z.B. Maschinenrichtlinie) und verschiedenen technischen Normen (z.B. EN 82079).

 

Wenn wir uns überlegen wollen, wie eine gute Technische Dokumentation zu schreiben ist, wenden wir uns am besten den Anleitungen zu. Was hier gilt, nutzt auch den anderen Teilbereichen.

 

 

Die gleiche Sprache sprechen

 

Im direkten Gespräch erkennen Sie an der Reaktion Ihres Gegenübers sofort, ob er Sie verstanden hat. Achten Sie aufmerksam darauf, wie er sich äußert, können Sie sich auf seine Sprachgewohnheiten einstellen. Die beste Grundlage, eine verständliche Technische Dokumentation zu schreiben, ist folglich, mit den Leuten so oft wie möglich zu reden, für die Sie schreiben wollen.

 

Fast genauso wertvoll sind Rückmeldungen zu den Technischen Dokumentationen, die Sie bereits geschrieben haben. Fragen Sie Ihre Servicekräfte, wenn sie vom Einsatz zurückkommen. Erkundigen Sie sich in der Abteilung, die sich um Reklamationen kümmert. Die im modernen Sprachgebrauch als „User Experience“ bezeichnete Erfahrung der Anwender gibt Ihnen Aufschluss über den Nutzen Ihrer Arbeit und zeigt Ihnen gegebenenfalls, wo es noch hakt.

 

 

user journey dokumentationWas wollen Sie mitteilen, wenn Sie eine Technische Dokumentation schreiben?

 

Mit den gesammelten Informationen gelingt es Ihnen, sich in die Rolle des Montage-, Bedien- und Wartungspersonals hineinzuversetzen. Dabei hilft Ihnen eine Methode, die unter dem Begriff „User Journey“ bekannt ist. Während Sie sich mit den einzelnen Rollen beschäftigen, tragen Sie die Informationen zusammen, die vor jedem Arbeitsschritt bereitstehen müssen. Wenn Sie die Technische Dokumentation schreiben, geben Ihnen die Arbeitsabläufe eine Orientierung. Lassen Sie die einzelnen Handlungen der Reihe nach vor Ihrem inneren Auge ablaufen. Das bringt Ordnung in Ihre Anleitung.

 

Beginnen Sie mit den sicherheitsrelevanten Hinweisen. Fahren Sie mit der Aufzählung aller erforderlichen Materialien und Werkzeuge fort, die vor Beginn der Arbeit bereitliegen sollen. Nun kann es losgehen. Fragen Sie sich bei jedem Arbeitsschritt:

 

  1. Was ist jetzt zu tun?
  2. Welche Risiken sind dabei zu beachten?
  3. Womit wird es gemacht?
  4. An welcher Stelle des technischen Objektes geschieht es?
  5. Welche Hangriffe sind erforderlich?

 

 

Beantworten Sie jede Frage mit einem oder mehreren Hauptsätzen. Formulieren Sie, wenn nötig, eine erforderliche Erläuterung in einem neuen Hauptsatz.

 

 

technische dokumentation illustrationVerständnis durch Abbildungen erleichtern

 

Überlegen Sie anschließend, welcher Hauptsatz durch ein Bild ersetzt oder ergänzt werden kann. Eine Technische Dokumentation schreiben bedeutet auch, Abbildungen gezielt einzusetzen. Denn sie geben mitunter auf den ersten Blick eine Antwort, wo Worte viel zu kompliziert sind.

 

 

Kann jeder verstehen, was Sie in der Technischen Dokumentation schreiben?

 

… oder wenigsten diejenigen, die es betrifft? Die Aufgabe „Technische Dokumentation schreiben“ ist fast geschafft. Abschließend sollten Sie überprüfen, ob das Ergebnis alle Anforderungen an die Verständlichkeit erfüllt. Ein Praxistest wäre hilfreich. Leider steht selten jemand zur Verfügung, der Zeit und Lust hat, die Anleitung auszuprobieren.

 

Bei der Überprüfung, ob ein Text verständlich ist, können Sie das Hamburger Verständlichkeitskonzept anwenden. Darin werden vier Gruppen von Merkmalen definiert, die eine Beurteilung ermöglichen:

 

  • Einfachheit
  • Gliederung/Ordnung
  • Kürze/Prägnanz
  • anregende Zusätze

 

 

Ist die Anleitung einfach?

 

Einfach bedeutet, dass der Text hauptsächlich allgemein bekannte Wörter enthält und aus kurzen Sätzen besteht. Unumgängliche Fachbegriffe erklären Sie so, dass ihre Bedeutung auch für den Laien ersichtlich wird. Fachleute fühlen sich bestätigt, wenn die Erklärung mit ihrem Wissen übereinstimmt. Haben Sie in der Anleitung Fremdwörter gefunden? Ersetzen Sie sie durch gebräuchliche Ausdrücke, schlagen Sie notfalls nach. Ist Ihnen ein „Schachtelsatz“ in die Anleitung geraten? Beschreiben Sie den Sachverhalt schnell neu.

 

 

Folgt die Anleitung einer inneren Ordnung?

 

Nur so lässt sich überhaupt eine Technische Dokumentation schreiben. Schauen Sie trotzdem kurz nach, ob Ihnen die Gliederung gelungen ist. Deutlich gekennzeichnete Haupt- und Zwischenüberschriften sowie kurze, durch Leerzeilen getrennte Absätze ermöglichen es dem Anwender, ganz bestimmte Informationen schnell zu finden. Vielleicht können Sie an einigen Punkten noch die eine oder andere Zwischenüberschrift einfügen.

 

 

technische doku schreibenIst die Anleitung kurz und prägnant?

 

Genauigkeit im Ausdruck ist eine entscheidende Voraussetzung für das Verständnis der Anleitung. Während Sie eine Technische Dokumentation schreiben, fällt Ihnen vielleicht nicht immer das gerade passende Wort ein. Das findet sich oft, wenn Sie Ihren Text mit etwas zeitlichem Abstand durchlesen. Schauen Sie nach, ob Sie einige verwendete Wörter durch eine noch treffendere Bezeichnung ersetzen können.

 

Enthält die Anleitung Passagen, die weinig zur Darstellung der Arbeitsabläufe und der Sicherheit beitragen? Die können Sie getrost weglassen. Fragen Sie sich gelegentlich: Will das jemand wissen, der gerade bei der Arbeit ist?

 

 

Enthält die Anleitung anregende Zusätze?

 

Nein? Das ist gut so. Unter anregenden Zusätzen versteht das Hamburger Verständlichkeitskonzept Sätze, die die Gefühle des Lesers ansprechen und den Text lebendiger erscheinen lassen. Bei Vorträgen oder in Fachartikeln dient das dazu, die Zuhörer oder Leser wach und konzentriert zu halten. Wenn Sie eine technische Dokumentation schreiben, sollten Sie stets sachlich bleiben.

 

Große Gefühlsausbrüche sind hier fehl am Platz – es sei denn, es ist die unbändige Freude Ihrer Anwender über die Dokumentation, die Sie so verständlich verfasst haben. Aber das ist wieder eine andere Geschichte 😉

 

[1] Luther, Dr. Martin, Ein Sendbrief D. M. Luthers vom Dolmetschen und Fürbitt der Heiligen, 1530

 

Bildquellen: Unsplash, Pexels

Ich habe Interesse an einer Schulung

* Erforderliche Felder
Cookie Consent mit Real Cookie Banner