So erstellen Sie ein Benutzerhandbuch: Von Null zum Helden (vollständige Anleitung)

Sie sind sich nicht sicher, wie Sie ein Benutzerhandbuch erstellen sollen, um Ihren Kunden zu helfen, mehr Wert aus Ihrem Produkt zu ziehen?

Ein Benutzerhandbuch ist Inhalt, der Ihren Kunden (oder Mitarbeitern) hilft, Ihr Produkt oder Ihre Dienstleistung effektiv zu nutzen. Möglicherweise wird es auch als Benutzerhandbuch, Bedienungsanleitung, Produkthandbuch usw. bezeichnet.

Neben der Unterstützung Ihrer Kunden bei der effektiven Nutzung Ihres Produkts kann Ihnen die Erstellung eines hochwertigen Benutzerhandbuchs auch dabei helfen, Kundendienst- und Supportanfragen zu reduzieren, da Benutzer ihre Probleme lösen können, ohne sich an den Support wenden zu müssen.

In dieser ausführlichen Anleitung erfahren Sie, wie Sie ein Benutzerhandbuch erstellen, das Ihren Kunden zum Erfolg verhilft.

Um dies zu erreichen, finden Sie hier alles, was wir behandeln werden:

• Verschiedene Arten von Benutzerhandbüchern
• Wo Sie Ihr Benutzerhandbuch veröffentlichen können
• So erstellen Sie ein Benutzerhandbuch

Lassen Sie uns graben!

Verschiedene Arten von Benutzerhandbüchern

Es gibt verschiedene Arten von Benutzerhandbüchern, darunter sowohl kundenorientierte als auch interne Inhalte.

Bevor Sie beginnen, ist es wichtig zu verstehen, welche Art von Handbuch Sie erstellen möchten, da sich dies auf Ihre Herangehensweise an den Inhalt auswirkt.

Hier ist eine kurze Zusammenfassung der verschiedenen Arten von Benutzerhandbüchern:

• Benutzerhandbuch – Ein klassisches Benutzerhandbuch lehrt Benutzer, wie ein Produkt zu verwenden ist.
• Schulungshandbuch – Ein Schulungshandbuch lehrt Benutzer, wie sie eine bestimmte Aufgabe ausführen oder einen bestimmten Job erledigen.
• Betriebshandbuch – ein Betriebshandbuch ist in der Regel ein internes Handbuch, das den Betrieb Ihres Unternehmens dokumentiert.
• Servicehandbuch – Ein Servicehandbuch konzentriert sich darauf, den Benutzern beizubringen, wie sie ein Produkt an verschiedenen Stellen im Produktlebenszyklus richtig warten.
• Standard Operating Procedures (SOPs) – SOPs sind interne Handbücher, die Organisationsmitgliedern beibringen, wie sie bestimmte Prozesse „richtig“ abschließen.

Bei den folgenden Anweisungen geht es uns hauptsächlich darum, ein öffentlich zugängliches Benutzerhandbuch zu erstellen. Die nachstehenden Grundprinzipien gelten jedoch für alle Arten von Benutzerhandbüchern.

Wo Sie Ihr Benutzerhandbuch veröffentlichen können

Wo Sie Ihr Benutzerhandbuch veröffentlichen, hängt von der Art des Benutzerhandbuchs ab, das Sie erstellen.

Für kundenorientierte Benutzerhandbücher möchten Sie diese fast immer auf Ihrer Website veröffentlichen. Auf diese Weise können Benutzer von überall auf das Handbuch zugreifen.

Darüber hinaus können Sie durch das Veröffentlichen von Inhalten von Benutzerhandbüchern im Internet eine benutzerfreundlichere Erfahrung als mit einem physischen Benutzerhandbuch schaffen, z. B. durch Hinzufügen von anklickbaren Inhaltsverzeichnissen und Echtzeit-Suchvorschlägen.

Für physische Produkte möchten Sie jedoch möglicherweise auch ein physisches Benutzerhandbuch als Ergänzung zu Ihrem webbasierten Handbuch hinzufügen.

Interne Benutzerhandbücher möchten Sie normalerweise vor der Öffentlichkeit verbergen.

Eine Möglichkeit, dies zu erreichen, besteht darin, sie nur im Intranet des Unternehmens verfügbar zu machen. Bei so vielen Menschen, die von zu Hause aus arbeiten, kann dies jedoch schwierig sein, es sei denn, Ihr Unternehmen verfügt über ein eigenes VPN-Setup.

Stattdessen können Sie den Inhalt mit einem Passwort schützen, indem Sie entweder den Mitarbeiter auffordern, sich bei einem Benutzerkonto anzumelden, oder einfach ein Passwort hinzufügen, um auf die Seite zuzugreifen.

Für physische Benutzerhandbücher können Sie ein spezielles Wissensmanagement-Tool verwenden, das Sie bei der Veröffentlichung komplexerer Handbücher unterstützt. Oder Sie können für einfachere Benutzerhandbücher einfach in Google Docs schreiben und von dort aus veröffentlichen – unsere Sammlung von Tools für technisches Schreiben enthält einige nützliche Tools, die Ihnen das Leben erleichtern.

Um Ihr Benutzerhandbuch online zu veröffentlichen, können Sie die meisten Dokumentations- oder Knowledge-Base-Programme verwenden. Wenn Sie ein Tool suchen, das sowohl öffentlich zugängliche als auch interne Benutzerhandbücher verarbeiten kann, können Sie das Open-Source-Plugin Heroic Knowledge Base für WordPress in Betracht ziehen. Wir werden im Tutorial ausführlicher darauf eingehen.

Hier ist ein Beispiel für ein Online-Benutzerhandbuch aus der Heroic Knowledge Base (und über die Heroic Knowledge Base):

Apropos Tutorial…

So erstellen Sie ein Benutzerhandbuch in sechs Schritten

Nachdem Sie nun einige Hintergrundinformationen haben, wollen wir uns mit der Erstellung eines Benutzerhandbuchs befassen, beginnend bei null bis hin zum fertigen Benutzerhandbuch.

1. Erstellen Sie Ihre Benutzerperson(en)

Bevor Sie mit der Erstellung von Inhalten beginnen, möchten Sie wissen, für wen die Inhalte bestimmt sind , was Sie erreichen können, indem Sie Benutzerpersönlichkeiten erstellen.

Wahrscheinlich haben Sie bereits eine gute Vorstellung davon, wer Ihre Kunden sind, aber es ist hilfreich, dies aufzuschreiben, um Ihre Bemühungen wirklich zu konzentrieren.

Warum ist das wichtig?

Nun, hier ist ein Beispiel:

Es gibt einen großen Unterschied zwischen der Erstellung technischer Inhalte für Maschinenbauingenieure und der Erstellung technischer Inhalte für technisch nicht versierte Benutzer.

Bei den meisten Produkten sind die Unterschiede nicht so stark. Dennoch ist es wichtig, Ihre Kundenpersönlichkeiten zu verstehen, damit Sie sicherstellen können, dass Ihr Benutzerhandbuch für die Personen, die es tatsächlich verwenden werden, Sinn ergibt.

2. Identifizieren Sie das/die Hauptproblem(e) und Ziel(e)

Sobald Sie verstehen, wer Ihre Kunden sind, besteht der nächste Schritt darin, zu verstehen, was sie mit dem von Ihnen erstellten Benutzerhandbuch erreichen möchten.

Das heißt, was ist das Endziel (oder die Endziele) der Personen, die dieses Handbuch lesen werden?

Es ist wichtig, dies zu verstehen, da der Zweck Ihres Handbuchs darin bestehen sollte, Ihren Benutzern dabei zu helfen, dieses Ziel so effizient wie möglich zu erreichen.

In einigen Fällen kann dieses Endziel eine bestimmte Sache sein. Wenn Sie beispielsweise ein Social-Media-Management-Tool haben, könnte es „einen Beitrag in sozialen Medien planen“.

In anderen kann es sich um ein abstrakteres Ziel handeln, wie z. B. „Verbesserung unserer Projektmanagementprozesse“.

Bei größeren Produkten kann es mehrere Dinge geben, die der Benutzer erreichen möchte, was uns zum nächsten Abschnitt führt.

3. Erstellen Sie eine logische Struktur und Hierarchie

Nachdem Sie nun verstanden haben, wer Ihre Kunden sind und was sie erreichen möchten, können Sie damit beginnen, die Struktur Ihres Benutzerhandbuchs zu entwerfen.

Sie möchten eine Struktur schaffen, die Ihre Benutzer von „Null“ zum Erreichen der Endziele führt, die Sie im vorherigen Abschnitt aufgeführt haben.

Hier sind einige Tipps, die Ihnen dabei helfen:

1. Denken Sie darüber nach, wie Sie Kunden helfen können, so schnell wie möglich einen Mehrwert aus Ihrem Produkt zu ziehen.
2. Ziehen Sie Ihr ganz persönliches Wissen daraus. Sie wissen offensichtlich viel über Ihr Produkt, aber Ihre Kunden werden nicht über dieses Hintergrundwissen verfügen.
3. Stellen Sie sicher, dass alle gängigen Probleme oder verwirrenden Details behandelt werden, auf die Ihre Kunden stoßen könnten, wenn sie versuchen, Ihr Produkt zu verwenden. Diese sollten logischerweise zu den Zeiten angegangen werden, zu denen Kunden am wahrscheinlichsten auf Probleme stoßen.

4. Schreiben Sie den Inhalt Ihres Benutzerhandbuchs

Sobald Sie Ihre Inhalte festgelegt haben, können Sie mit dem Schreiben beginnen.

Abhängig von der Größe Ihres Produkts/Ihrer Organisation schreiben Sie möglicherweise alles selbst. Oder Sie müssen möglicherweise mit anderen Teammitgliedern zusammenarbeiten, um den Inhalt zu schreiben.

Hier sind einige allgemeine Best Practices für Benutzerhandbücher, die Sie beim Schreiben Ihres Benutzerhandbuchs berücksichtigen sollten:

• Verwenden Sie eine Vorlage, um eine konsistente Formatierung sicherzustellen . Das Erstellen einer formatierten Vorlage beschleunigt nicht nur Ihre Arbeit, sondern stellt auch sicher, dass jeder Artikel in Ihrem Handbuch mit den anderen übereinstimmt.
• Fügen Sie visuelle Elemente (Bilder und Videos) hinzu, um Benutzern zu helfen . Ein gut kommentiertes Bild oder GIF kann hilfreicher sein als eigenständige Textanweisungen, egal wie detailliert und gründlich der Text ist.
• Verwenden Sie eine einfache Sprache und vermeiden Sie Fachjargon . Oder, wenn Fachjargon völlig unvermeidbar ist, stellen Sie sicher, dass Sie es erklären.
• Halten Sie es kurz und bündig . Ihr Ziel mit einem Benutzerhandbuch sollte es sein, das Thema vollständig abzudecken, aber in so wenigen Worten wie möglich. Lassen Sie keine wichtigen Informationen aus, sondern schneiden Sie unnötige Inhalte rücksichtslos ab.
• Verwenden Sie nach Möglichkeit Aufzählungszeichen und Listen für Anweisungen . Die Verwendung einer nummerierten oder Aufzählungsliste kann es Benutzern erleichtern, den Überblick über das Handbuch zu behalten. Wenn Sie mehr Details benötigen, als eine Liste zulässt, können Sie jedem Schritt eine eigene Unterüberschrift geben.
• Aktive Stimme verwenden . Passiv kann besonders bei Anweisungen in einer Bedienungsanleitung verwirrend sein. Es ist der Unterschied zwischen „Das Produkt kann durch Drücken des roten Knopfes eingeschaltet werden“ und „Sie können das Produkt durch Drücken des roten Knopfes einschalten“. Letzteres Beispiel (aktive Stimme) ist klarer und erleichtert es dem Leser, sich in die Anleitung hineinzuversetzen.

Schließlich ist es immer eine gute Idee, die Anweisungen Ihres Benutzerhandbuchs so zu testen, als wären Sie ein Erstbenutzer.

Das heißt, sobald Sie einen Artikel geschrieben haben, gehen Sie zurück und befolgen Sie diese Anweisungen Schritt für Schritt, um sicherzustellen, dass Sie nichts verpasst haben.

5. Veröffentlichen Sie Ihr Benutzerhandbuch

Sobald Sie Ihre Inhalte haben, ist der letzte Schritt, um live zu gehen, Ihr Benutzerhandbuch zu veröffentlichen, um es Ihren Kunden leicht zugänglich zu machen.

Wie Sie dies tun, hängt davon ab, welche Art von Produkt Sie anbieten. Beispielsweise möchten Sie möglicherweise eine physische Version Ihres Handbuchs beifügen, wenn Sie physische Produkte versenden.

Unabhängig davon, welche Art von Produkt Sie anbieten, sollten Sie Ihr Benutzerhandbuch online veröffentlichen, damit die Leute es leicht finden können.

Um Ihnen dabei zu helfen, können Sie Wissensdatenbank-/Dokumentationssoftware verwenden.

Mit dem WordPress-Plugin Heroic Knowledge Base können Sie beispielsweise Ihr Benutzerhandbuch mithilfe der Open-Source-WordPress-Software veröffentlichen.

Dieser Open-Source-Ansatz gibt Ihnen die volle Kontrolle über Ihre Plattform und bietet Ihnen gleichzeitig viele nützliche Tools, mit denen Ihre Kunden effektiver in Ihrem Benutzerhandbuch navigieren können:

• Organisation nach Kategorien – Sie können Ihr Benutzerhandbuch einfach in logische Kategorien organisieren und diese Kategorien per Drag-and-Drop anordnen.
• Suchvorschläge in Echtzeit – Wenn Kunden direkt zu einem bestimmten Tutorial springen möchten, können sie einfach mit der Eingabe der Suche beginnen und Live-Suchvorschläge basierend auf ihren Suchanfragen sehen.
• Automatisches Inhaltsverzeichnis – das Plugin generiert automatisch ein anklickbares Inhaltsverzeichnis für jeden Artikel im Benutzerhandbuch, das den Lesern hilft, direkt zu dem für sie relevanten Abschnitt zu springen.
• Einfache Legenden/Formatierung – Sie können ganz einfach Legenden und andere Formatierungen hinzufügen, um die Aufmerksamkeit auf Schlüsselelemente in Ihren Artikeln zu lenken.
• Sofortantworten-Widget – Zusätzlich zum Erstellen einer dedizierten Benutzerhandbuchseite auf Ihrer Website können Sie auch ein durchsuchbares Sofortantworten-Widget hinzufügen, mit dem Besucher den Inhalt des Benutzerhandbuchs von überall auf Ihrer Website durchsuchen können.

Wenn Sie noch mehr Optionen für Software sehen möchten, die Sie bei der Veröffentlichung eines Benutzerhandbuchs unterstützt, können Sie unsere Beiträge über die beste Wissensdatenbank-Software und die besten Dokumentationstools lesen.

6. Aktualisieren und überarbeiten Sie Ihr Benutzerhandbuch nach Bedarf

Das Erstellen eines Benutzerhandbuchs ist kein einmaliger Aufwand. In Zukunft müssen Sie Zeit in die Überarbeitung und Aktualisierung Ihrer Inhalte investieren.

Es gibt zwei Hauptgründe, warum Sie Ihr Benutzerhandbuch möglicherweise aktualisieren müssen:

1. Sie haben Ihrem Produkt neue Funktionen hinzugefügt oder die Funktionsweise vorhandener Funktionen/Schnittstellen geändert.
2. Sie möchten den Inhalt Ihres Benutzerhandbuchs verbessern, um ihn hilfreicher zu machen.

Die erste Situation ist offensichtlich – wenn Sie Ihr Produkt in irgendeiner Weise ändern, müssen Sie Ihr Benutzerhandbuch aktualisieren, um diese Änderungen zu berücksichtigen.

Es ist jedoch wichtig, auch die zweite Situation zu berücksichtigen. So sehr Sie es auch versuchen, Sie werden wahrscheinlich nicht jeden Benutzerhandbuchartikel vom ersten Tag an perfekt hinbekommen.

Um Ihren Benutzern besser helfen zu können, sollten Sie manuelle Inhalte mit geringer Leistung aktualisieren und überarbeiten, um sie nützlicher zu machen.

Wenn Sie Ihr Benutzerhandbuch mit einem Tool wie der Heroic Knowledge Base veröffentlichen, enthält es integrierte Bewertungen der Nützlichkeit von Artikeln, sodass Sie leicht erkennen können, welche Artikel verbessert werden müssen. Benutzer können auch Text-Feedback zum Artikel hinterlassen, das Sie auf bestimmte Teile des Artikels hinweisen kann, die nicht so hilfreich sind, wie sie sein könnten:

Möglicherweise fehlen Ihnen auch Artikel zu Themen, mit denen Benutzer Probleme haben. Um Ihnen bei der Suche nach diesen fehlenden Themen zu helfen, enthält die Heroic Knowledge Base auch integrierte Suchanalysen, sodass Sie nachverfolgen können, welche Suchen keine Themenergebnisse haben ( sowie allgemeine Suchen im Allgemeinen ):

Erstellen Sie noch heute Ihr Benutzerhandbuch

Zu lernen, wie man ein Benutzerhandbuch erstellt, ist wichtig, wenn Sie Ihre Kunden auf Erfolgskurs bringen wollen.

Mit den Tipps und Best Practices in diesem Beitrag sollten Sie jetzt das Wissen haben, das Sie brauchen, um mit Ihrem Benutzerhandbuch loszulegen.

Für eine einfache Möglichkeit, Ihr Benutzerhandbuch online zu veröffentlichen und Ihren Kunden bei der Navigation zu helfen, können Sie WordPress und das Heroic Knowledge Base-Plugin verwenden.

Heroic Knowledge Base macht es einfach, Ihre Artikel zu veröffentlichen und sie nach Bedarf zu organisieren. Außerdem können Ihre Kunden hilfreiche Funktionen wie Live-Suchvorschläge, automatische Inhaltsverzeichnisse und mehr nutzen.

Beginnen Sie noch heute und Sie werden Ihr Benutzerhandbuch im Handumdrehen veröffentlichen.

Wenn Sie daran interessiert sind, Dokumentation zu erstellen, um das interne Wissen in Ihrem Unternehmen zu verbessern, könnten Sie auch an unserem Tutorial zur Veröffentlichung eines Schulungshandbuchs für Ihre Mitarbeiter interessiert sein.