Screenshot-Dokumentation aktuell halten

Visuelle Dokumentation bleibt nur nützlich, solange Bilder, Bezeichnungen und Anweisungen zur aktuellen Aufgabe passen. Ein praktischer Pflegeprozess verbindet Produktänderungen mit betroffenen Guides, ersetzt nur die nötigen Schritte, testet die aktualisierte Folge und hält fest, wer sie geprüft hat. So muss nicht nach jeder Veröffentlichung jeder Guide neu erstellt werden.

Kurzfassung: Halte für jeden Guide die geprüfte Produktversion und einen Verantwortlichen fest. Prüfe Änderungen nach betroffenem Bildschirm und Aufgabe, ersetze die nötigen Schritte und führe anschließend den gesamten Guide einmal aus, bevor du das Prüfdatum aktualisierst.

Verantwortlichen und geprüfte Version festlegen

Der Verantwortliche steht für die Richtigkeit ein, muss aber nicht jede Änderung selbst schreiben. Notiere eine Rolle, die den aktuellen Ablauf bestätigen und Änderungen freigeben kann.

Speichere diese Angaben bei jedem visuellen Guide:

Verantwortlich:
Geprüfte Produkt- oder Prozessversion:
Zuletzt geprüft:
Nächste geplante Prüfung:
Verwendete Bildschirme oder Funktionen:
Verwendete Oberflächenbezeichnungen:
Speicherort der Ausgangsbilder:

Mit diesen Metadaten wird aus einem Versionshinweis eine Liste möglicher Auswirkungen auf die Dokumentation. Du musst nicht jede veröffentlichte Seite einzeln durchsuchen.

Produktänderungen als Prüftrigger nutzen

Eine ereignisbasierte Prüfung ist genauer, als nur auf einen Kalendertermin zu warten. Starte sie, wenn eine Version eine Bezeichnung, das Bildschirmlayout, den Navigationspfad, eine Berechtigung, Tarifleistung, einen Export, Fehlerzustand oder Standardwert verändert, den ein Guide verwendet.

Eine geplante Prüfung bleibt für Seiten sinnvoll, die kein eindeutiges Produktereignis auslöst. Wähle kürzere Intervalle für häufig genutzte Einrichtung, Sicherheit, Abrechnung, zerstörerische Aktionen und Oberflächen, die sich oft ändern.

Änderung den betroffenen Schritten zuordnen

Bei der Auswirkungsprüfung muss klar werden, welche Anweisung, welcher Screenshot, Prüfpunkt, FAQ-Eintrag und Link vom veränderten Verhalten abhängt. Gehe nicht davon aus, dass nur das Bild ersetzt werden muss.

Wird beispielsweise eine Export-Schaltfläche verschoben, können Screenshot und Positionsangabe betroffen sein. Ändern sich die Formate eines Tarifs, kann das Hauptschritte, Vergleichstabelle, FAQ, Metadatenbeschreibung und interne Links zur Tarifseite berühren.

Nutze diese Änderungsprüfung:

• Welche Bezeichnung hat sich geändert?
• Welches Steuerelement wurde verschoben oder hat einen anderen Zustand?
• Hat sich die Reihenfolge der Aktionen geändert?
• Haben sich Ausgangsbedingung oder Berechtigung geändert?
• Ist das erwartete Ergebnis anders?
• Hat sich eine Tarif- oder Verfügbarkeitsregel geändert?
• Welche Guide-Seiten, Bildunterschriften, Alternativtexte, FAQ-Einträge und Links beziehen sich darauf?

Nur betroffene Schritte ersetzen

Gezielter Austausch verringert den Prüfaufwand und lässt stabile Seiten unberührt. Stelle denselben sicheren Ausgangszustand her, nimm den geänderten Schritt erneut auf und erfasse genügend Kontext, damit er zur bestehenden Folge passt.

Ersetze mehrere Seiten, wenn die neue Interaktion Reihenfolge oder sichtbaren Zustand späterer Aktionen verändert. Füge keinen einzelnen neuen Screenshot in eine alte Folge ein, wenn Leser dadurch zwischen unvereinbaren Oberflächenversionen springen würden.

Mit Action Capture kannst du den betroffenen Ablauf erneut in Reihenfolge aufnehmen. Vergleiche die neue Folge mit dem veröffentlichten Guide und behalte nur die Seiten, die den geänderten Abschnitt ersetzen.

Text, Anmerkungen und Datenschutz erneut prüfen

Passe bei der Bearbeitung genaue Bezeichnungen, Aktionstext, Pfeile, Klickmarkierungen, Ausschnitt, Action Focus, Weichzeichnung und erwartete Prüfpunkte an. Alte Anmerkungen können auf eine leere Stelle zeigen, auch wenn der Screenshot auf den ersten Blick ähnlich aussieht.

Wiederhole auch die Datenschutzprüfung. Ein neu aufgenommenes Konto, Menü, eine Benachrichtigung oder ein Beispielprojekt kann Informationen zeigen, die in der früheren Version nicht vorhanden waren.

Den gesamten Guide testen

Der Regressionstest sollte bei Schritt eins und mit den veröffentlichten Ausgangsbedingungen beginnen. Wer nur die ersetzte Seite prüft, übersieht möglicherweise eine neue Voraussetzung oder eine Änderung am Übergang in diesen Abschnitt.

Der aktualisierte Guide ist fertig, wenn Leser dasselbe angegebene Ergebnis erreichen, alle Bezeichnungen stimmen, die Seiten richtig geordnet sind, private Angaben geschützt bleiben und jeder interne Link auf eine sichtbare Seite führt.

Trage neue geprüfte Version und neues Prüfdatum erst nach diesem vollständigen Durchlauf ein.

Nur bei echtem Bedarf archivieren

Ältere Versionen sind sinnvoll, wenn Kunden weiterhin alte Ausgaben einsetzen, der Support früheres Verhalten nachvollziehen muss oder ein regulierter Prozess den Nachweis verlangt. Kennzeichne die passende Version eindeutig und entferne den alten Guide aus der aktuellen Suche und Navigation, wenn er nicht mehr der Standardweg ist.

Bei den meisten öffentlichen Hilfeinhalten kann der Versionsverlauf der Quelle frühere Stände bewahren, während die veröffentlichte URL den aktuellen geprüften Weg zeigt. Vermeide mehrere durchsuchbare Seiten, die sich nur durch eine nicht mehr unterstützte Produktversion unterscheiden.

Pflege mit einem kompakten Eintrag dokumentieren

Verwende für jede Aktualisierung ein kurzes Protokoll:

Guide:
Verantwortlich:
Änderungsquelle:
Betroffene Schritte:
Text aktualisiert:
Bilder aktualisiert:
Datenschutzprüfung abgeschlossen:
Vollständiger Test abgeschlossen:
Geprüfte Version:
Geprüft von:
Prüfdatum:
Nächster Anlass oder Termin:

Die Pflege ist abgeschlossen, wenn veröffentlichter Guide, Bilder, Metadaten und Verantwortlichkeitsangaben dieselbe aktuelle Aufgabe beschreiben. Nutze Schritt-für-Schritt-Anleitung aus Klicks auf dem Mac erstellen, um betroffene Seiten neu aufzunehmen. Action Capture hält die Ersatzfolge für die Prüfung zusammen.