Die 13 einfachsten, aber wirkungsvollsten Regeln für die Erstellung von Benutzerhandbüchern

Ein Benutzerhandbuch wird in erster Linie erstellt, um den Benutzer bei der Verwendung eines Produkts und bei der Lösung von Problemen zu unterstützen. Perfekte Benutzerhandbücher und Kundensupport sind bei vielen Einkäufen unerlässlich, weshalb die Erstellung eines Benutzerhandbuchs keine einmalige Aufgabe ist.

Im Gegenteil, es handelt sich um ein fortlaufendes Projekt, das so lange läuft, wie ein Produkt existiert. Daher sind aktuelle und leicht zugängliche Handbücher und interaktive Benutzerhandbücher für jedes Unternehmen unerlässlich. Wir werden den Lebenszyklus von Benutzerhandbüchern in einem separaten Artikel besprechen, aber in diesem Artikel werden wir über Faktoren sprechen, die den Nutzen und die Beliebtheit der technischen Dokumentation beeinflussen und zu einem zunehmenden Bekanntheitsgrad Ihrer Dienstleistungen und Produkte führen können.

Hier sind die 13 einfachsten, aber wirkungsvollsten Tipps, die jeder technische Redakteur beim Erstellen eines Benutzerhandbuchs berücksichtigen muss. Wir werden auch erfahren, wie Sonat uns dabei hilft, einen großen Unterschied zu machen und ein Online-Benutzerhandbuch zu erstellen, das herausragt und unseren Kunden ein großartiges Benutzererlebnis bietet.

1. Stellen Sie sicher, dass Sie Ihr Produkt vollständig kennen

Umfassende Kenntnisse des Themas, über das Sie schreiben, sind ein Muss.

Sie können den Menschen nicht beibringen, wie sie ein Produkt verwenden und ihre Probleme lösen, es sei denn, Sie kennen das Produkt genau.

Obwohl Sie sich für tiefergehende Kenntnisse immer an die Experten wenden können, müssen Sie sicherstellen, dass Sie das Produkt gut kennen und über praktische Erfahrung verfügen, um es zu lehren und klare Anweisungen zu geben.

Sie können den Leuten nicht beibringen, wie ein Produkt zu verwenden ist, wenn Sie es nicht genau kennen.

Hier sind einige Tipps, die Ihnen beim Verfassen einer leicht verständlichen Benutzeranleitung helfen sollen:

• Führen Sie den Vorgang, über den Sie schreiben, Schritt für Schritt durch.
• Ein Fach zu unterrichten ist eine kluge Möglichkeit, es zu meistern. Versuchen Sie, das Verfahren zu lehren, bitten Sie um Feedback und nehmen Sie dann basierend auf den Eingaben Verbesserungen vor und beseitigen Sie Unklarheiten.
• Zögern Sie nicht, eine Expertenmeinung einzuholen, wenn Sie sich bei Teilen nicht hundertprozentig sicher sind.

2. Identifizieren Sie Ihre Zielgruppe

Bevor Sie eine Bedienungsanleitung erstellen, ist es von grundlegender Bedeutung, Ihre Zielgruppe zu identifizieren und sich an deren Bedürfnisse anzupassen. Sie sollten sorgfältig festlegen, an wen Sie sich wenden. Berücksichtigen Sie ihren Hintergrund, ihr Wissen, ihren Grad an Professionalität und den Grund, warum sie sich an Ihren Reiseführer wenden.

Ihre Benutzer könnten sein:

• Ein Erstbenutzer; Sie sind mit Ihrem Produkt nicht vertraut.
• Bestehende Kunden, die mit einigen Funktionen nicht vertraut sind.
• Professionelle Benutzer, die gelegentlich auf unerwartete Probleme stoßen oder die Verwendung bestimmter Funktionen vergessen.

Daher müssen Sie sich in die Lage Ihrer Benutzer versetzen, um herauszufinden, was diese möglicherweise benötigen und wie Sie ihre Bedürfnisse am besten erfüllen können. Es würde Ihnen auch helfen, eine kluge Wortwahl zu treffen.

Wenn Sie für einen allgemeinen Benutzer schreiben, müssen Sie die Verwendung von Fachterminologie, Akronymen und Fachjargon auf ein Minimum beschränken, damit Sie Ihre Kunden nicht verwirren und einschüchtern. Wenn die Verwendung von Fachterminologie unumgänglich ist, wäre die Bereitstellung eines Glossars hilfreich.

Vergessen Sie nicht, dass Sie für Ihre Benutzer schreiben, die nach einer Schaltfläche suchen, um Ihr Produkt zu erhalten, und nicht für die Entwickler oder Experten. Und noch einmal: Denken Sie daran, dass Sie ein Benutzerhandbuch nicht erstellen, um Menschen durch große Worte zu beeindrucken; Dies dient dazu, Ihre Benutzer zu informieren. Deshalb müssen Sie es so verständlich wie möglich machen.

Manche Dinge mögen für Sie und andere Experten offensichtlich sein, für Ihre Benutzer jedoch ein Fragezeichen. Wenn Sie einem tatsächlichen Benutzer dabei zuschauen, wie er Ihr Produkt verwendet, können Sie sich einen guten Eindruck von bestimmten Dingen verschaffen, die Sie ignoriert haben.

Identifizieren Sie Ihre Zielgruppe, erstellen Sie eine Persona, versetzen Sie sich in ihre Lage und denken Sie wie sie.

Hier sind einige Tipps, die Sie bei der Definition Ihrer Zielgruppe berücksichtigen sollten:

• Denken Sie über die Spezifikationen der Benutzer, ihre Bedürfnisse und die Fragen nach, die sie möglicherweise haben.
• Wenn Ihr Publikum nicht technisch versiert ist, minimieren Sie die Verwendung technischer Begriffe und erklären Sie ihm, wenn Sie welche verwenden müssen.
• Schreiben Sie Schritt-für-Schritt-Anleitungen in einfacher Sprache.

3. Verwenden Sie einen geeigneten und einheitlichen Schreibstil

Wählen Sie einen geeigneten Schreibstil. Im Allgemeinen könnte ein halbformeller oder formeller Stil, der einem etablierten Standard folgt, Ihnen dabei helfen, die Informationen in Ihrem Handbuch effektiv zu teilen.

Denken Sie daran, dass es sich hierbei um eine Anleitung handelt, deren Hauptzweck darin besteht, die Leser zu informieren und ihnen bei der Behebung möglicherweise auftretender Probleme zu helfen. Es ist kein guter Zeitpunkt, einen humorvollen Ton oder übermäßige Ungezwungenheit zu verwenden, da dies dazu führen kann, dass der Kernpunkt verloren geht.

Mit aktiver Stimme zu schreiben und sich auf Ihre Leser zu konzentrieren, ist ein wesentlicher Faktor, den Sie berücksichtigen müssen, da es viel einfacher zu verstehen ist. Da eine aktive Stimme das Thema klarer spezifiziert, minimiert sie Verwirrung, insbesondere wenn eine Aktion vom Benutzer selbst ausgeführt werden muss.

Durch die Festlegung von Standards können Sie sich weniger Gedanken darüber machen, was zu entscheiden ist, da es unterschiedliche Arten der Verwendung von Wörtern oder der Darstellung von Abbildungen und Diagrammen gibt.

4. Geben Sie präzise und präzise Anweisungen in einer einfachen Sprache

Sie schreiben eine Bedienungsanleitung, um Benutzern dabei zu helfen, ihre Fragen einfach zu beantworten, ein Problem zu beheben oder zu lernen, wie sie das Produkt richtig und sicher verwenden. Geben Sie klare und präzise Anweisungen in einfacher Sprache.

Hier sind einige Tipps:

• Halten Sie es prägnant. Vermeiden Sie es, Ihre Sätze mit unnötigen Details und sich wiederholenden Aussagen vollzustopfen.
• Verwenden Sie klare und einfache Worte.
• Teilen Sie einen komplizierten Prozess in kleinere Teile auf und geben Sie schrittweise und leicht verständliche Anweisungen.

5. Strukturieren und gestalten Sie Ihren Leitfaden

Das Layout und Design Ihres Benutzerhandbuchs hat großen Einfluss auf dessen Funktionalität. Formatieren Sie Ihr Handbuch so, dass Benutzer ganz einfach finden, was sie suchen. Sie können dieses Ziel erreichen, indem Sie auf der ersten Seite Ihres Handbuchs ein Inhaltsverzeichnis einfügen, das alle Überschriften und Unterüberschriften behandelt.

Sonat ist ein kostenloser Online-Ersteller von Benutzerhandbüchern . Es generiert automatisch eine PDF-Version Ihres Benutzerhandbuchs mit einem Inhaltsverzeichnis.

Verwenden Sie im gesamten Text ein einheitliches Layout. Das Entwerfen und Verwenden einer Vorlage könnte dabei helfen, demselben Standard zu folgen.

Vermeiden Sie es, ein einschüchterndes und verwirrendes Handbuch mit überladenem, langweiligem Text zu präsentieren. Verwenden Sie verschiedene Farben, Schriftarten, Illustrationen und visuelle Designs, um Ihren Benutzern das Befolgen der Schritte zu erleichtern und zwischen mehreren Verfahren, der Wichtigkeit anderer Themen, Warnungen usw. zu unterscheiden.

Schließlich sollten Format und Design Ihres Handbuchs benutzerfreundlich sein, sodass Ihre Kunden es sowohl leicht verständlich als auch optisch ansprechend finden.

Durch die Verwendung einer Standardvorlage für ein Benutzerhandbuch erhalten Sie möglicherweise ein vorbereitetes Format und Design, um sicherzustellen, dass Sie auf dem richtigen Weg sind und keine wichtige Überschrift verpassen. Es könnte Ihnen eine Menge Zeit und Energie sparen.

Sonat bietet Ihnen außerdem verschiedene Möglichkeiten, Ihr Benutzerhandbuch interaktiv zu gestalten. Sie können unbegrenzt hierarchische Themen haben. Sie können zwischen Schriftarten, Stilen, Farben, Anführungszeichenblöcken, Codeblöcken und vielem mehr wählen. Benutzer haben die Möglichkeit, das Handbuch im dunklen oder hellen Modus anzuzeigen.

Was das Branding betrifft, können Sie bei Sonat für jedes Benutzerhandbuch ein bestimmtes Thema, eine Branding-Farbe und ein Logo auswählen. Sie können mit Sonat beginnen, kostenlos Produktdokumentationen, ein Benutzerhandbuch oder ein Tutorial für Ihr Publikum zu schreiben.

6. Verwenden Sie zur besseren Verdeutlichung visuelle Darstellungen

Präsentieren Sie Ihre Handbücher mit klaren Bildern. Normalerweise sind Anweisungen zu visuellen Inhalten, einschließlich Abbildungen, Fotos, Screenshots, Symbolen und kurzen Tutorial-Videos, viel einfacher zu befolgen und zu verstehen. Nur textbasierte Handbücher können Benutzer langweilen oder einschüchtern.

Darüber hinaus könnten visuelle Designs auch als Kostensenkungsmaßnahme dienen, da sie den Übersetzungsaufwand reduzieren.

Hier sind einige Tipps, die Sie beim Hinzufügen von Bildmaterial beachten sollten:

• Verwenden Sie hochwertige Fotos.
• Verwenden Sie einfache Illustrationen statt komplexer Bilder.
• Fügen Sie kurze Videos ein.
• Fügen Sie Ihren Videos Untertitel hinzu, um sie zu indizieren und zu durchsuchen.

Mit Sonat können Sie alle Arten von Bildern einfügen und bearbeiten. Außerdem können Sie YouTube-, Vimeo- und DailyMotion-Videos ganz einfach in Ihr Benutzerhandbuch einbetten.

7. Schreiben, bearbeiten und Korrektur lesen Sie Ihr Handbuch

Meistens müssen Sie alle von Ihnen erstellten Inhalte vor der Veröffentlichung lesen, umschreiben, bearbeiten und Korrektur lesen. Benutzerhandbücher sind keine Ausnahme.

Möglicherweise sind Bearbeitungen und Überarbeitungen in verschiedenen Aspekten des Stils und der Sprache erforderlich, darunter Grammatik, Rechtschreibung und Zeichensetzung.

Normalerweise arbeitet ein Team technischer Redakteure zusammen, um ein großartiges Benutzerhandbuch zu erstellen, und holt dabei ständig die Meinung von Experten ein. Darüber hinaus kann dem Team auch eine Gruppe von Übersetzern hinzugefügt werden. Wenn eine solche Gruppe an einem Projekt arbeitet, gibt es nichts Wichtigeres, als verschiedene Arten von Dokumentation mit dem Team zur Überprüfung und Bearbeitung zu teilen. Damit alle Mitglieder gleichzeitig an der Verbesserung des Textes arbeiten können.

Durch die Verwendung von Sonat können Sie eine zentralisierte gemeinsame Plattform zum Arbeiten, Lesen, Bearbeiten und Zusammenarbeiten an Dokumenten nutzen. Wir statten es mit einer Rechtschreib- und Grammatikprüfung in 18 Sprachen aus.

Immer noch Zweifel? Lesen Sie : Was genau ist eine Bedienungsanleitung und warum ist sie so wichtig? Es ist das Schlüsselgeheimnis zur Zufriedenheit Ihrer Benutzer!

Sonat bietet Ihnen zwei verschiedene Welten; Die „Entwurfswelt“ befindet sich tatsächlich hinter den Kulissen, auf die nur Sie und Ihr Team Zugriff haben und die Sie alle so oft wie nötig bearbeiten und bearbeiten können, bevor Sie Ihre Arbeit veröffentlichen.

Und dann ist da noch die „Veröffentlichungswelt“, die Ihren Benutzern zugänglich gemacht wird und die Ihr Publikum schließlich sieht. Da die Veröffentlichung Ihrer manuellen Updates durch Sonat jedoch so einfach ist wie das Klicken auf die Schaltfläche „Veröffentlichen“, können Sie Ihre neuen Versionen bearbeiten, aktualisieren und veröffentlichen. Sie können jederzeit auf die Entwurfswelt zugreifen, wo Sie mit der Verlaufsfunktion den Überblick über alle Änderungen behalten.

8. Erwägen Sie die Übersetzung und Sprachlokalisierung

Um Ihr Geschäft auszubauen, möchten Sie Ihre Kunden auf jeden Fall überall auf der Welt beeindrucken und ihre Erwartungen erfüllen. Daher entscheiden Sie sich meist dafür, Ihre Bedienungsanleitung in andere Sprachen übersetzen zu lassen.

Sonat bietet Ihnen die Möglichkeit, bis zu 184 Sprachen in einem einzigen Handbuch einzuführen.

Das von Sonat erstellte Handbuch wird Ihren Benutzern basierend auf ihrer Landessprache in ihrem Browser angezeigt. Wenn Sie jedoch keine Übersetzungen in dieser bestimmten Sprache bereitgestellt haben, wird Ihren Benutzern die Standardsprache Ihres Handbuchs angezeigt.

Beachten Sie Folgendes, wenn Sie versuchen, eine Übersetzung Ihrer Inhalte bereitzustellen:

Vergessen Sie nicht, sich um die Sprachlokalisierung zu kümmern, um effektiv kommunizieren zu können. Bei der Sprachlokalisierung geht es um mehr als nur eine bloße Übersetzung, da sie eine tiefgreifende Kenntnis der Zielkultur erfordert, damit sich das Produkt effektiv an die lokalen Bedürfnisse anpassen kann. Dies könnte als separater Schritt nach der Übersetzung erfolgen. Die Einstellung professioneller Übersetzer mit hervorragenden Kenntnissen der Zielsprache und -kultur, vorzugsweise Muttersprachlern, würde diesen Prozess jedoch immer erheblich erleichtern.

9. Fügen Sie Referenzen hinzu und stellen Sie Links zu anderen Ressourcen bereit

Ein entscheidender Schritt ist die Bereitstellung von Links zu den Ressourcen Ihrer Organisation, damit Ihre Benutzer problemlos auf relevante Informationen zugreifen können. Dies könnte in Online-Handbüchern bereitgestellt werden, was die Suche nach Informationen erleichtert. Mit Sonat können Sie ganz einfach interne und externe Links in Ihrem Online-Handbuch erstellen.

10. Bitten Sie um Feedback

Sie schreiben ein Benutzerhandbuch, um Kunden die einfache Verwendung Ihres Produkts zu erleichtern. Aus diesem Grund können Sie keine perfekte Anleitung erstellen, bevor Sie Feedback von Menschen erhalten, die Ihr Produkt verwenden.

Vor der Veröffentlichung

Bevor Ihr Benutzerhandbuch veröffentlicht wird, testen Sie das Handbuch mit einigen echten Benutzern Ihrer Organisation, Betatestern oder sogar Mitarbeitern, die mit Ihrem Produkt am wenigsten vertraut sind, und bitten Sie um Feedback. Es hilft Ihnen, Ihre Krankheiten zu entdecken und auf ihre Bedürfnisse einzugehen.

Bitte beachten Sie die Teile, bei denen es möglicherweise schwierig sein könnte, Ihrem Leitfaden zu folgen. Es wäre hilfreich, wenn Sie auch Experten und Entwickler um Feedback bitten würden. Sie kennen das Produkt am besten und können Ihnen wertvolle Tipps aus der Sicht eines Profis geben.

Auch hier kann Sonat ein goldenes Werkzeug für Sie sein. Erinnern Sie sich an die zwei getrennten Welten in Sonat, die wir zuvor besprochen haben; Entwurf und Veröffentlichung. Die Entwurfswelt könnte es einem Autorenteam ermöglichen, unzählige Änderungen vorzunehmen und zu verbessern. Nun, diese Welt ist nicht auf technische Redakteure und Redakteure beschränkt. Sie könnten einer Gruppe von Betatestern Zugang gewähren und um Feedback bitten, bevor Sie Ihre Arbeit veröffentlichen.

Nach der Veröffentlichung

Sie erhalten eine Rückmeldung, nachdem Sie Ihr Handbuch veröffentlicht haben. Benutzer können zu jedem Fall Kommentare abgeben und ihre Erfahrungen mit Ihrem Produkt teilen. Es hilft Ihnen, die Meinungen der Benutzer ständig zu überwachen, Ihre Nachteile zu erkennen und den relevanten Teil sofort zu verbessern.

11. Machen Sie es zugänglich

Nachdem Sie mit der Erstellung Ihres Benutzerhandbuchs fertig sind, ist es an der Zeit, es Ihren Endbenutzern zu präsentieren. Die beste Methode zur Verbreitung Ihrer Bedienungsanleitung besteht darin, sie online zu veröffentlichen. Obwohl Sie auch eine gedruckte Version anbieten könnten, haben Online-Handbücher viele Vorteile gegenüber rein gedruckten Handbüchern.

Um nur einige zu nennen: Viele Menschen suchen online nach Informationen. Zweifellos lassen sich Online-Handbücher auch einfacher aktualisieren und teilen. Darüber hinaus wäre es am besten, die Zugänglichkeit für Ihre behinderten Kunden zu berücksichtigen; Elektronische Versionen bieten eine bessere Zugänglichkeit für Benutzer mit Behinderungen wie Sehbehinderung oder schwachen Handmanipulationsfähigkeiten.

Sie sollten in Ihrem Handbuch Suchoptionen bereitstellen, eine benutzerfreundliche Benutzeroberfläche verwenden und sicherstellen, dass es auf Tablets und Mobiltelefonen gut aussieht. Sonat bietet Ihnen all diese Funktionen und bietet Benutzern gleichzeitig die Möglichkeit, eine PDF-Version herunterzuladen und für später zu speichern. Daher können Ihre Benutzer das Handbuch auch dann erreichen, wenn sie keinen Internetzugang haben.

12. Halten Sie das Handbuch auf dem neuesten Stand

Halten Sie den Inhalt Ihres Handbuchs auf dem neuesten Stand. Ermutigen Sie Ihre Benutzer, ihre Erfahrungen, Empfehlungen und Ideen zu teilen. Nutzen Sie hilfreiches Feedback und Vorschläge zur Verbesserung Ihrer Inhalte zum besseren Verständnis. Es zeigt Ihren Benutzern, dass Sie Ihre Produkte ständig verbessern und, was noch wichtiger ist, dass Sie ihre Ideen pflegen und respektieren.

Online-Handbücher bieten in dieser Hinsicht einen bemerkenswerten Vorteil, wenn man bedenkt, dass aktualisierte Versionen mit einem Klick für jedermann verfügbar sind.

13. Unterschätzen Sie nicht das Marketingpotenzial

Auch wenn das Hauptziel der Benutzerschulung darin besteht, hilfreiche Informationen weiterzugeben, darf das Marketingpotenzial nicht vernachlässigt werden. Natürlich sollten Direktmarketing- und Vertriebsinformationen in Handbüchern vermieden werden, dennoch wird eine gute Benutzerunterstützung zu mehr Käufen führen.

Ihre Online-Handbücher und Produktdokumentationen könnten eines der wichtigsten Tools zur Verbesserung des Suchrankings und zur Generierung von Leads für Ihre Website sein.

Sonat kann Ihre Marketingziele mit robusten SEO-Funktionen erreichen, darunter unter anderem:

• Integration der Google Search Console
• Integration der Bing Search Console
• Beschreibungs-Meta-Tag
• Freundliche URL für Dokumente, Dokumentvarianten und Themen
• Überschriften verwenden
• Google Analytics-Integration
• CDN, Sonat nutzt ein leistungsstarkes Content Delivery Network, das die Ladezeit des Inhalts verkürzt und zu einer besseren Wirkung auf Suchmaschinen führt, was zu einem besseren Suchranking führt.
• Nutzen Sie Ihr Online-Handbuch als wertvolles Werkzeug zur Erreichung Ihrer Marketingziele.
• Verbessern Sie Ihren Suchrang und generieren Sie mithilfe Ihres Benutzerhandbuchs Leads für Ihre Website.

Was ist der nächste Schritt?

Sind Sie bereit, mit dem Schreiben Ihres Handbuchs zu beginnen? Gehen wir tiefer und erfahren mehr über die Abschnitte, Überschriften, Komponenten und Inhalte. Lesen Sie hier: So erstellen Sie ein professionelles Benutzerhandbuch.

Angst davor, von Grund auf neu zu schreiben? Vorlagen bewirken Wunder. Melden Sie sich an und Schreiben Sie ein professionelles Handbuch mithilfe kostenloser Benutzerhandbuchvorlagen .