Benutzerhandbücher sind ein wichtiger Bestandteil der digitalen Dienstleistungserbringung. Digitale Kunden erwarten Zugang zur Selbstbedienung und verlangen sofortigen Zugang zu Informationen. Ein Rundgang am Telefon reicht einfach nicht mehr aus; stundenlanges Erklären von Dingen, die besser in Benutzerhandbüchern dargestellt werden können.
Wir bei Docsie plädieren dafür, dass alle Unternehmen eine Bibliothek mit informativen Benutzerhandbüchern für Kunden erstellen. Dies ermöglicht die Selbstbedienung, reduziert die Arbeitsbelastung des Supports und bietet 24/7 Echtzeit-Zugang zu den Informationen, die Ihre Kunden benötigen, um mit Ihrem Produkt oder Ihrer Dienstleistung zu arbeiten.
10 Top-Tipps für Benutzerhandbücher und Dokumentation in Docsie
Bevor wir beginnen, haben Sie eine Möglichkeit, Dokumentation zu speichern, zu schreiben und zu hosten?
Besuchen Sie die Seite Docsie Onboarding für eine kundenorientierte Zusammenarbeit, umfassende Einbettung, maßgeschneiderte Übersetzungen und eine leistungsstarke Veröffentlichung auf Knopfdruck.
Jetzt, wo Sie Mitglied im Club sind, kommen wir zu unseren 10 besten Tipps!
1 - Reichern Sie Ihre Benutzerhandbücher mit Medien an
Text, Wörter, Buchstaben - wir benutzen sie jeden Tag. Leider kann das geschriebene Wort nicht mit der Wahrhaftigkeit von Videos oder der Inspiration von Bildern mithalten.
Wenn Sie eine Benutzerdokumentation erstellen, sollten Sie sie aus der Sicht des Benutzers lesen. Könnte dieser Abschnitt besser in einem GIF, einem eingebetteten Video oder einem kommentierten Bild erklärt werden? Wenn ja, fügen Sie eines hinzu!
Sie können Bilder hinzufügen, Videos einbetten und iFrame-Inhalte in Docsie integrieren. Probieren Sie es aus!
2 - Erstellen Sie einen Befehl, nein, nicht die Jedi-Art!
Schritt-für-Schritt-Anleitungen sind die Säule aller Kochbücher! Wenn du ein Rezept befolgst, mischst du dann deine Eier mit deinem Mehl? Genau das solltest du tun, und du weißt das, weil du die Schritte befolgst!
Aber Spaß beiseite: Gehen Sie alle Bedienungsanleitungen mit Schritt-für-Schritt-Anweisungen durch. Wenn Sie diese Schritte befolgen, erhalten Sie dann tatsächlich das gewünschte Ergebnis? Eine ungenaue Anleitung, die nicht zum gewünschten Ergebnis führt, ist für Kunden ein großes Warnsignal. Genaue Anleitungen hingegen schaffen Vertrauen und bieten durch die Weitergabe von Informationen einen Mehrwert für Kunden und das Unternehmen.
Erstellen Sie einen Auftrag mit Hilfe der nummerierten Listen in Docsie oder mit Docsie Book Articles, um Ihre Dokumentation zu segmentieren.
3 - Anpassung an alle Lesestufen
Gehen Sie davon aus, dass Ihre Kunden ihr JavaScript aus Ihren Top-Tipps kennen? Die Verwendung von Jargon und komplexer Terminologie wird normalerweise in technischen Benutzerhandbüchern empfohlen. Für Laien gilt jedoch: Je einfacher die Sprache, desto besser!
Die meisten Leser wollen einfach nur wissen, wie man etwas macht, und es wiederholen. Ein Ansatz besteht darin, ein komplexes, hochrangiges Konzept auf Papier zu bringen - und es dann in einer vereinfachten Version für Laien zu wiederholen. Auf diese Weise werden technische Benutzer und Laien auf einmal angesprochen und zwei Seiten mit einem Stift eingefärbt.
"Künstliche Intelligenz ist die algorithmische Nachahmung menschlicher Intelligenz mit dem Ziel der Produktivität; künstliche Intelligenz zielt darauf ab, Arbeit zu erledigen, indem sie die menschliche Intelligenz mit Hilfe von Computercode nachahmt." - Beide Begriffe bedeuten das Gleiche, zielen aber auf unterschiedliche Zielgruppen ab.
Verwenden Sie Docsie, um Regale für Laien und Regale für technische Benutzer zu erstellen. Auf diese Weise können Sie Bücher für beide Zielgruppen bereitstellen, wobei das vollständige Hosting über das Docsie-Portal möglich ist.
4 - Verwenden Sie Vorlagen und bleiben Sie nicht mehr lange auf!
Schreiben Sie jede Gebrauchsanweisung von Grund auf neu? Stattdessen sollten Sie Vorlagen mit einer grundlegenden Strukturierung und Markenbotschaft erstellen und auf diesen Inhalten aufbauen.
Das Schreiben von Grund auf kostet Zeit und Mühe und birgt das Risiko von Inkonsistenzen, wenn mehrere Autoren am selben Projekt arbeiten. Vorlagen sind eine gute Möglichkeit, beim Schreiben Zeit zu sparen und die Konsistenz zwischen den Seiten zu verbessern. Vertrauen entsteht durch konsistente Botschaften und die Schaffung von Werten, was durch Vorlagen gefördert wird.
Klicken Sie auf ...Mehr und wählen Sie Templates in Docsie. Hier können Sie Vorlagen speichern und neue Bücher beginnen, indem Sie die Vorlage als Quelle verwenden!
5 - Schnell schreiben, oft iterieren
In der agilen Software-Entwicklung lautet das Mantra: "Fail fast and iterate often". Übertragen auf die Benutzerdokumentation bedeutet dies, dass Ihre Mitarbeiter versuchen sollten, schnell zu schreiben und häufig zu iterieren.
Das bedeutet nicht, dass die Qualität der Geschwindigkeit geopfert wird. Stattdessen ermöglicht dies Kundenfeedback und Antworten mit weniger anfänglichem Aufwand. Dieses Feedback kann in weiteren Iterationen der Benutzerdokumentation genutzt werden und hilft dem Unternehmen, sich stärker am Kunden zu orientieren.
Docsie Vocally verdeutlicht das Feedback der Leser mit Bewertungen und Bildschirmaufzeichnungen, um den genauen Inhalt zu ermitteln, den sie gelesen haben. Probieren Sie es aus, wenn Sie schnell schreiben und häufig iterieren!
6 - Verschachteltes Wissen mit internen Backlinks
Ist Ihre Benutzerhandbuch-Dokumentation mit anderen Seiten rückverlinkt? Indem Sie Links zu relevanten Abschnitten der Dokumentation hinzufügen, helfen Sie den Lesern, Ihr Produkt oder Ihre Dienstleistung auf einer konzeptionellen Ebene zu verstehen und zu vertiefen.
Wenn Sie auf ein bestimmtes Merkmal oder eine Funktion hinweisen, fügen Sie immer einen Link hinzu. Ermöglichen Sie dem Leser den schnellen Zugriff auf diese Informationen, anstatt ihn zu zwingen, die Seite selbst zu suchen und zu laden. Sie sprechen von Kontoanmeldungen? Fügen Sie dem Text "Loggen Sie sich in Ihr Konto ein" auf Ihrer Seite und jeder anderen Seite eine Anmelde-URL hinzu. Gestalten Sie Ihre Dokumentation so, dass sie bequem im Text navigiert werden kann, anstatt eine endlose Bibliothek zu durchforsten.
Mit Docsie können Autoren von Benutzerhandbüchern interne Backlinks erstellen. Markieren Sie einfach etwas Text und klicken Sie auf die Schaltfläche 🖇️ in der Symbolleiste des Docsie-Editors. Darüber hinaus können Sie Links sprach- und versionsunabhängig mit relativen Objektlinks erstellen.
7 - Entfernen Sie die Spinnweben und aktualisieren Sie alte Inhalte
Haben Sie alte Benutzerhandbücher und Dokumentationen online sichtbar? Wenn Sie eine Dokumentation zur Version 1.2 veröffentlicht haben, während Ihr Produkt auf Version 1.3 ist, ist Ihre Dokumentation nicht mehr aktuell. Anstatt für jede Version eine neue Dokumentation zu veröffentlichen, sollten Sie Docsie Versioning verwenden.
Docsie Versioning ermöglicht es den Benutzern, auf historische und aktuelle Dokumentationsversionen zuzugreifen. Wenn neue Versionen veröffentlicht werden, werden die alten Versionen aus Redundanzgründen archiviert und sind über ein Dropdown-Menü zugänglich. Dies alles befindet sich auf derselben Webseite, was es den Benutzern erleichtert, die relevanten Informationen zu finden.
Wenn Ihr Leitfaden mit den besten Tipps für das Jahr 2021 auch 2022 noch veröffentlicht wird, sollten Sie ihn aktualisieren! Ändern Sie den Namen, aktualisieren Sie alle Zitate und Quellen mit den neuesten Forschungsergebnissen und überprüfen Sie, ob die Informationen noch relevant sind. Entrümpeln Sie die Spinnweben und sorgen Sie dafür, dass die Inhalte immer wieder neu verwendet werden können.
8 - Aufgaben verkleinern, in Stücken erledigen
Schreiben Sie beim Schreiben die gesamte Seite in einem Rutsch und ohne Vorplanung? Einiges davon ist eine persönliche Vorliebe der Autoren. Durch die Miniaturisierung von Aufgaben kann die Arbeit jedoch schneller und konzentrierter abgeschlossen werden.
Erstellen Sie eine einfache Struktur mit H1- und H2-Tags und kurzen Beschreibungen für jeden Abschnitt. Verwenden Sie diese beim Schreiben und nehmen Sie einzelne Abschnitte in Angriff, anstatt sich um die ganze Seite zu kümmern. Dies wird in der Schreibbranche als Gliederung bezeichnet. Die Gliederung bietet die Möglichkeit, vor Beginn des Schreibens mit den Redakteuren Rücksprache zu halten, und dient als Leitfaden für den Schreibprozess.
Erstellen Sie ein neues Buch in Docsie und fügen Sie einige grundlegende Überschriften und Text für eine Gliederung hinzu. Sie können über das Menü auf der rechten Seite auch Aufgaben hinzufügen, um die Arbeit in kleinere Stapel aufzuteilen, wenn mehrere Teammitglieder an den Inhalten arbeiten. Der Versionsverlauf bedeutet, dass Sie zurückgehen können, wenn ein Autor einen weniger guten Inhalt hinzufügt - perfekt, um schnell zu schreiben und häufig zu iterieren!
Kalender für Aufgabenzuweiser in Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)
9 - Ein Inhaltsverzeichnis für mehr Inhaltsleser
Bei komplexen und vielfältigen Benutzerhandbüchern kann eine Wand aus Text für die Leser einschüchternd wirken. Ein umfassendes Inhaltsverzeichnis kann hier Abhilfe schaffen. Dieses wird häufig in Enzyklopädien verwendet und hilft den Benutzern, relevante Informationen zu identifizieren und aufzurufen, während es gleichzeitig eine Struktur in die Umgebung eines Wissensportals bringt.
Docsie-Artikel, -Regale und -Arbeitsbereiche dienen der Erstellung eines Inhaltsverzeichnisses. Dieses wird automatisch auf der linken Seite Ihres Wissensportals angezeigt und bietet eine einfache Möglichkeit, durch Ihre Wissensdatenbank zu navigieren. Mit diesem Top-Tipp erledigt Docsie das für Sie!
10 - Beherrschen Sie Ihr Thema
Ist Ihr Autor ein Fachmann? Ist Ihr Autor einfallsreich und gut darin, Themen zu recherchieren, mit denen er vielleicht nicht vertraut ist? Trotz all dieser Tipps hängt die Qualität Ihrer Benutzerdokumentation letztlich vom Autor ab.
Je besser sie Ihr Produkt verstehen, desto genauer wird ihre Arbeit sein. Geben Sie den Autoren die Flexibilität, Ihr Produkt zu testen und zu erproben, da die Benutzer möglicherweise auf ähnliche Probleme stoßen. Noch besser ist es, wenn Sie Ihre Autoren gemeinsam mit Ihrem Vertriebsteam durch eine Produktdemo führen und ihnen praktische Erfahrungen mit der Vertriebspipeline und den darin enthaltenen Botschaften vermitteln. Auch dies fördert die Konsistenz und macht Ihre Autoren zu Benutzern. Nicht alle Autoren werden zu Anwendern, aber alle Anwender können durch praktisches Wissen zu guten Autoren werden.
Setzen Sie diese Tipps in Docsie in die Praxis um!
Vielen Dank, dass Sie unsere 10 besten Tipps für bessere Benutzerhandbücher gelesen haben. Wir laden Sie ein, diese Tipps auf Ihre Docsie-Dokumente anzuwenden!
Docsie ist eine End-to-End-Plattform für das Dokumentationsmanagement, mit der Unternehmen webbasierte FAQs, Produktdokumentationen, Benutzerhandbücher, Hilfedokumente und Benutzerhandbücher erstellen können. Die Plattform bietet kundenorientierte Zusammenarbeit, umfassende Einbettung, maßgeschneiderte Übersetzungen und leistungsstarke Veröffentlichung auf Knopfdruck.
Entscheiden Sie sich noch heute für ein Onboarding mit Docsie und begeistern Sie Ihre Kunden mit Ihrer Dokumentation!