Klare Schritt-für-Schritt-Anweisungen für Software schreiben

Klare visuelle Software-Dokumentation erklärt, was der Leser tun soll, wo die Aktion stattfindet und woran ihr Erfolg erkennbar ist. Definiere ein fertiges Ergebnis, schreibe direkte Aktionen mit genauen Oberflächenbezeichnungen, ergänze sichtbare Prüfpunkte, verbinde den Text mit hilfreichen Screenshots und teste den Guide, ohne ihn mündlich zu erklären.

Kurzfassung: Beginne jeden Schritt mit der Aktion, nenne das sichtbare Steuerelement, gib den nötigen Wert oder die Bedingung an und beschreibe das Ergebnis, ab dem der Leser fortfahren kann.

Ein fertiges Ergebnis definieren

Das Ergebnis gibt jedem Schritt einen Zweck. Formuliere die Aufgabe so, dass der Leser sie abschließen und prüfen kann, etwa „Den Guide als PNG-Dateien exportieren“ oder „Die Berechtigung zur Bildschirmaufnahme für Shotomatic aktivieren“.

Vermeide breite Ziele wie „Den Editor kennenlernen“. Ein solches Ziel sagt weder dem Autor, was dazugehört, noch dem Leser, wann die Aufgabe abgeschlossen ist.

Jeden Schritt mit der Aktion beginnen

Der erste Satz sollte dem Leser sagen, was zu tun ist. Beginne mit einem direkten Verb wie öffnen, auswählen, eingeben, ziehen, prüfen oder exportieren.

Vergleiche diese Fassungen:

Vorher: „Das Exportmenü befindet sich oben rechts und enthält mehrere nützliche Formate.“

Nachher: „Öffne oben rechts das Menü Export.“

Die zweite Fassung ermöglicht sofortiges Handeln. Eine Erklärung der Formate gehört nur danach, wenn sie die Entscheidung verändert.

Genaue Oberflächenbezeichnungen verwenden

Genaue Bezeichnungen helfen dem Leser, die Anweisung dem aktuellen Bildschirm zuzuordnen. Übernimm die sichtbare Großschreibung und unterscheide Menü, Schaltfläche, Feld, Tab und Tastenkürzel, wenn die Bedienung unterschiedlich ist.

Vorher: „Gehe zu den Einstellungen und aktiviere die passende Berechtigung.“

Nachher: „Öffne Systemeinstellungen > Datenschutz & Sicherheit > Bildschirm- & Systemaudioaufnahme und aktiviere Shotomatic.“

Vermeide interne Produktnamen, die Leser nicht sehen können. Dokumentation sollte der öffentlichen Oberfläche folgen, sofern sie nicht ausdrücklich für Entwickler oder Administratoren geschrieben ist.

Eine Entscheidung pro Schritt

Ein Schritt sollte eine wesentliche Aktion oder Entscheidung enthalten. So lassen sich Fehler leichter finden und Screenshots besser zuordnen.

Eng zusammengehörige Eingabe und Bestätigung können gemeinsam stehen:

Gib Quartalsprüfung in Dokumenttitel ein und wähle anschließend Speichern.

Teile den Schritt auf, wenn eine der Aktionen eine eigene Warnung, ein erwartetes Ergebnis oder eine Verzweigung hat.

Nach wichtigen Aktionen Prüfpunkte ergänzen

Prüfpunkte zeigen, ob eine Aktion funktioniert hat. Verwende sie nach Änderungen an Berechtigungen, Uploads, Exporten, Einladungen, zerstörerischen Aktionen und Übergängen, die Zeit brauchen können.

Vorher: „Wähle PDF exportieren und fahre fort.“

Nachher: „Wähle PDF exportieren. Wenn der Speicherdialog geöffnet wird, wähle den Zielordner.“

Der Prüfpunkt verhindert, dass der Leser bereits nach einem Ordner sucht, obwohl die Anwendung noch den vorherigen Bildschirm zeigt.

Verzweigungen an sichtbare Bedingungen knüpfen

Eine Verzweigung sollte mit etwas beginnen, das Leser sehen oder bestätigen können. Beschreibe zuerst den normalen Weg und halte die Ausnahme nahe an dem Schritt, den sie verändert.

Vorher: „Passe bei Bedarf die Berechtigungen an.“

Nachher: „Wenn die Fenstervorschau leer ist, öffne Systemeinstellungen > Datenschutz & Sicherheit > Bildschirm- & Systemaudioaufnahme und bestätige, dass Shotomatic aktiviert ist.“

Überlade den Hauptguide nicht mit jeder seltenen Ausnahme. Verlinke eine eigene Seite zur Fehlerbehebung, wenn mehrere Symptome und Ursachen die Aufgabe unterbrechen würden.

Screenshots zeigen Position und Zustand

Text und Bild sollten sich die Arbeit teilen. Der Text nennt Aktion, erforderlichen Wert, Bedingung und erwartetes Ergebnis. Der Screenshot zeigt die Position des Steuerelements und den relevanten sichtbaren Zustand.

Vermeide Absätze, die jedes sichtbare Element beschreiben. Lege auch nicht die gesamte Anweisung als großen Text über das Bild. Die Aktion sollte verständlich bleiben, wenn das Bild fehlt oder schwer zu erkennen ist.

Der Guide Screenshots für klare Anweisungen auf dem Mac annotieren hilft bei der Wahl zwischen Klickmarkierung, Pfeil, Form, Text, Zuschnitt und Weichzeichnung.

Fülltext und verborgene Annahmen entfernen

Fülltext verzögert die Aktion, verborgene Annahmen machen sie unmöglich. Streiche Wörter wie „einfach“, „nur“, „wie gewohnt“ und „nach Bedarf konfigurieren“. Ersetze sie durch die fehlende Voraussetzung.

Vorher: „Konfiguriere einfach die Exportoptionen nach Bedarf.“

Nachher: „Wähle PNG, behalte Originalgröße bei und wähle den Ordner, in dem das Support-Ticket Nachweise speichert.“

Die überarbeitete Fassung ist länger, weil sie notwendige Informationen enthält. Prägnanz bedeutet, überflüssige Wörter zu entfernen, nicht benötigte Details wegzulassen.

Anweisungen ohne zusätzliche Erklärung testen

Der Test sollte von einer Person durchgeführt werden, die den Guide nicht mitgeschrieben hat. Gib ihr die angegebenen Ausgangsbedingungen und bitte sie, die Aufgabe ohne mündliche Korrektur auszuführen.

Notiere die erste Stelle, an der sie zögert, das falsche Steuerelement wählt oder einen unerwarteten Zustand erreicht. Korrigiere dort Anweisung oder Screenshot und wiederhole den Test von vorn.

Der Guide ist fertig, wenn der Leser das angegebene Ergebnis erreicht, jede Verzweigung sichtbar nachvollziehen kann und die Schritte nicht vom Gedächtnis des Autors abhängen. Den vollständigen Ablauf für Klickaufnahmen findest du unter Schritt-für-Schritt-Anleitung aus Klicks auf dem Mac erstellen. Die aktuellen Werkzeuge zeigt Action Capture.