Dokumentationsstandards als Orientierungshilfe

Welche Standards ihr befolgen solltet, richtet sich nach der Art der erstellten Dokumentation. Hier nennen wir einige gängige Dokumentationsarten und empfehlen Vorlagen für die entsprechenden Standards.

Projekte verlaufen grundsätzlich reibungsloser, wenn alle Beteiligten auf demselben Stand sind. Das Team benötigt eine für alle zugängliche, immer verfügbare zentrale Informationsquelle. Ohne dokumentierten Projektplan verlieren die Teammitglieder unter Umständen den Überblick und verschwenden Zeit auf Unwichtiges.

Diese Vorlage von Confluence hilft dir, die Projektdokumentation zu beschleunigen und zu standardisieren. Sie sorgt dafür, dass wichtige Informationen über alle Projekte konsistent erfasst und festgehalten werden.

Verlieren deine Teammitglieder Zeit, weil sie anderen ständig erklären müssen, wie etwas geht? Oder bist du selbst schon einmal ins Schwitzen gekommen, weil die einzige Kollegin, die sich mit einer wichtigen Aufgabe oder einem Prozess auskannte, gerade Urlaub hatte?

Diese Szenarien zeigen, weshalb dokumentierte Anleitungen so wichtig sind. Im Prinzip benötigt ihr Dokumentation zu jedem Arbeitsablauf, den dein Team wiederholt ausführt. Diese muss so gestaltet sein, dass alle Teammitglieder die entsprechende Aufgabe oder den Prozess umsetzen können.

Anleitungsdokumente sind mit festgelegten Standards effektiver und natürlich leichter zu erstellen. Auch hier erweisen sich Vorlagen als praktisch. Die Confluence-Vorlage für Hilfeartikel gibt dir zum Beispiel eine Formel für die Prozessdokumentation an die Hand.

Dokumentation für Software und andere technische Produkte kann erklären, wie das Produkt funktioniert, wie es verwendet wird, wie es entwickelt wurde und wie es sich zusammensetzt.

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.

Technische Dokumentation ist oft umfangreich, sehr detailliert und wird häufig aktualisiert. Daher sind für Genauigkeit und Effizienz die richtigen Tools besonders wichtig. Du kannst beispielsweise die vorhandenen Vorlagen in Confluence verwenden oder eigene erstellen. Confluence enthält auch Makros, die das Aktualisieren oder Wiederverwenden von Text erleichtern.

Unabhängig von der Art der erstellten Dokumentation gibt es einige wichtige Eigenschaften, die sicherstellen, dass deine Arbeit den Dokumentationsstandards entspricht und für Benutzer hilfreich ist.

• Struktur: Zu wissen, was du dokumentieren möchtest, ist eine Sache. Dies auch auf verständliche Weise zu tun, ist eine ganz andere. Neben einer logischen Reihenfolge sind auch Elemente wie Abschnittsüberschriften und Stichpunktlisten eine wichtige Orientierungshilfe für die Leser der Dokumentation.
• Verständlichkeit: Eine klare, leicht verständliche Dokumentation muss genau das richtige Maß an Details enthalten. Zu wenig Informationen sind genauso verwirrend wie zu viele. Andere Möglichkeiten, die Klarheit der Dokumentation zu verbessern, sind eine korrekte Grammatik, der Verzicht auf Fachjargon und eine eindeutige Wortwahl (d. h. das Vermeiden von schwammigen Angaben wie "oft").
• Einheitlichkeit: Einheitlichkeit ist einer der wichtigsten Punkte, wenn es um eine leicht nachvollziehbare Dokumentation geht. Beispielsweise fällt es Benutzern leichter, ein Anleitungsdokument zu befolgen, wenn es auf die gleiche Weise geschrieben ist wie andere Anleitungen im Unternehmen.

Standards tragen nicht nur zu einer besseren Dokumentation bei. Sie helfen dir auch, diese Dokumentation effektiver zu verteilen.

Dokumentation ist nur dann nützlich, wenn das gesamte Team Zugriff darauf hat. Die Teammitglieder sollen wichtige Informationen nicht auf ihrer eigenen Festplatte speichern. Sie sollen sich auch nicht auf ein einziges gedrucktes Dokument verlassen müssen, das irgendwo in einem Aktenschrank schlummert. Situationen wie diese führen zu Verwirrung und behindern die Effizienz.

Zum Beispiel kann es passieren, dass Teammitglieder, die verschiedene Versionen der Dokumentation verwenden, aneinander vorbei kommunizieren oder unabsichtlich Mehrarbeit für Kollegen schaffen. Problematisch wird es auch, wenn ein außerhalb arbeitendes Teammitglied Informationen aus Dokumentation benötigt, die nur in physischer Form im Büro vorhanden ist.

Du kannst diese Schwierigkeiten umgehen, indem du Standards für die Aufbewahrung und Verteilung von Dokumentation festlegst. Am besten geeignet ist ein zentrales Repository, also ein bestimmter Speicherort, an dem immer die aktuellen Informationen für alle zur Verfügung stehen. Es genügt jedoch nicht, alles an einem zentralen Ort zusammenzustellen. Die Teammitglieder müssen sich dort auch auf Anhieb zurechtfinden.

Wir bei Atlassian nutzen Confluence als zentrales Repository. Mit Funktionen wie der leistungsstarken Suchfunktion, strukturierten Seitenhierarchien und einem Seitenarchiv sind alle Inhalte jederzeit leicht zu finden, problemlos zugänglich und aktuell.

In Confluence steht für jedes Team oder Projekt ein Bereich zur Verfügung, in dem die zugehörige Dokumentation organisiert werden kann. Teams können dort eine Seitenhierarchie erstellen, damit alle Informationen übersichtlich und über die Seitenstruktur schnell zu finden sind. Mitarbeiter können die für sie relevanten Bereiche oder Unterseiten beobachten, um bei Änderungen des Inhalts auf dem neuesten Stand zu bleiben. Wenn du einen bestimmten Bereich oder eine Seite weitergeben möchtest, kannst du die Schaltfläche zum Teilen nutzen oder auf der Seite einen Kommentar hinterlassen, in dem du andere Teammitglieder markierst. Alle offenen Seiten in Confluence können von anderen Mitarbeitern durchsucht werden. Die Suche lässt sich mit Filtern nach Ersteller, Veröffentlichungsdatum oder Bereich eingrenzen.

Nicht nur die einzelnen Teile der Dokumentation müssen ständig aktuell gehalten werden, sondern auch das System zum Erfassen und Organisieren von Dokumenten an sich. Denke also daran, auch dafür Standards festzulegen. Wie oft musst du die gespeicherten Dokumente durchgehen und bereinigen? Trage dir dafür gezielt Zeiten im Kalender ein.

Du hast jetzt einen Überblick zum Thema Dokumentationsstandards erhalten und kannst nun mit dem Erstellen oder Überarbeiten der Richtlinien für die von deinem Team genutzten Dokumentationsarten beginnen. Wenn du jetzt Zeit in das Festlegen dieser Standards investierst, kannst du später schneller Dokumentation erstellen und diese für dein Team sinnvoller gestalten.