Tipps für das Schreiben von Online-Benutzeranleitungen

Online User Guide Writing Tips

Online-Benutzeranleitungen und -Handbücher sind eine äußerst praktische Option, da auf sie einfach und von fast überall aus zugegriffen werden kann. Online-Benutzeranleitungen und -Handbücher müssen jedoch zweckmäßig verfasst werden, um effektiv und benutzerfreundlich zu sein.

Im Gegensatz zu gedruckten Benutzeranleitungen und Handbüchern werden Online-Handbücher oft durch mobile Geräte wie Smartphones und Tablets abgerufen. Auch wenn ihre Nutzung nicht auf diese Geräte beschränkt ist, erfahren Sie hier mehr über die besten Formate zum Veröffentlichen Ihrer Hilfedateien.
Was sollten Sie also beim Schreiben von Online-Benutzeranleitungen und -Handbüchern berücksichtigen? In diesem Artikel möchten wir Ihnen 6 grundlegende Tipps vorstellen.

Tipps für das Schreiben von Online-Benutzeranleitungen und -Handbüchern

1. Achten Sie darauf, dass Ihre Online-Benutzeranleitungen responsiv sind.

Weltweit gibt es Millionen Nutzer von mobilen Endgeräten. Sie sollten also sicherstellen, dass die Webseite Ihrer Online-Benutzeranleitungen responsiv und unabhängig von Ihrer Zielgruppe mit jeder Bildschirmgröße mobiler Geräte kompatibel ist. Sie können diese neue responsive HTML-Dokumentation, die mit allen Bildschirmgrößen kompatibel ist, als Starthilfe nutzen.

Intelligente Geräte haben verschiedene Formen und Größen. Sie können davon ausgehen, dass Ihre Produktbenutzer auf Ihre Online-Bedienungsanleitungen mit verschiedenen Geräten mit unterschiedlichen Größen und Bildschirmen zugreifen werden. Zudem sollten Sie Ihre Online-Benutzeranleitungen auch für iPhone-Geräte anpassen.
Wenn Ihre Benutzeranleitungen nicht responsiv sind, werden sie eher lästig als hilfreich für Ihre Benutzer sein. Es kann passieren, dass etliche Daten vom Bildschirm abgeschnitten werden und nur auf einem Laptop oder Desktop-Computer lesbar sind. Sie erreichen so nur einen Teil Ihres Publikums und verfehlen den wesentlichen Sinn einer Online-Bedienungsanleitung.

2. Verwenden Sie visuelle Hilfsmittel.

In den meisten Fällen ist es einfacher, sich an eine Abbildung als an einen Text zu erinnern. Das liegt daran, dass das Gehirn Bildmaterial 60.000-mal schneller verarbeitet als Text. Aus diesem Grund werden visuelle Hilfsmittel oft im Schulunterricht von Kindern eingesetzt. Sie sollten Ihre Produktbenutzer auf dieselbe Weise unterstützen. Manchmal genügt eine Abbildung, um den Benutzern die Durchführung einer Aktion, die Lösung eines Problems oder die richtige Anwendung eines Produkts zu erklären.

Eine einfache Darstellung der Nutzung Ihres Produkts oder der Behebung eines Fehlers kann den entscheidenden Unterschied zwischen einer effektiven und einer ineffektiven Benutzeranleitung ausmachen. Sie können die Lösung eines Problems anhand eines kurzen Videos, mit Bildern oder sogar mittels einer 3D-Grafik verdeutlichen. Verwenden Sie visuelle Hilfsmittel, um komplexe Vorgänge einfach und verständlich zu machen.

Dies ist besonders wichtig für Vorgänge, die verschiedene, für einen neuen Anwender eventuell verwirrende Teilschritte umfassen. Und zudem ist die Anwendung von Abbildungen einfacher als das Schreiben langer Texte, die durch viele nicht technisch bewanderte Leser als langweilig empfunden werden.

3. Erklären Sie alle Produkteigenschaften.

Ihr Produkt weist mit Sicherheit beeindruckende Eigenschaften auf. Ihre Produkteigenschaften sind jedoch absolut wertlos, wenn Ihre Benutzer die Eigenschaften und deren Funktionen und Anwendung nicht verstehen. Sie sollten deshalb alle wichtigen Eigenschaften Ihres Produkts mit einer leicht verständlichen Sprache erklären.

Erklären Sie die Funktionsweise jeder Produkteigenschaft sowie deren Anwendung in verschiedenen Situationen auf möglichst einfache Weise. Suchen Sie nach einer Verbindung zwischen den einzelnen Eigenschaften und zeigen Sie Ihren Benutzern, wie die Eigenschaften miteinander verknüpft sind und dennoch unabhängig voneinander funktionieren.

4. Erwähnen Sie Informationen zu Vorsichtsmaßnahmen.

Informationen zu Vorsichtsmaßnahmen können zum Beispiel erklären, wie ein bestimmter Befehl andere Befehle aufheben kann oder wie bestimmte Optionen einer Produkteigenschaft deren Funktionen aufgrund von Systemanforderungen oder des Benutzers verlängern oder verkürzen können. Sie sollten möglichst viele solcher Situationen erwähnen. Dadurch werden Ihre Benutzer eine klare Vorstellung davon haben, warum Ihr Produkt unter Umständen auf eine bestimmte Weise reagiert.

5. Erläutern Sie Begriffe bei Bedarf.

Zögern Sie nicht, Fachbegriffe zu erklären, die für einige Benutzer eventuell schwer verständlich sind. Sie können diese Begriffe im Glossar Ihrer Benutzeranleitung auflisten. Außerdem empfiehlt es sich, Links in Ihre Online-Benutzeranleitungen einzubauen, mittels derer die Benutzer zu der gewünschten Begriffsdefinition im Glossar gelangen.

6. Erwähnen Sie technische Informationen.

Gehen Sie davon aus, dass Ihre Produktbenutzer alle technische Laien sind? Wahrscheinlicher ist es, dass einige Ihrer Benutzer durchaus an den technischen Details Ihres Produkts interessiert sind. Sie sollten deshalb technische Informationen zu der Funktionsweise Ihres Produkts und seinen einzelnen Eigenschaften oder Teilen erwähnen. Sie können diese Vorgänge anhand von visuellen Hilfsmitteln leichter verständlich machen. Solche technischen Informationen tragen dazu bei, dass Ihre Benutzer Ursachen und Wirkungen bei der Anwendung Ihres Produkts verstehen.

Fazit

Um eine optimale Benutzerfreundlichkeit zu garantieren, sollten Online-Benutzeranleitungen und -Handbücher so einfach wie möglich verfasst und auf einer responsiven Webseite zugänglich gemacht werden. Die Anwendung einer Hilfe-Entwicklungssoftware wie HelpNDoc kann Ihnen das Erreichen dieses Ziels erleichtern.