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

Die Produktdokumentation ist vielleicht nicht der attraktivste Teil der Unternehmensführung, aber sie ist ein wichtiger Bereich, den Sie nicht übersehen sollten, wenn Sie mit Ihrem Unternehmen erfolgreich sein wollen.

Die Erstellung einer qualitativ hochwertigen Produktdokumentation kann dazu beitragen, den Erfolg Ihrer Kunden zu steigern, den Aufwand für den Support zu verringern und ganz allgemein Ihr Unternehmen zu verbessern.

Aber was gehört zur Erstellung einer 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 werden. Hier finden Sie alles, was wir behandeln werden:

• Warum Sie sich Gedanken über Ihre Produktdokumentationsstrategie machen sollten
• Einige echte Beispiele für erstklassige Dokumentation
• Die beste Produktdokumentationssoftware
• Acht Tipps für die Erstellung einer besseren Dokumentation

Sind Sie bereit, die Art und Weise zu verbessern, wie Ihr Unternehmen die Dokumentation handhabt? Legen Sie los!

Warum Sie sich Gedanken über Ihre Produktdokumentationsstrategie machen sollten

Lassen Sie uns zu Beginn einen Blick darauf werfen, warum Sie bei Ihrer Produktdokumentationsstrategie nicht knausern sollten.

Es macht Ihre Kunden erfolgreicher

Der größte Vorteil der Produktdokumentation besteht darin, dass sie Ihre Kunden erfolgreicher macht. Erfolgreichere Kunden bedeuten höhere Konversionsraten, niedrigere Abwanderungsraten und so weiter.

Das macht Sinn - wenn ein Kunde nicht herausfinden kann, wie er einen Nutzen aus Ihrem Produkt ziehen kann, wird er nicht sehr lange Kunde bleiben.

Die Produktdokumentation ist eine nützliche Methode, um die Kunden zu schulen, damit sie den größtmöglichen Nutzen aus Ihrem Produkt ziehen können. Wenn sie mehr Nutzen aus Ihrem Produkt ziehen, werden sie eher bereit sein, weiter zu zahlen, Sie ihren Freunden/Kollegen zu empfehlen und so weiter.

Es reduziert Ihre Support-Belastung

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

Wenn Ihre Produktdokumentation minderwertig oder gar nicht vorhanden ist, bedeutet das, dass sich Ihre Kunden bei jedem Problem an Ihr menschliches Supportteam wenden müssen. Das bedeutet mehr Zeit für die Beantwortung von Supportanfragen.

Entweder müssen Sie sich von der Entwicklung Ihres Unternehmens abkoppeln, um sich selbst um diese Antworten zu kümmern, oder Sie müssen einen speziellen Support-Mitarbeiter einstellen(was Geld kostet).

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

Es kann ein gutes Marketing- und Verkaufsinstrument sein

Viele Menschen denken bei Produktdokumentation an die Unterstützung von Kunden, die sich bereits für einen Kauf entschieden haben, aber eine gute Produktdokumentation kann Ihnen auch dabei helfen, mehr Kunden zu gewinnen und zu überzeugen.

Aus Sicht des Marketings ist die Produktdokumentation eine Goldmine für Long-Tail-SEO-Keywords, für die Sie Ihre Dokumentation ranken können. Sie werden überrascht sein, wie viele Besucher von Google direkt auf Ihre Produktdokumentation gelangen. Wenn Sie Ihre Dokumentation gut strukturieren, haben Sie die Chance, diese Menschen in Kunden zu verwandeln.

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

Stripe ist zum Beispiel dafür bekannt, eine der besten Produktdokumentationen zu haben. Wenn Sie auf Twitter gehen, können Sie sehen, dass viele Leute Stripe aufgrund der Qualität der Dokumentation empfehlen:

Es macht Ihre Mitarbeiter effektiver

Die Produktdokumentation ist nicht nur für Kunden gedacht, sondern kann auch eine wichtige Ressource für Ihre Teammitglieder sein, die sich über Ihr Produkt informieren und bei Bedarf nachschlagen können. Dies gilt insbesondere für neue Mitarbeiter, die möglicherweise nicht über ein breites Wissen über Ihr Produkt verfügen.

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

Um Ihnen weitere Anregungen zu geben, sehen wir uns einige Beispiele für Produktdokumentationen aus der Praxis erfolgreicher Unternehmen an.

1. Streifen

Wir haben Stripe bereits als eines der besten Beispiele für Qualitätsdokumentation als Marketing-/Verkaufsinstrument erwähnt, daher musste die Stripe-Dokumentation ganz oben auf unserer Liste stehen.

2. Adyen

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

3. Twilio

Falls Sie Twilio noch nicht kennen: Twilio ist ein Tool, mit dem Unternehmen die Kommunikation über Textnachrichten, E-Mails, Telefonanrufe und mehr in ihre Plattformen integrieren können. Wie bei Stripe und Adyen bedeutet dies, dass Unternehmen Twilio in ihre bestehenden Dienste integrieren müssen, was eine erstklassige Dokumentation erfordert. In den Twilio-Dokumenten finden Sie ein gutes Beispiel.

4. Schlupf

Slack ist ein weiteres Tool, das über eine sehr gut geschriebene und nützliche Dokumentation verfügt. Sie können die vollständige Slack-Dokumentation hier einsehen.

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

Beste Produktdokumentationssoftware

Nun wollen wir uns damit beschäftigen, wie Sie auf Ihrer Website eine bessere Produktdokumentation anbieten können. 

Im nächsten Abschnitt werden wir uns mit der eigentlichen Erstellung Ihrer Dokumentation befassen. Bevor Sie jedoch Ihre Dokumentation schreiben können, brauchen Sie einen Ort, an dem Sie diese Artikel speichern und Ihren Benutzern zugänglich machen können.

Sie können diese Artikel zwar direkt in Ihre Website einfügen, aber es ist eine viel bessere Idee, eine spezielle Produktdokumentationssoftware zu verwenden. Eine gute Produktdokumentationssoftware organisiert nicht nur Ihre Inhalte und macht sie für die Besucher zugänglich, sondern bietet auch andere nützliche Funktionen wie...

• Ajax-Suchfunktionen, die den Besuchern das Durchsuchen der Dokumentation erleichtern.
• Suchanalysen, damit Sie sehen können, nach welchen Themen die Leute suchen.
• Daten zur Nützlichkeit, damit Sie verfolgen können, wie hilfreich jeder einzelne Artikel ist, und bei Bedarf Verbesserungen vornehmen können.

Hier sind zwei der besten Lösungen...

Heldenhafte Wissensdatenbank (Heroic KB)

Heroic Knowledge Base ist ein Plugin für die kostenlose, quelloffene WordPress-Software, mit dem Sie ganz einfach Ihre eigene, selbst gehostete Produktdokumentation erstellen können.

Wenn Sie bereits WordPress für die Website Ihres Unternehmens verwenden, können Sie Heroic Knowledge Base zu Ihrer Website hinzufügen, um Ihre eigene Dokumentationszentrale zu erstellen. Wenn Sie dies nicht tun, können Sie auch eine eigene WordPress-Installation für Ihre Dokumentation erstellen. Im letzteren Fall könnten Sie auch interessiert sein an das KnowAll WordPress-Dokumentationsthema.

Mit Heroic Knowledge Base können Sie Ihre gesamte Dokumentation mit dem WordPress-Inhaltseditor hinzufügen, was die Einbindung von Multimedia-Inhalten bei Bedarf erleichtert. Außerdem erhalten Sie Zugriff auf das in WordPress integrierte System zur Versionierung von Inhalten, mit dem Sie Änderungen leicht nachvollziehen und frühere Versionen Ihrer Dokumentation vergleichen können.

Die Heroic Knowledge Base bietet außerdem eine Reihe nützlicher Funktionen:

• Sofortige Ajax-Suche.
• Analytische Suche.
• Bewertungen der Nützlichkeit von Artikeln.
• Anhänge der Artikeldatei.

Heroic Knowledge Base kostet nur $129.

Adobe RoboHelp

Wenn Sie Ihre Dokumentation nur im Internet veröffentlichen, ist eine Lösung wie Heroic Knowledge Base alles, was Sie brauchen. Bei Dokumentationsanforderungen auf Unternehmensebene kann es jedoch vorkommen, dass Sie Ihre Dokumentation auf mehreren Plattformen veröffentlichen müssen, z. B. im Web, auf Papier, in mobilen Apps, als PDF usw.

In diesem Fall sollten Sie ein plattformübergreifendes Werkzeug zur Erstellung von Dokumentationen wie Adobe RoboHelp bevorzugen. Mit einem Preis von 29,99 $ pro Monat für die individuelle Nutzung ist es teurer als Heroic Knowledge Base. Wenn Sie jedoch die plattformübergreifende Erstellung von Dokumentationen benötigen, könnte sich dieser Mehrpreis lohnen.

Wie Sie die Struktur und den Inhalt Ihrer Produktdokumentation optimieren können

Nachdem Sie nun die Software haben, die Sie für die Verwaltung Ihrer Dokumentation benötigen, lassen Sie uns darüber sprechen, wie Sie 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 gute Produktdokumentation zu schreiben, müssen Sie die Zielgruppe verstehen, für die Sie schreiben (d. h. Ihre Kunden).

Für wen Sie schreiben, hat Einfluss darauf, welche Informationen Sie aufnehmen und wie Sie alles strukturieren. Wenn Sie zum Beispiel für Entwickler schreiben, sollte sich Ihre Dokumentation grundlegend von der für gelegentliche Benutzer unterscheiden.

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

2. Die verschiedenen Arten der Produktdokumentation verstehen

Es gibt verschiedene Arten von Produktdokumentation, und jede erfordert einen anderen Ansatz. Einige der gängigen Arten sind:

• Übersichten - diese Artikel geben einen Überblick über die Funktionsweise eines Bereichs Ihres Produkts, z. B. eine Anleitung für die ersten Schritte".
• Schritt-für-Schritt-Anleitungen - in diesen Artikeln wird gezeigt, wie man eine bestimmte Aufgabe ausführt.
• Referenz - diese Artikel erklären bestimmte Konzepte Ihres Produkts.
• Fehlerbehebung - in diesen Artikeln wird erklärt, wie man häufige Probleme, die bei Kunden auftreten können, beseitigt/behebt.

Die Art der Dokumentation, an der Sie arbeiten, sollte sich auf die Art und Weise auswirken, wie Sie schreiben und wie Sie Ihre Dokumentation strukturieren, daher ist es wichtig, das Ziel zu kennen, bevor Sie loslegen.

3. Seien Sie konsistent in Ihrem Stil und Ihren Namenskonventionen

Um Ihren Kunden die Nutzung Ihrer Produktdokumentation zu erleichtern, ist es wichtig, dass Sie in Ihrer gesamten Dokumentation denselben Stil und dieselben Namenskonventionen beibehalten. Dies erleichtert es den Kunden, Ihrer Dokumentation zu folgen und vermeidet mögliche Verwechslungen.

Um Ihnen dabei zu helfen, könnte es nützlich sein, einen Leitfaden für die grundlegende Formatierung und Terminologie zu erstellen.

4. Einfache Sprache verwenden und sich kurz fassen

Alles in allem ist eine kurze, einfache Sprache immer besser als Wortsalat. Ihr Ziel sollte es sein, alle notwendigen Informationen in so wenigen Worten wie möglich zu vermitteln.

Außerdem sollten Sie die Verwendung von Fachjargon oder komplexen Begriffen nach Möglichkeit vermeiden. Nicht alle Ihre Kunden werden den gleichen Wissensstand haben, und einige sind vielleicht nicht einmal Muttersprachler der Sprache, in der Ihre Dokumentation verfasst ist. Daher sollten Sie die Dinge so einfach wie möglich halten, damit jeder einen Nutzen aus Ihrer Dokumentation ziehen kann.

5. Organisieren Sie die Dokumentation in logischen, "ausgabengroßen" Artikeln

Um es den Benutzern zu erleichtern, Ihre Dokumentation zu durchsuchen und Artikel für ihre spezifischen Probleme zu finden, müssen Sie Ihre Dokumentation in logische Abschnitte 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 verschiedene Probleme in denselben Artikel packen wollen, weil es für die Leute schwierig wird, nach diesen Themen zu suchen, und sie verwirrt sein könnten, wenn sie auf dem Artikel landen.

Ihre Kunden werden Ihre Dokumentation nicht linear wie ein Buch lesen. Stattdessen werden sie je nach dem Problem, mit dem sie gerade konfrontiert sind, umher springen. Wenn Sie Ihre Artikel in logische Abschnitte unterteilen, können Sie diesem Verhalten Rechnung tragen.

6. Multimedia-Elemente einbinden

Schriftlicher Text sollte zwar den Kern Ihrer Produktdokumentation bilden, aber nicht das Einzige sein. Es kann auch hilfreich sein, Bild- und Videoinhalte einzubeziehen, wenn dies sinnvoll ist.

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

7. Überschriften verwenden und ein Inhaltsverzeichnis hinzufügen

Verwenden Sie in den einzelnen Artikeln der Produktdokumentation Überschriften, um Ihre Artikel in logische Abschnitte zu unterteilen, anstatt nur einen langen Text zu schreiben.

Um den Lesern 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.

Einige Produktdokumentationssoftware kann Ihnen helfen, automatisch ein Inhaltsverzeichnis hinzuzufügen. Das Heroic Knowledge Base Plugin verfügt beispielsweise über eine integrierte Funktion zur automatischen Erstellung eines Inhaltsverzeichnisses auf der Grundlage der Überschriften der einzelnen Artikel.

8. Verbessern und aktualisieren Sie Ihre Dokumentation ständig

Schließlich ist es wichtig, daran zu denken, dass die Erstellung der Produktdokumentation kein einmaliges Ereignis ist, sondern ein fortlaufender Prozess.

Ihr Produkt wird sich wahrscheinlich grundsätzlich ändern. Daher ist es wichtig, Ihre Dokumentation zu aktualisieren, um diese Änderungen und alle neuen Funktionen zu berücksichtigen.

Wenn Sie sich für eine Produktdokumentationssoftware wie Heroic Knowledge Base entscheiden, erhalten Sie darüber hinaus Zugang zu Analysen, die Ihnen helfen zu verstehen, wie Ihre Dokumentation genutzt wird. Sie können diese Analysen verwenden, um:

1. Verfolgen Sie, wonach die Leute suchen. Das kann ein Zeichen dafür sein, dass Sie eine Dokumentation zu diesen Themen erstellen müssen, falls Sie das noch nicht getan haben.
2. Sehen Sie, welche Artikel den Nutzern nicht so sehr helfen, wie Sie es gerne hätten. Das könnte ein Zeichen dafür sein, dass Sie an diesen Artikeln Verbesserungen vornehmen müssen, um sie noch hilfreicher zu machen.

Beginnen Sie noch heute mit der Erstellung hervorragender Produktdokumentation!

Die Erstellung hochwertiger Produktdokumentation ist eine Investition in den langfristigen Erfolg Ihres Unternehmens. Sie hilft Ihnen...

• Machen Sie Ihre Kunden erfolgreicher.
• Verringern Sie die Belastung für Ihr Support-Team.
• Mehr Kunden anziehen und umwandeln.
• Verbessern Sie das Wissen Ihrer Mitarbeiter über Ihr Produkt.

In diesem Beitrag haben wir einige großartige Beispiele von Produktdokumentationen erfolgreicher Unternehmen sowie einige Tipps für das Verfassen und die Strukturierung Ihrer Dokumentation vorgestellt.

Wenn Sie bereit sind, Ihre eigene Produktdokumentation zu erstellen, können Sie das Heroic Knowledge Base Plugin verwenden, um Ihre eigene selbst gehostete Lösung auf der Basis von WordPress zu erstellen. Klicken Sie hier, um mehr über Heroic Knowledge Base zu erfahren.