Die Methode CARDS+ ist ein agiler Ansatz mit dem Ziel, Produktwissen strukturiert und mit hoher Qualität zu erfassen. Ohne Wiki wird die Umsetzung jedoch nicht gelingen. Confluence vom australischen Hersteller Atlassian ist so ein Wiki. Ein Confluence-Bereich ist sehr gut geeignet für den Aufbau einer Produktdokumentation. Confluence hat alle Funktionen, die notwendig sind für die Umsetzung der Methode CARDS+. Und mit dem Add-On-Konzept gibt es eine Vielzahl von Erweiterungsmöglichkeiten für das Wiki, z.B. Glossary, Scroll-Office, Scroll-Versions und die Integration von Gliffy, Draw.io oder Balsamiq.

Wiki

In einem anderen Beitrag habe ich mich bereits mit der Frage beschäftigt, was die Anforderungen an ein Wiki für die Methode CARDS+ sind. Das Ergebnis dieser Anforderungsanalyse ist ein Fallbeispiel und Teil meines Blogs. Confluence ist ein konkretes Produkt, das alle Anforderungen erfüllt, d.h. für alle Cases der Systembeschreibung für das Wiki eine Lösung bietet. Atlassian bietet das Produkt in der Cloud an, unterstützt aber weiterhin auch eine Selbstinstallation (vgl. Beitrag bei t3n).

Bereiche

Confluence verfolgt das Konzept der Bereiche und erfüllt damit eine Anforderung von CARDS+ an ein Wiki. Eine Best-Practice ist, dass jeder Bereich für einen bestimmten Zweck verwendet wird. Im konkreten Fall wird die Produktdokumentation zu einem einzigen Bereich zusammengefasst. Nur für das Glossar wird häufig ein separaten Bereich angelegt, weil das Glossar auch für das Benutzerhandbuch, Betriebshandbuch oder allgemein für das ganze Projekt relevant ist.

Startseite

Startseite

Die Startseite ist die Seite, mit der wir unsere Leser begrüßen. Darum enthält die Startseite auch die einen Überblick über

  • Die Struktur des Wiki mit Glossar, Systembeschreibung, Architekturentwurf und Systemstruktur.
  • Eine “Word Cloud” mit den wichtigsten Begriffen in diesem Bereich.
  • Einen Schnellzugriff auf das Glossar.
  • Eine Liste der letzten Änderungen an den Seiten in diesem Bereich.

Die Startseite gibt dem Leser einen guten Einstieg in die Dokumentation. Durch die Anzeige der letzten Änderungen bekommt der Leser auch einen Überblick über den Schwerpunkt der Aktivitäten und Veränderungen in der Produktdokumentation. Optional können wir auch eine Anzeige von Beiträgen einrichten. Einen Beitrag verwenden wir dann für die Ankündigung eines wichtigen Ereignisses oder für die Dokumentation der Durchführung eines Reviews.

Glossar

Glossar

Die einfachste Lösung für ein Glossar in Confluence besteht aus Einzelseiten je Buchstabe im Alphabet als Unterseiten einer Glossar-Seite. Für einen Glossar-Eintrag gibt es eine Vorlage. Für einen neuen Glossareintrag muss der Autor in der richtigen Buchstaben-Seite des Glossar mit der Vorlage Term eine Unterseite mit dem Begriff als Titel und Stichwort anlegen und den Begriff erklären. Jede Glossareintrag-Seite kann in anderen Seiten einfach als Begriff verlinkt werden.

Atlassian schlägt in seinem Blog eine ähnliche Lösung für ein Glossar vor. Glossary ist ein spezielles Add-On. Neben der einfacheren Erfassung von Glossareinträgen bietet Glossary ein Dashboard, einen optisch ansprechenden alphabetischen Überblick und weitere sehr nützliche Hilfestellungen für die Pflege und Nutzung des Glossars.

Medienbibliothek

Medien

In vielen Wiki-Produkten werden Medien in einer speziellen Medienbibliothek verwaltet. WordPress ist so ein Wiki. Confluence ist anders. In Confluence kann jede einzelne Seite im Wiki Anhänge verwalten. Das erscheint auf den ersten Blick flexibler als die zentrale Verwaltung in einer Medienbibliothek. Das Problem dabei ist, dass wir bei einer Datei, die in mehr als einer Seite verwendet wird, schnell den Überblick verlieren. Der Autor der Seite mit dem Anhang kann sehr leicht übersehen, dass eine Änderung sich auf andere Seiten auswirkt. Autoren machen schneller den

Medien werden bei CARDS+ als Anhang einer einzigen Medien-Seite verwaltet. Jeder Autor weiß, dass eine Abbildung aus dieser Medienbibliothek in mehr als einer Seite benutzt wird. Er wird entsprechend vorsichtig und abgestimmt mit anderen Autoren Änderungen vornehmen.

ktip Natürlich ist es weiterhin möglich, Anhänge auch in anderen Seiten zu verwalten. Wir müssen uns in diesem Fall sicher sein, dass die angehängte Datei nur in dieser Seite verwendet wird.

Diese spezielle Medien-Seite ist die konkrete Umsetzung der Anforderung für eine Medienbibliothek in Confluence. Die Medien-Seite ist die Medienbibliothek.

Vorlagen

Vorlagen

Vorlagen erfüllen eine weitere wichtige Anforderung von CARDS+. Vorlagen sorgen für eine einheitliche Struktur der Seiten im Wiki. Ohne Vorlagen ist das praktisch unmöglich. Confluence bietet zusätzlich in den Vorlagen die Möglichkeit, Hilfetexte für Autoren zu hinterlegen, mit Regeln, die wir im Projekt für die Inhalte der Abschnitte in den Bausteinen festlegen. Diese Texte verschwinden beim Eintippen des ersten Zeichens durch den Autor. Sehr angenehm.

Entscheidungen

Entscheidungen

Die Seite mit den Entscheidungen ist ein gutes Beispiel, wie Confluence-Makros und Stichworte in einer Seite genutzt werden, um Inhalte zu gruppieren. Im speziellen Fall geht es darum, Entscheidungen in Kategorien einzuteilen, damit sich Leser besser zurechtfinden. Es gibt aber Fälle, in denen eine Entscheidung nicht eindeutig einer Kategorie zuordnen lässt. Kein Problem, dann wird so eine Entscheidung eben in mehr als einer Kategorie angezeigt.

ktip Entscheidungen werden als Seiten nicht in einer Seitenhierarchie strukturiert, d.h. es gibt keine Unterseiten für die Kategorien. Bei einer Entscheidung mit mehr als einer Kategorie müssen wir uns in der Seitenhierarchie nicht für eine “Hauptkategorie” entscheiden, die es oft nicht gibt.

Ein Vorteil der flachen Struktur ist, dass wir das Vorlage-Makro nutzen können, um die Autoren beim Anlegen einer Decision-Seite besser unterstützen zu können.

Fazit

Confluence erfüllt alle Anforderungen, die die Methode CARDS+ an ein Wiki stellt. Durch die große Zahl an Add-Ons gibt es praktisch jedes Problem im Zusammenhang mit Dokumentation eine brauchbare Lösung. CARDS+ und Confluence ist eine praxiserprobte Kombination, die jedes agile Projekt in die Lage versetzt, Produktwissen sicher, schnell und mit hoher Qualität für Stakeholder und Projektmitarbeiter online, mobil und offline zur Verfügung zu stellen.


Die Abbildungen stammen aus einer Confluence-Instanz, die ich vorbereitet habe als Template. Ich stelle gerne jedem interessierten Leser einen XML-Export dieses Confluence-Space zur Verfügung.

Anfragen bitte als Nachrichten direkt an mich.