Das Prinzip DRY

Don’t Repeat Your­self

Wieder­hole dich nicht

clean-code-developer

Das Prinzip DRY hat zum Ziel, jede unnö­tige Dopplung oder Wieder­holungen von Inhalten im Wiki zu ver­meiden. Werden Doku­mente über einen längeren Zeit­raum gepflegt, ohne das Prinzip DRY zu berück­sichtigen, dann ent­stehen sehr leicht wider­sprüchliche Infor­mationen im Wiki. Dummer­weise erkennen wir in den meisten Fällen nur sehr schwer oder gar nicht, welches die gültige Infor­mation ist. Der einzige Anhalts­punkt ist der Zeit­punkt der letzten Änderung. Für Autoren bedeutet die Situation zusätz­liche Arbeit. Sie müssen die Wider­sprüche auflösen. Leser in so einer Sitauation beginnen dem Inhalt als Ganzes miss­trauen. Ein Teil der Doku­mentation “ver­dirbt” sprich­wörtlich.

Wie beim Program­mieren wird dieses Prinzip sehr häufig missachtet, weil es Kraft und Diszi­plin erfor­dert, es in der Praxis umzu­setzen. Um diese Hürde zu über­winden, benöti­gen wir

  1. gute Struk­turen, die im Team bekannt sind,
  2. klare Regeln, um Änderungen prüfen zu können und
  3. effek­tive Werk­zeuge, um exis­tierende Inhal­te schnell und ziel­sicher zu finden.

Das Ziel einer redun­danz­freie Struk­tur hilft uns bei den Punkten 1 und 2. Redun­danz­frei bedeu­tet ja auch wört­lich frei von Dupli­katen, Wieder­holun­gen oder über­flüssi­gen Infor­matio­nen. Der Eins­atz eines Wiki ist die Lösung für Punkt 3.

Der Ein­satz eines Wiki ermög­licht außer­dem die Ver­knüp­fung von Begrif­fen im Text mit häufig gebrauch­ten ein­deutigen Begriffen aus dem Glossar. Dadurch ver­meiden wir mehr­fache, even­tuell wider­sprüch­liche Erklä­run­gen für einen Begriff.

Präsen­tationen, Abbil­dungen, Dia­gramme und Fotos werden in einer zen­tralen Medien­biblio­thek ver­waltet. Es gibt die Bil­der nur einmal, auch wenn sie in ver­schiede­nen Seiten im Wiki ange­zeigt werden.

Infor­matio­nen aus exter­nen Quellen, also außer­halb des Wiki, werden über Ver­knüpfun­gen in die Pro­dukt­doku­men­tation einge­bun­den. Eine gepflegte Link­sammlung sorgt auch hier für Ord­nung.

Die Ver­öffent­lichung von Tei­len von Code, code-nahen Arte­fak­ten und Spezifi­katio­nen im Wiki ist eine weitere wich­tige Maß­nahme zur Ver­meidung von Dopplun­gen in der Pro­dukt­doku­men­tation. Wieder­holun­gen im Wiki, die durch mehr­fache Ver­öffent­lichun­gen der gleichen Spezifi­kation in unter­schied­lichen Seiten ent­ste­hen, sind wieder­rum unkri­tisch.