Ultimativer Leitfaden zum Schreiben von Anweisungen für Benutzerhandbuch

Benutzerhandbücher sind enorm wichtig für Anwender, die Produkte und Prozesse verstehen möchten. Manchmal wird sogar gesetzlich vorgeschrieben, wenn ein Unternehmen seine Produkte an Kunden verkauft.

Kunden wenden sich oft an Ihr Benutzerhandbuch, bevor Sie sich an Ihr Kunden-Support-Team wenden. Daher hat Ihr Handbuch das Potential, Ihnen Geld bei den Supportkosten zu sparen.

Es lohnt sich, viel Zeit und Aufwand in Ihr Benutzerhandbuch zu investieren, damit Sie die bestmögliche Kundenerfahrung erzielen können. In diesem Beitrag werden wir uns die Definition eines Benutzerhandbuchs anschauen, die besten Verfahren für das Schreiben eines Handbuchs, und einige Beispiele für Benutzerhandbücher können Sie verwenden, um Ihr Handbuch zu schreiben.

Was ist ein Benutzerhandbuch?

Ein Benutzerhandbuch ist ein Dokument, das einem Benutzer zur Verfügung gestellt wird, das bei der Verwendung eines bestimmten Systems, eines Produkts oder eines Dienstes nahtlos hilft. Es ist auch als Bedienungsanleitung oder Betriebsanweisung bekannt. Diese Dokumente decken detaillierte Informationen über Operationen, Standards & Richtlinien, Anleitungen zur Fehlerbehebung, Funktionalitäten & mehr ab.

Benutzerhandbücher beinhalten üblicherweise Schritt-für-Schritt Anweisungen, die Benutzern erklärt, wie sie Ihr Produkt nutzen können und potentielle Probleme beheben können, falls eteas schief geht. Es ist nicht unbedingt gemeint, vom Start bis zum Ende gelesen zu werden und sollte ein Inhaltsverzeichnis und einen Index enthalten, damit Kunden den Abschnitt finden können, der für ihre Frage relevant ist.

Es sollte eine Anleitung am Anfang des Handbuchs enthalten, damit Kunden sich auf den Laufenden bringen können. Es kann in gedruckter oder digitaler Format oder in einer Mischung aus beiden Formaten geliefert werden.

Typen von Benutzerhandbüchern

Es gibt verschiedene Arten von Benutzerhandbüchern, die Sie bei der Einleitung Ihrer technischen Kommunikation berücksichtigen sollten.

1. Anleitung

Eine Anleitung enthält grundlegende Anweisungen, die dem Benutzer erklären, wie er ein Produkt am besten verwenden soll.

2. Trainingshandbuch

Ein Trainingshandbuch beinhaltet eine Reihe von Anweisungen, die dem Benutzer vorschreiben, wie er einen Job, einen Prozess oder eine Aufgabe erledigen kann.

3. Service-Handbuch

Ein Service-Handbuch beinhaltet eine Reihe von Anweisungen, die den Anwendern zeigen, wie eine Maschine an verschiedenen Stellen in ihrer Lebensdauer läuft.

4. Benutzerhandbuch

Wie bereits erwähnt, sind Benutzerhandbücher technische Kommunikationsdokumente, die den Anwendern bei der Bedienung eines Produkts helfen.

5. Betriebsanleitung

Eine Betriebsanleitung ist die Dokumentation der Informationen Ihres Unternehmens einschließlich Rollen, Verantwortlichkeiten und Prozesse.

6. Organisationsrichtlinienhandbuch

Ein organisatorisches Richtlinien-Handbuch dokumentiert die Unternehmensrichtlinien, Verfahren und Bewährte Praktiken

7. Standard Betriebsverfahren-Anleitung (SOPs)

Ein Standardbetriebsverfahren bietet klare Anweisungen, wie Mitglieder einer Organisation mit dem Abschluss bestimmter Prozesse umgehen können.

Egal welche Art von Handbuch Sie auch immer schreiben – es gibt einige häufige Themen, die Sie beim Schreiben Ihrer Dokumentation verfolgen können.

Was macht ein gutes Benutzerhandbuch aus?

1. Einfache Sprache

Verwenden Sie keine blumige Prose beim Schreiben Ihres Benutzerhandbuchs. Ihre Schrift sollte klar, einfach und einfach zu verstehen sein, ohne dass ein Wörterbuch gebraucht wird.
Verwenden Sie kurze Sätze und Wörter, um Ihren Text zugänglich zu machen. Wenn Sie einen technischen Begriff verwenden müssen, stellen Sie sicher, dass Sie ihn definieren oder auf ein Glossar verlinken.

2. Visuell

Ohne Grafiken, scheint Ihr Benutzerhandbuch schließlich wie ein monotoner Textblock, wo es nichts gibt, was die visuelle Monotonie unterbricht oder die Aufmerksamkeit der Leser auf sich zieht. Auf diese Weise können viele Benutzerhandbücher langweilig zu lesen werden.

Machen Sie Ihre Dokumentation interaktiv, indem Sie relevante Bilder, Diagramme und Videos hinzufügen, mit denen sich Ihre Benutzer befassen können. Stellen Sie klar, auf welchen Schritt der Anweisungen sich Ihre Grafiken beziehen, damit die Benutzer sie verstehen können.

3. Logische hierarchische Struktur

Ihre Benutzer müssen in der Lage sein, Ihr Benutzerhandbuch geleitet durch einen vordefinierten Sinn für Struktur durchzusuchen. Ihre Inhalte sollten eine logische hierarchische Struktur haben, die für Benutzer sinnvoll ist, wenn sie nach Informationen suchen.

4. Durchsuchbare Inhalte

Idealerweise müssen Sie Ihre Inhalte für Nutzer durchsuchbar machen, indem Sie sie diese als Online-Wissensdatenbank mit einer klaren und prominenten Suchleiste zur Verfügung stellen. Ihre Suchleiste sollte die Begriffe vorhersagen, die Ihre Benutzer eintippen und sowohl den Titel als auch den Inhalt Ihrer Artikel durchsuchen.

5. Klare Themen und relevante Artikel

Sie sollten Ihre Inhalte in klaren Themen organisieren, die für die darin enthaltenen Artikel sinnvoll sind. Sie sollten nicht zu viele Themen für Ihre Dokumentation haben, die für Benutzer überwältigend sein können, und zur gleichen Zeit nicht zu viele Ebenen von Unterthemen haben. Sonst könnte Ihre Dokumentation könnte schwer durchdringbar werden.

6. Feedback und Bewertungen

Bitten Sie aktiv um Feedback von Ihren Benutzern in Ihrem Benutzerhandbuch und berücksichtigen Sie deren Verbesserungsvorschläge. Finden Sie heraus, ob Ihre Benutzer mit Ihrem Handbuch tatsächlich erfolgreich sind und ob es ihnen ermöglicht, ihre Probleme zu lösen.

Wie man ein Benutzerhandbuch erstellt

1. Benutzer identifizieren

In erster Linie müssen Sie beim Schreiben Ihrer Benutzerhandbücher vor dem Start genau identifizieren, wer Ihre Benutzer sind – Demographie, Ihre Bedürfnisse, Probleme und Anforderungen. Wenn Sie herausfinden, wer Ihre Zielgruppe ist, dann erfahren Sie, wie viel Details Sie in Ihr Benutzerhandbuch einfügen müssen und wie Sie Ihre Inhalte präsentieren sollen.

2. Auf das Problem fokussieren

Alle Benutzerhandbücher sind darauf ausgerichtet, ein Problem für die Benutzer zu lösen. Sie müssen herausfinden, was diese Probleme sind, um ein wirklich hilfreiches Handbuch zu erstellen und das Problem mit Ihren Anweisungen zu lösen. Natürlich sollte ein Problem sofort behoben werden, wenn es ein tief verwurzeltes Problem mit dem Produkt selbst gibt. Da geht es nicht, einfach in der Dokumentation eine Übergangslösung anzubieten.

3. Sequentielle Schritte in der Reihenfolge verwenden

Ihre Anweisungen sollten in sequentielle Schritte unterteilt werden, die in der Reihenfolge als eine nummerierte Liste dargestellt werden. Versuchen Sie, es so zu organisieren, dass die einfachste Aufgabe zuerst vorgestellt wird.

Behalten Sie nur einen Punkt pro Schritt, um es Ihren Benutzern zu erleichtern, den Anweisungen zu folgen. Teilen Sie Ihren Benutzern mit, wie die erledigte Aufgabe aussehen wird, bevor sie zum nächsten Schritt übergehen.

4. Einen Aktionsplan erstellen

Führen Sie Recherchen darüber durch, wie Benutzer Ihr Produkt tatsächlich verwenden, damit Sie die entsprechende Dokumentation erstellen können, um jeden Touchpoint auf der Benutzerreise zu begleiten. Wesentliches Ziel ist es, das Produkt aus der Sicht des Nutzers zu sehen und genau zu verstehen, wie sie mit Ihrer Marke interagieren.

Ein Teil Ihrer Aktionsplanung besteht darin, genau zu ermitteln, welches Problem oder Ziel der Benutzer bei der Verwendung Ihres Produkts hat. Möglicherweise müssen Sie Ihre Benutzer in verschiedene Segmente aufteilen, da Benutzer unterschiedliche Gründe für die Verwendung Ihres Produkts haben können.

5. Vorlage auswählen

Um Ihre Dokumentation konsequent zu halten, ist es wichtig, eine Reihe von Vorlagen zu entwickeln, die Sie verwenden können, um Ihre Inhalte zu schreiben. Ihre Vorlage sollte klar und einfach zu befolgen sein und die notwendigen Komponenten für jedes Dokument enthalten.

Ihre Vorlage kann Folgendes beinhalten:

• Raum für eine Einführung
• Abschnitte und Unterabschnitte
• Sequentielle Schritte
• Warnungen und Aufrufe
• Raum für eine Schlussfolgerung

Stellen Sie sicher, dass Sie die Schriftgröße und den Kontrast zwischen Text und Hintergrund bestimmen, und eine einheitliche Farbkodierung verwenden.

6. Schreiben Sie klare und leicht folgbare Inhalte

Wenn Sie den vorherigen Schritten gefolgt sind und Sie Ihre Benutzer verstehen und auf klare und überzeugende Weise schreiben sollte Ihr Inhalt klar und einfach zu befolgen sein. Bearbeiten Sie Ihre Dokumentation streng, um Ihre Inhalte zu rationalisieren und stellen Sie sicher, dass die Dokumentation nur die wichtigsten Elemente enthält, die Nutzer benötigen, um eine Aufgabe zu erledigen.

Jeder Schritt Ihrer Anweisungen sollte nur eine einzige Aufgabe enthalten, so dass Benutzer Schritt für Schritt durch Ihre Dokumentation arbeiten können, ohne verwirrt zu werden.

7. Alle Benutzer wie Laien behandeln

Gehen Sie nicht davon aus, dass Ihre Benutzer technisches Vorwissen haben – die Sprache, die Sie wählen, sollte die Benutzer so betrachten, als seien sie Laien. Fachbegriffe und Jargon sollen auf jeden Fall vermieden werden – ss sei denn, sie sind unbedingt notwendig. Am besten gehen Sie davon aus, dass Ihre Benutzer nichts über das Produkt wissen und in Ihrer Dokumentation so explizit wie möglich sind.

8. Anweisungen neben dem Produkt mit naiven Benutzern testen

Wenn Sie Ihr Benutzerhandbuch geschrieben haben, sollten Sie testen, ob es bei solchen Benutzern ankommt, die Ihr Produkt noch nie verwendet haben. Stellen Sie fest, wo Benutzer in Ihrer Dokumentation stecken bleiben könnten und überprüfen Sie dementsprechend Ihre Inhalte.

Benutzer sollten in der Lage sein, Ihre Dokumentation ohne Unterstützung zu nutzen. Sie sollten in Ihrem Handbuch alles angeben, was sie wissen müssen.

9. Inhalte anhand eines praktischen Ansatzes erstellen

Vergewissern Sie sich beim Schreiben Ihres Benutzerhandbuchs, dass Sie neben Ihren Anweisungen praktische Beispiele angeben, um den Benutzern die Ergebnisse zu zeigen, die sie erwarten können, wenn sie die Aufgabe erledigen. Ihre Anweisungen sollten deutlich erklären, was die Benutzer sehen oder hören werden, und welche Rückmeldungen sie vom Produkt erhalten.

10. Symbole, Zeichen und Codes frühzeitig erläutern

Möglicherweise müssen Sie in Ihrer Dokumentation Symbole, Zeichen und Codes verwenden, um bestimmte Informationen darzustellen. Vergewissern Sie sich, dass Sie sie frühzeitig erklären, damit die Benutzer sich an den Kopf nicht fassen müssen.

Auch lesen: Wie schreibe ich Inklusive Dokumentation?

Top-technische Schreibwerkzeuge für die Erstellung von Benutzerhandbüchern

1. Document360

Document360 ist perfekt zum Erstellen von Benutzerhandbüchern für Ihre Benutzer. Sie können Document360s von aktuellster Technologie erstellen Editor verwenden, um Inhalte zu schreiben und zu organisieren, indem Sie den Kategorie-Manager verwenden, der Ihnen bis zu sechs Ebenen von Unterkategorien erlaubt. Wenn Sie den Editor verwenden, können Sie entweder den WYSIWYG-Editor oder den Markdown Editor verwenden, mit dem Sie Inhalte in Markdown entwerfen können.

Die Benutzerhandbücher von Document360 verfügen über eine leistungsstarke Suchmaschine, die es Benutzern ermöglicht, Ihre Inhalte je nach Wunsch durchzusuchen, und die Seite ist für das Lesen auf jedem Gerät optimiert. Sie können die Funktionen von Document360 durch Erweiterungen mit anderen Apps wie Drift, Intercom und Freshchat und vieles mehr erweitern.

Sie können Ihr Benutzerhandbuch mit dem Homepage Builder anpassen, mit dem Sie vieles durchführen können, zum Beispiel Links hinfügen. Farben ändern, Kategorien aus Ihrem Handbuch einschließen und so weiter. Sie können mit CSS und JavaScript noch detaillierter anpassen.

Dokumentation, Speicherung und gemeinsame Nutzung von Benutzerhandbüchern mit Document360. Starten Sie noch heute Ihre kostenlose Testversion!

Benutzerhandbuch kostenlos erstellen!

2. Adobe FrameMaker

Adobe FrameMaker ist ein Help-Authoring Tool , das auf das Erstellen von Dokumenten für das Web spezialisiert ist. Sie können intelligente strukturierte Inhalte mit XML und DITA erstellen, die sowohl für Anfänger als auch für Fortgeschrittene geeignet sind. FrameMaker macht es einfach, Inhalte von Microsoft Word zu importieren, so dass Sie die Migration nicht manuell bearbeiten müssen.

FrameMaker hat eine gute Unterstützung für hochwertige Medien, so dass Sie immersive Inhalte mit Bildern und Videos erstellen können. Mit dem Adobe Acrobat Desktop und den Online-Diensten können Sie nahtlos mit Fachexperten zusammenarbeiten.

Es verarbeitet große Dokumente, die komplexes Styling aufweisen und eine Template-basierte Autorenumgebung verwenden. Es veröffentlicht in verschiedenen Formaten wie PDF, EPUB, mobile App und Responsive HTML5. Mit der Unterstützung von FrameMaker für XLIFF können Sie Ihre Inhalte an ein globales Publikum bringen.

3. Markdown

Markdown ist eine leichtgewichtige Auszeichnungssprache, die verwendet wird, um formatierten Text in einem Editor zu erstellen. Es ist ein Werkzeug zur Konvertierung von Texten in HTML-Dateien, mit dem Sie einfach Ihre Benutzerhandbücher verfassen und für Ihre Benutzer im Web veranstalten können.

Der Vorteil der Verwendung von Markdown ist, dass die Syntax Ihnen beim Schreiben Ihrer Dokumentation so lesbar wie möglich macht. Ein durch Markdown-Format formatiertes Dokument könnte veröffentlicht werden, ohne dass es mit Tags oder Formatierungsanweisungen markiert werden muss.

4. Paligo

Paligo ist ein Komponenteninhaltsmanagementsystem fpr Teams- Es bietet eine End-to-End-Plattform für intelligente Inhalte und eine einzige Quelle der Wahrheit, so dass Sie Ihr Benutzerhandbuch mit Wiederverwendung von Inhalten und strukturiertem Authoring verfassen können.

Paligo liefert themenbasiertes Authoring und intelligente Wiederverwendung von Inhalten, so dass Sie Ihre Dokumentation in einem Bruchteil der Zeit, die normalerweise fürs Erstellen eines fertigen Produkts benötigt wird, freigeben können. Paligo macht es Ihrem gesamten Team leicht, mit Hilfe seiner Cloud-basierten Plattform an Inhalten mitzuarbeiten.

Sie können Ihre Inhalte für verschiedene Zielgruppen personalisieren und dort veröffentlichen, wo Ihre Kunden sie benötigen, inklusive HTML5, PDF print, SCORM eLearning, Zendesk, Salesforce, GitHub, BitBucket, Amazon S3 und vielem mehr. Sie brauchen nur einmal Ihren Inhalt zu schreiben und dann können Sie ihn auf Knopfdruck erneut verwenden.

Paligo ist mit Versionierung für Autoren von Inhalten ausgestattet. Es beinhaltet Versionsverlauf und Roll-back-Versionsbranching, und Release-Management, damit Sie sich keine Sorgen um die Komplexität traditioneller entwicklerorientierter Versionsverwaltungssysteme machen müssen.

Auch lesen: Top 20 Software-Dokumentations-Tools von 2022

Sehen Sie sich dieses Video an, um zu erfahren, warum Document360 die bevorzugte Wahl für das Erstellen von Benutzerhandbüchern ist

Schlussfolgerung

Benutzerhandbücher sind ein unverzichtbarer Bestandteil Ihres Produkts oder Ihrer Dienstleistung und Sie sollten die entsprechende Menge an Zeit und Aufwand für dessen Erstellung investieren. Es stehen verschiedene Werkzeuge zur Verfügung, die jeweils für verschiedene Organisationen mit unterschiedlichen Bedürfnissen geeignet sind. Nehmen Sie sich Zeit, um sie zu testen und zu entscheiden, welche Ihnen am besten passt.

Das Angebot eines hilfreichen Benutzerhandbuchs führt zu zufriedeneren Kunden, die länger bei Ihrem Unternehmen bleiben. Ihr Kundenservice-Team wird Ihnen für die Bereitstellung einer Methode des Selbstbedienungsdienstes danken. So eine Methode hilft, die Anzahl der Kunden, die den Helpdesk ansprechen, zu minimieren.

Interessiert an der Wissensdatenbank Document360? Planen Sie eine Demo mit einem unserer Experten.

Demo buchen