Hierarchische Dokumentation von Objekten

Worum geht es?
Als Dialog werden die Ausgaben von Programmen auf dem Bildschirm angesehen. Der Begriff Dialog darf hierbei jedoch nicht so umfassend wie im Sinne der Programmierung interpretiert werden. Für den Programmierer kann u. U. jede Bildschirmausgabe als Dialog gelten.

Innerhalb unserer Methode HDvO wird zwischen Dialogen und Meldungen unterschieden. Während bei Dialogen differenzierte Möglichkeiten vorhanden sind, unterschiedliche Daten zu erfassen, ist bei Meldungen nur die Reaktion auf Verarbeitungen innerhalb des Programms möglich. Als typische Beispiele für Meldungen gelten Fehler- oder Informationsmeldungen.

Wir sind in der Vergangenheit immer wieder mit der Diskussion konfrontiert worden, ob die Abbildung eines Dialoges zwingender Bestandteil eines Pflichtenheftes ist. Wir können diese Frage mit einem klaren Ja beantworten. Die Erfahrung hat gezeigt, daß das Abstraktionsniveau vieler Anwender nicht ausreicht, die Funktionalität einer Maske nur durch das Aufzählen der Felder zu erfassen.

Frei nach dem Motto "Ein Bild sagt mehr als tausend Worte" hat sich die Abbildung von Dialogen im Pflichtenheft immer bewährt. Zudem kann anhand einer Abbildung das Verhalten des Dialoges besser dargestellt werden, als wenn es dazu nur eine abstrakte Textbeschreibung gibt.

Was bringt es?
Bei der Darstellung von Dialogen sollte versucht werden, eine möglichst hohe Übereinstimmung mit der zukünftigen Dialogführung zu bekommen. Eine zeichenorientierte Darstellung grafischer Dialoge z. B. macht es der Fachabteilung nicht leichter, sich die zukünftige Anwendung vorzustellen. Nutzen Sie, wenn möglich den Maskendesigner der Anwendungsentwicklungsumgebung, mit der die Software erstellt wird. Sollte dies nicht möglich sein, nutzen Sie Werkzeuge wie z. B. HDvO.

Grundsätzlich gilt, je exakter die Darstellung der Dialoge im Pflichtenheft der zukünftigen Anwendung entsprechen, desto geringer werden Diskussionen über evtl. Nacharbeiten sein.

Die Beschreibung eines Dialoges teilt sich immer in zwei Teile. Dem Abbild des Dialogs selber und der Feld und Funktionsbeschreibung. Sollte das Abbild des Dialoges aus einem Screenshot bestehen, achten Sie hierbei auf die aktuell im System eingestellte Farbtiefe. Diese Farbtiefe wird bei der Erstellung von Schnappschüssen meist übernommen.

Sollte die aktuelle Farbeinstellung unter Windows Truecolor sein, so wird diese auch beim Bildschirmschnappschuss übernommen. 256 Farben reichen jedoch für die Darstellung von Dialogen aus. Die Dateigröße des Pflichtenheftes reduziert sich dadurch erheblich.

Die Systematik der Beschreibung im Bereich der Feld- und Funktionsbeschreibungen von Dialogen ist unabhängig von der Art der Oberfläche und dem zugrundeliegenden Betriebssystem zu sehen. D. h. für die Beschreibung von Dialogen muss keine betriebssystemspezifische Form der Beschreibung erstellt werden.

Im Umkehrschluss bedeutet das, dass z. B die Beschreibung eines Dialogs unter UNIX ohne weiteres auch für Windows übernommen werden kann. Hierzu muss dann nur die Abbildung der Maske gegen die aktuelle Aufbereitung unter Windows ausgetauscht werden. (Hiermit ist natürlich nicht gemeint, dass eine detaillierte Softwarebeschreibung grundsätzlich betriebssystemunabhängig gemacht werden kann. Dazu müssen bei der Programmentwicklung meistens zu viele systemspezifische Funktionen des aktuellen Zielsystems genutzt werden. Die Oberfläche ist davon jedoch häufig nicht betroffen).

Wenn ein Dialog beschrieben wird, beginnt man mit einem einleitenden Satz. Es hilft innerhalb des Pflichtenheftes festzustellen, von wo der Dialog aufgerufen worden ist. Der Kontext ist so einfacher ersichtlich. Der einleitende Satz ist hierbei als Minimalanforderung an den Einstieg in eine Dialogbeschreibung zu sehen. Wenn zusätzliche Erklärungen sinnvoll sind, sollten Sie hier an dieser Stelle gemacht werden.

Der einleitende Satz könnte lauten: "Nach Aufruf des Menüpunktes <Menüpunkt> erscheint der folgende Dialog <Name des Dialoges>.

Beispiel für einen Dialog:

Nach der Abbildung des Dialoges wird seine Funktionalität beschrieben. Hierunter fallen:

• Feldbeschreibung
• Funktionstasten
• Buttons
• Rechte Maustaste
• Controls und sonstige Dialogelemente
• . . .

Bei der Beschreibung von Dialogen sollte eine Durchgängigkeit eingehalten werden, was die Reihenfolge der Beschreibungen angeht. Die obige Auflistung der zu beschreibenden Teilbereiche für einen Dialog kann als Anhaltspunkt dafür dienen, wie diese Durchgängigkeit gewährleistet werden kann.

Sollten verschiedene Teilbereiche bei einem Dialog nicht vorkommen. (z. B. keine Funktionstasten) Lassen Sie keine leeren Tabellen als Platzhalter dort. Dies produziert bei den Fachabteilungen nur unnötigen Diskussionsbedarf.