Wie man ein Software-Benutzerhandbuch schreibt: Der ultimative Leitfaden (einschließlich einer Vorlage)

Sie wissen nicht, wie Sie ein Software-Benutzerhandbuch für Ihr Produkt schreiben sollen?

Wenn Sie Ihren Benutzern helfen wollen, den größtmöglichen Nutzen aus Ihrem Produkt zu ziehen, ist die Erstellung eines hochwertigen Software-Benutzerhandbuchs ein guter Anfang.

Indem Sie den Nutzern die Inhalte zur Verfügung stellen, die sie benötigen, um Ihr Produkt selbst zu erlernen und Fehler zu beheben, können Sie ihnen helfen, erfolgreich zu sein, ohne dass sie sich an Ihre menschlichen Supportkanäle wenden müssen. 

Das macht es nicht nur für Ihre Nutzer einfacher, sondern kann auch die Anzahl der Supportanfragen in Ihrem Unternehmen verringern, was Ihnen Zeit und Geld spart.

Wie können Sie also das perfekte Software-Benutzerhandbuch für Ihre Benutzer erstellen? Das ist der Zweck dieses Leitfadens.

Um Ihnen den Einstieg zu erleichtern, finden Sie in diesem Beitrag alles, was Sie wissen möchten:

• Was ein Software-Benutzerhandbuch ist
• Wie man ein Software-Benutzerhandbuch in vier Schritten schreibt, einschließlich einer Vorlage für ein Software-Benutzerhandbuch
• Bewährte Verfahren zur Erstellung hochwertiger Inhalte für Ihr Benutzerhandbuch

Auf geht's!

Was ist ein Software-Benutzerhandbuch?

Ein Software-Benutzerhandbuch ist eine Dokumentation, die Informationen über die Verwendung und Verwaltung Ihrer Softwareanwendung oder Ihres Produkts enthält.

Ihr Software-Benutzerhandbuch kann Anleitungen für die ersten Schritte, Anweisungen, Glossare, Tipps zur Fehlerbehebung und andere ähnliche Inhalte enthalten. 

Sie enthält im Grunde alle Informationen, die Ihre Benutzer benötigen, um Ihre Software optimal nutzen zu können.

In der Regel beginnt es mit den Installationsschritten, gibt dann einen allgemeinen Überblick über die Benutzeroberfläche und die Verwendung verschiedener Funktionen und geht dann bei Bedarf auf die Fehlerbehebung und häufig gestellte Fragen ein. Weiter unten finden Sie eine detailliertere Vorlage für ein Software-Benutzerhandbuch.

Ein Beispiel für ein Software-Benutzerhandbuch finden Sie im Forklift 3-Benutzerhandbuch, das direkt in die Erklärung der Benutzeroberfläche einsteigt.

Ein weiteres Beispiel ist der Inhalt von Slacks Getting Started, in dem auch gleich die Slack-Oberfläche erklärt wird.

Warum ist es wichtig, ein Software-Benutzerhandbuch zu erstellen?

Es gibt zwei wichtige Gründe, ein Software-Benutzerhandbuch für Ihr Produkt zu erstellen:

1. Bessere Benutzererfahrung : Wenn Sie es den Benutzern leichter machen, den Umgang mit Ihrer Software zu erlernen und den Nutzen Ihrer Software zu maximieren, werden Ihre Benutzer eine bessere Erfahrung machen.
2. Geringerer Aufwand für den Support - indem Sie den Benutzern die Möglichkeit geben, ihre Probleme selbst zu lösen, können Sie den Aufwand für Ihre Support-Kanäle verringern. Dies gilt insbesondere, wenn Sie Ihr Benutzerhandbuch mit anderen Arten von Support-Inhalten wie einer Wissensdatenbank und/oder häufig gestellten Fragen (FAQs) kombinieren.

Wie man ein Software-Benutzerhandbuch in vier Schritten schreibt

Lassen Sie uns nun die allgemeine Schritt-für-Schritt-Anleitung für das Schreiben eines Software-Benutzerhandbuchs durchgehen. Im nächsten Abschnitt gehen wir auch auf einige bewährte Verfahren für den eigentlichen Inhalt Ihres Benutzerhandbuchs ein.

Wenn Sie an einer allgemeineren Betrachtung dieser Themen interessiert sind, finden Sie hier auch einen Leitfaden für die Erstellung von Benutzerhandbüchern aller Art.

1. Planen Sie die Struktur Ihres Software-Benutzerhandbuchs

Bevor Sie mit der Erstellung von Inhalten für Ihr Handbuch beginnen, sollten Sie zunächst die Struktur Ihres Handbuchs genau festlegen.

Um Ihr Handbuch so umfassend wie möglich zu gestalten, sollten Sie mehrere wichtige Interessengruppen zusammenbringen, die Sie dabei unterstützen.

Dazu könnten z. B. Kundenbetreuer, Vertriebsmitarbeiter usw. gehören - also alle, die wissen, wie sie den Benutzern helfen können, den größtmöglichen Nutzen aus dem Produkt zu ziehen. In manchen Fällen müssen Sie vielleicht auch mehr technisches Personal hinzuziehen, das bei fortgeschrittenen Details hilft.

Wenn Sie ein Soloprojekt leiten, tragen Sie natürlich alle diese Hüte selbst. Das ist das Schöne daran, ein Solo-Gründer zu sein.

Sobald Sie über die entsprechenden Wissensträger verfügen, können Sie die Gliederung Ihres Benutzerhandbuchs erstellen.

Für eine grobe Vorlage für ein Software-Benutzerhandbuch können Sie etwa so vorgehen...

1. Inhaltsverzeichnis - listen Sie die verschiedenen Abschnitte Ihres Benutzerhandbuchs auf, damit die Benutzer wissen, was sie erwartet.
2. Einleitung - Erklären Sie den Zweck Ihres Software-Benutzerhandbuchs.
3. Systemanforderungen - Geben Sie alle spezifischen Anforderungen an, die die Benutzer für die Nutzung Ihrer Software benötigen, z. B. Hardware-Spezifikationen, Betriebssystem usw.
4. Installationsanweisungen - beschreibt, wie der Benutzer die Software installieren kann.
5. Überblick über die Benutzeroberfläche - Geben Sie einen Überblick über die Benutzeroberfläche auf hoher Ebene.
6. Wie man bestimmte Funktionen verwendet - erstellen Sie für jede Hauptfunktion einen Abschnitt, der den Benutzern zeigt, wie sie funktioniert.
7. Häufig gestellte Fragen - behandeln Sie einige häufig gestellte Fragen, die ein Benutzer haben könnte (siehe unsere Liste der 5 besten Beispiele für FAQ-Seiten).
8. Fehlerbehebung - Geben Sie Tipps zur Fehlerbehebung.
9. Glossar - wenn Ihre Software eine spezielle Terminologie verwendet, sollten Sie am Ende des Benutzerhandbuchs ein Glossar hinzufügen.
10. Kontaktdaten des Supports - Erläutern Sie, wie die Nutzer den Support kontaktieren können, wenn sie zusätzliche Hilfe benötigen. Dies sollte am Ende stehen, damit die Nutzer versuchen, sich selbst zu helfen, bevor sie sich an den Support wenden.

Sie müssen sich nicht genau an diese Vorlage für ein Software-Benutzerhandbuch halten - sie dient lediglich als Ausgangspunkt, um Ihnen eine Vorstellung davon zu vermitteln, was Sie möglicherweise aufnehmen möchten.

2. Erstellen Sie den Inhalt Ihres Software-Benutzerhandbuchs

Sobald Sie Ihre Gliederung haben, können Sie mit der Erstellung des Inhalts Ihres Software-Benutzerhandbuchs beginnen.

Der Großteil Ihres Inhalts wird aus Text bestehen, aber vergessen Sie nicht, auch relevante Bilder, GIFs und Videos einzubinden.

Obwohl dieser Schritt wahrscheinlich die meiste Zeit in Anspruch nehmen wird, fassen wir uns hier kurz, denn im nächsten Abschnitt werden wir einige bewährte Verfahren für Software-Benutzerhandbücher vorstellen, die Ihrem Team bei der Erstellung effektiver Benutzerhandbücher helfen.

Wer Ihre Inhalte schreibt, hängt von der Größe Ihres Unternehmens und der Komplexität Ihres Produkts ab. Wenn Sie keinen eigenen technischen Redakteur haben, müssen Sie die Inhalte je nach Komplexität Ihrer Software möglicherweise Ihrem Kundenerfolgsteam oder Ihrem technischen Team zuweisen.

Wenn Sie allein gründen, sind Sie wahrscheinlich die beste Person, um Ihr Handbuch zu schreiben, da Sie Ihre Inhalte am besten kennen. Sie können jederzeit einen Redakteur einstellen, der Ihnen hilft, Ihren ersten Entwurf zu verbessern.

3. Veröffentlichen Sie Ihr Software-Benutzerhandbuch

Sobald Sie den Inhalt für Ihr Software-Benutzerhandbuch erstellt haben, müssen Sie Ihr Handbuch so veröffentlichen, dass die Benutzer es leicht konsumieren können.

Die meisten Wissensdatenbanken oder Dokumentationsprogramme sollten für ein Software-Benutzerhandbuch gut geeignet sein, aber Sie können auch Ihre eigene Lösung programmieren, wenn Sie sich zu sehr eingeschränkt fühlen. Einige Unternehmen veröffentlichen neben der Webversion auch eine PDF-Version des Benutzerhandbuchs.

In unseren Listen der besten Wissensdatenbank-Software und der besten Dokumentations-Tools finden Sie einige hervorragende Optionen für die Veröffentlichung der Web-Version Ihres Software-Benutzerhandbuchs.

Wenn Sie auf der Suche nach einer Software für Benutzerhandbücher sind, die Ihnen eine solide Funktionsliste, volle Kontrolle über Ihre Inhalte und die Flexibilität zur Anpassung an Ihre Bedürfnisse bietet, können Sie unser Heroic Knowledge Base WordPress Plugin verwenden.

Heroic Knowledge Base ist eine Open-Source-Software, die das ebenfalls Open-Source-basierte Content-Management-System (CMS) WordPress um alle Funktionen erweitert, die Sie für die Veröffentlichung Ihres Software-Benutzerhandbuchs benötigen.

Sie haben die volle Kontrolle über Ihre Plattform und die Flexibilität, jedes Element nach Bedarf anzupassen. Gleichzeitig enthält Heroic Knowledge Base aber auch integrierte Funktionen für alle wichtigen Funktionen, die Ihr Software-Benutzerhandbuch benötigt:

• Artikelorganisation - Sie können die Artikel in Ihrem Softwarehandbuch nach Kategorien ordnen. Sie könnten zum Beispiel verschiedene Kategorien für "Installation", "Benutzeroberfläche", "Verwendung von Funktionen", "Fehlerbehebung" usw. einrichten.
• Funktionen zum Auffinden von Inhalten - damit Benutzer relevante Inhalte so schnell wie möglich finden können, enthält Heroic Knowledge Base hilfreiche Funktionen zum Auffinden von Inhalten wie Suchvorschläge in Echtzeit, automatische Inhaltsverzeichnisse und mehr.
• Nutzer-Feedback-System - Nutzer können Feedback über die Nützlichkeit der einzelnen Artikel geben, so dass Sie wissen, was Sie gut machen (und wo Sie sich verbessern müssen).
• Detaillierte Analysen - Sie können nachverfolgen, welche Artikel am häufigsten aufgerufen werden, welche Artikel zu den meisten Supportanfragen führen, nach welchen Begriffen die Nutzer suchen, welche Suchanfragen keine Ergebnisse liefern und vieles mehr.

4. Aktualisieren Sie Ihr Software-Benutzerhandbuch aufgrund von Rückmeldungen und Änderungen

Die Erstellung eines hochwertigen Software-Benutzerhandbuchs ist keine einmalige Angelegenheit. Sobald Sie Ihr Handbuch veröffentlicht haben, ist es wichtig, dass Sie die wichtigsten Beteiligten weiterhin damit beauftragen, Ihr Handbuch bei Bedarf zu aktualisieren und zu überarbeiten.

In einigen Fällen können diese Aktualisierungen durch eine Änderung Ihrer Software erforderlich werden. Wenn Sie z. B. eine neue Funktion hinzufügen oder die Schnittstelle Ihrer Software ändern, müssen Sie Ihr Benutzerhandbuch aktualisieren, um diese Änderungen zu berücksichtigen.

In anderen Fällen können sich diese Aktualisierungen aus dem Feedback der Nutzer ergeben. Wenn Sie beispielsweise feststellen, dass die Nutzer durch einen bestimmten Artikel verwirrt sind, können Sie diesen Artikel aktualisieren, um ihn hilfreicher zu machen.

Oder wenn Sie feststellen, dass Benutzer nach einem Thema suchen, das in Ihrem Software-Benutzerhandbuch nicht vorhanden ist, müssen Sie möglicherweise einen neuen Artikel zu diesem Thema erstellen. 

Wenn Sie Ihr Benutzerhandbuch mit einem Tool wie Heroic Knowledge Base veröffentlichen, können Sie diese Art von Analysen leicht verfolgen, so dass Sie den Inhalt Ihres Benutzerhandbuchs überwachen und verbessern können.

Bewährte Praktiken für das Schreiben Ihres Software-Benutzerhandbuchs

Nachdem Sie nun den grundlegenden Prozess des Verfassens eines Software-Benutzerhandbuchs verstanden haben, wollen wir nun einige Best Practices für die Erstellung effektiver Benutzerhandbuchinhalte besprechen.

Verstehen Sie, wer Ihr Publikum ist

Wenn Sie hilfreiche Inhalte für Benutzerhandbücher erstellen wollen, müssen Sie wissen, für wen Sie schreiben:

• Woher Ihre Nutzer kommen.
• Was sie mit Ihrer Software zu erreichen versuchen.
• mit welchen Problemen sie zu kämpfen haben.
• Ihr allgemeiner Wissensstand über Ihre Branche und/oder alle relevanten technischen Bereiche.
• für welches Unternehmen sie arbeiten (oder ob sie Einzelanwender sind).
• Etc.

Nehmen wir zum Beispiel an, Ihre Software arbeitet mit Salesforce. Wenn Ihre Zielnutzer erfahrene Salesforce-Administratoren sind, würden Ihre Inhalte ganz anders aussehen, als wenn Ihre Zielnutzer die Vertriebsmitarbeiter selbst sind.

Wahrscheinlich haben Sie aufgrund Ihrer bisherigen Arbeit bereits ein gutes Verständnis für Ihre Zielnutzer. Wenn Sie sich jedoch nicht sicher sind, können Sie Customer Personas, Umfragen und Interviews nutzen, um ein tieferes Verständnis zu erlangen.

Verwenden Sie eine logische Struktur und Organisation

Wir haben dies bereits im ersten Schritt des vorigen Abschnitts angesprochen, aber es ist wichtig, Ihr Benutzerhandbuch optimal zu organisieren, damit die Benutzer leicht einen Nutzen aus Ihren Inhalten ziehen können.

Es gibt verschiedene Möglichkeiten, Ihr Benutzerhandbuch zu gliedern, und Sie können in verschiedenen Abschnitten mehrere Ansätze verwenden:

• Lineare Erfahrung - Sie können Ihr Handbuch so gliedern, wie die Benutzer die Dinge erleben werden. Sie könnten zum Beispiel mit "Installation" als erstem Abschnitt beginnen und dann im nächsten Abschnitt zur ersten Aktion nach der Installation übergehen.
• Funktion - Sie können Ihren Handbuchinhalt anhand der verschiedenen Funktionen Ihrer Software organisieren.
• Fehlerbehebung - Sie können allgemeine Schritte zur Fehlerbehebung an einer Stelle sammeln.

Auch hier ist es völlig in Ordnung, in Ihrem Handbuch mehrere Ansätze zu verwenden. Sie könnten zum Beispiel mit einer linearen Gliederung des Installationsprozesses beginnen.

Sobald Sie jedoch die Installation abgeschlossen haben und die Benutzer Ihre Software auf unterschiedliche Weise anwenden können, können Sie zu einem funktionsbasierten Organisationsansatz wechseln.

Halten Sie Ihren Text einfach und konsistent

Um Ihr Software-Benutzerhandbuch so zugänglich wie möglich zu machen, ist es wichtig, es so einfach wie möglich zu gestalten.

Hier sind einige Dinge, die Sie beachten sollten, um dies zu erreichen:

• Verwenden Sie keinen Fachjargon und keine verwirrenden Wörter - nicht alle Ihre Nutzer werden über die gleichen Kenntnisse in Bezug auf Ihre Branche und/oder die Sprache Ihres Produkts verfügen. Sie können Ihre Inhalte mit Tools wie dem Flesch Reading Ease Test testen, um Probleme zu finden.
• Vermeiden Sie das Passiv - die Verwendung des Passivs kann in einem Benutzerhandbuch besonders verwirrend sein. Anstelle eines Passivs wie "Sie können eine Kopie Ihres Entwurfs speichern, indem Sie auf die Schaltfläche "Entwurf speichern" drücken", sollten Sie besser einen Aktivsatz verwenden wie "Drücken Sie auf die Schaltfläche " Entwurf speichern", um eine Kopie Ihres Entwurfs zu speichern".
• Verwenden Sie kurze Sätze - wenn Sie Ihren Inhalt in kurze Sätze unterteilen, fällt es den Benutzern leichter, den Inhalt Ihres Benutzerhandbuchs zu erfassen und zu lesen. Wann immer möglich, vermeiden Sie lange Absätze (auch bekannt als "Textwände").
• Bleiben Sie konsistent - eine einheitliche Formulierung und Formatierung erleichtert es den Benutzern, Ihr Handbuch zu verstehen. Wenn Sie beispielsweise immer eine geordnete Liste verwenden, um die einzelnen Schritte einer bestimmten Aufgabe aufzulisten, sollten Sie versuchen, diese Formatierung in Ihrem gesamten Handbuch beizubehalten.
• Vermeiden Sie Probleme mit der Grammatik - stellen Sie sicher, dass Sie keine grammatikalischen Fehler haben, die es den Benutzern erschweren könnten, Ihr Handbuch zu verstehen. Sie können dies mit Tools wie Grammarly und Hemingway überprüfen.

Bilder und Videos einbeziehen, wenn hilfreich

Während Textinhalte die Grundlage Ihres Benutzerhandbuchs bilden, ist es wichtig, auch Bilder und Videos einzubeziehen, wo dies sinnvoll ist.

Das Sprichwort "Ein Bild sagt mehr als tausend Worte" mag zwar ein Klischee sein, aber es kann durchaus zutreffen, wenn Sie versuchen zu erklären, wie Benutzer einen Nutzen aus Ihrem Softwareprodukt ziehen können.

Um die Konzepte Ihres Textes zu erläutern, können Sie kommentierte Bilder oder GIFs hinzufügen, die veranschaulichen, worüber Sie sprechen.

Slack zum Beispiel ist sehr gut darin, Bilder zur Einführung in die Benutzeroberfläche mit Anmerkungen zu versehen.

Auch Videoinhalte können für manche Benutzer nützlich sein. Sie sollten jedoch vorsichtig sein, wenn Sie sich ausschließlich auf Videoinhalte verlassen, da dies nicht immer ein optimaler Weg für Benutzer ist, um Software-Handbuchinhalte zu konsumieren. 

Wenn ein Nutzer zum Beispiel nur versucht, ein bestimmtes Detail zu finden, ist es für ihn in der Regel viel einfacher, dieses Detail in Textinhalten zu finden als in einem Video.

Erstellen Sie Ihr Software-Benutzerhandbuch noch heute

Damit ist unser Leitfaden zum Verfassen eines großartigen Software-Benutzerhandbuchs abgeschlossen, das Ihren Benutzern zum Erfolg verhilft.

Wenn Sie Ihr Software-Benutzerhandbuch auf die einfachste Weise veröffentlichen möchten, können Sie das Heroic Knowledge Base Plugin für WordPress verwenden.

Heroic Knowledge Base ist ein Open-Source-Plugin, mit dem Sie das WordPress-CMS nutzen können, um Ihr eigenes, selbst gehostetes Software-Benutzerhandbuch zu erstellen, das vollständig unter Ihrer Kontrolle ist.

Gleichzeitig müssen Sie keine Abstriche bei der Funktionalität machen, denn Heroic Knowledge Base bietet alle Funktionen, die Sie für die Erstellung eines hervorragenden Software-Benutzerhandbuchs benötigen. Zu diesen Funktionen gehören Live-Suchvorschläge, die Organisation in Kategorien, die Sammlung von Benutzerfeedback, Analysen und vieles mehr.

Wenn Sie bereit sind, loszulegen, kaufen Sie Heroic Knowledge Base noch heute, und Sie werden im Handumdrehen ein gut aussehendes Benutzerhandbuch haben.