So erstellen Sie ein Benutzerhandbuch: Von Null 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 klare Anweisungen gegeben und die sichere Nutzung gewährleistet wird.

Benutzerhandbücher helfen Ihren Kunden nicht nur, Ihr Produkt effektiv zu nutzen, sondern können Ihnen auch helfen, Anfragen an den Kundenservice und Support zu reduzieren.

Hier ist ein typisches Beispiel für ein Benutzerhandbuch:

Aktivieren Sie das Plugin mit einem Lizenzschlüssel, den Sie im Download-Bereich erhalten.

Nichts falsch daran, es funktioniert immer noch großartig für Produkte mit begrenzter Nutzung. Aber was ist mit Software? Oder Produkte wie Telefone, die Hunderte von Funktionen und Anwendungsfällen haben?

Scheint kompliziert, oder?

Hier ist Sonys Ansatz für ihr Benutzerhandbuch für Mobiltelefone.

• Eine sehr praktische und leistungsstarke Suchleiste, die immer auf dem Bildschirm ist
• Schneller Zugriff auf ein Online- und ein Offline-Benutzerhandbuch (das meistens mit Mobiltelefonen geliefert wird).
• Hochwertige Grafiken, die äußerst nützlich sind und ein Premium-Gefühl vermitteln.
• Direkt auf den Punkt gebracht mit Listen, Schritten und anderen Bausteinen.
• Leistungsstarke Seitenleiste.
• Anleitungen können leicht mit Suchmaschinen gefunden werden.

All dies sorgt für ein sehr angenehmes Kundenerlebnis.

Deshalb sollten Sie die Erstellung eines Online-Benutzerhandbuchs in Betracht ziehen, das benutzerfreundlich ist und leicht über Suchmaschinen zugänglich ist.

Um dies zu erreichen, behandeln wir hier alles:

Legen wir los!

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 dies Ihre Herangehensweise an den Inhalt beeinflusst.

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

• Bedienungsanleitung: Eine klassische Bedienungsanleitung lehrt Benutzer, wie man ein Produkt verwendet. Wir haben in unserem anderen Leitfaden viel über die Bedienungsanleitung gesprochen, wenn Sie mehr erfahren möchten.
• Schulungshandbuch: Ein Schulungshandbuch lehrt den Benutzer, wie eine bestimmte Aufgabe ausgeführt oder ein bestimmter Job abgeschlossen wird.
• Betriebshandbuch: Ein Betriebshandbuch ist typischerweise ein internes Handbuch, das die Abläufe Ihres Unternehmens dokumentiert.
• Servicehandbuch: Ein Servicehandbuch konzentriert sich darauf, dem Benutzer zu vermitteln, wie ein Produkt im Laufe seines Lebenszyklus ordnungsgemäß gewartet wird.
• Standardarbeitsanweisungen (SOPs): SOPs sind interne Handbücher, die den Mitgliedern einer Organisation beibringen, wie sie bestimmte Prozesse richtig „auf die richtige Weise“ ausführen.

Für die folgenden Anweisungen konzentrieren wir uns hauptsächlich auf die Erstellung einer öffentlich zugänglichen Bedienungsanleitung. Die folgenden Grundprinzipien gelten jedoch für jede Art von Bedienungsanleitung.

So erstellen Sie eine Bedienungsanleitung

Jetzt, da Sie einige Hintergrundinformationen haben, kommen wir dazu, wie Sie eine Bedienungsanleitung erstellen, beginnend bei Null bis hin zu einer fertigen Bedienungsanleitung.

Hinweis: Ich empfehle, Schritte nicht zu überspringen, wenn Sie nicht überfordert werden möchten.

Schritt 1. Ziele festlegen und Schlüsselprobleme identifizieren

Ziele zu setzen und Probleme zu verstehen sollte der erste Schritt in jedem Projekt sein.

Mit dem Benutzerhandbuch können Sie Ziele erstellen wie:

1. Benutzer durch den Einrichtungsprozess führen
2. Kundensupport-Tickets reduzieren
3. Sichere Nutzung gewährleisten
4. Benutzererfahrung verbessern
5. Gesetzliche und branchenspezifische Standards einhalten

Und mit festgelegten Zielen können Sie nach den Schlüsselproblemen suchen:

1. Mangelnde Erfahrung
2. Budgetproblem
3. Nutzung von Inhouse-Entwicklung vs. Online-Lösungen
4. Ziele, die traditionelle Benutzerhandbücher nicht lösen werden
5. Nützlichkeit

Dies gibt Ihnen eine gute Vorstellung davon, wo Sie stehen, und ermöglicht es Ihnen, einen klaren Umfang für dieses Projekt festzulegen.

Schritt 2. Erstellung von Benutzerhandbuch-Inhalten

Hier sind einige Best Practices, die Sie bei der Erstellung von Benutzerhandbuch-Inhalten berücksichtigen sollten:

2.1. Ihre Benutzer verstehen

Bevor Sie mit der Erstellung von Inhalten beginnen, sollten Sie verstehen, für wen die Inhalte bestimmt sind. Dies können Sie durch die Erstellung von Benutzer-Personas erreichen.

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

Warum ist das wichtig?

Nun, hier ist ein Beispiel:

Es gibt einen großen Unterschied darin, technische Inhalte für Maschinenbauingenieure zu erstellen und technische Inhalte für nicht-technische Benutzer zu erstellen.

Bei den meisten Produkten werden die Unterschiede nicht so stark sein. Aber es ist dennoch wichtig, Ihre Kunden-Personas zu verstehen, damit Sie sicherstellen können, dass Ihr Benutzerhandbuch für die Personen, die es tatsächlich verwenden werden, Sinn ergibt.

2.2. Themen zum Schreiben finden

Sie möchten definitiv nicht ziellos Zeit mit dem Schreiben von Inhalten verbringen, die möglicherweise nicht das sind, wonach Benutzer suchen.

Um Ihnen den Einstieg zu erleichtern.

Das Kundensupport-Team kann häufig gestellte Fragen sammeln und diese mit einem Benutzerhandbuch lösen, bevor Benutzer danach suchen.

Sie können auch Analysen durchführen, um zu verstehen, wonach Benutzer suchen, aber das ist, nachdem Sie mit dem Festlegen des Benutzerhandbuchs fertig sind.

2.3. Logische Struktur und Hierarchie erstellen

Zurück zu Sonys Beispiel: Sie können sehen, wie gut deren Inhalte strukturiert sind.

Wenn ein Benutzer Probleme mit der Konnektivität hat, erleichtert der gut organisierte Inhalt das Auffinden relevanter Dokumente.

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

1. Es wird Ihnen helfen, einzugrenzen, was in die Bedienungsanleitung aufgenommen werden soll.
2. Es macht es auch SEO-freundlich mit Breadcrumbs, Inhaltsgruppierung und einer besseren Benutzererfahrung.

Hier sind einige Tipps, die Ihnen helfen, eine richtige Struktur zu erstellen:

1. Überlegen Sie, wie Sie Kunden helfen können, so schnell wie möglich von Ihrem Produkt zu profitieren.
2. Nehmen Sie Ihr persönliches Wissen heraus. Sie wissen offensichtlich viel über Ihr Produkt, aber Ihre Kunden werden nicht über dieses Hintergrundwissen verfügen.
3. Stellen Sie sicher, dass Sie alle häufigen Probleme oder verwirrenden Details abdecken, auf die Ihre Kunden stoßen könnten, wenn sie versuchen, Ihr Produkt zu verwenden. Diese sollten logisch zu den Zeiten behandelt werden, zu denen Kunden am wahrscheinlichsten auf Probleme stoßen.

2.4. Inhalt der Bedienungsanleitung schreiben

Das Schreiben von Inhalten für Bedienungsanleitungen unterscheidet sich völlig von regulären Inhalten. Es ist so geradlinig wie möglich, ohne Fachjargon und sehr visuell.

Nehmen Sie Sonys Benutzerhandbuchinhalt¹ als Beispiel.

Wie Sie sehen können, ist sie sehr informativ und erklärt einfach die Grundlagen der Handhabung eines Mobilgeräts oder die Einstellungen des Startbildschirms, und diese visuellen Elemente verleihen eine nette Note, die die Gesamtklarheit des Tutorials verbessert.

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

1. Verwenden Sie einfache Sprache und vermeiden Sie Fachjargon. Oder, wenn Fachjargon absolut unvermeidlich ist, stellen Sie sicher, dass Sie ihn erklären.
2. Halten Sie es kurz und bündig. Ihr Ziel bei einer Bedienungsanleitung sollte es sein, das Thema vollständig abzudecken, aber mit so wenigen Worten wie möglich. Lassen Sie keine wichtigen Informationen weg, aber kürzen Sie rücksichtslos alle unnötigen Inhalte.
3. Visuelle Elemente (Bilder und Videos) zur Unterstützung der Benutzer einfügen. Ein gut kommentiertes Bild oder GIF kann hilfreicher sein als reine Textanweisungen, egal wie detailliert und umfassend der Text ist.
4. Verwenden Sie nach Möglichkeit Aufzählungszeichen und Listen für Anweisungen. Eine nummerierte oder mit Aufzählungszeichen versehene Liste kann es den Benutzern erleichtern, den Leitfaden zu verfolgen. Oder, wenn Sie mehr Details als eine Liste zulässt benötigen, können Sie jeden Schritt zu einer eigenen Unterüberschrift machen.
5. Verwenden Sie die aktive Stimme. Die Passivform kann besonders verwirrend für die Anweisungen in einem Benutzerhandbuch 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 erleichtert es dem Leser, sich in die Anweisungen hineinzuversetzen.
6. Halten Sie die Formatierung konsistent, was unten erläutert wird.

2.5. Vorlagen zur Gewährleistung einer konsistenten Formatierung verwenden

Das Erstellen einer formatierten Vorlage beschleunigt nicht nur Ihre Arbeit, sondern stellt auch sicher, dass jeder Artikel in Ihrem Handbuch mit den anderen konsistent ist.

Hier ist eine Vorlage, die für Benutzerhandbuchartikel oder kundenorientierte Anleitungen bevorzugt wird.

Ihre Vorlage kann eine grundlegende Gliederung enthalten, der Sie beim Erstellen von Benutzerhandbuchinhalten folgen können:

Zum Beispiel sollte jeder Benutzerhandbuchartikel die folgenden Eigenschaften aufweisen:

1. Suchleiste
2. Brotkrümel
3. Titel
4. Einleitung
5. Hauptinhalt
6. Tipps, Hinweise oder andere wichtige Informationen
7. Bilder
8. Feedback-System
9. Verwandte Artikel
10. Links zu Community, Forum oder Support

Schließlich ist es immer eine gute Idee, Ihre Anleitungen zu testen, als wären Sie ein Erstbenutzer.

Das heißt, nachdem Sie ein Tutorial geschrieben haben, gehen Sie zurück und befolgen Sie diese Anweisungen Schritt für Schritt, um sicherzustellen, dass Sie nichts übersehen haben.

Jetzt, da Sie ein wirklich gutes Verständnis von den Zielen und Inhalten des Benutzerhandbuchs haben, beginnen wir mit der Erstellung eines Online-Portals, auf dem Sie Ihre Benutzerhandbuchartikel hosten können.

Schritt 3. Erstellung der Benutzerhandbuch-Website

Da wir ein Online-Portal für Benutzerhandbücher für einfachen Zugriff und beste Benutzererfahrung vorbereiten, müssen wir zuerst eine WordPress-Website erstellen.

3.1. WordPress-Website erstellen

WordPress ist die Top-Wahl, wenn es um den Aufbau 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.

1. Kaufen Sie einen beliebigen Kinsta-Hostingplan.
2. Folgen Sie dem Prozess der Kontoerstellung und des Checkouts.
3. Bestätigen Sie die E-Mail.

Sobald Sie fertig sind, wird Ihnen ein Dashboard angezeigt. Von diesem Dashboard aus können Sie ganz einfach WordPress-Sites erstellen.

Ähnlich wie Benutzerhandbücher hat Kinsta sehr gute Benutzerdokumentationen. Schauen Sie sich diese an, wenn Sie Probleme haben, oder kontaktieren Sie einfach deren Support-Team.

Wie Kinsta kann WordPress einfach auf jeder Hosting-Plattform installiert werden. Die Wahl liegt bei Ihnen!

3.2. Benutzerhandbuch-Portal erstellen

Jetzt, da Sie eine WordPress-Website bereit haben, lassen Sie uns damit Ihr Online-Benutzerhandbuch-Portal erstellen!

Das Hosten eines Benutzerhandbuchs online ähnelt irgendwie der Erstellung von Benutzerdokumentationen. Dafür werden wir notwendige Software benötigen, die folgende Anforderungen erfüllt:

1. Leistungsstarke Suchleiste
2. Flexibel und vollständig anpassbar
3. Kategorisierungs- und Tagging-Optionen
4. Dedizierte Bausteine für visuelle Elemente
5. Freiheit bei Layouts und Design
6. Benutzerrollen und Zugriffskontrolle
7. Feedback-System
8. Analysen und Berichte
9. SEO-Kontrollen

Heroic Knowledge Base erfüllt alle oben genannten Anforderungen und ermöglicht es Ihnen, sich auf die Inhaltserstellung zu konzentrieren.

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

Sobald Sie die benötigte Datei bereit haben:

1. Greifen Sie auf Ihr Website-Dashboard zu, indem Sie “/wp-admin” an das Ende Ihrer Website-URL anhängen.
2. Klicken Sie auf Plugins → Neues Plugin hinzufügen.
3. Klicken Sie auf die Schaltfläche Plugin hochladen.
4. Wählen Sie die Heroic KB Plugin-Datei aus.
5. Klicken Sie auf die Schaltfläche Jetzt installieren.
6. Klicken Sie nach der Installation auf Plugin aktivieren.

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

1. Aktivieren Sie das Plugin mit einem Lizenzschlüssel, den Sie im Downloadbereich erhalten.
2. Demo-Inhalt installieren.

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

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

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

Schritt 4. Gestaltung Ihres Portals

Mit der Premium-Benutzerhandbuch-Software wie Heroic KB haben Sie die Freiheit, Ihr Portal nach Ihren Wünschen zu gestalten.

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

Lassen Sie uns einige Szenarien durchgehen.

4.1. Farben

Sie können die Farben des Benutzerhandbuch-Portals an Ihren Marken-Styleguide anpassen. Gehen Sie dazu wie folgt vor:

1. Besuchen Sie das Website-Dashboard
2. Klicken Sie auf Heroic KB → Einstellungen
3. Klicken Sie auf den Tab Darstellung

4.2. Seitenleisten

Möchten Sie Ihre Standard-Seitenleiste anpassen?

1. Besuchen Sie das Website-Dashboard
2. Klicken Sie auf Heroic KB → Einstellungen
3. Klicken Sie auf den Tab Allgemein
4. Seitenleisten-Einstellungen verwalten
5. Änderungen speichern, um Einstellungen zu übernehmen

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

Schritt 5. Artikel zum Benutzerhandbuch hinzufügen

Das Hinzufügen von Artikeln zum Handbuch ähnelt dem Ausfüllen eines Online-Formulars, mit dem Unterschied, dass Sie die volle Freiheit über das Design haben.

Sie können viel erreichen, wenn Sie mit Seitenerstellern vertraut sind, und das Erstellen komplexer Layouts wird so einfach sein, sobald Sie den Dreh raus haben.

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

Nun zurück zur Hauptanleitung: Alle Artikel des Benutzerhandbuchs sind über das Website-Dashboard → Heroic KB zugänglich.

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

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

So wird Ihr Artikel-Builder aussehen.

Sie erhalten die zusätzliche Funktionalität des WordPress Editors und Heroic KB, um die ultimativen Benutzerhandbücher zu erstellen.

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

Spielen Sie einfach ein paar Minuten damit herum, 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. Und wenn Ihre Website mit Benutzerhandbüchern nicht suchmaschinenfreundlich ist, wirkt sich das erheblich auf Ihre Benutzererfahrung aus.

Stellen Sie sich nur die Schritte vor, die erforderlich sind, um eine einfache Anleitung für Ihre Produkte zu finden:

1. Benutzer suchen online nach einer Lösung und finden keine Antworten.
2. Besuchen Ihre Website und beginnen eine Wissensdatenbanksuche.
3. Durchsuchen einer riesigen Liste von Artikeln, um eine einfache Antwort oder Anleitung zu finden.

Klingt so schmerzhaft – und das ist es auch.

Was vermieden werden kann, indem Artikel SEO-freundlich gestaltet werden, und Sie müssen hier nicht viel investieren, da die meisten der hier angesprochenen Anfragen auf Ihren Markenschlüsselwörtern basieren.

Allein das Hinzufügen eines SEO-Plugins wie Yoast sollte ausreichen.

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

1. Halten Sie den Artikeltitel einfach und versuchen Sie, das Hauptkeyword einzufügen.
2. Verwenden Sie das Hauptkeyword für den Artikel-Slug.
3. Gruppieren Sie Inhalte mithilfe von Kategorien und Tags.
4. Verlinken Sie verwandte und notwendige Artikel/Anleitungen miteinander.

Wir haben detailliert behandelt, wie man Yoast SEO mit Heroic KB verwendet. Schauen Sie es sich an, um mehr zu erfahren.

Schritt 6. Aktualisieren und überarbeiten Sie den Inhalt Ihres Benutzerhandbuchs nach Bedarf

Die Erstellung eines Benutzerhandbuchs ist keine einmalige Anstrengung. Zukünftig müssen Sie Zeit in die Überarbeitung und Aktualisierung Ihrer Inhalte investieren.

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

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

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.

Die zweite Situation ist jedoch auch wichtig zu berücksichtigen. So sehr Sie sich auch bemühen, Sie werden wahrscheinlich nicht jeden Leitfaden oder jedes Tutorial vom ersten Tag an perfekt hinbekommen.

Um Ihren Benutzern besser helfen zu können, sollten Sie leistungsschwache 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 der Artikelhilfreichkeit, sodass Sie leicht erkennen können, welche Artikel verbessert werden müssen.

Benutzer können auch Textfeedback zu dem Artikel hinterlassen, was Sie auf bestimmte Teile des Artikels hinweisen kann, die nicht so hilfreich sind, wie sie sein könnten:

Sie könnten auch Artikel vermissen zu Themen, mit denen Benutzer Probleme haben.

Um Ihnen zu helfen, diese fehlenden Themen zu finden, enthält Heroic Knowledge Base auch integrierte Suchanalysen, sodass Sie verfolgen können, welche Suchen keine Themen-Ergebnisse haben (sowie allgemeine Suchen im Allgemeinen):

Erstellen Sie noch heute Ihr Benutzerhandbuch

Wir haben versucht, alles basierend auf unserer bisherigen Erfahrung abzudecken. Damit sollten Sie nun über das Wissen verfügen, das Sie benötigen, um eine effektive Website für Benutzerhandbücher zu erstellen.

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

Heroic Knowledge Base erleichtert die Veröffentlichung von Artikeln und deren Organisation nach Bedarf. Außerdem können Kunden von hilfreichen Funktionen wie Live-Suchvorschlägen, Inhaltsverzeichnissen und mehr profitieren.

Legen Sie noch heute los und Ihre Bedienungsanleitung ist im Handumdrehen online.

Wenn Sie daran interessiert sind, Dokumentationen zur Verbesserung des internen Wissens in Ihrem Unternehmen zu erstellen, sind Sie vielleicht auch an unserem Tutorial zur Veröffentlichung eines Schulungshandbuchs für Ihre Mitarbeiter interessiert.

In diesem Tutorial verwendete Ressourcen

1. Beispiel für Sonys Benutzerhandbuchinhalt ↩︎