Eine Schritt-für-Schritt-Anleitung zur Erstellung und Verwaltung von Produktdokumentationen | Produktmanagement #31

Was ist Produktdokumentation?

Produktdokumentation ist 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 Erstellung von Dokumentation besteht darin, den Benutzern zu helfen, zu verstehen, wie sie das Produkt nutzen können, insbesondere dessen erweiterte Funktionen.

Dokumentation ist wichtig, insbesondere wenn Sie ein digitales Produkt erstellen, das nicht nur Endbenutzern dient, sondern auch mit anderen Produkten integriert werden kann – zum Beispiel, indem Sie Daten in eine andere Anwendung exportieren oder eine Lokalisierungs- oder Kontaktdatenbank verwenden.

Beispielsweise könnte die Dokumentation für ein Projektmanagement-Tool Informationen darüber enthalten, wie man ein neues Projekt erstellt, wie man Teammitglieder zu einem Projekt hinzufügt und ihnen die Berechtigung erteilt, nur bestimmte Aufgaben zu ändern, wie man Aufgaben gleichzeitig mehreren Personen zuweist und wie man ihren Fortschritt verfolgt.

Elemente der Produktdokumentation

Die Produktdokumentation kann Folgendes umfassen:

• Benutzerhandbuch – ein Dokument, das Informationen zu den Produktfunktionen, Installation, Einstellungen und Fehlersuche bereitstellt.
• Benutzerleitfaden – ein Dokument, das erklärt, wie verschiedene Aufgaben mit dem Produkt ausgeführt werden, z. B. wie man ein Fotobearbeitungsprogramm verwendet oder wie man ein Computerspiel spielt.
• Wissensdatenbank – eine Sammlung von Artikeln oder Webseiten, die häufig gestellte Fragen beantworten oder zusätzliche Informationen über ein Produkt bereitstellen. Ein Beispiel wäre der Abschnitt “Hilfezentrum” oder “Support” auf der Website. Sie wird auch oft 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 eine PDF-Datei, die Antworten auf Fragen wie “Wie setze ich mein Passwort zurück?”, “Wie kontaktiere ich den Kundensupport?” oder “Was sind die Systemanforderungen für das Produkt?” enthält.
• Schulungen – Videos, die normalerweise auf der Website des Unternehmens oder auf YouTube veröffentlicht werden und zeigen, wie man das Produkt verwendet oder bestimmte Aufgaben ausführt.
• Diagramme und Infografiken – grafische Darstellungen der Struktur, Funktion oder des Prozesses eines Produkts. Zum Beispiel ein Diagramm, das zeigt, welche Optionen bei der Konfiguration einer API ausgewählt werden sollen.

Wie erstellt man Produktdokumentation?

Verständnis der Zielgruppe

Der erste Schritt bei der Erstellung von Produktdokumentation besteht darin, das Publikum zu verstehen, an das dieses spezielle Dokument gerichtet ist. Beantworten Sie die folgenden Fragen:

• Wer wird dieses Dokument verwenden? – Wird es ein Erstbenutzer oder ein fortgeschrittener Benutzer sein?
• Wann wird der Benutzer auf dieses Dokument zugreifen? Sucht er allgemeine oder zusätzliche Informationen über die Möglichkeiten des Tools oder eine Lösung für ein spezifisches Problem?
• Auf welchem Gerät wird er es verwenden? Wenn es sich um ein mobiles Gerät handelt, sind die Videos klar genug?
• Was sind ihre Bedürfnisse und Erwartungen? Bevorzugt der Benutzer, ein dynamisches Video anzusehen oder ein Diagramm zu betrachten?

Sobald Sie Ihr Publikum und dessen Bedürfnisse verstehen, können Sie mit der Erstellung Ihrer Dokumentation beginnen. Wenn Ihre Zielgruppe beispielsweise unerfahrene Benutzer sind, sollte die Dokumentation in jedem Schritt zugänglich sein, in einfacher, leicht verständlicher Sprache verfasst werden und detaillierte Anweisungen enthalten.

Denken Sie daran, dass 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 die prozentuale Rate, mit der Kunden aufhören, einen Dienst zu abonnieren.

Klare Kommunikation

Die Erstellung effektiver Produktdokumentation besteht nicht nur darin, die richtige Kommunikationsform (z. B. Videos, Grafiken, Wissensdatenbank) auszuwählen, sondern auch klar und präzise zu schreiben und zu kommunizieren. Die grundlegenden Prinzipien effektiver Kommunikation in der Produktdokumentation sind wie folgt:

• Verwenden Sie einfache Sprache – vermeiden Sie technische Sprache und komplizierte Begriffe. Anstatt zu sagen “ein Projekt initiieren”, können Sie sagen “ein Projekt starten”.
• Seien Sie spezifisch – geben Sie Beispiele, um den Benutzern zu helfen, zu verstehen, wie sie das Produkt verwenden können. Anstatt zu sagen “ermöglicht es Ihnen, Teammitglieder zu einem Projekt hinzuzufügen”, sagen Sie “fügen Sie ein Teammitglied zu einem Projekt hinzu, indem Sie auf die grüne Schaltfläche am unteren Rand der Projektmanagementseite klicken” und fügen Sie einen Screenshot mit einem visuellen Hinweis hinzu.
• Vermeiden Sie die passive Stimme – die aktive Stimme ist leichter zu verstehen und zu lesen. Anstatt zu sagen “das Projekt kann vom Manager gestartet werden”, sagen Sie “der Manager kann das Projekt starten.”

Es gibt viele andere Prinzipien, die zu beachten sind, aber das Wichtigste ist, sich daran zu erinnern, dass effektive Produktdokumentation für die Benutzer verständlich sein und ihnen helfen sollte, das Produkt effektiv zu nutzen.

Verwendung von visuellen Elementen in der Produktdokumentation

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

Aktualisierung und Pflege der Produktdokumentation

Produktdokumentation ist kein statisches Dokument. Sie muss regelmäßig aktualisiert werden, um Änderungen am Produkt widerzuspiegeln. Regelmäßige Updates sind entscheidend, damit die Dokumentation ihren Zweck erfüllt. Wenn Sie beispielsweise eine neue Funktion in Ihrer Projektmanagement-Software einführen, sollten Sie die Produktdokumentation entsprechend aktualisieren.

Veröffentlichung und Verbreitung der Produktdokumentation

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

Top-Dokumentenmanagementsysteme für Produktmanager

Produktmanager haben viele Werkzeuge zur Verfügung, die ihnen helfen können, Produktdokumentation zu erstellen und zu verwalten. Beliebte Lösungen sind:

• Google Docs ist ein cloudbasierter Dienst zum Erstellen und Bearbeiten von Dokumenten. Es ist ein beliebtes Tool für Produktmanager, da Sie von jedem Gerät darauf zugreifen können und es von mehreren Teammitgliedern verwendet werden kann.

• Firmbee ist ein umfassendes Projekt- und Teammanagement-Tool, das es Benutzern ermöglicht, Aufgaben von überall auf der Welt in Echtzeit zu erledigen. Produktmanager können ihre Arbeit und die ihrer Kollegen leicht organisieren, den Fortschritt verfolgen, Budgets kontrollieren und Rekrutierungsprozesse durchführen.

• Notion ist eine Aufgaben- und Projektmanagementanwendung, die verwendet werden kann, um Aufgaben, Notizen und Dateien zu verfolgen. Notion ist eine beliebte Option für Produktmanager, da es flexibel ist und angepasst werden kann.

• Zendesk Guide ist eine Kundenservicelösung, die verwendet werden kann, um Wissensdatenbankartikel zu erstellen und zu teilen. Zendesk Guide ist eine beliebte Wahl für Produktmanager, da es ihnen ermöglicht, Unterstützung zu bieten und Kunden bei der Lösung ihrer Probleme zu helfen.

Zusammenfassung

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

Sie sollte auch ein Werkzeug sein, das dazu beitragen kann, das Bewusstsein der Kunden für das Produkt zu erhöhen 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. Daher lohnt es sich, Zeit und Mühe in die Erstellung effektiver Produktdokumentation zu investieren, die sowohl Ihnen als auch Ihren Benutzern zugutekommt.

Wenn Ihnen unsere Inhalte gefallen, treten Sie unserer aktiven Community auf Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest, TikTok.