Wie man ein Benutzerhandbuch im Jahr 2023 erstellt

Einfache Schritt-für-Schritt-Anleitung

Sie haben sich also endlich entschlossen, einen neuen Leitfaden über Ihr tolles Produkt zu schreiben.

Im Jahr 2021 stellt man fest, dass die Erstellung eines Benutzerhandbuchs immer noch größtenteils ein manueller Prozess ist. Sie besorgen sich die nächstbeste App zur Erstellung Ihres Benutzerhandbuchs und beginnen mit der Zusammenstellung der Inhalte.

Wie fängt man also an, warum fängt man an, warum braucht man überhaupt ein Benutzerhandbuch (duh...)? Ich werde versuchen, einige der häufigsten Fragen zur Erstellung von Benutzerhandbüchern zu beantworten und Ihnen bei der Erstellung Ihres ersten Benutzerhandbuchs in Docsie zu helfen, aber Sie können auch jedes andere Tool verwenden...

Gründe und Vorteile für die Erstellung eines Benutzerhandbuchs

Es gibt viele Gründe für die Erstellung von Benutzerhandbüchern. Benutzerhandbücher sind äußerst nützlich und spielen eine entscheidende Rolle in der Welt der Verbraucher, der Elektronik, der Softwareprogramme und aller Facetten von materiellen oder immateriellen Produkten. Benutzerhandbücher bieten Ihren Benutzern einfache, schrittweise Anleitungen für die Verwendung und/oder den Zusammenbau der Produkte.

Ihre Kunden müssen über die Produkte, die Sie verkaufen, die Dienstleistungen, die Sie anbieten, oder die Methoden und Verfahren, die sie befolgen müssen, unterrichtet werden. Sie bieten einen Schritt-für-Schritt-Prozess, mit dem Ihre Kunden lernen können, wie man Ihr Produkt benutzt, und sich über die verschiedenen Merkmale und Funktionen Ihres Produkts informieren können.

Die Erstellung von Benutzerhandbüchern schränkt die rechtliche Haftung für Produkte ein:

Benutzerhandbücher begrenzen auch die Haftung bei unsachgemäßer Verwendung Ihrer Produkte. Ein Benutzerhandbuch ist sehr nützlich für Produkte, die bei unsachgemäßem Gebrauch oder Zusammenbau zu Verletzungen oder sogar zum Tod führen können. Zum Beispiel: Hochspannungsgeräte, feuererzeugende Geräte und sogar Laser erfordern ausführliche Bedienungsanleitungen, um den Kunden vor unsachgemäßem Gebrauch zu schützen.

Die Erstellung guter Bedienungsanleitungen spart Zeit:

Qualitativ hochwertige Benutzerhandbücher enthalten Anleitungen zur Verwendung Ihrer Produkte, was Ihrem technischen Team bei der Erklärung von Vorgängen oder dem Vertriebsteam bei Vorführungen viel Zeit ersparen kann. Viele komplizierte Softwareprodukte erfordern gute technische Benutzerhandbücher, damit die Kunden lernen, wie sie ihre Produkte mit dem größtmöglichen Potenzial nutzen können. Software wird in der Regel mit einer Vielzahl von Funktionen bombardiert, und die richtige Menge an Benutzerhandbüchern, die den Kunden mit nützlichen Informationen versorgen, kann langfristig dazu beitragen, Kunden zu binden und Zeit bei der Erklärung der verschiedenen Aspekte der Software und komplizierter Produkte zu sparen.

Aufklärung der Kunden über die Verwendung Ihrer Produkte:

Die Aufklärung der Kunden über technische Produkte ist sehr wichtig. Ohne geeignete Benutzerhandbücher können Ihre Kunden durch eine Flut von versteckten Funktionen verwirrt werden und nicht wissen, wie sie das volle Potenzial des technischen Produkts nutzen können. Benutzerhandbücher ermöglichen einen einfachen Prozess, bei dem Ihre Kunden lernen können, sich mit den verschiedenen technischen Aspekten Ihres Produkts zu beschäftigen, und sich wohlfühlen, weil sie ein Benutzerhandbuch zur Hand haben, wenn sie sich tiefer mit Ihren Produkten befassen müssen. Es wird ihnen den Stress nehmen, Dinge ohne formale schriftliche Anleitung herauszufinden. Auch für gefährliche Produkte können Benutzerhandbücher Warnungen vor dem gefährlichen Missbrauch von Produkten enthalten.

Was macht ein gutes Benutzerhandbuch aus?

Um mit der Erstellung eines Benutzerhandbuchs zu beginnen, müssen Sie verstehen, welches Problem Sie für einen bestimmten Kunden zu lösen versuchen. Wenn Sie einen Leitfaden für alles und jedes erstellen, wird er zu einem unverständlichen Durcheinander, das niemand verstehen wird, auch nicht die Zielgruppe. Schauen Sie sich einige der besten Beispiele für Benutzerhandbücher im Internet an, die von Superstar-Unternehmen wie Stripe oder Slack verfasst wurden. Sie werden ein bestimmtes Muster erkennen.

Jedes Benutzerhandbuch konzentriert sich auf die Lösung eines bestimmten Problems.

Was sollte also jede Anleitung tun? Sie sollte sich auf einfache Aktionen konzentrieren, die Ihr Benutzer ausführen kann, während er diese Anleitung befolgt. Es besteht kein Bedarf an Komplikationen. Im Gegenteil, wenn Sie sich auf einfache Aktionen konzentrieren, die Ihren Nutzern helfen, einfache Probleme mit Ihrem Produkt zu lösen, werden Sie eine Reihe von erstaunlichen Benutzerhandbüchern haben, die Ihre Kunden lieben werden.

Schauen wir uns also ein paar Benutzerhandbücher genauer an, um zu verstehen, wie ein gutes Benutzerhandbuch aufgebaut ist, damit wir uns daran orientieren können, wie wir selbst ein gutes Benutzerhandbuch schreiben können.

Was gehört also zu einem guten Benutzerhandbuch?

Schauen wir uns den obigen Leitfaden zum Thema "Managing Book" an und stellen ein paar Punkte zusammen

Organisieren Sie Ihre Benutzerhandbücher

Verwendung von Docsie zur Erstellung von Benutzerhandbüchern

Docsie verfügt über verschiedene Werkzeuge und Funktionen, mit denen Sie großartige Benutzerhandbücher erstellen können. Werfen wir zunächst einen Blick darauf, wie Docsie funktioniert. Docsie funktioniert unter der Prämisse von Büchern, Regalen und Sammlungen.

Die Sammlungen werden verwendet, um verschiedene Bücher zu isolieren, die Sie verschiedenen Kundentypen zeigen möchten. Zum Beispiel wird diese Sammlung nur für Geschäftskunden verwendet. Das bedeutet, dass wir nur 3 Bücher aus allen Büchern ausgewählt haben, um diese speziellen Kunden anzuzeigen.

Dies ist nützlich, wenn Sie verschiedene Arten von Kunden haben, die unterschiedliche Tränen Ihrer Produkte verwenden. Dies geschieht bei Docsie nahtlos, indem Sie auf die drei Punkte neben "Alle" klicken und "Hinzufügen" drücken.

In der Symbolleiste für Docsies-Sammlungen können Sie einen Namen für Ihre Sammlung festlegen und auswählen, welche Bedienungsanleitungen Sie in dieser speziellen Sammlung anzeigen möchten. Der Grund, warum dies wichtig ist, liegt darin, dass verschiedene Kunden möglicherweise verschiedene Bedienungsanleitungen für Ihre Produkte benötigen und dieses Tool ermöglicht es Ihnen, nur die spezifischen Bedienungsanleitungen anzuzeigen, die sie sehen müssen.

Beginnen wir nun mit dem Schreiben der ersten Bedienungsanleitung mit Docsie, dies wird mit Docsies "Book" gemacht

Stellen Sie sich ein Buch als Ihr Benutzerhandbuch oder Handbuch vor. In Ihrem geöffneten Buch sehen Sie den Editor, einen Platz zum Erstellen von "Artikeln" und Überschriften.

Der Editor oben, die Möglichkeit, verschiedene Versionen und Sprachen in der oberen linken Ecke zu erstellen und natürlich "Artikel und Unterrubriken auf der linken Seite.

Der Editor ist einfach zu bedienen, er ermöglicht es Ihnen, Videos, Bilder und Code mit unserem einfachen Drag-and-Drop-Verfahren hinzuzufügen. Außerdem können Sie den Inhalt nach Ihren Vorstellungen gestalten.

Artikel sind wirklich einfach zu erstellen; geben Sie einfach Ihren Titel ein. In diesem Fall ist der Titel "Was ist Docsie", aber Sie können jeden beliebigen Titel für Ihr Benutzerhandbuch eingeben.

Um Unterabschnitte in Ihren Benutzerhandbüchern zu erstellen, die als 1.1, 1.2...ext erscheinen, müssen Sie nur die Position Ihres Textes auswählen und den Text als "Überschrift" festlegen, indem Sie auf das H in der Editor-Registerkarte klicken.

Docsie ermöglicht es Ihnen auch, verschiedene Versionen und Sprachen Ihrer Benutzerhandbücher zu erstellen. Dies ist sehr nützlich und praktisch für die Lokalisierung und um über verschiedene Änderungen in Ihren Produkthandbüchern zu sprechen.

Wenn Sie Ihre Benutzerhandbücher vorbereitet, verfasst und mit Fotos versehen haben, die die verschiedenen Aspekte Ihrer Produkte und Funktionen erklären, ist der nächste Schritt die Veröffentlichung.

Zusammengefasst sind dies die Tipps und Tricks für die Erstellung eines Benutzerhandbuchs

Die meisten Software- und technischen Produkte sind sehr komplex und vielschichtig. Bei der Erstellung eines Benutzerhandbuchs für komplexe Produkte ist es daher sinnvoll, die Informationen und Anweisungen in kleinere Teile aufzuteilen. Im Wesentlichen werden verschiedene kleine Benutzerhandbücher erstellt und zu einem Benutzerhandbuch zusammengefasst.

Ihre Kunden sind mit Ihrem Produkt oder Ihrer Dienstleistung nicht vertraut. Je technischer Ihr Produkt ist, desto anschaulicher sollten Ihre Benutzerhandbücher in der Erstellungsphase sein. Vage Worte und Phraseologie sind in diesem Prozess nicht hilfreich. Seien Sie so spezifisch wie möglich, damit Ihr Kunde auch die komplizierteren Aspekte Ihres Produkts verstehen kann.

Ein Bild sagt mehr als tausend Worte. Das gilt vor allem für Benutzerhandbücher und Bedienungsanleitungen. Dieser Schritt wird von den meisten Unternehmen vernachlässigt, aber es ist sehr wichtig, die richtigen Fotos oder Schnappschüsse von den Produktmerkmalen und -aspekten zu haben und sie in den Benutzerhandbüchern zu erläutern. Auf diese Weise kann Ihr Kunde verstehen, auf welche Aspekte Ihres Produkts Sie sich beziehen.

Ihre Bedienungsanleitungen sollen Ihren Kunden helfen, die verschiedenen Verwendungsmöglichkeiten Ihrer Produkte zu verstehen. Erklären Sie die Dinge so einfach wie möglich, damit sie die verschiedenen Funktionen und Aspekte leicht verstehen können.