Print
extra_toc

Regelwerk für die Erstellung von Hilfethemen:

  1. Anrede Personalisieren Sie Aktion, Beschreibungen hingegen erfolgen neutral. Beispiel für Anweisung: "Zum bearbeiten der Stammdaten klicken Sie hier..." statt "Durch anklicken des Button könne die Stammdaten bearbeitet werden... " / Beispiel für Beschreibung: „Dieses Bild zeigt….“ statt „In diesem Bild sehen Sie…“
  2. Das Wichtigste im Satz zuerst In einem Satz sollte das Wichtigste immer zuerst genannt und außerdem auf eine logische Handlungsabfolge geachtet werden. Zum Beispiel könnte die Anweisung „Öffnen Sie die Abdeckung, nachdem Sie die Maschine ausgeschaltet haben.“ falsch verstanden werden. Logisch wäre hier eine andere Reihenfolge: „Schalten Sie die Maschine aus. Öffnen Sie die Abdeckung.“
  3. Kurze Sätze mit einer eindeutigen Aussage Kurze Sätze mit klaren Anweisungen lassen kaum Raum für Interpretationen. Ideal ist eine eindeutige Aussage pro Satz. Einschübe, Relativsätze und sogenannte Linkserweiterungen machen den Satz komplizierter und sorgen für ein größeres Fehlerrisiko.
  4. Positivformulierungen, Gebote und keine Verbote Vermeiden Sie (doppelte) Verneinungen und formulieren Sie positiv. Schreiben Sie, was die Person tun soll und nicht, was er lassen soll. Die Anweisung „Unbefugten Personen ist es nicht erlaubt, den Sicherheitsbereich zu betreten.“ ist eine Negativformulierung und ein Verbot. Positiv formuliert wäre „Sicherheitsbereich um die Maschine absperren.“ eine deutlich bessere und kürzere Anweisung.
  5. Füllwörter streichen Durchsuchen Sie den Text nach Wörtern wie „aber“, „unter anderem“, „verschiedene“ oder „eigentlich“. Diese Wörter sagen nichts aus und blähen den Text unnötig auf. Außerdem schränken sie die unter Punkt 2 beschriebene Eindeutigkeit ein und sorgen für Interpretationsspielraum.
  6. Falsche Fachbegriffe/Terminologie Die richtige Verwendung von Fachbegriffen und Terminologie sollte in der technischen Dokumentation eine Selbstverständlichkeit sein. Weit gefehlt, denn trotz verschiedenster Hilfsmittel, die für die Texterstellung verfügbar sind, werden verschiedenste Begriffe für ein und dieselbe Sache verwendet.
  7. Ausdruck Ausdrucksfehler sind keine Feinheiten, sondern Fehler, die nicht vernachlässigt werden können. Zum Beispiel passen Substantiv und Verb in einem Satz nicht zusammen. Im Satz „Der*die Anwender*in verfolgt eine ungünstige Technik“ befindet sich ein Ausdrucksfehler, denn eine Technik wird nicht verfolgt, sondern angewendet. Solche Fehler fallen in Texten, die man selbst geschrieben hat, kaum auf. Daher ist es hier sinnvoll nach dem 4-Augen-Prinzip zu arbeiten und den Text Korrektur lesen zu lassen.
  8. Aktiv statt Passiv Formulieren Sie Anweisungen im Aktiv und vermeiden Sie Passivkonstruktionen. Anweisungen sollen den*die Benutzer*in zu einer aktiven Handlung bewegen, daher ist eine direkte Ansprache notwendig. Darüber hinaus sind Sätze im Aktiv in der Regel kürzer.
  9. Verben statt Substantive Vermeiden Sie Nominalisierungen. Verräterisch sind hierbei die Endungen -keit, -heit, -ung, -ion und -atz, denn Adjektive, Verben und Adverbien können damit schnell in ein Substantiv umgewandelt werden. Dabei ist es in den meisten Fällen ganz einfach eine Nominalisierung mit einem Verb auszudrücken. Ein Beispiel sind die sogenannten Funktionsverben. Eine „Kontrolle durchführen“ lässt sich ganz einfach durch das Verb „kontrollieren“ ersetzen.
  10. Ausdrucksstarke Verben Nutzen Sie ausdrucksstarke Verben und vermeiden Sie Sätze mit Formen von „ist“ und „haben“. Verben erzeugen bestimmte Bilder im Kopf, die das Verständnis des Texts erleichtern. Sorgen Sie also nicht dafür, dass das Gerät angeschlossen ist, sondern schließen Sie das Gerät ganz einfach an.
  11. Ausdruckstarke Überschriften Abschließend sollten Sie einen Blick auf die Überschriften werfen. „Einleitung“, „Allgemeines“ oder „Schluss“ haben nur wenig Aussagekraft.