Confluence
Optimaler Werkzeugeinsatz
Das Wiki ist ein wesentlicher Bestandteil des Gesamtkonzeptes von cards+.
Ein Wiki ist eine Sammlung von Web-Seiten, deren Inhalte von den Besuchern nicht nur gelesen, sondern auch direkt im Web-Browser bearbeitet und geändert werden können. Das Ziel ist, Erfahrung und Wissen gemeinschaftlich zu sammeln (kollektive Intelligenz) und in für die Zielgruppe verständlicher Form zu dokumentieren.
Wikipedia
Ohne ein Wiki wird die Methode cards+ nicht gelingen! Confluence ist mit Sicherheit eine gute Wahl. Durch die große Zahl an Add-Ons gibt es praktisch für jedes Problem im Zusammenhang mit Dokumentation eine brauchbare Lösung. Die Kombination von Confluence und cards+ ist in der Praxis mehrfach erprobt. Sie versetzt jedes agile Entwicklungsprojekt in die Lage, Produktwissen schnell und in hoher Qualität zu entwickeln und ohne Hürden allen interessierten Parteien zur Verfügung zu stellen.
Das Wiki bildet außerdem das zentrale Verzeichnis für dokumentierte Informationen in anderen Werkzeugen, z.B. Spezifikationen in einem Git-Repository, Testpläne in einem Testmanagementsystem oder Normen, Richtlinien, Verordnungen, die für das Produkt relevant sind, in einem unternehmensweiten Dokumentenmanagementsystem.
Die PDF-Datei wird mit dem PDF.js Viewer angezeigt.
Confluence
Dokumentation agil entwickeln
Confluence ist die Entwicklungsumgebung der Autoren. Es gibt Bereiche, Seiten, Seitenvorlagen und Anhänge in den Seiten. Die Kommentarfunktion gibt Autoren und Lesern die Möglichkeit, Feedback zu den Inhalten zu geben. Mit dem Berechtigungskonzept können die Rollen Leser, Autor und Gärtner abgebildet werden.
Confluence organisiert Seiten in Bereiche (engl. spaces) und erfüllt damit eine wichtige Anforderung von cards+ an ein Wiki. Dem Prinzip SOC folgend sollte jeder Bereich ausschließlich einen bestimmten Zweck verfolgen. Aus dieser Motivation wird die Produktdokumentation zu einem einzigen Bereich zusammengefasst. Nur für das Glossar wird häufig ein separater Bereich angelegt, weil das Glossar auch für diverse Handbücher, Betriebsanweisungen oder ganz allgemein für das ganze Entwicklungsprojekt relevant ist. Mit anderen Worten: Das Glossar kann und soll auch in der Projektdokumentation verwendet werden.
Die Grundfunktion von einem Wiki ist es, Seiten (engl. pages) mit
Inhalten bereitzustellen. Der
Seiteneditor von Confluence bietet
einfache Grundfunktionen. Ein Autor kann aus sechs
Überschriftenebenen, drei Absatzformaten (normal
oder
für Code) und kombinierbaren Schriftstilen
(fett, kursiv, unterstrichen,
durchgestrichen) wählen. Zusätzlich bietet Confluence
mit einer großen Auswahl an Makros noch weitere
Gestaltungsmöglichkeiten, z.B.
mehrspaltige Texte oder Code-Blöcke.
Seitenvorlagen (engl. templates) erfüllen eine weitere wichtige Anforderung von cards+. Sie 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. Diese Texte verschwinden beim Eintippen des ersten Zeichens durch den Autor. Sehr angenehm.
Wie wichtig eine zentrale Verwaltung von Medien hat, zeigt sich erst nach längerer Zeit. Eine Medienbibliothek ist ein Konzept, um Präsentationen, Fotografien (z.B. vom Flipchart oder Whiteboard), Abbildungen und Diagramme in verschiedenen Formaten an einem zentralen “Ort” im Wiki abzulegen. Für die Umsetzung des Konzeptes legt ein Autor für jede Datei eine Medienseite mit einem aussagekräftigen eindeutigen Titel an. Im Anhang der Medienseite fügt er die Datei und ein Vorschaubild für die Anzeige im Wiki ein und vergibt Stichworte, um die Medienseite besser auffindbar zu machen.
Die zentrale Verwaltung von externen Links in einer Linksammlung folgt der Idee der Medienbibliothek. Autoren sind durch die Linksammlung unabhängig von der Strategie der Versionierung in den externe Quellen. Denn externe Quellen haben oft eine abweichende, häufig inkompatible Strategie zur Versionierung der Dokumente und Unterlagen. Selbst Unterlagen aus Papier können auf diese Art in das Wiki integriert werden, z.B. mit den Koordinaten in das Papierarchiv (z.B. Schrank, Ordner oder Lade). Für die Umsetzung des Konzeptes legt ein Autor legt für jeden Link eine Linkseite mit einem aussagekräftigen eindeutigen Titel an. Im Anhang der Linkseite fügt er ein Vorschaubild für die Anzeige im Wiki ein und vergibt Stichworte, um die Linkseite besser auffindbar zu machen. Die Linksammlung können Autoren nun verwenden, um extern verwaltete Dokumente und Unterlagen mit einem von ihnen gewählten Namen im Wiki zu verwenden.
Confluence
Kommentare erfolgreich moderieren
Confluence hat viele Funktionen für die Erstellung und Moderation von Kommentaren. Es gibt grundsätzlich zwei Wege, wie Leser Kommentare hinterlassen können. Seitenkommentar und Textkommentar.
Ein Seitenkommentar ist ein Hinweis, der sich auf die ganze Seite bezieht. Er wird zeitlich geordnet im Anschluss an die Seite gezeigt. Der jüngste Kommentar ist immer der oberste Kommentar, der angezeigt wird. Jeder Seitenkommentare kann beantwortet werden und bildet so eine hierarchisch dargestellte Diskussion. Erledigte Seitenkommentare können nur gelöscht werden.
Ein Textkommentar ist eine sehr elegante Möglichkeit, wie ein Leser Feedback zu einem bestimmten Wort oder Satz geben kann. Er muss nur einen Teil des Textes markieren und seinen Kommentar hinzufügen. Für Leser der Seite wird dieser Text dann hervorgehoben. Textkommentare können auch beantwortet werden, bilden aber anders als Seitenkommentare keine Hierarchie. Erledigte Textkommentare werden gelöscht oder nur gelöst. Gelöste Kommentare sind für Leser unsichtbar. Ein Autor kann sie aber jederzeit nachlesen.
Eine schöne Funktion von Confluence ist die Benachrichtigung des Autors einer Seite, wenn ein Leser einen neuen Kommentar geschrieben hat. Der Autor verliert nie den Überblick über die Kommentare. Er entscheidet aber selbst über den Zeitpunkt, zu dem er einen Kommentar bearbeitet. Die gleiche Funktion informiert den Leser, der den Kommentar erstellt hat, wenn er gelöscht bzw. gelöst wurde. Benachrichtigungen sind automatisch erzeugtes Feedback.
Ein für alle Autoren und Leser sichtbares Feedback gibt das Makro “Zuletzt aktualisiert” (engl. “Activity Stream“). Mit dem Makro werden alle Änderungen und Kommentare von Seiten in der Startseite des Bereiches platziert. Durch die Einschränkung auf den Bereich sehen Leser nur mehr relevante Änderungen. So kann sich ein Leser sehr bewusst über die Veränderungen einer bestimmten Produktdokumentation informieren.