Hierarchische Dokumentation von Objekten

Wie wird es gemacht ?
Die wichtigste Information zu einem Dialog ist die Beschreibung der dargestellten Felder. Die Form der Beschreibung sollte nicht in Prosa erfolgen. Eine tabellarische Form ist übersichtlich und bietet flexible Erweiterungsmöglichkeiten. Die Auflistung der Felder sollte hierbei in der Reihenfolge erfolgen, in der die Eingabe gemacht wird.

Feld
Name des Feldes in der Maske.

Art
Zur Beschreibung eines Feldes gehört auch seine Eigenschaft. Hierunter ist die Art und Weise zu verstehen, wie sich das Feld im Dialog verhält. Folgende grundlegenden Arten können vorkommen:

Anzeige: Feld wird vom Programm aus gefüllt.
Mussfeld: Feld darf nicht leer bleiben.
Kannfeld: Feld muss nicht unbedingt ausgefüllt sein.
Auswahlfeld: Es kann eine Auswahl aus einer definierten Menge getroffen werden.

Weitere Arten sind je nach Betriebssystem bzw. Anwendungsentwicklungsumgebung möglich.

Bemerkung
Hier gehört eine kurze Beschreibung des jeweiligen Feldes hin. Es können auch Bedingungen bzw. Plausibilitäten niedergelegt werden. Prüfen Sie auch bei augenscheinlich profanen Feldern wie z. B. Kundennummer oder Adresse, ob nicht eine Beschreibung notwendig ist. (So ist es z. B. für das Schreiben einer Rechnung schon wichtig, ob die Adresse im Dialog die Versandadresse oder die Rechnungsanschrift des Kunden ist.) Bei Feldern, deren Inhalte mit Hilfe einer Formel errechnet werden, muss die Formel Teil der Bemerkung werden.