Projektdokumentation mit Confluence aufbauen

Einer der wichtigsten Erfolgsfaktoren von Projekten und Produkten ist Kommunikation. Und einer der Aspekte in Kommunikation ist die Dokumentation und schriftlicher kollaborativer Austausch im Team. Ich nutze dafür gerne Atlassian Confluence. Wobei jedes kollaborative Werkzeug dafür passen würde. Ziel ist eine gute Struktur, die die Auffindbarkeit von Informationen erleichtert.

Als ersten Schritt muss man verstehen, wofür welche Zielgruppe die Dokumentation nutzen möchte. Und welche dieser Zielgruppen im Fokus der Seite sein soll. Zum Beispiel:

  • Als Projektleiter:in/Produktmanager:in möchte ich mein Produkt oder Projekt planen und regelkonform dokumentieren
  • Als Umsetzungsverantwortliche:r möchte ich schnell auf Anleitungen und Artikel zugreifen, die mich in der alltäglichen Arbeit unterstützen
  • Als Stakeholder möchte ich mir schnell einen Überblick über den aktuellen Stand des Projektes verschaffen

Stolperfalle: Diese Anforderungen sollte man sich nicht „aus der Perspektive der Zielgruppe ausdenken“, sondern konkret Vertreter:innen der Zielgruppen befragen.

Dokumentation planen

Eine gute und vor allem aktiv genutzte Dokumentation braucht eine gute Informationsarchitektur, eine Landkarte, die die Navigation und die Suche nach Informationen erleichtert. Natürlich haben Organisationen, Teams und einzelne Personen da ihre Vorlieben und eine allgemeine Vorlage würde nicht viel nützen. Einige Kriterien können jedoch bei dem Aufbau helfen.

Zwecke der Dokumentation

Ich betrachte bei der Dokumentation zwei verschiedene Zwecke, die bei der Planung betrachtet werden sollen:

  • Statische Dokumentation
    • Projekthandbuch
    • Freigabedokumente
    • Release-Notes
    • etc.
  • Dynamische Dokumentation
    • Meeting-Notizen
    • Retrospektiven
    • Protokolle
    • etc.

Statische Dokumentation wird seltener genutzt, kann daher stärker in Hierarchien strukturiert werden. Die dynamische Dokumentation wird für tägliche Zusammenarbeit eingesetzt, soll daher möglichst schnell erreichbar sein.

Empfehlung für eine Struktur

Inspiriert durch einige Blogs und Videos habe ich mich für eine bestimmte Struktur entschieden. Diese Struktur priorisiert das Umsetzungsteam als die primäre Zielgruppe. Denn diese arbeitet am meisten mit der Dokumentation und muss schnell und einfach zu den richtigen Informationen gelangen.

- 🧙🏻‍♀️ Team
  - Decision Log
  - Meeting Minutes
  - Rituale und Guidelines
  - Retrospektiven
  - OPL (open point list)
  - Stakeholder
- 🎁 Produkt
  - Anforderungen
  - Architektur
  - Release
  - Testing
- 🏭 Betrieb
  - Service Plan
  - Support
  - Incident Management

Je weiter unten in dem Baum, desto weniger frequentiert werden die Seiten genutzt. Für den Anfang sollte man versuchen die Anzahl der Top-Ebenen möglichst gering zu halten und mit Bedacht erweitern. Die hierarchische Verschachtlung ist ebenfalls so flach wie möglich und so tief wie (unbedingt) nötig zu halten.

Quellen und Ressourcen

Folgende Ressourcen haben mir bei der Recherche geholfen:

* = Affiliate-Links


Beitrag veröffentlicht

in

,

von

Schlagwörter:

Kommentare

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert