Eine Schritt-für-Schritt-Anleitung zum Erstellen und Verwalten von Produktdokumentationen | Produktmanagement #31

Was ist eine Produktdokumentation?

Bei der Produktdokumentation handelt es sich um eine Sammlung von Texten, Bildern und Videos, die das Produkt, seine Funktionen, die Art und Weise, wie es verwendet werden sollte, und andere relevante Details beschreiben. Der Hauptzweck der Dokumentation besteht darin, Benutzern zu helfen, die Verwendung des Produkts und insbesondere seine erweiterten Funktionen zu verstehen.

Dokumentation ist wichtig, insbesondere wenn Sie ein digitales Produkt erstellen, das nicht nur Endbenutzern dient, sondern auch in andere Produkte integriert werden kann – beispielsweise um Daten in eine andere Anwendung zu exportieren oder eine Lokalisierungs- oder Kontaktdatenbank zu verwenden.

Die Dokumentation für ein Projektmanagement-Tool könnte beispielsweise Informationen dazu enthalten, wie man ein neues Projekt erstellt, wie man Teammitglieder zu einem Projekt hinzufügt und ihnen die Berechtigung gibt, nur bestimmte Aufgaben zu ändern, wie man Aufgaben mehreren Personen gleichzeitig zuweist und wie man das macht Verfolgen Sie ihre Fortschritte.

Elemente der Produktdokumentation

Die Produktdokumentation kann Folgendes umfassen:

• Benutzerhandbuch – ein Dokument, das Informationen zu Produktfunktionen, Installation, Einstellungen und Fehlerbehebung enthält.
• Benutzerhandbuch – ein Dokument, das erklärt, wie Sie verschiedene Aufgaben mit dem Produkt ausführen, beispielsweise wie Sie ein Fotobearbeitungsprogramm verwenden oder wie Sie ein Computerspiel spielen.
• Wissensdatenbank – eine Sammlung von Artikeln oder Webseiten, die häufig gestellte Fragen beantworten oder zusätzliche Informationen zu einem Produkt bereitstellen. Ein Beispiel wäre der Abschnitt „Hilfe“ oder „Support“ auf der Website. Es wird auch häufig als Informationsquelle für einen Chatbot verwendet, der Kunden unterstützt.
• FAQ – eine Liste häufig gestellter Fragen und Antworten zum Produkt. Zum Beispiel eine Website oder PDF-Datei, die Antworten auf Fragen wie „Wie setze ich mein Passwort zurück?“, „Wie kontaktiere ich den Kundendienst?“ enthält. oder „Was sind die Systemanforderungen für das Produkt?“
• Tutorials – Videos, die normalerweise auf der Website des Unternehmens oder auf YouTube veröffentlicht werden und zeigen, wie das Produkt verwendet oder bestimmte Aufgaben ausgeführt werden.
• Diagramme und Infografiken – grafische Darstellungen der Struktur, Funktion oder des Prozesses eines Produkts. Beispielsweise ein Diagramm, das zeigt, welche Optionen beim Konfigurieren einer API ausgewählt werden müssen.

Wie erstelle ich eine Produktdokumentation?

Zielgruppe verstehen

Der erste Schritt bei der Erstellung einer Produktdokumentation besteht darin, die Zielgruppe zu verstehen, an die sich dieses bestimmte Dokument richtet. Beantworten Sie folgende Fragen:

• Wer wird dieses Dokument verwenden? – Wird es ein Erstbenutzer oder ein fortgeschrittener Benutzer sein?
• Ab wann greift der Benutzer nach diesem Dokument? Suchen sie nach allgemeinen oder zusätzlichen Informationen über die Fähigkeiten des Tools oder nach einer Lösung für ein bestimmtes Problem?
• Auf welchem ​​Gerät werden sie es verwenden? Sind die Videos klar genug, wenn es sich um ein Mobilgerät handelt?
• Was sind ihre Bedürfnisse und Erwartungen? Möchte der Benutzer lieber ein dynamisches Video ansehen oder sich ein Diagramm ansehen?

Sobald Sie Ihr Publikum und seine Bedürfnisse verstanden haben, können Sie mit der Erstellung Ihrer Dokumentation beginnen. Wenn Ihre Zielgruppe beispielsweise unerfahrene Benutzer sind, sollte die Dokumentation bei jedem Schritt zugänglich, in einer einfachen, leicht verständlichen Sprache verfasst und detaillierte Anweisungen enthalten.

Denken Sie daran, dass eine gut organisierte Dokumentation nicht nur den Benutzern hilft, das Produkt zu verstehen, sondern auch Zeit spart, die sie möglicherweise mit der Suche nach Antworten auf ihre Fragen verbracht hätten. Dies reduziert die Abwanderung, also den Prozentsatz, bei dem Kunden das Abonnement eines Dienstes beenden.

Klare Kommunikation

Bei der Erstellung effektiver Produktdokumentationen geht es nicht nur um die Wahl der richtigen Kommunikationsform (z. B. Videos, Bilder, Wissensdatenbank), sondern auch darum, klar und prägnant zu schreiben und zu kommunizieren. Die Grundprinzipien einer effektiven Kommunikation in der Produktdokumentation lauten wie folgt:

• Verwenden Sie eine einfache Sprache – vermeiden Sie Fachsprache und komplizierte Begriffe. Anstatt beispielsweise „Projekt starten“ zu sagen, können Sie auch „Projekt starten“ sagen.
• Seien Sie konkret – stellen Sie Beispiele zur Verfügung, die den Benutzern helfen, die Verwendung des Produkts zu verstehen. Anstatt beispielsweise zu sagen „Ermöglicht das Hinzufügen von Teammitgliedern zu einem Projekt“, sagen Sie „Fügen Sie ein Teammitglied zu einem Projekt hinzu, indem Sie auf die grüne Schaltfläche unten auf der Projektmanagementseite klicken“ und fügen Sie einen Screenshot mit einem visuellen Hinweis hinzu .
• Vermeiden Sie Passiv – Aktivsprache ist leichter zu verstehen und zu lesen. Anstatt beispielsweise zu sagen: „Das Projekt kann vom Manager gestartet werden“, sagen Sie: „Der Manager kann das Projekt starten.“

Es gibt viele weitere Grundsätze, die befolgt werden müssen, aber das Wichtigste ist, sich daran zu erinnern, dass eine effektive Produktdokumentation für Benutzer verständlich sein und ihnen helfen sollte, das Produkt effektiv zu nutzen.

Verwendung von Bildern in der Produktdokumentation

Visuelle Elemente wie Bilder, GIFs, kurze Videos, Diagramme und Infografiken können das Verständnis der Produktdokumentation erheblich verbessern. Beispielsweise kann ein Screenshot, der zeigt, wo sich die Schaltfläche „Teammitglied hinzufügen“ auf der Seite befindet, für Erstbenutzer sehr hilfreich sein. Verwenden Sie bei der Erstellung der Dokumentation außerdem klare Überschriften und eine einfache Schriftart, um den Text zu strukturieren.

Aktualisierung und Pflege der Produktdokumentation

Die Produktdokumentation ist kein statisches Dokument. Es muss regelmäßig aktualisiert werden, um Änderungen am Produkt widerzuspiegeln. Damit die Dokumentation ihren Zweck erfüllt, sind regelmäßige Aktualisierungen von entscheidender Bedeutung. Wenn Sie beispielsweise eine neue Funktion in Ihre Produktmanagementsoftware einführen, sollten Sie die Produktdokumentation entsprechend aktualisieren.

Veröffentlichung und Vertrieb von Produktdokumentationen

Die Veröffentlichung und Verbreitung der Produktdokumentation ist ebenso wichtig wie deren Erstellung. Sie müssen sicherstellen, dass Ihre Dokumentation für Benutzer leicht zugänglich ist, unabhängig davon, wo sie sich befinden oder welches Gerät sie verwenden. Sie können beispielsweise Ihre Produktdokumentation auf Ihre Website hochladen oder sie direkt per E-Mail an Benutzer senden.

Top-Dokumentenmanagementsysteme für Produktmanager

Produktmanagern stehen zahlreiche Tools zur Verfügung, die ihnen bei der Erstellung und Verwaltung von Produktdokumentationen helfen können. Zu den beliebten Lösungen gehören:

• Google Docs ist ein cloudbasierter Dienst zum Erstellen und Bearbeiten von Dokumenten. Es ist ein beliebtes Tool für Produktmanager, da es von jedem Gerät aus zugänglich ist und von mehreren Teammitgliedern genutzt werden kann.

• Firmbee ist ein umfassendes Projekt- und Teammanagement-Tool, mit dem Benutzer Aufgaben von überall auf der Welt in Echtzeit erledigen können. Produktmanager können ihre Arbeit und die ihrer Kollegen einfach organisieren, Fortschritte verfolgen, Budgets kontrollieren und Rekrutierungsprozesse durchführen.

• Notion ist eine Aufgaben- und Projektverwaltungsanwendung, mit der Aufgaben, Notizen und Dateien verfolgt werden können. Notion ist eine beliebte Option für Produktmanager, da es flexibel ist und angepasst werden kann.

• Zendesk Guide ist eine Kundendienstlösung, mit der Wissensdatenbankartikel erstellt und geteilt werden können. Zendesk Guide ist eine beliebte Wahl für Produktmanager, da es ihnen ermöglicht, Kunden zu unterstützen und ihnen bei der Lösung ihrer Probleme zu helfen.

Zusammenfassung

Die Erstellung und Verwaltung von Produktdokumentationen ist eine oft unterschätzte Aufgabe. Viele Entwickler digitaler Produkte glauben, dass ein gut gestaltetes Produkt selbsterklärend ist. Allerdings sollte eine Produktdokumentation mehr als nur ein Benutzerhandbuch sein.

Es sollte auch ein Tool sein, das dazu beitragen kann, die Bekanntheit der Kunden für das Produkt zu steigern und ihr Interesse an neuen Funktionen sowie die Anzahl der Aufrufe bestimmter Artikel oder Erklärungen zu analysieren. Eine solche Analyse hilft Unternehmen, ihre Produkte besser zu verwalten und die Benutzererfahrung zu verbessern. Es lohnt sich also, eine effektive Produktdokumentation zu erstellen, die sowohl Ihnen als auch Ihren Benutzern von Nutzen ist.

Wenn Ihnen unsere Inhalte gefallen, treten Sie unserer fleißigen Bienen-Community auf Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest und TikTok bei.

Autor: Andy Nichols

Ein Problemlöser mit 5 verschiedenen Graden und endlosen Motivationsreserven. Das macht ihn zu einem perfekten Geschäftsinhaber und Manager. Bei der Suche nach Mitarbeitern und Partnern sind Offenheit und Neugier gegenüber der Welt für ihn die Eigenschaften, die er am meisten schätzt.

Alle Beiträge anzeigen

Produkt Management:

1. Einführung in das Produktmanagement
2. Welche Rolle spielt ein Produktmanager?
3. Warum ist Produktlebenszyklusmanagement wichtig?
4. Wie baut man eine effiziente Produktstrategie auf?
5. OKRs vs. SMART-Ziele. Welches Framework führt zu besseren Ergebnissen?
6. Wie definiert man ein Wertversprechen?
7. Identifizierung von Kundenbedürfnissen und Marktsegmentierung
8. Entwicklung eines erfolgreichen Produktkonzepts. Techniken und Schritte
9. Mit einer effektiven Produkt-Roadmap einen Vorsprung verschaffen
10. Prototyping Ihres digitalen Produkts
11. Wie baut man ein MVP auf?
12. MVP gegen MMP gegen MMF. Wichtige Meilensteine ​​in der Produktentwicklung
13. Hypothesentests meistern
14. Bewährte Methoden zur Verbesserung des Produktqualitätsmanagements
15. Strategien und Taktiken für eine erfolgreiche Produkteinführung
16. Steigerung der Rentabilität durch Produktoptimierung
17. Produkterfolg messen
18. Wie bepreist man ein Produkt? Die beliebtesten Preisstrategien
19. Die Zukunft des Produktdesigns. Top-Trends und Prognosen
20. Wann sollte ein Produkt eingestellt werden? Schlüsselfaktoren, die EOL-Entscheidungen beeinflussen
21. Agil im Produktmanagement
22. Scrum und Kanban im Produktmanagement.
23. Was ist Lean Product Management?
24. Zu erledigende Aufgaben. Produkte schaffen, die Kunden wirklich brauchen
25. Was ist Growth Hacking?
26. Was ist datengesteuertes Produktmanagement?
27. A/B-Tests im Produktmanagement
28. Nützliche Produktmanagement-Vorlagen. Wo finde ich sie?
29. Strategyzer-Tools im Produktmanagement
30. 5 nützliche Produktmanagement-Tools
31. Wie erstellt und verwaltet man eine Produktdokumentation?