iqd logo

RSS-Abo: Newsfeed | Kommentare | E-Mail

Technisches Schreiben: Nüchterne Informationen präzise und leicht verdaulich vermitteln

16.12.2014 - von - schreiben Kommentar schreiben

Viele Texte stehen in einem Zusammenhang, in dem sie mit anderen Texten um die Aufmerksamkeit des Lesers konkurrieren. Bei technischen Dokumentationen hingegen sucht der Leser in genau diesem Dokument eine bestimmte Information. Damit ändern sich auch die Anforderungen an den Autor.

Bei unterhaltsamem wie journalistischem Schreiben steht oft das Ziel im Mittelpunkt, den Leser überhaupt dazu zu bringen, den Text zu öffnen und bis zum Ende zu lesen. Bei technischen Dokumentationen hingegen will der Leser sehr spezifische Informationen über einen Prozess, ein Gerät oder eine Software erhalten, die sich oft nur innerhalb dieses Dokuments finden lassen. Die Dokumentation konkurriert demnach nicht mit anderen Dokumentationen, sondern sollte dem Leser eine möglichst einfache Möglichkeit bieten, die gesuchten Informationen zu finden oder sich einen groben Überblick zu verschaffen.

Klare Struktur

Wichtigste Voraussetzung für eine schnelle und erfolgreiche Vermittlung technischer Informationen ist eine klare Struktur des Dokuments. Dabei geht es weniger darum, den Leser durch einen Spannungsbogen durch das Handbuch zu führen, sondern vielmehr ein schnelles Auffinden der gesuchten Information zu ermöglichen. Während beispielsweise vierte oder fünfte Unterüberschriften in Fließtexten eher störend sind, bieten sie in Dokumentationen wichtige Orientierung.

Auch muss in technischen Dokumenten nicht jede Information in einen Fließtext einbettet werden. Der Fachblog Copyblogger schlägt stattdessen vor, zentrale Punkte in Stichpunktlisten mit Unterpunkten zu vermitteln. So wird die richtige Information schnell gefunden und erfasst.

Präzise und knappe Sprache

Die Verwendung präziser aber gleichzeitig knapper Sprache ist eine weitere wichtige Voraussetzung für eine gut technische Dokumentation. Dabei zählt weniger die sprachliche Eleganz eines Textes als die klare Übermittlung relevanter Informationen. Ein Beispiel hierfür bietet die Gesellschaft für Technische Kommunikation (tekom) in ihrer Leitlinie “Regelbasiertes Schreiben”. Sie schlägt zum Beispiel vor, “Es sind weitere Maßnahmen erforderlich” zu vereinfachen zu “Weitere Maßnahmen sind erforderlich”.

Auch gilt es, möglichst einfache Begriffe und strukturell passende Satzstrukturen zu wählen. Dabei sollten korrekte Fachbegriffe an den Stellen verwendet werden, an denen sie den Lesern das Verständnis vereinfachen. Ansonsten sollte die Sprache möglichst einfach sein, ohne dabei jedoch an Korrektheit oder Präzision zu verlieren.

Vorwissen und Detailgrad

Um das richtige Maß an Fachsprache zu finden, ist es wichtig, sich bewusst zu machen, über welches Vorwissen Leser dieser Dokumentation üblicherweise verfügen. Dabei sollte man jedoch lieber zu wenig Vorwissen voraussetzen, als zu viel, denn bekannte Informationen lassen sich im Zweifel leichter überfliegen, als unbekannte nachrecherchieren. Auch sollte man vorsichtig sein, mit dem Leser nicht von oben herab zu kommunizieren, sondern ihn als Fachmann ernst zu nehmen.

Schließlich ist es auch wichtig, den angestrebten Detailgrad der Dokumentation abzustecken. Geht es darum, dem Nutzer einen groben Überblick zu verschaffen, der ihn in die Lage versetzt, das Gerät, den Prozess oder die Software möglichst schnell anzuwenden? Oder sollen einem Experten auch die letzten Optimierungsmöglichkeiten und Nuancen vermittelt werden? Auch hier gilt es, ein gesundes Mittelmaß zu finden, das der angestrebten Nutzung der Dokumentation angemessen ist.

Der Zweck heiligt die Sprache

Grundsätzlich gilt, dass der Zweck der Dokumentation für den späteren Leser im Mittelpunkt technischer Texte und Dokumentationen stehen sollte. Es geht nicht darum, den Leser durch poetische Sprache oder spannende Cliffhanger an den Text zu fesseln, sondern darum, ihm möglichst schnell die gesuchte Information zu präsentieren.

<Bildnachweis: Handbuch von Shutterstock>

Schreibe einen Kommentar