Wie Techies besser texten

Technische Themen verständlich beschreiben

09.06.2014
Von 


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.

Wie Techies besser texten

Tipp 5: 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.

Nicht:

  • Berichtedruck

  • Drucken von Briefen

  • Etikettendruck

Sondern:

  • Berichte drucken

  • Briefe drucken

  • Etiketten drucken

Tipp 6: Beginnen Sie mit den wichtigsten Informationen

Stellen Sie die wichtigsten Informationen immer möglichst weit nach vorne:

  • nach vorne im Dokument

  • nach vorne im Kapitel

  • nach vorne im Absatz

  • nach vorne im Satz

Durch das Vorziehen der wichtigsten Informationen erleichtern Sie Ihren Lesern das selektive Querlesen und erhöhen die Wahrscheinlichkeit, dass zumindest Ihre Kernaussagen Beachtung finden.

Die "wichtigsten Informationen" können diejenigen sein,

  • die besonders viele Leser betreffen,

  • die erfolgsentscheidend sind,

  • die sehr früh benötigt werden.

Innerhalb eines Satzes oder innerhalb einer Überschrift sollten Sie immer die Wörter nach vorne stellen, die signalisieren, um was es geht und an welcher Stelle der Leser handeln muss.

Nicht: Bedrucken von Briefumschlägen

Sondern: Briefumschläge bedrucken

(Erklärung: In einem Benutzerhandbuch zu einem Drucker ist klar, dass es um das Thema Drucken geht, also ist das Stichwort "Briefumschläge" die wichtige Information.)

Nicht: Wählen Sie die Option A auf Registerkarte B.

Sondern: Wählen Sie auf Registerkarte B Option A.

(Erklärung: Zuerst muss der Benutzer die Registerkarte wählen, also sollte diese Information vorne stehen. Erst nach der Wahl der Registerkarte wählt er die Option, benötigt die hierzu gehörige Information also auch erst später.)

Tipp 7: 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!

Halten Sie die hierarchische Struktur Ihrer Dokumente so flach wie möglich. In einem Benutzerhandbuch oder in einer Online-Hilfe sollten drei Gliederungsebenen ausreichen. Wenn Sie Überschriften haben wie 3.4.5.2., liegt etwas im Argen. Niemand kann und will eine solche Hierarchie beim Lesen nachvollziehen.

  • Reduzieren Sie die Inhalte auf das Wesentliche. Vieles kann bei näherer Betrachtung entfallen.

  • Teilen Sie komplexe, schwer zu verstehende Themen oder nachvollziehbare Abläufe in mehrere, leicht zu verstehende Themen auf.

  • Teilen Sie lange komplexe Absätze in mehrere leicht zu verstehende kurze Absätze auf.

  • Teilen Sie lange komplexe Sätze in mehrere leicht zu verstehende kurze Sätze auf.

Nicht: Wenn Sie Ihr Passwort ändern möchten, können Sie dies über die Schaltfläche "Neues Passwort eingeben" veranlassen, die Sie auf der Registerkarte "Verwaltung" unter dem Menüpunkt "Optionen" finden.

Sondern: Um Ihr Passwort zu ändern: (1) Wählen Sie den Menüpunkt "Optionen". (2) Aktivieren Sie die Registerkarte "Verwaltung". (3) Klicken Sie auf "Neues Passwort eingeben".

Tipp 8: 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.

Nicht: Auf der Rückseite der Bombe befinden sich ein rotes und ein grünes Kabel. Durchtrennen Sie dieses.

Nicht: Auf der Rückseite der Bombe befinden sich ein rotes und ein grünes Kabel. Durchtrennen Sie letzteres.

Nicht: Auf der Rückseite der Bombe befinden sich ein rotes und ein grünes Kabel. Durchtrennen Sie die grüne Leitung.

Sondern: Auf der Rückseite der Bombe befinden sich ein rotes und ein grünes Kabel. Durchtrennen Sie das grüne Kabel.

Nicht: Klicken Sie auf Schaltfläche A, drücken Sie danach auf Knopf B, und betätigen Sie abschließend Button C.

Sondern: (1) Klicken Sie auf Schaltfläche A. (2) Klicken Sie auf Schaltfläche B. (3) Klicken Sie auf Schaltfläche C.

Tipp 9: 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.

Fremdwörter, Anglizismen und Abkürzungen sollten Sie generell vermeiden.

Nicht: RAM

Sondern: Arbeitsspeicher

Nicht: Interface

Sondern: Schnittstelle oder Anschluss

Tipp 10: 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.

Nicht: Eigentlich wäre dieser Satz ohne Füllwort besser.Sondern: Ohne Füllwort wäre dieser Satz besser. (Das Wort "eigentlich" hat keinerlei Bedeutung.)

Nicht: Wenn Sie hundertprozentig sichergehen wollen, …

Sondern: Wenn Sie sichergehen wollen, … ("Sichergehen" bedeutet immer hundert Prozent.)

Nicht: Nähere Einzelheiten finden Sie im Kapitel …

Sondern: Einzelheiten finden Sie im Kapitel … (Einzelheiten sind immer "näher".)

Nicht: Die Lampe zeigt den aktuellen Status.

Sondern: Die Lampe zeigt den Status. (Ein Status ist immer "aktuell".)

Nicht: Das Passwort besitzt eine Gültigkeit für die Dauer einer Stunde.

Sondern: Das Passwort gilt eine Stunde.

Nicht: Auf Grund der Tatsache, dass …

Sondern: Weil …

Sind Sie noch immer nicht "restlos überzeugt", dass auch Ihre Texte in Zukunft noch verständlicher werden können? Macht nichts. Es reicht schon, wenn Sie nur "überzeugt" sind …

Viel Erfolg!