5 Tipps für das Schreiben von Klickanleitungen

Wir nennen Sie Klickanleitung oder Schritt-für-Schritt-Anleitung. Sie ist ein wesentlicher Bestandteil der Perfekten Bedienungsanleitung für Software. Hier erhalten Sie 5 Tipps, was Sie beim Schreiben dieser Anleitung beachten sollten. .

Eine Klickanleitung ist eine konkrete Arbeitseinleitung. Sie liefert dem Anwender die Informationen, damit er die Anwendung bedienen kann. Sie ist das Kernstück der Perfekten Bedienungsanleitung für Software. Hier finden Sie einige Tipps zum Selbermachen.

Am Anfang steht, was zu tun ist.

Beginnen Sie mit einem eindeutigen Verb:

  • Klicken Sie
  • Rechtsklicken Sie
  • Doppelklicken Sie
  • Geben Sie … ein
  • Wählen Sie
  • Bewegen Sie die Maus
  • Verwenden Sie die Tastenkombination

Schritt für Schritt.

Beschreiben Sie jede einzelne Aktion. Kombinieren Sie diese nicht.

Falsch: Wählen Sie den Eintrag hoch im Feld Priorität und bestätigen Sie die Eingabe
mit OK.
Richtig: Wählen Sie den Eintrag hoch im Feld Priorität.
Klicken Sie den Button OK.

Falsch: Klicken Sie 3 x hintereinander den Button OK.
Richtig: Klicken Sie den Button OK.
Klicken Sie den Button OK.
Klicken Sie den Button OK.

Konsistenz in der Wortwahl.

Verwenden Sie immer die gleichen Begriffe. Definieren Sie diese zu Beginn und seien Sie konsequent.

Schön knackig bitte!

Verzichten Sie auf jedes überflüssige Wort oder jede überflüssige Silbe. Alle, was Sie schreiben, muss ge-reviewed, gelesen, verstanden und ggf. auch übersetzt werden.

Be structured!

Eine Anleitung enthält keine Hintergrund-Informationen. Schaffen Sie sich eine klare Struktur, welche Inhalte, in welchem Format dokumentiert werden. Bei Bedarf nutzen Sie Verweise, um auf die Information hinzuweisen. Das bedeutet z. B., dass in einer Klickanleitung keine Erklärungen zu finden sind.

Tags

Schreibe einen Kommentar

Your email address will not be published.

top