4 wesentliche Dokumentationstypen, die jeder Produktmanager benötigt

Dokumentation ist eine der wichtigsten und am meisten unterschätzten Komponenten eines jeden Open-Source-Projekts und sollte nicht auf die leichte Schulter genommen werden.

Die meisten Open-Source-Projekte erhalten nicht genügend Aufmerksamkeit, weil ihre Autoren oft kein Interesse haben, nicht fähig sind oder keine Zeit finden, eine effektive Dokumentationsumgebung für ihre API und Produktdokumentation zu erstellen.

Auch wenn Ihre Anwendung hervorragend sein mag – bei unzureichender Dokumentation können Nutzer nicht von ihren Funktionen profitieren.

Selbst wenn sie aus irgendeinem Grund keine andere Wahl haben, als Ihre Anwendung zu nutzen, werden sie dies nicht effektiv oder in der von Ihnen gewünschten Weise tun können.

Das Erstellen guter Dokumentation erfordert viel Arbeit und regelmäßiges Studium anderer Dokumentationsprojekte. Glauben Sie mir – als jemand, der zahlreiche Dokumentationen für Docsie erstellt hat: Wenn Sie Code entwickeln, der von anderen genutzt wird, besonders von Ihren Kunden, sollte Ihr Produkt gut dokumentiert, formatiert und dynamisch präsentiert sein.

Was unterscheidet Tutorials, Anleitungen, Erklärungen und Referenzen?¶

Viele glauben fälschlicherweise, dass diese vier Begriffe dasselbe bezeichnen. Tatsächlich stehen sie für verschiedene Dokumentationsarten mit wichtigen Unterschieden:

Tutorial-Dokumentation: Informationsbasierte Dokumentation für Schulungszwecke.

Anleitungen/Benutzerhandbücher: Diese Dokumentation zeigt in Schritten, wie man spezifische Probleme löst, um ein bestimmtes Ziel zu erreichen.

Erklärende Dokumentation: Artikel-ähnliche Dokumentation, die dem Nutzer ein tieferes Verständnis eines Produkts durch Erklärungen und Hintergrundinformationen vermittelt.

Referenz-Dokumentation: Diese Dokumentation informiert über neue Funktionen und deren Nutzung. Sie kann in Form technischer Entwicklerdokumentation vorliegen oder in benutzerfreundlichere Release Notes übersetzt werden.

Gründe für hochwertige Dokumentation¶

Zunächst ist es wichtig zu verstehen, warum gute Dokumentation so wichtig, aber oft unterschätzt wird. Umfassende und gut geschriebene Dokumentation ist eines der wichtigsten Kriterien für eine breite Akzeptanz, besonders in Open-Source-Projekten, wo nahezu alle Aktivitäten öffentlich sind und entscheidend zum Projekterfolg beitragen.

Hier sind die wichtigsten Gründe für gute Dokumentation:

Sie schafft eine bessere Einarbeitungserfahrung für Ihre Kunden¶

Mit guter Produktdokumentation unterstützen Sie Ihre Kunden, sich mit Ihrem Produkt wohlzufühlen und durch klare Richtlinien abgesichert zu sein. Dafür sollten Sie:

1. Sicherstellen, dass Ihre Produktdokumentation sichtbar und leicht zugänglich ist, entweder durch In-App-Links oder über eine durchsuchbare Dokumentationsplattform.

2. Darauf achten, dass die Dokumente gut geschrieben sind und dem Kunden helfen, schnell und einfach Antworten zu finden.

Ein Tipp: Schreiben Sie Ihre Dokumentation einmal gut, und sie wird immer wieder von neuen Kunden genutzt werden.

Weniger Support-Anfragen¶

Kunden, die Ihre Dokumentation verstehen, werden Ihr Produkt besser nutzen können. Wenn Kunden etwas nicht herausfinden können, ist das frustrierend und sie geben möglicherweise Ihrem Produkt die Schuld.

Manche Kunden kontaktieren sofort den Support, wenn sie auf ein Problem stoßen. Mit attraktiver, leicht zugänglicher und verständlicher Dokumentation können sie ihre Probleme jedoch selbst lösen, ohne Sie zu kontaktieren – was sie zudem selbstbestimmter macht.

Sie unterstützt Ihr eigenes Team¶

Eine fundierte Wissensbasis hilft auch Ihren Teammitgliedern. Ihr internes Team sollte über neue Funktionen, geplante Roadmaps, API-Dokumentation und alles Nötige informiert sein, um alle auf dem gleichen Stand zu halten.

Anleitung zum Erstellen effektiver Dokumentation¶

Das Schreiben des Inhalts und dessen Organisation unterscheiden sich von der Wahl des richtigen Tons und der Sicherstellung der Verständlichkeit. Laut O'Reilly gibt es 8 Regeln für gute Dokumentation:

1. Erstellen Sie einladende Dokumentation.

2. Produzieren Sie gründliche Dokumentation, die alle Projektbereiche abdeckt.

3. Erstellen Sie übersichtliches Material, das leicht zu verstehen ist.

4. Erstellen Sie Dokumentation mit Fallstudien zur Produktnutzung.

5. Schreiben Sie Dokumentation mit gezielten Wiederholungen, wo nötig.

6. Halten Sie Ihre Dokumentation aktuell.

7. Erstellen Sie Dokumentation, zu der leicht beigetragen werden kann.

8. Machen Sie Dokumentation leicht auffindbar und verständlich.

Diese Elemente betreffen hauptsächlich den Inhalt. Nun folgen sechs Schritte zur Strukturierung dieser Informationen:

Entscheiden Sie, was dokumentiert werden soll¶

Überlegen Sie vor dem Start, welche Art von Dokumentation Sie erstellen: ein Tutorial, ein Referenzdokument, eine Anleitung oder eine Erklärung?

Beachten Sie, dass die Art Ihres Produkts direkten Einfluss auf die Art der Dokumentation hat, die Sie erstellen müssen.

Erstellen Sie ein Grundgerüst¶

Bauen Sie zuerst ein Fundament für Ihre Dokumentation. Dies kann anfangs sehr klein sein und nur wenige Gruppen umfassen, aber mit der Zeit wird die gesamte Plattform wachsen. Überprüfen Sie Ihre Organisationsstruktur regelmäßig.

Denken Sie daran: Sie sind der Lehrer und verantwortlich dafür, wie Ihre Schüler lernen. Je mehr Zeit Sie in die Struktur investieren, desto erfolgreicher werden Ihre Nutzer sein.

Nutzen Sie multimediale Techniken¶

Verwenden Sie Videos, Zeichnungen und verschiedene Stile, die Sie direkt in Ihre Dokumentation einbetten. Docsie ermöglicht die Einbettung all dieser Elemente auf unserer Plattform.

Diese helfen nicht nur den Kunden, Ihre Informationen besser zu verstehen, sondern bieten auch hervorragende Suchmaschinenoptimierung, die zu mehr hochwertigen Leads durch Ihre dynamische Dokumentation führt.

Sorgen Sie für Durchsuchbarkeit¶

Verschiedene Wissensdatenbanken bieten unterschiedliche Suchfunktionen – einige haben nur einfache Suchen ohne Segmentierungsmöglichkeiten (was in Ordnung ist, wenn Sie nicht Tausende von Dateien haben), andere bieten Abfragemöglichkeiten für Dokumente und sogar Benutzernamen.

Entscheidend ist: Nutzen Sie ein Tool mit schneller Suche. Eine integrierte Suchfunktion ermöglicht das einfache Suchen und Vorschauen von Dateien, ohne die App zu verlassen.

Docsie bietet eine dynamisch durchsuchbare Navigation für leicht zugängliche Informationen.

Ständige Verbesserung und Aktualisierung¶

Das Erstellen und Nutzen von Dokumenten ist schwierig, weil sie von ihren Erstellern oder Nutzern schnell vergessen werden. Dokumente stehen zudem vor verschiedenen Herausforderungen.

Mit der Zeit ähnelt die Ordnerstruktur einem Friedhof, da ältere Dokumentation tendenziell weiter unten auf dem Bildschirm verbleibt.

Gehen Sie daher regelmäßig Ihre alte Dokumentation durch und verbessern Sie sie. Ermutigen Sie auch Ihre Kollegen, dies zu tun. Docsie ermöglicht Updates durch unser fortschrittliches, einfach zu bedienendes Versionierungssystem.

Abschließende Gedanken:¶

Möchten Sie mehr darüber erfahren, wie man effektive Dokumentation schreibt? Für Software-Dokumentationsprofis gibt es viele Blogs und Informationen hier.