Methode

Kommen­tare erfolg­reich mode­rieren

Die Methode cards+ ver­folgt ein sehr wich­tiges Ziel. Eine leben­dige Pro­dukt­doku­mentation. Sie lebt u.a. durch das Feed­back der Leser. Feed­back als Kommen­tare in den Seiten des Wiki ist für alle sicht­bar, auch eventuell daraus ent­stehende Diskus­sionen. Feed­back ist jeder­zeit will­kommen. Die Erstel­lung und Pflege von Inhalten im Wiki ist Auf­gabe der Autoren. Dazu gehört auch die Mode­ration der Kommen­tare der Leser in den Seiten. Im Sinne der Nach­haltig­keit entfernt der Autor einer Seite Kommen­tare, die bereits zur Korrek­tur der Doku­mentation ver­wendet wurden. Nicht mehr rele­vante oder sachlich nicht korrekte Kommen­tare löscht er nach Abschluss der Klärung mit dem Ersteller des Kommen­tars. Durch dieses aktive Manage­ment der Kommen­tare schaffen wir Transpa­renz bei den Änderungen der Inhalte. Autoren können Kommen­tare auch als Indi­kator für die Quali­tät der Doku­mentation heran­ziehen.

Eine Seite im Wiki, die keine Kommen­tare enthält, ist darum eine gute Seite.

Anderer­seits ist eine Seite im Wiki mit Kommen­taren schlicht und ein­fach nicht fertig. Sehr viele Kommen­tare aus einer von mehreren Lesern kontro­vers geführten Diskus­sion sind ein klares Indiz für den Autor, das Thema der Seite noch einmal inten­siver zu betrach­ten.


Defini­tion

Welche Kate­gorien von Kommen­taren gibt es?

Verbesserung

Leser nutzen einen Text­kommen­tar, um eine redaktio­nellen Ver­besserung zu melden. Dazu zählen Recht­schreib- oder Grammatik­fehler in einem Text. Auch eine fehlende Ver­knüpfung eines Begriffes im Text mit einer Seite im Glossar ist hier gemeint. Die Korrek­tur der Seite kann ein Autor jeder­zeit und ohne umfang­reiche Abstimmung durch­führen.

Lücke

Eine interessierte Partei (z.B. ein Nutzer) findet als Leser eine Lücke in einer Beschrei­bung finden und meldet sie als Seiten­kommen­tar. Bei einer Lücke reden wir nicht von einem Fehler. Trotzdem ist jeder Hin­weis sehr will­kommen, wenn er einem Autor hilft, die Beschrei­bung besser zu machen. Die Korrek­tur der Seite kann ein Autor jeder­zeit nach erfolg­reicher Prüfung durch­führen.

Offener Punkt

Eine inter­essierte Partei (z.B. ein Ent­wickler) hat den Ein­druck, dass eine Beschrei­bung nicht voll­ständig ist. Solche Unklar­heiten bezeichnen wir als offene Punkte, bis sie geklärt sind. Offene Punkte ver­sucht der Autor der Seite so rasch wie mög­lich zu klären. Das Ergeb­nis der Klärung nutzt der Autor, um den Inhalt der Seite zu ver­bessern.

Fehler

Eine inter­essierte Partei (z.B. ein Ent­wickler) hat den Ein­druck, dass eine Beschrei­bung offen­sichtlich fehler­haft ist. Die Ein­schätzung ist subjek­tiv, bedeutet aber, dass die kommen­tierte Seite nicht mehr fertig ist. Fehler muss der Autor der Seite so rasch wie mög­lich klären. Das Ergeb­nis der Klärung nutzt der Autor, um den Inhalt der Seite zu ver­bessern.


Werk­zeug

Con­fluence

Con­fluence hat viele Funk­tionen für die Erstel­lung und Mode­ration von Kommen­taren. Es gibt grund­sätzlich zwei Wege, wie Leser Kommen­tare hinter­lassen können. Seiten­kommen­tar und Text­kommen­tar.

Ein Seiten­kommen­tar ist ein Hinweis, der sich auf die ganze Seite bezieht. Er wird zeit­lich geordnet im Anschluss an die Seite gezeigt. Der jüngste Kommen­tar ist immer der oberste Kommen­tar, der ange­zeigt wird. Jeder Seiten­kommen­tare kann beant­wortet werden und bildet so eine hierar­chisch darge­stellte Diskussion. Erledigte Seiten­kommen­tare können nur gelöscht werden.

Ein Text­kommen­tar ist eine sehr elegante Möglich­keit, wie ein Leser Feed­back zu einem bestimmten Wort oder Satz geben kann. Er muss nur einen Teil des Textes markieren und seinen Kommen­tar hinzufügen. Für Leser der Seite wird dieser Text dann hervor­gehoben. Text­kommen­tare können auch beant­wortet werden, bilden aber anders als Seiten­kommen­tare keine Hierar­chie. Erledigte Text­kommen­tare werden gelöscht oder nur gelöst. Gelöste Kommen­tare sind für Leser unsicht­bar. Ein Autor kann sie aber jeder­zeit nach­lesen.

Eine schöne Funktion von Confluence ist die Benach­richti­gung des Autors einer Seite, wenn ein Leser einen neuen Kommen­tar geschrieben hat. Der Autor ver­liert nie den Über­blick über die Kommen­tare. Er ent­scheidet aber selbst über den Zeit­punkt, zu dem er einen Kommen­tar bear­beitet. Die gleiche Funk­tion infor­miert den Leser, der den Kommen­tar erstellt hat, wenn er gelöscht bzw. gelöst wurde. Benach­richti­gungen sind auto­matisch erzeug­tes Feed­back.

Ein für alle Autoren und Leser sicht­bares Feed­back gibt das Makro “Zuletzt aktuali­siert” (engl. “Activity Stream“). Mit dem Makro werden alle Änderungen und Kommen­tare von Seiten in der Start­seite des Bereiches platziert. Durch die Ein­schränkung auf den Bereich sehen Leser nur mehr rele­vante Änderungen. So kann sich ein Leser sehr bewusst über die Ver­änderungen einer bestimmten Produkt­doku­mentation infor­mieren.