Visuelle Dokumentation

Visuelle Dokumentation erklärt ein Produkt, einen Prozess oder ein System vorwiegend mit Bildern: beschriftete Screenshots, Diagramme, kurze Videos und Bildfolgen Schritt für Schritt, ergänzt durch kurzen Text. Sie zeigt den Lesenden, wie der Bildschirm bei jedem Schritt aussehen sollte, statt es nur zu beschreiben.

Typische Formen sind Anleitungen, Onboarding-Material, Standardarbeitsanweisungen, Versionshinweise, Fehlerberichte und Schulungsfolien. Screenshots sind das häufigste Element, weil sie genau dem entsprechen, was Nutzer sehen. Diagramme erklären Strukturen, und kurze Videos oder GIFs zeigen Abläufe, die Standbilder nicht darstellen können.

Warum visuelle Dokumentation wichtig ist

Lesende überfliegen, bevor sie lesen. Ein Screenshot mit einer nummerierten Markierung auf der richtigen Schaltfläche bestätigt, dass sie an der richtigen Stelle sind, und verringert Fehler. Visuelle Anleitungen überwinden Sprachbarrieren außerdem besser als lange Texte und reduzieren wiederholte Supportanfragen dazu, wo sich eine Einstellung befindet.

Wo visuelle Dokumentation eingesetzt wird

• Hilfecenter und Wissensdatenbanken.
• Interne Abläufe für Support-, Finanz- und Betriebsteams.
• Entwicklerdokumentation, die Konfigurationsbildschirme zeigt.
• QA-Berichte und Fehlertickets.
• Schulungen für neue Mitarbeitende.

Screenshots in Dokumentations-Workflows

1. Nehmen Sie jeden Schritt auf, idealerweise einen Screenshot pro Aktion.
2. Schneiden Sie das Bild auf den relevanten Bereich zu oder legen Sie den Ausschnitt fest.
3. Fügen Sie Schrittnummern, Pfeile und kurze Beschriftungen hinzu.
4. Machen Sie private Daten unkenntlich.
5. Exportieren Sie als PDF oder Webbilder und veröffentlichen Sie.

Action Capture in Temposhot (Command+3) sichert das Ziel unmittelbar vor jedem akzeptierten Klick und kann Schritte nach dem angeklickten Element benennen, standardmäßig mit Click "[[element-name]]". Der Editor in Documents ergänzt Step Numbers und Bildausschnitte, und der Export erzeugt PDFs oder Seitenbilder.

Häufige Fehler

• Screenshots zeigen den ganzen Bildschirm, obwohl nur ein Bereich wichtig ist.
• Veraltete Bilder nach einer Änderung der Oberfläche.
• Uneinheitliche Größen und Beschriftungsstile zwischen den Schritten.
• Private Daten bleiben in veröffentlichten Bildern stehen.

Immer wieder dieselben Screenshots?

Zeichnen Sie einen Ablauf einmal mit Action Capture auf und bearbeiten Sie ihn in Documents. Siehe Action Capture.

Häufige Fragen

Wie viele Screenshots sollte eine Anleitung enthalten?

Ein guter Ausgangspunkt ist ein Screenshot pro Aktion, die den Bildschirm verändert. Lassen Sie Schritte weg, die kein Bild brauchen.

Wie halte ich Screenshots aktuell?

Nehmen Sie nach jeder Änderung der Oberfläche die betroffenen Schritte neu auf und bewahren Sie die Originale jeder Version auf.

Quellen

• Softwaredokumentation in der Wikipedia (englisch)
• Google-Styleguide für Entwicklerdokumentation

Weiterführende Ressourcen

• Anleitung zu Action Capture: Schritt-für-Schritt-Anleitungen aus Klicks erstellen.
• Anmerkungen und Bildausschnitt: Schrittnummern und Fokus.
• Export aus Documents: Export als PDF und Seitenbilder.