So schreiben Sie ein Software-Benutzerhandbuch: Der ultimative Leitfaden (einschließlich einer Vorlage)

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

Wenn Sie Ihren Benutzern helfen möchten, auf die effizienteste Art und Weise den größtmöglichen Nutzen aus Ihrem Produkt zu ziehen, ist die Erstellung eines hochwertigen Software-Benutzerhandbuchs ein guter Anfang.

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

Dies erleichtert nicht nur Ihren Benutzern die Arbeit, 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.

Um Ihnen den Einstieg zu erleichtern, finden Sie hier alles, was wir in diesem Beitrag behandeln werden:

• Was ist ein Software-Benutzerhandbuch?
• So schreiben Sie in vier Schritten ein Software-Benutzerhandbuch, einschließlich einer Vorlage für ein Software-Benutzerhandbuch
• Best Practices zum Erstellen hochwertiger Inhalte für Ihr Benutzerhandbuch

Lasst uns eintauchen!

Was ist ein Software-Benutzerhandbuch?

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

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

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

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 Fehlerbehebung und häufig gestellte Fragen ein. Auch hier stellen wir unten eine ausführlichere Vorlage für ein Software-Benutzerhandbuch zur Verfügung.

Um ein Beispiel für ein Software-Benutzerhandbuch zu sehen, können Sie sich das Forklift 3-Benutzerhandbuch ansehen, das direkt in die Erklärung der Benutzeroberfläche einsteigt.

Ein weiteres Beispiel finden Sie im Slack-Inhalt „Erste Schritte“, in dem auch direkt mit der Erläuterung der Slack-Benutzeroberfläche begonnen 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. Verbesserte Benutzererfahrung – indem Sie es den Benutzern erleichtern, den Umgang mit Ihrer Software zu erlernen und den Nutzen, den sie aus Ihrer Software ziehen, zu maximieren, werden Ihre Benutzer eine bessere Erfahrung machen.
2. Reduzierter Supportaufwand – indem Sie Benutzern die Möglichkeit geben, ihre eigenen Probleme zu lösen, können Sie die Belastung Ihrer menschlichen Supportkanäle verringern. Dies gilt insbesondere dann, wenn Sie Ihr Benutzerhandbuch mit anderen Arten von Supportinhalten kombinieren, beispielsweise einer Wissensdatenbank und/oder häufig gestellten Fragen (FAQs).

So schreiben Sie in vier Schritten ein Software-Benutzerhandbuch

Kommen wir nun zur allgemeinen Schritt-für-Schritt-Anleitung zum Verfassen eines Software-Benutzerhandbuchs. Im nächsten Abschnitt gehen wir auch auf einige Best Practices für den eigentlichen Inhalt Ihres Benutzerhandbuchs ein.

Wenn Sie an einem allgemeineren Blick auf diese Themen interessiert sind, haben wir auch eine Anleitung zum Erstellen jeder Art von Benutzerhandbuch.

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, möchten Sie möglicherweise mehrere wichtige Interessengruppen zusammenbringen, die Sie dabei unterstützen.

Dazu könnten beispielsweise Kundenerfolg, Verkäufe usw. gehören – jeder, der weiß, wie er Benutzern dabei helfen kann, den größtmöglichen Nutzen aus dem Produkt zu ziehen. In einigen Fällen müssen Sie möglicherweise auch mehr technisches Personal hinzuziehen, um bei weiterführenden Details zu helfen.

Wenn Sie ein Soloprojekt leiten, tragen Sie natürlich alle diese Aufgaben selbst. Das ist die Freude, ein Sologründer zu sein.

Sobald Sie über die entsprechenden Wissensträger verfügen, können Sie den Grundriss 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 in Ihrem Benutzerhandbuch auf, damit Benutzer wissen, was sie erwartet.
2. Einführung – Erläutern Sie den Zweck Ihres Software-Benutzerhandbuchs.
3. Systemanforderungen – beschreiben Sie alle spezifischen Anforderungen, die Benutzer für die Verwendung Ihrer Software benötigen, z. B. Hardwarespezifikationen, Betriebssystem usw.
4. Installationsanweisungen – beschreiben, wie der Benutzer die Software installieren kann.
5. Übersicht über die Benutzeroberfläche – geben Sie einen allgemeinen Überblick über die Benutzeroberfläche.
6. So verwenden Sie bestimmte Funktionen : Erstellen Sie für jede Kernfunktion einen Abschnitt, der den Benutzern zeigt, wie sie funktioniert.
7. Häufig gestellte Fragen – Behandeln Sie einige häufig gestellte Fragen eines Benutzers.
8. Fehlerbehebung – Geben Sie Ratschläge zur Fehlerbehebung weiter.
9. Glossar – Wenn Ihre Software über spezifische Terminologie verfügt, möchten Sie möglicherweise am Ende Ihres Software-Benutzerhandbuchs ein Glossar hinzufügen.
10. Kontaktdaten des Supports – Erklären Sie, wie Benutzer den Support kontaktieren können, wenn sie weitere Hilfe benötigen. Sie möchten dies am Ende beibehalten, damit Benutzer versuchen, sich selbst zu helfen, bevor sie sich an den Support wenden.

Sie müssen sich nicht genau an die Vorlage dieses Software-Benutzerhandbuchs halten – es dient nur als Ausgangspunkt, um Ihnen eine Vorstellung davon zu geben, was Sie möglicherweise einbeziehen möchten.

2. Erstellen Sie den Inhalt Ihres Software-Benutzerhandbuchs

Sobald Sie Ihre Gliederung erstellt 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, halten wir diesen Abschnitt vorerst kurz, da wir im nächsten Abschnitt einige Best Practices für Software-Benutzerhandbücher vorstellen, die Ihrem Team bei der Erstellung effektiver Benutzerhandbuchinhalte 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.

Oder wenn Sie ein Einzelgründer sind, sind Sie wahrscheinlich die beste Person, um Ihre manuellen Inhalte zu schreiben, da Sie über das tiefste Verständnis Ihrer Inhalte verfügen. Sie können jederzeit einen Redakteur beauftragen, der Sie bei der Verbesserung Ihres ersten Entwurfs unterstützt.

3. Veröffentlichen Sie Ihr Software-Benutzerhandbuch

Sobald Sie über den Inhalt Ihres Software-Benutzerhandbuchs verfügen, müssen Sie Ihr Handbuch so veröffentlichen, dass Benutzer es leicht nutzen können.

Die meisten Wissensdatenbank- oder Dokumentationsprogramme sollten als Software-Benutzerhandbuch gut funktionieren. Sie können jedoch jederzeit Ihre eigene Lösung programmieren, wenn Sie das Gefühl haben, zu eingeschränkt zu sein. Einige Unternehmen veröffentlichen zusätzlich zur Webversion auch eine PDF-Version des Benutzerhandbuchs.

Um einige tolle Optionen für die Veröffentlichung der Webversion Ihres Software-Benutzerhandbuchs zu sehen, können Sie sich unsere Listen der besten Wissensdatenbank-Software und der besten Dokumentationstools ansehen.

Wenn Sie nach einer Benutzerhandbuch-Software suchen, die Ihnen eine solide Funktionsliste, die volle Kontrolle über Ihre Inhalte und die Flexibilität bietet, Dinge an Ihre Bedürfnisse anzupassen, können Sie unser Heroic Knowledge Base WordPress-Plugin verwenden.

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

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

• Artikelorganisation – Sie können die Artikel in Ihrem Softwarehandbuch mithilfe von Kategorien organisieren. Beispielsweise könnten Sie unterschiedliche Kategorien für „Installation“, „Schnittstelle“, „Funktionen verwenden“, „Fehlerbehebung“ usw. haben.
• Inhaltserkennungsfunktionen – Damit Benutzer relevante Inhalte so schnell wie möglich finden können, enthält die Heroic Knowledge Base hilfreiche Inhaltserkennungsfunktionen wie Suchvorschläge in Echtzeit, ein automatisches Inhaltsverzeichnis und mehr.
• Benutzer-Feedback-System – Benutzer können Feedback zur Nützlichkeit jedes Artikels geben, sodass Sie wissen, was Sie gut machen (und wo Sie sich verbessern müssen).
• Detaillierte Analysen – Sie können nachverfolgen, welche Artikel die meisten Aufrufe erhalten, welche Artikel zu den meisten Supportanfragen führen, nach welchen Begriffen Benutzer suchen, welche Suchanfragen keine Ergebnisse liefern und vieles mehr.

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

Das Erstellen eines qualitativ hochwertigen Software-Benutzerhandbuchs ist keine „einmal erledigte“ Sache. Auch nach der Veröffentlichung Ihres Handbuchs ist es wichtig, weiterhin wichtige Stakeholder damit zu beauftragen, Ihr Handbuch nach Bedarf zu aktualisieren und zu überarbeiten.

In einigen Fällen können diese Aktualisierungen aufgrund einer Ä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önnten diese Aktualisierungen aus dem Feedback der Benutzer resultieren. Wenn Sie beispielsweise feststellen, dass Benutzer 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.

Durch die Veröffentlichung Ihres Benutzerhandbuchs mit einem Tool wie der Heroic Knowledge Base können Sie diese Art von Analysen einfach verfolgen, sodass Sie den Inhalt Ihres Benutzerhandbuchs überwachen und verbessern können.

Best Practices zum Schreiben Ihres Software-Benutzerhandbuchs

Nachdem Sie nun den grundlegenden Prozess zum Schreiben eines Software-Benutzerhandbuchs verstanden haben, gehen wir einige Best Practices für die Erstellung effektiver Benutzerhandbuchinhalte durch.

Verstehen Sie, wer Ihre Zielgruppe ist

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

• Woher Ihre Benutzer kommen.
• Was sie mit Ihrer Software erreichen wollen.
• Welche Schmerzpunkte sie erleben.
• Ihr allgemeiner Wissensstand über Ihre Branche und/oder alle relevanten technischen Bereiche.
• Für welches Unternehmen sie arbeiten (oder ob sie Einzelbenutzer sind).
• Usw.

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

Sie werden Ihre Zielbenutzer wahrscheinlich bereits aus Ihrer bestehenden Arbeit gut kennen. Wenn Sie sich jedoch nicht sicher sind, können Sie Kundenpersönlichkeiten, Umfragen und Interviews nutzen, um ein tieferes Verständnis zu erlangen.

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 einfach von Ihren Inhalten profitieren können.

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

• Lineare Erfahrung – Sie können Ihr Handbuch so organisieren, wie Benutzer die Dinge erleben. Beispielsweise könnten Sie mit „Installation“ als erstem Abschnitt beginnen und dann im nächsten Abschnitt mit der ersten Aktion nach der Installation fortfahren.
• Funktion – Sie können Ihren manuellen Inhalt basierend auf den verschiedenen Funktionen Ihrer Software organisieren.
• Fehlerbehebung – Sie können allgemeine Schritte zur Fehlerbehebung an einem Ort sammeln.

Auch hier ist es völlig in Ordnung, in Ihrem Handbuch mehrere Ansätze zu verwenden. Beispielsweise könnten Sie damit beginnen, die Dinge für den Installationsprozess linear zu organisieren.

Aber sobald Sie die Installation abgeschlossen haben und Benutzer mit der Anwendung Ihrer Software auf unterschiedliche Weise beginnen können, können Sie zu einem funktionsbasierten Organisationsansatz wechseln.

Halten Sie Ihr Schreiben einfach und konsistent

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

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

• Verwenden Sie keinen Fachjargon oder verwirrende Wörter – nicht alle Ihre Benutzer verfügen über die gleichen Kenntnisse in Ihrer Branche und/oder der Sprache Ihres Produkts. Daher ist es wichtig, unnötigen Fachjargon und verwirrendes Vokabular zu vermeiden. Sie können Ihre Inhalte mit Tools wie dem Flesch Reading Ease-Test testen, um Probleme zu finden.
• Vermeiden Sie Passiv – die Verwendung von Passiv kann in einem Benutzerhandbuch besonders verwirrend sein. Anstatt beispielsweise eine passive Formulierung wie „Sie können eine Kopie Ihres Entwurfs speichern, indem Sie auf die Schaltfläche „ Entwurf speichern “ klicken“ zu verwenden, ist es besser, eine aktive Formulierung wie „Drücken Sie die Schaltfläche „ Entwurf speichern “, um eine Kopie Ihres Entwurfs zu speichern“ zu verwenden Entwurf."
• Verwenden Sie kurze Sätze – teilen Sie Ihren Inhalt in kurze Sätze auf, damit Benutzer den Inhalt Ihres Benutzerhandbuchs leichter lesen und lesen können. Vermeiden Sie nach Möglichkeit lange Absätze (auch bekannt als „Textwände“).
• Bleiben Sie konsistent – ​​die Verwendung konsistenter Formulierungen und Formatierungen erleichtert den Benutzern das Verständnis Ihres Handbuchs. Wenn Sie beispielsweise immer eine geordnete Liste verwenden, um einzelne Schritte einer bestimmten Aufgabe aufzulisten, versuchen Sie, diese Formatierung im gesamten Benutzerhandbuch 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.

Fügen Sie Bilder und Videos hinzu, wo dies hilfreich ist

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

Das Sprichwort „Ein Bild sagt mehr als tausend Worte“ mag ein Klischee sein, aber es kann durchaus zutreffen, wenn Sie erklären möchten, wie Benutzer von Ihrem Softwareprodukt profitieren können.

Um die Konzepte Ihres Textes zu erläutern, können Sie mit Anmerkungen versehene Bilder oder GIFs hinzufügen, die veranschaulichen, wovon Sie sprechen.

Slack leistet beispielsweise hervorragende Arbeit bei der Kommentierung seiner Einführungsbilder für die Benutzeroberfläche.

Auch Videoinhalte können für manche Nutzer nützlich sein. Sie sollten jedoch vorsichtig sein, wenn Sie sich ausschließlich auf Videoinhalte verlassen, da dies für Benutzer nicht immer eine optimale Möglichkeit ist, Inhalte von Softwarehandbüchern zu konsumieren.

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

Erstellen Sie noch heute Ihr Software-Benutzerhandbuch

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

Wenn Sie Ihr Software-Benutzerhandbuch am einfachsten 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 liegt.

Gleichzeitig müssen Sie keine Abstriche bei der Funktionalität machen, denn Heroic Knowledge Base bietet alle Funktionen, die Sie zum Erstellen eines großartigen Software-Benutzerhandbuchs benötigen. Zu diesen Funktionen gehören Live-Suchvorschläge, Kategorienorganisation, Sammlung von Benutzerfeedback, Analysen und mehr.

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