Die 15 besten Praktiken für die Dokumentation von Produktversionen

Dieser Fauxpas lehrte mich, dass ich unser Produkt durch das Prisma des Kunden betrachten muss. Dann ging der sprichwörtliche Lichtschalter "an". Wenn ich ein Produkt liefere, das die Probleme des Kunden angeht, und es dann mit einer professionellen Produktdokumentation unterstütze, haben wir einen Gewinner.

Und ich entdeckte auch, dass die Erstellung professioneller, ästhetisch ansprechender und leicht zu lesender Produktdokumentation keine leichte Aufgabe ist. Aber wenn sie richtig gemacht wird, kann die Produktdokumentation zufriedene Kunden in Verzückung versetzen und letztendlich den Umsatz steigern.

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

Diese Best Practices sorgen für eine ästhetisch ansprechende, informative und benutzerfreundliche Produktdokumentation. Wenn Sie diese Richtlinien befolgen, können Sie eine Produktdokumentation erstellen, die aus einem guten Kunden einen großartigen Kunden machen kann. Und großartige Kunden helfen Unternehmen letztendlich, ihre Umsätze zu steigern, wobei die Produktdokumentation ein wesentlicher Bestandteil der Kundenerfahrung ist.

1. Verstehen Sie Ihre Zielgruppe und geben Sie ihr, was sie will

Es ist wichtig, [die Erwartungen Ihrer Zielgruppe zu kennen] (https://www.stickyminds.com/article/writing-requirements-documentation-multiple-audiences). Ist die Produktdokumentation zum Beispiel für Administratoren oder für Endbenutzer bestimmt? Der Umfang Ihrer Zielgruppe kann es erforderlich machen, die Dokumentation technisch für Administratoren oder in klar definierten Begriffen und Anweisungen für Endbenutzer zu verfassen.

Ein bewährtes Verfahren zur Erstellung einer professionellen Produktdokumentation besteht darin, die Kundenerwartungen auf der Ebene der Administratoren oder Endbenutzer zu verstehen. Einige der Methoden, um Informationen über die Zielgruppe zu sammeln, sind:

• Fragebögen und Umfragen

• Wahrgenommenes Feedback der Zielgruppe

• Firmen-Brainstorming

• Feedback zu gängigen Kundenmeinungen

• Kundengespräche am runden Tisch

2. Erstellung eines Dokumentationsplans als Best Practice

Die Erstellung eines Dokumentationsplans kann dazu beitragen, mögliche Engpässe während der Projektdurchführung zu erkennen. Die Erstellung einer Produktdokumentation kann eine Herausforderung sein. Ein bewährtes Verfahren ist die Erstellung eines Dokumentationsplans, um Probleme, die während des Dokumentationsprozesses auftreten können, vorherzusehen.

Die Erstellung eines Dokumentationsplans bietet unter anderem die folgenden Vorteile:

Umsetzbare Punkte - Überprüfung der vorhandenen Dokumentation, um verwendbare Informationen zu finden, die im neuen Produktdokumentationsplan wiederverwendet werden können.

• Beachtung von Vorlagen und Styleguides - Wenn die Produktdokumentation für ein neues Produkt bestimmt ist, stellen Sie sicher, dass sie dem Sprachgebrauch und dem Stil der Branche entspricht, oder wenn die Dokumentation zu einem bestehenden Produkt gehört, behalten Sie die aktuellen Styleguides und Vorlagen bei, um die Kontinuität der Marke zu gewährleisten.

• Werkzeuge für den Dokumentationsprozess - Werkzeuge für den Dokumentationsprozess können den Produktdokumentationsprozess definieren und rationalisieren und gleichzeitig die Kontinuität der Teamarbeit und ein besseres Verständnis des Dokumentationsentwicklungsprozesses gewährleisten.

3. Vereinfachung der Produktdokumentation als Best Practice

Im Jahr 2016 wurde eine Studie durchgeführt, um festzustellen, wie viele Nutzer die Produktdokumentation lesen. Die Ergebnisse waren augenöffnend, denn es stellte sich heraus, dass nur 25 % der Benutzer die Produktdokumentation nicht lesen. Die Umfrage ergab, dass der Mangel an Endbenutzern, die die Produktdokumentation nicht lesen, zum Teil auf Folgendes zurückzuführen ist:

• Benutzer sind ungeduldig - Mit dem Aufkommen sofortiger Informationen über das Internet haben die Benutzer in der Regel weniger Geduld, um Antworten auf ihre Probleme zu finden. Das Lesen von Produktdokumentationen online oder offline kann aufgrund der großen Menge an Informationen, die für ein bestimmtes Produkt erforderlich sind, mühsam sein.

Skip-ahead-Syndrom - Benutzer überspringen oft die notwendige Produktdokumentation und gehen direkt zu den Grundlagen der Produktverwendung über. Die Benutzer lernen und verstehen die Funktionsweise von Produkten eher durch die Interaktion mit dem Produkt als durch das Lesen detaillierter Anleitungen. Anleitungen müssen so klar und informativ wie möglich sein.

Verwirrendes Layout und Struktur - Handbücher sind oft in einem Format geschrieben, das schwer zu verstehen und zu befolgen ist. Viele Benutzer empfinden die Produktdokumentation als verwirrend oder irrelevant für ihre Frage, was sie frustriert und davon abhält, die Anleitung zu lesen. Oft hat das Unternehmen keine detaillierte Publikumsforschung betrieben und nicht richtig verstanden, was der Benutzer braucht, und war zu verwirrt, um die Lektüre zu beenden.

4. Screenshots und grafische Informationen einbeziehen

Betrachten Sie die Produktdokumentation als eine Art Straßenkarte, die eine Geschichte über das Produkt erzählt. Führen Sie den Kunden auf einen Weg, der mit Screenshots oder anderen Grafiken (https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250) leicht nachvollziehbar ist, und zeigen Sie, wie die einzelnen Grafiken miteinander interagieren. Erklären Sie klar und deutlich, was der Benutzer sieht oder wann eine Funktion aktiviert wird, wie sie sich auf das Produkt auswirkt und was er als Nächstes erwartet. Vergewissern Sie sich, dass jede Grafik zweckmäßig ist und dass der Arbeitsablauf des Produkts mit den anderen zusammenarbeitet.

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

Ich habe festgestellt, dass [Querverweise beim Lesen der Produktdokumentation von unschätzbarem Wert sind] (https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingReST/Reference/Content/Links.html) Wenn man versteht, was ein Merkmal oder ein Funktionsprozess bewirkt, ist es sehr hilfreich, Querverweise zu einem zugehörigen Thema herzustellen. Darüber hinaus wird durch die Verknüpfung zugehöriger Datenpunkte das Gesamtbild hinsichtlich der Interaktion und des Arbeitsablaufs des Systems deutlicher.

6. Denken Sie bei der Produktdokumentation an das KISS-Prinzip.

Denken Sie daran, bei der Erstellung der Dokumentation das KISS-Prinzip (Keep It Simple, Stupid) anzuwenden. Es ist jedoch wichtig, den Prozess gründlich zu dokumentieren, aber nicht so weit, dass die Dokumentation zu umfangreich wird. Außerdem sucht der Benutzer der Dokumentation möglicherweise nach bestimmten Informationen zu bestimmten Punkten, so dass die Einhaltung des KISS-Prinzips die Navigation und das Verständnis der Dokumentation wesentlich erleichtert.

Zum Beispiel können einfache Notationen ausreichen, um eine Funktion zu erklären, vielleicht mit einem Verweis (Querverweis) auf das Hauptthema. Halten Sie die Fakten übersichtlich und nicht übertrieben, damit der Benutzer leicht nach den für ihn relevanten Informationen suchen kann. Sie sind vielleicht nicht daran interessiert, jeden Aspekt des Produkts zu lesen.

7. Berücksichtigen Sie unterschiedliche Lernstile

Jeder Mensch hat einen unterschiedlichen Lernstil. Einige bevorzugen ausführliche Beschreibungen, während andere vielleicht Grafiken und visuelle Darstellungen bevorzugen. Manche Nutzer lernen jedoch eher durch praktische Mitarbeit als durch konzentriertes Lesen.

Achten Sie bei der Erstellung einer effektiven und informativen Produktdokumentation darauf, dass alle Lernstile berücksichtigt werden. Das Einfügen von Grafiken wie Screenshots, Diagrammen, strukturiertem Text oder Videolinks trägt dazu bei, dass alle Lerntypen die Produktdokumentation verstehen.

8. Personalisieren und strukturieren Sie Onboarding-Inhalte

Personalisieren Sie die Produktdokumentation auf der Grundlage der Rolle der Zielgruppe (https://www.deanhouston.com/news/knowing-audience-document-right-document/). Erstellen Sie verschiedene Versionen der Dokumentation, die auf den Rollen der Zielgruppe basieren, wenn Sie die Inhalte einführen. Zum Beispiel sind die Fragen eines Administrators 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 mehr auf die Rolle der vorgesehenen Zielgruppe ausgerichtet sind. Durch die Anpassung des Onboarding-Inhalts an die Rolle der Zielgruppe erhält die Dokumentation ein Element der Personalisierung.

9. Definieren Sie Begriffe für bestimmte Zielgruppen klar und deutlich

Je nach Zielgruppe empfiehlt es sich, die Bedeutung jedes in der Dokumentation verwendeten Begriffs zu erklären. Wenn es sich um ein internes Publikum handelt, können Sie kompliziertere Begriffe mit einer gewissen Klarstellung verwenden. Wenn jedoch externe Benutzer auf die Dokumentation zugreifen, gibt es keine Möglichkeit, das Fachwissen der Benutzer zu kennen.

Die klare Definition eindeutiger oder komplexer Begriffe ermöglicht eine bessere und effizientere Kommunikation für alle internen und externen Benutzer.

10. Bieten Sie eine Methode zur Sammlung von Benutzer-Feedback

Das Feedback zur Dokumentation liefert wichtige Informationen über die Wirksamkeit des Dokuments. Bieten Sie einen Link oder eine einfache Schaltfläche mit "Gefällt mir/Gefällt mir nicht", 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 eine flach strukturierte Dokumentation

Achten Sie bei der Erstellung der Produktdokumentation darauf, dass die Dokumentation nicht in einer "flachen Struktur" verfasst ist. Das Lesen eines Dokuments voller flacher Texte ist mühsam und kann auch ermüdend sein. Außerdem wird das Interesse des Lesers an der Dokumentation gesteigert, wenn die Informationen für das besprochene Thema relevant sind und der Leser sie schnell verinnerlichen kann.

Unterbrechen Sie den fließenden, flachen Text durch Hervorhebung ausgewählter Informationen oder durch die Integration von Videos, Bildern, Links und anderen Methoden, um eine bessere Benutzerfreundlichkeit zu erzielen. Wenn der Inhalt des Dokuments in "mundgerechten" Stücken geliefert wird, hat der Leser ein angenehmeres Erlebnis und ist weniger abgeneigt, die Dokumentation zu lesen.

12. Erstellen Sie eine Dokumentation, die SEO-freundlich ist

Ein bewährtes Verfahren für die Online-Produktdokumentation besteht darin, sicherzustellen, dass sie in einem Stil verfasst ist, der Dokumentation 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 den ausdrücklichen Link zur Hosting-Site haben, sind die Antworten schneller und präziser, wenn sie SEO-freundlich sind.

13. Halten Sie die Produktdokumentation auf dem neuesten Stand

Die Pflege der Produktdokumentation ist von entscheidender Bedeutung, vor allem, wenn der Zugriff online erfolgt. Oft ändern sich die Anforderungen an ein Produkt und die Online-Dokumentation muss alle neuen Änderungen oder Aktualisierungen widerspiegeln. Daher muss die Benutzerdokumentation auf dem neuesten Stand gehalten und bei neuen Aktualisierungen aktualisiert werden, um sicherzustellen, dass der Kunde über Änderungen in der Produktdokumentation informiert wird.

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

Eine 2014 durchgeführte Studie ergab, dass die Benutzer die Produktdokumentation nicht vollständig gelesen haben. Die Hauptgründe für das Nichtlesen der Dokumentation waren:

• Die Produktdokumentation war übermäßig komplex

• Die Dokumentation ging nicht direkt auf ihre Fragen ein

• Die Benutzer haben viele Funktionen des Produkts nicht genutzt, weil sie die Dokumentation nicht gelesen haben.

• Viele Benutzer zogen es vor, statt die Dokumentation zu lesen, "praktisch" zu lernen.

15. Verwalten Sie sowohl dynamische als auch statische Inhalte

Die Produktdokumentation wird ständig durch Aktualisierungen, neue Funktionen, korrigierte Inhalte, aktualisierte Wartungshinweise und andere Elemente erweitert. Diese Aktualisierung wird als ein lebendiges, atmendes Dokument betrachtet, das sich ständig an die Anforderungen des Produkts anpasst.

Statische Inhalte stellen dem Benutzer Daten zur Verfügung, die sich während der Lebensdauer des Produkts nicht ändern. Die Idee hinter statischen Inhalten ist es, den Benutzern, insbesondere neuen Benutzern, Informationen zur Verfügung zu stellen, die über den Lebenszyklus des Produkts hinweg statisch bleiben. Statische Inhalte sind für eine umfassende Dokumentation unerlässlich, treten aber in der Regel hinter der dynamischen Dokumentation zurück.

Die Pflege der Dokumentation ist einfacher, wenn der Inhalt [entweder als dynamisch oder statisch klassifiziert] wird (https://brainly.com/question/24688083). Die Dokumentation des Produktlebenszyklus lässt sich einfacher implementieren und validieren, wenn die Dokumentation als dynamisch oder statisch eingestuft wird. Bei Aktualisierungen neuer Funktionen (statisch) oder detaillierten Produktaktualisierungen (dynamisch) kann es zu geringfügigen Änderungen in der Dokumentation kommen.

16. Best Practices für die Verfügbarkeit der Produktdokumentation

Die Benutzer lesen zwar nicht unbedingt viel Produktdokumentation, aber wenn sie sie brauchen, wollen sie sie sofort haben. Traditionell wurde die Dokumentation in Form eines gedruckten Handbuchs mit dem Produkt mitgeschickt. In der digitalen Online-Welt von heute wird die Dokumentation jedoch häufig über das Internet bereitgestellt.

Unabhängig von der Art und Weise, wie die Produktdokumentation bereitgestellt wird, ist es wichtig, leicht zugängliche Zugangspunkte zu haben. Daher sind heute die vorherrschenden Methoden zur Bereitstellung der Dokumentation:

Offline-Dokumentation - Viele Produkte werden mit gedruckten Handbüchern oder "Schnellstart"-Kurzbeschreibungen ausgeliefert. Diese Dokumente sind in der Regel einmalig und lassen sich nicht ohne weiteres verteilen. Viele Handbücher werden jedoch optional in einem gekapselten PDF-Format zur Verfügung gestellt, was die Portabilität oder die Möglichkeit, sie bei Bedarf auszudrucken, fördert.

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 zurück. Das Aufkommen des Internets hat das Ausdrucken von Handbüchern oder Produktdokumentationen für die Endbenutzer verdrängt. Einige der Vorteile der Online-Dokumentation sind:

1. Telearbeit - Eine Sache, die uns die Pandemie gelehrt hat, ist, dass die Arbeit von zu Hause aus genauso produktiv sein kann wie im Büro, besonders wenn unsere Fragen mit Online-Dokumentation beantwortet werden.

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

3. Mobilfreundlichkeit - Das Aufkommen mobiler Geräte wie iPads und Smartphones hat den PC im täglichen Umgang langsam verdrängt. Mit einem Smartphone können Sie problemlos auf Online-Dokumentation zugreifen, und alle lästigen Produktprobleme lassen sich leicht recherchieren, sogar in Ihrem Lieblingscafé während der Mittagspause.