Wie Techies besser texten
Technische Themen verständlich beschreiben
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.
- Technische Themen verständlich beschreiben
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. - 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. - 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. - 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. - 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". - Formulieren Sie parallel
In technischen Texten sind gleichförmig aufgebaute Überschriften und Sätze kein Zeichen eines schwachen Schreibstils, sondern ein wichtiges Mittel, das Verständnis zu erleichtern. Bei einem wiederkehrenden Satzmuster kann sich der Leser voll auf die Inhalte konzentrieren. Der Text wird dadurch schnell erfassbar und somit besser verständlich. - Beginnen Sie mit den wichtigsten Informationen
Durch das Vorziehen der wichtigsten Informationen erleichtern Sie Ihren Lesern das selektive Querlesen und erhöhen die Wahrscheinlichkeit, dass zumindest Ihre Kernaussagen Beachtung finden. - Haben Sie Mut zur Einfachheit
Technische Themen sind kompliziert genug, da sollten Sie die Struktur der Dokumente und die Sprache einfach halten. Versuchen Sie nicht durch lange Sätze, komplexe grammatikalische Konstrukte oder eine Vielzahl von Fremd- und Fachwörtern zu beeindrucken. Viel wichtiger ist die Verständlichkeit! - Scheuen Sie sich nicht, Wörter zu wiederholen
Die Zeiten, in denen Sie Ihrem Deutschlehrer beweisen mussten, über welch großen Wortschatz Sie verfügen, sind vorbei. Befreien Sie sich von dem Trauma, kein Wort wiederholen zu dürfen. Sie dürfen! Ja, Sie sollten es sogar, denn vielfach kann eine Wortwiederholung Mehrdeutigkeiten beseitigen oder einen Text besser lesbar machen. Die Leser sind mit den technischen Inhalten ohnehin genug gefordert - da darf wenigstens die Sprache einfach sein. - Vermeiden Sie überflüssige Fachwörter und Abkürzungen
Sprechen Sie die Sprache Ihrer Leser. In einem Fachartikel oder in einer technischen Spezifikation sind Fachwörter durchaus angebracht, in einer Bedienungsanleitung oder in anderen Dokumenten für Benutzer sind sie meist fehl am Platz. Falls Sie ein Fachwort nicht ersetzen können, erklären Sie es beim ersten Vorkommen. - Vermeiden Sie überflüssigen Ballast
Viele Menschen glauben, das Einfügen gewisser Wörter und Floskeln ließe ihren Text "eleganter" klingen. Das Gegenteil ist der Fall. Durch heiße Luft wird Ihr Text nur länger, nicht besser. Das kostet den Leser mehr Zeit beim Lesen und Sie mehr Geld für Druck und bei eventuellen Übersetzungen in Fremdsprachen.
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
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.