Wie Sie eine Dokumentationsstruktur erstellen, die für das gesamte Team funktioniert

Sie möchten eine zufriedene und selbstständige Benutzerbasis aufbauen? Dann machen Sie ihre Dokumentation öffentlich zugänglich. Auch die Zusammenarbeit innerhalb Ihres eigenen Produktteams kann sich stetig verbessern, wenn Ihr Team gemeinsam die Technische Dokumentation erarbeitet.

Doch Vorsicht ist geboten, denn Teams neigen dazu, sich nur auf den Inhalt selbst und nicht auf dessen Strukturierung zu konzentrieren. Gut strukturierte Inhalte beeinflussen aber nicht nur das Verständnis auf Nutzerseite, sondern ebenso das Verständnis aller beteiligten Teammitglieder.

Wie erstellen und pflegen Sie also eine gut strukturierte Dokumentation? Dieser Beitrag zeigt detailliert, worauf Sie achten sollten, damit Ihr Team großartige Dokumentationen erstellen kann.

Die beste Dokumentation wird im Team geschrieben

Für eine präzise und gut lesbare Technische Dokumentation, benötigen Sie prägnantes Produktwissen. Jeder aus dem Team kann hierzu beitragen. Das bedeutet also für Sie, darauf zu achten, dass Ihre Dokumentation nie isoliert geschrieben wird – selbst dann, wenn Sie möglicherweise einige Technische Redakteure zur Hand haben.

  • Entwickler und UX-Designer arbeiten direkt am Produkt, dessen Entwicklung, Design und Spezifikationen.
  • Vertriebs- und Marketingteams nutzen die Informationen, um Aufmerksamkeit zu generieren und Interessenten während der Entscheidungsphase zu begleiten.
  • Kundendienst- und Supportmitarbeiter verlassen sich auf die Dokumentation, um Supportanfragen zu reduzieren, aber auch um Fragen konsistent und genau zu beantworten und Feedback zu geben.

Sie brauchen also ein Werkzeug, mit dem jeder im Team auf die Dokumentation zugreifen, dazu beitragen und sie verfeinern kann - unabhängig der eigenen Rolle.

Confluence bietet eine kollaborative Lösung für die Dokumentation und kann für alle Bereiche, von der internen Kommunikation bis hin zur Projektplanung und -verwaltung, eingesetzt werden. Confluence ist somit die gemeinsame Wissensplattform für Ihr Team und das perfekte Tool um Ihre Produktdokumentation zu verfassen und zu verwalten. Von hier können Sie Ihre Inhalte sogar als öffentliches HelpCenter oder als Wissensdatenbank direkt an Ihre Benutzer weitergeben.

Die Struktur ist am wichtigsten

Unabhängig davon, ob Sie Ihre Dokumentation von Grund auf neu erstellen oder ob Sie einfach eine bestehende Technische Dokumentation überarbeiten, beginnen Sie immer mit der Struktur. Eine gute Struktur ist wichtig für den ersten Eindruck und entscheidet, ob der Nutzer weiterlesen wird.

Ihre Dokumentation sollte deshalb diese Anforderungen erfüllen:

  • Die Navigation ist einfach.
  • Inhalte sind logisch geordnet.
  • Benutzer erhalten einen schnellen und einfachen Zugang zu den wichtigsten Informationen.

Doch bevor es soweit ist, stoßen viele Dokumentations-Teams auf die gleichen Herausforderungen: Die Beteiligten halten sich weder an festgelegte Richtlinien für Inhalt und Gestaltung, noch werden neue Artikel oder Aktualisierungen in die bestehende Struktur eingepasst. Außerdem kommt es häufig dazu, dass sich Teams nicht für einen einheitlichen Ansatz zur Strukturierung von Themen entscheiden können.

Legen Sie die Struktur hingegen im Voraus fest, vermeiden Sie viele Diskussionen. Sorgen Sie für Konsistenz in Schrift und Format und definieren Sie grundlegende Richtlinien für Design-Strukturen. So bieten Sie Ihren Anwendern eine einheitliche Benutzerführung mit der sie Informationen leicht finden und deren Bedeutung verstehen können.

Ansätze zur Strukturierung von Technischen Dokumentationen

Wie entscheiden Sie, nach welchen Kriterien Sie strukturieren? Es gibt verschiedene Ansätze, die Ihr Dokumentations-Team wählen könnte:

AnsatzBeschreibung

Beispiel

ProduktstrukturVerwenden Sie einen Feature-First-Ansatz, indem Sie die Hauptfunktionen Ihres Produkts zuerst dokumentieren.Wie Sie den Editiermodus verwenden.
BenutzeroberflächeDokumentieren Sie Ihr Produkt auf Grundlage der wichtigsten Bedienelemente und der Benutzeroberflächen.Ein Rundgang durch die Änderungsprotokoll-Ansicht
AnwenderaufgabenErklären Sie in einzelnen Schritten, wie eine Aufgabe auszuführen und ein bestimmtes Ziel zu erreichen ist.Wie Sie das Theme des HelpCenters anpassen.
Endanwender-RolleBeschreiben Sie die Aufgaben und Funktionen Ihres Produkts auf Grundlage von Perspektiven und Zielen verschiedener Endbenutzer.Administratorhandbuch für die Installation

Für welche Struktur Sie sich auch entscheiden mögen, sie wird vermutlich nicht immer für alle Anwendungsfälle und Nutzergruppen passen. Ihre Technische Dokumentation wird also eine Mischung aus mehreren Ansätzen enthalten. Entscheiden Sie daher im Team, welche Ansätze am besten geeignet sind. Analysieren Sie zusätzlich Anwenderverhalten und Kundenfeedback, um diese Entscheidung zu unterstützen.

Lassen Sie sich nicht festlegen

Mit einem flexiblen Dokumentationswerkzeug wie Confluence müssen Sie sich nicht auf einen Ansatz festlegen. Es ist einfach, Artikel hinzuzufügen, zu bearbeiten und Themenstrukturen zu ändern. Ihr Team kann Ihre Dokumentation – je nach Kundenanforderung – schnell anpassen und bereitstellen. Darüber hinaus kann die Dokumentation im Internet veröffentlicht oder als PDF- oder Word-Dokument exportiert werden. 

Topics definieren

Sobald Sie sich auf eine Struktur geeinigt haben, ist es an der Zeit, verschiedene Thementypen festzulegen. So helfen Sie Ihren Autoren zu entscheiden, wie verschiedene Arten von Inhalten formuliert werden sollen. Mithilfe von Topics können Sie Ihren Inhalt in organisierte Blöcke aufgliedern und die verschiedenen Artikel klassifizieren:

  • Konzept: Ein ausführlich formuliertes Konzept, typischerweise eine lineare Seite.
  • Aufgabe: Schritt-für-Schritt-Anleitung zur Durchführung einer bestimmten Aktion, meist mithilfe einer nummerierten Liste.
  • Referenz: Enthält zusätzliche Informationen zu einem Konzept, beispielsweise eine tabellarische Seite.
  • Fehlerbehebung: Eine Problembeschreibung und Lösungsansatz mit Schritt-für-Schritt-Anleitung.

Am besten entwerfen Sie für jedes Topic einen Leitfaden und wandeln diesen in Templates um. Diese Templates helfen Ihrem Team bei der Entscheidung und ermöglichen einen schnellen Einstieg bei der Erstellung der Inhalte.

Templates helfen außerdem dabei, inhaltliche Strukturen und Designs innerhalb Ihrer Artikel einzuhalten. So kann jeder in Ihrem Team die richtigen Informationen beisteuern, ohne Mehrarbeit für Sie als Autor oder Manager zu verursachen.

Verwenden Sie Templates

Erstellen Sie mit Confluence interaktive Templates mit Elementen wie Anweisungstexten oder Variablen. Über Makros können Sie zusätzliche Funktionen hinzufügen und dynamische Inhalte einbinden.

Bessere Dokumente mit einer besseren Struktur

Wie messen Sie den Erfolg, wenn diese Schritte umgesetzt sind? Ihre Dokumentationsstruktur ist effektiv, wenn die folgenden Kriterien stimmen: 

  • Ihre Anwender sind in der Lage, Informationen schnell zu finden und ihre Bedeutung leicht zu verstehen.
  • Alle an der Dokumentation Beteiligten wissen, welche Informationen sie mit wem teilen müssen.
  • Das Team kann auf die Dokumentation zugreifen um Support-Tickets zu beantworten, Marketinginhalte zu erstellen oder komplexe Fragen von Interessenten zu beantworten.

Auch Autoren oder Manager werden einen spürbaren Unterschied sehen: Leitlinien sind leichter durchzusetzen und das Format ist konsistenter. Sie werden feststellen, dass Ihr Team tatsächlich einen Beitrag zu den Dokumenten leisten möchte, weil der Prozess weniger zeitaufwändig ist und sie vom Endergebnis gleichermaßen profitieren.

Bereit für den Einstieg? 

Viele Teams verwenden bereits Confluence, um ihre Technische Dokumentation zu verfassen und zu strukturieren. Lernen Sie Enlite kennen, um diesen Ansatz erfolgreich umzusetzen.

Möchten Sie Ihre Technische Kommunikation erfolgreicher gestalten?



Related Articles

Wir mögen Cookies

Wir nutzen Cookies, damit Sie sicher und effektiv surfen und wir unsere Website noch besser machen können.

Möchten Sie uns dabei helfen?