Die Produktdokumentation ist ein Ergebnis des ganzen Teams. Der Product-Owner, unterstützt von Business-Analysten, beginnt mit dem fachlichen Entwurf. Zusammen mit dem Team ergänzt er die Lösung im Rahmen der Software-Architektur. Jeder Analyst, Entwickler und Tester im Team hat Anteil an einer guten Dokumentation. Er korrigiert Fehler, kommentiert Unklarheiten oder macht Vorschläge für Verbesserungen, mit Kommentaren direkt im Wiki.

Confluence bietet zwei Wege, wie Leser Kommentare hinterlassen können.

Seitenkommentare werden zeitlich geordnet im Anschluss an die Seite gezeigt. Seitenkommentare können auch beantwortet werden und bilden so eine Diskussion.

Weiterlesen auf atlassian.com

Textkommentare sind eine sehr elegante Möglichkeit, wie ein Leser Feedback zu einem bestimmten Wort oder Satz geben kann. Er muss die Textstelle nur markieren und seinen Kommentar hinzufügen.

Weiterlesen auf atlassian.com

Offener Punkt

Offene Punkte und andere Unklarheiten versucht der Autor in einem persönliches Gespräch mit dem Ersteller eines Kommentars zu klären. Ein Kommentar kann aber auch im Daily angesprochen werden, um eine Klärung zusammen mit dem Team herbeizuführen. Der Rahmen für so eine Klärung kann das regelmäßige Refinement-Meeting sein. Alternativ kann ein Workshop organisiert werden, wenn zur Klärung Stakeholder oder andere Experten erforderlich sind. Das Ergebnis der Klärung nutzt der Autor, um den Inhalt einer Seite zu verbessern.

Fehler

Es ist im ureigensten Interesse eines Autors, dass Fehler in der Dokumentation schnell gefunden werden. Das Feedback des Teams ist dabei der effizienteste Weg. Analysten, Entwickler und Tester haben unterschiedliche Sichten auf das Produkt. Ein Analyst kann die Nutzersicht einnehmen, kennt die Prozesse, und erkennt so Widersprüche. Ein Entwickler erkennt einen Fehler in der Dokumentation, weil er weiß, wie das Produkt programmiert wurde. Ein Tester kennt einen Testfall, der im Widerspruch zur Dokumentation steht. Am Ende eines Sprints darf eine Produktdokumentation nur das beschreiben, was das Produktinkrement leistet.

Metrik

Eine Seite im Wiki, die keine Kommentare enthält, ist eine gute Seite. Andererseits ist eine Seite im Wiki mit Kommentaren schlicht und einfach nicht fertig. Kommentare sind Hinweise auf Unklarheiten, offene Punkte oder Fehler. Sehr viele Kommentare aus einer von mehreren Lesern kontrovers geführten Diskussion sind ein klares Indiz für den Autor, eine Seite noch einmal intensiver zu betrachten. Kommentare sind eine Metrik für die Qualität.

Feedback

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” (“Activity Stream“). Mit dem Makro werden alle Änderungen und Kommentare von Seiten an einer zentralen Stelle im Wiki platziert werden. Durch die Einschränkung auf den Bereich (Space) der Produktdokumentation sehen

Fazit

Kommentare unterstützen die Kommunikation im Team. Sie machen Feedback einzelner Personen für alle sichtbar. Sie lösen eine Diskussion aus, wenn es kontroverse Kommentare gibt. Sie sind die einzig verfügbare messbare Größe für die Qualität einer Seite. Darum ist es besonders wichtig, dass Autoren In allen Fällen Kommentare löschen, wenn sie bearbeitet oder geklärt sind. Der Ersteller des Kommentars wird von Confluence automatisch informiert. Er kann die Änderungen an der Seite überprüfen. Im besten Fall ist nun alles gut. Ist er aber nicht zufrieden, kann er dies erneut als Kommentar in der Seite vermerken.