Das Verfassen von qualitativ hochwertigen Texten ist schwierig
und kostet viel Zeit.
Der Alltag in der Projektarbeit ist meist durch Zeitmangel und
Termindruck gekennzeichnet. Tätigkeiten, die keinen direkten
Nutzen erkennen lassen werden nur ungern zusätzlich erledigt.
Die Dokumentation des Entwicklungsprozesses gehört dazu.
Was den Managementfaktor angeht, also die grundsätzliche
Entscheidung für oder gegen die Investition in die
Dokumentation, so werden wir im Rahmen des Projekts keine
Überzeugungsarbeit leisten können. Sind die Voraussetzungen
aber geschaffen, so ist ein wichtiger Aspekt im Kontext der
Dokumentation die oft mangelnde Vorbildung und Motivation der
Mitarbeiter: Eine Methode mit Werkzeugunterstützung zur
Software-Dokumentation kann nicht erfolgreich eingesetzt werden,
wenn nicht flankierend dazu eine Weiterbildungs- und
Motivationsoffensive gestartet wird.
Des weiteren muß die Tätigkeit der Dokumentation einfacher
und von allem behindernden Ballast befreit und so nahtlos wie
möglich in den Prozeß der Software-Entwicklung integriert
werden. Dokumente sollen schrittweise entstehen, die einzelnen
Beiträge hierzu dürfen jeweils nicht zu groß sein. Hohe
Anforderungen bestehen an die Werkzeuge: Sie müssen leicht
bedienbar sein, nicht bevormundend wirken und gleichzeitig auf
Basis des Dokumenationsmodells den Zusammenhang der Textfragmente
sicherstellen. Das Selbstverständnis der Anwender muß sich
ändern, hin zu einer Dokumentationskultur: die Dokumente
sind im gemeinsam genutzten Intranet für alle Projektmitglieder
sichtbar und dienen so zum Ausweis der eigenen Produktivität.
Nur so ist mit der Bereitschaft der Anwender zu rechnen, wenn die
Mehrarbeit als eigener Vorteil aufgefaßt wird.
- Zeitmangel/Termindruck ß à Erledigung der nicht direkt
nützlichen Tätigkeit der Dokumentation.
- Geringe Vorbildung und mangelnde Motivation ß à
Anforderungen an eine hochwertige Dokumentation.
- Werkzeugunterstützung und automatische Generierung von
Struktur und Teilinhalten ß
à Bevormundung und
Einschränkung der Kreativität.
- Fragmentarische Textproduktion ß
à Integration der
Fragmente in eine geeignete Struktur
Ziel einer methodischen und werkzeugmäßigen Unterstützung
der Software-Dokumentation muß sein, diese Tätigkeit soweit als
Möglich zu erleichtern und zu automatisieren, ohne den
Entwicklungsprozeß unnötig zu bürokratisieren. Stichwortartig
nun die Lösungsaspekte:
- Vorstrukturierung: Durch die Bereitstellung
vordefinierter Gliederungen für die verschiedenen
Dokumenttypen und deren konsequente Verwendung wird das
Schreiben der Texte, das Lesen und das manuelle wie auch
das werkzeuggestützte Wiederfinden stark vereinfacht.
Über diesen Punkt besteht Konsens und es sind eine Reihe
von standardisierten [XXX-Referenz] sowie viele
firmenspezifische Gliederungen verfügbar. Die Verwendung
der Musterform*
für die Gliederung der Dokumentation von
Musterkomponenten*
war Gegenstand der Diskussion [Referenz - Pattern Mailing
Liste], wurde unseres Wissens aber bisher nicht in
größerem Rahmen und werkzeuggestützt eingesetzt. Für
die Dokumentation von Musterausprägungen*
wird eine Untermenge der Mustergliederung*
verwandt [Odenthal&Quibeldey-Cirkel, 1997].
Die Gliederungen werden Teil des Dokumentationsmodells
sein, das durch den Anwender auf seine Bedürfnisse
angepaßt werden kann.
- Generierung: Eine Entwicklungsumgebung*, die den Entwerfer
beim Dokumentieren unterstützt, sollte außer der
Gliederung auch Teile der Dokumentation automatisch
erstellen. Im einzelnen handelt es sich um Diagramme,
formularbasierte Textfragmente und die Einbettung der
Dokumente in das übergeordnete Dokumentationsmodell.
Die Generierung erfolgt verzahnt mit der
Weiterentwicklung des Entwurfs.
- Tailoring: Im Zusammenhang mit der automatischen
Erstellung von Dokumentteilen steht die Steuerung dieses
Generierungsvorgangs in Abhängigkeit bestimmter
Parameter. Dies erfolgt z.T. automatisch und meist
interaktiv durch eine Abfolge von Dialogen (Wizzard-Technologie),
mit denen vom Anwender weitere Informationen über die
Gründe seines Tuns angefordert werden.
- Vorbild: Zur Dokumentation einer Musterausprägung
wird der Text des Musters als Vorbild herangezogen: der
Anwender verwendet den Mustertext als Leitfaden, zu der
er bestätigend oder kontrastierend die Dokumentation der
konkreten Ausprägung verfaßt.
- Weiterbildung: Vielleicht der wichtigste Punkt ist
die Weiterbildung der Anwender in den Prinzipien der
technischen Dokumentation. Hierfür sind verschiedene
Tätigkeiten im Rahmen des Projekts geplant. Zunächst
gilt es, die Fakten zusammenzutragen und möglichst
kompakt aufzubereiten. Diese Darstellung soll als Basis
dienen für die Erstellung von Schulungsunterlagen, einem
Handbuch für den Anwender und einer interaktiven Hilfe,
die in die Werkzeugumgebung integriert ist.
Dokumentationsmodell