15 Best Practices für Produktdokumentation, die Ergebnisse liefern

Dieser Fauxpas lehrte mich, dass ich unser Produkt durch die Augen der Kunden betrachten muss. Dann ging mir sprichwörtlich ein Licht auf. Wenn ich ein Produkt liefere, das die Schmerzpunkte der Kunden adressiert und es mit professioneller Produktdokumentation unterstütze, haben wir einen Gewinner.

Ich entdeckte auch, dass die Erstellung professioneller, ansprechender und leicht lesbarer Produktdokumentation keine einfache Aufgabe ist. Doch richtig umgesetzt kann Produktdokumentation zufriedene Kunden begeistern und letztendlich den Umsatz steigern.

Was sind die besten Praktiken für die Erstellung professioneller Produktdokumentation?¶

Diese Best Practices schaffen ansprechende, informative und benutzerfreundliche Produktdokumentation. Die Befolgung dieser Richtlinien hilft Ihnen, Dokumentation zu liefern, die aus guten Kunden großartige Kunden macht. Großartige Kunden helfen Unternehmen, ihren Umsatz zu steigern, wobei die Produktdokumentation ein wesentlicher Bestandteil der Kundenerfahrung ist.

1. Verstehen Sie Ihre Zielgruppe und geben Sie ihnen, was sie wollen¶

Es ist wichtig, die Erwartungen Ihrer Zielgruppe zu kennen. Ist die Produktdokumentation beispielsweise für Administratoren oder Endbenutzer gedacht? Der Umfang Ihrer Zielgruppe kann erfordern, dass Sie technisch für Administratoren schreiben oder klar definierte Begriffe und Anweisungen für den Endbenutzer formulieren.

Eine bewährte Praxis bei der Erstellung professioneller Produktdokumentation ist das Verständnis der Kundenerwartungen auf Administrator- oder Endbenutzerebene. Einige Methoden zur Erfassung von Informationen über die Zielgruppe sind:

• Fragebögen und Umfragen

• Feedback zur wahrgenommenen Zielgruppe

• Unternehmensbrainstorming

• Feedback zu gängigen Kundenmeinungen

• Kundendiskussionsrunden

2. Erstellen Sie einen Dokumentationsplan als Best Practice¶

Ein Dokumentationsplan hilft, potenzielle Engpässe während der Projektumsetzung zu erkennen. Die Erstellung von Produktdokumentation kann herausfordernd sein, und ein Dokumentationsplan hilft, Probleme vorherzusehen, die während des Dokumentationsprozesses auftreten können.

Zu den Vorteilen eines Dokumentationsplans gehören:

• Umsetzbare Maßnahmen - Prüfung vorhandener Dokumentation, um anwendbare Informationen zu verwenden, die im neuen Produktdokumentationsplan wiederverwendet werden können.

• Beachtung von Vorlagen und Stilrichtlinien - Bei Dokumentation für ein neues Produkt, stellen Sie sicher, dass es im Stil der Branche bleibt. Bei bestehenden Produkten, halten Sie sich an aktuelle Stilrichtlinien und Vorlagen, um die Kontinuität der Marke zu gewährleisten.

• Dokumentation der Prozesswerkzeuge - Dokumentationswerkzeuge können den Produktdokumentationsprozess definieren und optimieren und gleichzeitig die Kontinuität der Teamarbeit und ein besseres Verständnis des Dokumentationsentwicklungsprozesses sicherstellen.

3. Vereinfachen Sie die Produktdokumentation als Best Practice¶

Eine Studie aus dem Jahr 2016 untersuchte, wie viele Benutzer die Produktdokumentation lesen. Die Ergebnisse waren aufschlussreich: Nur 25% der Benutzer lesen die Produktdokumentation nicht. Die Umfrage ergab, dass Endbenutzer aus folgenden Gründen die Produktdokumentation nicht lesen:

• Benutzer sind ungeduldig - Mit dem Aufkommen sofortiger Informationen im Web werden Benutzer typischerweise ungeduldiger bei der Suche nach Antworten. Das Lesen von Produktdokumentation online oder offline kann aufgrund der umfangreichen Informationen mühsam sein.

• Übersprung-Syndrom - Benutzer überspringen oft notwendige Produktdokumentation und gehen direkt zu den Grundlagen der Produktnutzung über. Benutzer lernen und verstehen, wie Produkte funktionieren, eher durch Interaktion als durch detaillierte Anleitungen. Anweisungen müssen daher so klar und informativ wie möglich sein.

• Verwirrende Struktur und Aufbau - Handbücher sind oft in einem schwer verständlichen Format geschrieben. Viele Benutzer finden die Produktdokumentation verwirrend oder irrelevant für ihre Frage, werden frustriert und lesen nicht weiter. Oft hat das Unternehmen keine gründliche Zielgruppenforschung durchgeführt und die Bedürfnisse der Benutzer nicht richtig verstanden.

4. Fügen Sie Screenshots und grafische Informationen ein¶

Betrachten Sie Produktdokumentation als Fahrplan, der eine Geschichte über ein Produkt erzählt. Führen Sie den Kunden auf einem Weg, der leicht mit Screenshots oder anderen Grafiken zu identifizieren ist. Erklären Sie, was der Benutzer sieht oder was passiert, wenn eine Funktion aktiviert wird, und was als nächstes zu erwarten ist. Stellen Sie sicher, dass jede Grafik zweckmäßig ist und der Arbeitsablauf des Produkts harmonisch funktioniert.

5. Verwenden Sie Querverweise für ein besseres Verständnis der Themen¶

Ich habe Querverweise beim Lesen von Produktdokumentation als unschätzbar wertvoll empfunden. Das Verständnis einer Funktion oder eines Prozesses wird erheblich verbessert, wenn auf ein verwandtes Thema verwiesen wird. Durch die Querverknüpfung zugehöriger Datenpunkte wird das Gesamtbild der Systeminteraktion und des Workflows deutlicher.

6. Denken Sie an das KISS-Prinzip für die Produktdokumentation¶

Denken Sie daran, das KISS-Prinzip (Keep It Simple, Stupid) bei der Erstellung von Dokumentation anzuwenden. Es ist wichtig, den Prozess gründlich zu dokumentieren, aber nicht bis zum Übermaß. Der Dokumentationsbenutzer sucht möglicherweise nach bestimmten Informationen, daher ermöglicht die Einhaltung des KISS-Prinzips eine einfachere Navigation und ein besseres Verständnis der Dokumentation.

Zum Beispiel können einfache Notizen ausreichen, um eine Funktion zu erklären, vielleicht mit einem Verweis (Querverweis) auf das Hauptthema. Halten Sie die Fakten klar und nicht übertrieben, damit der Benutzer leicht relevante Informationen finden kann. Nicht jeder möchte jeden Aspekt des Produkts lesen.

7. Berücksichtigen Sie verschiedene Lernstile¶

Jede Person hat einen anderen Lernstil. Einige bevorzugen ausführliche Beschreibungen, während andere Grafiken und visuelle Darstellungen vorziehen. Manche Benutzer lernen mehr durch praktische Beteiligung als durch konzentriertes Lesen.

Berücksichtigen Sie alle Lernstile bei der Erstellung effektiver und informativer Produktdokumentation. Das Einfügen von Grafiken wie Screenshots, Diagrammen, strukturiertem Text oder Videolinks hilft sicherzustellen, dass alle Lernstile die Produktdokumentation verstehen können.

8. Personalisieren und strukturieren Sie Onboarding-Inhalte¶

Personalisieren Sie die Produktdokumentation basierend auf der Rolle der Zielgruppe. Erstellen Sie verschiedene Versionen der Dokumentation für die verschiedenen Rollen der Zielgruppe beim Onboarding der Inhalte. Die Fragen eines Administrators sind möglicherweise nicht relevant für die Fragen eines Power-Users zur Dokumentation.

Die Dokumentation kann eine Ebene der Personalisierung einführen, indem leicht unterschiedliche Versionen des Dokuments erstellt werden, die gezielter auf die Rolle der Zielgruppe ausgerichtet sind. Die Anpassung der Onboarding-Inhalte basierend auf der Rolle der Zielgruppe verleiht der Dokumentation ein Element der Personalisierung.

9. Definieren Sie Begriffe klar für bestimmte Zielgruppen¶

Je nach Zielgruppe ist es eine gute Praxis, die Bedeutung jedes in der Dokumentation verwendeten Begriffs zu erklären. Bei internen Zielgruppen können Sie komplexere Begriffe mit einiger Erläuterung verwenden. Wenn jedoch externe Benutzer auf die Dokumentation zugreifen, gibt es keine Möglichkeit, den Kenntnisstand der Benutzer zu kennen.

Eine klare Definition einzigartiger oder komplexer Begriffe schafft eine bessere und effizientere Kommunikation für alle internen Stakeholder und externen Benutzer.

10. Bieten Sie eine Methode zur Sammlung von Benutzerfeedback¶

Feedback zur Dokumentation liefert wertvolle Informationen zur Wirksamkeit des Dokuments. Stellen Sie einen Link oder einen einfachen Button mit "Gefällt mir/Gefällt mir nicht" bereit, um wertvolle Informationen über die Qualität der Dokumentation zu sammeln. Durch das Sammeln von Benutzerfeedback kann die Dokumentation verfeinert und verbessert werden.

11. Vermeiden Sie Dokumentation mit flacher Struktur¶

Achten Sie bei der Erstellung von Produktdokumentation darauf, dass die Dokumentation nicht als "flache Struktur" geschrieben wird. Das Lesen eines Dokuments voller flachen Textes ist mühsam und kann langweilig werden. Das Interesse des Lesers an der Dokumentation wird gesteigert, wenn die Informationen relevant zum besprochenen Thema sind und schnell erfasst werden können.

Lockern Sie den kontinuierlichen, flachen Text auf, indem Sie ausgewählte Informationen hervorheben oder Videos, Bilder, Links und andere Methoden integrieren, um eine bessere Benutzererfahrung zu bieten. Die Bereitstellung von Dokumentinhalten in "häppchengroßen" Abschnitten sorgt für ein angenehmeres Leseerlebnis und macht den Leser weniger abgeneigt, die Dokumentation zu lesen.

12. Erstellen Sie SEO-freundliche Dokumentation¶

Eine bewährte Praxis für Online-Produktdokumentation ist, sicherzustellen, dass sie in einem Stil geschrieben ist, der SEO-freundlich ist. Stellen Sie sicher, dass die Dokumentation so geschrieben ist, dass die Suchergebnisse im Internet für Ihre Dokumentation maximiert werden. Kunden müssen möglicherweise nach ihrer Dokumentation suchen, und wenn sie nicht über den expliziten Link zur Hosting-Seite verfügen, sind die Antworten bei der Eingabe von Suchbegriffen schneller und präziser, wenn sie SEO-freundlich sind.

13. Halten Sie die Produktdokumentation aktuell¶

Die Wartung der Produktdokumentation ist entscheidend, vor allem, wenn sie online zugänglich ist. Oft ändern sich die Anforderungen eines Produkts, und die Online-Dokumentation muss alle neuen Änderungen oder Updates widerspiegeln. Die Benutzerdokumentation muss aktuell und für alle neuesten Updates aktualisiert sein, und der Kunde muss über Änderungen in der Produktdokumentation informiert werden.

14. Verstehen Sie, dass Benutzer die Produktdokumentation möglicherweise nicht lesen¶

Eine Studie aus dem Jahr 2014 ergab, dass Benutzer die Produktdokumentation nicht vollständig lesen. Die Hauptgründe für das Nichtlesen der Dokumentation waren:

• Produktdokumentation war zu komplex

• Dokumentation hat ihre Fragen nicht direkt beantwortet

• Benutzer nutzten viele Produktfunktionen nicht, weil sie die Dokumentation nicht lasen

• Viele Benutzer bevorzugten "praktisches Lernen" statt Dokumentation zu lesen

15. Verwalten Sie sowohl dynamische als auch statische Inhalte¶

Produktdokumentation entwickelt sich kontinuierlich weiter mit Updates, neuen Funktionen, korrigierten Inhalten, aktualisierten Wartungshinweisen und anderen Elementen. Diese Aktualisierung wird als lebendes, atmendes Dokument betrachtet, das sich kontinuierlich an die Anforderungen des Produkts anpasst.

Statische Inhalte bieten dem Benutzer Daten, die sich über die Lebensdauer des Produkts nicht ändern. Statische Inhalte sollen Benutzern, insbesondere neuen Benutzern, Informationen liefern, die über den Lebenszyklus des Produkts hinweg statisch bleiben. Statische Inhalte sind wichtig für umfassende Dokumentation, treten aber typischerweise hinter dynamische Dokumentation zurück.

Die Pflege der Dokumentation ist einfacher, wenn Inhalte als dynamisch oder statisch klassifiziert werden. Die Dokumentation des Produktlebenszyklus kann einfacher implementiert und validiert werden, wenn die Dokumentation als dynamisch oder statisch kategorisiert wird. Es können geringfügige Änderungen in der Dokumentation für neue Funktionsupdates (statisch) oder detaillierte Produktupdates (dynamisch) vorgenommen werden.

16. Best Practices für die Verfügbarkeit von Produktdokumentation¶

Obwohl Benutzer nicht unbedingt viel Produktdokumentation lesen, wollen sie sie sofort verfügbar haben, wenn sie sie brauchen. Die traditionelle Bereitstellungsmethode für Dokumentation war ein gedrucktes Handbuch, das mit dem Produkt mitgeliefert wurde. In der heutigen digitalen, Online-Welt wird Dokumentation jedoch oft über das Web bereitgestellt.

Unabhängig davon, wie Produktdokumentation bereitgestellt wird, ist es wichtig, leicht zugängliche Zugriffspunkte zu haben. Die vorherrschenden Methoden zur Bereitstellung von Dokumentation heute sind:

• Offline-Dokumentation - Viele Produkte werden mit gedruckten Handbüchern oder "Quick Start"-Kurzanleitungen geliefert. Diese Dokumente sind in der Regel "Einmalprodukte" und nicht leicht zu verteilen. Viele Handbücher werden jedoch optional im PDF-Format angeboten, was die Portabilität fördert oder die Möglichkeit bietet, sie bei Bedarf auszudrucken.

• Online-Dokumentation - Jedes Mal, wenn Sie bei Google nach einer Antwort auf ein Problem suchen, greifen Sie wahrscheinlich auf einen Ausschnitt aus der Online-Dokumentation zu. Das Aufkommen des Webs hat den Druck von Handbüchern oder Produktdokumentationsmaterialien für Endbenutzer ersetzt. Einige der Vorteile der Online-Dokumentation sind:

• Telearbeit - Die Pandemie hat uns gelehrt, dass Arbeiten von zu Hause aus genauso produktiv sein kann wie im Büro, besonders wenn unsere Fragen mit Online-Dokumentation beantwortet werden.

• Zusammenarbeit - Mit einem leicht zugänglichen Online-Dokumentationsportal können Teammitglieder Informationen spontan teilen und Teamarbeit schaffen, was im Büro oft unmöglich ist.

• Mobilfreundlichkeit - Mobile Geräte wie iPads und Smartphones haben PCs für alltägliche Interaktionen langsam verdrängt. Sie können mit einem Smartphone leicht auf Online-Dokumentation zugreifen, und alle störenden Produktprobleme können recherchiert werden, sogar in Ihrem Lieblingscafé während der Mittagspause.