Startseite

Einleitung

Dokumentation für den Endanwender

System-Dokumentation

Projektdokumentation mit SoDoM

Zusammenfassung

Literaturverzeichnis

Online-Folien

Kapitel 3 - Projektdokumentation mit SoDoM

• Motivation
• Was ist ein Vorgehensmodell?
• Was ist SoDoM - Die Komponenten

• Das Word-Frontend

• Das Browser-Frontend

• Die Glossardatenbank

• Konfigurationsverwaltung mit Continuus CM

Motivation:

Sowohl den Anspruch Entwurfsentscheidungen zu dokumentieren und somit nachvollziehbar und wiederverwendbar zu gestalten, als auch eine Dokumentation im Hinblick auf eine höher abstrakte, qualitätssichernde Dokumentation von Softwaresystemen genügt die Projekt-Dokumentation.

Häufig kommen hierbei sogenannte Vorgehensmodelle zum Einsatz.

Motiviert wird die Dokumentation insbesondere dann, wenn effektive Werkzeuge zur Verfügung stehen. Das Ziel des studentischen Projektes "SoDoM" an der Universität-GH Siegen ist es, mit SoDoM ein Werkzeug zu entwickeln, welches anhand des Vorgehensmodelles der deutschen Telekom AG "VM-Basis" [von der Telekom AG zum internen Gebrauch zur Verfügung gestellt] die Projekt-Dokumentation von Softwaresystemen unterstützt.

3.1 Das Vorgehensmodell VM-Basis - Eine kurze Erläuterung

In der Zusammenarbeit mit externen Partnern ist das Vorgehensmodell Grundlage bei der Ausschreibung, Vertragsgestaltung und Abwicklung von Projekten. Bei der Ausschreibung wird die Vergleichbarkeit der Angebote gewährleistet. Im vertraglichen Bereich ist eine eindeutige Leistungsbeschreibung/-abgrenzung möglich. In der Abwicklung wird das Produkt im festgelegten Rahmen entwickelt.
aus VM-Basis.

Unter anderem heißt es zum Zweck des Vorgehensmodells:

Erklärtes Hauptziel eines Vorgehensmodelles ist es aber auch, ein gewisses Gleichgewicht zwischen Kosten, Zeit, Quantität und Qualität zu erreichen.
Nähere Informationen zu Vorgehensmodellen beschreibt die Arbeit "Dokumentenbasierte Software-Entwicklung: am Beispiel V-Modell97 vs. VM-Basis (Telekom AG)". Dort wird genau auf die Aufgaben und Problematik des Einsatzes von Vorgehensmodellen eingegangen.

3.2 Aufbau von SoDoM

Mit SoDoM wird dem Entwickler ein Dokumentationswerkzeug zur Verfügung gestellt, welches ihm erlaubt, während er die dem Vorgehensmodell entsprechenden Arbeitspapiere erstellt, Entwurfsbegriffe zu definieren und in einer globalen Glossardatenbank abzulegen.
Diese globale Glossardatenbank stellt ein projektübergreifenden Entwurfsbegriffsvokabular zur Verfügung. Entwurfsentscheidungen können vom Autoren direkt dokumentiert und abgelegt werden. Das Konfigurationsmanagement mit Continuus CM erlaubt es, den Entstehungsprozeß einer Begriffsdefinition auch für andere nachvollziehbar zu machen.
Die Motivation Softwarekomponenten wiederzuverwenden und somit die Produktivität entscheidend zu erhöhen, wird dadurch gesteigert, daß alle Softwarekomponenten vollständig auch in ihrem Entstehungsprozeß dokumentiert wurden.
Die mustergestützte Softwareentwicklung wird dadurch gefördert, daß in der Glossardatenbank auch Entwurfsmuster (in der Notation von Gamma et. al) verwendet werden. Somit wird die Anwendung von Design Patterns unterstützt. Außerdem wird mit steigender Anzahl der Projekte ein Wissensfundus aufgebaut, der für alle zukünftigen Entwicklungen eine gemeinsame Wissensbasis darstellt. Das Problem 3 aus der Einleitung, daß aufgrund des braindrain-Effektes Entwurfswissen verloren geht, wird dadurch erheblich reduziert. Nahmen bisher Entwickler, die ein Unternehmen verließen, daß Erfahrungswissen, welches sie in zahlreichen Projekten gesammelt hatten mit, und entfernten es damit aus dem Unternehmen, so ist es nun möglich, dieses Erfahrungswissen in der Glossardatenbank zu sichern und zu erhalten.
Durch die konsequente Unterstützung eines Vorgehensmodelles wird desweiteren eine Qualittätssicherung erreicht. Eine Qualitätsnorm wie die DIN-ISO 9001 kann somit sichergestellt werden.

Das Dokumentationswerkzeug SoDoM setzt sich aus 4 Hauptkomponenten zusammen:

• dem Word-Frontend
• dem Browser-Frontend
• der Glossardatenbank
• und dem Konfigurationsmanagement mit Continuus CM

Während das Word-Frontend hauptsächlich dazu dient, die Dokumentation, also die Arbeitspapiere des Vorgehensmodelles, zu erstellen und zu bearbeiten, erlaubt das Browser-Frontend in den erstellten Arbeitspapieren und der Glossardatenbank zu navigieren und nach bestimmten Begriffen und Definitionen zu suchen.

3.2.1 Das Word-Frontend

Die Funktionalität von Word wird um ein Add-On von SoDoM erweitert. Dem Autoren, der die Arbeitspapiere gemäß dem Vorgehensmodell bearbeitet, werden während der Bearbeitung die in der Glossardatenbank enthaltenen Begriffe farbig unterlegt, ähnlich wie das bereits von der Rechtschreibhilfe her bekannt ist. Auf Wunsch kann der Autor bestimmte Begriffe markieren und mittels eines Kontextmenüs den markierten Begriff neu definieren beziehungsweise redefinieren. Bei redefinierten Begriffen wird der Entstehungsprozeß festgehalten. Genauere Informationen zum Aufbau und der Funktionsweise des Word-Frontend sind unter Hauptseminar-Homepage in der Seminararbeit "Autoren-Frontend für die Software-Dokumentation" von Thorsten Pelz zu finden.

3.2.2 Das Browser-Frontend

Das Browser-Frontend stellt ein zweites wichtiges Anwenderinterface dar. Mit Hilfe des Browser-Frontends ist es einem Leser möglich in der Glossardatenbank verschiedene Aktionen durchzuführen. Mittels einer Anfrage an das Konfigurationsmanagement Continuus CM wird ein schreibgeschützter Zugriff auf die Glossardatenbank etabliert. Mittels des Browser-Frontends werden folgende Funktionen dem Leser zur Verfügung gestellt:

• die Glossardatenbank nach einem bestimmten Kriterium zu sortieren.
  Dabei ist es möglich ein Tailoring, das heißt eine Beschränkung auf bestimmte Kriterien, auf den Datenbestand anzuwenden.

• den Definitionsprozeß eines Begriffes nachzuvollziehen.
  Dies geschieht durch die Nachvollziehbarkeit des Entstehungsprozesses. Bei jeder Definition oder Redefinition werden ein Zeitstempel und Angaben über Autor, Projekt etc. gespeichert.

• die Glossardatenbank nach bestimmten Suchkriterien zu durchsuchen.

• eine hyperlinkgestützte Navigation innerhalb der Glossardatenbank.

Screenshots vom Browser-Frontend sind zur Zeit leider noch nicht verfügbar, da es sich noch in der Entwicklung befindet. Näheres zum Entwicklungsstand, den Zielen und erste Previews werden in Kürze auf der SoDoM-Homepage zu finden sein.

3.2.3 Die Glossardatenbank

Die Glossardatenbank stellt das zentrale Element des Dokumentationswerkzeugs SoDoM dar. In ihr werden alle Begriffe und deren Definitionen verwaltet. Nähere Informationen zum Aufbau und der Funktionsweise der Glossardatenbank sind unter dem Titel "Aufbau und Funktion von Glossaren als Dokumentationsmittel" von Sven Dehmel zu finden.

3.2.4 Konfigurationsmanagement mit Continuus CM

Die Verwaltung der Zugriffe auf die Arbeitspapiere ist die Hauptaufgabe des Konfigurationswerkzeuges Continuus CM. Sollen Arbeitspapiere bearbeitet werden, müssen sie zunächst unter Continuus CM ausgecheckt und nach ihrer Bearbeitung wieder unter Continuus CM eingecheckt werden. Dies sichert die Datenkonsistenz der Arbeitspapiere. Auch die Glossardatenbank wird mit Hilfe von Continuus CM verwaltet. Mit dem Konfigurationsmanagement im Detail hat sich Richard Schuller unter dem Arbeitstitel "Konfigurations-Management am Beispiel von Continuus® beschäftigt.