Hierarchische Dokumentation von Objekten

Wie wird es gemacht ?
Bei den grafischen Benutzeroberflächen gibt es zu den normalen Anzeige- und Eingabefeldern noch eine Vielzahl von sog. Controls. Dies sind spezielle Funktionen, die innerhalb von Dialogen genutzt werden können. Hierzu gehören z. B. Regler, Drop-Downlisten, Comboboxen usw.

Bei der Vielzahl der existierenden Möglichkeiten ist es müßig, jedes einzelne Control zu beschreiben. Es ist vielmehr sinnvoll eine einheitliche Vorgehensweise zu definieren, mit der jedes Control beschrieben werden kann. Folgende Schritte können hier hilfreich sein:

1. Spalten der Tabelle definieren
Zur Definition einer Tabelle für ein Control, werden zuerst die Spalten der Tabelle definiert. Diese Tabelle ist der Rahmen in dem das Control vollständig beschrieben wird. Die drei Spalten Control, Status und Beschreibung/Bedingung reichen meistens dafür aus.

Beispiel: Checkbox
Die Spalten zur Beschreibung von Checkboxen lauten:
Control=Checkbox
Status=Selektion
Beschreibung/Bedingung=Beschreibung/Bedingung

2. Attribute der Felder festlegen
Nachdem die Spalten definiert worden sind, müssen die Attribute festgelegt werden, die jedes Feld in der Spalte haben kann.

Beispiel: Checkbox
Checkbox: Hier wird der Text der Checkbox erfasst.
Selektion: Welche Checkbox ist per Voreinstellung selektiert?
Beschreibung/Bedingung: Welche Auswirkung hat die Selektion bzw. keine Selektion der Checkbox?

Control	Selektion	Bedingung/Beschreibung

Sollte eine Tabelle öfter genutzt werden, kann diese als Textbaustein im Pflichtenheft abgelegt werden. So kann ohne viel Aufwand der gleiche Aufbau an verschiedenen Stellen immer wieder genutzt werden. Einfach leere Tabelle markieren Einfügen - Autotext Neu wählen - Namen vergeben - fertig.