Wenn Ihre Produkte komplexer sind als eine Rolle Papierhandtücher, erstellen Sie eine Art Benutzerdokumentation, die den Menschen hilft, zu lernen, wie man sie benutzt.
Ein gut gestaltetes, benutzerfreundliches Produkthandbuch oder Benutzerhandbuch kann den Unterschied zwischen einem fantastischen und einem schrecklichen Kundenerlebnis bedeuten.
Und die Benutzerdokumentation ist nicht nur für neue Benutzer gedacht.,
Erfahrene Kunden können sich auch auf Benutzerhandbücher oder Produkthandbücher beziehen, um ihre Erinnerungen an eine Funktion aufzufrischen, die sie nicht häufig verwendet haben, oder um ein bestimmtes Problem zu lösen.
In diesem Beitrag konzentrieren wir uns hauptsächlich auf Best Practices zum Erstellen von Benutzerdokumentationen für nicht physische Produkte wie Software, aber die meisten, wenn nicht fast alle dieser Tipps gelten auch für den Bereich physisches Produkt.
Hier erfahren Sie:
- Was ist Benutzerdokumentation und warum ist sie wichtig?
- Wie die Endbenutzerdokumentation Teil des Kundenerlebnisses ist.,
- Wie eine gute Benutzerdokumentation dazu beitragen kann, Ihr Kundensupport-Team zu entlasten.
- Warum visuelle Inhalte die geheime Zutat für die beste Dokumentation sind.
- Die wesentlichen Elemente, die die beste Benutzerdokumentation gewährleisten.
- Die vier Schritte zum Erstellen einer Dokumentation, die Ihre Kunden begeistert und den Test der Zeit besteht.
Einfaches Erstellen eines Benutzerhandbuchs (kostenlose Vorlage)
Snagits Vorlagen sind der schnellste Weg, Benutzerhandbücher zu erstellen. Erstellen Sie Schritt-für-Schritt-Anleitungen mit einem einfachen und professionellen Look.,
Laden
Was ist Benutzerdokumentation?
Benutzerdokumentation (auch Endbenutzerhandbücher, Endbenutzerhandbücher, Bedienungsanleitungen usw. genannt)) ist der Inhalt, den Sie Endbenutzern zur Verfügung stellen, damit sie mit Ihrem Produkt oder Ihrer Dienstleistung erfolgreicher sind.
Dies sind die Unterrichtsmaterialien, die zu Ihrem Produkt gehören, damit jemand lernen kann, es richtig zu verwenden, oder — bei physischen Produkten — es sogar zusammenzustellen.,
Wenn Sie jemals ein Ikea-Möbelstück zusammengebaut haben, haben Sie die Endbenutzerdokumentation verwendet.
Aber die Benutzerdokumentation nimmt viele Formen an.
Videospiele werden mit Handbüchern geliefert, um Ihnen mitzuteilen, welche Tasten gedrückt werden müssen, um die Bösen zu erschießen. Software-Dokumentation zeigt Ihnen, was Ihr Kauf tun kann und wie es zu tun.,
Steuerformulare enthalten Anleitungen zum richtigen Ausfüllen.
Rasenmäher und Schneewerfer haben Produkthandbücher, die Ihnen zeigen, wie Sie die Motoren starten und wo Sie den Kraftstoff nachfüllen können.
fahren Sie nach unten, um, wie stellen Sie Benutzer-Dokumentation
Warum ist die Benutzer-Dokumentation wichtig?
Sie wissen, dass Ihr Produkt großartig ist. Sie möchten, dass Ihre Kunden es auch wissen. Die Benutzerdokumentation hilft sicherzustellen, dass Ihre Kunden oder Benutzer tatsächlich lernen, wie Sie das Beste aus Ihrem Produkt herausholen können.,
Egal, ob Sie ein Dokument speichern, einen Motor starten, ein bestimmtes Werkzeug verwenden oder wichtige Sicherheitsinformationen, Ihre Endbenutzerdokumentation ist ein wichtiger Teil Ihrer Beziehung zu Ihren Kunden.
Es kann Ihre Kunden begeistern
Die Benutzerdokumentation ist einfach, oder? Ich meine, schreiben Sie einfach ein paar Sachen darüber, wie Sie Ihr Produkt verwenden, und Sie sind gut zu gehen!
So einfach ist es nicht.
Es ist mehr als nur „gewusst wie“-material. Es ist Teil des Kundenerlebnisses., Und das bedeutet, es ist auch Marketingmaterial.
Als Verbraucher selbst habe ich sowohl großartige als auch schreckliche Benutzerhandbücher erlebt. Ich wette, die meisten von euch haben ähnliche Erfahrungen gemacht.
Ein großartiges Benutzerhandbuch oder Produkthandbuch zeigt Ihren Kunden, dass es Ihnen nicht nur darum geht, ob sie Ihr Produkt kaufen, sondern auch, ob sie eine wirklich großartige Erfahrung damit haben.
Und Kunden, die das Gefühl haben, dass Sie sich über ihren Geldbeutel hinaus um sie kümmern, werden immer wieder zu Ihnen zurückkehren.,
Wenn Sie möchten, dass sie der Welt mitteilen, wie sehr sie Ihre Produkte und Dienstleistungen lieben, ist die Bereitstellung einer großartigen Benutzerdokumentation ein wesentlicher Bestandteil dieser Erfahrung nach dem Kauf.
Wie Benutzerdokumentation Ihr Support-Team unterstützt
Die Leute wenden sich an Ihr Support-Team, wenn etwas nicht funktioniert, aber sie rufen auch an, wenn sie einfach nichts herausfinden können. Eine großartige Benutzerdokumentation hilft Ihrem Support-Team auf zwei Arten.
1., Gibt ihnen ein einfaches Nachschlagewerk
Großartige Benutzerdokumentation muss nicht nur für Kunden sein. Ihr Produkt-Support-Team kann die Dokumentation verwenden, um Ihre Kunden besser zu unterstützen, wenn sie anrufen. Wenn Sie wichtige Elemente wie ein Inhaltsverzeichnis oder einen Index einfügen, können sie schnell die Informationen finden, die sie benötigen. Und wenn es sich um ein durchsuchbares elektronisches Dokument handelt, ist das noch besser! Wir werden später mehr darüber in dem Artikel erfahren.
2. Reduziert Anrufe
Wie oben erwähnt, rufen Leute oft Unterstützung an, wenn sie etwas nicht herausfinden können., Aber, wenn Kunden es selbst herausfinden können, sind sie weit weniger wahrscheinlich, Hilfe zu brauchen. Tatsächlich bevorzugen mehr als 70 Prozent der Menschen die Website eines Unternehmens, um Hilfe zu erhalten, anstatt ein Telefon oder eine E-Mail zu verwenden.
Selbst die beste Dokumentation beseitigt nicht alle diese Anrufe, aber das Erstellen von Benutzerhandbüchern und Handbüchern, die umfassend, leicht zu verstehen, klar und prägnant sind, kann das Gesamtvolumen erheblich reduzieren Anrufe, E-Mails, Chats usw.
Was sind die wesentlichen Elemente einer großartigen Benutzerdokumentation?,
Obwohl jedes Produkt einzigartig ist und verschiedene Elemente benötigt, um wirklich großartige Benutzerdokumente zu erstellen, gibt es einige Best Practices für die Endbenutzerdokumentation, unabhängig davon, was passiert.,
Große benutzer dokumentation sollte enthalten:
- Plain sprache
- Einfachheit
- Visuals
- EIN fokus auf die problem
- EINE logische hierarchie und fluss
- EIN inhaltsverzeichnis
- Durchsuchbarer Inhalt
- Zugänglicher Inhalt
- Gutes Design
- Feedback von echten Benutzern
- Links zu weiteren Ressourcen
Einfache Sprache
Nichts wird einen Kunden mehr frustrieren, als etwas zu lesen, das er nicht verstehen kann. Niemand will sich dumm fühlen., Ihren Kunden das Gefühl zu geben, dass es so ist, ist sicherlich keine Möglichkeit, ein großartiges Erlebnis zu fördern.
Verwenden Sie nach Möglichkeit einfache, einfache Sprache, um Ihren Kunden zu helfen, selbst die komplexesten Konzepte zu verstehen.
Denken Sie daran, schreiben Sie für den Benutzer, nicht für den Entwickler.
Es klingt wie ein Kinderspiel, aber das Schreiben in einfacher Sprache über ein Produkt oder eine Dienstleistung, die Sie von vorne nach hinten kennen, ist viel schwieriger, als Sie vielleicht denken. Sie wissen, alle Arten von Fachjargon, Akronyme und andere „insider“ – Infos, die Kunden wahrscheinlich nicht. Es ist natürlich für Sie, es zu benutzen.,
Aber hier können Sie ernsthafte Probleme bekommen.
Gehen Sie nicht davon aus, dass Ihr Kunde etwas über Ihr Produkt weiß. Gehen Sie nicht davon aus, dass sie alle technischen und/oder branchenspezifischen Schlagworte kennen, die Sie wahrscheinlich jeden Tag in Ihrem Büro verwenden. Schreibe es für sie.
Schreiben Sie nicht so, als wären sie Kinder, sondern verstehen Sie, dass sie möglicherweise zusätzliche Hilfe benötigen, um sie wirklich auf den neuesten Stand zu bringen. Schreiben Sie die Dokumentation auf leicht lesbare Weise.
Einfachheit
Halten Sie es so einfach wie möglich, um sein Ziel zu erreichen. Dies gilt sowohl für den Inhalt des Dokuments als auch für dessen Gestaltung., Lange Textblöcke und Seiten, die dicht mit schriftlichen und grafischen Inhalten gefüllt sind, können Benutzerhandbücher oder Handbücher einschüchternd und unfreundlich wirken lassen.
Kunden, die von Ihren Benutzermaterialien eingeschüchtert sind, rufen mit größerer Wahrscheinlichkeit Ihr Support-Team um Hilfe an, als zu versuchen, ihre Fragen selbst zu lösen. Und sie haben weit weniger wahrscheinlich eine gute Kundenerfahrung.
Visuals, Visuals, visuals
Die beste Benutzerdokumentation veranschaulicht perfekt das Sprichwort „show, don‘ t t tell.,“
Visuelle Inhalte, einschließlich Bilder, kommentierte Screenshots, Grafiken und Videos, zeigt schnell jemand, wie Ihr Produkt funktioniert. Sie müssen nicht darüber lesen, sie können es sehen!
Neuere Forschungen von TechSmith zeigen, dass Menschen visuelle Informationen tatsächlich schneller aufnehmen und Aufgaben besser ausführen, wenn Anweisungen mit visuellen oder Videoinhalten versehen werden.,
Visuelle Inhalte helfen auch, lange Textblöcke aufzubrechen und können dazu beitragen, einen Großteil des Textes zu beseitigen, der viele Benutzerhandbücher oder Handbücher einschüchternd und unangenehm erscheinen lässt.
Zu den beliebten Möglichkeiten, visuelle Inhalte in die Benutzerdokumentation aufzunehmen, gehören Screenshots, Bildschirmaufnahmen, Tutorial-Videos und mehr.
Haben Sie von vereinfachten Grafiken gehört?, Manchmal auch als vereinfachte Benutzeroberfläche (oder SUI) bezeichnet, nehmen vereinfachte Grafiken Bilder einer Benutzeroberfläche oder einer anderen Grafik auf und vereinfachen sie — wie der Name schon sagt. Diese einfachere Version hebt die wichtigsten Informationen hervor und reduziert gleichzeitig Text und Grafiken, die für einfachere Formen nicht wichtig sind.,
Also, etwas, das so aussieht:
Sieht jetzt so aus:
Wenn ich jemandem zeigen wollte, wie der Menüpunkt Mobilgerät verbinden ausgewählt wird, entfernt das zweite Bild das gesamte Durcheinander und ermöglicht es den Augen des Kunden, sich darauf zu konzentrieren, wo er sein muss.
Wahrscheinlich sind Sie bereits auf vereinfachte Grafiken gestoßen und haben es nicht einmal bemerkt.,
Wie dieser von G Suite Learning Center:
Es gibt viele Tools, aber wenn Sie nach leistungsstarken und einfachen Möglichkeiten suchen, Screenshots und Bildschirmaufnahmen zu erstellen, empfehle ich dringend, eine kostenlose Testversion von Snagit herunterzuladen.
Fokus auf das zu lösende Problem
Jedes Produkt löst ein Problem., Aber zu oft sind wir so verliebt in unsere coolen Produktfunktionen, dass wir nur hervorheben möchten, was es tun kann, und deshalb brauchen unsere Kunden es.
Zeigen Sie den Benutzern, wie Sie Aufgaben mit Ihrem Produkt ausführen.
Dies beinhaltet natürlich Produktfunktionen, aber tun Sie dies im Zusammenhang damit, dem Benutzer zu helfen, den Grund zu finden, warum er Ihr Produkt überhaupt gekauft hat — um ein bestimmtes Problem zu lösen.,
Unsere Camtasia-und Snagit-Tutorials (ja, Tutorial-Videos können eine Form der Dokumentation sein) heben beispielsweise bestimmte Funktionen hervor, tun dies jedoch im Zusammenhang damit, warum jemand diese Funktion möglicherweise verwendet. Es geht um das Warum, nicht nur um das Wie.
Hier ist ein großartiges Beispiel …
Logische Hierarchie und Ablauf
Gute Dokumentation benötigt eine Hierarchie von Überschriften und Unterüberschriften, die einen Benutzer wissen lässt, was jeder Abschnitt ihnen zeigen wird., Und diese Hierarchie sollte einem logischen Fluss folgen, der dem Benutzer hilft, zu lernen, Ihr Produkt auf die hilfreichste Weise zu verwenden.
Zum Beispiel möchten Sie Ihre Dokumentation wahrscheinlich nicht damit beginnen, Ihren Kunden zu zeigen, wie Sie die erweiterten Funktionen verwenden, ohne ihnen zuerst die Grundlagen der Funktionsweise Ihres Produkts zu zeigen. Beginnen Sie zuerst mit den einfachen Dingen und zeigen Sie ihnen dann, während Ihre Benutzer ihr Wissen aufbauen, die erweiterten Funktionen.,
Inhaltsverzeichnis
Ein Inhaltsverzeichnis bietet Ihren Kunden eine einfache, effiziente und vertraute Möglichkeit, schnell eine Lösung für ihre Frage oder ihr Problem zu finden. Es befindet sich direkt am Anfang des Dokuments, sodass sie keine Textseiten durchsuchen müssen, um zu finden, wonach sie suchen. Es sollte alle wichtigen Überschriften und Unterüberschriften wie oben beschrieben enthalten.
Mach es durchsuchbar
Es gab eine Zeit, in der die meisten Benutzerdokumentationen gedruckt wurden., In einer Zeit, in der fast jeder Zugriff auf ein Smartphone hat, ist es sinnvoller, elektronische Dokumentationen zu erstellen. Das bedeutet nicht, dass Sie auch keine Druckversionen erstellen können, aber eine elektronische Version bietet eine Reihe von Vorteilen, die wir im Folgenden näher erläutern werden.
Wie ein Inhaltsverzeichnis ermöglicht durchsuchbarer Inhalt Benutzern einen einfacheren Zugriff auf Ihre Inhalte und hilft ihnen, selbst Lösungen zu finden.
Erreichbarkeit
Erstellen von barrierefreien Inhalten., Dies bedeutet, sicherzustellen, dass die elektronische Dokumentation den Standards der Zugänglichkeit für Menschen entspricht, die blind oder sehbehindert, taub oder schwerhörig sind oder kognitive Behinderungen haben können.
Denken Sie daran, dass viele Ihrer Kunden dies benötigen, um Ihre Benutzerdokumentation zu verstehen und vollständig darauf zuzugreifen. Lass sie nicht zurück!
Gutes Design
Geben Sie Ihren Benutzern ein Dokument, das sie sich ansehen möchten, und es wird wahrscheinlicher, dass sie es verwenden.
Entwerfen Sie Materialien mit Blick auf Ihre Kunden. Machen Sie es nutzbar und freundlich., Vermeiden Sie lange Absätze von Text oder Seiten, die zu voll mit Inhalt verpackt sind. Lassen Sie für weißen Raum zu helfen, brechen die Monotonie und machen die Aussicht auf ein neues Produkt weniger entmutigend zu lernen.
Fügen Sie Grafiken und Bilder so weit wie möglich ein, um Ihren Kunden zu zeigen, anstatt Ihnen mitzuteilen, wie Sie Ihr Produkt verwenden. Verwenden Sie für die elektronische Dokumentation Video und Gifs.
Verwenden Sie konsistente Schriftarten und Komplementärfarben für mehrere Dokumente. Wenn Ihre Organisation über einen Styleguide verfügt (den Sie dringend empfehlen sollten), stellen Sie sicher, dass Ihre Dokumentation diesem entspricht.,
Snagit Templates macht es unglaublich einfach, professionell aussehende Benutzerdokumentation aus einer Reihe von Screenshots oder anderen Bildern zu erstellen. Sammeln Sie einfach die Bilder, die Sie benötigen, wählen Sie Erstellen und Bild aus Vorlage und Sie sind auf dem Weg.
Snagit enthält eine Reihe kostenloser, professionell gestalteter Vorlagen, und mit TechSmith-Assets für Snagit erhalten Sie Zugriff auf eine Menge mehr!
Feedback von echten Benutzern und/oder Betatestern
Sie können keine wirklich großartige Benutzerdokumentation erstellen, bis Sie den Personen außerhalb Ihrer Organisation zugehört haben, die die Produkte tatsächlich verwenden.,
Lerne ihre Schmerzpunkte und versuche sie so gut du kannst anzusprechen. Finden Sie heraus, was sie Ihnen sagen, dass sie wissen müssen, um Ihre Produkte am besten zu verwenden. Während einige davon offensichtlich sein könnten, garantiere ich Ihnen, Dinge zu lernen, die Sie nie in Betracht gezogen haben.
Links zu anderen Dokumentationen
Stellen Sie sicher, dass Ihre Kunden Zugriff auf mehr Ressourcen Ihres Unternehmens haben, um mit Ihren Produkten erfolgreich zu sein. Für die elektronische Benutzerdokumentation kann dies so einfach sein wie das Bereitstellen von Links zu Tutorials, FAQs, Benutzerforen und mehr.,
Aber auch Druckdokumentation kann Dinge wie Website-Adressen und Telefonnummern für weitere Unterstützung enthalten.
Bonus! Schritt-für-Schritt-Anleitung hinzufügen
Schritt-für-Schritt-Anleitungen helfen, lange Textblöcke zu vermeiden und bieten eine viel klarere Möglichkeit, einen Prozess anzuzeigen, als zu versuchen, ihn nur über Text zu erklären. Sie sind einfacher zu folgen, leichter zu verstehen und bieten eine viel benutzerfreundlichere Erfahrung, als einfach jemandem zu sagen, wie man eine Aufgabe erledigt.,
Und denken Sie daran, einschließlich visueller Inhalte in Ihren Schritt-für-Schritt-Anweisungen macht sie noch besser.
Snagit bietet ein super einfach zu bedienendes Step-Tool, mit dem Sie eine großartige Schritt-für-Schritt-Dokumentation erstellen können. Außerdem können Sie mit dem Werkzeug Bilder kombinieren einzelne Screenshots und andere Bilder zu einem einzigen Bild kombinieren, um die Bearbeitung und Markierung zu vereinfachen.
So erstellen Sie eine großartige Benutzerdokumentation
Schritt 1: Planen Sie
Jeder großartige Satz von Benutzerdokumenten beginnt mit einem Plan., Hier sind einige Tipps, wie Sie dorthin gelangen, wohin Sie gehen.
Wissen, wo Sie anfangen sollen
Viele Leute gehen davon aus, dass Sie, wenn Sie Ihr Produkt kennen, einfach mit der Erstellung Ihrer Dokumentation beginnen können, aber es gibt noch viel mehr. Beginnen Sie stattdessen mit einem Plan, um sicherzustellen, dass Sie Ihren Benutzern tatsächlich helfen.
Bevor Sie eine Dokumentation erstellen, sollten Sie Folgendes beachten:
- Was sollten Sie einschließen? Was sollten Sie weglassen? (Hinweis: Hier kann Benutzerfeedback WIRKLICH hilfreich sein!)
- In welcher Reihenfolge sollten wir die Informationen präsentieren?, (Erinnern Sie sich an Essay-Umrisse aus der Mittelschule? Benutze sie!)
- Welche anderen Ressourcen stehen zur Verfügung? Wie werden wir Zugang/Links zu diesen bereitstellen?
- Wer ist für die Erstellung des Dokuments verantwortlich? Wer ist für das Feedback zum Dokument verantwortlich? Wer hat die endgültige Genehmigung?
- Muss dies übersetzt oder lokalisiert werden?
Die Antworten auf diese Fragen prägen, wie Sie Ihre Dokumentation erstellen. Die Planung sorgt für einen reibungslosen Ablauf und ein besseres Benutzerdokument.
Kennen Sie Ihr Produkt
Stellen Sie sicher, dass Sie Ihr Produkt kennen.,
Das bedeutet nicht, dass Sie der absolute Experte für alles sein müssen, aber jeder, der ein Benutzerhandbuch oder eine Bedienungsanleitung erstellt, sollte praktische Erfahrung mit dem Produkt haben.
Verlassen Sie sich auf Ihre Fachexperten für das vertiefte Wissen, sicher, aber Sie sollten wissen, wie es selbst zu verwenden, bevor Sie versuchen, jemand anderes zu lehren.
Wählen Sie Ihr Format
Ebenso wichtig ist das endgültige Format eines Dokuments. Wird es nur Print sein? Wird es elektronisch sein? Wenn ja, wo wird es leben?,
Es ist noch nicht allzu lange her, dass fast die gesamte Benutzerdokumentation nur gedruckt wurde. Wenn Sie jedoch keinen sehr guten Grund haben, empfehle ich Ihnen, zumindest eine elektronische Version auf Ihrer Website verfügbar zu haben.
Die meisten Benutzer haben 24-Stunden-Zugriff auf Smartphones, Computer oder Tablets und sind es gewohnt, alles zu finden, was sie wissen möchten, wann immer sie es wissen möchten. Wenn Sie Benutzerressourcen online stellen, haben sie überall Zugriff, was bedeutet, dass sie nicht durch Schubladen oder Aktenschränke suchen müssen, um ein Benutzerhandbuch zu finden, das sie seit Jahren nicht mehr gesehen haben.,
Außerdem ist es einfach einfacher, elektronische Dokumentation für Menschen mit Behinderungen zugänglich zu machen. Eine reine Druckversion funktioniert für die meisten Menschen, aber sind Sie bereit, eine Braille-Version für blinde oder sehbehinderte Benutzer zu erstellen? Was ist mit Benutzern mit körperlicher Behinderung, bei denen es für sie schwierig ist, Objekte mit ihren Händen zu manipulieren?
Es gibt Tools, die allen den Zugang zu elektronischer Dokumentation erleichtern, aber Nur-Print-Versionen bieten ein viel schwierigeres Problem bei der Zugänglichkeit.,
Außerdem ist die elektronische Dokumentation viel einfacher zu aktualisieren, da sie im Internet lebt.
PDF: Sollten Sie oder sollten Sie nicht?
Wenn Sie NICHT möchten, dass Personen Ihre Dokumentation drucken, machen Sie sie NICHT zu einem PDF. Stellen Sie stattdessen eine elektronische Version auf Ihrer Website als normalen Website-Text zur Verfügung. Es gibt eine Reihe von Gründen dafür, aber alles läuft darauf hinaus: Es ist einfach einfacher zu bedienen.
Wenn Sie eine herunterladbare PDF-Version Ihrer Dokumentation anbieten möchten, ist das in Ordnung. Stellen Sie jedoch sicher, dass es auch in einem Nicht-PDF-Format auf Ihrer Website verfügbar ist.,
Schritt 2: Erstellen Sie Ihr Benutzerdokument
Sobald Sie alle Fragen beantwortet und alle oben beschriebenen Entscheidungen getroffen haben, ist es Zeit, Ihre Benutzerdokumentation zu erstellen. Ich gehe nicht davon aus, Ihnen zu sagen, wie GENAU die Dokumentation für Ihr spezifisches Produkt erstellt werden soll, aber es gibt einige wichtige Dinge zu beachten.
- Vermeiden Sie Jargon und hochtechnische Begriffe, außer wenn dies unbedingt erforderlich ist (und definieren Sie sie dann unbedingt).
- Vermeiden Sie Akronyme, es sei denn, Sie erklären, was Sie bedeuten.
- Verwenden Sie nach Möglichkeit einen allgemein anerkannten Schreibstil wie AP oder Chicago., Wenn Ihre Organisation einen Unternehmensstilführer hat, verwenden Sie diesen.
- Gehen Sie nicht davon aus, dass der Benutzer etwas über Ihr Produkt weiß oder was es tut. ZEIGEN Sie Ihnen, was Sie wissen müssen, um erfolgreich zu sein.
- Denken Sie daran, einfache Sprache zu verwenden. Schreiben Sie für eine achte Klasse. Selbst für fortgeschrittene Leser führt eine einfache Sprache zu einer schnelleren Verarbeitung und einem besseren Verständnis.
- Das Design sollte angenehm, nicht einschüchternd sein und den Benutzer anziehen. Machen Sie sie wollen Ihre Dokumentation verwenden.,
Schritt 3: Testen Sie es
Ein Benutzerhandbuch ist nur dann großartig, wenn es Ihren Kunden hilft, Ihr Produkt bestmöglich zu nutzen. Und das kannst du erst wissen, wenn es jemand benutzt. Bevor deine neue Kreation in die Welt hinausgeht, möchtest du sie testen. Hier sind ein paar Tipps!
- Best Practice: Geben Sie es einer Gruppe von echten Benutzern oder Betatestern und sehen Sie, wie es geht. Integrieren Sie Ihr feedback in das fertige Dokument.
- Wenn Sie kein Beta – Test-Benutzerfeedback haben, testen Sie es intern, vorzugsweise mit Mitarbeitern, die mit dem Produkt am wenigsten vertraut sind.,
- Holen Sie sich Feedback von den Entwicklern und Ingenieuren. Sie kennen das Produkt besser als jeder andere und können auf Dinge hinweisen, die Sie möglicherweise verpasst haben.
Schritt 4: Halten Sie Ihre Dokumentation auf dem neuesten Stand
Wenn sich Ihr Produkt ändert, müssen Sie alles auf dem neuesten Stand halten. Wie oben erwähnt, bietet dies der elektronischen Dokumentation einen großen Vorteil gegenüber dem Druck. Allerdings können auch Nur-Print-Dokumente aktualisiert und zum Download auf Ihrer Website zur Verfügung gestellt werden.
Denken Sie daran, dass Ihr Inhalt nur dann großartig ist, wenn er genau ist. Stellen Sie sicher, dass das, was Sie Ihren Kunden geben, ihnen tatsächlich hilft, Ihr Produkt zu verwenden.,
Zusammenfassung
Wenn Sie sich an nichts anderes erinnern, denken Sie daran, dass großartige Benutzerdokumentationen so erstellt, entworfen und präsentiert werden sollten, dass sie für Ihre Benutzer am hilfreichsten sind.
Geben Sie ihnen eine Dokumentation, die sie weiterhin begeistert und die Art von Kundenerfahrung bietet, die Sie haben möchten.
Machen Sie Ihre Dokumentation zugänglich, nützlich und visuell.
Einfaches Erstellen eines Benutzerhandbuchs (kostenlose Vorlage)
Snagits Vorlagen sind der schnellste Weg, Benutzerhandbücher zu erstellen. Erstellen Sie Schritt-für-Schritt-Anleitungen mit einem einfachen und professionellen Look.,
Download
Häufig gestellte Fragen
Benutzerdokumentation (auch Endbenutzerhandbücher, Endbenutzerhandbücher, Bedienungsanleitungen usw. genannt)) ist der Inhalt, den Sie Endbenutzern zur Verfügung stellen, damit sie mit Ihrem Produkt oder Ihrer Dienstleistung erfolgreicher sind.
In der Vergangenheit wurde die Benutzerdokumentation über eine für den Benutzer lokale Hilfedatei oder ein physisches Handbuch oder eine Broschüre bereitgestellt., Heutzutage wird Benutzerdokumentation fast immer online angeboten, was technischen Autoren geholfen hat, einfallsreicher zu sein, wie sie Benutzern helfen.
Eine großartige Benutzerdokumentation sollte Folgendes umfassen: Einfache Sprache, Einfachheit, Grafik, Fokus auf das Problem, logische Hierarchie und Ablauf, Inhaltsverzeichnis, durchsuchbare Inhalte, zugängliche Inhalte, gutes Design, Feedback von echten Benutzern und Links zu weiteren Ressourcen.
Großartige Benutzerdokumentation kann in vier einfachen Schritten erstellt werden: Kennen Sie zuerst Ihre Ziele und erstellen Sie einen Plan, um sie zu erreichen. Erstellen Sie als Nächstes
Ihren Leitfaden basierend auf Ihrem Plan. Testen Sie dann Ihren Leitfaden, um sicherzustellen, dass er die Arbeit erledigt, bevor Sie ihn freigeben. Schließlich halten Sie es auf dem Laufenden. Wenn sich Ihr Produkt ändert, aktualisieren Sie Ihre Dokumentation, um die Änderungen widerzuspiegeln.
Hinweis: Dieser Beitrag wurde ursprünglich im August 2019 veröffentlicht, aber zur Verdeutlichung und um neue Informationen zu erhalten, im September 2020 aktualisiert.
Schreibe einen Kommentar