SaaS Produktdokumentation für Ihre Kunden erstellen

Dokumentation in einem SaaS-Unternehmen ist ein bisschen wie Rock-n-Roll, oder? Oder doch wahrscheinlich nicht.

Die Dokumentation für Ihr SaaS-Produkt ist von entscheidender Bedeutung, obwohl es in dem Wirbelsturm des SaaS-Starts möglicherweise nicht ganz oben auf Ihrer Prioritätsliste gewesen ist.

Es ist mehr als nur ein Kostensparer für den Kundendienst. Möglicherweise haben Sie bereits einige Versuche beim Veröffentlichen einiger Dokumente gemacht, aber es ist Zeit, Ihre Dokumente auf die nächste Ebene zu bringen.

Da SaaS-Unternehmen nach einem Abonnementmodell arbeiten, interagieren Sie regelmäßig mit Ihren Kunden. Das bedeutet, Sie sind einzigartig positioniert, um von der Dokumentation zu profitieren.

Die solide SaaS-Produktdokumentation trägt direkt zum Aufbau einer starken, kontinuierlichen Beziehung zu Ihren Kunden bei und reduziert so die Abwanderung von Kunden.

Die Abwanderung, der sogenannte Churn, ist eines der größten Hindernisse für Ihr Wachstum, so dass SaaS Unternehmen nicht ignorieren können, dass gute Dokumente benötigt werden.

Warum Sie “Killer” SaaS Produktdokumentation brauchen

Im Moment könnten Sie vielleicht die Gelegenheit haben, Ihre Kunden glücklicher zu machen. Sie können Kundensupportanfragen mit reaktiver Dokumentation reduzieren – Dokumente, die als Antwort auf Probleme, die Ihre Kunden haben, erstellt wurden.

Für SaaS-Unternehmen die skalieren müssen, ist Produktdokumentation notwendig, um die Anzahl der Tickets pro Kunde so niedrig wie möglich zu halten. mit Dokumentation können Sie Ihr Produkt benutzerfreundlicher machen, um Abwanderungen zu reduzieren.

SaaS Produktdokumente haben auch das Potenzial, das On-Boarding in Ihrem Startup zu verbessern. Dies ist mit proaktiver Dokumentation möglich.

Wussten Sie, dass Dokumentation Ihnen auch helfen kann, Ihre Online-Sichtbarkeit zu erhöhen? Ja! Der Vorteil einer Killer-Dokumentation besteht darin, dass sie Teil Ihrer Content-Marketing-Strategie sein kann, insbesondere, wenn Ihr SaaS-Produkt mit einer populären Industrie verbunden ist.

Letztlich kann und sollte dies in Ihre Bemühungen um eine Optimierung Ihrer Wissensdatenbank durch SEO miteinbezogen werden.

Die Wissensdatenbank von MailChimp zum Beispiel passt zu den Anfragen im Zusammenhang mit E-Mail-Marketing. Wenn Sie nach ‚E-Mail-Abonnenten analysieren‘ suchen, erscheint deren Dokumentation in den Suchergebnissen. Dies ist eine großartige Möglichkeit für potentielle Kunden, ihre Produkte zu entdecken.

Dieser Ansatz funktioniert am besten, wenn Ihre Wissensdatenbank eine Subdomain Ihrer Hauptseite ist und für Ihr Site-Ranking zählt.

Schauen Sie sich an, wie Sie Produktdokumentation für Ihre SaaS erstellen:

9 Bereiche zur Konzentration auf SaaS Produktdokumentation

Um eine passende Dokumentation für Ihre SaaS-Nutzer zu erstellen, müssen Sie sich auf neun Schlüsselbereiche konzentrieren.

1. Definieren Sie die Zielgruppe für Ihre Dokumentation
2. Erfahren Sie die Art der Dokumentation, die Sie erstellen
3. Verwenden Sie die Informationsarchitektur in Ihrer SaaS-Wissensdatenbank
4. Ordnen Sie Ihre Wissensdatenbank-Inhalte in Chunks für nicht-lineare Entdeckungen
5. Qualitätsproduktdokumentation erkennen
6. Unterscheiden Sie zwischen Code-Dokumentation und Produktdokumentation
7. Nutzen Sie die passende Softwarelösung für das Hosting Ihrer Wissensdatenbank
8. Mehrere Formate für Inhalte verwenden
9. Iterieren Sie Ihre Dokumentation kontinuierlich

Wir gehen nun ins Detail, wie Sie Killer SaaS Produktdokumentation für Ihre Benutzer erstellen können.

1. Definieren Sie die Zielgruppe für Ihre Dokumentation

Sie können keine Killer-Dokumentation erstellen, wenn Sie nicht genau wissen, für wen Sie sie schreiben.

Ihre Dokumentation kann entweder an Endnutzer, interne Mitarbeiter, API-Entwickler oder eine Kombination aus diesen Zielgruppen gerichtet sein.

Entscheidend ist es, das Zielpublikum für Ihre Wissensdatenbank klar zu definieren. Bei Bedarf sollten Sie den Inhalt in separate Wissensdatenbanken unterteilen. Es geht darum, spezifisch zu sein.

Bevor Sie Zeit und Ressourcen in eine Killer-Wissensdatenbank für Ihre SaaS investieren, führen Sie ausführliche Interviews und Umfragen durch. Finden Sie genau heraus, wer Ihre Kunden sind.

Sogar ein paar E-Mails, die um Feedback von denjenigen bitten, die Ihr Support-Team kontaktieren, ist besser als nichts.

Wave weiß genau, wer sein Wissensdatenbank-Publikum ist – kleine Unternehmer

2. Kennen Sie die Art der Dokumentation, die Sie erstellen

Wussten Sie, dass es verschiedene technische Dokumentationen gibt? Sie müssen sich darüber im Klaren sein, welche Sie erstellen.

Typen der SaaS-Produktdokumentation können Folgendes beinhalten:

• Anleitungen
• Praktische Handbücher
• Erklärungen
• Referenz

Die Klarstellung der Art der Dokumentation bedeutet, dass sie optimal formatiert und Ihren Benutzern präsentiert werden kann. Um Verwirrung zu vermeiden, müssen Sie verschiedene Arten von Inhalten voneinander trennen.

Anleitungen

Tutorials sind zum praktischen Lernen gedacht und enthalten wenig bis gar kein Referenzmaterial. Sie sind kurze und bündige Anleitungen für Anfänger, um sich mit den Grundfunktionen Ihrer Software vertraut zu machen.

Praktische Handbücher

Diese sind fortgeschrittener als Tutorials. How-to Handbücher führen die Benutzer durch den Prozess der Fertigstellung einer bestimmten Aufgabe und eine Aufgabe, die Anfänger wahrscheinlich nicht formulieren konnten. Dies könnte beinhalten, wie Sie Probleme bei einem Absturz Ihres Programms beheben können.

Erklärungen

Erklärungen sind Diskussionen über Konzepte. Sie sind eher theoretisch als praktisch. Das Ziel ist es, Ihren Benutzer dazu zu bringen, etwas Abstraktes zu verstehen, wie den Kontext um Ihre Software.

Referenz

Referenzdokumente sind technische Beschreibungen Ihrer Software. Dies könnte in Entwicklerdokumenten häufiger sein als für Endbenutzer Ihrer Software. Es ist möglich, dass sie für Endbenutzer immer noch nützlich sein könnten, wenn potenzielle Kunden ihre Dokumentation ihren eigenen Entwicklern zeigen.

Lesen Sie auch: Spieldesign Dokument: Schritte und Bewährte Praktiken

3. Verwenden Sie die Informationsarchitektur in Ihrer SaaS Produktdokumentationssoftware

SaaS Produktdokumentation ist nicht nur eine Frage der Erstellung einer Fülle von Inhalten und deren Weitergabe an Ihre Kunden.

Layout und Informationsarchitektur Ihrer Wissensdatenbank müssen sorgfältig entworfen werden. Dies wird den Lernprozess unterstützen.

Information Architecture (IA) liefert ihren Benutzern Wegweiser, die ihnen den Weg durch Ihre Wissensdatenbank zeigen. Es ist von Dingen wie der Konsistenz bei der Benennung von Konventionen, Hierarchien und Kategorien betroffen. Es zeigt die Einsatzmöglichkeiten Ihres Benutzers für Ihre Software und verbessert den ROI für Ihr Produkt.

IA behebt die unbewusste sowie unbewusste Inkompetenz Ihrer Nutzer.

Unbewusste Inkompetenz ist es, wenn Ihre Benutzer nicht wissen, was sie nicht wissen. User-Onboarding Dokumentation hilft Ihren Benutzern sich aus diesem Zustand auszubilden. Aber was ist mit der restlichen Zeit?

Bewusste Inkompetenz ist, wenn Ihre Benutzer bereits wissen, was sie nicht wissen und ein Problem mit Ihrer Software haben. Die Aufgabe Ihrer Dokumentation besteht darin, diesen Benutzern passende Inhalte zur Verfügung zu stellen, die ihre Probleme reibungslos lösen.

4. Ordnen Sie Ihre Wissensdatenbankinhalte in Chunks für nicht-linerate Entdeckungen 

SaaS Produktdokumentation wird nicht linear wie ein Buch konsumiert. Benutzer kommen aus verschiedenen Orten zu Ihrer Wissensdatenbank.

In der Vergangenheit der gedruckten technischen Gebrauchsanleitungen, musste jede Ausgabe des Handbuchs jedes Mal neu gedruckt werden, wenn eine neue Version der Technologie herauskam. Es wurde in einer bestimmten Art gestaltet, damit Benutzer von A bis B lesen oder die Tabelle der Inhalte verwenden können.

Dieser Trend hat sich in das Dokumentationsfeld übertragen. Aber moderne Browsinggewohnheiten bedeuten, dass Ihre Kunden aus verschiedenen Quellen zu Ihrer Dokumentation kommen. Jeder Inhalt muss als eigenständige und potenzielle Zielseite sinnvoll sein.

Der Schlüssel liegt darin, Ihre Inhalte durch Chunks zu verschönern. Behandeln Sie jeden Inhalt als wiederverwertbare Informationsquelle.

Vergewissern Sie sich, dass nicht mehr als ein wesentliches Thema in jedem Stück behandelt wird und verknüpfen Sie verwandte Inhalte zusammen. Benutzen Sie Menüs und Navigation, um Benutzern zu anderen Themen zu leiten.

Stellen Sie sich Ihre Inhalte als Teil einer Cloud vor und nicht als Sequenz.

5. Qualitätsdokumentation erkennen

Qualität ist ein subjektiver Zustand, aber es gibt einige Kriterien, die Sie verwenden können, um zu beurteilen, ob Sie qualitativ hochwertige Dokumentation erstellen oder nicht.

Vollständigkeit

Sie können Ihre Dokumentation nicht mit einer Zerstreuungswaffe behandeln, da dies das Vertrauen untergraben wird. Wenn eines Ihrer Schlüsselfunktionen nicht dokumentiert ist oder die Dokumentation veraltet ist, ist dies wohl schlimmer als überhaupt keine Dokumentation.

Ihre Dokumentation muss eine vollständige Bibliothek sein, die alles enthält, was Ihre Benutzer über Ihr Produkt wissen möchten. Dies bedeutet nicht, dass Sie jeden einzelnen Artikel auf Ihrer Knowledge Base-Homepage aufnehmen, aber alle Informationen sollten irgendwo verfügbar sein.

Präzis

Gleichzeitig muss alles, was Sie einbeziehen, von höchster Relevanz sein. Dies ist keine Zeit, um mit Ihren Inhalten großzügig oder wortgewandt zu sein.

Kommen Sie schnell zur Sache und entfernen Sie alle überflüssigen Informationen. Wenn Sie nochmals Ihre Dokumentation für Ihre eigenen Zwecken der Redaktion durchlesen wollen, erkenn Si, dass Sie sich langweilen. Das ist schon ein großes Warnsignal, dass es zu viele Informationen in Ihren Dokumenten gibt.

Verwenden Sie nur die genaue Anzahl der Wörter, die Sie brauchen, um Ihre Punkte zu übermitteln. Platzieren Sie die Lösung auf jedes Problem schon am Anfang Ihrer Inhalte. Dann erläutern Sie weiter für die Benutzer, die Schritt für Schritt durch den Prozess gehen.

Kontexbasiert

Endbenutzer Ihres Produkts verlassen sich darauf, dass Sie alle notwendigen Kontexte für Ihre Dokumentation bereitstellen. Das heißt: keine Vermutungen – Nutzer müssen sofort verstehen, ob sie den richtigen Inhalt gefunden haben oder nicht.

Sie können den Kontext angeben, indem Sie kurz erläutern, wie viel Benutzer wissen sollten, bevor sie von Ihrem Artikel profitieren können. Mozilla tut dies in ihren Entwicklerdokumenten wirklich gut:

Einfach

Einfach ist nicht das Gleiche wie verblödet. Wenn Ihre Dokumentation einfach ist, bedeutet dies, dass Sie sich entschieden haben, die grundlegenden Informationen jederzeit anzuzeigen.

Nur eine kleine Anzahl von Funktionen werden von Ihren Kunden verwendet.  Überprüfen Sie daher Ihre Analyse, um zu sehen, welche Dokumentation am dringendsten benötigt wird. Verwenden Sie dies, um zu bestimmen, welchen Weg Sie Ihren Kunden zeigen, wenn sie Ihre Produktwissensdatenbank erreichen.

Stripe hält es wirklich einfach:

Qualitätsdokumentation beruht letztlich darauf, Ihre Zielgruppe zu kennen, wie sie am besten lernt und wie Sie ihre Erwartungen erfüllen können. Es gibt keine Zauberformel, weil jede Zielgruppe anders ist.

Befolgen Sie diese bewährten Prinzipien, um Ihre Erfolgschancen zu maximieren, und stellen Sie professionelle technische Autoren ein, um Ihnen dabei zu helfen, dieses Ziel zu erreichen.

6. Unterscheiden zwischen Code-Dokumentation und Produktdokumentation

Einige Unternehmen sind Anhänger agiler Methodologien und verfolgen einen “docs-like-code” Ansatz in der Dokumentation. Während dies ein fantastisch nützlicher Ansatz sein kann, folgt SaaS Produktdokumentation einem leicht anderen Prozess als die Code-Dokumentation.

Produktdokumente sollten so oft wie nötig aktualisiert werden – wenn Fehler gefunden werden, oder wenn neue Inhalte erstellt werden. Sie entspricht nicht unbedingt ihrem Entwicklungszyklus oder der Häufigkeit, mit der Sie Ihren Code verschicken möchten.Zusätzlich ist es vielleicht nicht sehr realistisch zu erwarten, dass Ihre technischen Autoren oder Support-Agenten lernen, Entwicklerwerkzeuge wie Github zur Veröffentlichung von Docs zu verwenden.

Manchmal ist der Endbenutzer Ihrer Software ein Entwickler, aber das macht Produktdokumentation immer noch nicht gleich wie Code-Dokumentation. Code-Dokumentation bezieht sich speziell auf den Code und zielt in der Regel sowieso auf die Verbesserung der Kommunikation zwischen internen Entwicklern und Produktdokumentationen für Zielgruppen außerhalb Ihres Unternehmens.

Verschiedene Teams und Teammitglieder sollten für die Bereitstellung verschiedener Dokumentationsarten verantwortlich sein – selbst wenn sie alle „Dokumentation“ produzieren. Die Bewertung sollte auf verschiedenen Ebenen stattfinden, um den Erfolg zu messen, so dass nicht jeder gezwungen ist, dieselben Werkzeuge oder Prozesse zu verwenden.

7. Nutzen Sie die passende Softwarelösung für das Hosting Ihrer Wissensdatenbank

Wenn Sie ein SaaS-Produkt verkaufen, benötigen Sie in der Regel eine Online-Wissensdatenbank, um Ihre Hilfsinhalte zu unterbringen. Knowledge Base-Softwarelösungen sind reichlich vorhanden, aber wenige davon sind speziell für die SaaS-Dokumentation konzipiert.

Technische Autorenwerkzeuge wie Madcap Flare sind für Großunternehmen gedacht, die Dokumentationen in vielen verschiedenen Formaten, Überdruck und Web erstellen. Diese sind zu schwer und unpassend für Ihr durchschnittliches SaaS-Unternehmen.

Andere wissensbasierte Lösungen, die auf Unternehmen abzielen, haben einen Preisnachlass. SaaS-Startups benötigen Software, die sich zu einem Preispunkt skaliert, der sich mit einem bescheideneren Budget bequem anfühlt.

Und da Sie vielleicht bereits über eine Helpdesk-Lösung verfügen, wollen Sie wahrscheinlich keine Wissensdatenbank mit Support-Software, sondern nur eine einfache Wissensdatenbank.

Neugierig zu sehen, wie es für Sie funktioniert? Tauchen Sie ein – sehen Sie, wie einfach es ist, Dokumentation zu verwalten!

Interessiert an der Wissendatenbank Document360? Planen Sie eine Demo mit einem unserer Experten.

Demo buchen

Da Sie die Abonnementsoftware über das Internet liefern, benötigen Sie ein Werkzeug, das auf die gleiche Weise funktioniert. Sie benötigen eine SaaS Wissensdatenbank-Lösung.

Unser eigenes Produkt Document360 ist eine Wissensdatenbank-Software für SaaS-Unternehmen und Sie können sich für eine kostenlose Testversion anmelden.

8. Verwenden Sie mehrere Formate für Inhalte

Manchmal würzen Hersteller von Dokumentationen ihre Inhalte gern mit verschiedenen Formaten wie:

• Bildern
• Videos
• Screencasts
• Audios
• Interaktiven Code-Beispielen

Oft ist ein Bild im Wert von tausend Wörtern und kann die Lernerfahrung des Benutzers verbessern.

Denken Sie jedoch daran, dass Videos und Screencasts schwieriger zu aktualisieren sein können als geschriebene Dokumentation, und Sie können Probleme bei der Internationalisierung haben.

Videos und Bilder sind auch nicht zugänglich für Benutzer von Screenreadern, daher sollten Sie immer eine schriftliche Version zur Begleitung Ihrer Bilder bereitstellen. Das kann am Ende eine Menge zusätzlicher Arbeit bedeuten.

Das heißt nicht, dass Sie keine Videos verwenden sollten, da sie eine unglaubliche Möglichkeit sein können, Informationen über Ihr Produkt zu übermitteln. Beachten Sie einfach die Probleme  bei der Wartung und Zugänglichkeit.

9. Iterieren Sie ständig Ihre SaaS-Dokumentation

Ihre SaaS Produktdokumentation ist nie fertig. Es entwickelt sich immer weiter, genau wie sich Ihr Produkt entwickelt.

Die meisten SaaS-Unternehmen sind offen für die Tatsache, dass der Kundenservice in erster Linie online stattfindet, und so sollte ihre Wissensdatenbank sein. Die Natur der Softwareentwicklung bedeutet, dass sie mit dem Konzept der kontinuierlichen Iteration vertraut sind. Tatsächlich – ihre Unternehmen gründen sich darauf.

Dies hat dazu geführt, dass einige Dokumentarfilmer einen “docs-like-code” Ansatz verfolgen (wie wir bereits erwähnt haben). Dies bedeutet, dass Sie sich die Prinzipien von der Softwareentwicklung borgen und Ihre Dokumentation im selben Repository wie Ihren Code behalten müssen.

Ob dies für Ihren Start geeignet ist oder nicht, muss von Fall zu Fall entschieden werden. Sie müssen jedoch Ihre Unterlagen mit der neuesten Version Ihres Produkts auf dem neuesten Stand halten.

Zu keinem Zeitpunkt sollten Kunden Zugang zu unvollständigen Unterlagen haben. Dies birgt die Gefahr, den Ruf Ihres Produkts zu schädigen und Ihre Glaubwürdigkeit zu zerstören.

Lesen Sie auch: Produktanforderungsdokument: Vorteile, & Beispiele

Schlussbemerkungen

Manche meinen, ein gutes Produkt sollte sich nur selbst dokumentieren. Das heißt, das Produkt ist so benutzerfreundlich, dass überhaupt keine Dokumentation benötigt wird. Dieser Ansatz impliziert – wenn Ihr Produkt eine Dokumentation benötigt, haben Sie bei der Benutzererfahrung versagt.

In Wirklichkeit haben die meisten Softwareprodukte genügend Komplexität, sodass nicht jede Funktion sofort sichtbar ist. Nicht jeder Anwendungsfall für Ihre Software ist immer intuitiv. Hier kann Killer SaaS Produktdokumentationssoftware wirklich nützlich sein.

Die Bedeutung von Docs geht auf die Idee der unbewussten Inkompetenz zurück, d.h. Ihre Kunden wissen nicht, was sie nicht wissen.

SaaS Produktdokumentation ist Ihr stiller Partner bei der Reduzierung von Abwanderungen und der Steigerung der Kundenzufriedenheit. Sicherlich möchten Sie nun so bald wie möglich beginnen!

Nächste Schritte

Schauen Sie sich die besten Suchbegriffe in Ihrer Wissensdatenbank an, wenn Sie eine haben. Wenn Sie das nicht tun, interviewen Sie einige Ihrer Kunden über ihre größten Probleme mit Ihrer Software. Dann erstellen Sie einen Plan für Ihre Knowledge Base-Inhalte und strukturieren Sie Ihre SaaS-Produktdokumentation um diesen Plan herum.

Veröffentlichen Sie Ihre Inhalte und verbessern Sie Ihre Wissensdatenbank kontinuierlich und erstellen Sie neue Prozesse, um den Erfolg zu sichern.

Mithilfe einer Wissensdatenbank-Software kann der gesamte Prozess extrem effizienter werden.

Ihre Dokumentation benötigt ein maßgeschneidertes Haus, um zu leben. Denken Sie darüber nach, in Kick-Ass eigenständige Wissensdatenbank-Software wie Document360 zu investieren

Beginnen Sie Ihre kostenlose Testversion