Wie Techies besser texten

Technische Themen verständlich beschreiben

Marc Achtelig betreibt ein Ingenieurbüro für Technische Kommunikation mit Schwerpunkt Softwaredokumentation. Er schreibt und konzipiert seit mehr als 20 Jahren Benutzerhandbücher, Online-Hilfen und Screencasts und unterstützt Unternehmen dabei, die Qualität ihrer Benutzerdokumentation zu verbessern. Außerdem unterrichtet er an der Hochschule Karlsruhe im Fach Online-Dokumentation.
Technische Inhalte einfach zu vermitteln, kann ganz schön schwierig sein. Wir geben Ihnen Tipps, wie Sie die Lesbarkeit von Bedienungsanleitungen, Spezifikationen, Marketing-Unterlagen und anderen technischen Texten entscheidend verbessern.

Jeder kann schreiben, aber nicht jeder kann so schreiben, dass es jeder versteht. Denken Sie zum Beispiel an die vielen unverständlichen Bedienungsanleitungen, die außer einem Kopfschütteln und Achselzucken bei ihren Lesern nur wenig bewegen.

Wenn Handbuch und Online-Hilfe unverständlich sind, können viele Kunden nur einen Bruchteil der Funktionen nutzen, die ihnen ein Produkt eigentlich bietet. Nicht nur für die Kunden ist das schade, sondern auch für die Hersteller, die die Funktionen mit viel Aufwand und Kosten implementiert haben. Zusätzlich entsteht hoher Aufwand für den Kundensupport.

Bei unternehmensinternen Dokumenten sieht es nicht besser aus. Viel Zeit und Geld geht verloren, wenn zum Beispiel die Inhalte einer Spezifikation oder die Kommentare im Quellcode einer Software nur schwer oder sogar falsch verstanden werden.

How to Write That F***ing Manual

Foto: indoition

Die Tipps in diesem Artikel basieren auf dem Buch von Marc Achtelig: Basiswissen Technische Dokumentation: „How to Write That F***ing Manual“ – Ohne Umschweife zu benutzerfreundlichen Handbüchern und Hilfen, zweisprachige Ausgabe Englisch + Deutsch

Informationen und Bezugsquellen zum Buch finden Sie unter http://www.indoition.com/de/products/index.html.

Aber es geht auch anders. Wir zeigen Ihnen, wie.

Tipp 1: Schreiben Sie für Ihre Zielgruppe, nicht für sich selbst

Schreiben Sie Ihren Text nicht so, wie Sie ihn selbst gerne lesen würden, sondern so, wie Ihre Leser ihn brauchen. Schreiben Sie nicht das, was Sie sagen möchten, sondern das, was Ihre Leser wissen müssen.

Hieraus ergibt sich eine der wichtigsten Anforderungen an die Gliederung eines Benutzerhandbuchs: Gliedern Sie ein Benutzerhandbuch oder eine Online-Hilfe nicht entsprechend der Funktionslogik des Produkts (typische Denkweise des Entwicklers), sondern entlang der Aufgaben und Ziele der Benutzer. Da die Benutzer die Funktionslogik des Produkts beim Lesen noch nicht kennen, werden sie bei einer funktionslogischen Gliederung die gesuchten Informationen nicht finden.

Nicht:

  • HDMI

  • DVI

  • RS232

  • RJ45

Sondern:

  • Gerät mit einen Fernseher verbinden

  • Gerät per Kabel mit einem Router verbinden

  • Gerät drahtlos mit einem Router verbinden (WLAN)

Tipp 2: Werfen Sie nicht alles in einen Topf

Die wenigsten Benutzer lesen ein Benutzerhandbuch von vorne bis hinten durch. Die Leser eines Benutzerhandbuchs benötigen eine bestimmte Information und möchten dann so schnell wie möglich mit dem Produkt weiterarbeiten.

Stopfen Sie nicht alle Informationen in ein Kapitel in der Hoffnung, die Leser würden sich dann schon das für sie Passende heraussuchen. Selbst falls den Lesern das gelingt: Glücklich wird damit niemand, denn jeder muss eine Menge irrelevanter Dinge lesen, die ihn im Augenblick gar nicht interessieren. Aus Sicht der Leser wird Ihr Dokument damit als wenig hilfreich empfunden.

Trennen Sie stattdessen die Informationen entsprechend dem Informationsbedarf Ihrer Leser. Trennen Sie insbesondere nach den unterschiedlichen Informationstypen "Grundlagen", "schrittweise Anleitungen" und "Referenzinformationen zum Nachschlagen". Kein Benutzer benötigt alle dieser Informationstypen gleichzeitig.

Nicht:

  • Berichte

Sondern:

  • Grundlegendes zu Berichten

  • Einen Bericht erstellen

  • In Berichten verwendbare Datenfelder

Weitere Kriterien, nach denen Sie die Informationen trennen können, sind zum Beispiel Benutzergruppe oder Vorwissen.

Die Trennung der Informationen muss nicht auf die Kapitelebene beschränkt bleiben. Auch innerhalb eines Kapitels können Sie die Informationen trennen und unter jeweils eigene Zwischenüberschriften stellen.

Tipp 3: Finden Sie sprechende Überschriften

Wie die Überschrift eines Handbuchkapitels oder einer Hilfeseite formuliert ist, entscheidet, ob sich ein Leser die Zeit nimmt, mit dem Lesen zu beginnen. Hält der Inhalt nicht, was der Leser unter der Überschrift erwartet hat, wird er das Lesen Ihres Dokuments als Zeitverschwendung empfinden - ganz unabhängig von der Qualität des Inhalts.

Aus der Überschrift sollte klar hervorgehen:

  • Um was geht es?

  • Wie tiefgehend und anspruchsvoll sind die Informationen?

  • Um welchen Informationstyp handelt es sich: um konzeptionelle Grundlagen, um eine schrittweise Anleitung, oder um Referenzinformationen zum Nachschlagen?

Nicht: Überblick

Sondern: Überblick über mögliche Ausgabeformate

Nicht: Berichte

Sondern: So erstellen Sie einen einfachen Bericht

Tipp 4: Formulieren Sie im Aktiv und sprechen Sie den Leser direkt an

Passivsätze verschleiern Verantwortlichkeiten und drücken sich um konkrete Aussagen. Nicht zuletzt daher sind sie bei Politikern so beliebt. Jeder kennt die klassischen Formulierungen, wie "Es wurden Fehler gemacht" oder "Es bleibt zu prüfen".

Als Autor eines technischen Textes müssen Sie klar zu Sache kommen. Schreiben Sie im Aktiv und sprechen Sie die Leser persönlich an.

Nicht: Die Sollzeit kann auch geändert werden.Nicht: Es ist auch möglich, die Sollzeit zu ändern.Nicht: Die Sollzeit lässt sich auch ändern.Nicht: Man kann die Sollzeit auch ändern.Sondern: Sie können die Sollzeit auch ändern.Oder: Ihr Vorgesetzter kann die Sollzeit auch ändern.

Nicht: Es wird empfohlen, täglich eine Sicherungskopie zu erstellen.Sondern: Wir empfehlen, täglich eine Sicherungskopie zu erstellen.Oder: Die Norm DIN XY empfiehlt, täglich eine Sicherungskopie zu erstellen.Oder: Erstellen Sie täglich eine Sicherungskopie, um einem möglichen Datenverlust optimal vorzubeugen (Empfehlung nach DIN XY).