Don’t Repeat Yourself
Wiederhole dich nicht
clean-code-developer
Das Prinzip DRY hat zum Ziel, jede unnötige Dopplung oder Wiederholungen von Inhalten im Wiki zu vermeiden. Werden Dokumente über einen längeren Zeitraum gepflegt, ohne das Prinzip DRY zu berücksichtigen, dann entstehen sehr leicht widersprüchliche Informationen im Wiki. Dummerweise erkennen wir in den meisten Fällen nur sehr schwer oder gar nicht, welches die gültige Information ist. Der einzige Anhaltspunkt ist der Zeitpunkt der letzten Änderung. Für Autoren bedeutet die Situation zusätzliche Arbeit. Sie müssen die Widersprüche auflösen. Leser in so einer Sitauation beginnen dem Inhalt als Ganzes misstrauen. Ein Teil der Dokumentation “verdirbt” sprichwörtlich.
Wie beim Programmieren wird dieses Prinzip sehr häufig missachtet, weil es Kraft und Disziplin erfordert, es in der Praxis umzusetzen. Um diese Hürde zu überwinden, benötigen wir
- gute Strukturen, die im Team bekannt sind,
- klare Regeln, um Änderungen prüfen zu können und
- effektive Werkzeuge, um existierende Inhalte schnell und zielsicher zu finden.
Das Ziel einer redundanzfreie Struktur hilft uns bei den Punkten 1 und 2. Redundanzfrei bedeutet ja auch wörtlich frei von Duplikaten, Wiederholungen oder überflüssigen Informationen. Der Einsatz eines Wiki ist die Lösung für Punkt 3.
Der Einsatz eines Wiki ermöglicht außerdem die Verknüpfung von Begriffen im Text mit häufig gebrauchten eindeutigen Begriffen aus dem Glossar. Dadurch vermeiden wir mehrfache, eventuell widersprüchliche Erklärungen für einen Begriff.
Präsentationen, Abbildungen, Diagramme und Fotos werden in einer zentralen Medienbibliothek verwaltet. Es gibt die Bilder nur einmal, auch wenn sie in verschiedenen Seiten im Wiki angezeigt werden.
Informationen aus externen Quellen, also außerhalb des Wiki, werden über Verknüpfungen in die Produktdokumentation eingebunden. Eine gepflegte Linksammlung sorgt auch hier für Ordnung.
Die Veröffentlichung von Teilen von Code, code-nahen Artefakten und Spezifikationen im Wiki ist eine weitere wichtige Maßnahme zur Vermeidung von Dopplungen in der Produktdokumentation. Wiederholungen im Wiki, die durch mehrfache Veröffentlichungen der gleichen Spezifikation in unterschiedlichen Seiten entstehen, sind wiederrum unkritisch.