Syntax und Semantik

Regeln und Konventionen der Syntax (Satzbau) und der Semantik (Bedeutung von Wörtern und Wortgruppen) können gut überlegt eingesetzt werden, um die Verständlichkeit eines Textes zu verbessern. Kurze Sätze mit leicht verständlichen Wörtern und klaren Anweisungen helfen den Usern dabei die Dokumentation schneller und besser zu verstehen.

Gegenwartsform und modale Hilfsverben

  • Schreiben Sie in der Gegenwartsform, außer es wird ein Ereignis in der Vergangenheit oder Zukunft beschrieben.
  • Vermeiden Sie modale Hilfsverben.
Don'tsDo's
1. Der Kursbaustein sollte nun im Menü angezeigt werden.1. Der Kursbaustein wird im Menü angezeigt.
2. Zuerst müssen Sie auf den Button „Start“ klicken.2. Klicken Sie auf den Button Start.
3. Am Schluss werden Sie eine Zusammenfassung der Daten sehen.3. Sie sehen eine Zusammenfassung der Daten

Aktivsätze

Schreiben Sie möglichst in der Aktiven Form, vor allem wenn Sie Abläufe dokumentieren.

Don'tsDo's
1. Die Dateien können nun in den Ordner hochgeladen werden.1. Sie können die Dateien nun in den Ordner hochladen.
2. Das Video muss zuerst noch veröffentlicht werden.2. Veröffentlichen Sie das Video.

Zweite Person

Anleitungen sollten aus Sicht der User geschrieben werden. Sprechen Sie die User mit „Sie“ direkt an.

Don'tsDo's
1. An dieser Stelle kann man die Zugangsregeln festlegen.1. Legen Sie die Zugangsrechte fest.
2. Wähle hier die gewünschte Option.2. Wählen Sie die gewünschte Option.

Fachbegriffe, Abkürzungen und Akronyme

  • Versuchen Sie die Verwendung von Fachbegriffen so weit wie möglich zu minimieren. Wenn Sie Fachbegriffe verwenden müssen, geben Sie eine Definition an.
  • Schreiben Sie Abkürzungen aus, auch wenn sie normalerweise gängig verwendet werden.
  • Buchstabieren Sie Akronyme immer aus, wenn sie zum ersten Mal in einem Dokument erwähnt werden.
  • Wenn eine Abkürzung oder ein Akronym in einem Absatz mehrmals verwendet wird, kann es abgekürzt werden.

Zusammengesetzte Handlungsanweisung

Besteht ein Schritt aus mehreren Handlungsanweisungen, beschreiben Sie zuerst, wo eine Funktion zu finden ist und dann, wie damit umzugehen ist.

Don'tsDo's
1. Wählen Sie OK im Kursanlagefenster.1. Klicken Sie im Fenster Kursanlage auf OK.
2. Klicke auf Kurseditor unter Administration.2. Klicken Sie auf Administration, dann auf Kurseditor.

Schreibstil

User sollen sich in einer Userdokumentation persönlich angesprochen fühlen. Es sollte dennoch vermieden werden, sich zu umgangssprachlich auszudrücken. Hier werden ein paar Ausdrucksweisen beschrieben, die vermieden werden sollten.

Vermeide ... Weil ...
Der einfachste Weg das zu tun ist ... / Geben Sie einfach einen Titel an.Für die User ist vieles schwerer umzusetzen, als man selber meint. Lass das Wort „einfach“ weg und gib stattdessen eine konkrete Handlungsaufforderung.
Es gibt mehrere Möglichkeiten, das zu bewerkstelligen.Gib nur einen möglichen Lösungsweg an und reduziere die Informationen auf das Wesentliche. Sollte es notwendig sein mehrere Möglichkeiten zu beschreiben, musst du dies nicht ankündigen. Setze die alternative Möglichkeit in Klammern hinter dem notwendigen Schritt.
Mit einem Klick auf "Ok" können Sie die Angaben bestätigen.Gib konkrete Handlungsaufforderungen. Wenn eine Aktion nur optional ist, markiere sie mit "Optional:" davor.
Nach oben scrollen