Close

Aufbau einer besseren Dokumentation

Du hast gerade ein Projekt gestartet und bist jetzt verantwortlich für die Dokumentation (oder auch: $#*&^!%).

Wirkt diese Aufgabe auf dich erst mal beängstigend? Klar, aber deshalb helfen wir dir! Im Folgenden findest du eine Dokumentation zur Dokumentation [(zwinker)], die dich Schritt für Schritt mit Profitipps durch den Prozess führt. Packen wir's an!


Warum ist das wichtig für mich?

Einfach gesagt ist Dokumentation eine Hilfestellung für alle möglichen Tätigkeiten. Aber wie bei den meisten unerklärlich außergewöhnlichen Dingen, ist sie weitaus mehr als bloße Anleitungen. Dokumentation hilft Benutzern und Teams bei Folgendem:

Geistige Energie sparen

Erledige deine Arbeit mit dem kleinstmöglichen Aufwand und ohne zu viel darüber nachzudenken.

Konsistenz herstellen

Stelle sicher, dass deinen Lesern konsistent dieselben Informationen, Prozesse und Pläne vermittelt werden.

Arbeitsbelastung minimieren

Gestalte das Onboarding neuer Teammitglieder schnell und effizient, damit sie sofort loslegen können.

Unternehmens-Branding verbessern

Präsentiere dich sowohl deinen externen Kunden als auch internen Mitarbeitern gegenüber als hilfsbereit.

Wenn du keinen Wert bietest, wird dich niemand eines Blickes würdigen. Es liegt in deiner Hand, wie deine Leser über die angebotenen Informationen denken, und sie darüber aufzuklären, warum die Informationen wichtig sind.

Was ist Dokumentation?

Dokumentation ist all das, was du dir darunter vorstellst: eine Reihe von Dokumenten. Ein Kompass für den durchschnittlichen Endbenutzer. Ein Playbook für den Softwareentwickler. In einem eher technischen Bereich besteht die Dokumentation normalerweise aus Text oder Abbildungen, die einer Software beiliegen. Diese Dokumente dienen als Referenzhandbuch, in dem erklärt wird, wie die Software funktioniert und wie sie verwendet wird. Bei Softwareteams hat Dokumentation vielleicht die Form von Produktanforderungen, Versionshinweisen oder Designspezifikationen. Technische Teams können in der Dokumentation Code und APIs detailliert darstellen und ihre Softwareentwicklungsprozesse festhalten. Extern erfolgt die Dokumentation häufig in Form von Handbüchern und Benutzerhandbüchern für System-Admins, Supportteams und andere Endbenutzer.

Jede Dokumentation sollte in erster Linie zwei Punkte erfüllen:

1. Benutzer informieren

2. Benutzer in die Lage versetzen, eine Tätigkeit erfolgreich auszuführen

Wenn du mit einer Dokumentation beginnst, definiere zuerst das Thema und das Ziel, damit deine Leser sofort wissen, was sie lesen.

Dokumentationsarten

Wie bereits erwähnt, gibt es die verschiedensten Arten von Dokumentation und sie kann intern oder extern ausgerichtet sein. Stil und Ton, Formatierung, Mitwirkende, Zielgruppen und Inhalt unterscheiden sich je nach Art der Dokumentation. Im Folgenden sind die häufigsten Dokumentationsarten aufgeführt:



Interne Dokumentation
abbildung-teamdokumentation

Teamdokumentation

Die Teamdokumentation beleuchtet die geleistete Arbeit, damit Teams wirklich als Team arbeiten können. Sie beinhaltet Projektpläne, Zeitpläne, Statusberichte, Besprechungsnotizen und alles weitere, was ein Team für eine funktionale und effiziente Arbeitsweise benötigt. Diese Dokumentationsart ist detailliert, damit alle über denselben Informationsstand verfügen.

abbildung-referenzdokumentation

Referenzdokumentation

Die Referenzdokumentation informiert Mitarbeiter unternehmensweit über wichtige Themen, Prozesse und Richtlinien. Dies können Richtlinien sein, die von der Personalabteilung erstellt wurden, rechtliche Verfahren zur Beauftragung externer Anbieter oder Hilfeartikel zur Inanspruchnahme betrieblicher Leistungen. Denke daran, dass die Referenzdokumentation von einem kleinen Personenkreis für eine große und vielfältige Zielgruppe verfasst wurde. Daher muss auf leicht verständliche Inhalte geachtet werden.

abbildung-projektdokumentation

Projektdokumentation

Die Projektdokumentation ist natürlich projektspezifisch und gibt der Produktentwicklung die dringend benötigte Struktur. Sie enthält Vorschläge, Dokumente zu Produktanforderungen, Konstruktionsrichtlinien oder -skizzen, Roadmaps und andere relevante Informationen, die für die Entwicklung benötigt werden, mit Beiträgen von Projektmanagern, Ingenieuren, Designern usw.



EXTERNE DOKUMENTATION
abbildung-systemdokumentation

Systemdokumentation

In der Systemdokumentation werden Code, APIs und andere Prozesse beschrieben, die Entwicklern und Programmierern mitteilen, welche Methoden und Funktionen bei der Entwicklung spezifischer Software verwendet werden können, sowie Einschränkungen und Anforderungen. Codefragmente, wie beispielsweise API-Aufrufe und -Antworten, sind für diese Art der Dokumentation von zentraler Bedeutung.

abbildung-endbenutzerdokumentation

Endbenutzerdokumentation

Benutzerdokumentation ist oft die sichtbarste Art der Dokumentation. Sie sollte leicht zu lesen und zu verstehen sein und mit jeder neuen Version der Software aktualisiert werden. Zu ihr gehören "Readme"-Dokumente, Installationsanleitungen, Admin-Handbücher, Produkt-Wissensdatenbanken und Tutorials (die hilfreichste Form von allen). Wie bei der Referenzdokumentation wird sie von einer kleinen Gruppe Ersteller für eine große Zielgruppe erstellt, sodass leicht verständliche Inhalte wichtig sind.

Beispiele sind in der Dokumentation sehr wertvoll für deine Leser. Sie dienen als Brücke, um Konzepte und Ideen zu verstehen und sicherzustellen, dass die Leser tatsächlich wissen, wovon du sprichst.

Dokumentation erstellen

Das oberste Ziel ist, eine für den Leser hilfreiche Dokumentation zu erstellen. Nachfolgend findest du einige Schritte, die du als Inspiration für die Erstellung deiner Dokumentation nutzen kannst, wodurch dir diese Aufgabe hoffentlich ein wenig erleichtert wird.

1. Recherchieren

Was müssen Benutzer über dein Produkt, dein Projekt oder deine API wissen? Finde mit deinem Analysetool heraus, wonach gesucht wird, lies in Online-Community-Foren und Diskussionsgruppen und führe Benutzerrecherchen und Benutzertests durch. Außerdem musst du dein Produkt genau kennen und wissen, wie du die Fragen der Benutzer verständlich beantwortest und neue Funktionen oder Workflows erklärst.

2. Einfach loslegen

Gib klar an, was in deiner Dokumentation behandelt wird und warum es sich für die Leser lohnt, sie durchzulesen.

3. Informationen zusammenstellen

Erstelle eine Gliederung und skizziere deine Inhalte. Schreibe in einem angemessenen Ton (Menschlichkeit kommt immer gut an!) für deine Zielgruppe und achte auf einen konsistenten und prägnanten Stil. Erläutere wichtige Details klar und deutlich.

4. Formatieren

Ordne deine Seite so, dass die Leser von Anfang bis Ende leicht folgen können. Verzichte auf alles Überflüssige und lockere lange Inhalte mit visuellen Darstellungen wie Diagrammen, Screenshots und Bildern auf.

5. Korrekturlesen

Lass deine Rechtschreibfehler korrigieren. Die Korrekturleser sollten das Ziel deiner Dokumentation genau kennen. So können unklare Formulierungen und fehlende Schritte entdeckt werden.

6. Veröffentlichen

Nach der Überprüfung und Korrektur kann die Dokumentation veröffentlicht werden! Veröffentliche deine Arbeit und behalte Feedback und Kommentare im Auge. Dokumentation wird nicht einmalig verfasst, um dann in Vergessenheit zu geraten!

Wertvolle Tipps

Wie du siehst, reicht es bei der Dokumentation nicht, einfach ein paar Anleitungen und Texte zusammenzustellen. Der Wahnsinn hat tatsächlich Methode. Behalte diese Leitlinien vor, während und nach dem Erstellen deiner Dokumentation im Hinterkopf – am besten auch noch, während du schläfst:

Kurz und knapp

Deine Dokumentation sollte genau die richtige Menge an Informationen enthalten, um die Arbeit zu erledigen, ohne ein Hilfeticket erstellen zu müssen. Gib die wichtigsten Punkte an und verweise auf detailliertere Informationen.

Visuelle Darstellungen

Visuelle Darstellungen sind entscheidend für das Verständnis. Produktdesign, Codebeispiele, produktinterne Demos, Screenshots und Video-Tutorials spielen eine große Rolle dabei, dem Leser zu helfen, das Konzept, die Anleitung oder die Aufgabe vollständig zu verstehen. Achte auch auf das Layout, die Lesbarkeit und leicht verdauliche Happen.

Zielgruppengerecht

Versetze dich in deine Benutzer hinein. Lerne deine Leser kennen und versuche, ihre Anwendung deines Produkts und deiner Dokumentation nachzuvollziehen. Daran sollten sich deine Inhalte immer orientieren.

Sofort einsatzbereit

Die beste Dokumentation ist klar, prägnant, informativ und bietet vor allem einen Mehrwert für die Zielgruppe. Überlege dir, Software für Teamzusammenarbeit wie Confluence für deine Dokumentation einzusetzen, um weniger Zeit mit der Informationssuche zu verbringen und mehr Zeit damit, Vorhaben zu verwirklichen.

Mehr erfahren