Wie man ein Benutzerhandbuch erstellt: Vom Nullpunkt zum Helden (Vollständige Anleitung)

Sie sind sich nicht sicher, wie Sie ein Benutzerhandbuch erstellen sollen, damit Ihre Kunden einen größeren Nutzen aus Ihrem Produkt ziehen können?

Ein Benutzerhandbuch ist ein Inhalt, der Ihren Kunden (oder Mitarbeitern) hilft, Ihr Produkt oder Ihre Dienstleistung effektiv zu nutzen. Man könnte es auch als Benutzerhandbuch, Bedienungsanleitung, Produkthandbuch usw. bezeichnen.

Ein hochwertiges Benutzerhandbuch hilft nicht nur Ihren Kunden, Ihr Produkt effektiv zu nutzen, sondern kann auch dazu beitragen, Kundendienst- und Supportanfragen zu reduzieren, da die Benutzer ihre Probleme lösen können, ohne sich an den Support wenden zu müssen.

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

Um das zu erreichen, werden wir uns mit folgenden Themen befassen:

• Verschiedene Arten von Benutzerhandbüchern
• Wo Sie Ihr Benutzerhandbuch veröffentlichen können
• Wie man ein Benutzerhandbuch erstellt

Auf geht's!

Verschiedene Arten von Benutzerhandbüchern

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

Bevor Sie beginnen, sollten Sie sich darüber im Klaren sein, welche Art von Handbuch Sie erstellen möchten, da dies Einfluss darauf hat, wie Sie den Inhalt gestalten.

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

• Benutzerhandbuch - ein klassisches Benutzerhandbuch lehrt die Benutzer, wie man ein Produkt benutzt.
• Schulungshandbuch - In einem Schulungshandbuch wird den Benutzern beigebracht, wie sie eine bestimmte Aufgabe oder einen bestimmten Auftrag ausführen können.
• Betriebshandbuch - ein Betriebshandbuch ist in der Regel ein internes Handbuch, das die Abläufe in Ihrem Unternehmen dokumentiert.
• Wartungshandbuch - ein Wartungshandbuch vermittelt den Benutzern, wie ein Produkt zu verschiedenen Zeitpunkten des Produktlebenszyklus richtig gewartet wird.
• Standardarbeitsanweisungen (SOPs) - SOPs sind interne Handbücher, in denen die Mitglieder der Organisation lernen, wie man bestimmte Prozesse "richtig" ausführt.

In den folgenden Anweisungen geht es hauptsächlich um die Erstellung eines Benutzerhandbuchs für die Öffentlichkeit. Die folgenden Grundprinzipien gelten jedoch für jede Art von Benutzerhandbuch.

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 wollen.

Für Benutzerhandbücher, die für Kunden bestimmt sind, werden Sie diese fast immer auf Ihrer Website veröffentlichen wollen. Auf diese Weise können die Benutzer von überall aus auf das Handbuch zugreifen.

Darüber hinaus können Sie durch die Veröffentlichung von Benutzerhandbuchinhalten im Internet eine benutzerfreundlichere Erfahrung schaffen als mit einem physischen Benutzerhandbuch, indem Sie beispielsweise anklickbare Inhaltsverzeichnisse und Suchvorschläge in Echtzeit hinzufügen.

Bei physischen Produkten können Sie jedoch auch ein physisches Benutzerhandbuch als Ergänzung zu Ihrem webbasierten Handbuch anbieten.

Interne Benutzerhandbücher sollten in der Regel vor der Öffentlichkeit verborgen werden. 

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

Stattdessen können Sie den Inhalt mit einem Kennwort schützen, indem Sie den Mitarbeiter auffordern, sich bei einem Benutzerkonto anzumelden, oder einfach ein Kennwort für den Zugriff auf die Seite hinzufügen.

Für physische Benutzerhandbücher können Sie ein spezielles Wissensmanagement-Tool verwenden, das Sie bei der Veröffentlichung komplexerer Handbücher unterstützt. Für einfachere Benutzerhandbücher können Sie auch einfach in Google Docs schreiben und von dort aus veröffentlichen - unsere Sammlung von Tools zum technischen 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 Wissensdatenbankprogramme verwenden. Wenn Sie ein Tool suchen, das sowohl für öffentliche als auch für interne Benutzerhandbücher geeignet ist, können Sie das Open-Source-Plugin Heroic Knowledge Base für WordPress verwenden. Wir werden in diesem Tutorial näher darauf eingehen.

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

Mehr über Dokumentation erfahren Sie in unserer Übersicht über die 12 besten Dokumentationsbeispiele.

Apropos Lernprogramm...

Wie man ein Benutzerhandbuch in sechs Schritten erstellt

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

1. Erstellen Sie Ihre Benutzer-Persona(s)

Bevor Sie mit der Erstellung von Inhalten beginnen, sollten Sie sich darüber im Klaren sein, für wen die Inhalte bestimmt sind. Dies können Sie erreichen, indem Sie User Personas 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 ein Beispiel:

Es besteht ein großer Unterschied zwischen der Erstellung technischer Inhalte für Maschinenbauingenieure und der Erstellung technischer Inhalte für nichttechnische Benutzer.

Bei den meisten Produkten werden die Unterschiede nicht so gravierend sein. Dennoch ist es wichtig, Ihre Kunden-Personas zu verstehen, damit Sie sicherstellen können, dass Ihr Benutzerhandbuch für die Personen sinnvoll ist, die es tatsächlich benutzen werden.

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

Sobald Sie wissen, wer Ihre Kunden sind, müssen Sie im nächsten Schritt herausfinden, was sie mit dem von Ihnen zu erstellenden Benutzerhandbuch erreichen wollen.

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

Dies zu verstehen ist wichtig, denn der Zweck Ihres Handbuchs sollte es sein, Ihren Benutzern zu helfen, dieses Ziel so effizient wie möglich zu erreichen.

In manchen Fällen kann dieses Endziel eine bestimmte Sache sein. Wenn Sie z. B. ein Tool zur Verwaltung sozialer Medien verwenden, könnte es "die Planung eines Beitrags in sozialen Medien" sein.

In anderen Fällen kann es sich um ein abstrakteres Ziel handeln, wie z. B. die "Verbesserung unserer Projektmanagementprozesse".

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

3. Erstellen Sie eine logische Struktur und Hierarchie

Da Sie nun wissen, wer Ihre Kunden sind und was sie erreichen wollen, können Sie mit der Strukturierung Ihres Benutzerhandbuchs beginnen.

Sie wollen eine Struktur schaffen, die Ihre Nutzer von "Null" bis zum Erreichen der im vorherigen Abschnitt genannten Ziele führt.

Hier sind einige Tipps, die Ihnen dabei helfen:

1. Überlegen Sie, wie Sie den Kunden helfen können, so schnell wie möglich einen Nutzen aus Ihrem Produkt zu ziehen.
2. Lassen Sie Ihr persönliches Wissen außen vor. Sie wissen natürlich viel über Ihr Produkt, aber Ihre Kunden werden nicht über dieses Hintergrundwissen verfügen.
3. Achten Sie darauf, dass Sie häufige Probleme oder verwirrende Details behandeln, auf die Ihre Kunden bei der Verwendung Ihres Produkts stoßen könnten. Diese sollten logischerweise zu den Zeitpunkten angesprochen werden, zu denen die Kunden am ehesten auf Probleme stoßen.

4. Schreiben Sie den Inhalt Ihres Benutzerhandbuchs

Sobald Sie Ihren Inhalt festgelegt haben, können Sie mit dem Schreiben beginnen.

Je nach Größe Ihres Produkts/Ihrer Organisation können Sie alles selbst schreiben. Oder Sie müssen mit anderen Teammitgliedern zusammenarbeiten, um die Inhalte zu schreiben.

Im Folgenden finden Sie einige allgemeine Best Practices für Benutzerhandbücher, die Sie beim Verfassen Ihres Benutzerhandbuchs berücksichtigen sollten:

• Verwenden Sie eine Vorlage, um eine einheitliche Formatierung zu gewährleisten. Die Erstellung einer formatierten Vorlage beschleunigt nicht nur Ihre Arbeit, sondern stellt auch sicher, dass jeder Artikel in Ihrem Handbuch mit den anderen konsistent ist.
• Binden Sie visuelle Elemente (Bilder und Videos) ein, um den Nutzern zu helfen. Ein gut kommentiertes Bild oder GIF kann hilfreicher sein als eine alleinstehende Textanleitung, egal wie detailliert und gründlich der Text ist.
• Verwenden Sie eine einfache Sprache und vermeiden Sie Fachjargon. Wenn Jargon unvermeidlich ist, sollten Sie ihn erklären.
• Fassen Sie sich kurz und prägnant. Ihr Ziel bei einem Benutzerhandbuch sollte es sein, das Thema vollständig abzudecken, aber in so wenigen Worten wie möglich. Lassen Sie keine wichtigen Informationen aus, aber kürzen Sie rücksichtslos alle unnötigen Inhalte.
• Verwenden Sie, wenn möglich, Aufzählungen und Listen für Anweisungen. Eine nummerierte oder mit Aufzählungszeichen versehene Liste kann es den Benutzern erleichtern, den Überblick über den Leitfaden zu behalten. Wenn Sie mehr Details benötigen, als eine Liste erlaubt, können Sie jedem Schritt eine eigene Unterüberschrift geben.
• Verwenden Sie die aktive Sprache. Der Passivsatz kann vor allem bei den Anweisungen in einem Benutzerhandbuch 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". Das letztere Beispiel (aktive Stimme) ist klarer und macht es dem Leser leichter, sich in die Anleitung hineinzuversetzen.

Schließlich ist es immer eine gute Idee, die Anweisungen in Ihrem Benutzerhandbuch so zu testen, als wären Sie ein Erstnutzer.

Das heißt, wenn Sie einen Artikel geschrieben haben, gehen Sie zurück und folgen Sie den Anweisungen Schritt für Schritt, um sicherzustellen, dass Sie nichts übersehen haben.

5. Veröffentlichen Sie Ihr Benutzerhandbuch

Sobald Sie Ihre Inhalte erstellt haben, ist der letzte Schritt die Veröffentlichung Ihres Benutzerhandbuchs, um es Ihren Kunden leicht zugänglich zu machen.

Wie Sie dies tun, hängt von der Art des Produkts ab, das Sie anbieten. Wenn Sie z. B. physische Produkte versenden, sollten Sie eine physische Version Ihres Handbuchs beifügen.

Unabhängig von der Art des Produkts, das Sie anbieten, sollten Sie Ihr Benutzerhandbuch online veröffentlichen, damit die Benutzer es leicht finden können.

Zu diesem Zweck können Sie eine Wissensdatenbank/Dokumentationssoftware verwenden.

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

Dieser Ansatz einer Open-Source-Wissensdatenbank gibt Ihnen die volle Verantwortung und Kontrolle über Ihre Plattform und bietet gleichzeitig viele nützliche Tools, die Ihren Kunden helfen, sich in Ihrem Benutzerhandbuch besser zurechtzufinden:

• Kategorienorganisation - Sie können Ihr Benutzerhandbuch ganz einfach in logische Kategorien einteilen und diese Kategorien per Drag & Drop anordnen.
• Suchvorschläge in Echtzeit - wenn Kunden direkt zu einem bestimmten Tutorial springen möchten, können sie einfach mit der Suche beginnen und erhalten Live-Suchvorschläge auf der Grundlage ihrer Suchanfragen.
• Automatisches Inhaltsverzeichnis - das Plugin generiert automatisch ein klickbares Inhaltsverzeichnis für jeden Artikel des Benutzerhandbuchs, das den Lesern hilft, direkt zu dem Abschnitt zu springen, der für sie relevant ist.
• Einfache Beschriftungen/Formatierungen - Sie können problemlos Beschriftungen und andere Formatierungen hinzufügen, um die Aufmerksamkeit auf wichtige Elemente in Ihren Artikeln zu lenken.
• Widget für Sofortantworten - Sie können nicht nur eine eigene Seite mit Benutzerhandbüchern auf Ihrer Website erstellen, sondern auch ein durchsuchbares Widget für Sofortantworten hinzufügen, mit dem Besucher die Inhalte von Benutzerhandbüchern von überall auf Ihrer Website durchsuchen können.

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

6. Aktualisieren und überarbeiten Sie Ihr Benutzerhandbuch nach Bedarf

Die Erstellung eines Benutzerhandbuchs ist keine einmalige Angelegenheit. Auch in Zukunft müssen Sie Zeit in die Überarbeitung und Aktualisierung Ihrer Inhalte investieren.

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

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

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.

Aber auch die zweite Situation ist zu berücksichtigen. So sehr Sie sich auch bemühen mögen, Sie werden wahrscheinlich nicht jeden Artikel des Benutzerhandbuchs vom ersten Tag an perfekt hinbekommen.

Um Ihren Nutzern besser zu helfen, sollten Sie schlecht funktionierende manuelle Inhalte aktualisieren und überarbeiten, um sie nützlicher zu machen.

Wenn Sie Ihr Benutzerhandbuch mit einem Tool wie Heroic Knowledge Base veröffentlichen, enthält es integrierte Bewertungen für die Nützlichkeit der Artikel, 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:

Sie könnten auch Artikel zu Themen vermissen, mit denen Benutzer Probleme haben. Um Ihnen bei der Suche nach diesen fehlenden Themen zu helfen, enthält die Heroic Knowledge Base auch eine integrierte Suchanalyse, mit der Sie verfolgen können, bei welchen Suchvorgängen keine Themenergebnisse gefunden werden(sowie bei Suchvorgängen im Allgemeinen):

Erstellen Sie Ihr Benutzerhandbuch noch heute

Die Erstellung eines Benutzerhandbuchs ist wichtig, wenn Sie Ihren Kunden zum Erfolg verhelfen wollen.

Mit den Tipps und bewährten Verfahren in diesem Beitrag sollten Sie nun über das Wissen verfügen, das Sie benötigen, um Ihr Benutzerhandbuch in Gang zu bringen.

Eine einfache Möglichkeit, Ihr Benutzerhandbuch online zu veröffentlichen und Ihren Kunden bei der Navigation zu helfen, ist die Verwendung von WordPress und dem Heroic Knowledge Base Plugin.

Mit Heroic Knowledge Base ist es einfach, Ihre Artikel zu veröffentlichen und sie nach Bedarf zu organisieren. Außerdem können Ihre Kunden von hilfreichen Funktionen wie Live-Suchvorschlägen, automatischen Inhaltsverzeichnissen und mehr profitieren.

Legen Sie noch heute los und veröffentlichen Sie Ihr Benutzerhandbuch im Handumdrehen.

Wenn Sie daran interessiert sind, Dokumentationen zu erstellen, um das interne Wissen in Ihrem Unternehmen zu verbessern, könnte Sie auch unser Tutorial über die Veröffentlichung eines Schulungshandbuchs für Ihre Mitarbeiter interessieren.