9 Tipps für eine tolle Benutzerdokumentation (mit Beispielen)

Die Benutzerdokumentation ist ein wichtiger Teil des Gesamtprodukts, das an Ihren Kunden geliefert wird. Es hilft Endbenutzern, mit Ihrem Produkt oder Ihrer Dienstleistung erfolgreicher zu sein.

In der Vergangenheit wurde die Benutzerdokumentation über eine Hilfedatei bereitgestellt, die sich lokal auf dem Computer des Benutzers befand, oder über ein physisches Handbuch oder eine Broschüre. Dies bedeutete, dass es nicht einfach aktualisiert oder geändert werden konnte und dass Softwareanbieter nur sehr wenige Daten darüber erhielten, wie ihre Inhalte verwendet wurden.

Heutzutage wird die Benutzerdokumentation fast immer online angeboten, was den technischen Redakteuren geholfen hat, den Benutzern einfallsreicher zu helfen. Sie können Daten sammeln, verschiedene Lerntechniken ausprobieren, schneller iterieren und ein reichhaltigeres Inhaltserlebnis für Benutzer schaffen.

Hier kommt dieser Blogbeitrag ins Spiel! ich

In diesem Beitrag untersuchen wir, was Sie tun können, um Ihre Benutzerdokumentation zu verbessern, und sehen uns einige Beispiele für hervorragende Benutzerunterstützungsinhalte an.

Beginnen Sie mit einem Plan

Wie bei den meisten Dingen im Leben ist es am besten, mit einem Plan zu beginnen, und das Erstellen von Benutzerdokumentationen ist nicht anders. Aus diesem Grund sollten Sie sich (und möglicherweise denen, die die Dokumentation anfordern) viele Fragen stellen, bevor Sie beginnen.

1. Betrachten Sie Ihr Publikum

Für wen machst du das? Der Endbenutzer? Ein Systemadministrator? Werden diese Inhalte nur intern überprüft oder auch extern gesehen? Für wen Sie die Benutzerdokumentation erstellen, hilft bei der Gestaltung der von Ihnen geteilten Informationen.

2. Bewerten und behalten Sie Ihr Endziel im Auge

Der Hauptzweck jeder Dokumentation besteht darin, Ihrem Publikum etwas beizubringen. Nachdem Sie bestimmt haben, wer Ihre Dokumentation verwenden wird, sollten Sie entscheiden, was sie davon haben sollen.

Welche Aktion soll Ihr Publikum ausführen können, nachdem es die Dokumentation gelesen hat? Indem Sie die Antwort auf diese Frage im Hinterkopf behalten, können Sie die richtige Menge an Inhalten für die betreffende Aufgabe bereitstellen.

3. Stellen Sie sicher, dass Ihre Benutzerdokumentation leicht auffindbar ist

Versteckte Benutzerdokumentation ist fast so nutzlos wie schlechte Benutzerdokumentation. Es ist wichtig sicherzustellen, dass die von Ihnen erstellte Benutzerdokumentation für diejenigen, die sie benötigen, leicht auffindbar ist.

Das bedeutet nicht nur, dass sie sichtbar ist, sondern auch, dass Benutzer in Ihrer technischen Dokumentation navigieren und schnell Antworten auf ihre Fragen finden können.

Je schneller Ihr Publikum diese Antworten finden kann, desto glücklicher wird es sein. Es erspart Ihnen auch Zeit, wichtige, aber häufig gestellte Fragen zu Ihrem Produkt zu beantworten.

Prägnanter, starker Schreibstil

Starkes Schreiben ist für eine großartige Benutzerdokumentation unerlässlich. Aber das Schreiben wirkt sich auf mehr aus als darauf, wie sich die Benutzerdokumentation liest oder anhört. Es kann auch beeinflussen, wie einfach es ist, in Ihrer Benutzerdokumentation zu navigieren.

4. Schreiben Sie aussagekräftige Titel und Untertitel

Stellen Sie sicher, dass Ihre Titel nützlich und vor allem spezifisch sind. Das Schreiben von Titeln oder Untertiteln, die formuliert sind, um eine Frage zu beantworten, ist oft am besten. Titel auf diese Weise einzurahmen, macht es Ihren Endbenutzern leichter, das zu finden, wonach sie suchen, und hilft Ihnen auch dabei, Artikel zu schreiben, die die Bedürfnisse der Benutzer direkt ansprechen.

Unbounce leistet fantastische Arbeit beim Schreiben effektiver Titel und Untertitel in der gesamten Benutzerdokumentation. Dies erleichtert die Navigation in der Dokumentation. Jeder spezifische Artikel hat sein eigenes Inhaltsverzeichnis, was das Finden der Antwort auf eine bestimmte Frage zum Kinderspiel macht.

5. Erleichtern Sie das Durchsuchen

Die Bereitstellung von Informationen auf eine Weise, die einfach zu scannen ist, hilft Benutzern, Zeit zu sparen. Als Menschen schätzen wir jede Zeitersparnis, die wir bekommen können. Außerdem wissen Benutzer möglicherweise nicht genau, wonach sie suchen. Dann ist einfach zu durchsuchender Inhalt am vorteilhaftesten.

IBM macht gute Arbeit, indem es ihre Hilfeinhalte leicht durchsuchbar macht, indem sie ein übersichtliches Inhaltsverzeichnis organisiert und verwandte Themen bereitstellt.

6. Machen Sie es leicht durchsuchbar

Google hat uns beigebracht, dass das Finden der Antworten auf unsere Fragen so einfach ist wie das Eingeben in ein Suchfeld. Ihre Hilfedokumentation sollte diese Erwartung widerspiegeln. Wenn Ihr Hilfeinhalt nicht durchsuchbar ist, ist er wahrscheinlich nicht sehr hilfreich.

Die umfassende Wissensdatenbank von Hubspot macht den Self-Service für seine Kunden einfach.

Verwenden Sie Visuals, um das Verständnis zu verbessern

Eine gute Benutzerdokumentation ist sehr visuell. Während starkes Schreiben und Text für eine hervorragende Benutzerdokumentation unerlässlich sind, lernen Menschen am besten, wenn auch visuelle Elemente vorhanden sind.

7. Verwenden Sie kommentierte Screenshots

Kommentierte Screenshots sind aussagekräftige visuelle Elemente, die in der Benutzerdokumentation verwendet werden können. Sie beseitigen das Rätselraten für Benutzer, indem sie genau zeigen, welche Schritte sie unternehmen müssen.

Mit Programmen wie TechSmith Snagit ist es einfach, Textlegenden, Pfeile und mehr zu Screenshots hinzuzufügen. Sie werden beispielsweise feststellen, dass ich in diesem Blog-Beitrag kommentierte Screenshots verwende, die ich mit Snagit erstellt habe.

Wenn Sie sich inspiriert fühlen, können Sie sogar das Step-Tool von Snagit ausprobieren, mit dem Sie Teile eines Bildes identifizieren können, indem Sie beim Zeigen und Klicken geordnete Callouts platzieren. Jedes Mal, wenn Sie klicken, um einen weiteren Schritt hinzuzufügen, wird die Zahl automatisch erhöht.

Ein Unternehmen, das die Kraft von Screenshots in seiner Dokumentation wunderbar nutzt, ist Asana. In ihrer großartigen Benutzerdokumentation verwenden sie kommentierte Screenshots, um Kunden klar zu führen.

8. Nutzen Sie das Video, um es zu zeigen, nicht zu erzählen

Video eignet sich gut, um einen Prozess zu demonstrieren. Viele großartige Benutzerdokumentationen kombinieren die Leistungsfähigkeit von Videos mit Textanweisungen. Beispielsweise ist es eine gute Praxis, ein kurzes Video zu verwenden, um schnell durch einen Prozess zu gehen.

Dann können Sie neben dem Video eine Schritt-für-Schritt-Anleitung in Textform bereitstellen, auf die sich die Benutzer beziehen können, wenn sie den Prozess selbst ausprobieren. Auf diese Weise müssen sie das Video nicht immer wieder ansehen, wenn sie nur eine kurze Erinnerung benötigen.

In unseren TechSmith-Produkt-Tutorials verwenden wir ein Hauptvideo, um einen vollständigen Überblick über die Funktion oder das Thema zu geben, das wir besprechen. Dann stellen wir unter dem Video Snippets bereit, begleitet von Screenshots oder animierten GIFs, um die Hauptpunkte des Videos zu wiederholen.

9. Zeigen Sie Beispiele und Endergebnisse

Benutzer müssen wissen, wie das erfolgreiche Abschließen jeder Aufgabe aussieht. Die Bereitstellung eines Screenshots eines beispielhaften Endergebnisses für Benutzer ist eine gute Möglichkeit, Ihrem Publikum das ideale Ergebnis zu demonstrieren.

Eine hervorragende Benutzerdokumentation macht es Endbenutzern leicht, Antworten auf ihre Fragen zu finden, was zu glücklichen, zufriedenen Benutzern führt.

Ein wesentlicher Bestandteil der Erstellung einer großartigen Benutzerdokumentation ist die Bereitstellung klarer, leicht durchsuchbarer Informationen. Visuals wie Screenshots, Videos oder animierte GIFs sind großartige Möglichkeiten, um effizienter und effektiver mit Ihren Benutzern zu kommunizieren.