Software-Benutzerhandbuch: Der ultimative Leitfaden mit einer Vorlage

Sie sind sich nicht sicher, wie Sie ein Software-Benutzerhandbuch für Ihr Produkt schreiben sollen? Ich zeige Ihnen, wie es mit dieser einfach zu befolgenden Vorlage für Software-Benutzerhandbücher geht.

Wenn Sie Ihren Benutzern helfen möchten, den maximalen Wert aus Ihrem Produkt auf die effizienteste Weise zu ziehen, ist die Erstellung eines qualitativ hochwertigen Software-Benutzerhandbuchs ein großartiger Ausgangspunkt.

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

Das macht es nicht nur Ihren Benutzern leichter, sondern kann auch die Anzahl der Supportanfragen in Ihrem Unternehmen reduzieren, 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.

Legen wir los!

Was ist ein Software-Benutzerhandbuch?

Ein Software-Benutzerhandbuch ist eine Dokumentation, die Informationen darüber liefert, wie Ihre Software-App oder Ihr Produkt verwendet und verwaltet wird.

Ihre Software-Benutzerhandbuch kann Anleitungen für den Einstieg, Anweisungen, Glossare, Tipps zur Fehlerbehebung und andere ähnliche Inhalte enthalten. 

Grundsätzlich enthält es alle Informationen, die Ihre Benutzer benötigen, um einen Mehrwert aus Ihrer Software zu ziehen.

Normalerweise beginnt es mit Installationsschritten, dann folgt eine allgemeine Übersicht über die Benutzeroberfläche und die Verwendung verschiedener Funktionen, und dann wird bei Bedarf auf Fehlerbehebung und FAQs eingegangen. Auch hier werden wir unten eine detailliertere Vorlage für ein Software-Benutzerhandbuch teilen.

Beispiele für Software-Benutzerhandbücher

Software-Benutzerhandbuch Forklift 3, das direkt mit der Erklärung der Benutzeroberfläche beginnt.

Als weiteres Beispiel sehen Sie sich die Einstiegsinhalte von Slack an, die ebenfalls direkt mit der Erklärung der Slack-Benutzeroberfläche beginnen.

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. Verbesserte Benutzererfahrung: Indem Sie es den Benutzern erleichtern, Ihre Software zu erlernen und den Wert, den sie aus Ihrer Software ziehen, zu maximieren, werden Ihre Benutzer bessere Erfahrungen machen.
2. Reduzierte Supportbelastung: Indem Sie den Benutzern die Möglichkeit geben, ihre eigenen Probleme zu lösen, können Sie die Belastung Ihrer menschlichen Supportkanäle reduzieren. Dies gilt insbesondere, wenn Sie Ihr Benutzerhandbuch mit anderen Arten von Supportinhalten wie einer Wissensdatenbank und/oder häufig gestellten Fragen (FAQs) kombinieren.

So schreiben Sie ein Software-Benutzerhandbuch in vier Schritten

Nun kommen wir zur allgemeinen Schritt-für-Schritt-Anleitung, wie man ein Software-Benutzerhandbuch schreibt. Im nächsten Abschnitt werde ich auch einige der Best Practices für das Schreiben von Benutzerhandbüchern behandeln.

Wenn Sie an einem allgemeineren Überblick über diese Themen interessiert sind, haben wir auch eine Anleitung zur Erstellung jeder Art von Benutzerhandbuch.

1. Planen Sie die Struktur Ihres Software-Benutzerhandbuchs

Bevor Sie mit der Erstellung von Inhalten für Ihr Handbuch beginnen, planen Sie zuerst die Struktur Ihres Handbuchs richtig.

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

Zum Beispiel könnten dies Kundenerfolg, Vertrieb und so weiter sein – jeder, der weiß, wie man Benutzern hilft, den maximalen Wert aus dem Produkt zu ziehen. In einigen Fällen müssen Sie möglicherweise auch technisches Personal hinzuziehen, um bei fortgeschritteneren Details zu helfen.

Wenn Sie natürlich ein Soloprojekt leiten, werden Sie all diese Hüte selbst tragen. Das ist die Freude eines Solo-Gründers.

Sobald Sie die relevanten Wissensvermittler haben, können Sie die Gliederung Ihres Benutzerhandbuchs erstellen.

Hier ist die Vorlage für ein Software-Benutzerhandbuch, der Sie folgen können, um Ihr erstes Benutzerhandbuch zu erstellen:

Sie müssen diese Vorlage für Software-Benutzerhandbücher nicht exakt befolgen – sie ist nur ein Ausgangspunkt, um Ihnen eine Vorstellung davon zu geben, 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 Text sein, aber vergessen Sie nicht, auch relevante Bilder, GIFs und Videos einzufügen.

Während dieser Schritt wahrscheinlich am meisten Zeit in Anspruch nehmen wird, halten wir diesen Abschnitt vorerst kurz, da wir im nächsten Abschnitt einige Best Practices für Software-Benutzerhandbücher vorstellen werden, die Ihrem Team helfen, effektive Inhalte für Benutzerhandbücher zu erstellen.

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

Oder, wenn Sie ein Einzelgründer sind, sind Sie wahrscheinlich die beste Person, um Ihre Handbuchinhalte zu schreiben, da Sie das tiefste Verständnis für Ihre Inhalte haben. Sie können jederzeit einen Redakteur engagieren, der Ihnen hilft, Ihren ersten Entwurf zu verbessern.

Hier sind einige Best Practices für das Schreiben Ihres Software-Benutzerhandbuchs:

Jetzt, da Sie den grundlegenden Prozess des Schreibens eines Software-Benutzerhandbuchs verstehen, lassen Sie uns einige Best Practices für die Erstellung effektiver Inhalte für Benutzerhandbücher durchgehen.

1. Verstehen Sie Ihre Zielgruppe

Wenn Sie hilfreiche Inhalte für Benutzerhandbücher erstellen möchten, ist es unerlässlich zu wissen, für wen Sie schreiben:

• Woher Ihre Benutzer kommen.
• Was sie mit Ihrer Software erreichen wollen.
• Welche Probleme sie haben.
• Ihr allgemeines Wissensniveau über Ihre Branche und/oder relevante technische Bereiche.
• Für welches Unternehmen sie arbeiten (oder ob es sich um Einzelbenutzer handelt).

Nehmen wir an, Ihre Software befasst sich mit Salesforce. Wenn Ihre Zielbenutzer erfahrene Salesforce-Administratoren sind, würde Ihr Inhalt ganz anders aussehen, als wenn Ihre Zielbenutzer die Vertriebsmitarbeiter selbst wären.

Sie werden wahrscheinlich bereits ein gutes Verständnis Ihrer Zielbenutzer aus Ihrer bestehenden Arbeit haben. Wenn Sie sich jedoch nicht sicher sind, können Sie Kunden-Personas, Umfragen und Interviews verwenden, um ein tieferes Verständnis zu gewinnen.

2. Verwenden Sie eine logische Struktur und Organisation

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

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

• Lineares Erlebnis: Sie können Ihr Handbuch so organisieren, wie die Benutzer Dinge erleben werden. Zum Beispiel könnten Sie mit der Installation als erster Abschnitt beginnen und dann im nächsten Abschnitt zur ersten Aktion nach der Installation übergehen.
• Funktion: Sie können den Inhalt Ihres Handbuchs basierend auf den verschiedenen Funktionen Ihrer Software organisieren.
• Fehlerbehebung: Sie können häufige Schritte zur Fehlerbehebung an einem Ort sammeln.

Es ist völlig in Ordnung, mehrere Ansätze innerhalb Ihres Handbuchs zu verwenden. Sie könnten damit beginnen, die Dinge für den Installationsprozess linear zu organisieren.

Aber sobald Sie die Installation abgedeckt haben und Benutzer Ihre Software auf verschiedene Weise anwenden können, könnten Sie zu einem funktionsbasierten Organisationsansatz wechseln.

3. Halten Sie Ihre Sprache einfach und konsistent

Um Ihr Benutzerhandbuch für Software so zugänglich wie möglich zu gestalten, ist es wichtig, Ihre Sprache so einfach wie möglich zu halten.

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

1. Vermeiden Sie Fachjargon oder verwirrende Wörter – nicht alle Ihre Benutzer haben das gleiche Wissen über Ihre Branche und/oder die Sprache Ihres Produkts. Daher ist es wichtig, unnötigen Fachjargon und verwirrende Vokabeln zu vermeiden. Sie können Ihre Inhalte mit Tools wie dem Flesch Reading Ease Test testen, um Probleme zu finden.
2. Vermeiden Sie Passivkonstruktionen – die Verwendung von Passivkonstruktionen kann in einer Bedienungsanleitung besonders verwirrend sein. Anstatt beispielsweise eine Passivkonstruktion wie „Eine Kopie Ihres Entwurfs kann durch Drücken der Schaltfläche Entwurf speichern gespeichert werden“ zu verwenden, ist es besser, eine Aktivkonstruktion wie „Drücken Sie die Schaltfläche Entwurf speichern, um eine Kopie Ihres Entwurfs zu speichern“ zu verwenden.
3. Verwenden Sie kurze Sätze – das Aufteilen Ihrer Inhalte in kurze Sätze erleichtert es den Benutzern, Ihre Bedienungsanleitung zu verstehen und zu überfliegen. Vermeiden Sie, wann immer möglich, lange Absätze (auch bekannt als „Textwände“).
4. Bleiben Sie konsistent – die Verwendung konsistenter Formulierungen und Formatierungen erleichtert es den Benutzern, Ihr Handbuch zu verstehen. Wenn Sie beispielsweise immer eine geordnete Liste verwenden, um einzelne Schritte bei einer bestimmten Aufgabe aufzulisten, versuchen Sie, diese Formatierung in Ihrer gesamten Bedienungsanleitung beizubehalten.
5. Vermeiden Sie Grammatikprobleme – stellen Sie sicher, dass keine grammatikalischen Fehler vorhanden sind, die es den Benutzern erschweren könnten, Ihr Handbuch zu verstehen. Sie können dies mit Tools wie Grammarly und Hemingway überprüfen.

4. Fügen Sie bei Bedarf Bilder und Videos hinzu

Während Textinhalte die Grundlage Ihrer Bedienungsanleitung bilden, fügen Sie Bilder und Videos hinzu, wo es sinnvoll ist.

Das Sprichwort „Ein Bild sagt mehr als tausend Worte“ mag klischeehaft sein, aber es kann definitiv wahr sein, wenn Sie versuchen zu erklären, wie Benutzer von Ihrem Softwareprodukt profitieren können.

Um die Konzepte aus Ihrem Text zu veranschaulichen, können Sie kommentierte Bilder oder GIFs hinzufügen, die demonstrieren, worüber Sie sprechen.

Slack macht zum Beispiel einen großartigen Job bei der Kommentierung seiner Bilder zur Einführung der Benutzeroberfläche.

Videoinhalte können für einige Benutzer ebenfalls nützlich sein. Sie sollten jedoch vorsichtig sein, wenn Sie sich ausschließlich auf Videoinhalte verlassen, da dies nicht immer der optimale Weg für Benutzer ist, Software-Handbuchinhalte zu konsumieren. 

Wenn ein Benutzer nur versucht, ein bestimmtes Detail zu beheben, ist es für ihn normalerweise viel einfacher, dieses Detail in Textinhalten als in einem Video zu finden.

3. Veröffentlichen Sie Ihr Software-Benutzerhandbuch

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

Die meisten Wissensdatenbank- oder Dokumentationssoftware sollte für ein Software-Benutzerhandbuch gut funktionieren, obwohl Sie immer Ihre eigene Lösung programmieren können, wenn Sie sich zu sehr eingeschränkt fühlen. Einige Unternehmen veröffentlichen auch eine PDF-Version des Benutzerhandbuchs zusätzlich zur Webversion.

Wenn Sie nach einer Software für Benutzerhandbücher suchen, die Ihnen eine solide Funktionsliste, die vollständige Kontrolle über Ihre Inhalte und die Flexibilität zur Anpassung an Ihre Bedürfnisse bietet, können Sie Heroic Knowledge Base verwenden.

Heroic Knowledge Base ist ein WordPress-Plugin, das die notwendige Funktionalität zu Ihrer Website hinzufügt und es Ihnen ermöglicht, Ihr Software-Benutzerhandbuch zu veröffentlichen und zu verwalten.

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

• Artikelorganisation: Sie können die Artikel in Ihrem Softwarehandbuch mithilfe von Kategorien organisieren. Zum Beispiel könnten Sie verschiedene Kategorien für „Installation“, „Oberfläche“, „Verwendung von Funktionen“, „Fehlerbehebung“ usw. haben.
• Funktionen zur Inhaltsfindung: Um Benutzern zu helfen, relevante Inhalte so schnell wie möglich zu finden, bietet Heroic Knowledge Base hilfreiche Funktionen zur Inhaltsfindung wie Echtzeit-Suchvorschläge, automatische Inhaltsverzeichnisse und mehr.
• Benutzerfeedback-System: Benutzer können Feedback zur Hilfreichkeit jedes Artikels teilen, was Ihnen zeigt, was Sie gut machen (und wo Sie sich verbessern müssen).
• Detaillierte Analysen: Sie können verfolgen, welche Artikel die meisten Aufrufe erhalten, welche Artikel zu den meisten menschlichen Supportanfragen führen, nach welchen Begriffen Benutzer suchen, welche Suchanfragen keine Ergebnisse liefern und mehr.

Weitere großartige Optionen für die Veröffentlichung der Webversion Ihres Software-Benutzerhandbuchs finden Sie in unseren Listen der besten Knowledge-Base-Software und der besten Dokumentationswerkzeuge.

4. Aktualisieren Sie Ihr Software-Benutzerhandbuch basierend auf Feedback und Änderungen

Die Erstellung eines qualitativ hochwertigen Software-Benutzerhandbuchs ist keine einmalige Sache. Es ist wichtig, Schlüsselinteressenten weiterhin die Aktualisierung und Überarbeitung Ihres Handbuchs nach Bedarf zuzuweisen.

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

In anderen Fällen können diese Aktualisierungen aus Benutzerfeedback resultieren. Wenn Sie beispielsweise feststellen, dass Benutzer von einem bestimmten Artikel verwirrt sind, können Sie diesen Artikel aktualisieren, um ihn hilfreicher zu gestalten.

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 erstellen, um dieses Thema abzudecken. 

Die Veröffentlichung Ihres Benutzerhandbuchs mit einem Tool wie Heroic Knowledge Base ermöglicht es Ihnen, diese Arten von Analysen einfach zu verfolgen, damit Sie die Inhalte Ihres Benutzerhandbuchs überwachen und verbessern können.

Abschließende Gedanken

Das schließt unseren Leitfaden ab, wie man ein großartiges Software-Benutzerhandbuch schreibt, das Ihre Benutzer zum Erfolg führt.

Wenn Sie die einfachste Möglichkeit suchen, Ihr Software-Benutzerhandbuch zu veröffentlichen, 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 steht.

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 großartigen Software-Benutzerhandbuchs benötigen. Dazu gehören Live-Suchvorschläge, Kategorisierung, Sammlung von Benutzerfeedback, Analysen und mehr.

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