Produktdokumentation: Der ultimative Leitfaden

Produktdokumentation… sie ist vielleicht nicht der aufregendste Teil eines Unternehmens, aber ein wichtiger Bereich, den Sie nicht übersehen sollten, wenn Ihr Unternehmen erfolgreich sein soll.

Die Erstellung hochwertiger Produktdokumentationen kann Ihnen helfen, Ihre Kunden erfolgreicher zu machen, Ihren Supportaufwand zu reduzieren und generell ein besseres Unternehmen aufzubauen.

Aber was gehört zur Erstellung von Produktdokumentationen? 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 ist alles, was wir behandeln werden:

• Warum Sie sich um Ihre Produktdokumentationsstrategie kümmern sollten
• Einige reale Beispiele für erstklassige Dokumentationen
• Die beste Software für Produktdokumentationen
• Acht Tipps für die Erstellung besserer Dokumentationen

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

Warum Sie sich um Ihre Produktdokumentationsstrategie kümmern sollten

Beginnen wir damit, warum Sie bei Ihrer Produktdokumentationsstrategie nicht sparen sollten.

Es macht Ihre Kunden erfolgreicher

Der größte Vorteil der Erstellung von Produktdokumentationen ist, dass sie Ihre Kunden erfolgreicher macht. Mehr erfolgreiche Kunden bedeuten höhere Konversionsraten, niedrigere Abwanderungsraten und so weiter.

Es ist logisch – wenn ein Kunde nicht herausfinden kann, wie er einen Mehrwert aus Ihrem Produkt ziehen kann, wird er nicht lange Kunde bleiben.

Produktdokumentation ist eine nützliche Möglichkeit, Kunden zu schulen, damit sie den größtmöglichen Nutzen erzielen. Wenn sie mehr Wert aus Ihrem Produkt ziehen, werden sie eher weiterhin dafür bezahlen, Sie an ihre Freunde/Kollegen weiterempfehlen und so weiter.

Es reduziert Ihre Support-Belastung

Produktdokumentation kann auch eine großartige Möglichkeit sein, die Belastung Ihrer menschlichen Support-Kanäle zu reduzieren.

Wenn Ihre Produktdokumentation von geringer Qualität oder nicht vorhanden ist, bedeutet dies, dass Ihre Kunden jedes Mal, wenn ein Problem auftritt, Ihr menschliches Support-Team kontaktieren müssen. Das bedeutet mehr Zeitaufwand für die Beantwortung von Supportanfragen.

Sie müssen entweder Zeit von der Weiterentwicklung Ihres Unternehmens abziehen, um diese Anfragen selbst zu bearbeiten, oder Sie müssen eine engagierte Support-Person einstellen (was Geld kostet).

Mit qualitativ hochwertiger Dokumentation können Kunden viele ihrer Probleme selbst lösen, wodurch die Notwendigkeit entfällt, sich an den Support zu wenden. Sie können Ihre Support-Prozesse auch so strukturieren, dass die Leute aufgefordert werden, Ihre Dokumentation zu prüfen, bevor sie eine Anfrage stellen.

Es kann ein gutes Marketing- und Vertriebsinstrument sein

Während viele Leute an Produktdokumentation im Kontext der Unterstützung von Personen denken, die sich bereits für einen Kauf entschieden haben, kann eine gute Produktdokumentation Ihnen auch helfen, mehr Kunden anzuziehen und zu konvertieren.

Aus Marketingsicht ist Produktdokumentation eine Goldgrube für Long-Tail-SEO-Keywords, für die Sie Ihre Dokumentation ranken können. Sie werden vielleicht überrascht sein, wie viele Leute direkt über Google auf Ihrer Produktdokumentation landen. Wenn Sie Ihre Dokumentation gut strukturieren, haben Sie die Chance, diese Leute in Kunden zu verwandeln.

Ihre Dokumentation kann auch ein nützliches Vertriebsinstrument für Leute sein, die noch unentschlossen sind, Ihr Produkt zu kaufen. Produktdokumentation kann potenzielle Vorverkaufsfragen beantworten, sie davon überzeugen, dass Ihr Produkt das tut, was sie brauchen, und ihnen Vertrauen geben, dass sie Hilfe erhalten, wenn sie sie brauchen.

Zum Beispiel ist Stripe für seine hervorragende Produktdokumentation bekannt. Wenn Sie auf Twitter gehen, können Sie viele Leute sehen, die Stripe wegen der Qualität der Stripe-Dokumentation empfehlen:

Es macht Ihre Mitarbeiter effektiver

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

Vier großartige reale Beispiele für Produktdokumentation

Um Ihnen weitere Inspiration zu geben, werfen wir einen Blick auf einige reale Beispiele für Produktdokumentation von erfolgreichen Unternehmen.

1. Stripe

Wir haben Stripe bereits als eines der besten Beispiele für qualitativ hochwertige Dokumentation als Marketing-/Vertriebsinstrument erwähnt, daher wussten Sie, dass die Stripe-Dokumentation auf unserer Liste an erster Stelle stehen musste.

2. Adyen

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

3. Twilio

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

4. Slack

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

Beste Software für Produktdokumentation

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

Wir werden im nächsten Abschnitt darüber sprechen, wie Sie Ihre Dokumentation tatsächlich schreiben. Bevor Sie jedoch Ihre Dokumentation schreiben können, benötigen Sie einen Ort, an dem Sie diese Artikel speichern und für Ihre Benutzer zugänglich machen können.

Während Sie diese Artikel einfach direkt zu Ihrer Website hinzufügen können, ist es eine viel bessere Idee, eine spezielle Software für Produktdokumentationen zu verwenden. Neben der Organisation Ihrer Inhalte und der Zugänglichkeit für Besucher bietet eine gute Software für Produktdokumentationen weitere nützliche Funktionen wie...

• Ajax-Suchfunktionen, die Besuchern helfen, die Dokumentation zu durchsuchen.
• Suchanalysen, damit Sie sehen können, nach welchen Themen die Leute suchen.
• Hilfreichkeitsdaten, 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...

Heroic Knowledge Base (Heroic KB)

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

Wenn Sie WordPress bereits für die Website Ihres Unternehmens nutzen, können Sie Heroic Knowledge Base zu Ihrer Website hinzufügen, um Ihre eigene Dokumentationszentrale zu erstellen. Oder, wenn nicht, können Sie eine dedizierte WordPress-Installation für Ihre Dokumentation erstellen. In letzterem Fall sind Sie vielleicht auch an dem KnowAll WordPress-Dokumentationsthema interessiert.

Heroic Knowledge Base ermöglicht es Ihnen, all Ihre Dokumentation über den Content-Editor von WordPress hinzuzufügen, was die Einbindung von multimedialen Inhalten erleichtert, falls erforderlich. Sie erhalten auch Zugriff auf das integrierte Versionsverwaltungssystem von WordPress, mit dem Sie Änderungen leicht verfolgen und frühere Versionen Ihrer Dokumentation vergleichen können.

Heroic Knowledge Base fügt außerdem eine Reihe nützlicher Funktionen hinzu, darunter:

• Sofortige Ajax-Suche.
• Suchanalysen.
• Bewertungen der Artikelhilfreichkeit.
• Dateianhänge für Artikel.

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. Für unternehmensweite Dokumentationsanforderungen gibt es jedoch möglicherweise Situationen, in denen Sie Ihre Dokumentation auf mehreren Plattformen veröffentlichen müssen, einschließlich Web, physischem Papier, mobilen Apps, PDFs usw.

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

So optimieren Sie die Struktur und den Inhalt Ihrer Produktdokumentation

Jetzt, da Sie die Software zur Verwaltung Ihrer Dokumentation haben, sprechen wir darüber, wie Sie qualitativ hochwertige Artikel schreiben können. Hier sind acht wichtige Tipps zur Strukturierung Ihrer Dokumentation und zum Verfassen besserer Hilfeartikel...

1. Verstehen Sie Ihre Zielgruppe

Um eine hervorragende Produktdokumentation zu schreiben, müssen Sie die Zielgruppe verstehen, für die Sie schreiben (d. h. Ihre Kunden).

Für wen Sie schreiben, beeinflusst, welche Informationen Sie einbeziehen und wie Sie alles strukturieren. Wenn Sie beispielsweise für Entwickler schreiben, sollte Ihre Dokumentation radikal anders sein als das Schreiben für Gelegenheitsnutzer.

Sie möchten nicht davon ausgehen, dass Ihr Publikum Experten sind und wichtige Details übergehen, aber Sie können je nach Zielgruppe grundlegende Kenntnisse voraussetzen.

2. Verstehen Sie die verschiedenen Arten von Produktdokumentationen

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

• Übersichten – diese Artikel geben einen Überblick darüber, wie ein Bereich Ihres Produkts funktioniert, z. B. eine „Erste Schritte-Anleitung“.
• Schritt-für-Schritt-Anleitungen – diese Artikel zeigen den Benutzern, wie sie eine bestimmte Aufgabe ausführen.
• Referenz – diese Artikel erklären spezifische Konzepte in Ihrem Produkt.
• Fehlerbehebung – diese Artikel erklären, wie häufige Probleme, auf die Kunden stoßen könnten, behoben werden können.

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

3. Seien Sie konsistent in Ihrem Stil und Ihren Namenskonventionen

Damit Ihre Produktdokumentation für Ihre Kunden einfacher zu verwenden ist, ist es wichtig, dass Sie durchgängig den gleichen Stil und die gleichen Namenskonventionen beibehalten. Dies erleichtert es den Kunden, Ihrer Dokumentation zu folgen und potenzielle Verwirrung zu vermeiden.

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

4. Verwenden Sie klare Sprache und bleiben Sie prägnant

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

Sie sollten auch vermeiden, Fachjargon oder komplexe Begriffe zu verwenden, wann immer möglich. Nicht alle Ihre Kunden haben die gleiche Wissensbasis, und einige sind möglicherweise nicht einmal Muttersprachler der Sprache Ihrer Dokumentation. Daher stellt die möglichst einfache Gestaltung sicher, dass jeder einen Mehrwert aus Ihrer Dokumentation ziehen kann.

5. Dokumentation in logischen, „problembezogenen“ Artikeln organisieren

Um es den Leuten 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 Teilprobleme geben, aber die Idee ist, dass Sie nicht zwei völlig getrennte Probleme in denselben Artikel packen wollen, da dies die Suche nach diesen Themen erschwert und die Leute verwirrt sein könnten, wenn sie auf den Artikel stoßen.

Ihre Kunden werden Ihre Dokumentation nicht linear lesen, wie sie ein Buch lesen. Stattdessen werden sie je nach dem Problem, auf das sie gerade stoßen, hin und her springen. Die Unterteilung Ihrer Artikel in logische Abschnitte 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 einzufügen, wo dies sinnvoll ist.

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

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

Achten Sie innerhalb einzelner Produktdokumentationsartikel darauf, Überschriften zu verwenden, um Ihre Artikel in logische Abschnitte zu unterteilen, anstatt nur einen langen Textblock zu schreiben.

Um den Leuten 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. Zum Beispiel bietet das Heroic Knowledge Base Plugin eine integrierte Funktion, um automatisch ein Inhaltsverzeichnis basierend auf den Überschriften jedes Artikels zu generieren.

8. Verbessern und aktualisieren Sie Ihre Dokumentation immer

Schließlich ist es wichtig zu bedenken, dass die Erstellung von Produktdokumentationen kein einmaliges Ereignis ist; es ist ein fortlaufender Prozess.

Auf grundlegender Ebene wird Ihr Produkt wahrscheinlich Änderungen erfahren, daher ist es wichtig, Ihre Dokumentation zu aktualisieren, um diese Änderungen und alle neuen Funktionen, die Sie hinzugefügt haben, zu berücksichtigen.

Aber darüber hinaus erhalten Sie, wenn Sie eine Produktdokumentationssoftware wie Heroic Knowledge Base wählen, Zugriff auf Analysen, die Ihnen helfen zu verstehen, wie Menschen Ihre Dokumentation nutzen. Sie können diese Analysen verwenden, um:

1. Zu verfolgen, wonach die Leute suchen, was ein Zeichen dafür sein kann, dass Sie Dokumentationen zu diesen Themen erstellen müssen, falls Sie dies noch nicht getan haben.
2. Zu sehen, welche Artikel den Benutzern nicht so helfen, wie Sie es sich wünschen, was ein Zeichen dafür sein könnte, dass Sie diese Artikel verbessern müssen, um ihre Hilfreichkeit zu steigern.

Beginnen Sie noch heute mit der Erstellung großartiger Produktdokumentationen!

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

• Ihre Kunden erfolgreicher zu machen.
• Die Belastung Ihres Support-Teams zu reduzieren.
• Mehr Kunden anzuziehen und zu konvertieren.
• Das Wissen Ihrer Mitarbeiter über Ihr Produkt zu verbessern.

In diesem Beitrag haben wir einige großartige Beispiele für Produktdokumentationen von erfolgreichen Unternehmen sowie einige Tipps zur Erstellung und Strukturierung Ihrer Dokumentation geteilt.

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