Hierarchische Dokumentation von Objekten

Wie wird es gemacht ?
Unsere Erfahrungen haben gezeigt, daß je tiefer die Fachabteilung selbst in der EDV steckt, desto detaillierter können die erwarteten Vorgaben sein. Dem entgegen stehen natürlich Zeit und Geld. Aus diesem Grunde ist es wichtig vor der Erstellung des Pflichtenheftes den Detaillierungsgrad der Dialogbeschreibung festzulegen.

Die Festlegung des Detaillierungsgrades der Beschreibung erfolgt anhand eines Beispieldialoges. Mit diesem werden die verschiedenen Möglichkeiten der Beschreibung vorgestellt. Gemeinsam mit der Fachabteilung wird dann entschieden, in welcher Form die Beschreibung vorgenommen wird. Während der Festlegung der Form der Detaillierung müssen folgende Fragen gestellt werden:

• Ist die gewählte Form der Detaillierung sinnvoll? (Für Entwicklung oder Anwender)
• Enthält die gewählte Form der Detaillierung den notwendigen Informationsgehalt?
• Ist die gewünschte Form der Detaillierung unter den zeitlichen und ökonomischen Rahmenbedingungen möglich?

Erst wenn alle diese Fragen befriedigend beantwortet werden konnten, kann mit der eigentlichen Beschreibung der Dialoge begonnen werden.

Varianten der Beschreibung von Dialogen
Anbei finden Sie Beispiele, wie man einen Dialog beschreiben kann. Als Vorlage für diese Beispiele dient der zu Beginn des Kapitels dargestellte Dialog. Wir haben bisher zumeist die Variante "klein" eingesetzt. Die anderen Varianten der Dokumentation haben sich in unserer Arbeit oft als zu zeitaufwendig und zu teuer erwiesen.

Die dargestellten Varianten sind als Vorschlag zu verstehen und erheben nicht den Anspruch auf Vollständigkeit. Entscheiden Sie selbst welche dieser Varianten Sie nutzen wollen.

Sollte eine Nachdokumentation einer bereits bestehenden Anwendung durchgeführt werden müssen, so hat sich folgende Form der Dialogbeschreibung bewährt:

Die Felder Herkunft und Weiterverwendung helfen in diesem Falle die Zusammenhänge innerhalb der Applikation auf der kleinsten Ebene darzustellen. Auf diese Weise kann schrittweise eine Anwendung nachdokumentiert werden.