Ein bewährtes Verfahren bei der Einführung eines neuen Produkts ist die Vorbereitung der Produktfreigabe. Insbesondere wollen wir uns auf die Erstellung einer neuen Produktdokumentation zur Unterstützung der Produkteinführung konzentrieren. Andernfalls haben potenzielle Nutzer keine relevanten Informationen, die sie nach dem Kauf Ihrer neuen Lösung als Referenz verwenden können.
Als Teil einer umfassenderen Marketingstrategie sollten Produktmanager und Mitglieder des Produktteams weiterlesen, um mehr über 15 bewährte Verfahren zu erfahren, die sie bei ihrer nächsten Produkteinführung anwenden sollten. Am Ende werden Sie wissen, wie Sie diese wichtigen Dokumente so gut wie möglich gestalten können!
Welche Arten von Produktdokumentation sollte ich beachten?
Bevor wir uns mit der Liste der bewährten Verfahren befassen, sollten wir klären, welche Arten von Produktdokumentation es gibt und welches Ziel damit verfolgt wird:
Produktanforderungsdokumentation - Ein Produktanforderungsdokument oder PRD ist eine Art interner Produktdokumentation, die Unternehmen dabei hilft, Freigabekriterien zu erfüllen. Darin wird erklärt, was das Endprodukt für einen Benutzer leisten soll, ohne dass das Wie oder Wo genau definiert wird. Anschließend verwenden Entwicklungsteams und Testteams ein PRD, um das Produkt mit den geschäftlichen Anforderungen für die Freigabe in Einklang zu bringen. PRDs sind bei Softwareprodukten weit verbreitet, können aber zur Einhaltung jeder Produkt-Roadmap verwendet werden.
- Benutzerhandbücher und Self Service - Produktteams müssen als weiche Voraussetzung für eine erfolgreiche Produkteinführung Benutzerhandbücher erstellen. Wie der Name schon sagt, handelt es sich dabei um eine Dokumentation, die den Endbenutzern hilft, ihre Produktivität bei der Verwendung eines neuen Produkts zu maximieren. Hier sollten alle wichtigen benutzerseitigen Funktionen vollständig erklärt werden, damit die Kunden den größtmöglichen Nutzen daraus ziehen können. Noch besser ist es, diese Anleitungen in einer externen Wissensdatenbank zur Verfügung zu stellen, damit die Kunden sich selbst helfen können!
Leitfäden zur Einrichtung, Installation und Konfiguration - Wenn ein Produkt eingerichtet, installiert und konfiguriert werden muss, ist dies eine weitere technische Produktdokumentation, die Sie erstellen müssen. Ziel ist es, diese Prozesse aus der Sicht des Benutzers und ggf. des Entwicklers zu veranschaulichen. Bei einer Softwaredokumentation kann sich dies über mehrere Geräte und Betriebssysteme erstrecken; dies ist zu berücksichtigen.
Marketing-Assets - Sie denken vielleicht nicht, dass es sich hierbei um eine Produktdokumentation handelt, aber es ist eine! Der Stil und das Format der Marketing-Assets beeinflussen, wie Kunden Ihr Produkt wahrnehmen, bevor sie es benutzen. Ein guter Eindruck ist entscheidend. Wie beschreiben Sie die neuen Funktionen des Produkts? Für welche Zielgruppe ist es gedacht? Wie wird das Produkt das Arbeits- oder Privatleben der Kunden verbessern? Ist es das, was Sie und das gesamte Unternehmen den Kunden vermitteln wollen?
15 Best Practices für die Dokumentation bei der Veröffentlichung neuer Produkte
Nach dieser Einführung in die Produktdokumentation folgt nun die Liste der bewährten Verfahren:
1: Machen Sie den Anfang!
Sie fangen gerade erst mit der Produktdokumentation an? Prima! Zögern Sie nicht, einen Anfang zu machen. Viele Menschen wollen die Produktdokumentation PERFEKT haben, und im Streben nach Perfektion werden sie von der Aufgabe gelähmt. Bringen Sie das Grundkonzept für Ihre Dienstleistungen zu Papier und konzentrieren Sie sich dann auf die Feinabstimmung, um Ihre Kunden zu beeindrucken. Versionshinweise eignen sich hervorragend, um die Grundlagen zu definieren, auf denen Sie dann aufbauen können.
2: Keep it Simple, Stupid...
Die Abkürzung KISS steht für ein echtes Gestaltungsprinzip, das in den 60er Jahren bei der US-Marine in Umlauf gebracht wurde (Wortspiel beabsichtigt). Diese Regel kann auch auf die Produktdokumentation angewendet werden. Fragen Sie sich selbst: "Wie kann man die notwendigen Informationen so vermitteln, dass sie für alle Bevölkerungsgruppen verständlich sind?"
Um dies auf Ihre Produktvision anzuwenden, empfehlen wir den Flesch-Kincaid-Lesbarkeitstest. Tools zur Bewertung von Inhalten wie Grammarly verwenden dieses System häufig. Damit erhalten Sie bei der Analyse schriftlicher Inhalte eine Punktzahl, die einer amerikanischen Highschool-Note entspricht. Streben Sie die 8. Klasse oder das Alter von 13 bis 14 Jahren als Schulalter an, um die Interpretierbarkeit von Inhalten zu maximieren - Moment, wir hätten auch sagen können, wie leicht es ist, Ihre Texte zu verstehen.
3: Verstehen Sie das Zielpublikum
So, Sie haben angefangen und es einfach gehalten. Jetzt müssen Sie wissen, für wen Sie eigentlich schreiben... Die Zielgruppe eines Softwareunternehmens wird sich zum Beispiel stark von der eines Automobilherstellers unterscheiden.
Stellen wir uns ein Unternehmen für Bildungssoftware vor, das sich auf einfache Tools konzentriert, mit denen junge Schüler Schritt für Schritt Konzepte lernen können. Der erste Gedanke, der Ihnen in den Sinn kommt, ist vielleicht: "Die Zielgruppe sind also Kinder, richtig?". Nicht unbedingt... Die Zielgruppe sind die primären Entscheidungsträger für Softwarepakete in einem Kindergarten oder einer Sekundarschule - wie die IT-Abteilung und die für die Beschaffung zuständigen internen Akteure. Eine sekundäre Zielgruppe wären die jungen Schüler, die die Lernsoftware in freier Wildbahn sehen und sich für deren Einsatz in ihrer Schule einsetzen.
4: Konzentrieren Sie sich auf den Wert, nicht auf eine Geschichte
Zwar liebt jeder eine gute Geschichte, aber die Kunden wollen wissen, welchen Wert Ihr Produkt bietet. Wird es eine Aufgabe oder einen Arbeitsablauf vereinfachen? Ist Ihr Produkt offline verfügbar, während die Konkurrenz nur online verfügbar ist? Erledigt Ihr Produkt eine Aufgabe schneller als andere Produkte der Konkurrenz?
Diese Beispiele stellen Alleinstellungsmerkmale (USP) für ein bestimmtes Angebot dar. Wenn Sie sich auf die USPs konzentrieren und sie hervorheben, können Sie potenzielle Kunden anlocken und ihnen helfen zu verstehen, was Sie haben, was andere nicht haben, und so Ihren Marktanteil erhöhen. Sie können USPs definieren, indem Sie eine Wettbewerbsanalyse mit Konkurrenten in Ihrer Branche durchführen.
5: Nutzen Sie die Formatierung, um Informationen zu kategorisieren
Die Dokumentation sollte nicht aus einem großen Textblock bestehen. Dies ist für den Endbenutzer schwer zu durchschauen und zu navigieren. Verwenden Sie stattdessen Überschriften und andere Formatierungsoptionen, um den Text aufzulockern.
H1-Überschriften sind das erste, was der Benutzer sieht, wenn er auf eine Seite klickt. H2 und H3 dienen als Unterüberschriften für die auf der Seite behandelten Themen. Sie können Aufzählungspunkte oder nummerierte Listen verwenden, um Inhalte zu gruppieren, damit sie leichter zu lesen sind, und sich sogar für Rich Snippets qualifizieren, um SEO und SERPS-Sichtbarkeit zu verbessern. Wenn Sie über Markdown-Kenntnisse verfügen, bietet ein Online-Markdown-Editor wie Docsie zahlreiche Formatierungsoptionen, um Ihre Produktdokumente hervorzuheben!
6: Bewahren Sie Ihre Dokumentation an einem zentralen Ort auf
Es gibt nichts Schlimmeres, als eine technische Dokumentation zu veröffentlichen und dann festzustellen, wie kompliziert es ist, sie langfristig zu überwachen und zu verwalten. Was ist, wenn die Dokumentation aktualisiert werden muss? Wo ist das Originaldokument, und wie können wir neue Versionen der Seite freigeben? Was ist mit der Übersetzung dieser Inhalte in andere Sprachen?
Für diese Best Practice müssen wir Docsie erwähnen! Die Online-Wissensdatenbank-Software ermöglicht es Ihnen, Dokumente an einem einzigen, zentralen Ort in der Cloud zu speichern. Von hier aus können Mitarbeiter und Auftragnehmer gemeinsam an den Inhalten arbeiten, um die Fertigstellung bis zur Markteinführung zu beschleunigen. Docsie bietet Versionskontrollmanagement, wenn Sie Wissen aktualisieren müssen, und Sprachmanagement für die globale Lokalisierung von Inhalten. Wenn Sie die Erstellung globaler Inhalte automatisieren möchten, haben wir auch einen raffinierten Ghost-KI-Sprachübersetzungs-Bot, der im Hintergrund präzise für Sie übersetzt!
7: Ein Bild sagt mehr als Tausend Worte
Eine langatmige Erklärung, wie etwas zu tun ist, kann zwar funktionieren, ist aber keine effektive Methode, um Endbenutzer zu unterrichten. Zeigen Sie es ihnen stattdessen mit Bildern, sogar mit bewegten Bildern!
Versuchen Sie, für jedes Produktdokument ein begleitendes Videotutorial zu erstellen. Auf diese Weise können diejenigen, die lieber lesen, den Text überfliegen, während visuelle Lernende sich für das Video entscheiden können. Ebenso können GIFs und Bilder den Nutzern helfen, zu erkennen, worauf Sie sich beziehen, insbesondere innerhalb einer Software-Benutzeroberfläche (UI). Wenn Sie sich auf verschiedene Lernstile einstellen, können Sie einer größeren Anzahl von Nutzern helfen, was wiederum mehr Potenzial für Ihr Produkt bedeutet.
8: Lernen vs. Ziele vs. Verstehen vs. Information
Was ist der Zweck des Dokuments? Die Absicht des Nutzers ist bei der Online-Produktdokumentation von entscheidender Bedeutung und hilft Ihnen, Ihre Inhalte auf die einzelnen Abschnitte der User Journey auszurichten.
Lernen - Wenn eine Person eine Sache noch nie gesehen hat, hilft ihr der Lerninhalt, die grundlegenden Prinzipien zu verstehen.
Ziele - Diese Art von Inhalt sollte dem Benutzer helfen, ein Ziel zu erreichen, z. B. "Wie exportiere ich eine PDF-Datei aus Docsie". Am Ende wird der Benutzer das Ziel erreicht haben: eine PDF-Datei zu exportieren.
-
Verstehen** - Diese Art von Inhalt wird auch als Recherche bezeichnet und richtet sich an Kunden, die bereits über Fachwissen zu einem bestimmten Thema verfügen, dieses aber noch vertiefen möchten.
-
Information - Die Person hat eine Frage und möchte eine bestimmte Antwort. Das kann so einfach sein wie das Echtzeit-Wetter an einem bestimmten Ort oder ein Video darüber, wie man ein Baumhaus baut.
9: Machen Sie es durchsuchbar
Bevor Sie die Dokumentation veröffentlichen, sollten Sie sicherstellen, dass Ihre Benutzer nach Schlüsselwörtern im Text suchen können.
Wenn nicht, empfehlen wir Ihnen, eine Dokumentationsplattform zu finden, die dies unterstützt. Am meisten schreckt es die Benutzer ab, wenn sie nicht in der Lage sind, Informationen schnell zu finden. Dies führt zu Frustration, zusätzlicher Arbeitsbelastung des Kundensupport-Teams, wenn es die Informationen nicht finden kann, und zu einer negativen Kundenerfahrung (CX) insgesamt. Oh, Docsie unterstützt die globale Suche, falls Sie sich das gefragt haben!
10: Vorbereitung auf das Sammeln von umsetzbarem Feedback
Die Autoren der Dokumentation sind sich der Tatsache bewusst, dass sich die ursprüngliche Version des Inhalts im Laufe der Zeit zwangsläufig ändern wird. Solange die Öffentlichkeit die Dokumentation nicht zu Gesicht bekommt, können Ihre Autoren nur gegenseitig Ideen und Feedback austauschen.
Sobald Ihre Dokumentation veröffentlicht ist, ist es unserer Meinung nach unerlässlich, eine Feedbacksammlung einzurichten. Auf diese Weise können Ihre Autoren alle negativen Aspekte des Inhalts in positive umwandeln, indem sie echten Kunden und Endbenutzern zuhören. Sie müssen nicht woanders suchen, Sie können die Vorteile der Feedbacksammlung in Docsie nutzen!
11: Verlinken Sie auf eine Seite, wenn Sie ein Thema erwähnen
Diese bewährte Praxis bezieht sich auf SEO und die Navigationsstruktur von Webseiten.
Wenn Sie ein Schlüsselwort erwähnen, verlinken Sie dann darauf? Wenn Sie auf andere Themen verweisen, kann es sein, dass die Benutzer das andere Thema im Zusammenhang mit der aktuellen Seite noch nicht verstehen. Sie sollten auf alle erwähnten Themen verlinken, zu denen es eine Dokumentation gibt, da dies den Lesern ermöglicht, schnell auf Unterthemen zuzugreifen, während sie sich über ein Hauptthema informieren.
12: Klarheit, nicht Zweideutigkeit
Klarheit ist beim Verfassen von Produktdokumentation besser als Zweideutigkeit. Sie können einfaches Englisch verwenden, um Mehrdeutigkeit zu vermeiden, was im Wesentlichen bedeutet, dass Sie Jargon und Fachsprache nur dann verwenden, wenn es unbedingt notwendig ist. Wenn Sie Fachjargon verwenden, sollten Sie unmittelbar danach eine vereinfachte Definition für Laien schreiben.
"Wenn Sie Probleme haben, die Informationen in dieser Dokumentation zu verstehen, fragen Sie bitte unseren Kundenbetreuer nach weiteren Details, wie Sie diese Verständnisschwierigkeiten überwinden können."
"Wenn der angezeigte Inhalt schwer zu verstehen ist, können Sie den Kundensupport um Hilfe bitten."
Was ist Ihnen lieber?
13: Vorlagen erstellen, um Dokumente zu beschleunigen
Wenn ein neues Produkt auf den Markt kommt, ist es wichtig, den Prozess der Dokumentationserstellung zu beschleunigen. Dies können Sie mit Hilfe von Vorlagen erreichen.
Vorlagen definieren eine wiederverwendbare Struktur für Seiten und helfen den Autoren, Inhalte schneller und konsistenter zu erstellen. Sie können auch mehrere Vorlagen für verschiedene Inhaltsstile erstellen. Docsie bietet eine Reihe von vorgefertigten Vorlagen, die Sie verwenden können, sowie Unterstützung für benutzerdefinierte Vorlagen.
14: Erstellen Sie einen Tonfall und einen Style Guide für Autoren
Wie viel Freiraum haben Ihre Autoren?
Es ist wichtig, die Autoren einzuschränken, da dies zu Inkonsistenzen in den endgültigen Entwürfen der Produktdokumentation führen kann. Sie können dies mit Richtlinien für den Tonfall (Tone of Voice, ToV) und Stilrichtlinien für das Schreiben von Inhalten erreichen.
Tonfall - Es kommt nicht darauf an, was Sie sagen, sondern wie Sie es sagen. Sollen die Autoren formell und korrekt oder eher leger sein? Ist Humor erlaubt, oder sind die Themen eher ernst? Sind Ihre Inhalte eher gesprächig und leidenschaftlich, oder wollen Sie nur knallharte Fakten?
Stilrichtlinien - In diesem Dokument kann das Leitbild des Unternehmens erläutert werden und wie die Autoren beim Schreiben und Formatieren der Seiten einen bestimmten Stil einhalten können. Dazu gehören z. B. die anzusprechenden Benutzer-Personas, SEO-Grundsätze wie Meta-Beschreibungen und Zitier- oder Referenzierungsanforderungen (Chicago, AP Style usw.).
15: Veröffentlichen Sie Ihre Dokumentation mit einer leistungsfähigen Wissensdatenbank-Plattform
Wenn Ihr schriftlicher Inhalt Treibstoff ist, welches Vehikel verwenden Sie dann, um die Botschaft zu vermitteln?
Eine leistungsstarke Wissensdatenbank-Plattform ist für die Bereitstellung einer hochwertigen Produktdokumentation unerlässlich. Wenn Dokumente nicht mehr verfügbar sind oder Seiten nur langsam geladen werden, ist die ganze Mühe, die in die Erstellung dieser Dokumente gesteckt wurde, umsonst gewesen.
Sie müssen in der Lage sein, vorhandene Dokumente zu importieren, gemeinsam mit internen Teams an Inhalten zu arbeiten, neue Dokumente zu erstellen und zu bearbeiten, dynamische Rich-Content-Inhalte einzubetten und auf einer Wissensseite zu veröffentlichen. Auch die Versionskontrolle ist für langfristige Dokumentationsaktualisierungen von entscheidender Bedeutung, ebenso wie die Sprachverwaltung und die automatische Übersetzung für die globale Lokalisierung von Inhalten.
Sie haben es erraten! Alle diese Funktionen sind in Docsie verfügbar. Probieren Sie diese Funktionen aus und testen Sie unseren kostenlosen Forever-Plan, um loszulegen!