people text - Technische Dokumentation. Verständlich. Schnell. Professionell. Technische Dokumentation. Verständlich. Schnell. Professionell.

Screenshots in Online-Dokumentation: Wann machen sie Sinn?

Eine Online-Dokumentation für Software informiert über die Eigenschaften und Funktionen der Software-Anwendung. Ziel ist es, die Benutzer möglichst schnell in die Lage zu versetzen, dass sie die Software produktiv anwenden können. Dabei dient die Online-Dokumentation als allzeit verfügbares Nachschlagewerk - hier vor allem als kontextsensitive Online-Hilfe. Um die Dokumentation möglichst anschaulich und verständlich zu gestalten, können Sie Screenshots einbinden. Durch die Visualisierung der Abläufe besonders in den Handlungsanleitungen ist es möglich, die Benutzeroberfläche mit dem Screenshot in der Online-Dokumentation abzugleichen. Auf diese Weise können Ihre Anweder die eigenen Aktionen jederzeit nachvollziehen.

Dabei sind jedoch nicht für alle Online-Dokumentationen die gleichen Voraussetzungen für das Einbinden von Screenshots gegeben. In welchem Maße Screenshots sinnvoll sind, hängt von verschiedenen Faktoren ab, zum Beispiel davon, ob die Dokumentation in viele Sprachen übersetzt wird und wo sie angezeigt wird. Dennoch werden Screenshots gerne als Bereicherung der Online-Dokumentation verstanden.

Screenshots erklären schwierige Schritte in Handlungsanleitungen

Wenn Sie eine Software beschreiben, deren Benutzeroberfläche komplexe Prozessabläufe abbildet, und wenn es sehr schwierig ist, diese in Handlungsanleitungen zu beschreiben, dann helfen Screenshots weiter. Zum Beispiel: Durch bildgebende Verfahren erstellte Aufnahmen in der Medizin. Wenn Benutzer in einer CT-Thoraxaufnahme etwas einzeichnen müssen und die Software reagiert darauf beispielsweise mit verschiedenen Linien, dann hilft ein Screenshot schnell und einfach. Felder ausfüllen oder Schaltflächen drücken - dies zu beschreiben ist dagegen leicht möglich, sodass ein Screenshot überflüssig ist.

Einführung in die Benutzeroberfläche

Wenn Sie die Benutzeroberfläche einführend dokumentieren, dann sollten Sie Screenshots verwenden. Die Benutzer können sich mit der Oberfläche vertraut machen. Wenn Sie die Hauptkomponenten mit Nummern versehen und diese beschreiben, dann verwirrt der Screenshot nicht. Selbst wenn die Anwendung gleichzeitig geöffnet ist, ist sofort zu erkennen, welche Benutzeroberfläche zur Hilfe gehört und welche nicht.

Die Online-Dokumentation wird in viele Sprachen übersetzt

Wenn Ihre Software-Dokumentation in sehr viele Sprachen übersetzt wird, dann sollten Sie prüfen, ob Sie tatsächlich alle Screenshots benötigen. Denn jeder Screenshot wird nicht nur in der Quellsprache, sondern auch in den Zielsprachen erstellt und immer wieder aktualisiert. Damit ist ein hoher Zeitaufwand verbunden. Sie können auf den Screenshots die Feldbezeichner unleserlich machen, die redundant sind und nur die Feldbezeichner leserlich lassen, die für die Handlungsanleitung relevant sind. Aber dennoch müssen Sie in allen Zielsprachen prüfen, ob die Screenshots noch aktuell sind.
Planen Sie die Erstellung der Screenshots in den Zielsprachen sowie die Qualitätssicherung gut ein. Vielleicht holen Sie die Übersetzer ins Boot, um die Übersetzung der Benutzeroberfläche zu prüfen.

Die Benutzeroberfläche wird konfiguriert

Wenn Sie eine Software dokumentieren, die individuell angepasst werden kann, dann machen Screenshots überhaupt keinen Sinn. Die Benutzer konfigurieren sich die Felder auf der Benutzeroberfläche so, wie die Terminologie es vorsieht, oder legen sogar neue Felder an bzw. deaktivieren sie. Hier würden Screenshots verwirren, denn Sie können nicht sicherstellen, dass die Screenshots immer aktuell sind.

Fazit: Screenshots in Online-Dokumentationen tragen dazu bei, die Verständlichkeit eines Textes zu erhöhen, allerdings nur dann, wenn Wörter alleine nicht ausreichen. Darüber hinaus sollte der Wirtschaftlichkeitsfaktor nicht aus den Augen verloren werden. Denn wenn Sie Ihre Online-Dokumentation in verschiedene Sprachen übersetzen, müssen Sie auch die Screenshots für die Zielsprachen erstellen und in die Dokumentation einarbeiten. 

Softwaredokumentation erstellen

Sie haben Fragen zur Softwaredokumentation? Melden Sie sich einfach bei uns!