Das Ergebnis der Aktivitäten kleiner, mittlerer und großer Organisationen sind Produkte, die ohne Produktdokumentation nicht auskommen. Warum?

Produktdokumentation wird in den meisten Fällen mit dem Produkt geliefert. Sie enthält Details zur Arbeit mit dem Produkt, Anweisungen zur Verwendung, Haftungsausschlüsse und andere wichtige Details zum Produkt. Es wäre jedoch naiv zu denken, dass Produktdokumentation nur ein Flyer oder eine Broschüre ist, die Sie in der Produktverpackung finden. Es ist ein viel breiterer Begriff. Die Produktdokumentation ist nicht nur für Verbraucher bestimmt. Die Verbraucherdokumentation umfasst die minimal erforderlichen und gesetzlich vorgeschriebenen Informationen, die je nach Produkt erheblich variieren.

Auch die Organisation selbst muss die Produktdokumentation aufbewahren. Stellen Sie sich zum Beispiel einen Automobilhersteller vor. Wie viel Dokumentation muss über ein Fahrzeug bereits seit der Planung existieren. Im Fahrzeug finden Sie im Handschuhfach jedoch nur eine sehr kurze Bedienungsanleitung. Dasselbe gilt für Software, bei der der Anbieter über das Produktdesign, den Quellcode, Beschreibungen der Infrastruktur verfügt, während der Benutzer nur mit einem Handbuch arbeitet, das oft in vielen Sprachvarianten verfügbar ist, obwohl das Produkt für den globalen Markt völlig identisch ist.

Produktdokumentation in Confluence

Confluence ist ein ideales Tool für Systemdokumentation, insbesondere für den internen Gebrauch in Organisationen. Die Dokumentation wird von Mitarbeitern der Organisation erstellt, die eine Confluence-Lizenz haben, und wird von Teammitgliedern abgerufen, die ebenfalls eine Lizenz besitzen. Wenn Sie an der Dokumentation mit Partnern oder Subunternehmern zusammenarbeiten müssen, empfehlen wir die Nutzung des Gastzugangs (Guest). Dieser Zugang ist kostenlos. Er ist auf einen Confluence-Bereich (Space) und pro lizenzierte Person auf bis zu 5 Gastzugänge beschränkt. Ein Gast kann in dem zugewiesenen Bereich Seiten anzeigen, erstellen, bearbeiten, kommentieren…

Ein wichtiger Schritt bei der Erstellung der Dokumentation ist eine gut durchdachte Struktur der Bereiche. Eine Möglichkeit ist es, jedem Produkt einen eigenen Bereich zuzuweisen. Berechtigungen für lizenzierte Benutzer und Gäste können einfach nach dem jeweiligen Bereich festgelegt werden. Confluence bietet auch die Möglichkeit, anonymen Benutzern Zugriff zu gewähren, was bedeutet, dass jeder ohne Konto auf einen ausgewählten Bereich zugreifen kann. So lassen sich Benutzerhandbücher effektiv für die Öffentlichkeit freigeben.

Viele physische Produkte enthalten heute keine gedruckten Handbücher mehr, sondern verweisen auf digitale Versionen über URLs oder QR-Codes. Häufig führen sie zu einer Produktwebsite mit einem Benutzerhandbuch. Allerdings sind Webvorlagen für technische und umfangreiche Dokumentation oft weniger geeignet. Confluence und andere spezialisierte Tools bieten weitaus bessere Funktionen für die Verwaltung umfangreicher Dokumentationen und erleichtern die Verteilung von Informationen an Benutzer.

Welche Hauptvorteile bietet Confluence?

• Versionskontrolle – Verwaltet verschiedene Dokumentationsversionen und bietet Vergleichsmöglichkeiten (was hinzugefügt, entfernt, geändert wurde), einschließlich Angabe von Änderungen, Zeitpunkt und Autor. Möglichkeit, zu einer älteren Version zurückzukehren und die Bearbeitung fortzusetzen.
• Vorlagen – Sparen Zeit und helfen, die Dokumentstruktur beizubehalten.
• Zusammenarbeit – Es ist unerlässlich, dass mehrere Autoren gleichzeitig an einem Dokument arbeiten können und es kommentieren und Diskussionen darüber führen können.
• Erweiterte Suche – Je mehr Produkte, desto mehr Dokumente. Es wird sicherlich einen Zeitpunkt geben, an dem Sie nicht nur nach dem Dokumentnamen, sondern auch nach dessen Inhalt suchen.
• Sicherheit – Bei interner Dokumentation möchten Sie sicherstellen, dass Sie keine Wettbewerbsvorteile verlieren, die durch Veröffentlichung an einen Mitbewerber weitergegeben werden könnten.
• Datensicherung – Datenverlust ist unerwünscht, sei es bei bereits abgeschlossenen oder noch in Bearbeitung befindlichen Dokumenten.

Übersichtliche Seitenstruktur mithilfe von Page Tree Visualization

Page Tree Visualization bietet eine einfache und intuitive Möglichkeit, die Struktur Ihrer Seiten in Confluence zu visualisieren und zu verstehen.

• Einfachheit – Der Benutzer fügt lediglich das Makro der Anwendung in eine Seite ein, und diese zeigt sofort die Prozesskarte an.
• Übersichtlichkeit – Ein Blick auf die Seite zeigt dem Benutzer den gesamten Prozessablauf.
• Zeiteinsparung – Der Benutzer muss keine Prozesskarte in Confluence zeichnen, die Anwendung erstellt sie automatisch.
• Integration – Die Anwendung lässt sich leicht in Confluence integrieren und ermöglicht Benutzern das Erstellen, Bearbeiten und Teilen von Visualisierungen auf verschiedenen Seiten und in verschiedenen Bereichen von Confluence.

Welche Dokumentationstypen gibt es?

Systemdokumentation

Wird „intern“ von Entwicklern, Designern… verwendet. Der technische Teil richtet sich an ein hoch technisches Publikum. Neben Textbeschreibungen enthält sie verschiedene Zeichnungen, Modelle usw. Die Systemdokumentation kann auch einen geschäftlichen Teil enthalten, der für Vertriebsmitarbeiter, Marketingmitarbeiter und verwandte Rollen bestimmt ist. Das Wesentliche an der Systemdokumentation ist, dass sie nicht öffentlich zugänglich ist.

Die Systemdokumentation für Softwarelösungen könnte weiter unterteilt werden in:

• Produktanforderungen
• UX-Design
• API-Dokumentation
• Architekturübersicht
• Quellcode
• Produkt-Map
• Testpläne

Vorteile der Systemdokumentation:

• Ohne technische Spezifikationen und Design wäre es nicht möglich, das Produkt zu erstellen oder weiterzuentwickeln.
• Systemdokumente ermöglichen technischen und geschäftlichen Teams die Zusammenarbeit bei der Entwicklung und Vermarktung.
• Bei Mitarbeiterfluktuation hilft sie neuen Teammitgliedern, das Produkt/den Service schneller zu verstehen.

Benutzerdokumentation

Stellt Endbenutzern Informationen zur Verfügung, die für eine erfolgreiche Nutzung des Produkts oder der Dienstleistung erforderlich sind. Abhängig von der Zielgruppe richten sich die Anleitungen an ein mehr oder weniger technisches Publikum. Beispiele sind Benutzerhandbücher, Schnellstartanleitungen und Fehlerbehebungsanleitungen.

Für ein Softwareprodukt könnte die Benutzerdokumentation umfassen:

• Benutzerhandbuch
• Installationshandbuch
• Schulungshandbuch
• Schnellstartanleitung
• Fehlerbehebungsanleitung
• FAQs

Vorteile der Benutzerdokumentation:

• Erhöht den Produktwert
• „Schließt“ das Potenzial des Produkts auf
• Baut das Vertrauen des Kunden auf
• Steigert den Umsatz, was für den Kundensupport entscheidend ist
• Reduziert die Notwendigkeit für Kundensupport-Teams

Wie erstellt man qualitativ hochwertige Produktdokumentation?

Hier eine kurze Erklärung, was Produktdokumentation ist, welche Typen es gibt und was sie umfasst. Es gibt einige grundlegende Schritte, die zu befolgen sind:

• Identifizieren Sie die Zielgruppe – Bevor Sie mit der Inhaltserstellung beginnen, sollten Sie sich fragen, wer die Informationen nutzen wird. Dies betrifft nicht nur das Fachniveau des Inhalts, sondern vor allem die Anforderungen, die die Dokumentation erfüllen soll.
• Strukturieren – Strukturierung, Kategorisierung und Segmentierung machen die Informationen für den Leser lesbarer und verdaulicher.
• Einführung hinzufügen – Das fertige Dokument kann sehr umfangreich sein. Daher ist es ratsam, das Produkt zu Beginn kurz zu beschreiben, auch wenn die weiteren Teile des Dokuments sehr technisch und fachlich sind.
• Seien Sie präzise – Geben Sie nur notwendige Informationen an und vermeiden Sie irrelevante Informationen.
• Vorlagen verwenden – Wenn Sie Dokumente regelmäßig erstellen, steigern Sie Ihre Effizienz mit vordefinierten Vorlagen.

Wo sollte die Produktdokumentation erstellt werden?

Es gibt viele Dokumentationstools. Welches sollte man wählen? Dieser Artikel behandelt nur Confluence. Die Wahl des Tools hängt jedoch beispielsweise ab von:

• Der Art der zu erstellenden Dokumente
• Der Notwendigkeit, Dokumente intern oder extern zu verteilen.

In Bezug auf Confluence empfehlen wir die Erweiterung durch die Anwendung Refined for Confluence. Die Bereiche und Seiten von Confluence werden dadurch um eine Ansicht erweitert, die die Anwendung „Site“ nennt – eine Art Navigationsseite. Sie kann mehrere Bereiche bündeln oder auf diese und externe Quellen verweisen. Die Startseite hat einen eigenen Editor, in dem Administratoren das Thema (Hintergrund, Symbolstil, Schriftart…) und die Module konfigurieren, aus denen sie besteht. Module können als Bausteine betrachtet werden, aus denen sich die Navigationsseite zusammensetzt. Es gibt eine Vielzahl von Modulen für Inhaltsautoren, die entweder den Inhalt oder die Funktionalität unterstützen, die benötigt wird.

Marek Vejrosta

Atlassian-Berater

Wenn Sie Hilfe von Experten bei der Einführung oder Konfiguration von Jira und Confluence benötigen oder Tipps zur effektivsten Nutzung in Ihrem Unternehmen wünschen, zögern Sie nicht, uns zu kontaktieren.

Unsere Atlassian Lösungen