Warum ist die Dokumentation von Projekten wichtig?
Wir kennen das alle: Ein paar Monate nach Abschluss eines Projekts müssen Änderungen vorgenommen werden, und plötzlich fragst du dich: «Wie war das nochmal eingerichtet?» Dein Kopf raucht, aber die Details sind verschwommen. Oder: Du übernimmst ein Projekt, weil ein Kollege unerwartet ausfällt, und versuchst dich schnell in die technischen Details einzuarbeiten. Genau hier kommen Dokumentationen ins Spiel.
Oft wird Dokumentation als «extra» Arbeit angesehen, die Zeit kostet und die man lieber in andere Aufgaben stecken würde. Doch wenn man später feststellt, dass man ohne eine saubere Dokumentation das bereits vorhandene Wissen erneut erlernen muss, spart eine gute Dokumentation enorm viel Zeit. Daher empfehlen wir, alle Web- (und CRM-) Projekte ordentlich zu dokumentieren.
Dokumentationen helfen Entwicklern und Administratoren, aber auch Projektmanagern und -leitern, schnell zu verstehen, wie das System aufgebaut ist. Bei Web- und CRM-Projekten sorgen sie dafür, dass alle Teammitglieder – Entwickler, Designer, Projektmanager und andere Stakeholder – auf dieselben Informationen zugreifen können und dieses Wissen nicht bei einer Person hängen bleibt. Dokumentationen schaffen einen extremen Mehrwert für das Unternehmen und die Kunden.
Dokumentationen stellen sicher, dass alle Aspekte des Projekts – vom Code-Aufbau und den Einstellungen bei Webprojekten bis hin zu CRM-Workflows und der Datenverarbeitung – einem konsistenten und standardisierten Ansatz folgen.
Bei Artd nutzen wir zwei verschiedene Tools für die Dokumentation: Writeaguide und Confluence. Lass uns die Funktionen der beiden Tools genauer anschauen.
Writeaguide
Writeaguide ist eine zentrale Plattform für das Wissen deiner Organisation. Es hat eine einfache Oberfläche, die auch von nicht-technischen Teammitgliedern genutzt werden kann. Du kannst Sammlungen erstellen und diesen Sammlungen einzelne Guides zuweisen – ideal, wenn ein Kunde mehrere Projekte hat, die du bündeln möchtest.
Es gibt verschiedene Elemente, die du für deine Dokumentation nutzen kannst: Text, Bilder, Videos, Abschnitte, Versionsverwaltung und Kommentare von Teammitgliedern. Darüber hinaus bietet Writeaguide hierarchische Abstufungen für Titel, wobei automatisch ein Inhaltsverzeichnis erstellt wird. Du kannst sie intern oder extern teilen und gemeinsam daran arbeiten. Auch die Vergabe von Lese- oder Bearbeitungsrechten ist möglich. Ein echtes Highlight: Die Suchfunktion ist sehr gut!
Confluence
Confluence ist eher wie ein Team-Arbeitsbereich. Es enthält sogenannte «Spaces», die du wie Projekte oder Themen sehen kannst – vergleichbar mit den Sammlungen in Writeaguide. Jeder Space kann mehrere Seiten und Unterseiten haben. Du kannst Seiten miteinander verknüpfen. Außerdem gibt es eine fortgeschrittene Versionsverwaltung und eine Kommentarfunktion, und du erhältst bei Updates eine Benachrichtigung. Zudem kannst du Seiten mit Tags organisieren. Natürlich gibt es auch hier eine leistungsstarke Suchfunktion, die nach Tags, Filtern oder Stichwörtern sucht.
Confluence bietet noch mehr Funktionen: Es besitzt eine gute Integration mit anderen Atlassian-Tools, man kann Flussdiagramme erstellen und es besteht die Möglichkeit, in Echtzeit mit anderen Personen an einem Dokument zu arbeiten. Das ist zum Beispiel bei Meeting-Notizen sehr hilfreich. Es gibt über 100 Vorlagen, mit denen du eine Seite starten kannst. Confluence bietet auch die Möglichkeit, Berechtigungen einzustellen – so kannst du bestimmen, wer die Dokumente lediglich ansehen, bearbeiten oder kommentieren darf.
Vergleich
Alles in allem ist Confluence das Tool mit mehr Möglichkeiten und daher besonders geeignet für größere und komplexere Projekte. Für einfache Dokumentationen bietet Writeaguide jedoch einen leichteren Einstieg und ist einfacher zu handhaben. Preislich liegt Writeaguide zwischen 6 und 8 Euro im Monat. Confluence hat einen kostenlosen Plan für bis zu 10 Benutzer, danach gibt es verschiedene Pläne ab 5 USD pro Nutzer pro Monat.
Wie wir die Tools nutzen und warum
Bei Artd dokumentieren wir unsere Projekte in Writeaguide. Jedes Projekt, das wir für einen Kunden durchführen, halten wir dort fest. Meistens dokumentieren wir die technischen Setups, sodass wir in ein paar Monaten oder wenn ein anderes Teammitglied das Projekt übernimmt, genau sehen können, wie alles eingerichtet ist und welche Funktion bestimmte Codeteile erfüllen. Das Ganze reichern wir natürlich mit konkreten Beispielen an. Wir dokumentieren dort auch Learnings aus den Projekten, damit Kollegen bei ähnlichen Projekten von den Tipps anderer profitieren können. Writeaguide ermöglicht es uns außerdem, diese Guides leicht mit unseren Kunden zu teilen.
Confluence nutzen wir für die Dokumentation unserer internen Prozesse und Richtlinien. Diese Seiten sind oft etwas komplexer, mit Links zu Unterseiten, Prozessen und Abläufen. Für uns handelt es sich dabei um rein interne Informationen. Für diese komplexeren Themen bietet Confluence eine gute Struktur und Verknüpfungsmöglichkeiten, weshalb wir es dafür bevorzugen. Writeaguide eignet sich dagegen perfekt, um Informationen an Externe weiterzugeben – daher der Einsatz für Kundenprojekte. Mit diesen beiden Tools können wir einerseits die technische Dokumentation für die Projekte unserer Kunden sicherstellen und andererseits unsere internen Prozesse und Abläufe sauber dokumentieren.