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

Ein Benutzerhandbuch ist ein Inhalt, der Ihren Kunden (oder Mitarbeitern) hilft, Ihr Produkt oder Ihre Dienstleistung effektiv zu nutzen. Indem es klare Anweisungen gibt und eine sichere Nutzung gewährleistet.

Benutzerhandbücher helfen Ihren Kunden nicht nur, Ihr Produkt effektiv zu nutzen, sondern können auch dazu beitragen, Kundendienst- und Supportanfragen zu reduzieren.

Hier ist ein typisches Beispiel für ein Benutzerhandbuch:

Quelle: ManyManuals

Daran ist nichts auszusetzen, und für Produkte mit begrenzter Nutzung funktioniert es immer noch gut. Aber was ist mit Software? Oder mit Produkten wie Telefonen, die Hunderte von Funktionen und Anwendungsfällen haben?

Klingt kompliziert, oder?

Hier ist der Ansatz von Sony für das Benutzerhandbuch seiner Mobiltelefone.

• Eine sehr praktische und leistungsstarke Suchleiste, die immer auf dem Bildschirm zu sehen ist
• Schneller Zugang zu Online- und Offline-Benutzerhandbüchern (die meist mit Mobiltelefonen geliefert werden).
• Hochwertiges Bildmaterial, das äußerst nützlich ist und ein erstklassiges Gefühl vermittelt.
• Direkt auf den Punkt gebracht mit Listen, Schritten und anderen Bausteinen.
• Leistungsstarke Seitenleiste.
• Leitfäden können über Suchmaschinen leicht gefunden werden.

All dies macht die Erfahrung für die Kunden sehr angenehm.

Deshalb sollten Sie die Erstellung eines Online-Handbuchs in Erwägung ziehen, das benutzerfreundlich ist und über Suchmaschinen leicht gefunden werden kann.

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

Auf geht's!

Verschiedene Arten von Benutzerhandbüchern

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

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:

• Gebrauchsanweisung: In einer klassischen Gebrauchsanweisung wird den Benutzern erklärt, wie sie ein Produkt verwenden können. Wir haben in unserem anderen Leitfaden viel über die Gebrauchsanweisung gesprochen, falls Sie mehr darüber erfahren möchten.
• Schulungshandbuch: In einem Schulungshandbuch wird den Benutzern beigebracht, wie sie eine bestimmte Aufgabe oder einen bestimmten Job erledigen können.
• Betriebshandbuch: Ein Betriebshandbuch ist in der Regel ein internes Handbuch, das die Abläufe in Ihrem Unternehmen dokumentiert.
• Wartungshandbuch: In einem Wartungshandbuch wird den Benutzern vermittelt, wie sie ein Produkt zu verschiedenen Zeitpunkten seines Lebenszyklus richtig warten können.
• 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.

Wie man ein Benutzerhandbuch 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.

Hinweis: Ich empfehle, keine Schritte zu überspringen, wenn Sie nicht überfordert werden wollen.

Schritt 1. Festlegung von Zielen und Identifizierung der Hauptprobleme

Die Festlegung von Zielen und das Verstehen von Problemen sollte der erste Schritt bei jedem Projekt sein.

Mit dem Benutzerhandbuch können Sie Ziele wie z. B.:

1. Benutzer durch den Einrichtungsprozess leiten
2. Reduzierung der Kunden-Support-Tickets
3. Gewährleistung der sicheren Nutzung
4. Verbesserung der Benutzerfreundlichkeit
5. Einhaltung von Rechts- und Industriestandards

Und wenn Sie sich Ziele gesetzt haben, können Sie nach den wichtigsten Problemen suchen:

1. Mangel an Erfahrung
2. Thema Haushalt
3. Nutzung von Eigenentwicklungen im Vergleich zu Online-Lösungen
4. Ziele, die mit herkömmlichen Benutzerhandbüchern nicht erreicht werden können
5. Nützlichkeit

So erhalten Sie eine gute Vorstellung davon, wo Sie stehen, und können einen klaren Rahmen für dieses Projekt festlegen.

Schritt 2. Inhalt des Benutzerhandbuchs erstellen

Im Folgenden finden Sie einige bewährte Verfahren, die Sie bei der Erstellung von Benutzerhandbüchern beachten sollten:

2.1. Verstehen Sie Ihre Benutzer

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.2. Themen finden, über die man schreiben kann

Sie wollen auf keinen Fall ziellos Zeit mit dem Schreiben von Inhalten verbringen, die möglicherweise nicht das sind, wonach die Nutzer suchen.

Um Ihnen den Einstieg zu erleichtern.

Das Kundenserviceteam kann häufig gestellte Fragen sammeln und sie mit einem Benutzerhandbuch lösen, bevor die Benutzer danach suchen.

Sie können sich auch mit Analysen befassen, um zu verstehen, wonach die Nutzer suchen, aber das ist erst möglich, wenn Sie mit dem Benutzerhandbuch für die Einstellungen fertig sind.

2.3. Erstellen einer logischen Struktur und Hierarchie

Um auf das Beispiel von Sony zurückzukommen, können Sie sehen, wie gut deren Inhalte strukturiert sind.

Wenn ein Benutzer Probleme mit der Konnektivität hat, macht es der gut organisierte Inhalt einfach, verwandte Dokumente zu finden.

Es kann den Kunden nicht nur helfen, schnell Antworten zu finden:

1. Dies wird Ihnen helfen, den Inhalt des Benutzerhandbuchs einzugrenzen.
2. Außerdem wird die Seite durch Breadcrumbs, Inhaltsgruppierung und eine bessere Benutzerfreundlichkeit SEO-freundlich.

Im Folgenden finden Sie einige Tipps, die Ihnen bei der Erstellung einer geeigneten Struktur 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.

2.4. Inhalt des Benutzerhandbuchs schreiben

Das Schreiben von Benutzerhandbüchern unterscheidet sich völlig von normalen Inhalten. Er ist so einfach wie möglich, ohne Fachjargon und sehr visuell.

Nehmen Sie das Benutzerhandbuch von Sony¹ als Beispiel.

Wie Sie sehen können, ist es sehr informativ und erklärt auf einfache Weise die Grundlagen des Umgangs mit den Einstellungen von Mobilgeräten oder des Startbildschirms, und diese Bilder fügen eine nette Note hinzu, die die allgemeine Klarheit des Tutorials verbessert.

Hier sind einige Tipps, die Sie befolgen können, um hochwertige Inhalte für Benutzerhandbücher zu schreiben:

1. Verwenden Sie eine einfache Sprache und vermeiden Sie Fachjargon. Wenn Jargon unvermeidlich ist, sollten Sie ihn erklären.
2. 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.
3. 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.
4. 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.
5. Verwenden Sie eine aktive Stimme. Der Passivsatz kann besonders 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 einschalten, indem Sie den roten Knopf drücken". Das letztere Beispiel (aktive Stimme) ist klarer und macht es dem Leser leichter, sich in die Anleitung hineinzuversetzen.
6. Achten Sie auf eine einheitliche Formatierung, die im Folgenden erläutert wird.

2.5. Vorlagen verwenden, um eine konsistente Formatierung zu gewährleisten

Die Erstellung einer formatierten Vorlage beschleunigt nicht nur Ihre Arbeit, sondern sorgt auch dafür, dass jeder Artikel in Ihrem Handbuch mit den anderen konsistent ist.

Diese Vorlage wird bevorzugt für Artikel in Benutzerhandbüchern oder kundenorientierten Leitfäden verwendet.

Ihre Vorlage kann eine grundlegende Gliederung enthalten, die Sie bei der Erstellung des Inhalts des Benutzerhandbuchs befolgen können:

Zum Beispiel sollte jeder Artikel des Benutzerhandbuchs die folgenden Eigenschaften aufweisen:

1. Suchleiste
2. Semmelbrösel
3. Titel
4. Intro
5. Hauptinhalt
6. Tipps, Hinweise oder andere wichtige Informationen
7. Bilder
8. Feedback-System
9. Ähnliche Artikel
10. Links zur Gemeinschaft, zum Forum oder zur Unterstützung

Schließlich ist es immer eine gute Idee, Ihre Leitfäden so zu testen, als wären Sie ein Erstnutzer.

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

Nun, da Sie die Ziele und den Inhalt des Benutzerhandbuchs gut verstanden haben, können wir mit der Erstellung eines Online-Portals beginnen, auf dem Sie Ihre Benutzerhandbuchartikel veröffentlichen können.

Schritt 3. Benutzerhandbuch Website erstellen

Da wir ein Online-Portal für Benutzerhandbücher vorbereiten, um den Zugang zu erleichtern und die Benutzerfreundlichkeit zu erhöhen, müssen wir zunächst eine WordPress-Website erstellen.

3.1. WordPress Website erstellen

WordPress ist die erste Wahl, wenn es um die Erstellung von Websites geht. Es ist ein kostenloses Content Management System (CMS), das Sie mit Themes und Plugins nach Belieben gestalten können.

Das Erstellen einer WordPress-Website ist einfach. Hier erfahren Sie, wie Sie WordPress auf Kinsta installieren können.

1. Kaufen Sie ein beliebiges Kinsta-Hostingpaket.
2. Folgen Sie dem Prozess der Kontoerstellung und der Kaufabwicklung.
3. Überprüfen Sie die E-Mail.

Danach wird Ihnen ein Dashboard angezeigt. Vom Dashboard aus können Sie ganz einfach WordPress-Sites erstellen.

Wie bei den Benutzerhandbüchern gibt es auch bei Kinsta eine sehr gute Benutzerdokumentation, die Sie bei Problemen einsehen können, oder Sie wenden sich einfach an das Support-Team.

Wie Kinsta kann auch WordPress problemlos auf jeder Hosting-Plattform installiert werden. Sie haben die Wahl!

3.2. Benutzerhandbuch Portal erstellen

Jetzt, wo Sie eine WordPress-Website fertig haben, können Sie damit beginnen, Ihr Online-Handbuchportal zu erstellen!

Ein Benutzerhandbuch online zu hosten ist ähnlich wie die Erstellung einer Benutzerdokumentation. Dazu benötigen wir eine Software, die die folgenden Anforderungen erfüllt:

1. Leistungsstarke Suchleiste
2. Flexibel und vollständig anpassbar
3. Optionen zur Kategorisierung und Kennzeichnung
4. Dedizierte Bausteine für visuelle Elemente
5. Freiheit bei Layout und Gestaltung
6. Benutzerrollen und Zugangskontrolle
7. Feedback-System
8. Analysen und Berichte
9. SEO-Kontrollen

Heroische Wissensdatenbank erfüllt alle oben genannten Anforderungen und ermöglicht es Ihnen, sich auf die Erstellung von Inhalten zu konzentrieren.

Laden Sie die Heroic KB .zip-Datei herunter, indem Sie einen beliebigen Plan von hier kaufen, und notieren Sie sich den Lizenzschlüssel.

Sobald Sie die erforderliche Datei bereit haben:

1. Zugang zu Ihrem Website-Dashboard durch Hinzufügen von "/wp-admin" an das Ende der URL Ihrer Website.
2. Klicken Sie auf Plugins → Neues Plugin hinzufügen.
3. Klicken Sie auf die Schaltfläche Plugin hochladen.
4. Wählen Sie die Plugin-Datei Heroic KB .
5. Klicken Sie auf die Schaltfläche Jetzt installieren.
6. Aktivieren Sie nach der Installation das Plugin.

Sobald die Installation des Plugins abgeschlossen ist, wird Ihnen ein Einrichtungsassistent angezeigt. Folgen Sie einfach den Schritten.

1. Aktivieren Sie das Plugin mit einem Lizenzschlüssel, den Sie im Bereich Downloads erhalten.
2. Installieren Sie die Demo-Inhalte.

Hinweis: Wenn Sie den Einrichtungsassistenten während der Plugin-Installation übersehen haben, können Sie ihn über den Bereich Plugins erneut aufrufen.

Herzlichen Glückwunsch 🎊! Ihr Benutzerhandbuch-Portal ist fertig und Sie können mit der Anpassung und dem Hinzufügen von Inhalten beginnen.

Um Ihr neu erstelltes Portal zu überprüfen, besuchen Sie die Website: yourdomain.com/knowledge-base/.

Schritt 4. Gestalten Sie Ihr Portal

Mit der Premium-Software für Benutzerhandbücher wie Heroic KB haben Sie die Freiheit, Ihr Portal nach Ihren Vorstellungen zu gestalten.

Sie können die meisten Anpassungen vornehmen, ohne eine einzige Zeile Code schreiben zu müssen, indem Sie einfach die Einstellungen über Website-Dashboard → Heroic KB → Einstellungen aktualisieren.

Lassen Sie uns einige Szenarien durchspielen.

4.1. Farben

Sie können die Farben des Benutzerhandbuchportals an Ihren Marken-Styleguide anpassen. Um dies zu tun:

1. Website Dashboard besuchen
2. Klicken Sie auf Heroic KB → Einstellungen
3. Klicken Sie auf die Registerkarte Erscheinungsbild

4.2. Seitenleisten

Möchten Sie Ihre Standard-Seitenleiste anpassen?

1. Website Dashboard besuchen
2. Klicken Sie auf Heroic KB → Einstellungen
3. Klicken Sie auf die Registerkarte Allgemein
4. Einstellungen für die Seitenleiste verwalten
5. Änderungen speichern , um Einstellungen zu übernehmen

Und um den Inhalt der Seitenleiste zu ändern, gehen Sie zu Darstellung → Widgets.

Schritt 5. Hinzufügen von Artikeln zum Benutzerhandbuch

Das Hinzufügen von Artikeln zum Handbuch ist ähnlich wie das Ausfüllen eines Online-Formulars, nur dass Sie bei der Gestaltung völlig frei sind.

Sie können so viel erreichen, wenn Sie sich mit Web Page Buildern auskennen, und die Erstellung komplexer Layouts wird so einfach, wenn Sie erst einmal den Dreh raus haben.

So können Sie z. B. in wenigen Minuten ein Layout erstellen, das den Benutzerhandbüchern von Apple ähnelt, und es durch die Erstellung von Vorlagen wiederverwenden.

Nun zurück zum Hauptleitfaden. Alle Artikel des Benutzerhandbuchs können über das Website-Dashboard → Heroic KB aufgerufen werden.

Von hier aus können Sie neue Artikel hinzufügen oder alte Artikel verwalten.

Um einen neuen Artikel hinzuzufügen, klicken Sie einfach auf die Schaltfläche Neuen Artikel hinzufügen oder Heroic KB → Neuen Artikel hinzufügen.

So sieht Ihr Article Builder aus.

Sie erhalten die zusätzlichen Funktionen des WordPress-Editors und Heroic KB , um die ultimativen Benutzerhandbücher zu erstellen.

• Funktioniert wie jeder normale Editor wie TinyMCE, nur mit zusätzlichen Gestaltungsoptionen.
• Fügen Sie Absätze, Überschriften, Listen, Bilder oder beliebige HTML-Inhalte hinzu.
• Erstellen Sie einzigartige Layouts mit Gruppen-, Zeilen-, Stapel- oder Gitterblöcken.
• Fügen Sie Anhänge hinzu, wählen Sie ein Abstimmungssystem oder schützen Sie das Handbuch mit den Einstellungen von Heroic KB durch ein Passwort.

Spielen Sie einfach ein paar Minuten damit, Sie werden die Gestaltungsfreiheit sicher lieben.

5.1. Artikel SEO-freundlich gestalten

Wenn jemand Probleme mit Ihrem Produkt hat, wird er zuerst bei Google (oder einer anderen Suchmaschine) suchen. Wenn Sie Ihre benutzerhandbuchbasierte Website nicht suchmaschinenfreundlich gestalten, wird harsch Benutzererfahrung beeinträchtigen.

Stellen Sie sich vor, welche Schritte erforderlich sind, um einen einfachen Leitfaden über Ihre Produkte zu finden:

1. Die Nutzer suchen im Internet nach einer Lösung und finden keine Antworten.
2. Besucht Ihre Website und beginnt eine Suche in der Wissensdatenbank.
3. Das Durchsuchen einer riesigen Liste von Artikeln, um eine einfache Antwort oder einen Leitfaden zu finden.

Klingt so schmerzhaft - und das ist es auch.

Dies kann vermieden werden, indem die Artikel SEO-freundlich gestaltet werden, und Sie müssen hier nicht so viel investieren, da die meisten Suchanfragen, auf die Sie hier abzielen werden, auf Ihrem Marken-Keyword basieren.

Das Hinzufügen eines SEO-Plugins wie Yoast sollte genügen.

Beachten Sie außerdem die folgenden SEO-Tipps für Online-Benutzerhandbücher:

1. Halten Sie den Titel des Artikels einfach und versuchen Sie, das wichtigste Schlüsselwort zu nennen.
2. Verwenden Sie das Hauptstichwort für den Slug des Artikels.
3. Gruppieren Sie Inhalte mithilfe von Kategorien und Tags.
4. Verlinken Sie verwandte und notwendige Artikel/Leitfäden.

Wir haben im Detail behandelt, wie man Yoast SEO mit Heroic KB verwenden, überprüfen Sie es aus, um mehr zu erfahren.

Schritt 6. Aktualisieren und überarbeiten Sie den Inhalt Ihres Benutzerhandbuchs 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 sie aktualisieren müssen:

1. Sie haben Ihrem Produkt neue Funktionen hinzugefügt oder die Funktionsweise bestehender Funktionen/Schnittstellen geändert.
2. Sie wollen Inhalte verbessern, um sie hilfreicher zu machen.

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

Aber auch die zweite Situation ist wichtig zu bedenken. So sehr Sie sich auch bemühen mögen, Sie werden wahrscheinlich nicht jeden Leitfaden oder jedes Tutorial 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 ein Benutzerhandbuch mit einem Tool wie Heroic Knowledge Base erstellen, enthält es integrierte Bewertungen für die Nützlichkeit der Artikel, so dass Sie leicht erkennen können, welche Artikel verbessert werden müssen.

Die Nutzer 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 die 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, welche Suchanfragen keine Themenergebnisse liefern(sowie die Suchanfragen im Allgemeinen):

Erstellen Sie Ihr Benutzerhandbuch noch heute

Wir haben versucht, auf der Grundlage unserer bisherigen Erfahrungen alles abzudecken. Damit sollten Sie nun über das nötige Wissen verfügen, um eine effektive Benutzerhandbuch-Website zu erstellen.

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.

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

Legen Sie noch heute los, und Sie werden in kürzester Zeit mit Ihrem Benutzerhandbuch online sein.

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.

In diesem Tutorial verwendete Ressourcen

1. Beispiel für den Inhalt des Benutzerhandbuchs von Sony ︎