Bewertung der Qualität objektorientierter Entwürfe - Worte-Projekt

8.3 Wartbarkeit 111
Diskussion
Zusammenhalt verbessert die Verständlichkeit und damit die Wartbarkeit. Durch
hohen Zusammenhalt ist die Wahrscheinlichkeit hoch, dass bei einer Änderung in der
Regel nur eine Komponente betroffen ist, da alle Aspekte einer Abstraktion an einem
Ort zusammengefasst sind. Welleneffekte treten daher in geringerem Maße auf.
8.3.5 Einheitlichkeit
Definition
Ein Entwurf ist einheitlich, wenn er einem einheitlichen Stil folgt (auch bekannt als
konzeptionelle Integrität, siehe Abschnitt 7.3.1). Der Entwurf soll, auch wenn er von
verschiedenen Personen und in mehreren Iterationen bearbeitet wurde, so aussehen,
als sei er von einer Person in einem Guss erzeugt worden.
Diskussion
Einheitlichkeit erhöht die Verständlichkeit des Entwurfs. Sie kann mit einfachen Mitteln
wie Namenskonventionen erreicht werden. Auch die Einhaltung von Standards
(auf die in der Entwurfsdokumentation hingewiesen werden muss) ist hilfreich. Die
Konventionen und Standards sollten so gewählt sein, dass alle Entwickler, die den
Entwurf bearbeiten oder als Vorlage für die Implementierung verwenden sollen, mit
ihnen vertraut sind.
8.3.6 Dokumentierung
Definition
Dokumentierung ist die Güte der Darstellung des Entwurfs in der Entwurfsdokumentation.
Sie wird beeinflusst durch die Wahl und Nutzung der Notation, die Strukturierung
der Dokumentation und deren Vollständigkeit.
Diskussion
Die Dokumentation ist für die Verständlichkeit wichtig, weil sie Bedeutung und
Zweck der Entwurfsbestandteile sowie ihr Zusammenspiel festhält. Sie sollte gut
strukturiert sein, d. h. sich durch ihren Aufbau dem Leser leicht erschließen. Außerdem
sollte sie vollständig, konsistent, präzise und korrekt sein.
Die Notation sollte allen Entwicklern vertraut und leicht erlernbar sein. Außerdem
sollte sich möglichst viel möglichst präzise in ihr ausdrücken lassen. Schließlich sollte
sie robust sein, das heißt kleine Änderungen der Syntax sollten nicht große Änderungen
der Semantik verursachen. Ansonsten können kleine Fehler in der Dokumentation
zu großen Fehlern in der Implementierung führen. Die beste Notation ist allerdings
ohne Nutzen, wenn die darin erstellte Dokumentation nichts taugt.