Technische Dokumentationen erstellen: Verständlichkeit kommt bei Weiterbildungen zu kurz

Verständlichkeit in technischen Dokumentationen ist wichtig. Doch nur wenige Weiterbildungsangebote legen darauf besonderen Wert.

Nach Aussagen von Experten aus der WORTLIGA-Community lernen technische Redakteure zu selten, verständlich zu schreiben. Von zwölf untersuchten Seminar-Angeboten (Recherche auf Google-Seite 1) erwähnten nur fünf Angebote Verständlichkeit als Lehrinhalt. Zu diesen Anbietern gehören der TÜV-Nord, der TÜV-Rheinland, das VDI Wissensforum, das Institut für technische Literatur AG und die tecteam GmbH.

Sprache und Aufbau von Dokumentationen: Zu selten auf den Anwender ausgerichtet

Wie der TÜV Rheinland in seinem Blog „QM aktuell“ berichtet, ist die Sprache der typischen Systemdokumentationen „auditorisch“. Das bedeutet, sie ist auf Normen, Auditoren und die Erlangung von Zertifikaten ausgerichtet. Diese Sprache errichtet hohe Hürden für das Verständnis.

Viele Qualitätsexperten etwa sprechen laut TÜV Rheinland nur noch in der Sprache von Normen und technischen Modellen über Qualitätsmanagement. Diese Sprache schließt viele Menschen aus. Die ISO 9001 unterstreiche aber explizit die Bedeutung der Kommunikation für ein wirksames Qualitätsmanagement.

Tipps für verständliche Dokumentationen

Für effektive technische Dokumentationen gilt: Behalte die Bedürfnisse des Nutzers im Blick. Präsentiere die Informationen klar, präzise und leicht verständlich. Diese Checkliste gibt Dir Tipps und Methoden dafür. 

• Berücksichtige Deine Zielgruppe:
  Schreibe für den Anwender, nicht für Dich selbst.
  Passe den Fachjargon an die Zielgruppe an.
  Ein Benutzer ohne Vorkenntnisse sollte das Produkt bedienen können.
• Wähle aussagekräftige Titel und Untertitel:
  Verwende konkrete und relevante Überschriften.
  Nutze Fragesätze, um die Gedankengänge des Anwenders zu simulieren.
  Arbeite nach dem Zwiebelschalenprinzip: Überblick -> Details.
• Achte auf eine übersichtliche Präsentation:
  Verwende Inhaltsverzeichnisse, Stichwortverzeichnisse, Listen, Infokästen und Zusammenfassungen.
  Gestalte die Dokumentation so, dass Informationen leicht zu finden sind.
• Gib klare, präzise Anweisungen:
  Verwende kurze Sätze und relevante Wörter.
  Schreibe eindeutig und vermeide unklare Wörter.
  Sei direkt und wiederhole bei Bedarf Anweisungen.
• Nutze Screenshots und visuelle Elemente:
  Verwende Bilder und Screenshots, um komplexe Sachverhalte zu erklären.
  Ergänze visuelle Elemente mit Erklärungen und Anmerkungen.
• Biete Videos an:
  Kombiniere Textinhalte mit Videos, um Vorgänge zu verdeutlichen.
  Nutze Schritt-für-Schritt-Anleitungen in Textform und begleitende Videos.
• Mache Deine technische Dokumentation leicht auffindbar:
  Nutze Online-Plattformen statt gedruckter Handbücher.
  Aktualisiere digitale Formate bei Bedarf.
  Optimiere Deine Dokumentation für wichtige Suchbegriffe.
• Integriere eine Suchfunktion:
  Ermögliche es Nutzern, Informationen schnell durch eine Suchfunktion zu finden.
• Gib Beispiele:
  Beispiele erleichtern die Umsetzung.
• Nutze ein Textanalyse-Tool
  Tools wie die WORTLIGA Textanalyse helfen Dir beim verständlichen Schreiben. Das Tool zeigt dir die Lesbarkeit Deines Textes an, errechnet das Sprachniveau und gibt Dir KI-Vorschläge für verständliche Formulierungen: