So erstellen Sie die beste Benutzerdokumentation

Wenn Ihre Produkte komplexer sind als eine Rolle Papierhandtücher, erstellen Sie wahrscheinlich eine Art Benutzerdokumentation, um den Menschen zu helfen, ihre Verwendung zu erlernen.

Ein gut gestaltetes, benutzerfreundliches Produkt- oder Benutzerhandbuch kann den Unterschied zwischen einem fantastischen und einem schrecklichen Kundenerlebnis ausmachen.

Außerdem ist die Benutzerdokumentation nicht nur für neue Benutzer gedacht.

Erfahrene Kunden können auch auf Benutzerhandbücher oder Produkthandbücher zurückgreifen, um ihre Erinnerungen an eine Funktion aufzufrischen, die sie nicht oft verwendet haben, oder um ein bestimmtes Problem zu lösen, das sie haben.

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 alle) dieser Tipps gelten auch für den Hardwarebereich.

Hier ist, was Sie lernen werden:

• Was Benutzerdokumentation ist und warum sie wichtig ist.
• 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 zur Erstellung von Dokumentationen, die Ihre Kunden begeistern und die Zeit überdauern.

Was ist Benutzerdokumentation?

Benutzerdokumentation (auch Endbenutzerhandbücher, Endbenutzerhandbücher, Bedienungsanleitungen usw. genannt) ist der Inhalt, den Sie Endbenutzern zur Verfügung stellen, um ihnen zu helfen, mit Ihrem Produkt oder Ihrer Dienstleistung erfolgreicher zu sein.

Dies sind die Anleitungsmaterialien, die mit Ihrem Produkt geliefert werden, um jemandem zu helfen, es richtig zu verwenden oder – im Fall von physischen Produkten – sogar zusammenzubauen.

Wenn Sie jemals ein IKEA-Möbelstück zusammengebaut haben, haben Sie die Endbenutzerdokumentation verwendet.

Die Benutzerdokumentation nimmt jedoch viele Formen an.

Videospiele werden mit Handbüchern geliefert, die Ihnen sagen, welche Knöpfe Sie drücken müssen, um die Bösewichte zu erschießen. Die Softwaredokumentation zeigt Ihnen, was Ihr Einkauf kann und wie es geht.

Steuerformulare enthalten Anleitungen zum korrekten Ausfüllen.

Für Rasenmäher und Schneefräsen gibt es Produktanleitungen, die Ihnen zeigen, wie Sie die Motoren starten und wo Sie Kraftstoff nachfüllen.

Fahren Sie mit der Erstellung der Benutzerdokumentation fort

Warum ist die Benutzerdokumentation wichtig?

Sie wissen, dass Ihr Produkt großartig ist. Das sollen auch Ihre Kunden wissen. Die Benutzerdokumentation hilft sicherzustellen, dass Ihre Kunden oder Benutzer tatsächlich lernen, wie sie Ihr Produkt optimal nutzen können.

Ob es darum geht, ein Dokument zu speichern, einen Motor zu starten, ein bestimmtes Werkzeug zu verwenden oder sogar wichtige Sicherheitsinformationen, Ihre Endbenutzerdokumentation ist ein wichtiger Teil Ihrer Beziehung zu Ihren Kunden.

Benutzerdokumentation 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 können loslegen!

Ganz so einfach ist es nicht.

Es ist mehr als nur „How-to“-Material. Es ist Teil des Kundenerlebnisses. Und das heißt, es ist auch Marketingmaterial.

Als Verbraucher habe ich sowohl großartige als auch schreckliche Benutzerhandbücher erlebt. Ich wette, die meisten von Ihnen haben ähnliche Erfahrungen gemacht.

Ein großartiges Benutzerhandbuch oder ein Produktleitfaden zeigt Ihren Kunden, dass es Ihnen nicht nur wichtig ist, ob sie Ihr Produkt kaufen, sondern ob sie tatsächlich eine wirklich großartige Erfahrung damit machen.

Kunden, die das Gefühl haben, dass Sie sich über ihr Portemonnaie 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 die Benutzerdokumentation Ihr Support-Team unterstützt

Leute wenden sich oft an Ihr Support-Team, wenn etwas nicht funktioniert, aber sie können auch anrufen, wenn sie etwas einfach nicht herausfinden können. Eine hervorragende Benutzerdokumentation hilft Ihrem Support-Team in zweierlei Hinsicht.

1. Gibt ihnen eine einfache Referenzanleitung

Gute Benutzerdokumentation muss nicht nur für Kunden sein. Ihr Produktsupportteam kann die Dokumentation verwenden, um Ihre Kunden besser zu unterstützen, wenn sie um Hilfe bitten. Wenn Sie wichtige Elemente wie ein Inhaltsverzeichnis oder einen Index hinzufügen, können sie die benötigten Informationen schnell finden. Und wenn es sich um ein durchsuchbares elektronisches Dokument handelt, ist das sogar noch besser! Wir werden später in diesem Artikel mehr darüber erfahren.

2. Reduziert Anrufe

Wie oben erwähnt, rufen Leute oft den Support an, wenn sie etwas nicht herausfinden können. Aber wenn Kunden es selbst herausfinden können, ist es weitaus unwahrscheinlicher, dass sie Hilfe benötigen. Tatsächlich nutzen mehr als 70 Prozent der Menschen lieber die Website eines Unternehmens, um Hilfe zu erhalten, als Hilfe per Telefon oder E-Mail zu erhalten.

Selbst die beste Dokumentation wird nicht alle diese Anrufe beseitigen, aber die Erstellung von Benutzerhandbüchern und Handbüchern, die klar, umfassend und prägnant sind, trägt wesentlich dazu bei, das Gesamtvolumen von Supportanfragen zu reduzieren.

Was sind die wesentlichen Elemente einer guten Benutzerdokumentation?

Obwohl jedes Produkt einzigartig ist und unterschiedliche Elemente erfordert, um wirklich großartige Benutzerdokumente zu erstellen, gibt es einige Best Practices für die Endbenutzerdokumentation, die Sie auf jeden Fall befolgen sollten.

Eine gute Benutzerdokumentation sollte Folgendes beinhalten:

• Einfache Sprache
• Einfachheit
• Visuals
• Ein Fokus auf das Problem
• Eine logische Hierarchie und ein Fluss
• Ein Inhaltsverzeichnis
• Durchsuchbarer Inhalt
• Zugängliche Inhalte
• 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 versteht. Niemand möchte sich dumm fühlen, und eine Sprache, die Ihren Kunden das Gefühl gibt, ist sicherlich kein Weg, um ein großartiges Erlebnis zu fördern.

Verwenden Sie wann immer möglich eine einfache, verständliche Sprache, damit Ihre Kunden selbst die komplexesten Konzepte verstehen.

Denken Sie daran, schreiben Sie für den Benutzer, nicht für den Entwickler.

Es klingt wie ein Kinderspiel, aber in einfacher Sprache über ein Produkt oder eine Dienstleistung zu schreiben, die Sie von vorne bis hinten kennen, ist schwieriger als Sie vielleicht denken. Sie kennen alle Arten von Jargon, Akronymen und anderen „Insider“-Informationen, die Kunden wahrscheinlich nicht kennen. Es ist für Sie selbstverständlich, es zu verwenden.

Aber genau da kann es zu ernsthaften Schwierigkeiten kommen.

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.

Schreiben Sie nicht, als wären sie Kinder, aber verstehen Sie, dass sie möglicherweise zusätzliche Hilfe benötigen, um sie wirklich auf den neuesten Stand zu bringen. Schreiben Sie die Dokumentation in einer leicht lesbaren Weise.

Einfachheit

Halten Sie die Dokumentation so einfach wie möglich, um ihr Ziel zu erreichen. Dies gilt sowohl für den Inhalt als auch für die Gestaltung des Dokuments. Lange Textblöcke und Seiten, die dicht mit geschriebenen und grafischen Inhalten gefüllt sind, können dazu führen, dass Benutzerhandbücher oder Handbücher einschüchternd und unfreundlich wirken.

Kunden, die von Ihren Benutzermaterialien eingeschüchtert sind, rufen mit weitaus größerer Wahrscheinlichkeit Ihr Support-Team um Hilfe an, als zu versuchen, ihre Fragen selbst zu lösen. Darüber hinaus ist es weitaus unwahrscheinlicher, dass sie ein gutes Kundenerlebnis haben.

Visuals

Die beste Benutzerdokumentation veranschaulicht perfekt den Satz „zeigen, nicht erzählen“.

Visuelle Inhalte, darunter Bilder, kommentierte Screenshots, Grafiken und Videos, zeigen jemandem schnell, wie Ihr Produkt funktioniert. Sie müssen nicht darüber lesen: Sie können es sehen!

Jüngste Untersuchungen von TechSmith zeigen, dass Menschen visuelle Informationen tatsächlich schneller aufnehmen und Aufgaben besser ausführen, wenn Anweisungen mit visuellen oder Videoinhalten bereitgestellt werden.

Visuelle Inhalte helfen auch dabei, lange Textblöcke aufzubrechen und können dazu beitragen, einen Großteil des Textes zu eliminieren, der viele Benutzerhandbücher oder Handbücher einschüchternd und unangenehm erscheinen lässt.

Beliebte Möglichkeiten, visuelle Inhalte in die Benutzerdokumentation aufzunehmen, sind Screenshots, Bildschirmaufzeichnungen, Tutorial-Videos und mehr.

Haben Sie von vereinfachten Grafiken gehört? Vereinfachte Grafiken werden manchmal als vereinfachte Benutzeroberfläche (oder SUI) bezeichnet und nehmen 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 man das Menüelement Connect Mobile Device auswählt, entfernt das zweite Bild die ganze Unordnung und ermöglicht es den Augen des Kunden, sich darauf zu konzentrieren, wo sie sein müssen.

Wahrscheinlich sind Sie bereits auf vereinfachte Grafiken gestoßen und haben es nicht einmal bemerkt, wie diese aus dem G Suite Learning Center:

Es gibt viele Tools, aber wenn Sie nach leistungsstarken und einfachen Möglichkeiten zum Erstellen von Screenshots und Bildschirmaufzeichnungen suchen, empfehle ich Ihnen dringend, eine kostenlose Testversion von Snagit herunterzuladen.

Konzentrieren Sie sich auf das zu lösende Problem

Jedes Produkt löst ein Problem. Aber allzu oft lieben wir unsere coolen Produktfunktionen so sehr, dass wir nur hervorheben wollen, was sie können, und nicht, warum unsere Kunden sie brauchen.

Stellen Sie sicher, dass Sie Benutzern zeigen, wie sie Aufgaben mit Ihrem Produkt ausführen.

Dies betrifft natürlich Produktfunktionen, aber heben Sie sie hervor, um dem Benutzer zu helfen, den Grund zu finden, warum er Ihr Produkt überhaupt gekauft hat – um ein bestimmtes Problem zu lösen.

Zum Beispiel heben unsere Camtasia- und Snagit-Tutorials (ja, Tutorial-Videos können eine Form der Dokumentation sein) bestimmte Funktionen hervor, aber sie tun dies im Zusammenhang damit, warum jemand diese bestimmte Funktion verwenden könnte. Es geht um das Warum, nicht nur um das Wie.

Hier ist ein tolles Beispiel …

Logische Hierarchie und Fluss

Eine gute Dokumentation benötigt eine Hierarchie von Überschriften und Unterüberschriften, die einem Benutzer mitteilt, was ihm jeder Abschnitt zeigen wird. Und diese Hierarchie sollte einem logischen Fluss folgen, der dem Benutzer hilft, Ihr Produkt auf die hilfreichste Weise zu nutzen.

Beispielsweise möchten Sie Ihre Dokumentation wahrscheinlich nicht damit beginnen, Kunden zu zeigen, wie sie die fortgeschritteneren Funktionen verwenden, ohne ihnen zuerst die Grundlagen der Funktionsweise Ihres Produkts zu zeigen. Beginnen Sie zuerst mit den einfachen Dingen und zeigen Sie Ihren Benutzern dann, während sie ihr Wissen erweitern, 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 nicht Seiten mit Text durchsuchen müssen, um zu finden, wonach sie suchen. Es sollte alle wichtigen Überschriften und Unterüberschriften wie oben beschrieben enthalten.

Machen Sie es durchsuchbar

Es gab eine Zeit, in der die meisten Benutzerdokumentationen gedruckt wurden. Jetzt, in einer Zeit, in der fast jeder Zugang zu einem Smartphone hat, ist es sinnvoller, elektronische Dokumentationen zu erstellen. Das bedeutet nicht, dass Sie nicht auch Druckversionen erstellen können, aber eine elektronische Version bietet eine Reihe von Vorteilen, auf die wir weiter unten näher eingehen werden.

Wie ein Inhaltsverzeichnis erleichtern durchsuchbare Inhalte Benutzern den Zugriff auf Ihre Inhalte und helfen ihnen, selbst Lösungen zu finden.

Barrierefreiheit

Erstellen Sie zugängliche Inhalte. Das bedeutet sicherzustellen, dass die elektronische Dokumentation den Zugänglichkeitsstandards 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 ist wahrscheinlicher, dass sie es verwenden.

Entwerfen Sie Materialien mit Blick auf Ihre Kunden. Machen Sie es benutzerfreundlich und benutzerfreundlich. Vermeiden Sie lange Textabsätze oder zu vollgestopfte Seiten. Lassen Sie Leerraum zu, um die Monotonie aufzubrechen und die Aussicht, ein neues Produkt zu lernen, weniger abschreckend zu gestalten.

Fügen Sie so viele Grafiken und Bilder wie möglich hinzu, um sie zu zeigen, anstatt Ihren Kunden zu sagen, wie sie Ihr Produkt verwenden sollen. Verwenden Sie für die elektronische Dokumentation Video und GIFs.

Verwenden Sie konsistente Schriftarten und Komplementärfarben in mehreren Dokumenten. Wenn Ihre Organisation über einen Styleguide verfügt (den ich dringend empfehle, zu erstellen, falls noch keiner vorhanden ist), stellen Sie sicher, dass sich Ihre Dokumentation daran hält.

Snagit-Vorlagen machen es unglaublich einfach, eine professionell aussehende Benutzerdokumentation aus einer Reihe von Screenshots oder anderen Bildern zu erstellen. Stellen Sie einfach die benötigten Bilder zusammen, wählen Sie „Erstellen“ und dann „Bild aus Vorlage“, und Sie können loslegen.

Snagit wird mit einer Reihe kostenloser, professionell gestalteter Vorlagen geliefert, und mit TechSmith Assets for Snagit erhalten Sie Zugriff auf eine Menge mehr!

Feedback von echten Benutzern und/oder Beta-Testern

Sie können keine wirklich großartige Benutzerdokumentation erstellen, bis Sie den Leuten außerhalb Ihrer Organisation zugehört haben, die die Produkte tatsächlich verwenden.

Lernen Sie ihre Schmerzpunkte kennen und versuchen Sie, sie so gut wie möglich anzugehen. Finden Sie heraus, was Sie wissen müssen, um Ihre Produkte optimal zu nutzen. Während einige davon offensichtlich erscheinen mögen, garantiere ich Ihnen, dass Sie Dinge lernen werden, an die Sie nie gedacht haben.

Links zu anderen Dokumentationen

Stellen Sie sicher, dass Ihre Kunden Zugriff auf mehr Ressourcen Ihres Unternehmens haben, um zu erfahren, wie Sie mit Ihren Produkten erfolgreich sein können. Für die elektronische Benutzerdokumentation kann dies so einfach sein wie das Bereitstellen von Links zu Tutorials, FAQs, Benutzerforen und mehr.

Aber auch die gedruckte Dokumentation kann Dinge wie Website-Adressen und Telefonnummern für weitere Unterstützung enthalten.

Bonus! Fügen Sie Schritt-für-Schritt-Anleitungen hinzu

Schritt-für-Schritt-Anleitungen helfen, lange Textblöcke zu vermeiden und bieten eine viel klarere Möglichkeit, einen Prozess zu zeigen, als zu versuchen, ihn nur durch Text zu erklären. Sie sind einfacher zu befolgen, leichter zu verstehen und bieten eine viel benutzerfreundlichere Erfahrung, als jemandem einfach zu sagen, wie er eine Aufgabe erledigen soll.

Und denken Sie daran, dass das Einfügen visueller Inhalte in Ihre Schritt-für-Schritt-Anleitungen sie noch besser macht.

Snagit bietet ein benutzerfreundliches Step-Tool, mit dem Sie eine großartige Schritt-für-Schritt-Dokumentation erstellen können. Außerdem können Sie mit dem Tool zum Kombinieren von Bildern einzelne Screenshots und andere Bilder zu einem einzigen Bild kombinieren, um es einfacher zu bearbeiten und zu markieren.

So erstellen Sie eine großartige Benutzerdokumentation

Schritt 1: Planen

Jeder große Satz von Benutzerdokumenten beginnt mit einem Plan. Hier sind einige Tipps, wie Sie dorthin gelangen, wo Sie hinwollen.

Wissen, wo man anfangen soll

Viele Leute gehen davon aus, dass Sie, wenn Sie Ihr Produkt kennen, einfach mit der Erstellung Ihrer Dokumentation beginnen können. Aber es gehört noch viel mehr dazu. 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 sollte man weglassen? (Tipp: Hier kann Benutzerfeedback WIRKLICH hilfreich sein!)
• In welcher Reihenfolge sollten wir die Informationen präsentieren? (Erinnern Sie sich an Aufsatzskizzen aus der Schule? Verwenden Sie sie!)
• Welche anderen Ressourcen werden verfügbar sein? Wie werden wir Zugang/Links zu diesen bereitstellen?
• Wer ist für die Erstellung des Dokuments verantwortlich? Wer ist für Feedback zum Dokument verantwortlich? Wer hat die endgültige Genehmigung?
• Muss dies übersetzt oder lokalisiert werden?

Die Antworten auf diese Fragen bestimmen, wie Sie Ihre Dokumentation erstellen. Die Planung sorgt für einen reibungslosen Ablauf und eine bessere Benutzerdokumentation.

Kennen Sie Ihr Produkt

Stellen Sie sicher, dass Sie Ihr Produkt kennen.

Das bedeutet nicht, dass Sie in allem der absolute Experte sein müssen, aber jeder, der ein Benutzerhandbuch oder eine Bedienungsanleitung erstellt, sollte praktische Erfahrung mit dem Produkt haben.

Verlassen Sie sich für das tiefergehende Wissen auf Ihre Fachexperten, aber Sie sollten wissen, wie Sie es selbst anwenden, bevor Sie versuchen, es jemand anderem beizubringen.

Wählen Sie Ihr Format

Darüber hinaus ist das endgültige Format eines Dokuments ebenso wichtig. Wird es nur gedruckt 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 rund um die Uhr Zugriff auf Smartphones, Computer oder Tablets und sind daran gewöhnt, alles zu finden, was sie wissen möchten, wann immer sie es wissen möchten. Durch die Online-Stellung von Benutzerressourcen haben sie Zugriff, wo immer sie sich befinden, was bedeutet, dass sie nicht in Schubladen oder Aktenschränken 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 wird für die meisten Menschen funktionieren, aber sind Sie bereit, eine Braille-Version für blinde oder sehbehinderte Benutzer zu erstellen? Was ist mit Benutzern mit einer körperlichen Behinderung, bei denen es für sie schwierig ist, Objekte mit ihren Händen zu manipulieren?

Es gibt Tools, die den Zugang zu elektronischer Dokumentation für alle erleichtern, aber nur gedruckte Versionen stellen ein viel schwierigeres Problem der Zugänglichkeit dar.

Außerdem ist die elektronische Dokumentation viel einfacher zu aktualisieren, da sie im Internet lebt.

Soll ich meine Dokumentation als PDF erstellen?

Wenn Sie eine herunterladbare PDF-Version Ihrer Dokumentation anbieten möchten, ist das in Ordnung. Stellen Sie jedoch sicher, dass es auf Ihrer Website auch in einem Nicht-PDF-Format verfügbar ist.

Schritt 2: Erstellen Sie Ihr Benutzerdokument

Nachdem Sie alle Fragen beantwortet und alle oben beschriebenen Entscheidungen getroffen haben, ist es an der Zeit, Ihre Benutzerdokumentation zu erstellen. Ich werde nicht anmaßen, Ihnen zu sagen, wie Sie die Dokumentation für Ihr spezifisches Produkt GENAU erstellen, aber es gibt einige wichtige Dinge, die Sie beachten sollten.

• Vermeiden Sie Jargon und hochtechnische Begriffe, es sei denn, es ist absolut notwendig (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 über einen Unternehmens-Styleguide verfügt, verwenden Sie diesen.
• Gehen Sie nicht davon aus, dass der Benutzer etwas über Ihr Produkt oder dessen Funktionsweise weiß. ZEIGEN Sie ihnen, was sie wissen müssen, um erfolgreich zu sein.
• Denken Sie daran, eine einfache Sprache zu verwenden. Schreiben Sie für eine achte Klasse oder darunter. Auch für fortgeschrittene Leser führt eine einfache Sprache zu einer schnelleren Verarbeitung und einem besseren Verständnis.
• Das Design sollte ansprechend und nicht einschüchternd sein und den Benutzer anziehen. Lassen Sie ihn Ihre Dokumentation verwenden WOLLEN.

Schritt 3: Testen Sie es

Ein Benutzerhandbuch ist nur dann großartig, wenn es Ihren Kunden hilft, Ihr Produkt optimal zu nutzen. Und Sie können das nicht wissen, bis jemand es benutzt. Bevor Ihre neue Kreation in die Welt hinausgeht, möchten Sie sie testen. Hier sind ein paar Tipps!

• Best Practice: Geben Sie es einer Gruppe echter Benutzer oder Betatester und sehen Sie, wie sie sich schlagen. Bauen Sie ihr Feedback in das fertige Dokument ein.
• Wenn Sie kein Benutzerfeedback für Betatests haben, testen Sie es intern, vorzugsweise mit Mitarbeitern, die am wenigsten mit dem Produkt vertraut sind.
• Erhalten Sie Feedback von den Entwicklern und Ingenieuren. Sie kennen das Produkt besser als jeder andere und können auf Dinge hinweisen, die Sie möglicherweise übersehen haben.

Schritt 4: Halten Sie Ihre Dokumentation auf dem neuesten Stand

Wenn sich Ihr Produkt ändert, müssen Sie die Benutzerdokumentation auf dem neuesten Stand halten. Wie oben erwähnt, bietet dies der elektronischen Dokumentation einen großen Vorteil gegenüber dem Druck. Aber auch nur gedruckte Dokumente können aktualisiert und auf Ihrer Website zum Download zur Verfügung gestellt werden.

Denken Sie daran, dass Ihre Inhalte nur dann großartig sind, wenn sie korrekt sind. 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 eine großartige Benutzerdokumentation so erstellt, gestaltet und präsentiert werden sollte, dass sie für Ihre Benutzer am hilfreichsten ist .

Geben Sie ihnen eine Dokumentation, die sie weiterhin begeistert und die Art von Kundenerlebnis bietet, die Sie sich wünschen.

Machen Sie Ihre Dokumentation zugänglich, nützlich und visuell.

Stellen Sie häufig Fragen