Ultimativer Leitfaden zur Produktdokumentation: Alles, was Sie wissen müssen, um großartige Dokumente zu erstellen

Produktdokumentation… es ist vielleicht nicht der reizvollste Teil der Führung eines Unternehmens, aber es ist ein Schlüsselbereich, den Sie nicht übersehen sollten, wenn Sie möchten, dass Ihr Unternehmen erfolgreich ist.

Das Erstellen einer hochwertigen Produktdokumentation kann Ihnen dabei helfen, Ihre Kunden erfolgreicher zu machen, Ihren Supportaufwand zu reduzieren und ganz allgemein ein besseres Geschäft aufzubauen.

Aber was gehört zur Erstellung der Produktdokumentation? Und wie können Sie Ihre eigene Dokumentation auf Ihrer Website einrichten?

Das sind nur einige der Fragen, die wir in unserem ultimativen Leitfaden zur Produktdokumentation beantworten. Hier ist alles, was wir behandeln werden:

• Warum Sie sich um Ihre Produktdokumentationsstrategie kümmern sollten
• Einige echte Beispiele für erstklassige Dokumentation
• Die beste Produktdokumentationssoftware
• Acht Tipps für eine bessere Dokumentation

Sind Sie bereit, die Handhabung der Dokumentation in Ihrem Unternehmen zu verbessern? Lassen Sie uns graben!

Warum Sie sich um Ihre Produktdokumentationsstrategie kümmern sollten

Beginnen wir mit einem Blick darauf, warum Sie bei Ihrer Produktdokumentationsstrategie nicht sparen sollten.

Es macht Ihre Kunden erfolgreicher

Der größte Vorteil der Erstellung von Produktdokumentationen besteht darin, dass Ihre Kunden erfolgreicher werden. Erfolgreichere Kunden zu haben bedeutet höhere Konversionsraten, niedrigere Abwanderungsraten und so weiter.

Es macht Sinn – wenn ein Kunde nicht herausfinden kann, wie er Wert aus Ihrem Produkt ziehen kann, wird er nicht sehr lange Kunde bleiben.

Die Produktdokumentation ist eine nützliche Möglichkeit, Kunden zu schulen, damit sie so viel Wert wie möglich erhalten. Wenn sie mehr Wert aus Ihrem Produkt ziehen, zahlen sie eher weiter, empfehlen Sie ihren Freunden/Kollegen und so weiter.

Es reduziert Ihre Support-Belastung

Die Produktdokumentation kann auch eine großartige Möglichkeit sein, die Belastung Ihrer menschlichen Supportkanäle zu verringern.

Wenn Ihre Produktdokumentation von geringer Qualität oder nicht vorhanden ist, bedeutet dies, dass Ihre Kunden sich bei jedem Problem an Ihr menschliches Support-Team wenden müssen. Das bedeutet mehr Zeit für die Beantwortung von Supportanfragen.

Sie müssen sich entweder Zeit nehmen, um Ihr Geschäft auszubauen, um diese Antworten selbst zu bearbeiten, oder Sie müssen einen engagierten Support-Mitarbeiter einstellen ( was Geld kostet ).

Mit einer qualitativ hochwertigen Dokumentation können Kunden viele ihrer Probleme selbst lösen, sodass sie sich nicht mehr an den Support wenden müssen. Sie können Ihre Support-Prozesse auch so strukturieren, dass die Leute dazu gebracht werden, Ihre Dokumentation zu überprüfen, bevor sie eine Anfrage stellen.

Es kann ein gutes Marketing- und Verkaufsinstrument sein

Während viele Menschen an Produktdokumentation denken, um Menschen zu helfen, die sich bereits für einen Kauf entschieden haben, kann eine gute Produktdokumentation Ihnen auch dabei helfen, mehr Kunden zu gewinnen und zu konvertieren.

Aus Marketingsicht ist die Produktdokumentation eine Goldgrube für Long-Tail-SEO-Keywords, nach denen Sie Ihre Dokumentation ordnen können. Sie werden vielleicht überrascht sein, wie viele Personen direkt auf Ihre Produktdokumentation von Google gelangen. Wenn Sie Ihre Dokumentation gut strukturieren, haben Sie die Chance, diese Leute zu Kunden zu machen.

Ihre Dokumentation kann auch ein nützliches Verkaufsinstrument für Personen sein, die beim Kauf Ihres Produkts unschlüssig sind. Die Produktdokumentation kann potenzielle Fragen vor dem Verkauf beantworten, sie davon überzeugen, dass Ihr Produkt das kann, was sie brauchen, und ihnen das Vertrauen geben, dass sie Hilfe bekommen, wenn sie sie brauchen.

Beispielsweise ist Stripe dafür bekannt, einige der besten Produktdokumentationen zu haben. Wenn Sie zu Twitter gehen, können Sie viele Leute sehen, die Stripe aufgrund der Qualität der Stripe-Dokumentation empfehlen:

Es macht Ihre Mitarbeiter effektiver

Die Produktdokumentation ist nicht nur für Kunden, sie kann auch eine wichtige Ressource für Ihre Teammitglieder sein, um mehr über Ihr Produkt zu erfahren und bei Bedarf nachzuschlagen. Dies gilt insbesondere für neue Mitarbeiter, die möglicherweise keine breite Wissensbasis über Ihr Produkt haben.

Vier großartige Beispiele für Produktdokumentationen aus der Praxis

Um Ihnen noch mehr Inspiration zu geben, sehen wir uns einige Beispiele aus der realen Produktdokumentation erfolgreicher Unternehmen an.

1. Streifen

Wir haben Stripe bereits als eines der besten Beispiele für Qualitätsdokumentation als Marketing-/Verkaufstool erwähnt, Sie wissen also, dass die Stripe-Dokumentation die Nummer eins auf unserer Liste sein musste.

2. Adyen

Adyen ist eine Zahlungsplattform für E-Commerce-, Mobil- und Point-of-Sale-Zahlungen. Wie bei Stripe bedeutet dies, dass Entwickler es in ihre eigenen Plattformen integrieren müssen, was eine hervorragende Dokumentation erfordert. Adyen enttäuscht nicht – sehen Sie sich hier die vollständige Adyen-Dokumentation an.

3. Twilio

Wenn Sie mit Twilio nicht vertraut sind, ist es ein Tool, das Unternehmen hilft, Kommunikation über Textnachrichten, E-Mails, Telefonanrufe und mehr in ihre Plattformen einzubauen. Wie bei Stripe und Adyen bedeutet dies, dass Unternehmen Twilio in ihre bestehenden Dienste integrieren müssen, was eine erstklassige Dokumentation erfordert. Sie können die Twilio-Dokumentation durchsuchen, um ein großartiges Beispiel zu sehen.

4. Locker

Slack ist ein weiteres Tool mit einer sehr gut geschriebenen und nützlichen Dokumentation. Sie können die vollständige Slack-Dokumentation hier durchsuchen.

Weitere Beispiele finden Sie in unserem vollständigen Beitrag zu den besten Beispielen für die Benutzerdokumentation.

Beste Produktdokumentationssoftware

Sehen wir uns nun an, wie Sie eine bessere Produktdokumentation auf Ihrer Website anbieten können.

Wir werden im nächsten Abschnitt über das eigentliche Schreiben Ihrer Dokumentation sprechen. Bevor Sie jedoch Ihre Dokumentation schreiben können, benötigen Sie einen Ort, an dem Sie diese Artikel speichern und Ihren Benutzern zugänglich machen können.

Sie können diese Artikel zwar einfach direkt zu Ihrer Website hinzufügen, es ist jedoch eine viel bessere Idee, eine spezielle Produktdokumentationssoftware zu verwenden. Abgesehen davon, dass Sie Ihre Inhalte organisieren und für Besucher zugänglich machen, enthält eine gute Produktdokumentationssoftware andere nützliche Funktionen wie …

• Ajax-Suchfunktionen, um Besuchern beim Durchsuchen der Dokumentation zu helfen.
• Suchen Sie Analysen, damit Sie sehen können, nach welchen Themen die Leute suchen.
• Nützlichkeitsdaten, damit Sie verfolgen können, wie hilfreich jeder einzelne Artikel ist, und bei Bedarf verbessern können.

Hier sind zwei der besten Lösungen…

Heroische Wissensdatenbank (Heroic KB)

Heroic Knowledge Base ist ein Plugin für die kostenlose Open-Source-WordPress-Software, mit der Sie ganz einfach Ihren eigenen selbst gehosteten Produktdokumentations-Hub erstellen können.

Wenn Sie WordPress bereits für die Website Ihres Unternehmens verwenden, können Sie Heroic Knowledge Base zu Ihrer Website hinzufügen, um Ihren eigenen Dokumentations-Hub zu erstellen. Wenn Sie dies nicht tun, können Sie eine dedizierte WordPress-Installation für Ihre Dokumentation erstellen. Im letzteren Fall könnte Sie auch das KnowAll WordPress-Dokumentationsthema interessieren.

Mit der Heroic Knowledge Base können Sie Ihre gesamte Dokumentation mit dem Inhaltseditor von WordPress hinzufügen, was das Einfügen von Multimedia-Inhalten bei Bedarf erleichtert. Sie erhalten auch Zugriff auf das integrierte Inhaltsversionierungssystem von WordPress, mit dem Sie Änderungen einfach nachverfolgen und frühere Versionen Ihrer Dokumentation vergleichen können.

Heroic Knowledge Base fügt auch eine Reihe nützlicher Funktionen hinzu, darunter:

• Sofortige Ajax-Suche.
• Suchanalyse.
• Bewertung der Nützlichkeit von Artikeln.
• Artikeldateianhänge.

Heroic Knowledge Base kostet nur 129 $.

Adobe RoboHelp

Wenn Sie Ihre Dokumentation nur im Web veröffentlichen, ist eine Lösung wie Heroic Knowledge Base alles, was Sie brauchen. Bei Dokumentationsanforderungen auf Unternehmensebene kann es jedoch Situationen geben, in denen Sie Ihre Dokumentation auf mehreren Plattformen veröffentlichen müssen, darunter das Internet, Papier, mobile Apps, PDFs usw.

In diesem Fall bevorzugen Sie möglicherweise ein plattformübergreifendes Dokumentationserstellungstool wie Adobe RoboHelp. Ab 29,99 $ pro Monat für die individuelle Nutzung ist es teurer als die Heroic Knowledge Base. Wenn Sie jedoch plattformübergreifendes Authoring benötigen, ist dieser zusätzliche Preis möglicherweise das Geld wert.

So optimieren Sie die Struktur und den Inhalt Ihrer Produktdokumentation

Nachdem Sie nun über die Software verfügen, die zum Verwalten Ihrer Dokumentation erforderlich ist, lassen Sie uns darüber sprechen, wie Sie qualitativ hochwertige Artikel schreiben können. Hier sind acht wichtige Tipps zur Strukturierung Ihrer Dokumentation und zum Schreiben besserer Hilfeartikel …

1. Verstehen Sie Ihr Publikum

Um eine großartige Produktdokumentation zu schreiben, müssen Sie die Zielgruppe verstehen, für die Sie schreiben (dh Ihre Kunden).

Für wen Sie schreiben, wird beeinflussen, welche Informationen Sie aufnehmen und wie Sie alles strukturieren. Wenn Sie beispielsweise für Entwickler schreiben, sollte sich Ihre Dokumentation grundlegend von der Dokumentation für gelegentliche Benutzer unterscheiden.

Sie möchten nicht davon ausgehen, dass Ihre Zuhörer Experten sind und wichtige Details beschönigen, aber Sie können einige Grundkenntnisse voraussetzen, je nachdem, wer sie sind.

2. Verstehen Sie die verschiedenen Arten von Produktdokumentationen

Es gibt verschiedene Arten von Produktdokumentationen und jede erfordert einen anderen Ansatz. Einige der häufigsten Typen sind:

• Übersichten – Diese Artikel bieten einen Überblick darüber, wie ein Bereich Ihres Produkts funktioniert, z. B. eine Anleitung „Erste Schritte“.
• Schritt-für-Schritt-Tutorials – diese Artikel zeigen Menschen, wie sie eine bestimmte Aufgabe ausführen.
• Referenz – Diese Artikel erläutern bestimmte Konzepte in Ihrem Produkt.
• Fehlerbehebung – In diesen Artikeln wird erläutert, wie häufige Probleme, auf die Kunden stoßen können, debuggt/behoben werden.

Die Art der Dokumentation, an der Sie arbeiten, sollte sich darauf auswirken, wie Sie schreiben und wie Sie Ihre Dokumentation strukturieren. Daher ist es wichtig, das Ziel zu kennen, bevor Sie sich einarbeiten.

3. Seien Sie konsistent in Ihrem Stil und Ihren Namenskonventionen

Um Ihren Kunden die Verwendung Ihrer Produktdokumentation zu erleichtern, ist es wichtig, dass Sie in Ihrer gesamten Dokumentation den gleichen Stil und die gleichen Namenskonventionen beibehalten. Dies erleichtert es den Kunden, Ihrer Dokumentation zu folgen und mögliche Verwirrung zu vermeiden.

Um Ihnen dabei zu helfen, könnte es hilfreich sein, einen Styleguide für grundlegende Formatierung und Terminologie zu erstellen.

4. Verwenden Sie eine einfache Sprache und bleiben Sie prägnant

Alle Dinge gleich, kurze, einfache Sprache ist immer besser als Wortsalat. Ihr Ziel sollte es sein, alle notwendigen Informationen in möglichst wenigen Worten zu kommunizieren.

Sie sollten auch möglichst keinen Fachjargon oder komplexe Begriffe verwenden. Nicht alle Ihre Kunden verfügen über die gleiche Wissensbasis und einige sind möglicherweise nicht einmal Muttersprachler der Sprache Ihrer Dokumentation. Wenn Sie die Dinge also so einfach wie möglich halten, stellen Sie sicher, dass jeder von Ihrer Dokumentation profitieren kann.

5. Organisieren Sie die Dokumentation in logischen, „problembezogenen“ Artikeln

Um es den Benutzern zu erleichtern, Ihre Dokumentation zu durchsuchen und Artikel zu ihren spezifischen Themen zu finden, müssen Sie Ihre Dokumentation in logische Segmente unterteilen. Im Allgemeinen sollte sich jeder Artikel auf die Lösung eines bestimmten Problems konzentrieren.

Natürlich kann es innerhalb dieses Hauptproblems mehrere Unterprobleme geben, aber die Idee ist, dass Sie nicht zwei völlig separate Probleme in denselben Artikel werfen möchten, da dies es den Leuten erschweren wird, nach diesen Themen und ihnen zu suchen könnten verwirrt sein, wenn sie auf dem Artikel landen.

Ihre Kunden werden Ihre Dokumentation nicht linear lesen, als würden sie ein Buch lesen. Stattdessen springen sie basierend auf dem Problem, auf das sie gerade stoßen, herum. Das Aufteilen Ihrer Artikel in logische Segmente hilft Ihnen, dieses Verhalten zu berücksichtigen.

6. Integrieren Sie Multimedia-Elemente

Während geschriebener Text den Kern Ihrer Produktdokumentation bilden sollte, sollte er nicht das Einzige sein. Es kann auch hilfreich sein, Bild- und Videoinhalte dort einzubinden, wo es sinnvoll ist.

Wenn Sie Screenshots hinzufügen, können Sie den Bildern auch Anmerkungen hinzufügen, um wichtige Details zu verdeutlichen.

7. Verwenden Sie Überschriften und fügen Sie ein Inhaltsverzeichnis hinzu

Verwenden Sie in einzelnen Produktdokumentationsartikeln Überschriften, um Ihre Artikel in logische Segmente zu unterteilen, anstatt nur eine lange Textwand zu schreiben.

Um die Navigation im Artikel zu erleichtern, können Sie auch ein Inhaltsverzeichnis hinzufügen, mit dem die Leser schnell zu einem bestimmten Abschnitt springen können.

Manche Produktdokumentationssoftware kann Ihnen dabei helfen, automatisch ein Inhaltsverzeichnis hinzuzufügen. Das Heroic Knowledge Base-Plugin verfügt beispielsweise über eine integrierte Funktion zum automatischen Generieren eines Inhaltsverzeichnisses basierend auf den Überschriften der einzelnen Artikel.

8. Verbessern und aktualisieren Sie Ihre Dokumentation immer

Schließlich ist es wichtig, sich daran zu erinnern, dass das Erstellen einer Produktdokumentation kein einmaliges Ereignis ist; es ist ein laufender Prozess.

Grundsätzlich wird Ihr Produkt wahrscheinlich Änderungen unterliegen, daher ist es wichtig, Ihre Dokumentation zu aktualisieren, um diese Änderungen und alle neuen Funktionen, die Sie hinzugefügt haben, zu berücksichtigen.

Darüber hinaus erhalten Sie, wenn Sie sich für eine Produktdokumentationssoftware wie Heroic Knowledge Base entscheiden, Zugriff auf Analysen, die Ihnen helfen zu verstehen, wie Menschen Ihre Dokumentation verwenden. Sie können diese Analysen verwenden, um:

1. Verfolgen Sie, wonach die Leute suchen, was ein Zeichen dafür sein kann, dass Sie eine Dokumentation zu diesen Themen erstellen müssen, falls Sie dies noch nicht getan haben.
2. Sehen Sie, welche Artikel den Benutzern nicht so gut helfen, wie Sie möchten. Dies könnte ein Zeichen dafür sein, dass Sie diese Artikel verbessern müssen, um ihre Nützlichkeit zu verbessern.

Beginnen Sie noch heute mit der Erstellung fantastischer Produktdokumentationen!

Die Erstellung hochwertiger Produktdokumentationen ist eine Investition in den langfristigen Erfolg Ihres Unternehmens. Es hilft Ihnen …

• Machen Sie Ihre Kunden erfolgreicher.
• Reduzieren Sie die Belastung Ihres Support-Teams.
• Gewinnen und konvertieren Sie von vornherein mehr Kunden.
• Verbessern Sie das Wissen Ihrer Mitarbeiter über Ihr Produkt.

In diesem Beitrag haben wir einige großartige Beispiele für Produktdokumentationen erfolgreicher Unternehmen zusammen mit einigen Tipps zum Schreiben und Strukturieren Ihrer Dokumentation geteilt.

Wenn Sie bereit sind, Ihren eigenen Produktdokumentations-Hub zu erstellen, können Sie das Heroic Knowledge Base-Plugin verwenden, um Ihre eigene selbst gehostete Lösung zu erstellen, die von WordPress unterstützt wird. Klicken Sie hier, um mehr über die heroische Wissensdatenbank zu erfahren.