Dokumentation / Praxisleitfaden
Machen Sie aus einer Bildschirmaufnahme eine Schritt-für-Schritt-Anleitung.
Nutzen Sie dieselbe Aufnahme für eine gut lesbare Anleitung. Beginnen Sie mit der Aufgabe, prüfen Sie den Text und lassen Sie jeden Schritt mit etwas enden, das die Leser überprüfen können.
Beginnen Sie mit einer vollständigen Aufgabe.
Eine gute Anleitung hat einen klaren Ausgangspunkt und ein sichtbares Ergebnis. „Ein Teammitglied einladen“ gibt den Lesern eine Aufgabe, die sie abschließen können. „Ein Rundgang durch unsere Einstellungen“ zeigt ihnen nur eine Sammlung von Bildschirmen ohne Grund, sie zu nutzen.
Notieren Sie vor der Aufnahme, für wen die Anleitung gedacht ist, welche Berechtigung diese Person braucht und was sie am Ende sehen sollte. Halten Sie diese Antworten bereit, während Sie den Ablauf aufnehmen.
Prüfen Sie den Sprechertext, bevor Sie die Anleitung erstellen.
Gesprochen erklärt man eine Aufgabe anders als in einer schriftlichen Anleitung. Es gibt Nebenbemerkungen, Korrekturen oder Verweise wie „klicken Sie da drauf“. Ihr geprüftes Skript sollte die Bedienelemente benennen und die Aktionen in der richtigen Reihenfolge erklären.
Korrigieren Sie in Polysh Produktnamen und Button-Beschriftungen, bevor Sie die Anleitung erstellen. Behalten Sie nützliche Hintergrundinformationen, trennen Sie sie aber von Aktionen, die die Leser tatsächlich ausführen müssen.
Prüfen Sie Aktion, Screenshot und Ergebnis.
Polysh macht aus dem geprüften Sprechertext gruppierte Schritte, Voraussetzungen, Hinweise und erwartete Ergebnisse. Behandeln Sie die erzeugte Anleitung als Entwurf, den Sie prüfen.
- Aktion: Sagt der Schritt, was zu tun ist, und nennt er dabei das sichtbare Bedienelement?
- Screenshot: Zeigt er den Bildschirm, den die Leser in diesem Moment brauchen?
- Ergebnis: Können die Leser erkennen, ob die Aktion funktioniert hat?
Ein Schritt mit dem falschen Screenshot verwirrt. Wenn die erzeugte Anleitung kein passendes Bild enthält, wählen Sie eines aus den aufgenommenen Kandidaten oder lassen Sie es weg, bis Sie das richtige haben. Prüfen Sie vor dem Teilen auf sensible Informationen.