“Code smells”, sagte Kent Beck. Bei übel riechendem Code handelt es sich allgemein um Code, der einer gemeinsamen Vorstellungen von guter und lesbarer Programmierung nicht entspricht. Gleiches gilt auch für Texte einer Produktdokumentation im Wiki. Sie brauchen eine Struktur. Kein Scrum-Team braucht literarisch wertvolle Werke. Texte werden von ihnen genutzt, um ein technisches System zu entwerfen und bauen. Wortwiederholungen sind auf jeden Fall gewünscht, Begriffe werden immer gleich benutzt, Doppeldeutigkeiten vermieden.

Ein Wiki ist ein Werkzeug, mit dem die Dokumentation für ein Software-Produkt schnell und sicher erstellt werden kann. Die Methode CARDS+ stellt sicher, dass diese Dokumentation in hoher Qualität dauerhaft erhalten bleibt. Sowohl Werkzeug als auch Dokumentation müssen gepflegt werden. Ein Gärtner ist eine Person, die dafür Verantwortung übernimmt.

Experte

Ein Gärtner ist der Experte der Dokumentenstruktur.

  • Er kennt das Produkt.
  • Er beherrscht die Methode CARDS+.
  • Er ist Experte für das Wiki.
  • Er pflegt die Knowledge-Base.

Er ist in der Lage, auf Bedürfnisse der Autoren einzugehen. Im Rahmen der Methode CARDS+ macht er Vorschläge, wie Inhalte strukturiert werden. Er unterstützt die Autoren bei der Automatisierung von Vorgängen wie den Export von Teilen der Dokumentation. Er kennt das Wiki und weiß, wie es gegebenenfalls erweitert werden kann.

ktip Confluence bietet mit seinen kostenlosen und kommerziellen Addon ein Ökosystem, das kaum Wünsche übrig lässt. Der Gärtner hilft bei der Auswahl.

Autor

Es ist eine Binsenweisheit, dass nur ein Software-Experte, der selbst programmiert, auf Dauer ein guter Software-Experte ist. Entfernt er sich zu weit vom Code, besteht die Gefahr, dass er sich zum Theoretiker entwickelt und sich in seinen sprichwörtlichen Elfenbeinturm zurückzieht. Diese Erkenntnis läßt sich direkt auf das Dokumentieren übertragen. Ein Gärtner sollte daher unbedingt als Autor im Wiki arbeiten. Nur so sieht er die Probleme der anderen Autoren und erkennt die Schwierigkeiten, die Leser mit den Inhalten haben.

Coach

Ein Gärtner ist der Coach für andere Autoren und Leser, die aktiv mitarbeiten. Er erklärt die Ideen und Konzepte der Methode CARDS+ kennt alle Funktionen des Wiki. Ein Wiki erscheint auf den ersten Blick einfach. Es gibt nur fixe Absatzformate (normaler Text, ein Zitat, Code), eine begrenzte Anzahl von Überschriftenebenen und wenige, aber kombinierbare Formatierungsoptionen (in der Regel fett, kursiv, unterstrichen, durchgestrichen). Der wahre Wert eines Wiki zeigt sich aber erst durch die Verknüpfung von Inhalten. Hier ist der Gärtner ein Mentor. Sollte es notwendig sein, kann er eng mit einem Autor zusammenarbeiten, um das beste Ergebnis im Wiki zu erzielen.

ktip Eine besondere Stärke von Confluence sind seine Makros. Sie erlauben Autoren vielfältige Möglichkeiten für Gestaltung, Integration und Verknüpfung von Inhalten. Die Verwendung von Makros ist nicht immer trivial und erfordert häufig eine bestimmte Struktur der Seiten.

Verwalter

Als Verwalter übernimmt der Gärtner Verantwortung für die ganze Produktdokumentation. Er achtet darauf, dass Autoren die vereinbarten Regeln im Wiki einhalten und die vorbereiteten Seitenvorlagen benutzen. Wird die Struktur eines Bausteins geändert, passt der Gärtner die entsprechende Seitenvorlage für den Baustein an. Er organisiert die Anpassung der schon existierenden Seiten dieses Typs an die neue Form. Er gibt Autoren Hinweise auf Kommentare, die gelöscht werden können. Er übernimmt die Pflege von Seiten, für die es aktuell keinen Autor gibt, weil das Produkt an dieser Stelle fertig ist. Im Sinne kontinuierlicher Verbesserung korrigiert er Rechtschreibfehler in den Texten oder fügt gegebenenfalls Verlinkungen zum Glossar ein.

Administrator

Ein Gärtner ist der Administrator für das Wiki. Er kann Nutzer einrichten, sperren oder löschen. Wenn es Wunsch der Autoren ist, kann der Gärtner Berechtigungen für Autoren und Leser einschränken. Dazu nutzt der Nutzergruppen, die er anlegt und ändert. Er installiert und konfiguriert das Wiki.

ktip Alle diese Tätigkeiten kann ein Gärtner für Confluence durch die durchwegs gute Online-Dokumentation selbst durchführen. Bei Problemen gibt es eine Vielzahl von meistens hilfreichen Foren.

Fazit

Ein Wiki ist ein ausgezeichnetes Werkzeug, CARDS+ eine agile Methode für inkrementelles Dokumentieren. Zusammen bilden sie eine Lösung, mit der ein Team eine hochwertige Produktdokumentation erstellen kann. Aber wie das Produkt benötigt auch die Dokumentation dauerhafte Pflege. Es muss Personen geben, die das Vorgehen verstehen und Verantwortung für die Inhalte übernehmen. Das sind Gärtner, die darauf achten, dass Autoren und Leser die vereinbarten Regeln einhalten. Ohne Gärtner ist es nicht möglich, hohe Qualität dauerhaft zu erhalten.