CARDS+

Month: January 2017

Qualität ist Kopfsache

Ein ganz wesentliches Ziel der Methode CARDS+ ist die Qualität der Inhalte. Prinzipien und Praktiken der Methode sollen unter anderem Autoren die Pflege einer Produktdokumentation im Wiki so einfach wie möglich machen. Die wohl wichtigsten Leitsätze sind:

  • Erfasse jede Information nur an einer Stelle im Wiki.
  • Erfasse nur jene Information, für die es Leser gibt.
  • Erfasse keine Information im Wiki, die an einer anderen Stelle bereits ausreichend beschrieben wurde.
  • Lass jede Änderung mindestens einmal prüfen.
  • Ignoriere keinen Fehler.

Beachten wir sie nicht, ist es sehr wahrscheinlich, dass Inhalte im Wiki sprichwörtlich verderben. Das Schlimme an den verdorbenen Dokumenten ist, dass wir sie niemals sofort erkennen.

Continue reading

Qualität braucht Kompetenz und Verantwortung

“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.

Continue reading

Was ist der Unterschied zwischen inkrementell und iterativ?

Continue reading

Confluence-Tip Stichworte nutzen

Eine wachsende Menge an Seiten in unserem Wiki führt dazu, dass die Baumstruktur in Confluence unübersichtlich wird. Stichworte, richtig verwendet, sind sie ein sehr leistungsfähiges Mittel, um Seiten im Wiki schnell und sicher zu finden, zusätzlich zur Navigation in der Baumstruktur. Stichworte stellen neben Kommentaren und dem Gefällt-Mir-Status sehr nützliche Zusatzinformationen einer Seite im Wiki dar. Stichworte können praktisch in beliebiger Anzahl verwendet werden.

ktip Atlassian hat den englischen Begriff “label” in den deutschen Begriff “Stichwort” übersetzt. Das ist meiner Meinung nicht ganz optimal. Stichworte sind in der üblichen Definition Teil des Textes oder Titels einer Seite. Schlagworte hingegen sind Zusatzinformationen aus einem kontrollierten Vokabular. Schlagworte müssen aber nicht zwingend im Text oder Titel der Seite vorkommen. Schlagwort trifft daher den Kern der Sache besser.

Continue reading

Copyright © 2018 Impressum Datenschutz

Zum Anfang ↑