CARDS+ hat Prinzipien

CARDS+ hat Prinzipien

Dokumentieren ist ein Handwerk. Wir können unsere Kreativität effizient “zu Papier” bringen, wenn wir die notwendigen Fähigkeiten besitzen. Prinzipien der Methode CARDS+ helfen uns dabei. Viele Prinzipien der Programmierer gelten auch für Autoren, in den meisten Fällen in nur leicht abgewandelter Form.

Einfach

Das Prinzip KISS hilft uns, dass wir zielgerichtet Dokumente so schreiben, dass es unsere Leser gut verstehen. “Weniger ist mehr” bedeutet oft mehr Arbeit. Einen Sachverhalt einfach zu beschreiben, auf den Punkt zu bringen, ist nicht immer leicht. Das Ergebnis hat aber einen umso höheren Wert.

Einmalig

Mit dem Prinzip DRY stellen wir sicher, dass wir den Überblick behalten und jede Information nur einmal erfassen. Bei kleineren Änderung muss nur eine Seite angefasst werden. Bei großen Änderungen erkennen wir schnell Abhängigkeiten. Dieses Prinzip ist vor allem für eine nachhaltige Produktdokumentation wichtig.

Minimal

Das Prinzip COC hat die Vermeidung von duplizierten Inhalten zum Ziel. Anders als bei dem Prinzip DRY  geht es hier um Quellen außerhalb des Wiki. Insbesondere wollen wir mit dem Prinzip COC im Zusammenhang mit Produktdokumentation den Wert von Code und Unit-Tests als Dokumentation hervorheben. Das Wiki stellt dabei nur mehr eine Art Navigationshilfe für das “Lesen” von Code dar.

Nachhaltig

Ziel des Prinzip SOC ist es, die Stärken der Projektmitarbeiter zu fördern und damit die Motivation zu erhöhen. Auch die klare Trennung von Projekt- und Produktdokumentation geht auf dieses Prinzip zurück. Denn keine Methode kann eine Lösung für alle Fragen bieten.

Effizient

Das Prinzip SLA spiegelt sich in der Struktur des Wiki wieder. Gerade bei der Beschreibung fachlicher Inhalte arbeiten sehr oft Personen zusammen, deren Fähigkeiten sehr unterschiedlich sind. Um diese Zusammenarbeit effizient zu gestalten, darf der Inhalt eines Bausteines sich in seinem Abstraktionsniveau nicht ändern.

Zielgruppenorientiert

Anders als beim Programmieren verwenden wir das Prinzip SRP beim Dokumentieren im wörtlichen Sinn. Wir legen für jeden Baustein im Wiki fest, wer der verantwortliche Autor und die Leser sind. Die Vorgaben der Methode für die Bausteine im Wiki unterstützen den Autor, den Inhalt verständlich und passend für die Zielgruppen zu schreiben.

Transparent

Der Scrum Guide beschreibt das Prinzip der «Definition of Done» (kurz DOD) als ein Werkzeug der Transparenz. Transparenz fällt einem nicht in den Schoß, sie ist ein Weg, den es zu beschreiten gilt. Transparenz ist Arbeit. Die DOD verkörpert ein explizites und geteiltes Verständnis davon, unter welchen Bedingungen ein Produktinkrement fertig ist.